Add typing to scope()

astroid/nodes/node_classes.py

@@ -40,7 +40,7 @@
 import sys
 import typing
 from functools import lru_cache
-from typing import Callable, Generator, Optional
+from typing import TYPE_CHECKING, Callable, Generator, Optional
 
 from astroid import decorators, mixins, util
 from astroid.bases import Instance, _infer_stmts
@@ -61,6 +61,9 @@
 else:
     from typing_extensions import Literal
 
+if TYPE_CHECKING:
+    from astroid.scoped_nodes import LocalsDictNodeNG
+
 
 def _is_const(value):
     return isinstance(value, tuple(CONST_CLS))
@@ -2020,7 +2023,7 @@ def postinit(self, nodes: typing.List[NodeNG]) -> None:
         """
         self.nodes = nodes
 
-    def scope(self):
+    def scope(self) -> Optional["LocalsDictNodeNG"]:
         """The first parent node defining a new scope.
 
         :returns: The first parent scope node.

astroid/nodes/node_ng.py

@@ -1,14 +1,27 @@
 import pprint
 import typing
 from functools import singledispatch as _singledispatch
-from typing import ClassVar, Iterator, Optional, Tuple, Type, TypeVar, Union, overload
+from typing import (
+    TYPE_CHECKING,
+    ClassVar,
+    Iterator,
+    Optional,
+    Tuple,
+    Type,
+    TypeVar,
+    Union,
+    overload,
+)
 
 from astroid import decorators, util
 from astroid.exceptions import AstroidError, InferenceError, UseInferenceDefault
 from astroid.manager import AstroidManager
 from astroid.nodes.as_string import AsStringVisitor
 from astroid.nodes.const import OP_PRECEDENCE
 
+if TYPE_CHECKING:
+    from astroid.scoped_nodes import LocalsDictNodeNG
+
 # Types for 'NodeNG.nodes_of_class()'
 T_Nodes = TypeVar("T_Nodes", bound="NodeNG")
 T_Nodes2 = TypeVar("T_Nodes2", bound="NodeNG")
@@ -246,7 +259,7 @@ def frame(self):
         """
         return self.parent.frame()
 
-    def scope(self):
+    def scope(self) -> Optional["LocalsDictNodeNG"]:
         """The first parent node defining a new scope.
 
         :returns: The first parent scope node.

astroid/nodes/scoped_nodes.py

@@ -43,7 +43,7 @@
 import io
 import itertools
 import typing
-from typing import List, Optional
+from typing import List, Optional, TypeVar
 
 from astroid import bases
 from astroid import decorators as decorators_mod
@@ -77,6 +77,9 @@
     {"classmethod", "staticmethod", "builtins.classmethod", "builtins.staticmethod"}
 )
 
+# # Type for 'LocalsDictNodeNG.scope()'
+T_LocalsDictScope = TypeVar("T_LocalsDictScope", bound="LocalsDictNodeNG")
+
 
 def _c3_merge(sequences, cls, context):
     """Merges MROs in *sequences* to a single MRO using the C3 algorithm.
@@ -237,7 +240,7 @@ def frame(self):
         """
         return self
 
-    def scope(self):
+    def scope(self: T_LocalsDictScope) -> T_LocalsDictScope:
         """The first parent node defining a new scope.
 
         :returns: The first parent scope node.