Run openwisp-qa-format over files

Author: jonathanunderwood

docs/source/conf.py

@@ -33,35 +33,35 @@
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
-    'sphinx.ext.autodoc',
-    'sphinx.ext.viewcode',
+    "sphinx.ext.autodoc",
+    "sphinx.ext.viewcode",
 ]
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+templates_path = ["_templates"]
 
 # The suffix(es) of source filenames.
 # You can specify multiple suffix as a list of string:
 # source_suffix = ['.rst', '.md']
-source_suffix = '.rst'
+source_suffix = ".rst"
 
 # The encoding of source files.
 # source_encoding = 'utf-8-sig'
 
 # The master toctree document.
-master_doc = 'index'
+master_doc = "index"
 
 # General information about the project.
-project = u'netjsonconfig'
-copyright = u'{0}, OpenWISP.org'.format(datetime.date.today().year)
-author = u'Federico Capoano'
+project = u"netjsonconfig"
+copyright = u"{0}, OpenWISP.org".format(datetime.date.today().year)
+author = u"Federico Capoano"
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
 # The short X.Y version.
-version = '{0}.{1}'.format(VERSION[0], VERSION[1])
+version = "{0}.{1}".format(VERSION[0], VERSION[1])
 # The full version, including alpha/beta/rc tags.
 release = get_version()
 
@@ -98,7 +98,7 @@
 # show_authors = False
 
 # The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
+pygments_style = "sphinx"
 
 # A list of ignored prefixes for module index sorting.
 # modindex_common_prefix = []
@@ -114,7 +114,7 @@
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-html_theme = 'sphinx_rtd_theme'
+html_theme = "sphinx_rtd_theme"
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
@@ -206,7 +206,7 @@
 # html_search_scorer = 'scorer.js'
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'netjsonconfigdoc'
+htmlhelp_basename = "netjsonconfigdoc"
 
 # -- Options for LaTeX output ---------------------------------------------
 
@@ -227,10 +227,10 @@
 latex_documents = [
     (
         master_doc,
-        'netjsonconfig.tex',
-        u'netjsonconfig documentation',
-        u'Federico Capoano',
-        'manual',
+        "netjsonconfig.tex",
+        u"netjsonconfig documentation",
+        u"Federico Capoano",
+        "manual",
     ),
 ]
 
@@ -259,7 +259,7 @@
 
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
-man_pages = [(master_doc, 'netjsonconfig', u'netjsonconfig Documentation', [author], 1)]
+man_pages = [(master_doc, "netjsonconfig", u"netjsonconfig Documentation", [author], 1)]
 
 # If true, show URL addresses after external links.
 # man_show_urls = False
@@ -273,12 +273,12 @@
 texinfo_documents = [
     (
         master_doc,
-        'netjsonconfig',
-        u'netjsonconfig documentation',
+        "netjsonconfig",
+        u"netjsonconfig documentation",
         author,
-        'netjsonconfig',
-        'Python library that converts NetJSON DeviceConfiguration objects to real router configurations.',
-        'Miscellaneous',
+        "netjsonconfig",
+        "Python library that converts NetJSON DeviceConfiguration objects to real router configurations.",
+        "Miscellaneous",
     ),
 ]
 
@@ -341,7 +341,7 @@
 # epub_post_files = []
 
 # A list of files that should not be packed into the epub file.
-epub_exclude_files = ['search.html']
+epub_exclude_files = ["search.html"]
 
 # The depth of the table of contents in toc.ncx.
 # epub_tocdepth = 3

netjsonconfig/__init__.py

@@ -10,13 +10,13 @@
 
 def get_backends():
     default = {
-        'openwrt': OpenWrt,
-        'openwisp': OpenWisp,
-        'openvpn': OpenVpn,
+        "openwrt": OpenWrt,
+        "openwisp": OpenWisp,
+        "openvpn": OpenVpn,
     }
     logger = logging.getLogger(__name__)
 
-    for entry_point in iter_entry_points('netjsonconfig.backends'):
+    for entry_point in iter_entry_points("netjsonconfig.backends"):
         try:
             default.update({entry_point.name.lower(): entry_point.load()})
         except ImportError as e:  # noqa

netjsonconfig/backends/base/backend.py

