Use Black to format code

 * Format code to use double-quotes instead of single-quotes

 * Set line-length to 120

 * Fix a few spelling errors in comments

Author: amb1s1

pyntc/__init__.py

@@ -11,8 +11,8 @@
 except ImportError:
     from ConfigParser import SafeConfigParser
 
-LIB_PATH_ENV_VAR = 'PYNTC_CONF'
-LIB_PATH_DEFAULT = '~/.ntc.conf'
+LIB_PATH_ENV_VAR = "PYNTC_CONF"
+LIB_PATH_DEFAULT = "~/.ntc.conf"
 
 
 def ntc_device(device_type, *args, **kwargs):
@@ -63,15 +63,15 @@ def ntc_device_by_name(name, filename=None):
         raise ConfFileNotFoundError(filename)
 
     for section in sections:
-        if ':' in section:
-            device_type_and_conn_name = section.split(':')
+        if ":" in section:
+            device_type_and_conn_name = section.split(":")
             device_type = device_type_and_conn_name[0]
             conn_name = device_type_and_conn_name[1]
 
             if name == conn_name:
                 device_kwargs = dict(config.items(section))
-                if 'host' not in device_kwargs:
-                    device_kwargs['host'] = name
+                if "host" not in device_kwargs:
+                    device_kwargs["host"] = name
 
                 return ntc_device(device_type, **device_kwargs)
 

pyntc/data_model/converters.py

@@ -52,11 +52,8 @@ def convert_list_by_key(original_list, key_map, fill_in=False, whitelist=[], bla
     converted_list = []
     for original in list(original_list):
         converted_list.append(
-            convert_dict_by_key(original,
-                                key_map,
-                                fill_in=fill_in,
-                                whitelist=whitelist,
-                                blacklist=blacklist))
+            convert_dict_by_key(original, key_map, fill_in=fill_in, whitelist=whitelist, blacklist=blacklist)
+        )
 
     return converted_list
 

pyntc/data_model/key_maps/eos_key_maps.py

@@ -1,22 +1,14 @@
 # Key maps for EOS devices are stored here.
 
-BASIC_FACTS_KM = {
-    'model': 'modelName',
-    'os_version': 'internalVersion',
-    'serial_number': 'serialNumber'
-}
+BASIC_FACTS_KM = {"model": "modelName", "os_version": "internalVersion", "serial_number": "serialNumber"}
 
 
 INTERFACES_KM = {
-    'speed': 'bandwidth',
-    'duplex': 'duplex',
-    'vlan': ['vlanInformation', 'vlanId'],
-    'state': 'linkStatus',
-    'description': 'description',
+    "speed": "bandwidth",
+    "duplex": "duplex",
+    "vlan": ["vlanInformation", "vlanId"],
+    "state": "linkStatus",
+    "description": "description",
 }
 
-VLAN_KM = {
-    'state': 'state',
-    'name': 'name',
-    'id': 'vlan_id',
-}
+VLAN_KM = {"state": "state", "name": "name", "id": "vlan_id"}

pyntc/data_model/key_maps/ios_key_maps.py

@@ -1,8 +1,3 @@
 # Key maps for IOS devices are stored here.
 
-BASIC_FACTS_KM = {
-    'model': 'hardware',
-    'os_version': 'version',
-    'serial_number': 'serial',
-    'hostname': 'hostname',
-}
+BASIC_FACTS_KM = {"model": "hardware", "os_version": "version", "serial_number": "serial", "hostname": "hostname"}

pyntc/devices/__init__.py

@@ -12,10 +12,10 @@
 
 
 supported_devices = {
-    'cisco_asa_ssh': ASADevice,
-    'arista_eos_eapi': EOSDevice,
-    'f5_tmos_icontrol': F5Device,
-    'cisco_ios_ssh': IOSDevice,
-    'juniper_junos_netconf': JunosDevice,
-    'cisco_nxos_nxapi': NXOSDevice,
+    "cisco_asa_ssh": ASADevice,
+    "arista_eos_eapi": EOSDevice,
+    "f5_tmos_icontrol": F5Device,
+    "cisco_ios_ssh": IOSDevice,
+    "juniper_junos_netconf": JunosDevice,
+    "cisco_nxos_nxapi": NXOSDevice,
 }

pyntc/devices/asa_device.py

@@ -24,20 +24,17 @@
 
 @fix_docs
 class ASADevice(BaseDevice):
-
-    def __init__(self, host, username, password, secret='', port=22, **kwargs):
-        super(ASADevice, self).__init__(host, username, password,
-                                        vendor='cisco',
-                                        device_type='cisco_asa_ssh')
+    def __init__(self, host, username, password, secret="", port=22, **kwargs):
+        super(ASADevice, self).__init__(host, username, password, vendor="cisco", device_type="cisco_asa_ssh")
 
         self.native = None
         self.host = host
         self.username = username
         self.password = password
         self.secret = secret
         self.port = int(port)
