Fix typo in pylintrc for useless-suppression (#5303)

* Fix typo in pylintrc for useless-suppression

* Fix CI for information messages

* Remove useless disables

* Update CI and docs for 3.8+

Co-authored-by: Pierre Sassoulas <[email protected]>

Author: DanielNoord

.github/workflows/ci.yaml

@@ -9,7 +9,7 @@ on:
 
 env:
   CACHE_VERSION: 3
-  DEFAULT_PYTHON: 3.6
+  DEFAULT_PYTHON: 3.8
   PRE_COMMIT_CACHE: ~/.cache/pre-commit
 
 jobs:

.pre-commit-config.yaml

@@ -57,6 +57,7 @@ repos:
             "-rn",
             "-sn",
             "--rcfile=pylintrc",
+            "--fail-on=I",
             "--load-plugins=pylint.extensions.docparams",
           ]
         # disabled plugins: pylint.extensions.mccabe

ChangeLog

@@ -275,6 +275,12 @@ Release date: TBA
   Closes #3507
   Closes #5087
 
+* It is now recommended to do ``pylint`` development on ``Python`` 3.8 or higher. This
+  allows using the latest ``ast`` parser.
+
+* All standard jobs in the ``pylint`` CI now run on ``Python`` 3.8 by default. We still
+  support python 3.6 and 3.7 and run tests for those interpreters.
+
 * ``TypingChecker``
 
   * Fix false-negative for ``deprecated-typing-alias`` and ``consider-using-alias``

doc/development_guide/contribute.rst

@@ -64,7 +64,8 @@ You can clone Pylint and its dependencies from ::
 .. _git: https://git-scm.com/
 
 Got a change for Pylint?  Below are a few steps you should take to make sure
-your patch gets accepted.
+your patch gets accepted. We recommend using Python 3.8 or higher for development
+of Pylint as it gives you access to the latest ``ast`` parser.
 
 - Test your code
 

doc/whatsnew/2.12.rst

@@ -195,6 +195,12 @@ Other Changes
 * Added the ``--enable-all-extensions`` command line option. It will load all available extensions
   which can be listed by running ``--list-extensions``
 
+* It is now recommended to do ``pylint`` development on ``Python`` 3.8 or higher. This
+  allows using the latest ``ast`` parser.
+
+* All standard jobs in the ``pylint`` CI now run on ``Python`` 3.8 by default. We still
+  support python 3.6 and 3.7 and run tests for those interpreters.
+
 * Fix crash on ``open()`` calls when the ``mode`` argument is not a simple string.
 
   Partially closes #5321

pylint/checkers/exceptions.py

@@ -232,7 +232,6 @@ def visit_const(self, node: nodes.Const) -> None:
         )
 
     def visit_instance(self, instance: objects.ExceptionInstance) -> None:
-        # pylint: disable=protected-access
         cls = instance._proxied
         self.visit_classdef(cls)
 
@@ -535,7 +534,6 @@ def visit_tryexcept(self, node: nodes.TryExcept) -> None:
                     if isinstance(exc, astroid.Instance) and utils.inherit_from_std_ex(
                         exc
                     ):
-                        # pylint: disable=protected-access
                         exc = exc._proxied
 
                     self._check_catching_non_exception(handler, exc, part)

pylint/checkers/format.py

@@ -52,7 +52,7 @@
 """
 
 import tokenize
-from functools import reduce  # pylint: disable=redefined-builtin
+from functools import reduce
 from typing import List
 
 from astroid import nodes

pylint/checkers/similar.py

@@ -26,7 +26,6 @@
 # Licensed under the GPL: https://www.gnu.org/licenses/old-licenses/gpl-2.0.html
 # For details: https://github.com/PyCQA/pylint/blob/main/LICENSE
 
-# pylint: disable=redefined-builtin
 """a similarities / code duplication command line tool and pylint checker
 
 The algorithm is based on comparing the hash value of n successive lines of a file.

pylint/checkers/utils.py

@@ -1338,7 +1338,6 @@ def is_registered_in_singledispatch_function(node: nodes.FunctionDef) -> bool:
             continue
 
         if isinstance(func_def, nodes.FunctionDef):
-            # pylint: disable=redundant-keyword-arg; some flow inference goes wrong here
             return decorated_with(func_def, singledispatch_qnames)
 
     return False

pylint/checkers/variables.py

@@ -1783,7 +1783,6 @@ def _loopvar_name(self, node: astroid.Name) -> None:
                 self.add_message("undefined-loop-variable", args=node.name, node=node)
 
     def _check_is_unused(self, name, node, stmt, global_names, nonlocal_names):
-        # pylint: disable=too-many-branches
         # Ignore some special names specified by user configuration.
         if self._is_name_ignored(stmt, name):
             return

pylint/config/option.py

