lint found minor stuff

Author: mahtin

cli4/cli4.py

@@ -7,21 +7,37 @@
 import keyword
 import json
 
-my_yaml = None
-my_jsonlines = None
-
 import CloudFlare
+
 from .dump import dump_commands, dump_commands_from_web
 from . import converters
 from . import examples
 
+my_yaml = None
+my_jsonlines = None
+
+class CLI4InternalError(Exception):
+    """ errors in cli4 """
+
 def load_and_check_yaml():
     """ load_and_check_yaml() """
+    # only called if user uses --yaml flag
     from . import myyaml
     global my_yaml
-    my_yaml = myyaml.myyaml()
-    if not my_yaml.available():
-        sys.exit('cli4: install yaml support')
+    try:
+        my_yaml = myyaml.myyaml()
+    except ImportError:
+        sys.exit('cli4: install yaml support via: pip install pyyaml')
+
+def load_and_check_jsonlines():
+    """ load_and_check_yaml() """
+    # only called if user uses --ndjson flag
+    from . import myjsonlines
+    global my_jsonlines
+    try:
+        my_jsonlines = myjsonlines.myjsonlines()
+    except ImportError:
+        sys.exit('cli4: install jsonlines support via: pip install jsonlines')
 
 def strip_multiline(s):
     """ remove leading/trailing tabs/spaces on each line"""
@@ -56,7 +72,7 @@ def process_params_content_files(method, binary_file, args):
                         with open(filename, 'rb') as f:
                             content = f.read()
                     else:
-                        with open(filename, 'r') as f:
+                        with open(filename, 'r', encoding="utf-8") as f:
                             content = f.read()
             except IOError:
                 sys.exit('cli4: %s - file open failure' % (filename))
@@ -86,8 +102,8 @@ def process_params_content_files(method, binary_file, args):
                 value_string = strip_multiline(value_string)
                 try:
                     value = my_yaml.safe_load(value_string)
-                except my_yaml.parser.ParserError as e:
-                    raise ValueError
+                except my_yaml.parser.ParserError:
+                    raise ValueError from None
             except ValueError:
                 sys.exit('cli4: %s="%s" - can\'t parse json value' % (tag_string, value_string))
         elif value_string[0] == '@':
@@ -203,8 +219,8 @@ def run_command(cf, method, command, params=None, content=None, files=None):
                         elif (cmd[0] == 'user') and (cmd[1] == 'load_balancers') and (cmd[2] == 'pools'):
                             identifier1 = converters.convert_load_balancers_pool_to_identifier(cf, element)
                         else:
-                            raise Exception("/%s/%s :NOT CODED YET" % ('/'.join(cmd), element))
-                    except Exception as e:
+                            raise CLI4InternalError("/%s/%s :NOT CODED YET" % ('/'.join(cmd), element))
+                    except CLI4InternalError as e:
                         sys.stderr.write('cli4: /%s - %s\n' % (command, e))
                         raise e
                 cmd.append(':' + identifier1)
@@ -229,8 +245,8 @@ def run_command(cf, method, command, params=None, content=None, files=None):
                                                                                       identifier1,
                                                                                       element)
                         else:
-                            raise Exception("/%s/%s :NOT CODED YET" % ('/'.join(cmd), element))
-                    except Exception as e:
+                            raise CLI4InternalError("/%s/:%s :NOT CODED YET" % ('/'.join(cmd), element))
+                    except CLI4InternalError as e:
                         sys.stderr.write('cli4: /%s - %s\n' % (command, e))
                         raise e
                 # identifier2 may be an array - this needs to be dealt with later
@@ -252,10 +268,11 @@ def run_command(cf, method, command, params=None, content=None, files=None):
                     # raw string - used for workers script_names
                     identifier3 = element[1:]
                 else:
+                    #  /accounts/:id/storage/kv/namespaces/:id/values/:key_name - it's a strange one!
                     if len(cmd) >= 6 and cmd[0] == 'accounts' and cmd[2] == 'storage' and cmd[3] == 'kv' and cmd[4] == 'namespaces' and cmd[6] == 'values':
                         identifier3 = element
                     else:
-                        sys.stderr.write('/%s/%s :NOT CODED YET 3\n' % ('/'.join(cmd), element))
+                        sys.stderr.write('/%s/:%s :NOT CODED YET\n' % ('/'.join(cmd), element))
                         raise e
         else:
             try:
@@ -332,9 +349,9 @@ def write_results(results, output):
     if len(results) == 1:
         results = results[0]
 
-    if isinstance(results, str) or isinstance(results, (bytes, bytearray)):
+    if isinstance(results, (str, bytes, bytearray)):
         # if the results are a simple string, then it should be dumped directly
-        # this is only used for /zones/:id/dns_records/export presently
+        # this is only used for /zones/:id/dns_records/export, workers, and other calls
         # or
         # output is image or audio or video or something like that so we dump directly
         pass
@@ -441,11 +458,7 @@ def do_it(args):
             load_and_check_yaml()
             output = 'yaml'
         elif opt in ('-n', '--ndjson'):
-            from . import myjsonlines
-            global my_jsonlines
-            my_jsonlines = myjsonlines.myjsonlines()
-            if not my_jsonlines.available():
-                sys.exit('cli4: install jsonlines support')
+            load_and_check_jsonlines()
             output = 'ndjson'
         elif opt in ('-i', '--image'):
             output = 'image'

cli4/converters.py

@@ -10,29 +10,29 @@ def convert_zones_to_identifier(cf, zone_name):
     try:
         zones = cf.zones.get(params=params)
     except CloudFlare.exceptions.CloudFlareAPIError as e:
-        raise ConverterError(int(e), '%s - %d %s' % (zone_name, int(e), e))
+        raise ConverterError(int(e), '%s - %d %s' % (zone_name, int(e), e)) from None
     except Exception as e:
-        raise ConverterError(0, '%s - %s' % (zone_name, e))
+        raise ConverterError(0, '%s - %s' % (zone_name, e)) from e
 
     if len(zones) == 1:
         return zones[0]['id']
 
-    raise ConverterError('%s: not found' % (zone_name))
+    raise ConverterError('%s: not found' % (zone_name)) from None
 
 def convert_accounts_to_identifier(cf, account_name):
     """account names to numbers"""
     params = {'name':account_name, 'per_page':1}
     try:
         accounts = cf.accounts.get(params=params)
     except CloudFlare.exceptions.CloudFlareAPIError as e:
-        raise ConverterError(int(e), '%s - %d %s' % (account_name, int(e), e))
+        raise ConverterError(int(e), '%s - %d %s' % (account_name, int(e), e)) from None
     except Exception as e:
-        raise ConverterError(0, '%s - %s' % (account_name, e))
+        raise ConverterError(0, '%s - %s' % (account_name, e)) from e
 
     if len(accounts) == 1:
         return accounts[0]['id']
 
-    raise ConverterError('%s: not found' % (account_name))
+    raise ConverterError('%s: not found' % (account_name)) from None
 
 def convert_dns_record_to_identifier(cf, zone_id, dns_name):
     """dns record names to numbers"""
@@ -41,9 +41,9 @@ def convert_dns_record_to_identifier(cf, zone_id, dns_name):
     try:
         dns_records = cf.zones.dns_records.get(zone_id, params=params)
     except CloudFlare.exceptions.CloudFlareAPIError as e:
-        raise ConverterError(int(e), '%s - %d %s' % (dns_name, int(e), e))
+        raise ConverterError(int(e), '%s - %d %s' % (dns_name, int(e), e)) from None
     except Exception as e:
-        raise ConverterError(0, '%s - %s' % (dns_name, e))
+        raise ConverterError(0, '%s - %s' % (dns_name, e)) from e
 
     r = []
     for dns_record in dns_records:
@@ -52,82 +52,82 @@ def convert_dns_record_to_identifier(cf, zone_id, dns_name):
     if len(r) > 0:
         return r
 
