Adjust string literals to pep8 standard. (#896)

Author: janiversen

doc/api/doxygen/build.py

@@ -31,10 +31,10 @@ def which(program):
     return None
 
 
-if which('doxygen') is not None:
+if which("doxygen") is not None:
     print("Building Doxygen API Documentation")
     os.system("doxygen .doxygen")  # nosec
-    if os.path.exists('../../../build'):
+    if os.path.exists("../../../build"):
         shutil.move("html", "../../../build/doxygen")
 else:
     print("Doxygen not available...not building")

doc/api/epydoc/build.py

@@ -32,7 +32,7 @@
     print("Building Epydoc API Documentation")
     cli()
 
-    if os.path.exists('../../../build'):
+    if os.path.exists("../../../build"):
         shutil.move("html", "../../../build/epydoc")
 except Exception:  # pylint: disable=broad-except
     traceback.print_exc(file=sys.stdout)

doc/api/pydoc/build.py

@@ -26,18 +26,18 @@ def classify_class_attrs(cls):
         0. The name (a string).
 
         1. The kind of attribute this is, one of these strings:
-               'class method'    created via classmethod()
-               'static method'   created via staticmethod()
-               'property'        created via property()
-               'method'          any other flavor of method
-               'data'            not a method
+               "class method"    created via classmethod()
+               "static method"   created via staticmethod()
+               "property"        created via property()
+               "method"          any other flavor of method
+               "data"            not a method
 
         2. The class which defined this attribute (a class).
 
-        3. The object as obtained directly from the defining class's
+        3. The object as obtained directly from the defining class"s
            __dict__, not via getattr.  This is especially important for
            data attributes:  C.data is just a data object, but
-           C.__dict__['data'] may be a data descriptor with additional
+           C.__dict__["data"] may be a data descriptor with additional
            info, like a __doc__ string.
 
     Note: This version is patched to work with Zope Interface-bearing objects
@@ -101,72 +101,72 @@ class DefaultFormatter(pydoc.HTMLDoc):
     def docmodule(self, object, name=None, mod=None, packageContext=None, *ignored):  # noqa: C901
         """Produce HTML documentation for a module object."""
         my_name = object.__name__  # ignore the passed-in name
-        parts = split(my_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]))
-        linkedname = join(links + parts[-1:], '.')
-        head = '<big><big><strong>%s</strong></big></big>' % linkedname
+                "<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':
+            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)'
+            filelink = "(built-in)"
         info = []
-        if hasattr(object, '__version__'):
+        if hasattr(object, "__version__"):
             version = str(object.__version__)
-            if version[:11] == '$' + 'Revision: ' and version[-1:] == '$':
+            if version[:11] == "$" + "Revision: " and version[-1:] == "$":
                 version = strip(version[11:-1])
-            info.append('version %s' % self.escape(version))
-        if hasattr(object, '__date__'):
+            info.append("version %s" % self.escape(version))
+        if hasattr(object, "__date__"):
             info.append(self.escape(str(object.__date__)))
         if info:
-            head = head + ' (%s)' % join(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)
 
         classes, cdict = [], {}
         for key, value in inspect.getmembers(object, inspect.isclass):
             if (inspect.getmodule(value) or object) is object:
                 classes.append((key, value))
-                cdict[key] = cdict[value] = '#' + key
+                cdict[key] = cdict[value] = "#" + key
         for key, value in classes:
             for base in value.__bases__:
                 key, modname = base.__name__, base.__module__
                 module = sys.modules.get(modname)
                 if modname != my_name and module and hasattr(module, key):
                     if getattr(module, key) is base:
                         if key not in cdict:
-                            cdict[key] = cdict[base] = modname + '.html#' + key
+                            cdict[key] = cdict[base] = modname + ".html#" + key
         funcs, fdict = [], {}
         for key, value in inspect.getmembers(object, inspect.isroutine):
             if inspect.isbuiltin(value) or inspect.getmodule(value) is object:
                 funcs.append((key, value))
-                fdict[key] = '#-' + key
+                fdict[key] = "#-" + key
                 if inspect.isfunction(value):
                     fdict[value] = fdict[key]
         data = []
         for key, value in inspect.getmembers(object, pydoc.isdata):
-            if key not in ['__builtins__', '__doc__']:
+            if key not in ["__builtins__", "__doc__"]:
                 data.append((key, value))
 
         doc = self.markup(pydoc.getdoc(object), self.preformat, fdict, cdict)
-        doc = doc and '<tt>%s</tt>' % doc
-        result = result + '<p>%s</p>\n' % doc
+        doc = doc and "<tt>%s</tt>" % doc
+        result = result + "<p>%s</p>\n" % doc
 
         packageContext.clean(classes, object)
         packageContext.clean(funcs, object)
         packageContext.clean(data, object)
 
-        if hasattr(object, '__path__'):
+        if hasattr(object, "__path__"):
             modpkgs = []
             modnames = []
             for file in os.listdir(object.__path__[0]):
