Merge remote-tracking branch 'origin/main' into issue8808_wrongimportorder

Pierre-Sassoulas · Pierre-Sassoulas · commit 63a9ed38025a · 2023-11-26T11:07:22.000+01:00
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -17,7 +17,7 @@ repos:
             doc/data/messages/m/missing-final-newline/bad/crlf.py
           )$
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: "v0.1.4"
+    rev: "v0.1.5"
     hooks:
       - id: ruff
         args: ["--fix"]
@@ -39,7 +39,7 @@ repos:
       - id: isort
         exclude: doc/data/messages/
   - repo: https://github.com/psf/black
-    rev: 23.10.1
+    rev: 23.11.0
     hooks:
       - id: black
         args: [--safe, --quiet]
@@ -112,7 +112,7 @@ repos:
         files: ^(doc/(.*/)*.*\.rst)
         additional_dependencies: [Sphinx==5.0.1]
   - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v1.6.1
+    rev: v1.7.0
     hooks:
       - id: mypy
         name: mypy
@@ -131,7 +131,7 @@ repos:
           ]
         exclude: tests(/\w*)*/functional/|tests/input|tests(/.*)+/conftest.py|doc/data/messages|tests(/\w*)*data/
   - repo: https://github.com/pre-commit/mirrors-prettier
-    rev: v3.0.3
+    rev: v3.1.0
     hooks:
       - id: prettier
         args: [--prose-wrap=always, --print-width=88]
diff --git a/doc/requirements.txt b/doc/requirements.txt
@@ -1,5 +1,5 @@
 Sphinx==7.2.6
 sphinx-reredirects<1
-towncrier~=23.10
+towncrier~=23.11
 furo==2023.9.10
 -e .
diff --git a/doc/user_guide/usage/run.rst b/doc/user_guide/usage/run.rst
@@ -95,7 +95,11 @@ command line using the ``--rcfile`` option.  Otherwise, Pylint searches for a
 configuration file in the following order and uses the first one it finds:
 
 #. ``pylintrc`` in the current working directory
+#. ``pylintrc.toml`` in the current working directory,
+   providing it has at least one ``tool.pylint.`` section.
 #. ``.pylintrc`` in the current working directory
+#. ``.pylintrc.toml`` in the current working directory,
+   providing it has at least one ``tool.pylint.`` section.
 #. ``pyproject.toml`` in the current working directory,
    providing it has at least one ``tool.pylint.`` section.
    The ``pyproject.toml`` must prepend section names with ``tool.pylint.``,
diff --git a/doc/whatsnew/fragments/8827.false_negative b/doc/whatsnew/fragments/8827.false_negative
@@ -0,0 +1,3 @@
+Extend broad-exception-raised and broad-exception-caught to except*.
+
+Closes #8827
diff --git a/doc/whatsnew/fragments/9167.false_positive b/doc/whatsnew/fragments/9167.false_positive
@@ -0,0 +1,3 @@
+Exempt ``TypedDict`` from ``typing_extensions`` from ``too-many-ancestor`` checks.
+
+Refs #9167
diff --git a/doc/whatsnew/fragments/9172.false_positive b/doc/whatsnew/fragments/9172.false_positive
@@ -0,0 +1,12 @@
+Fixed incorrect suggestion for shallow copy in unnecessary-comprehension
+
+Example of the suggestion:
+#pylint: disable=missing-module-docstring
+a = [1, 2, 3]
+b = [x for x in a]
+b[0] = 0
+print(a) # [1, 2, 3]
+
+After changing b = [x for x in a] to b = a based on the suggestion, the script now prints [0, 2, 3]. The correct suggestion should be use list(a) to preserve the original behavior.
+
+Closes #9172
diff --git a/doc/whatsnew/fragments/9228.feature b/doc/whatsnew/fragments/9228.feature
@@ -0,0 +1,3 @@
+Support for resolving external toml files named pylintrc.toml and .pylintrc.toml.
+
+Closes #9228
diff --git a/pylint/checkers/base/basic_checker.py b/pylint/checkers/base/basic_checker.py
@@ -478,7 +478,10 @@ def visit_expr(self, node: nodes.Expr) -> None:
         # side effects), else pointless-statement
         if (
             isinstance(expr, (nodes.Yield, nodes.Await))
-            or (isinstance(node.parent, nodes.Try) and node.parent.body == [node])
+            or (
+                isinstance(node.parent, (nodes.Try, nodes.TryStar))
+                and node.parent.body == [node]
+            )
             or (isinstance(expr, nodes.Const) and expr.value is Ellipsis)
         ):
             return
