[lint] add new version of .pylintrc and fix issues reported by pylint

Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>

Author: return42

.pylintrc

@@ -1,12 +1,5 @@
 # -*- coding: utf-8; mode: conf -*-
-# lint Python modules using external checkers.
-#
-# This is the main checker controlling the other ones and the reports
-# generation. It is itself both a raw checker and an astng checker in order
-# to:
-# * handle message activation / deactivation at the module level
-# * handle some basic but necessary stats'data (number of classes, methods...)
-#
+
 [MASTER]
 
 # A comma-separated list of package or module names from where C extensions may
@@ -59,7 +52,13 @@ confidence=
 # --enable=similarities". If you want to run only the classes checker, but have
 # no Warning level messages displayed, use"--disable=all --enable=classes
 # --disable=W"
-disable=bad-whitespace, duplicate-code
+disable=duplicate-code,
+        missing-function-docstring,
+        consider-using-f-string,
+	use-dict-literal,
+	unnecessary-lambda-assignment,
+	redundant-u-string-prefix,
+	consider-iterating-dictionary
 
 # Enable the message, report, category or checker with the given id(s). You can
 # either give multiple identifier separated by comma (,) or put this option
@@ -105,39 +104,21 @@ max-nested-blocks=5
 
 [BASIC]
 
-# List of builtins function names that should not be used, separated by a comma
-bad-functions=map,filter,apply,input
-
-# Naming hint for argument names
-argument-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$
-
 # Regular expression matching correct argument names
 argument-rgx=(([a-z][a-zA-Z0-9_]{2,30})|(_[a-z0-9_]*))$
 
-# Naming hint for attribute names
-attr-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$
-
 # Regular expression matching correct attribute names
 attr-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*)|([A-Z0-9_]*))$
 
 # Bad variable names which should always be refused, separated by a comma
 bad-names=foo,bar,baz,toto,tutu,tata
 
-# Naming hint for class attribute names
-class-attribute-name-hint=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$
-
 # Regular expression matching correct class attribute names
 class-attribute-rgx=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$
 
-# Naming hint for class names
-class-name-hint=[A-Z_][a-zA-Z0-9]+$
-
 # Regular expression matching correct class names
 class-rgx=[A-Z_][a-zA-Z0-9]+$
 
-# Naming hint for constant names
-const-name-hint=(([A-Z_][A-Z0-9_]*)|(__.*__))$
-
 # Regular expression matching correct constant names
 const-rgx=(([a-zA-Z_][a-zA-Z0-9_]*)|(__.*__))$
 #const-rgx=[f]?[A-Z_][a-zA-Z0-9_]{2,30}$
@@ -146,9 +127,6 @@ const-rgx=(([a-zA-Z_][a-zA-Z0-9_]*)|(__.*__))$
 # ones are exempt.
 docstring-min-length=-1
 
-# Naming hint for function names
-function-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$
-
 # Regular expression matching correct function names
 function-rgx=(([a-z][a-zA-Z0-9_]{2,30})|(_[a-z0-9_]*))$
 
@@ -158,21 +136,12 @@ good-names=i,j,k,ex,Run,_,log,cfg,id
 # Include a hint for the correct naming format with invalid-name
 include-naming-hint=no
 
-# Naming hint for inline iteration names
-inlinevar-name-hint=[A-Za-z_][A-Za-z0-9_]*$
-
 # Regular expression matching correct inline iteration names
 inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$
 
-# Naming hint for method names
-method-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$
-
 # Regular expression matching correct method names
 method-rgx=(([a-z][a-zA-Z0-9_]{2,30})|(_[a-z0-9_]*))$
 
-# Naming hint for module names
-module-name-hint=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$
-
 # Regular expression matching correct module names
 #module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$
 module-rgx=([a-z_][a-z0-9_]*)$
@@ -189,9 +158,6 @@ no-docstring-rgx=^_
 # to this list to register other decorators that produce valid properties.
 property-classes=abc.abstractproperty
 
-# Naming hint for variable names
-variable-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$
-
 # Regular expression matching correct variable names
 variable-rgx=(([a-z][a-zA-Z0-9_]{2,30})|(_[a-z0-9_]*)|([a-z]))$
 
@@ -217,12 +183,6 @@ max-line-length=120
 # Maximum number of lines in a module
 max-module-lines=2000
 
