style: fix type annotations

Author: pwwang

varname/core.py

@@ -3,7 +3,7 @@
 import ast
 import re
 import warnings
-from typing import Any, List, Union, Tuple, Type, Callable, overload
+from typing import Any, List, Union, Tuple, Type, Callable, Optional, overload
 
 from executing import Source
 
@@ -27,11 +27,11 @@
 
 def varname(
     frame: int = 1,
-    ignore: IgnoreType = None,
+    ignore: IgnoreType | None = None,
     multi_vars: bool = False,
     raise_exc: bool = True,
     strict: bool = True,
-) -> Union[str, Tuple[Union[str, Tuple], ...]]:
+) -> Optional[Union[str, Tuple[Union[str, Tuple], ...]]]:
     """Get the name of the variable(s) that assigned by function call or
     class instantiation.
 
@@ -148,10 +148,10 @@ class instantiation.
             )
         )
 
-    return names[0]
+    return names[0]  # type: ignore
 
 
-def will(frame: int = 1, raise_exc: bool = True) -> str:
+def will(frame: int = 1, raise_exc: bool = True) -> Optional[str]:
     """Detect the attribute name right immediately after a function call.
 
     Examples:
@@ -204,7 +204,7 @@ def will(frame: int = 1, raise_exc: bool = True) -> str:
         return None
 
     # try to get node inst.attr from inst.attr()
-    node = node.parent
+    node = node.parent  # type: ignore
 
     # see test_will_fail
     if not isinstance(node, ast.Attribute):
