cleaner sanitize code for keywords, dashes, at-symbols. Cleaner API Exception returns. Added unified find() call to reduce code

Author: mahtin

CloudFlare/cloudflare.py

@@ -700,37 +700,52 @@ def __repr__(self):
         def get(self, identifier1=None, identifier2=None, identifier3=None, identifier4=None, params=None, data=None):
             """ Cloudflare v4 API"""
 
-            if getattr(self, '_content_type', False):
-                return self._do('GET', self._parts, [identifier1, identifier2, identifier3, identifier4], params, data, self._content_type)
-            return self._do('GET', self._parts, [identifier1, identifier2, identifier3, identifier4], params, data)
+            try:
+                if getattr(self, '_content_type', False):
+                    return self._do('GET', self._parts, [identifier1, identifier2, identifier3, identifier4], params, data, self._content_type)
+                return self._do('GET', self._parts, [identifier1, identifier2, identifier3, identifier4], params, data)
+            except CloudFlareAPIError as e:
+                raise CloudFlareAPIError(e=e) from None
 
         def patch(self, identifier1=None, identifier2=None, identifier3=None, identifier4=None, params=None, data=None):
             """ Cloudflare v4 API"""
 
-            if getattr(self, '_content_type', False):
-                return self._do('PATCH', self._parts, [identifier1, identifier2, identifier3, identifier4], params, data, self._content_type)
-            return self._do('PATCH', self._parts, [identifier1, identifier2, identifier3, identifier4], params, data)
+            try:
+                if getattr(self, '_content_type', False):
+                    return self._do('PATCH', self._parts, [identifier1, identifier2, identifier3, identifier4], params, data, self._content_type)
+                return self._do('PATCH', self._parts, [identifier1, identifier2, identifier3, identifier4], params, data)
+            except CloudFlareAPIError as e:
+                raise CloudFlareAPIError(e=e) from None
 
         def post(self, identifier1=None, identifier2=None, identifier3=None, identifier4=None, params=None, data=None, files=None):
             """ Cloudflare v4 API"""
 
-            if getattr(self, '_content_type', False):
-                return self._do('POST', self._parts, [identifier1, identifier2, identifier3, identifier4], params, data, files, self._content_type)
-            return self._do('POST', self._parts, [identifier1, identifier2, identifier3, identifier4], params, data, files)
+            try:
+                if getattr(self, '_content_type', False):
+                    return self._do('POST', self._parts, [identifier1, identifier2, identifier3, identifier4], params, data, files, self._content_type)
+                return self._do('POST', self._parts, [identifier1, identifier2, identifier3, identifier4], params, data, files)
+            except CloudFlareAPIError as e:
+                raise CloudFlareAPIError(e=e) from None
 
         def put(self, identifier1=None, identifier2=None, identifier3=None, identifier4=None, params=None, data=None, files=None):
             """ Cloudflare v4 API"""
 
-            if getattr(self, '_content_type', False):
-                return self._do('PUT', self._parts, [identifier1, identifier2, identifier3, identifier4], params, data, files, self._content_type)
-            return self._do('PUT', self._parts, [identifier1, identifier2, identifier3, identifier4], params, data, files)
+            try:
+                if getattr(self, '_content_type', False):
+                    return self._do('PUT', self._parts, [identifier1, identifier2, identifier3, identifier4], params, data, files, self._content_type)
+                return self._do('PUT', self._parts, [identifier1, identifier2, identifier3, identifier4], params, data, files)
+            except CloudFlareAPIError as e:
+                raise CloudFlareAPIError(e=e) from None
 
         def delete(self, identifier1=None, identifier2=None, identifier3=None, identifier4=None, params=None, data=None):
             """ Cloudflare v4 API"""
 
-            if getattr(self, '_content_type', False):
-                return self._do('DELETE', self._parts, [identifier1, identifier2, identifier3, identifier4], params, data, self._content_type)
-            return self._do('DELETE', self._parts, [identifier1, identifier2, identifier3, identifier4], params, data)
+            try:
+                if getattr(self, '_content_type', False):
+                    return self._do('DELETE', self._parts, [identifier1, identifier2, identifier3, identifier4], params, data, self._content_type)
+                return self._do('DELETE', self._parts, [identifier1, identifier2, identifier3, identifier4], params, data)
+            except CloudFlareAPIError as e:
+                raise CloudFlareAPIError(e=e) from None
 
     class _CFbaseUnused(_CFbase):
         """ Cloudflare v4 API"""
