Finish typing of pylint.pyreverse.utils

pylint/pyreverse/utils.py

@@ -11,10 +11,23 @@
 import shutil
 import subprocess
 import sys
+from typing import TYPE_CHECKING, Any, Callable, Optional, Tuple, Union
 
 import astroid
 from astroid import nodes
 
+if TYPE_CHECKING:
+    from pylint.pyreverse.diadefslib import DiaDefGenerator
+    from pylint.pyreverse.diagrams import ClassDiagram, PackageDiagram
+    from pylint.pyreverse.inspector import Linker
+
+    _CallbackT = Callable[
+        [nodes.NodeNG],
+        Optional[Union[Tuple[ClassDiagram], Tuple[PackageDiagram, ClassDiagram]]],
+    ]
+    _CallbackTupleT = Tuple[Optional[_CallbackT], Optional[_CallbackT]]
+
+
 RCFILE = ".pyreverserc"
 
 
@@ -46,7 +59,7 @@ def insert_default_options() -> None:
 PROTECTED = re.compile(r"^_\w*$")
 
 
-def get_visibility(name):
+def get_visibility(name: str) -> str:
     """Return the visibility from a name: public, protected, private or special."""
     if SPECIAL.match(name):
         visibility = "special"
@@ -60,37 +73,18 @@ def get_visibility(name):
     return visibility
 
 
-ABSTRACT = re.compile(r"^.*Abstract.*")
-FINAL = re.compile(r"^[^\W\da-z]*$")
-
-
-def is_abstract(node):
-    """Return true if the given class node correspond to an abstract class
-    definition.
-    """
-    return ABSTRACT.match(node.name)
-
-
-def is_final(node):
-    """Return true if the given class/function node correspond to final
-    definition.
-    """
-    return FINAL.match(node.name)
-
-
-def is_interface(node):
+def is_interface(node: nodes.ClassDef) -> bool:
     # bw compatibility
     return node.type == "interface"
 
 
-def is_exception(node):
+def is_exception(node: nodes.ClassDef) -> bool:
     # bw compatibility
     return node.type == "exception"
 
 
 # Helpers #####################################################################
 
-_CONSTRUCTOR = 1
 _SPECIAL = 2
 _PROTECTED = 4
 _PRIVATE = 8
@@ -111,7 +105,7 @@ def is_exception(node):
 class FilterMixIn:
     """Filter nodes according to a mode and nodes' visibility."""
 
-    def __init__(self, mode):
+    def __init__(self, mode: str) -> None:
         """Init filter modes."""
         __mode = 0
         for nummod in mode.split("+"):
@@ -121,7 +115,7 @@ def __init__(self, mode):
                 print(f"Unknown filter mode {ex}", file=sys.stderr)
         self.__mode = __mode
 
-    def show_attr(self, node):
+    def show_attr(self, node: nodes.NodeNG | str) -> bool:
         """Return true if the node should be treated."""
         visibility = get_visibility(getattr(node, "name", node))
         return not self.__mode & VIS_MOD[visibility]
@@ -137,11 +131,14 @@ class ASTWalker:
     the node in lower case
     """
 
-    def __init__(self, handler):
+    def __init__(self, handler: DiaDefGenerator | Linker | LocalsVisitor) -> None:
         self.handler = handler
-        self._cache = {}
+        self._cache: dict[
+            type[nodes.NodeNG],
+            _CallbackTupleT,
+        ] = {}
 
-    def walk(self, node, _done=None):
+    def walk(self, node: nodes.NodeNG, _done: set[nodes.NodeNG] | None = None) -> None:
         """Walk on the tree from <node>, getting callbacks from handler."""
         if _done is None:
             _done = set()
@@ -155,7 +152,7 @@ def walk(self, node, _done=None):
         self.leave(node)
         assert node.parent is not node
 
-    def get_callbacks(self, node):
+    def get_callbacks(self, node: nodes.NodeNG) -> _CallbackTupleT:
         """Get callbacks from handler for the visited node."""
         klass = node.__class__
         methods = self._cache.get(klass)
@@ -173,13 +170,13 @@ def get_callbacks(self, node):
             e_method, l_method = methods
         return e_method, l_method
 
-    def visit(self, node):
+    def visit(self, node: nodes.NodeNG) -> None:
         """Walk on the tree from <node>, getting callbacks from handler."""
         method = self.get_callbacks(node)[0]
         if method is not None:
             method(node)
 
-    def leave(self, node):
+    def leave(self, node: nodes.NodeNG) -> None:
         """Walk on the tree from <node>, getting callbacks from handler."""
         method = self.get_callbacks(node)[1]
         if method is not None:
@@ -189,11 +186,11 @@ def leave(self, node):
 class LocalsVisitor(ASTWalker):
     """Visit a project by traversing the locals dictionary."""
 
-    def __init__(self):
+    def __init__(self) -> None:
         super().__init__(self)
-        self._visited = set()
+        self._visited: set[nodes.NodeNG] = set()
 
-    def visit(self, node):
+    def visit(self, node: nodes.NodeNG) -> Any:
         """Launch the visit starting from the given node."""
         if node in self._visited:
             return None
@@ -253,7 +250,7 @@ def get_annotation(
     return ann
 
 
-def infer_node(node: nodes.AssignAttr | nodes.AssignName) -> set:
+def infer_node(node: nodes.AssignAttr | nodes.AssignName) -> set[Any]:
     """Return a set containing the node annotation if it exists
     otherwise return a set of the inferred types using the NodeNG.infer method.
     """
@@ -269,7 +266,7 @@ def infer_node(node: nodes.AssignAttr | nodes.AssignName) -> set:
         return {ann} if ann else set()
 
 
-def check_graphviz_availability():
+def check_graphviz_availability() -> None:
     """Check if the ``dot`` command is available on the machine.
 
     This is needed if image output is desired and ``dot`` is used to convert