@@ -181,7 +181,6 @@ def _check_choice(self):
                 f"must not supply choices for type {self.type!r}", self
             )
 
-    # pylint: disable=unsupported-assignment-operation
     optparse.Option.CHECK_METHODS[2] = _check_choice  # type: ignore[index]
 
     def process(self, opt, value, values, parser):

pylint/extensions/overlapping_exceptions.py

@@ -49,7 +49,6 @@ def visit_tryexcept(self, node: nodes.TryExcept) -> None:
                 if exc is astroid.Uninferable:
                     continue
                 if isinstance(exc, astroid.Instance) and utils.inherit_from_std_ex(exc):
-                    # pylint: disable=protected-access
                     exc = exc._proxied
 
                 if not isinstance(exc, astroid.ClassDef):

pylint/lint/pylinter.py

@@ -623,7 +623,6 @@ def _load_reporters(self) -> None:
                 sub_reporters.append(reporter)
                 if reporter_output:
                     (reporter_output,) = reporter_output
-                    # pylint: disable=consider-using-with
                     output_file = stack.enter_context(
                         open(reporter_output, "w", encoding="utf-8")
                     )
@@ -1066,7 +1065,7 @@ def _check_file(self, get_ast, check_astroid_module, file: FileItem):
         self.file_state = FileState(file.modpath)
         # fix the current file (if the source file was not available or
         # if it's actually a c extension)
-        self.current_file = ast_node.file  # pylint: disable=maybe-no-member
+        self.current_file = ast_node.file
         check_astroid_module(ast_node)
         # warn about spurious inline messages handling
         spurious_messages = self.file_state.iter_spurious_suppression_messages(
@@ -1312,6 +1311,7 @@ def _report_evaluation(self):
                 "refactor": self.stats.refactor,
                 "convention": self.stats.convention,
                 "statement": self.stats.statement,
+                "info": self.stats.info,
             }
             note = eval(evaluation, {}, stats_dict)  # pylint: disable=eval-used
         except Exception as ex:  # pylint: disable=broad-except

pylint/lint/run.py

@@ -21,7 +21,7 @@
 def _cpu_count() -> int:
     """Use sched_affinity if available for virtualized or containerized environments."""
     sched_getaffinity = getattr(os, "sched_getaffinity", None)
-    # pylint: disable=not-callable,using-constant-test
+    # pylint: disable=not-callable,using-constant-test,useless-suppression
     if sched_getaffinity:
         return len(sched_getaffinity(0))
     if multiprocessing:

pylint/reporters/text.py