diff --git a/pylint/checkers/base_checker.py b/pylint/checkers/base_checker.py
@@ -188,10 +188,10 @@ def create_message_definition_from_tuple(
             default_scope = WarningScope.NODE
         options: ExtraMessageOptions = {}
         if len(msg_tuple) == 4:
-            (msg, symbol, descr, msg_options) = msg_tuple  # type: ignore[misc]
+            (msg, symbol, descr, msg_options) = msg_tuple
             options = ExtraMessageOptions(**msg_options)
         elif len(msg_tuple) == 3:
-            (msg, symbol, descr) = msg_tuple  # type: ignore[misc]
+            (msg, symbol, descr) = msg_tuple
         else:
             error_msg = """Messages should have a msgid, a symbol and a description. Something like this :
 
diff --git a/pylint/checkers/exceptions.py b/pylint/checkers/exceptions.py
@@ -556,6 +556,10 @@ def visit_compare(self, node: nodes.Compare) -> None:
         "catching-non-exception",
         "duplicate-except",
     )
+    def visit_trystar(self, node: nodes.TryStar) -> None:
+        """Check for empty except*."""
+        self.visit_try(node)
+
     def visit_try(self, node: nodes.Try) -> None:
         """Check for empty except."""
         self._check_try_except_raise(node)
diff --git a/pylint/checkers/refactoring/refactoring_checker.py b/pylint/checkers/refactoring/refactoring_checker.py
@@ -1801,15 +1801,15 @@ def _check_unnecessary_comprehension(self, node: nodes.Comprehension) -> None:
             if isinstance(node.parent, nodes.DictComp) and isinstance(
                 inferred, astroid.objects.DictItems
             ):
-                args = (f"{node.iter.func.expr.as_string()}",)
-            elif (
-                isinstance(node.parent, nodes.ListComp)
-                and isinstance(inferred, nodes.List)
-            ) or (
-                isinstance(node.parent, nodes.SetComp)
-                and isinstance(inferred, nodes.Set)
+                args = (f"dict({node.iter.func.expr.as_string()})",)
+            elif isinstance(node.parent, nodes.ListComp) and isinstance(
+                inferred, nodes.List
             ):
-                args = (f"{node.iter.as_string()}",)
+                args = (f"list({node.iter.as_string()})",)
+            elif isinstance(node.parent, nodes.SetComp) and isinstance(
+                inferred, nodes.Set
+            ):
+                args = (f"set({node.iter.as_string()})",)
             if args:
                 self.add_message(
                     "unnecessary-comprehension", node=node.parent, args=args
diff --git a/pylint/config/find_default_config_files.py b/pylint/config/find_default_config_files.py
@@ -15,7 +15,12 @@
 else:
     import tomli as tomllib
 
-RC_NAMES = (Path("pylintrc"), Path(".pylintrc"))
+RC_NAMES = (
+    Path("pylintrc"),
+    Path("pylintrc.toml"),
+    Path(".pylintrc"),
+    Path(".pylintrc.toml"),
+)
 PYPROJECT_NAME = Path("pyproject.toml")
 CONFIG_NAMES = (*RC_NAMES, PYPROJECT_NAME, Path("setup.cfg"))
 
diff --git a/requirements_test.txt b/requirements_test.txt
@@ -4,7 +4,7 @@ tbump~=6.11.0
 contributors-txt>=1.0.0
 pytest-cov~=4.1
 pytest-profiling~=1.7
-pytest-xdist~=3.3
+pytest-xdist~=3.4
 six
 # Type packages for mypy
 types-pkg_resources==0.1.3
diff --git a/requirements_test_min.txt b/requirements_test_min.txt
@@ -6,7 +6,7 @@ py~=1.11.0
 pytest~=7.4
 pytest-benchmark~=4.0
 pytest-timeout~=2.2
-towncrier~=23.10
+towncrier~=23.11
 requests
 # Voluntary for test purpose, not actually used in prod, see #8904
 setuptools==41.6.0
diff --git a/tests/config/test_find_default_config_files.py b/tests/config/test_find_default_config_files.py
@@ -129,6 +129,41 @@ def test_pylintrc_parentdir() -> None:
             assert next(config.find_default_config_files()) == expected
 
 
+@pytest.mark.usefixtures("pop_pylintrc")
+def test_pylintrc_toml_parentdir() -> None:
+    """Test that the first pylintrc.toml we find is the first parent directory."""
+    # pylint: disable=duplicate-code
+    with tempdir() as chroot:
+        chroot_path = Path(chroot)
+        files = [
+            "a/pylintrc.toml",
+            "a/b/__init__.py",
+            "a/b/pylintrc.toml",
+            "a/b/c/__init__.py",
+            "a/b/c/d/__init__.py",
+            "a/b/c/d/e/.pylintrc.toml",
+        ]
+        testutils.create_files(files)
+        for config_file in files:
+            if config_file.endswith("pylintrc.toml"):
+                with open(config_file, "w", encoding="utf-8") as fd:
+                    fd.write('[tool.pylint."messages control"]\n')
+
+        with fake_home():
+            assert not list(config.find_default_config_files())
+
+        results = {
+            "a": chroot_path / "a" / "pylintrc.toml",
+            "a/b": chroot_path / "a" / "b" / "pylintrc.toml",
+            "a/b/c": chroot_path / "a" / "b" / "pylintrc.toml",
+            "a/b/c/d": chroot_path / "a" / "b" / "pylintrc.toml",
+            "a/b/c/d/e": chroot_path / "a" / "b" / "c" / "d" / "e" / ".pylintrc.toml",
+        }
+        for basedir, expected in results.items():
+            os.chdir(chroot_path / basedir)
+            assert next(config.find_default_config_files()) == expected
+
+
 @pytest.mark.usefixtures("pop_pylintrc")
 def test_pyproject_toml_parentdir() -> None:
     """Test the search of pyproject.toml file in parent directories"""
diff --git a/tests/functional/b/broad_exception/broad_exception_caught.py b/tests/functional/b/broad_exception/broad_exception_caught.py
diff --git a/tests/functional/b/broad_exception/broad_exception_caught.rc b/tests/functional/b/broad_exception/broad_exception_caught.rc
@@ -0,0 +1,5 @@
+[EXCEPTIONS]
+overgeneral-exceptions=builtins.BaseException,
+                       builtins.Exception,
+                       functional.b.broad_exception.broad_exception_caught.CustomBroadException,
+                       broad_exception_caught.CustomBroadException
diff --git a/tests/functional/b/broad_exception/broad_exception_caught.txt b/tests/functional/b/broad_exception/broad_exception_caught.txt
@@ -1,3 +1,3 @@
-broad-exception-caught:14:7:14:16::Catching too general exception Exception:INFERENCE
-broad-exception-caught:20:7:20:20::Catching too general exception BaseException:INFERENCE
-broad-exception-caught:32:7:32:27::Catching too general exception CustomBroadException:INFERENCE
+broad-exception-caught:14:7:14:16::Catching too general exception Exception:INFERENCE
+broad-exception-caught:20:7:20:20::Catching too general exception BaseException:INFERENCE
+broad-exception-caught:32:7:32:27::Catching too general exception CustomBroadException:INFERENCE
diff --git a/tests/functional/b/broad_exception/broad_exception_caught_trystar.py b/tests/functional/b/broad_exception/broad_exception_caught_trystar.py
@@ -0,0 +1,39 @@
+# pylint: disable=missing-docstring
+__revision__ = 0
+
+class CustomBroadException(Exception):
+    pass
+
+
+class CustomNarrowException(CustomBroadException):
+    pass
+
+
+try:
+    __revision__ += 1
+except* Exception: # [broad-exception-caught]
+    print('error')
+
+
+try:
+    __revision__ += 1
+except* BaseException: # [broad-exception-caught]
+    print('error')
+
+
+try:
+    __revision__ += 1
+except* ValueError:
+    print('error')
+
+
+try:
+    __revision__ += 1
+except CustomBroadException: # [broad-exception-caught]
+    print('error')
+
+
+try:
+    __revision__ += 1
+except* CustomNarrowException:
+    print('error')
diff --git a/tests/functional/b/broad_exception/broad_exception_caught_trystar.rc b/tests/functional/b/broad_exception/broad_exception_caught_trystar.rc
@@ -0,0 +1,8 @@
+[EXCEPTIONS]
+overgeneral-exceptions=builtins.BaseException,
+                       builtins.Exception,
+                       functional.b.broad_exception.broad_exception_caught_trystar.CustomBroadException,
+                       broad_exception_caught_trystar.CustomBroadException
+
+[testoptions]
+min_pyver=3.11
diff --git a/tests/functional/b/broad_exception/broad_exception_caught_trystar.txt b/tests/functional/b/broad_exception/broad_exception_caught_trystar.txt
@@ -0,0 +1,3 @@
+broad-exception-caught:14:8:14:17::Catching too general exception Exception:INFERENCE
+broad-exception-caught:20:8:20:21::Catching too general exception BaseException:INFERENCE
+broad-exception-caught:32:7:32:27::Catching too general exception CustomBroadException:INFERENCE
diff --git a/tests/functional/b/broad_exception/broad_exception_raised.py b/tests/functional/b/broad_exception/broad_exception_raised.py
diff --git a/tests/functional/b/broad_exception/broad_exception_raised.rc b/tests/functional/b/broad_exception/broad_exception_raised.rc
@@ -0,0 +1,5 @@
+[EXCEPTIONS]
+overgeneral-exceptions=builtins.BaseException,
+                       builtins.Exception,
+                       functional.b.broad_exception.broad_exception_raised.CustomBroadException,
+                       broad_exception_raised.CustomBroadException
diff --git a/tests/functional/b/broad_exception/broad_exception_raised.txt b/tests/functional/b/broad_exception/broad_exception_raised.txt
@@ -1,8 +1,8 @@
-broad-exception-raised:15:4:15:41:exploding_apple:"Raising too general exception: Exception":INFERENCE
-broad-exception-raised:20:8:20:34:raise_and_catch:"Raising too general exception: Exception":INFERENCE
-broad-exception-caught:21:11:21:20:raise_and_catch:Catching too general exception Exception:INFERENCE
-broad-exception-raised:38:8:38:35:raise_catch_raise:"Raising too general exception: Exception":INFERENCE
-broad-exception-raised:46:8:46:40:raise_catch_raise_using_alias:"Raising too general exception: Exception":INFERENCE
-broad-exception-raised:48:0:48:17::"Raising too general exception: Exception":INFERENCE
-broad-exception-raised:49:0:49:21::"Raising too general exception: BaseException":INFERENCE
-broad-exception-raised:50:0:50:28::"Raising too general exception: CustomBroadException":INFERENCE
+broad-exception-raised:15:4:15:41:exploding_apple:"Raising too general exception: Exception":INFERENCE
+broad-exception-raised:20:8:20:34:raise_and_catch:"Raising too general exception: Exception":INFERENCE
+broad-exception-caught:21:11:21:20:raise_and_catch:Catching too general exception Exception:INFERENCE
+broad-exception-raised:38:8:38:35:raise_catch_raise:"Raising too general exception: Exception":INFERENCE
+broad-exception-raised:46:8:46:40:raise_catch_raise_using_alias:"Raising too general exception: Exception":INFERENCE
+broad-exception-raised:48:0:48:17::"Raising too general exception: Exception":INFERENCE
+broad-exception-raised:49:0:49:21::"Raising too general exception: BaseException":INFERENCE
+broad-exception-raised:50:0:50:28::"Raising too general exception: CustomBroadException":INFERENCE
diff --git a/tests/functional/b/broad_exception/broad_exception_raised_trystar.py b/tests/functional/b/broad_exception/broad_exception_raised_trystar.py
@@ -0,0 +1,52 @@
+# pylint: disable=missing-docstring, unreachable
+
+ExceptionAlias = Exception
+
+class CustomBroadException(Exception):
+    pass
+
+
+class CustomNarrowException(CustomBroadException):
+    pass
+
+
+def exploding_apple(apple):
+    print(f"{apple} is about to explode")
+    raise Exception("{apple} exploded !")  # [broad-exception-raised]
+
+
+def raise_and_catch_star():
+    try:
+        raise Exception("Oh No!!")  # [broad-exception-raised]
+    except* Exception as ex:  # [broad-exception-caught]
+        print(ex)
+
+
+def raise_catch_reraise_star():
+    try:
+        exploding_apple("apple")
+    except* Exception as ex:
+        print(ex)
+        raise ex
+
+
+def raise_catch_raise_star():
+    try:
+        exploding_apple("apple")
+    except* Exception as ex:
+        print(ex)
+        raise Exception() from None  # [broad-exception-raised]
+
+
+def raise_catch_raise_using_alias_star():
+    try:
+        exploding_apple("apple")
+    except* Exception as ex:
+        print(ex)
+        raise ExceptionAlias() from None  # [broad-exception-raised]
+
+raise Exception()  # [broad-exception-raised]
+raise BaseException()  # [broad-exception-raised]
+raise CustomBroadException()  # [broad-exception-raised]
+raise IndexError from None
+raise CustomNarrowException() from None
diff --git a/tests/functional/b/broad_exception/broad_exception_raised_trystar.rc b/tests/functional/b/broad_exception/broad_exception_raised_trystar.rc
@@ -0,0 +1,7 @@
+[EXCEPTIONS]
+overgeneral-exceptions=builtins.BaseException,
+                       builtins.Exception,
+                       functional.b.broad_exception.broad_exception_raised_trystar.CustomBroadException,
+                       broad_exception_raised_trystar.CustomBroadException
+[testoptions]
+min_pyver=3.11
diff --git a/tests/functional/b/broad_exception/broad_exception_raised_trystar.txt b/tests/functional/b/broad_exception/broad_exception_raised_trystar.txt
@@ -0,0 +1,8 @@
+broad-exception-raised:15:4:15:41:exploding_apple:"Raising too general exception: Exception":INFERENCE
+broad-exception-raised:20:8:20:34:raise_and_catch_star:"Raising too general exception: Exception":INFERENCE
+broad-exception-caught:21:12:21:21:raise_and_catch_star:Catching too general exception Exception:INFERENCE
+broad-exception-raised:38:8:38:35:raise_catch_raise_star:"Raising too general exception: Exception":INFERENCE
+broad-exception-raised:46:8:46:40:raise_catch_raise_using_alias_star:"Raising too general exception: Exception":INFERENCE
+broad-exception-raised:48:0:48:17::"Raising too general exception: Exception":INFERENCE
+broad-exception-raised:49:0:49:21::"Raising too general exception: BaseException":INFERENCE
+broad-exception-raised:50:0:50:28::"Raising too general exception: CustomBroadException":INFERENCE
diff --git a/tests/functional/b/broad_exception_caught.rc b/tests/functional/b/broad_exception_caught.rc
diff --git a/tests/functional/b/broad_exception_raised.rc b/tests/functional/b/broad_exception_raised.rc
diff --git a/tests/functional/u/unnecessary/unnecessary_comprehension.py b/tests/functional/u/unnecessary/unnecessary_comprehension.py
@@ -4,7 +4,9 @@
 # List comprehensions
 [x for x in iterable]  # [unnecessary-comprehension]
 [y for x in iterable]  # expression != target_list
+[x for x in iterable] # [unnecessary-comprehension] use list(iterable)
 [x for x,y,z in iterable]  # expression != target_list
+[(x, y) for x, y in iterable]  # [unnecessary-comprehension]
 [(x,y,z) for x,y,z in iterable]  # [unnecessary-comprehension]
 [(x,y,z) for (x,y,z) in iterable]  # [unnecessary-comprehension]
 [x for x, *y in iterable]  # expression != target_list
diff --git a/tests/functional/u/unnecessary/unnecessary_comprehension.txt b/tests/functional/u/unnecessary/unnecessary_comprehension.txt
diff --git a/tests/pyreverse/functional/class_diagrams/colorized_output/colorized.puml b/tests/pyreverse/functional/class_diagrams/colorized_output/colorized.puml
diff --git a/tests/pyreverse/functional/class_diagrams/colorized_output/custom_colors.dot b/tests/pyreverse/functional/class_diagrams/colorized_output/custom_colors.dot
diff --git a/tests/pyreverse/functional/class_diagrams/colorized_output/custom_colors.puml b/tests/pyreverse/functional/class_diagrams/colorized_output/custom_colors.puml

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+Extend broad-exception-raised and broad-exception-caught to except*.`
	`2`	`+`
	`3`	`+Closes #8827`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	+Exempt ``TypedDict`` from ``typing_extensions`` from ``too-many-ancestor`` checks.
	`2`	`+`
	`3`	`+Refs #9167`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+Support for resolving external toml files named pylintrc.toml and .pylintrc.toml.`
	`2`	`+`
	`3`	`+Closes #9228`