@@ -754,30 +769,42 @@ def __init__(self, base, parts, content_type):
         def patch(self, identifier1=None, identifier2=None, identifier3=None, identifier4=None, params=None, data=None):
             """ Cloudflare v4 API"""
 
-            if getattr(self, '_content_type', False):
-                return self._base.do_not_available('PATCH', self._parts, [identifier1, identifier2, identifier3, identifier4], params, data, self._content_type)
-            return self._base.do_not_available('PATCH', self._parts, [identifier1, identifier2, identifier3, identifier4], params, data)
+            try:
+                if getattr(self, '_content_type', False):
+                    return self._base.do_not_available('PATCH', self._parts, [identifier1, identifier2, identifier3, identifier4], params, data, self._content_type)
+                return self._base.do_not_available('PATCH', self._parts, [identifier1, identifier2, identifier3, identifier4], params, data)
+            except CloudFlareAPIError as e:
+                raise CloudFlareAPIError(e=e) from None
 
         def post(self, identifier1=None, identifier2=None, identifier3=None, identifier4=None, params=None, data=None, files=None):
             """ Cloudflare v4 API"""
 
-            if getattr(self, '_content_type', False):
-                return self._base.do_not_available('POST', self._parts, [identifier1, identifier2, identifier3, identifier4], params, data, files, self._content_type)
-            return self._base.do_not_available('POST', self._parts, [identifier1, identifier2, identifier3, identifier4], params, data, files)
+            try:
+                if getattr(self, '_content_type', False):
+                    return self._base.do_not_available('POST', self._parts, [identifier1, identifier2, identifier3, identifier4], params, data, files, self._content_type)
+                return self._base.do_not_available('POST', self._parts, [identifier1, identifier2, identifier3, identifier4], params, data, files)
+            except CloudFlareAPIError as e:
+                raise CloudFlareAPIError(e=e) from None
 
         def put(self, identifier1=None, identifier2=None, identifier3=None, identifier4=None, params=None, data=None, files=None):
             """ Cloudflare v4 API"""
 
-            if getattr(self, '_content_type', False):
-                return self._base.do_not_available('PUT', self._parts, [identifier1, identifier2, identifier3, identifier4], params, data, self._content_type)
-            return self._base.do_not_available('PUT', self._parts, [identifier1, identifier2, identifier3, identifier4], params, data)
+            try:
+                if getattr(self, '_content_type', False):
+                    return self._base.do_not_available('PUT', self._parts, [identifier1, identifier2, identifier3, identifier4], params, data, self._content_type)
+                return self._base.do_not_available('PUT', self._parts, [identifier1, identifier2, identifier3, identifier4], params, data)
+            except CloudFlareAPIError as e:
+                raise CloudFlareAPIError(e=e) from None
 
         def delete(self, identifier1=None, identifier2=None, identifier3=None, identifier4=None, params=None, data=None):
             """ Cloudflare v4 API"""
 
-            if getattr(self, '_content_type', False):
-                return self._base.do_not_available('DELETE', self._parts, [identifier1, identifier2, identifier3, identifier4], params, data, self._content_type)
-            return self._base.do_not_available('DELETE', self._parts, [identifier1, identifier2, identifier3, identifier4], params, data)
+            try:
+                if getattr(self, '_content_type', False):
+                    return self._base.do_not_available('DELETE', self._parts, [identifier1, identifier2, identifier3, identifier4], params, data, self._content_type)
+                return self._base.do_not_available('DELETE', self._parts, [identifier1, identifier2, identifier3, identifier4], params, data)
+            except CloudFlareAPIError as e:
+                raise CloudFlareAPIError(e=e) from None
 
     class _CFbaseAuth(_CFbase):
         """ Cloudflare v4 API"""
@@ -809,6 +836,23 @@ def __init__(self, base, parts, content_type):
             self._do = self._base.do_certauth
             self._valid = True
 
+    @classmethod
+    def sanitize_verb(cls, v):
+        """ sanitize_verb """
+        # keywords are also changed to have underscore appended so it can used with Python code
+        if keyword.iskeyword(v):
+            v = v + '_'
+        # AI functions introduce '@' symbol - i.e .../@cf/... they are replaced with at_
+        if '@' == v[0]:
+            v = 'at_' + v[1:]
+        # AI functions introduce '.' symbol - i.e 1.0 they are replaced with underscore
+        if '.' in v:
+            v = v.replace('.','_')
+        # dashes (vs underscores) cause issues in Python and other languages. they are replaced with underscores
+        if '-' in v:
+            v = v.replace('-','_')
+        return v
+
     def add(self, t, p1, p2=None, p3=None, p4=None, p5=None, content_type=None):
         """ add api call to class"""
 