@@ -292,7 +292,7 @@ def __init__(
         ansi_terms = ["xterm-16color", "xterm-256color"]
         if os.environ.get("TERM") not in ansi_terms:
             if sys.platform == "win32":
-                # pylint: disable=import-error,import-outside-toplevel
+                # pylint: disable=import-outside-toplevel
                 import colorama
 
                 self.out = colorama.AnsiToWin32(self.out)

pylint/testutils/lint_module_test.py

@@ -146,14 +146,12 @@ def multiset_difference(
                     unexpected[key] = -value
         return missing, unexpected
 
-    # pylint: disable=consider-using-with
     def _open_expected_file(self) -> TextIO:
         try:
             return open(self._test_file.expected_output, encoding="utf-8")
         except FileNotFoundError:
             return StringIO("")
 
-    # pylint: disable=consider-using-with
     def _open_source_file(self) -> TextIO:
         if self._test_file.base == "invalid_encoded_data":
             return open(self._test_file.source, encoding="utf-8")

pylint/testutils/reporter_for_tests.py

@@ -50,7 +50,6 @@ def finalize(self) -> str:
         self.reset()
         return result
 
-    # pylint: disable=unused-argument
     def on_set_current_module(self, module: str, filepath: Optional[str]) -> None:
         pass
 

pylint/testutils/unittest_linter.py

@@ -14,7 +14,7 @@
 class UnittestLinter:
     """A fake linter class to capture checker messages."""
 
-    # pylint: disable=unused-argument, no-self-use
+    # pylint: disable=unused-argument
 
     def __init__(self):
         self._messages = []

pylint/utils/file_state.py

@@ -74,9 +74,9 @@ def _collect_block_lines(
         #
         # 1.   def meth8(self):
         # 2.        """test late disabling"""
-        # 3.        pylint: disable=not-callable
+        # 3.        pylint: disable=not-callable, useless-suppression
         # 4.        print(self.blip)
-        # 5.        pylint: disable=no-member
+        # 5.        pylint: disable=no-member, useless-suppression
         # 6.        print(self.bla)
         #
         # E1102 should be disabled from line 1 to 6 while E1101 from line 5 to 6

pylint/utils/utils.py

@@ -93,7 +93,7 @@ def normalize_text(text, line_len=DEFAULT_LINE_LENGTH, indent=""):
 
 
 # py3k has no more cmp builtin
-def cmp(a, b):  # pylint: disable=redefined-builtin
+def cmp(a, b):
     return (a > b) - (a < b)
 
 

pylintrc

@@ -57,7 +57,7 @@ confidence=
 # multiple time. See also the "--disable" option for examples.
 enable=
     use-symbolic-message-instead,
-    useless-supression,
+    useless-suppression,
     fixme
 
 # Disable the message, report, category or checker with the given id(s). You

tests/benchmark/test_baseline_benchmarks.py

@@ -9,7 +9,7 @@
 # Licensed under the GPL: https://www.gnu.org/licenses/old-licenses/gpl-2.0.html
 # For details: https://github.com/PyCQA/pylint/blob/main/LICENSE
 
-# pylint: disable=protected-access,missing-function-docstring,no-self-use
+# pylint: disable=missing-function-docstring
 
 import os
 import pprint

tests/checkers/unittest_design.py

@@ -58,5 +58,4 @@ def test_ignore_paths_with_no_value(self) -> None:
         Compare against actual list to see if validator works."""
         options = get_global_option(self.checker, "exclude-too-few-public-methods")
 
-        # pylint: disable-next=use-implicit-booleaness-not-comparison
         assert options == []

tests/checkers/unittest_format.py

@@ -293,9 +293,7 @@ def test_disable_global_option_end_of_line() -> None:
     Test for issue with disabling tokenizer messages
     that extend beyond the scope of the ast tokens
     """
-    file_ = tempfile.NamedTemporaryFile(
-        "w", delete=False
-    )  # pylint: disable=consider-using-with
+    file_ = tempfile.NamedTemporaryFile("w", delete=False)
     with file_:
         file_.write(
             """

tests/config/unittest_config.py

@@ -97,5 +97,4 @@ def test_ignore_paths_with_no_value(self) -> None:
         Compare against actual list to see if validator works."""
         options = get_global_option(self.checker, "ignore-paths")
 
-        # pylint: disable-next=use-implicit-booleaness-not-comparison
         assert options == []

tests/conftest.py

@@ -1,5 +1,4 @@
 # pylint: disable=redefined-outer-name
-# pylint: disable=no-name-in-module
 import os
 from pathlib import Path
 

tests/lint/unittest_lint.py

@@ -70,8 +70,6 @@
 from pylint.utils import FileState, print_full_documentation, tokenize_module
 
 if os.name == "java":
-    # pylint: disable=no-member
-    # os._name is valid see https://www.programcreek.com/python/example/3842/os._name
     if os.name == "nt":
         HOME = "USERPROFILE"
     else:
@@ -799,7 +797,6 @@ def test_error_unexpected_value() -> None:
 
 
 class _CustomPyLinter(PyLinter):
-    # pylint: disable=too-many-ancestors
     @staticmethod
     def should_analyze_file(modname: str, path: str, is_argument: bool = False) -> bool:
         if os.path.basename(path) == "wrong.py":

tests/profile/test_profile_against_externals.py

@@ -7,7 +7,7 @@
 # Licensed under the GPL: https://www.gnu.org/licenses/old-licenses/gpl-2.0.html
 # For details: https://github.com/PyCQA/pylint/blob/main/LICENSE
 
-# pylint: disable=protected-access,missing-function-docstring,no-self-use
+# pylint: disable=missing-function-docstring
 
 import os
 import pprint

tests/pyreverse/test_diagrams.py

@@ -4,7 +4,6 @@
 # For details: https://github.com/PyCQA/pylint/blob/main/LICENSE
 
 """Unit test for the diagrams modules"""
-# pylint: disable=redefined-outer-name
 from typing import Callable
 
 from pylint.pyreverse.diadefslib import DefaultDiadefGenerator, DiadefsHandler

tests/regrtest_data/unused_variable.py

@@ -1,4 +1,4 @@
-# pylint: disable=missing-docstring
+# pylint: disable=missing-module-docstring, missing-function-docstring
 
 def test():
     variable = ''

tests/test_func.py

@@ -55,7 +55,6 @@ class LintTestUsingModule:
     def _test_functionality(self) -> None:
         if self.module:
             tocheck = [self.package + "." + self.module]
-        # pylint: disable=not-an-iterable; can't handle boolean checks for now
         if self.depends:
             tocheck += [
                 self.package + f".{name.replace('.py', '')}" for name, _ in self.depends

tests/unittest_reporting.py

@@ -58,7 +58,7 @@ def test_template_option(linter):
 
 
 def test_deprecation_set_output(recwarn):
-    """TODO remove in 3.0"""  # pylint: disable=fixme
+    """TODO remove in 3.0"""
     reporter = BaseReporter()
     # noinspection PyDeprecation
     reporter.set_output(sys.stdout)