Deprecate astroid.helpers.safe_infer()

safe_infer() was moved to astroid.util

Author: jacobtylerwalls

astroid/helpers.py

@@ -6,6 +6,7 @@
 
 from __future__ import annotations
 
+import warnings
 from collections.abc import Generator
 
 from astroid import bases, manager, nodes, objects, raw_building, util
@@ -19,10 +20,20 @@
 )
 from astroid.nodes import scoped_nodes
 from astroid.typing import InferenceResult
+from astroid.util import safe_infer as real_safe_infer
 
-# Don't remove the following safe_infer import without a deprecation notice.
-# safe_infer was moved to util in #2232, but can be accessed here via this.
-from astroid.util import safe_infer
+
+def safe_infer(
+    node: nodes.NodeNG | bases.Proxy | util.UninferableBase,
+    context: InferenceContext | None = None,
+) -> InferenceResult | None:
+    # When removing, also remove the real_safe_infer alias
+    warnings.warn(
+        "Import safe_infer from astroid.util; this shim in astroid.helpers will be removed.",
+        DeprecationWarning,
+        stacklevel=2,
+    )
+    return real_safe_infer(node, context=context)
 
 
 def _build_proxy_class(cls_name: str, builtins: nodes.Module) -> nodes.ClassDef:
@@ -166,7 +177,7 @@ def has_known_bases(klass, context: InferenceContext | None = None) -> bool:
     except AttributeError:
         pass
     for base in klass.bases:
-        result = safe_infer(base, context=context)
+        result = real_safe_infer(base, context=context)
         # TODO: check for A->B->A->B pattern in class structure too?
         if (
             not isinstance(result, scoped_nodes.ClassDef)
@@ -241,7 +252,7 @@ def object_len(node, context: InferenceContext | None = None):
     # pylint: disable=import-outside-toplevel; circular import
     from astroid.objects import FrozenSet
 
-    inferred_node = safe_infer(node, context=context)
+    inferred_node = real_safe_infer(node, context=context)
 
     # prevent self referential length calls from causing a recursion error
     # see https://github.com/pylint-dev/astroid/issues/777

tests/test_helpers.py

@@ -264,3 +264,13 @@ class A(type): #@
 def test_uninferable_for_safe_infer() -> None:
     uninfer = util.Uninferable
     assert util.safe_infer(util.Uninferable) == uninfer
+
+
+def test_safe_infer_shim() -> None:
+    with pytest.warns(DeprecationWarning) as records:
+        helpers.safe_infer(nodes.Unknown())
+
+    assert (
+        "Import safe_infer from astroid.util; this shim in astroid.helpers will be removed."
+        in records[0].message.args[0]
+    )