Merge branch 'main' into fix/1015-overload-not-an-iterable

CONTRIBUTORS.txt

@@ -191,6 +191,8 @@ Contributors
 - Alexander Scheel <alexander.m.scheel@gmail.com>
 - Alexander Presnyakov <flagist0@gmail.com>
 - Ahmed Azzaoui <ahmed.azzaoui@engie.com>
+- JulianJvn <128477611+JulianJvn@users.noreply.github.com>
+- Gwyn Ciesla <gwync@protonmail.com>
 
 Co-Author
 ---------

ChangeLog

@@ -14,10 +14,16 @@ Release date: TBA
   Refs pylint-dev/pylint#4696
 
 
-What's New in astroid 3.1.0?
+What's New in astroid 3.1.1?
 ============================
 Release date: TBA
 
+
+
+What's New in astroid 3.1.0?
+============================
+Release date: 2024-02-23
+
 * Include PEP 695 (Python 3.12) generic type syntax nodes in ``get_children()``,
   allowing checkers to visit them.
 
@@ -38,12 +44,15 @@ Release date: TBA
 * Include modname in AST warnings. Useful for ``invalid escape sequence`` warnings
   with Python 3.12.
 
+* ``RecursionError`` is now trapped and logged out as ``UserWarning`` during astroid node transformations with instructions about raising the system recursion limit.
+
+  Closes pylint-dev/pylint#8842
+
 * Suppress ``SyntaxWarning`` for invalid escape sequences on Python 3.12 when parsing modules.
 
   Closes pylint-dev/pylint#9322
 
 
-
 What's New in astroid 3.0.3?
 ============================
 Release date: 2024-02-04

astroid/__pkginfo__.py

@@ -2,5 +2,5 @@
 # For details: https://github.com/pylint-dev/astroid/blob/main/LICENSE
 # Copyright (c) https://github.com/pylint-dev/astroid/blob/main/CONTRIBUTORS.txt
 
-__version__ = "3.1.0-dev0"
+__version__ = "3.2.0-dev0"
 version = __version__

astroid/nodes/as_string.py

@@ -6,6 +6,7 @@
 
 from __future__ import annotations
 
+import warnings
 from collections.abc import Iterator
 from typing import TYPE_CHECKING
 
@@ -363,7 +364,15 @@ def visit_generatorexp(self, node) -> str:
 
     def visit_attribute(self, node) -> str:
         """return an astroid.Getattr node as string"""
-        left = self._precedence_parens(node, node.expr)
+        try:
+            left = self._precedence_parens(node, node.expr)
+        except RecursionError:
+            warnings.warn(
+                "Recursion limit exhausted; defaulting to adding parentheses.",
+                UserWarning,
+                stacklevel=2,
+            )
+            left = f"({node.expr.accept(self)})"
         if left.isdigit():
             left = f"({left})"
         return f"{left}.{node.attrname}"

astroid/transforms.py

@@ -4,6 +4,7 @@
 
 from __future__ import annotations
 
+import warnings
 from collections import defaultdict
 from collections.abc import Callable
 from typing import TYPE_CHECKING, List, Optional, Tuple, TypeVar, Union, cast, overload
@@ -110,7 +111,18 @@ def _visit_generic(self, node: _Vistables) -> _VisitReturns:
         if not node or isinstance(node, str):
             return node
 
-        return self._visit(node)
+        try:
+            return self._visit(node)
+        except RecursionError:
+            # Returning the node untransformed is better than giving up.
+            warnings.warn(
+                f"Astroid was unable to transform {node}.\n"
+                "Some functionality will be missing unless the system recursion limit is lifted.\n"
+                "From pylint, try: --init-hook='import sys; sys.setrecursionlimit(2000)' or higher.",
+                UserWarning,
+                stacklevel=0,
+            )
+            return node
 
     def register_transform(
         self,

tbump.toml

@@ -1,7 +1,7 @@
 github_url = "https://github.com/pylint-dev/astroid"
 
 [version]
-current = "3.1.0-dev0"
+current = "3.2.0-dev0"
 regex = '''
 ^(?P<major>0|[1-9]\d*)
 \.

tests/test_nodes.py

@@ -29,7 +29,7 @@
     transforms,
     util,
 )
-from astroid.const import PY310_PLUS, PY312_PLUS, Context
+from astroid.const import IS_PYPY, PY310_PLUS, PY312_PLUS, Context
 from astroid.context import InferenceContext
 from astroid.exceptions import (
     AstroidBuildingError,
@@ -47,6 +47,7 @@
     Tuple,
 )
 from astroid.nodes.scoped_nodes import ClassDef, FunctionDef, GeneratorExp, Module
+from tests.testdata.python3.recursion_error import LONG_CHAINED_METHOD_CALL
 
 from . import resources
 
@@ -279,6 +280,20 @@ def test_as_string_unknown() -> None:
         assert nodes.Unknown().as_string() == "Unknown.Unknown()"
         assert nodes.Unknown(lineno=1, col_offset=0).as_string() == "Unknown.Unknown()"
 
+    @staticmethod
+    @pytest.mark.skipif(
+        IS_PYPY,
+        reason="Test requires manipulating the recursion limit, which cannot "
+        "be undone in a finally block without polluting other tests on PyPy.",
+    )
+    def test_recursion_error_trapped() -> None:
+        with pytest.warns(UserWarning, match="unable to transform"):
+            ast = abuilder.string_build(LONG_CHAINED_METHOD_CALL)
+
+        attribute = ast.body[1].value.func
+        with pytest.raises(UserWarning):
+            attribute.as_string()
+
 
 @pytest.mark.skipif(not PY312_PLUS, reason="Uses 3.12 type param nodes")
 class AsStringTypeParamNodes(unittest.TestCase):

tests/test_transforms.py

@@ -5,14 +5,20 @@
 from __future__ import annotations
 
 import contextlib
+import sys
 import time
 import unittest
 from collections.abc import Callable, Iterator
 
+import pytest
+
 from astroid import MANAGER, builder, nodes, parse, transforms
+from astroid.brain.brain_dataclasses import _looks_like_dataclass_field_call
+from astroid.const import IS_PYPY
 from astroid.manager import AstroidManager
 from astroid.nodes.node_classes import Call, Compare, Const, Name
 from astroid.nodes.scoped_nodes import FunctionDef, Module
+from tests.testdata.python3.recursion_error import LONG_CHAINED_METHOD_CALL
 
 
 @contextlib.contextmanager
@@ -258,3 +264,21 @@ def transform_class(cls):
                 import UserDict
         """
         )
+
+    def test_transform_aborted_if_recursion_limited(self):
+        def transform_call(node: Call) -> Const:
+            return node
+
+        self.transformer.register_transform(
+            nodes.Call, transform_call, _looks_like_dataclass_field_call
+        )
+
+        original_limit = sys.getrecursionlimit()
+        sys.setrecursionlimit(500 if IS_PYPY else 1000)
+
+        try:
+            with pytest.warns(UserWarning) as records:
+                self.parse_transform(LONG_CHAINED_METHOD_CALL)
+                assert "sys.setrecursionlimit" in records[0].message.args[0]
+        finally:
+            sys.setrecursionlimit(original_limit)

tests/testdata/python3/recursion_error.py

@@ -0,0 +1,170 @@
+LONG_CHAINED_METHOD_CALL = """
+from a import b
+
+(
+    b.builder('name')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .add('name', value='value')
+    .Build()
+)"""