@@ -309,12 +309,12 @@ def nameof(
         # We don't have to check keyword arguments here, as the instruction
         # will then be CALL_FUNCTION_KW.
         if not more_vars:
-            return bytecode_nameof(frameobj.f_code, frameobj.f_lasti)
+            return bytecode_nameof(frameobj.f_code, frameobj.f_lasti)  # type: ignore
 
         # We are anyway raising exceptions, no worries about additional burden
         # of frame retrieval again
-        source = frameobj.f_code.co_filename
-        if source == "<stdin>":
+        source = frameobj.f_code.co_filename  # type: ignore
+        if source == "<stdin>":  # pragma: no cover
             raise VarnameRetrievingError(
                 "Are you trying to call nameof in REPL/python shell? "
                 "In such a case, nameof can only be called with single "
@@ -345,10 +345,10 @@ def nameof(
 def argname(
     arg: str,
     *,
-    func: Callable = None,
-    dispatch: Type = None,
+    func: Optional[Callable] = None,
+    dispatch: Optional[Type] = None,
     frame: int = 1,
-    ignore: IgnoreType = None,
+    ignore: Optional[IgnoreType] = None,
     vars_only: bool = True,
 ) -> ArgSourceType:  # pragma: no cover
     ...
@@ -360,10 +360,10 @@ def argname(
     more_arg: str,
     /,  # introduced in python 3.8
     *more_args: str,
-    func: Callable = None,
-    dispatch: Type = None,
+    func: Optional[Callable] = None,
+    dispatch: Optional[Type] = None,
     frame: int = 1,
-    ignore: IgnoreType = None,
+    ignore: Optional[IgnoreType] = None,
     vars_only: bool = True,
 ) -> Tuple[ArgSourceType, ...]:  # pragma: no cover
     ...
@@ -372,10 +372,10 @@ def argname(
 def argname(
     arg: str,
     *more_args: str,
-    func: Callable = None,
-    dispatch: Type = None,
+    func: Optional[Callable] = None,
+    dispatch: Optional[Type] = None,
     frame: int = 1,
-    ignore: IgnoreType = None,
+    ignore: Optional[IgnoreType] = None,
     vars_only: bool = True,
 ) -> Union[ArgSourceType, Tuple[ArgSourceType, ...]]:
     """Get the names/sources of arguments passed to a function.
@@ -456,10 +456,10 @@ def argname(
     func_node = reconstruct_func_node(func_node)
 
     if not func:
-        func = get_function_called_argname(func_frame, func_node)
+        func = get_function_called_argname(func_frame, func_node)  # type: ignore
 
     if dispatch:
-        func = func.dispatch(dispatch)
+        func = func.dispatch(dispatch)  # type: ignore
 
     # don't pass the target arguments so that we can cache the sources in
     # the same call. For example:
@@ -468,9 +468,9 @@ def argname(
     # >>>   b_name = argname(b)
     try:
         argument_sources = get_argument_sources(
-            Source.for_frame(func_frame),
+            Source.for_frame(func_frame),  # type: ignore
             func_node,
-            func,
+            func,  # type: ignore
             vars_only=vars_only,
         )
     except Exception as err:
@@ -483,13 +483,13 @@ def argname(
     for farg in (arg, *more_args):
 
         farg_name = farg
-        farg_subscript = None  # type: str | int
+        farg_subscript = None  # type: Optional[str]
         match = re.match(r"^([\w_]+)\[(.+)\]$", farg)
         if match:
             farg_name = match.group(1)
             farg_subscript = match.group(2)
-            if farg_subscript.isdigit():
-                farg_subscript = int(farg_subscript)
+            if farg_subscript.isdigit():  # type: ignore
+                farg_subscript = int(farg_subscript)  # type: ignore
         else:
             match = re.match(r"^\*([\w_]+)$", farg)
             if match:

varname/helpers.py

@@ -4,17 +4,17 @@
 import inspect
 from functools import partial, wraps
 from os import PathLike
-from typing import Any, Callable, Dict, Tuple, Type, Union
+from typing import Any, Callable, Dict, Tuple, Type, Union, Optional
 
 from .utils import IgnoreType
 from .ignore import IgnoreList
 from .core import argname, varname
 
 
 def register(
-    cls_or_func: type = None,
+    cls_or_func: Optional[Type] = None,
     frame: int = 1,
-    ignore: IgnoreType = None,
+    ignore: Optional[IgnoreType] = None,
     multi_vars: bool = False,
     raise_exc: bool = True,
     strict: bool = True,
@@ -130,7 +130,7 @@ def __init__(
         self,
         value: Any,
         frame: int = 1,
-        ignore: IgnoreType = None,
+        ignore: Optional[IgnoreType] = None,
         raise_exc: bool = True,
         strict: bool = True,
     ):
@@ -240,12 +240,12 @@ def debug(
 
 def exec_code(
     code: str,
-    globals: Dict[str, Any] = None,
-    locals: Dict[str, Any] = None,
+    globals: Optional[Dict[str, Any]] = None,
+    locals: Optional[Dict[str, Any]] = None,
     /,
-    sourcefile: PathLike | str = None,
+    sourcefile: Optional[PathLike | str] = None,
     frame: int = 1,
-    ignore: IgnoreType = None,
+    ignore: Optional[IgnoreType] = None,
     **kwargs: Any,
 ) -> None:
     """Execute code where source code is visible at runtime.
@@ -297,9 +297,9 @@ def exec_code(
         ignore_list = IgnoreList.create(ignore)
         frame_info = ignore_list.get_frame(frame)
         if globals is None:
-            globals = frame_info.f_globals
+            globals = frame_info.f_globals  # type: ignore
         if locals is None:
-            locals = frame_info.f_locals
+            locals = frame_info.f_locals  # type: ignore
 
     try:
         exec(compile(code, sourcefile, "exec"), globals, locals, **kwargs)

varname/ignore.py

@@ -17,25 +17,27 @@
 <lambda> are ignored by default.
 
 """
+
 import sys
 import inspect
 import warnings
 from os import path
 from pathlib import Path
 from fnmatch import fnmatch
 from abc import ABC, abstractmethod
-from typing import List, Union
+from typing import List, Union, Optional
 from types import FrameType, ModuleType, FunctionType
 
 from executing import Source
 
 try:
     import sysconfig  # 3.10+
 except ImportError:  # pragma: no cover
-    from distutils import sysconfig
+    from distutils import sysconfig  # type: ignore
+
     STANDLIB_PATH = sysconfig.get_python_lib(standard_lib=True)
 else:
-    STANDLIB_PATH = sysconfig.get_path('stdlib')
+    STANDLIB_PATH = sysconfig.get_path("stdlib")
 
 from .utils import (
     IgnoreElemType,
@@ -52,6 +54,13 @@
 class IgnoreElem(ABC):
     """An element of the ignore list"""
 
+    module: ModuleType
+    filename: str
+    dirname: str
+    func: FunctionType
+    n_decor: int
+    qualname: str
+
     def __init_subclass__(cls, attrs: List[str]) -> None:
         """Define different attributes for subclasses"""
 
@@ -120,9 +129,7 @@ def match(self, frame_no: int, frameinfos: List[inspect.FrameInfo]) -> bool:
         frame = frameinfos[frame_no].frame
 
         # in case of symbolic links
-        return path.realpath(frame.f_code.co_filename) == path.realpath(
-            self.filename
-        )
+        return path.realpath(frame.f_code.co_filename) == path.realpath(self.filename)
 
 
 class IgnoreDirname(IgnoreElem, attrs=["dirname"]):
@@ -220,9 +227,7 @@ def match(self, frame_no: int, frameinfos: List[inspect.FrameInfo]) -> bool:
         if module and module != self.module:
             return False
 
-        if not module and not frame_matches_module_by_ignore_id(
-            frame, self.module
-        ):
+        if not module and not frame_matches_module_by_ignore_id(frame, self.module):
             return False
 
         source = Source.for_frame(frame)
@@ -231,7 +236,10 @@ def match(self, frame_no: int, frameinfos: List[inspect.FrameInfo]) -> bool:
         return fnmatch(source.code_qualname(frame.f_code), self.qualname)
 
 
-class IgnoreFilenameQualname(IgnoreElem, attrs=["filename", "qualname"]):
+class IgnoreFilenameQualname(
+    IgnoreElem,
+    attrs=["filename", "qualname"],
+):  # pragma: no cover
     """Ignore calls with given qualname in the module with the filename"""
 
     def match(self, frame_no: int, frameinfos: List[inspect.FrameInfo]) -> bool:
@@ -284,7 +292,7 @@ def create_ignore_elem(ignore_elem: IgnoreElemType) -> IgnoreElem:
 
     if isinstance(ignore_elem[0], ModuleType):
         return IgnoreModuleQualname(*ignore_elem)  # type: ignore
-    if isinstance(ignore_elem[0], (Path, str)):
+    if isinstance(ignore_elem[0], (Path, str)):  # pragma: no cover
         return IgnoreFilenameQualname(*ignore_elem)  # type: ignore
     if ignore_elem[0] is None:
         return IgnoreOnlyQualname(*ignore_elem)
@@ -298,7 +306,7 @@ class IgnoreList:
     @classmethod
     def create(
         cls,
-        ignore: IgnoreType = None,
+        ignore: Optional[IgnoreType] = None,
         ignore_lambda: bool = True,
         ignore_varname: bool = True,
     ) -> "IgnoreList":
@@ -324,9 +332,9 @@ def create(
             IgnoreStdlib(STANDLIB_PATH)  # type: ignore
         ]  # type: List[IgnoreElem]
         if ignore_varname:
-            ignore_list.append(create_ignore_elem(sys.modules[__package__]))
+            ignore_list.append(create_ignore_elem(sys.modules[__package__ or __name__]))
         if ignore_lambda:
-            ignore_list.append(create_ignore_elem((None, "*<lambda>")))
+            ignore_list.append(create_ignore_elem((None, "*<lambda>")))  # type: ignore
         for ignore_elem in ignore:
             ignore_list.append(create_ignore_elem(ignore_elem))
 
@@ -355,19 +363,15 @@ def nextframe_to_check(
         for ignore_elem in self.ignore_list:
             matched = ignore_elem.match(frame_no, frameinfos)  # type: ignore
             if matched and isinstance(ignore_elem, IgnoreDecorated):
-                debug_ignore_frame(
-                    f"Ignored by {ignore_elem!r}", frameinfos[frame_no]
-                )
+                debug_ignore_frame(f"Ignored by {ignore_elem!r}", frameinfos[frame_no])
                 return ignore_elem.n_decor + 1
 
             if matched:
-                debug_ignore_frame(
-                    f"Ignored by {ignore_elem!r}", frameinfos[frame_no]
-                )
+                debug_ignore_frame(f"Ignored by {ignore_elem!r}", frameinfos[frame_no])
                 return 1
         return 0
 
-    def get_frame(self, frame_no: int) -> FrameType:
+    def get_frame(self, frame_no: int) -> Optional[FrameType]:
         """Get the right frame by the frame number
 
         Args:
@@ -397,9 +401,7 @@ def get_frame(self, frame_no: int) -> FrameType:
                     debug_ignore_frame("Gotcha!", frames[i])
                     return frames[i].frame
 
-                debug_ignore_frame(
-                    f"Skipping ({frame_no - 1} more to skip)", frames[i]
-                )
+                debug_ignore_frame(f"Skipping ({frame_no - 1} more to skip)", frames[i])
                 i += 1
 
         except Exception as exc: