Please black (doc directory). (#897)

Author: janiversen

doc/api/epydoc/build.py

@@ -14,6 +14,7 @@
     pkg_resources.require("epydoc")
 
     from epydoc.cli import cli  # pylint: disable=import-error
+
     sys.argv = """epydoc.py pymodbus
         --html --simple-term --quiet
         --include-log

doc/api/pydoc/build.py

@@ -81,8 +81,11 @@ def classify_class_attrs(cls):
             kind = "class method"
         elif isinstance(obj, property):
             kind = "property"
-        elif (inspect.ismethod(obj_via_getattr) or  # noqa: W504
-              inspect.ismethoddescriptor(obj_via_getattr)):
+        elif inspect.ismethod(
+            obj_via_getattr
+        ) or inspect.ismethoddescriptor(
+            obj_via_getattr
+        ):
             kind = "method"
         else:
             kind = "data"
@@ -98,24 +101,28 @@ def classify_class_attrs(cls):
 class DefaultFormatter(pydoc.HTMLDoc):
     """Default formatter."""
 
-    def docmodule(self, object, name=None, mod=None, packageContext=None, *ignored):  # noqa: C901
+    def docmodule(  # NOSONAR # noqa: C901
+        self, object, name=None, mod=None, packageContext=None, *ignored  # NOSONAR
+    ):  # noqa: C901
         """Produce HTML documentation for a module object."""
         my_name = object.__name__  # ignore the passed-in name
         parts = split(my_name, ".")
         links = []
         for i in range(len(parts) - 1):
             links.append(
-                "<a href=\"%s.html\"><font color=\"#ffffff\">%s</font></a>" %
-                (join(parts[:i + 1], "."), parts[i]))
+                '<a href="%s.html"><font color="#ffffff">%s</font></a>'
+                % (join(parts[: i + 1], "."), parts[i])
+            )
         linkedname = join(links + parts[-1:], ".")
         head = "<big><big><strong>%s</strong></big></big>" % linkedname
         try:
             path = inspect.getabsfile(object)
             url = path
             if sys.platform == "win32":
                 import nturl2path
+
                 url = nturl2path.pathname2url(path)
-            filelink = "<a href=\"file:%s\">%s</a>" % (url, path)
+            filelink = '<a href="file:%s">%s</a>' % (url, path)
         except TypeError:
             filelink = "(built-in)"
         info = []
@@ -129,7 +136,8 @@ def docmodule(self, object, name=None, mod=None, packageContext=None, *ignored):
         if info:
             head = head + " (%s)" % join(info, ", ")
         result = self.heading(
-            head, "#ffffff", "#7799ee", "<a href=\".\">index</a><br>" + filelink)
+            head, "#ffffff", "#7799ee", '<a href=".">index</a><br>' + filelink
+        )
 
         modules = inspect.getmembers(object, inspect.ismodule)
 
@@ -185,23 +193,25 @@ def docmodule(self, object, name=None, mod=None, packageContext=None, *ignored):
         elif modules:
             # FIX   contents = self.multicolumn(
             # FIX   modules, lambda (key, value), s=self: s.modulelink(value))
-            result = result + self.bigsection(
-                "Modules", "#fffff", "#aa55cc", contents)
+            result = result + self.bigsection("Modules", "#fffff", "#aa55cc", contents)
 
         if classes:
             # FIX  classlist = map(lambda (key, value): value, classes)
             contents = [
-                self.formattree(inspect.getclasstree(classlist, 1), my_name)]  # noqa: F821
+                self.formattree(inspect.getclasstree(classlist, 1), my_name)  # noqa: F821
+            ]
             for key, value in classes:
                 contents.append(self.document(value, key, my_name, fdict, cdict))
             result = result + self.bigsection(
-                "Classes", "#ffffff", "#ee77aa", join(contents))
+                "Classes", "#ffffff", "#ee77aa", join(contents)
+            )
         if funcs:
             contents = []
             for key, value in funcs:
                 contents.append(self.document(value, key, my_name, fdict, cdict))
             result = result + self.bigsection(
-                "Functions", "#ffffff", "#eeaa77", join(contents))
+                "Functions", "#ffffff", "#eeaa77", join(contents)
+            )
         if data:
             contents = []
             for key, value in data:
@@ -210,25 +220,22 @@ def docmodule(self, object, name=None, mod=None, packageContext=None, *ignored):
                 except Exception:  # nosec
                     pass
             result = result + self.bigsection(
-                "Data", "#ffffff", "#55aa55", join(contents, "<br>\n"))
+                "Data", "#ffffff", "#55aa55", join(contents, "<br>\n")
+            )
         if hasattr(object, "__author__"):
             contents = self.markup(str(object.__author__), self.preformat)
-            result = result + self.bigsection(
-                "Author", "#ffffff", "#7799ee", contents)
+            result = result + self.bigsection("Author", "#ffffff", "#7799ee", contents)
         if hasattr(object, "__credits__"):
             contents = self.markup(str(object.__credits__), self.preformat)
-            result = result + self.bigsection(
-                "Credits", "#ffffff", "#7799ee", contents)
+            result = result + self.bigsection("Credits", "#ffffff", "#7799ee", contents)
 
         return result
 
     def classlink(self, object, modname):
         """Make a link for a class."""
         name, module = object.__name__, sys.modules.get(object.__module__)
         if hasattr(module, name) and getattr(module, name) is object:
-            return "<a href=\"%s.html#%s\">%s</a>" % (
-                module.__name__, name, name
-            )
+            return '<a href="%s.html#%s">%s</a>' % (module.__name__, name, name)
         return pydoc.classname(object, modname)
 
     def moduleSection(self, object, packageContext):
@@ -269,11 +276,9 @@ def moduleSection(self, object, packageContext):
                         self.modpkglink((modname, name, ispackage, isshadowed))
                     )
             contents = string.join(items, "<br>")
-            result = self.bigsection(
-                "Package Contents", "#ffffff", "#aa55cc", contents)
+            result = self.bigsection("Package Contents", "#ffffff", "#aa55cc", contents)
         elif modules:
-            result = self.bigsection(
-                "Modules", "#fffff", "#aa55cc", contents)
+            result = self.bigsection("Modules", "#fffff", "#aa55cc", contents)
         else:
             result = ""
         return result
@@ -309,10 +314,13 @@ class PackageDocumentationGenerator:
     """
 
     def __init__(
-        self, baseModules, destinationDirectory=".",
-        recursion=1, exclusions=(),
+        self,
+        baseModules,  # NOSONAR
+        destinationDirectory=".",  # NOSONAR
+        recursion=1,
+        exclusions=(),
         recursionStops=(),
-        formatter=None
+        formatter=None,
     ):
         """Initialize."""
         self.destinationDirectory = os.path.abspath(destinationDirectory)
@@ -329,8 +337,10 @@ def __init__(
             try:
                 self.exclusions[exclusion] = pydoc.locate(exclusion)
             except pydoc.ErrorDuringImport:
-                self.warn("""Unable to import the module %s which was specified as an exclusion module""" %
-                          (repr(exclusion)))
+                self.warn(
+                    """Unable to import the module %s which was specified as an exclusion module"""
+                    % (repr(exclusion))
+                )
         self.formatter = formatter or DefaultFormatter()
         for base in baseModules:
             self.addBase(base)
@@ -349,7 +359,10 @@ def addBase(self, specifier):
             self.baseSpecifiers[specifier] = pydoc.locate(specifier)
             self.pending.append(specifier)
         except pydoc.ErrorDuringImport:
-            self.warn("""Unable to import the module %s which was specified as a base module""" % (repr(specifier)))
+            self.warn(
+                """Unable to import the module %s which was specified as a base module"""
+                % (repr(specifier))
+            )
 
     def addInteresting(self, specifier):
         """Add a module to the list of interesting modules."""
@@ -398,21 +411,27 @@ def process(self):
                     pass
                 except pydoc.ErrorDuringImport as value:
                     self.info("""   ... FAILED %s""" % (repr(value)))
-                    self.warn("""Unable to import the module %s""" % (repr(self.pending[0])))
+                    self.warn(
+                        """Unable to import the module %s""" % (repr(self.pending[0]))  # NOSONAR
+                    )
                 except (SystemError, SystemExit) as value:
                     self.info("""   ... FAILED %s""" % (repr(value)))
-                    self.warn("""Unable to import the module %s""" % (repr(self.pending[0])))
+                    self.warn(
+                        """Unable to import the module %s""" % (repr(self.pending[0]))  # NOSONAR
+                    )
                 except Exception as value:
                     self.info("""   ... FAILED %s""" % (repr(value)))
-                    self.warn("""Unable to import the module %s""" % (repr(self.pending[0])))
+                    self.warn(
+                        """Unable to import the module %s""" % (repr(self.pending[0]))  # NOSONAR
+                    )
                 else:
                     page = self.formatter.page(
                         pydoc.describe(object),
                         self.formatter.docmodule(
                             object,
                             object.__name__,
                             packageContext=self,
-                        )
+                        ),
                     )
                     file = open(
                         os.path.join(
@@ -439,11 +458,9 @@ def clean(self, objectList, object):
         for key, value in objectList[:]:
             for excludeObject in self.exclusions.values():
                 if hasattr(excludeObject, key) and excludeObject is not object:
-                    if (
-                        getattr(excludeObject, key) is value or  # noqa: W504
-                        (hasattr(excludeObject, "__name__") and  # noqa: W504
-                         excludeObject.__name__ == "Numeric"
-                         )
+                    if getattr(excludeObject, key) is value or (
+                        hasattr(excludeObject, "__name__")
+                        and excludeObject.__name__ == "Numeric"
                     ):
                         objectList[:] = [(k, o) for k, o in objectList if k != key]
 

doc/api/pydoctor/build.py

@@ -9,9 +9,11 @@
     import os
     import shutil
     import pkg_resources
+
     pkg_resources.require("pydoctor")
 
     from pydoctor.driver import main  # pylint: disable=import-error
+
     sys.argv = """pydoctor.py --quiet
         --project-name=Pymodbus
         --project-url=http://code.google.com/p/pymodbus/

doc/conf.py

@@ -21,6 +21,7 @@
 import sys
 from recommonmark.transform import AutoStructify
 from pymodbus import __version__
+
 parent_dir = os.path.abspath(os.pardir)
 # examples = os.path.join(parent_dir, "examples")
 example_contrib = os.path.join(parent_dir, "examples/contrib")
@@ -45,7 +46,6 @@
 # extensions coming with Sphinx (named "sphinx.ext.*") or your custom
 # ones.
 
-# extensions = ["sphinx.ext.autodoc", "m2r", "recommonmark"]
 extensions = ["sphinx.ext.autodoc", "m2r2"]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -59,7 +59,6 @@
 # }
 
 source_suffix = [".rst", ".md"]
-# source_suffix = ".rst"
 
 # The master toctree document.
 master_doc = "index"  # pylint: disable=invalid-name
@@ -141,15 +140,12 @@
     # The paper size ("letterpaper" or "a4paper").
     #
     # "papersize": "letterpaper",
-
     # The font size ("10pt", "11pt" or "12pt").
     #
     # "pointsize": "10pt",
-
     # Additional stuff for the LaTeX preamble.
     #
     # "preamble": "",
-
     # Latex figure (float) alignment
     #
     # "figure_align": "htbp",
@@ -159,19 +155,21 @@
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [  # NOSONAR
-    (master_doc, "PyModbus.tex", "PyModbus Documentation",  # NOSONAR
-     "Sanjay", "manual"),
+    (
+        master_doc,
+        "PyModbus.tex",
+        "PyModbus Documentation",  # NOSONAR
+        "Sanjay",
+        "manual",
+    ),
 ]
 
 
 # -- Options for manual page output ---------------------------------------
 
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
-man_pages = [
-    (master_doc, "pymodbus", "PyModbus Documentation",
-     [author], 1)
-]
+man_pages = [(master_doc, "pymodbus", "PyModbus Documentation", [author], 1)]
 
 
 # -- Options for Texinfo output -------------------------------------------
@@ -180,18 +178,26 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    (master_doc, "PyModbus", "PyModbus Documentation",
-     author, "PyModbus", "One line description of project.",
-     "Miscellaneous"),
+    (
+        master_doc,
+        "PyModbus",
+        "PyModbus Documentation",
+        author,
+        "PyModbus",
+        "One line description of project.",
+        "Miscellaneous",
+    ),
 ]
 
 
 def setup(app):
     """Do setup."""
-    app.add_config_value("recommonmark_config", {
-        "url_resolver": lambda url: github_doc_root + url,
-        "auto_toc_tree_section": "Contents",
-    },
-        True
+    app.add_config_value(
+        "recommonmark_config",
+        {
+            "url_resolver": lambda url: github_doc_root + url,
+            "auto_toc_tree_section": "Contents",
+        },
+        True,
     )
     app.add_transform(AutoStructify)

examples/common/async_asyncio_serial_client.py

@@ -127,7 +127,7 @@ async def start_async_test(client):  # pylint: disable=redefined-outer-name
     # ----------------------------------------------------------------------- #
     # socat -d -d PTY,link=/tmp/ptyp0,raw,echo=0,ispeed=9600 PTY,
     # link=/tmp/ttyp0,raw,echo=0,ospeed=9600
-    loop, client = ModbusClient(schedulers.ASYNC_IO, port="/tmp/ttyp0",  # nosec pylint: disable=unpacking-non-sequence
+    loop, client = ModbusClient(schedulers.ASYNC_IO, port="/tmp/ttyp0",  # NOSONAR # nosec pylint: disable=unpacking-non-sequence
                                 baudrate=9600, method="rtu")
     loop.run_until_complete(start_async_test(client.protocol))
     loop.close()