-# List of optional constructs for which whitespace checking is disabled. `dict-
-# separator` is used to allow tabulation in dicts, etc.: {1  : 1,\n222: 2}.
-# `trailing-comma` allows a space between comma and closing bracket: (a, ).
-# `empty-line` allows space-only lines.
-no-space-check=trailing-comma,dict-separator
-
 # Allow the body of a class to be on the same line as the declaration if body
 # contains single statement.No config file found, using default configuration
 
@@ -243,7 +203,7 @@ logging-modules=logging
 [MISCELLANEOUS]
 
 # List of note tags to take in consideration, separated by a comma.
-notes=FIXME,XXX,TODO
+notes=FIXME,XXX
 
 
 [SIMILARITIES]
@@ -441,4 +401,4 @@ known-third-party=enchant
 
 # Exceptions that will emit a warning when being caught. Defaults to
 # "Exception"
-overgeneral-exceptions=Exception
+overgeneral-exceptions=builtins.Exception

linuxdoc/autodoc.py

@@ -131,6 +131,7 @@ def main():
         CMD.rst_files = []
 
     if CMD.threads > 1:
+        # pylint: disable=consider-using-with
         pool = multiprocessing.Pool(CMD.threads)
         pool.map(autodoc_file, gather_filenames(CMD))
         pool.close()

linuxdoc/cdomainv2.py

@@ -88,11 +88,11 @@ def handle_signature(self, sig, signode):
             if self.objtype == 'function':
                 fullname = self.options["name"]
             else:
-                # FIXME: handle :name: value of other declaration types?
+                # ToDo: handle :name: value of other declaration types?
                 pass
         return fullname
 
-    def add_target_and_index(self, name, sig, signode):  # pylint: disable=arguments-differ
+    def add_target_and_index(self, name, sig, signode):  # pylint: disable=arguments-renamed
         # for C API items we add a prefix since names are usually not qualified
         # by a module name and so easily clash with e.g. section titles
         targetname = 'c.' + name

linuxdoc/kernel_doc.py

@@ -275,7 +275,6 @@ def map_row(row, map_table):
     return row
 
 def highlight_parser(text, map_table):
-    # FIXME: document this
     block_indent = 0
     row_indent = 0
     state = 'highlight' # [highlight|literal]
@@ -611,11 +610,11 @@ def setParser(self, parser):
     def setOptions(self, options):
         self.options = options
 
-    def highlight(self, cont):
+    def highlight(self, text):
         u"""returns *highlighted* text"""
         if self.options.highlight:
-            return highlight_parser(cont, self.HIGHLIGHT_MAP)
-        return cont
+            return highlight_parser(text, self.HIGHLIGHT_MAP)
+        return text
 
     def get_preamble(self):
         retVal = ""
@@ -2120,9 +2119,9 @@ def state_2(self, line):
             else:
                 if ( self.options.markup == "reST"
                      and self.ctx.section.startswith("@")):
-                    # FIXME: I doubt if it is a good idea to strip leading
-                    # whitespaces in parameter description, but *over all* we
-                    # get better reST output.
+                    # I doubt if it is a good idea to strip leading whitespaces
+                    # in parameter description, but *over all* we get better
+                    # reST output.
                     cont_line = cont_line.strip()
                     # Sub-sections in parameter descriptions are not provided,
                     # but if this is a "lorem:\n" line create a new paragraph.
@@ -2428,15 +2427,6 @@ def dump_section(self, name, cont):
         self.debug("dump_section(): %(name)s", name = name)
         name = name.strip()
         cont = cont.rstrip() # dismiss trailing whitespace
-        # FIXME: sections with '%CONST' prefix no longer exists
-        # _type_constant     = RE(r"\%([-_\w]+)")
-        #if _type_constant.match(name):  # '%CONST' - name of a constant.
-        #    name = _type_constant[0]
-        #    self.debug("constant section '%(name)s'",  name = name)
-        #    if self.ctx.constants.get(name, None):
-        #        self.error("duplicate constant definition '%(name)s'"
-        #                   , name = name)
-        #    self.ctx.constants[name] = cont
 
         _type_param  = RE(r"\@(\w[.\w]*)")  # match @foo and @foo.bar
         if _type_param.match(name):   # '@parameter' - name of a parameter

linuxdoc/kernel_include.py

@@ -90,7 +90,8 @@ def _run(self):  # pylint: disable=R
             include_file = io.FileInput(source_path=path,
                                         encoding=encoding,
                                         error_handler=e_handler)