@@ -20,7 +20,7 @@ class BaseBackend(object):
     """
 
     schema = None
-    FILE_SECTION_DELIMITER = '# ---------- files ---------- #'
+    FILE_SECTION_DELIMITER = "# ---------- files ---------- #"
     list_identifiers = []
 
     def __init__(self, config=None, native=None, templates=None, context=None):
@@ -48,8 +48,8 @@ def __init__(self, config=None, native=None, templates=None, context=None):
             self.parse(native)
         else:
             raise ValueError(
-                'Expecting either config or native argument to be '
-                'passed during the initialization of the backend'
+                "Expecting either config or native argument to be "
+                "passed during the initialization of the backend"
             )
 
     def _load(self, config):
@@ -63,7 +63,7 @@ def _load(self, config):
                 pass
         if not isinstance(config, dict):
             raise TypeError(
-                'config block must be an instance of dict or a valid NetJSON string'
+                "config block must be an instance of dict or a valid NetJSON string"
             )
         return config
 
@@ -75,7 +75,7 @@ def _merge_config(self, config, templates):
             return config
         # type check
         if not isinstance(templates, list):
-            raise TypeError('templates argument must be an instance of list')
+            raise TypeError("templates argument must be an instance of list")
         # merge templates with main configuration
         result = {}
         config_list = templates + [config]
@@ -97,33 +97,33 @@ def _render_files(self):
         """
         Renders additional files specified in ``self.config['files']``
         """
-        output = ''
+        output = ""
         # render files
-        files = self.config.get('files', [])
+        files = self.config.get("files", [])
         # add delimiter
         if files:
-            output += '\n{0}\n\n'.format(self.FILE_SECTION_DELIMITER)
+            output += "\n{0}\n\n".format(self.FILE_SECTION_DELIMITER)
         for f in files:
-            mode = f.get('mode', DEFAULT_FILE_MODE)
+            mode = f.get("mode", DEFAULT_FILE_MODE)
             # add file to output
             file_output = (
-                '# path: {0}\n'
-                '# mode: {1}\n\n'
-                '{2}\n\n'.format(f['path'], mode, f['contents'])
+                "# path: {0}\n"
+                "# mode: {1}\n\n"
+                "{2}\n\n".format(f["path"], mode, f["contents"])
             )
             output += file_output
         return output
 
     def _deduplicate_files(self):
-        files = self.config.get('files', [])
+        files = self.config.get("files", [])
         if not files:
             return
         files_dict = OrderedDict()
         for file in files:
-            files_dict[file['path']] = file
-        self.config['files'] = list(files_dict.values())
+            files_dict[file["path"]] = file
+        self.config["files"] = list(files_dict.values())
 
-    @draft4_format_checker.checks('cidr', AssertionError)
+    @draft4_format_checker.checks("cidr", AssertionError)
     def _cidr_notation(value):
         try:
             ipaddress.ip_network(value)
@@ -153,9 +153,9 @@ def render(self, files=True):
             self.to_intermediate()
         self._deduplicate_files()
         # support multiple renderers
-        renderers = getattr(self, 'renderers', None) or [self.renderer]
+        renderers = getattr(self, "renderers", None) or [self.renderer]
         # convert intermediate data structure to native configuration
-        output = ''
+        output = ""
         for renderer_class in renderers:
             renderer = renderer_class(self)
             output += renderer.render()
@@ -168,7 +168,7 @@ def render(self, files=True):
             files_output = self._render_files()
             if files_output:
                 # max 2 new lines
-                output += files_output.replace('\n\n\n', '\n\n')
+                output += files_output.replace("\n\n\n", "\n\n")
         # return the configuration
         return output
 
@@ -185,7 +185,7 @@ def json(self, validate=True, *args, **kwargs):
             self.validate()
         # automatically adds NetJSON type
         config = deepcopy(self.config)
-        config.update({'type': 'DeviceConfiguration'})
+        config.update({"type": "DeviceConfiguration"})
         return json.dumps(config, *args, **kwargs)
 
     def generate(self):
@@ -196,7 +196,7 @@ def generate(self):
         :returns: in-memory tar.gz archive, instance of ``BytesIO``
         """
         tar_bytes = BytesIO()
-        tar = tarfile.open(fileobj=tar_bytes, mode='w')
+        tar = tarfile.open(fileobj=tar_bytes, mode="w")
         self._generate_contents(tar)
         self._process_files(tar)
         tar.close()
@@ -206,7 +206,7 @@ def generate(self):
         # to achieve this we must use the python `gzip` library because the `tarfile`
         # library does not seem to offer the possibility to modify the gzip `mtime`.
         gzip_bytes = BytesIO()