-    raise ConverterError('%s: not found' % (dns_name))
+    raise ConverterError('%s: not found' % (dns_name)) from None
 
 def convert_certificates_to_identifier(cf, certificate_name):
     """certificate names to numbers"""
     try:
         certificates = cf.certificates.get()
     except CloudFlare.exceptions.CloudFlareAPIError as e:
-        raise ConverterError(int(e), '%s - %d %s' % (certificate_name, int(e), e))
+        raise ConverterError(int(e), '%s - %d %s' % (certificate_name, int(e), e)) from None
     except Exception as e:
-        raise ConverterError(0, '%s - %s' % (certificate_name, e))
+        raise ConverterError(0, '%s - %s' % (certificate_name, e)) from e
 
     for certificate in certificates:
         if certificate_name in certificate['hostnames']:
             return certificate['id']
 
-    raise ConverterError('%s: not found' % (certificate_name))
+    raise ConverterError('%s: not found' % (certificate_name)) from None
 
 def convert_organizations_to_identifier(cf, organization_name):
     """organizations names to numbers"""
     try:
         organizations = cf.user.organizations.get()
     except CloudFlare.exceptions.CloudFlareAPIError as e:
-        raise ConverterError(int(e), '%s - %d %s' % (organization_name, int(e), e))
+        raise ConverterError(int(e), '%s - %d %s' % (organization_name, int(e), e)) from None
     except Exception as e:
-        raise ConverterError(0, '%s - %s' % (organization_name, e))
+        raise ConverterError(0, '%s - %s' % (organization_name, e)) from e
 
     for organization in organizations:
         if organization_name == organization['name']:
             return organization['id']
 
-    raise ConverterError('%s not found' % (organization_name))
+    raise ConverterError('%s not found' % (organization_name)) from None
 
 def convert_invites_to_identifier(cf, invite_name):
     """invite names to numbers"""
     try:
         invites = cf.user.invites.get()
     except CloudFlare.exceptions.CloudFlareAPIError as e:
-        raise ConverterError(int(e), '%s - %d %s' % (invite_name, int(e), e))
+        raise ConverterError(int(e), '%s - %d %s' % (invite_name, int(e), e)) from None
     except Exception as e:
-        raise ConverterError(0, '%s - %s' % (invite_name, e))
+        raise ConverterError(0, '%s - %s' % (invite_name, e)) from e
 
     for invite in invites:
         if invite_name == invite['organization_name']:
             return invite['id']
 
-    raise ConverterError('%s: not found' % (invite_name))
+    raise ConverterError('%s: not found' % (invite_name)) from None
 
 def convert_virtual_dns_to_identifier(cf, virtual_dns_name):
     """virtual dns names to numbers"""
     try:
         virtual_dnss = cf.user.virtual_dns.get()
     except CloudFlare.exceptions.CloudFlareAPIError as e:
-        raise ConverterError(int(e), '%s - %d %s' % (virtual_dns_name, int(e), e))
+        raise ConverterError(int(e), '%s - %d %s' % (virtual_dns_name, int(e), e)) from None
     except Exception as e:
-        raise ConverterError(0, '%s - %s' % (virtual_dns_name, e))
+        raise ConverterError(0, '%s - %s' % (virtual_dns_name, e)) from e
 
     for virtual_dns in virtual_dnss:
         if virtual_dns_name == virtual_dns['name']:
             return virtual_dns['id']
 
-    raise ConverterError('%s: not found' % (virtual_dns_name))
+    raise ConverterError('%s: not found' % (virtual_dns_name)) from None
 
 def convert_load_balancers_pool_to_identifier(cf, pool_name):
     """load balancer pool names to numbers"""
     try:
         pools = cf.user.load_balancers.pools.get()
     except CloudFlare.exceptions.CloudFlareAPIError as e:
-        raise ConverterError(int(e), '%s - %d %s' % (pool_name, int(e), e))
+        raise ConverterError(int(e), '%s - %d %s' % (pool_name, int(e), e)) from None
     except Exception as e:
-        raise ConverterError(0, '%s - %s' % (pool_name, e))
+        raise ConverterError(0, '%s - %s' % (pool_name, e)) from e
 
     for p in pools:
         if pool_name == p['description']:
             return p['id']
 
-    raise ConverterError('%s: not found' % (pool_name))
+    raise ConverterError('%s: not found' % (pool_name)) from None
 
 def convert_custom_hostnames_to_identifier(cf, zone_id, custom_hostname):
     """custom_hostnames to numbers"""
@@ -136,9 +136,9 @@ def convert_custom_hostnames_to_identifier(cf, zone_id, custom_hostname):
     try:
         custom_hostnames_records = cf.zones.custom_hostnames.get(zone_id, params=params)
     except CloudFlare.exceptions.CloudFlareAPIError as e:
-        raise ConverterError(int(e), '%s - %d %s' % (custom_hostname, int(e), e))
+        raise ConverterError(int(e), '%s - %d %s' % (custom_hostname, int(e), e)) from None
     except Exception as e:
-        raise ConverterError(0, '%s - %s' % (custom_hostname, e))
+        raise ConverterError(0, '%s - %s' % (custom_hostname, e)) from e
 
     r = []
     for custom_hostnames_record in custom_hostnames_records:
@@ -147,4 +147,4 @@ def convert_custom_hostnames_to_identifier(cf, zone_id, custom_hostname):
     if len(r) > 0:
         return r
 
-    raise ConverterError('%s: not found' % (custom_hostname))
+    raise ConverterError('%s: not found' % (custom_hostname)) from None

cli4/dump.py

@@ -22,5 +22,3 @@ def dump_commands_from_web(cf, url):
             else:
                 a.append('%-6s %s' % (r['action'], r['cmd']))
     return '\n'.join(a) + '\n'
-
-

cli4/examples.py

@@ -8,13 +8,13 @@
     # function, so use the PyPI version:
     try:
         import importlib_resources
-    except ModuleNotFoundError as e:
+    except ModuleNotFoundError:
         importlib_resources = None
 else:
     # importlib.resources has files(), so use that:
     import importlib.resources as importlib_resources
 
-examples_package_name = 'examples'
+EXAMPLES_PACKAGE_NAME = 'examples'
 
 def display():
     """ display() """
@@ -23,7 +23,7 @@ def display():
         raise ModuleNotFoundError('Module "importlib_resources" missing - please "pip install importlib_resources" as your Python version is lower than 3.9')
 
     try:
-        pkg = importlib_resources.files(examples_package_name)
+        pkg = importlib_resources.files(EXAMPLES_PACKAGE_NAME)
     except ModuleNotFoundError as e:
         raise e
 
@@ -36,4 +36,3 @@ def display():
             if '__init__.py' in os.fspath(f):
                 continue
             print('\t%s' % (os.fspath(f)))
-

cli4/myjsonlines.py

@@ -7,17 +7,12 @@ class myjsonlines():
 
     def __init__(self):
         """ __init__ """
-        pass
-
-    def available(self):
-        """ available() """
         if not myjsonlines._jsonlines:
             try:
                 import jsonlines
                 myjsonlines._jsonlines = jsonlines
-            except ImportError:
-                return False
-        return True
+            except ImportError as e:
+                raise ImportError from e
 
     def Writer(self, fd):
         """ Writer() """

cli4/myyaml.py

@@ -8,18 +8,13 @@ class myyaml():
 
     def __init__(self):
         """ __init__ """
-        pass
-
-    def available(self):
-        """ available() """
         if not myyaml._yaml:
             try:
                 import yaml
                 myyaml._yaml = yaml
                 myyaml.parser = yaml.parser
-            except ImportError:
-                return False
-        return True
+            except ImportError as e:
+                raise ImportError from e
 
     def safe_load(self,value_string):
         """ safe_load() """