-        self.global_delay_factor = kwargs.get('global_delay_factor', 1)
-        self.delay_factor = kwargs.get('delay_factor', 1)
+        self.global_delay_factor = kwargs.get("global_delay_factor", 1)
+        self.delay_factor = kwargs.get("delay_factor", 1)
         self._connected = False
         self.open()
 
@@ -50,7 +47,7 @@ def _enter_config(self):
         self._enable()
         self.native.config_mode()
 
-    def _file_copy_instance(self, src, dest=None, file_system='flash:'):
+    def _file_copy_instance(self, src, dest=None, file_system="flash:"):
         if dest is None:
             dest = os.path.basename(src)
 
@@ -66,9 +63,9 @@ def _get_file_system(self):
         Raises:
             FileSystemNotFound: When the module is unable to determine the default file system.
         """
-        raw_data = self.show('dir')
+        raw_data = self.show("dir")
         try:
-            file_system = re.match(r'\s*.*?(\S+:)', raw_data).group(1)
+            file_system = re.match(r"\s*.*?(\S+:)", raw_data).group(1)
             return file_system
         except AttributeError:
             # TODO: Get proper hostname
@@ -82,51 +79,46 @@ def _image_booted(self, image_name, **vendor_specifics):
         return False
 
     def _interfaces_detailed_list(self):
-        ip_int = self.show('show interface')
-        ip_int_data = get_structured_data('cisco_asa_show_interface.template',
-                                          ip_int)
+        ip_int = self.show("show interface")
+        ip_int_data = get_structured_data("cisco_asa_show_interface.template", ip_int)
 
         return ip_int_data
 
     def _is_catalyst(self):
-        return self.facts['model'].startswith('WS-')
+        return self.facts["model"].startswith("WS-")
 
     def _raw_version_data(self):
-        show_version_out = self.show('show version')
+        show_version_out = self.show("show version")
         try:
-            version_data = \
-                get_structured_data('cisco_asa_show_version.template',
-                                    show_version_out)[0]
+            version_data = get_structured_data("cisco_asa_show_version.template", show_version_out)[0]
             return version_data
         except IndexError:
             return {}
 
-    def _send_command(self, command, expect=False, expect_string=''):
+    def _send_command(self, command, expect=False, expect_string=""):
         if expect:
             if expect_string:
-                response = self.native.send_command_expect(command,
-                                                           expect_string=expect_string)
+                response = self.native.send_command_expect(command, expect_string=expect_string)
             else:
                 response = self.native.send_command_expect(command)
         else:
             response = self.native.send_command_timing(command)
 
-        if '% ' in response or 'Error:' in response:
+        if "% " in response or "Error:" in response:
             raise CommandError(command, response)
 
         return response
 
     def _show_vlan(self):
-        show_vlan_out = self.show('show vlan')
-        show_vlan_data = get_structured_data('cisco_ios_show_vlan.template',
-                                             show_vlan_out)
+        show_vlan_out = self.show("show vlan")
+        show_vlan_data = get_structured_data("cisco_ios_show_vlan.template", show_vlan_out)
 
         return show_vlan_data
 
     def _uptime_components(self, uptime_full_string):
-        match_days = re.search(r'(\d+) days?', uptime_full_string)
-        match_hours = re.search(r'(\d+) hours?', uptime_full_string)
-        match_minutes = re.search(r'(\d+) minutes?', uptime_full_string)
+        match_days = re.search(r"(\d+) days?", uptime_full_string)
+        match_hours = re.search(r"(\d+) hours?", uptime_full_string)
+        match_minutes = re.search(r"(\d+) minutes?", uptime_full_string)
 
         days = int(match_days.group(1)) if match_days else 0
         hours = int(match_hours.group(1)) if match_hours else 0
@@ -145,7 +137,7 @@ def _uptime_to_seconds(self, uptime_full_string):
 
     def _uptime_to_string(self, uptime_full_string):
         days, hours, minutes = self._uptime_components(uptime_full_string)
-        return '%02d:%02d:%02d:00' % (days, hours, minutes)
+        return "%02d:%02d:%02d:00" % (days, hours, minutes)
 
     def _wait_for_device_reboot(self, timeout=3600):
         start = time.time()
@@ -160,7 +152,7 @@ def _wait_for_device_reboot(self, timeout=3600):
         raise RebootTimeoutError(hostname=self.host, wait_time=timeout)
 
     def backup_running_config(self, filename):
-        with open(filename, 'w') as f:
+        with open(filename, "w") as f:
             f.write(self.running_config)
 
     def checkpoint(self, checkpoint_file):
@@ -184,8 +176,7 @@ def config_list(self, commands):
             try:
                 self._send_command(command)
             except CommandError as e:
-                raise CommandListError(
-                    entered_commands, command, e.cli_error_msg)
+                raise CommandListError(entered_commands, command, e.cli_error_msg)
         self.native.exit_config_mode()
 
     @property
@@ -214,8 +205,7 @@ def file_copy(self, src, dest=None, file_system=None):
 
             if not self.file_copy_remote_exists(src, dest, file_system):
                 raise FileTransferError(
-                    message="Attempted file copy, "
-                            "but could not validate file existed after transfer"
+                    message="Attempted file copy, but could not validate file existed after transfer"
                 )
 
     # TODO: Make this an internal method since exposing file_copy should be sufficient
@@ -230,9 +220,9 @@ def file_copy_remote_exists(self, src, dest=None, file_system=None):
         return False
 
     def get_boot_options(self):
-        show_boot_out = self.show('show boot | i BOOT variable')
+        show_boot_out = self.show("show boot | i BOOT variable")
         # Improve regex to get only the first boot $var in the sequence!
-        boot_path_regex = r'Current BOOT variable = (\S+):\/(\S+)'
+        boot_path_regex = r"Current BOOT variable = (\S+):\/(\S+)"
 
         match = re.search(boot_path_regex, show_boot_out)
         if match:
@@ -263,56 +253,59 @@ def open(self):
                 self._connected = False
 
         if not self._connected:
-            self.native = ConnectHandler(device_type='cisco_asa',
-                                         ip=self.host,
-                                         username=self.username,
-                                         password=self.password,
-                                         port=self.port,
-                                         global_delay_factor=self.global_delay_factor,
-                                         secret=self.secret,
-                                         verbose=False)
+            self.native = ConnectHandler(
+                device_type="cisco_asa",
+                ip=self.host,
+                username=self.username,
+                password=self.password,
+                port=self.port,
+                global_delay_factor=self.global_delay_factor,
+                secret=self.secret,
+                verbose=False,
+            )
             self._connected = True
 
     def reboot(self, timer=0, confirm=False):
         if confirm:
+
             def handler(signum, frame):
-                raise RebootSignal('Interrupting after reload')
+                raise RebootSignal("Interrupting after reload")
 
             signal.signal(signal.SIGALRM, handler)
             signal.alarm(10)
 
             try:
                 if timer > 0:
-                    first_response = self.show('reload in %d' % timer)
+                    first_response = self.show("reload in %d" % timer)
                 else:
-                    first_response = self.show('reload')
+                    first_response = self.show("reload")
 
-                if 'System configuration' in first_response:
-                    self.native.send_command_timing('no')
+                if "System configuration" in first_response:
+                    self.native.send_command_timing("no")
 
-                self.native.send_command_timing('\n')
+                self.native.send_command_timing("\n")
             except RebootSignal:
                 signal.alarm(0)
 
             signal.alarm(0)
         else:
-            print('Need to confirm reboot with confirm=True')
+            print("Need to confirm reboot with confirm=True")
 
     def rollback(self, rollback_to):
         raise NotImplementedError
 
     @property
     def running_config(self):
-        return self.show('show running-config', expect=True)
+        return self.show("show running-config", expect=True)
 
-    def save(self, filename='startup-config'):
-        command = 'copy running-config %s' % filename
+    def save(self, filename="startup-config"):
+        command = "copy running-config %s" % filename
         # Changed to send_command_timing to not require a direct prompt return.
         self.native.send_command_timing(command)
         # If the user has enabled 'file prompt quiet' which dose not require any confirmation or feedback.
         # This will send return without requiring an OK.
-        # Send a return to pass the [OK]? message - Incease delay_factor for looking for response.
-        self.native.send_command_timing('\n', delay_factor=2)
+        # Send a return to pass the [OK]? message - Increase delay_factor for looking for response.
+        self.native.send_command_timing("\n", delay_factor=2)
         # Confirm that we have a valid prompt again before returning.
         self.native.find_prompt()
         return True
@@ -327,7 +320,9 @@ def set_boot_options(self, image_name, **vendor_specifics):
         if re.search(image_name, file_system_files) is None:
             raise NTCFileNotFoundError(
                 # TODO: Update to use hostname
-                hostname=self.host, file=image_name, dir=file_system
+                hostname=self.host,
+                file=image_name,
+                dir=file_system,
             )
 
         current_images = current_boot.splitlines()
@@ -342,10 +337,9 @@ def set_boot_options(self, image_name, **vendor_specifics):
                 message="Setting boot command did not yield expected results",
             )
 
-    def show(self, command, expect=False, expect_string=''):
+    def show(self, command, expect=False, expect_string=""):
         self._enable()
-        return self._send_command(command, expect=expect,
-                                  expect_string=expect_string)
+        return self._send_command(command, expect=expect, expect_string=expect_string)
 
     def show_list(self, commands):
         self._enable()
@@ -357,14 +351,13 @@ def show_list(self, commands):
             try:
                 responses.append(self._send_command(command))
             except CommandError as e:
-                raise CommandListError(entered_commands, command,
-                                       e.cli_error_msg)
+                raise CommandListError(entered_commands, command, e.cli_error_msg)
 
         return responses
 
     @property
     def startup_config(self):
-        return self.show('show startup-config')
+        return self.show("show startup-config")
 
 
 class RebootSignal(NTCError):