-        gz = gzip.GzipFile(fileobj=gzip_bytes, mode='wb', mtime=0)
+        gz = gzip.GzipFile(fileobj=gzip_bytes, mode="wb", mtime=0)
         gz.write(tar_bytes.getvalue())
         gz.close()
         gzip_bytes.seek(0)  # set pointer to beginning of stream
@@ -215,7 +215,7 @@ def generate(self):
     def _generate_contents(self, tar):
         raise NotImplementedError()
 
-    def write(self, name, path='./'):
+    def write(self, name, path="./"):
         """
         Like ``generate`` but writes to disk.
 
@@ -224,10 +224,10 @@ def write(self, name, path='./'):
         :returns: None
         """
         byte_object = self.generate()
-        file_name = '{0}.tar.gz'.format(name)
-        if not path.endswith('/'):
-            path += '/'
-        f = open('{0}{1}'.format(path, file_name), 'wb')
+        file_name = "{0}.tar.gz".format(name)
+        if not path.endswith("/"):
+            path += "/"
+        f = open("{0}{1}".format(path, file_name), "wb")
         f.write(byte_object.getvalue())
         f.close()
 
@@ -239,16 +239,16 @@ def _process_files(self, tar):
         :returns: None
         """
         # insert additional files
-        for file_item in self.config.get('files', []):
-            path = file_item['path']
+        for file_item in self.config.get("files", []):
+            path = file_item["path"]
             # remove leading slashes from path
-            if path.startswith('/'):
+            if path.startswith("/"):
                 path = path[1:]
             self._add_file(
                 tar=tar,
                 name=path,
-                contents=file_item['contents'],
-                mode=file_item.get('mode', DEFAULT_FILE_MODE),
+                contents=file_item["contents"],
+                mode=file_item.get("mode", DEFAULT_FILE_MODE),
             )
 
     def _add_file(self, tar, name, contents, mode=DEFAULT_FILE_MODE):
@@ -261,7 +261,7 @@ def _add_file(self, tar, name, contents, mode=DEFAULT_FILE_MODE):
         :param mode: string representing file mode, defaults to 644
         :returns: None
         """
-        byte_contents = BytesIO(contents.encode('utf8'))
+        byte_contents = BytesIO(contents.encode("utf8"))
         info = tarfile.TarInfo(name=name)
         info.size = len(contents)
         # mtime must be 0 or any checksum operation
@@ -292,16 +292,16 @@ def to_intermediate(self):
                 value = OrderedDict(value)
             if value:
                 self.intermediate_data = merge_config(
-                    self.intermediate_data, value, list_identifiers=['.name']
+                    self.intermediate_data, value, list_identifiers=[".name"]
                 )
 
     def parse(self, native):
         """
         Parses a native configuration and converts
         it to a NetJSON configuration dictionary
         """
-        if not hasattr(self, 'parser') or not self.parser:
-            raise NotImplementedError('Parser class not specified')
+        if not hasattr(self, "parser") or not self.parser:
+            raise NotImplementedError("Parser class not specified")
         parser = self.parser(native)
         self.intermediate_data = parser.intermediate_data
         del parser

netjsonconfig/backends/base/converter.py

@@ -43,18 +43,18 @@ def type_cast(self, item, schema=None):
         """
         if schema is None:
             schema = self._schema
-        properties = schema['properties']
+        properties = schema["properties"]
         for key, value in item.items():
             if key not in properties:
                 continue
             try:
-                json_type = properties[key]['type']
+                json_type = properties[key]["type"]
             except KeyError:
                 json_type = None
-            if json_type == 'integer' and not isinstance(value, int):
+            if json_type == "integer" and not isinstance(value, int):
                 value = int(value)
-            elif json_type == 'boolean' and not isinstance(value, bool):
-                value = value == '1'
+            elif json_type == "boolean" and not isinstance(value, bool):
+                value = value == "1"
             item[key] = value
         return item
 

netjsonconfig/backends/base/parser.py

@@ -13,10 +13,10 @@ def __init__(self, config):
             data = self.parse_text(config)
         # presence of read() method
         # indicates a file-like object
-        elif hasattr(config, 'read'):
+        elif hasattr(config, "read"):
             data = self.parse_tar(config)
         else:
-            raise ParseError('Unrecognized format')
+            raise ParseError("Unrecognized format")
         self.intermediate_data = data
 
     def parse_text(self, config):