doc: Run blacken-docs on the mardown docs

Author: mpenning

sphinx-doc/cli.md

@@ -43,11 +43,12 @@ router bgp 65111
 That CLI command is the equivalent of running this
 {func}`~ciscoconfparse2.CiscoConfParse.find_parent_objects` script:
 
-```python
+```pycon
 >>> from ciscoconfparse2 import CiscoConfParse
->>> parse = CiscoConfParse('conf/path/or/file/glob.conf')
->>> for obj in parse.find_parent_objects(['router bgp'):
+>>> parse = CiscoConfParse("conf/path/or/file/glob.conf")
+>>> for obj in parse.find_parent_objects(["router bgp"]):
 ...     print(obj.text)
+...
 >>>
 ```
 
@@ -75,13 +76,14 @@ default-information originate
 That CLI command is the equivalent of running this
 {func}`~ciscoconfparse2.CiscoConfParse.find_child_objects` script:
 
-```python
+```pycon
 >>> from ciscoconfparse2 import CiscoConfParse
->>> parse = CiscoConfParse('conf/path/or/file/glob.conf')
->>> for obj in parse.find_child_objects(['router bgp',
-...                                      'address-family',
-...                                      'default-information']):
+>>> parse = CiscoConfParse("conf/path/or/file/glob.conf")
+>>> for obj in parse.find_child_objects(
+...     ["router bgp", "address-family", "default-information"]
+... ):
 ...     print(obj.text)
+...
 >>>
 ```
 
@@ -110,12 +112,12 @@ Output as   : raw_text
 That CLI command is the equivalent of running this
 {func}`~ciscoconfparse2.CiscoConfParse.find_object_branches` script:
 
-```python
+```pycon
 >>> from ciscoconfparse2 import CiscoConfParse
->>> parse = CiscoConfParse('conf/path/or/file/glob.conf')
->>> for branch in parse.find_object_branches(['router bgp',
-...                                           'address-family',
-...                                           'default-information']):
+>>> parse = CiscoConfParse("conf/path/or/file/glob.conf")
+>>> for branch in parse.find_object_branches(
+...     ["router bgp", "address-family", "default-information"]
+... ):
 ...     print([obj.text for obj in branch])
 ...
 >>>

sphinx-doc/example_complex.md

@@ -14,6 +14,7 @@ Save this code in a file named example.py
 from ciscoconfparse2 import CiscoConfParse
 from ciscoconfparse2 import IPv4Obj
 
+
 def intf_csv(intf_obj) -> str:
     """
     :return: CSV for each interface object.
@@ -24,44 +25,48 @@ def intf_csv(intf_obj) -> str:
     #   something like 'interface Loopback0'
     intf_name = " ".join(intf_obj.split()[1:])
 
-    admin_status = intf_obj.re_match_iter_typed("^\s+(shutdown)",
-                                                default="not_shutdown",
-                                                result_type=str)
+    admin_status = intf_obj.re_match_iter_typed(
+        "^\s+(shutdown)", default="not_shutdown", result_type=str
+    )
 
     # Search children of all interfaces for a regex match and return
     # the value matched in regex match group 1.  If there is no match,
     # return a default value: 0.0.0.1/32
-    addr_netmask = intf_obj.re_match_iter_typed(r"^\s+ip\saddress\s(\d+\.\d+\.\d+\.\d+\s\S+)",
-                                                result_type=IPv4Obj,
-                                                group=1,
-                                                default=IPv4Obj("0.0.0.1/32"))
+    addr_netmask = intf_obj.re_match_iter_typed(
+        r"^\s+ip\saddress\s(\d+\.\d+\.\d+\.\d+\s\S+)",
+        result_type=IPv4Obj,
+        group=1,
+        default=IPv4Obj("0.0.0.1/32"),
+    )
 
     # Find the description and replace all commas in it
     description = intf_obj.re_match_iter_typed("description\s+(\S.*)").replace(",", "_")
 
-    switchport_status = intf_obj.re_match_iter_typed("(switchport)",
-                                                     default="not_switched")
+    switchport_status = intf_obj.re_match_iter_typed(
+        "(switchport)", default="not_switched"
+    )
 
     # Return a csv based on whether this is a switchport
     if switchport_status == "not_switched":
         return f"{intf_name},{admin_status},{addr_netmask.as_cidr_addr},{switchport_status},,,{description}"
 
     else:
         # Only calculate switchport values if this is a switchport
-        trunk_access = intf_obj.re_match_iter_typed("switchport mode (trunk)",
-                                                    default="access",
-                                                    result_type=str)
-        access_vlan = intf_obj.re_match_iter_typed("switchport access vlan (\d+)",
-                                                   default=1,
-                                                   result_type=int)
+        trunk_access = intf_obj.re_match_iter_typed(
+            "switchport mode (trunk)", default="access", result_type=str
+        )
+        access_vlan = intf_obj.re_match_iter_typed(
+            "switchport access vlan (\d+)", default=1, result_type=int
+        )
 
         # Return the CSV string of values...
         return f"{intf_name},{admin_status},{switchport_status},{trunk_access},{access_vlan},{description}"
 
-parse = CiscoConfParse('tests/fixtures/configs/sample_08.ios', syntax='ios')
+
+parse = CiscoConfParse("tests/fixtures/configs/sample_08.ios", syntax="ios")
 
 # Find interface BaseCfgLine() instances...
-for intf_obj in parse.find_objects('^interface'):
+for intf_obj in parse.find_objects("^interface"):
     print(intf_csv(intf_obj))
 ```
 

sphinx-doc/example_simple.md

@@ -28,10 +28,10 @@ from ciscoconfparse2 import CiscoConfParse
 #     !
 
 # Search a configuration in the test fixutres directory
-parse = CiscoConfParse('tests/fixtures/configs/sample_02.ios', syntax='ios')
+parse = CiscoConfParse("tests/fixtures/configs/sample_02.ios", syntax="ios")
 
 # Find a parent line containing 'interface' and child line with 'shutdown'
-for intf_obj in parse.find_parent_objects(['interface', 'shutdown']):
+for intf_obj in parse.find_parent_objects(["interface", "shutdown"]):
     intf_name = " ".join(intf_obj.split()[1:])
     print(f"Shutdown: {intf_name}")
 ```

sphinx-doc/factory_hsrp.md

@@ -32,9 +32,7 @@ The following script should be used to extract the HSRP Groups from `GigabitEthe
 ```python
 from ciscoconfparse2 import CiscoConfParse
 
-parse = CiscoConfParse("/path/to/config/file",
-                       syntax="ios",
-                       factory=True)
+parse = CiscoConfParse("/path/to/config/file", syntax="ios", factory=True)
 
 hsrp_intf = parse.find_objects("interface GigabitEthernet1/0")[0]
 

sphinx-doc/intro.md

@@ -99,7 +99,7 @@ iterating in a loop (because two different interfaces have `parameter01`). Howev
 [ciscoconfparse2] can easily identify it by searching a list of elements with
 {py:meth}`~ciscoconfparse2.CiscoConfParse.find_child_objects`:
 
-```python
+```pycon
 >>> from ciscoconfparse2 import CiscoConfParse
 >>> # Assume we parsed the config into 'parse'
 >>> parse
@@ -114,7 +114,7 @@ iterating in a loop (because two different interfaces have `parameter01`). Howev
 However, you can still get multiple children by using a less-specific
 regex:
 
-```python
+```pycon
 >>>
 >>> # Expect to see a list of two children here... search across
 >>> # any Ethernet feature
@@ -124,7 +124,7 @@ regex:
 
 Finally, you can still get parent objects with {py:meth}`~ciscoconfparse2.CiscoConfParse.find_parent_objects`:
 
-```python
+```pycon
 >>> parse.find_parent_objects(["Ethernet", "feature01", "parameter"])
 [<IOSCfgLine # 3 'interface Ethernet0/1'>]
 ```
@@ -144,14 +144,15 @@ layer2 trunks; the interface name is stored on one line, and the trunk
 configuration is stored somewhere below the interface name. With
 ciscoconfparse, it's really this easy...
 
-```python
+```pycon
 >>> from ciscoconfparse2 import CiscoConfParse
->>> parse = CiscoConfParse('/tftpboot/largeConfig.conf', syntax='ios', factory=False)
+>>> parse = CiscoConfParse("/tftpboot/largeConfig.conf", syntax="ios", factory=False)
 >>>
 >>> # Find parent interfaces that are configured with 'switchport trunk'
 >>> dot1q_trunks = parse.find_parent_objects(["^interface", "switchport trunk"])
 >>> for intf in dot1q_trunks:
 ...     print(intf)
+...
 <IOSCfgLine # 217 'interface GigabitEthernet1/1'>
 <IOSCfgLine # 237 'interface GigabitEthernet1/2'>
 ...

sphinx-doc/tutorial_build_diffs.md

@@ -65,11 +65,11 @@ interface Serial1/1
 The script below will build read the configurations from disk and check to see whether
 there are diffs.
 
-```python
+```pycon
 >>> from ciscoconfparse2.ciscoconfparse2 import Diff
 >>> # Parse the original configuration
->>> old_config = '/tftpboot/bucksnort_before.conf'
->>> new_config = '/tftpboot/bucksnort_after.conf'
+>>> old_config = "/tftpboot/bucksnort_before.conf"
+>>> new_config = "/tftpboot/bucksnort_after.conf"
 >>> diff = Diff(old_config=old_config, new_config=new_config)
 >>> diff.get_diff()
 ['interface Serial1/0', ' mpls ip']
@@ -88,11 +88,11 @@ interface Serial1/0
 
 The script below will build read the configurations from disk and build rollback diff configs.
 
-```python
+```pycon
 >>> from ciscoconfparse2.ciscoconfparse2 import Diff
 >>> # Parse the original configuration
->>> old_config = '/tftpboot/bucksnort_before.conf'
->>> new_config = '/tftpboot/bucksnort_after.conf'
+>>> old_config = "/tftpboot/bucksnort_before.conf"
+>>> new_config = "/tftpboot/bucksnort_after.conf"
 >>> diff = Diff(old_config=old_config, new_config=new_config)
 >>> diff.get_rollback()
 ['interface Serial1/0', ' mpls ip']

sphinx-doc/tutorial_parent_child.md

@@ -161,7 +161,7 @@ The assuming we use the configuration in the example above,
 configuration for matching config objects and stores a list of
 {class}`~ciscoconfparse2.models_cisco.IOSCfgLine` objects in `serial_objs`.
 
-```python
+```pycon
 >>> serial_objs
 [<IOSCfgLine # 14 'interface Serial1/0'>,
 <IOSCfgLine # 18 'interface Serial1/1'>,
@@ -251,7 +251,7 @@ running globally on this device.
 
 Results:
 
-```python
+```pycon
 >>> cdp_intfs
 [<IOSCfgLine # 14 'interface Serial1/0'>, <IOSCfgLine # 18 'interface Serial1/1'>, <IOSCfgLine # 23 'interface Serial1/2'>]
 ```