@@ -830,10 +874,7 @@ def add(self, t, p1, p2=None, p3=None, p4=None, p5=None, content_type=None):
         element = None
         for element in a[0:-1]:
             try:
-                if '-' in element:
-                    branch = getattr(branch, element.replace('-','_'))
-                else:
-                    branch = getattr(branch, element)
+                branch = getattr(branch, CloudFlare.sanitize_verb(element))
             except AttributeError:
                 # missing path - should never happen unless api_v4 is a busted file
                 branch = None
@@ -844,15 +885,7 @@ def add(self, t, p1, p2=None, p3=None, p4=None, p5=None, content_type=None):
 
         name = a[-1]
         try:
-            if keyword.iskeyword(name):
-                # add the keyword appended with an extra underscore so it can used with Python code
-                f = getattr(branch, name + '_')
-            else:
-                if '-' in name:
-                    # dashes (vs underscores) cause issues in Python and other languages
-                    f = getattr(branch, name.replace('-','_'))
-                else:
-                    f = getattr(branch, name)
+            branch = getattr(branch, CloudFlare.sanitize_verb(name))
             # we only are here becuase the name already exists - don't let it overwrite - should never happen unless api_v4 is a busted file
             raise CloudFlareAPIError(0, 'api load: duplicate name found: %s/**%s**' % ('/'.join(a[0:-1]), name))
         except AttributeError:
@@ -873,15 +906,19 @@ def add(self, t, p1, p2=None, p3=None, p4=None, p5=None, content_type=None):
             # should never happen
             raise CloudFlareAPIError(0, 'api load type mismatch')
 
-        if keyword.iskeyword(name):
-            # add the keyword appended with an extra underscore so it can used with Python code
-            setattr(branch, name + '_', f)
-        else:
-            if '-' in name:
-                # dashes (vs underscores) cause issues in Python and other languages
-                setattr(branch, name.replace('-','_'), f)
-            else:
-                setattr(branch, name, f)
+        setattr(branch, CloudFlare.sanitize_verb(name), f)
+
+    def find(self, cmd):
+        """ find """
+        m = self
+        for verb in cmd.split('/'):
+            if verb == '' or verb[0] == ':':
+                continue
+            try:
+                m = getattr(m, CloudFlare.sanitize_verb(verb))
+            except AttributeError:
+                raise AttributeError('%s: not found' % (verb)) from None
+        return m
 
     def api_list(self):
         """ recursive walk of the api tree returning a list of api calls"""

CloudFlare/exceptions.py

@@ -16,16 +16,24 @@ def __int__(self):
         def __str__(self):
             return self.message
 
-    def __init__(self, code, message, error_chain=None):
+    def __init__(self, code=0, message=None, error_chain=None, e=None):
         """ errors for Cloudflare API"""
 
-        self.evalue = self.CodeMessage(int(code), str(message))
+        if e and isinstance(e, CloudFlareAPIError):
+            self.evalue = e.evalue
+            self.error_chain = e.error_chain
+            return
+
+        self.evalue = CloudFlareError.CodeMessage(int(code), str(message))
         self.error_chain = None
         if error_chain is not None:
             self.error_chain = []
             for evalue in error_chain:
-                self.error_chain.append(
-                    self.CodeMessage(int(evalue['code']), str(evalue['message'])))
+                if isinstance(evalue, CloudFlareError.CodeMessage):
+                    v = evalue
+                else:
+                    v = CloudFlareError.CodeMessage(int(evalue['code']), str(evalue['message']))
+                self.error_chain.append(v)
             # self.error_chain.append({'code': self.code, 'message': str(self.message)})
         # As we are built off Exception, we need to get our superclass all squared away
         # super().__init__(message)

cli4/cli4.py

@@ -4,7 +4,6 @@
 import sys
 import re
 import getopt
-import keyword
 import json
 
 import CloudFlare
@@ -272,14 +271,7 @@ def run_command(cf, method, command, params=None, content=None, files=None):
                         raise e
         else:
             try:
-                if keyword.iskeyword(element):
-                    # a keyword is appended with an extra underscore so it can used with Python code
-                    m = getattr(m, element + '_')
-                elif '-' in element:
-                    # dashes (vs underscores) cause issues in Python and other languages
-                    m = getattr(m, element.replace('-','_'))
-                else:
-                    m = getattr(m, element)
+                m = getattr(m, CloudFlare.CloudFlare.sanitize_verb(element))
                 cmd.append(element)
             except AttributeError as e:
                 # the verb/element was not found