@@ -180,13 +180,13 @@ def docmodule(self, object, name=None, mod=None, packageContext=None, *ignored):
             modpkgs.sort()
             contents = self.multicolumn(modpkgs, self.modpkglink)
             # #   result = result + self.bigsection(
-            # #   'Package Contents', '#ffffff', '#aa55cc', contents)
+            # #   "Package Contents", "#ffffff", "#aa55cc", contents)
             result = result + self.moduleSection(object, packageContext)
         elif modules:
             # FIX   contents = self.multicolumn(
             # FIX   modules, lambda (key, value), s=self: s.modulelink(value))
             result = result + self.bigsection(
-                'Modules', '#fffff', '#aa55cc', contents)
+                "Modules", "#fffff", "#aa55cc", contents)
 
         if classes:
             # FIX  classlist = map(lambda (key, value): value, classes)
@@ -195,13 +195,13 @@ def docmodule(self, object, name=None, mod=None, packageContext=None, *ignored):
             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,23 +210,23 @@ 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'))
-        if hasattr(object, '__author__'):
+                "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)
-        if hasattr(object, '__credits__'):
+                "Author", "#ffffff", "#7799ee", contents)
+        if hasattr(object, "__credits__"):
             contents = self.markup(str(object.__credits__), self.preformat)
             result = result + self.bigsection(
-                'Credits', '#ffffff', '#7799ee', contents)
+                "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>' % (
+            return "<a href=\"%s.html#%s\">%s</a>" % (
                 module.__name__, name, name
             )
         return pydoc.classname(object, modname)
@@ -237,7 +237,7 @@ def moduleSection(self, object, packageContext):
         packageContext.clean(modules, object)
         packageContext.recurseScan(modules)
 
-        if hasattr(object, '__path__'):
+        if hasattr(object, "__path__"):
             modpkgs = []
             modnames = []
             for file in os.listdir(object.__path__[0]):
@@ -251,7 +251,7 @@ def moduleSection(self, object, packageContext):
             modpkgs.sort()
             # do more recursion here...
             for (modname, name, ya, yo) in modpkgs:
-                packageContext.addInteresting(join((object.__name__, modname), '.'))
+                packageContext.addInteresting(join((object.__name__, modname), "."))
             items = []
             for (modname, name, ispackage, isshadowed) in modpkgs:
                 try:
@@ -268,12 +268,12 @@ def moduleSection(self, object, packageContext):
                     items.append(
                         self.modpkglink((modname, name, ispackage, isshadowed))
                     )
-            contents = string.join(items, '<br>')
+            contents = string.join(items, "<br>")
             result = self.bigsection(
-                'Package Contents', '#ffffff', '#aa55cc', contents)
+                "Package Contents", "#ffffff", "#aa55cc", contents)
         elif modules:
             result = self.bigsection(
-                'Modules', '#fffff', '#aa55cc', contents)
+                "Modules", "#fffff", "#aa55cc", contents)
         else:
             result = ""
         return result
@@ -288,7 +288,7 @@ class AlreadyDone(Exception):
 class PackageDocumentationGenerator:
     """A package document generator creates documentation.
 
-    for an entire package using pydoc's machinery.
+    for an entire package using pydoc"s machinery.
 
     baseModules -- modules which will be included
         and whose included and children modules will be
@@ -419,7 +419,7 @@ def process(self):
                             self.destinationDirectory,
                             self.pending[0] + ".html",
                         ),
-                        'w',
+                        "w",
                     )
                     file.write(page)
                     file.close()
@@ -441,7 +441,7 @@ def clean(self, objectList, object):
                 if hasattr(excludeObject, key) and excludeObject is not object:
                     if (
                         getattr(excludeObject, key) is value or  # noqa: W504
-                        (hasattr(excludeObject, '__name__') and  # noqa: W504
+                        (hasattr(excludeObject, "__name__") and  # noqa: W504
                          excludeObject.__name__ == "Numeric"
                          )
                     ):
@@ -466,11 +466,11 @@ def recurseScan(self, objectList):
 
     print("Building Pydoc API Documentation")
     PackageDocumentationGenerator(
-        baseModules=['pymodbus', '__builtin__'],
+        baseModules=["pymodbus", "__builtin__"],
         destinationDirectory="./html/",
-        exclusions=['math', 'string', 'twisted'],
+        exclusions=["math", "string", "twisted"],
         recursionStops=[],
     ).process()
 
-    if os.path.exists('../../../build'):
+    if os.path.exists("../../../build"):
         shutil.move("html", "../../../build/pydoc")

doc/api/pydoctor/build.py

@@ -22,7 +22,7 @@
     print("Building Pydoctor API Documentation")
     main(sys.argv[1:])
 
-    if os.path.exists('../../../build'):
+    if os.path.exists("../../../build"):
         shutil.move("html", "../../../build/pydoctor")
 except:  # noqa: E722 NOSONAR pylint: disable=bare-except
     print("Pydoctor unavailable...not building")