-        except UnicodeEncodeError as error:
+        except UnicodeEncodeError:
+            # pylint: disable=raise-missing-from
             raise self.severe('Problems with "%s" directive path:\n'
                               'Cannot encode input file path "%s" '
                               '(wrong locale?).' %

linuxdoc/kfigure.py

@@ -48,7 +48,7 @@ def mkdir(folder, mode=0o775):
         os.makedirs(folder, mode)
 
 def file2literal(fname):
-    with open(fname, "r") as src:
+    with open(fname, "r", encoding="utf-8") as src:
         data = src.read()
         node = nodes.literal_block(data, data)
     return node
@@ -255,7 +255,7 @@ def dot2format(app, dot_fname, out_fname): # pylint: disable=unused-argument
     cmd = [dot_cmd, '-T%s' % out_format, dot_fname]
     exit_code = 42
 
-    with open(out_fname, "w") as out:
+    with open(out_fname, "w", encoding="utf-8") as out:
         exit_code = subprocess.call(cmd, stdout = out)
         if exit_code != 0:
             # pylint: disable=deprecated-method
@@ -391,7 +391,7 @@ def visit_kernel_render(self, node):
 
     if not path.isfile(tmp_fname):
         mkdir(path.dirname(tmp_fname))
-        with open(tmp_fname, "w") as out:
+        with open(tmp_fname, "w", encoding="utf-8") as out:
             out.write(code)
 
     img_node = nodes.image(node.rawsource, **node.attributes)

linuxdoc/manKernelDoc.py

@@ -290,7 +290,7 @@ class KernelDocManBuilder(ManualPageBuilder):
     def init(self):
         pass
 
-    def is_manpage(self, node):  # pylint: disable=no-self-use
+    def is_manpage(self, node):
         if isinstance(node, nodes.section):
             return bool(
                 Section2Manpage.sec2man_get_first_child(
@@ -305,7 +305,7 @@ def write_doc(self, docname, doctree):
         """Where you actually write something to the filesystem."""
         pass
 
-    def get_partial_document(self, children):  # pylint: disable=no-self-use
+    def get_partial_document(self, children):
         doc_tree =  new_document('<output>')
         doc_tree += children
         return doc_tree
@@ -323,8 +323,10 @@ def write(self, *ignored):
         logger.info(darkgreen("}"))
         man_nodes   = master_tree.traverse(condition=self.is_manpage)
         if not man_nodes and not self.config.man_pages:
-            logger.warn('no "man_pages" config value nor manual section found; no manual pages '
-                        'will be written')
+            logger.warning(
+                'no "man_pages" config value nor manual section found; no manual pages '
+                'will be written'
+            )
             return
 
         logger.info(bold('START writing man pages ... '), nonl=True)

linuxdoc/rstFlatTable.py

@@ -172,7 +172,7 @@ def buildTableNode(self):
             tbody += self.buildTableRowNode(row)
         return table
 
-    def buildTableRowNode(self, row_data, classes=None):  # pylint: disable=no-self-use
+    def buildTableRowNode(self, row_data, classes=None):
         classes = [] if classes is None else classes
         row = nodes.row()
         for cell in row_data:
@@ -332,7 +332,7 @@ def parseRowItem(self, rowItem, rowNum):
             row.append( (cspan, rspan, cellElements) )
         return row
 
-    def parseCellItem(self, cellItem):  # pylint: disable=no-self-use
+    def parseCellItem(self, cellItem):
         # search and remove cspan, rspan colspec from the first element in
         # this listItem (field).
         cspan = rspan = 0

linuxdoc/rstKernelDoc.py

@@ -340,7 +340,7 @@ def parseSource(self, opts):
 
     def run(self):
 
-        # FIXME: think about again; these members has been added for convenience
+        # ToDo: think about again; these members has been added for convenience
         self.parser = None                     # pylint: disable=attribute-defined-outside-init
         self.doc    = self.state.document      # pylint: disable=attribute-defined-outside-init
         self.env    = self.doc.settings.env    # pylint: disable=attribute-defined-outside-init
@@ -362,7 +362,7 @@ def run(self):
             if not self.doc.settings.file_insertion_enabled:
                 raise FaultyOption('docutils: file insertion disabled')
             opts = self.getParserOptions()
-            # FIXME: think about again; these members has been added for convenience
+            # ToDo: think about again; these members has been added for convenience
             self.parser = self.parseSource(opts) # pylint: disable=attribute-defined-outside-init
             self.nodes.extend(self.getNodes())