Add types to config.py CONFIG_LEVELS, MetaParserBuilder.__new__() .needs_values() .set_dirty_and_flush_changes()

Author: Yobmod

git/config.py

@@ -31,9 +31,9 @@
 
 # typing-------------------------------------------------------
 
-from typing import TYPE_CHECKING, Tuple
+from typing import Any, Callable, Mapping, TYPE_CHECKING, Tuple
 
-from git.types import Literal
+from git.types import Literal, Lit_config_levels, TBD
 
 if TYPE_CHECKING:
     pass
@@ -59,7 +59,7 @@
 class MetaParserBuilder(abc.ABCMeta):
 
     """Utlity class wrapping base-class methods into decorators that assure read-only properties"""
-    def __new__(cls, name, bases, clsdict):
+    def __new__(cls, name: str, bases: TBD, clsdict: Mapping[str, Any]) -> TBD:
         """
         Equip all base-class methods with a needs_values decorator, and all non-const methods
         with a set_dirty_and_flush_changes decorator in addition to that."""
@@ -85,23 +85,23 @@ def __new__(cls, name, bases, clsdict):
         return new_type
 
 
-def needs_values(func):
+def needs_values(func: Callable) -> Callable:
     """Returns method assuring we read values (on demand) before we try to access them"""
 
     @wraps(func)
-    def assure_data_present(self, *args, **kwargs):
+    def assure_data_present(self, *args: Any, **kwargs: Any) -> Any:
         self.read()
         return func(self, *args, **kwargs)
     # END wrapper method
     return assure_data_present
 
 
-def set_dirty_and_flush_changes(non_const_func):
+def set_dirty_and_flush_changes(non_const_func: Callable) -> Callable:
     """Return method that checks whether given non constant function may be called.
     If so, the instance will be set dirty.
     Additionally, we flush the changes right to disk"""
 
-    def flush_changes(self, *args, **kwargs):
+    def flush_changes(self, *args: Any, **kwargs: Any) -> Any:
         rval = non_const_func(self, *args, **kwargs)
         self._dirty = True
         self.write()
@@ -206,7 +206,7 @@ def items_all(self):
         return [(k, self.getall(k)) for k in self]
 
 
-def get_config_path(config_level: Literal['system', 'global', 'user', 'repository']) -> str:
+def get_config_path(config_level: Lit_config_levels) -> str:
 
     # we do not support an absolute path of the gitconfig on windows ,
     # use the global config instead

git/repo/base.py

@@ -34,7 +34,7 @@
 
 # typing ------------------------------------------------------
 
-from git.types import TBD, PathLike, Literal
+from git.types import TBD, PathLike, Lit_config_levels
 from typing import (Any, BinaryIO, Callable, Dict,
                     Iterator, List, Mapping, Optional,
                     TextIO, Tuple, Type, Union,
@@ -45,7 +45,6 @@
     from git.refs.symbolic import SymbolicReference
     from git.objects import TagObject, Blob, Tree  # NOQA: F401
 
-Lit_config_levels = Literal['system', 'global', 'user', 'repository']
 
 # -----------------------------------------------------------
 

git/types.py

@@ -12,8 +12,6 @@
     from typing_extensions import Final, Literal  # noqa: F401
 
 
-TBD = Any
-
 if sys.version_info[:2] < (3, 6):
     # os.PathLike (PEP-519) only got introduced with Python 3.6
     PathLike = str
@@ -23,3 +21,7 @@
 elif sys.version_info[:2] >= (3, 9):
     # os.PathLike only becomes subscriptable from Python 3.9 onwards
     PathLike = Union[str, os.PathLike[str]]
+
+TBD = Any
+
+Lit_config_levels = Literal['system', 'global', 'user', 'repository']

mypy.ini

@@ -2,7 +2,7 @@
 [mypy]
 
 # TODO: enable when we've fully annotated everything
-# disallow_untyped_defs = True
+disallow_untyped_defs = True
 
 # TODO: remove when 'gitdb' is fully annotated
 [mypy-gitdb.*]