add types to git.__init__, compat, db, diff, exc, util

Author: Yobmod

git/__init__.py

@@ -5,18 +5,20 @@
 # the BSD License: http://www.opensource.org/licenses/bsd-license.php
 # flake8: noqa
 #@PydevCodeAnalysisIgnore
+from git.exc import *                       # @NoMove @IgnorePep8
 import inspect
 import os
 import sys
-
 import os.path as osp
 
+from typing import Optional
+from git.types import PathLike
 
 __version__ = 'git'
 
 
 #{ Initialization
-def _init_externals():
+def _init_externals() -> None:
     """Initialize external projects by putting them into the path"""
     if __version__ == 'git' and 'PYOXIDIZER' not in os.environ:
         sys.path.insert(1, osp.join(osp.dirname(__file__), 'ext', 'gitdb'))
@@ -29,13 +31,13 @@ def _init_externals():
 
 #} END initialization
 
+
 #################
 _init_externals()
 #################
 
 #{ Imports
 
-from git.exc import *                       # @NoMove @IgnorePep8
 try:
     from git.config import GitConfigParser  # @NoMove @IgnorePep8
     from git.objects import *               # @NoMove @IgnorePep8
@@ -65,7 +67,8 @@ def _init_externals():
 #{ Initialize git executable path
 GIT_OK = None
 
-def refresh(path=None):
+
+def refresh(path: Optional[PathLike] = None) -> None:
     """Convenience method for setting the git executable path."""
     global GIT_OK
     GIT_OK = False
@@ -78,6 +81,7 @@ def refresh(path=None):
     GIT_OK = True
 #} END initialize git executable path
 
+
 #################
 try:
     refresh()

git/cmd.py

@@ -210,7 +210,7 @@ def refresh(cls, path=None):
         # - a GitCommandNotFound error is spawned by ourselves
         # - a PermissionError is spawned if the git executable provided
         #   cannot be executed for whatever reason
-        
+
         has_git = False
         try:
             cls().version()
@@ -498,7 +498,7 @@ def readlines(self, size=-1):
         # skipcq: PYL-E0301
         def __iter__(self):
             return self
-        
+
         def __next__(self):
             return self.next()
 
@@ -639,7 +639,7 @@ def execute(self, command,
 
         :param env:
             A dictionary of environment variables to be passed to `subprocess.Popen`.
-            
+
         :param max_chunk_size:
             Maximum number of bytes in one chunk of data passed to the output_stream in
             one invocation of write() method. If the given number is not positive then

git/compat.py

@@ -11,57 +11,71 @@
 import os
 import sys
 
-
 from gitdb.utils.encoding import (
     force_bytes,     # @UnusedImport
     force_text       # @UnusedImport
 )
 
+# typing --------------------------------------------------------------------
+
+from typing import Any, AnyStr, Dict, Optional, Type
+from git.types import TBD
+
+# ---------------------------------------------------------------------------
 
-is_win = (os.name == 'nt')
+
+is_win = (os.name == 'nt')  # type: bool
 is_posix = (os.name == 'posix')
 is_darwin = (os.name == 'darwin')
 defenc = sys.getfilesystemencoding()
 
 
-def safe_decode(s):
+def safe_decode(s: Optional[AnyStr]) -> Optional[str]:
     """Safely decodes a binary string to unicode"""
     if isinstance(s, str):
         return s
     elif isinstance(s, bytes):
         return s.decode(defenc, 'surrogateescape')
-    elif s is not None:
+    elif s is None:
+        return None
+    else:
         raise TypeError('Expected bytes or text, but got %r' % (s,))
 
 
-def safe_encode(s):
-    """Safely decodes a binary string to unicode"""
+def safe_encode(s: Optional[AnyStr]) -> Optional[bytes]:
+    """Safely encodes a binary string to unicode"""
     if isinstance(s, str):
         return s.encode(defenc)
     elif isinstance(s, bytes):
         return s
-    elif s is not None:
+    elif s is None:
+        return None
+    else:
         raise TypeError('Expected bytes or text, but got %r' % (s,))
 
 
-def win_encode(s):
+def win_encode(s: Optional[AnyStr]) -> Optional[bytes]:
     """Encode unicodes for process arguments on Windows."""
     if isinstance(s, str):
         return s.encode(locale.getpreferredencoding(False))
     elif isinstance(s, bytes):
         return s
     elif s is not None:
         raise TypeError('Expected bytes or text, but got %r' % (s,))
+    return None
+
 
 
-def with_metaclass(meta, *bases):
+def with_metaclass(meta: Type[Any], *bases: Any) -> 'metaclass': # type: ignore ## mypy cannot understand dynamic class creation
     """copied from https://github.com/Byron/bcore/blob/master/src/python/butility/future.py#L15"""
-    class metaclass(meta):
+
+    class metaclass(meta):  # type: ignore
         __call__ = type.__call__
-        __init__ = type.__init__
+        __init__ = type.__init__    # type: ignore
 
-        def __new__(cls, name, nbases, d):
+        def __new__(cls, name: str, nbases: Optional[int], d: Dict[str, Any]) -> TBD:
             if nbases is None:
                 return type.__new__(cls, name, (), d)
             return meta(name, bases, d)
+
     return metaclass(meta.__name__ + 'Helper', None, {})

git/config.py

@@ -16,6 +16,8 @@
 import fnmatch
 from collections import OrderedDict
 
+from typing_extensions import Literal
+
 from git.compat import (
     defenc,
     force_text,
@@ -194,7 +196,7 @@ def items_all(self):
         return [(k, self.getall(k)) for k in self]
 
 
-def get_config_path(config_level):
+def get_config_path(config_level: Literal['system', 'global', 'user', 'repository']) -> str:
 
     # we do not support an absolute path of the gitconfig on windows ,
     # use the global config instead

git/db.py

@@ -7,11 +7,19 @@
 from gitdb.db import GitDB  # @UnusedImport
 from gitdb.db import LooseObjectDB
 
-from .exc import (
-    GitCommandError,
-    BadObject
-)
+from gitdb.exc import BadObject
+from git.exc import GitCommandError
+
+# typing-------------------------------------------------
+
+from typing import TYPE_CHECKING, AnyStr
+from git.types import PathLike
+
+if TYPE_CHECKING:
+    from git.cmd import Git
+    
 
+# --------------------------------------------------------
 
 __all__ = ('GitCmdObjectDB', 'GitDB')
 
@@ -28,23 +36,23 @@ class GitCmdObjectDB(LooseObjectDB):
         have packs and the other implementations
     """
 
-    def __init__(self, root_path, git):
+    def __init__(self, root_path: PathLike, git: 'Git') -> None:
         """Initialize this instance with the root and a git command"""
         super(GitCmdObjectDB, self).__init__(root_path)
         self._git = git
 
-    def info(self, sha):
+    def info(self, sha: bytes) -> OInfo:
         hexsha, typename, size = self._git.get_object_header(bin_to_hex(sha))
         return OInfo(hex_to_bin(hexsha), typename, size)
 
-    def stream(self, sha):
+    def stream(self, sha: bytes) -> OStream:
         """For now, all lookup is done by git itself"""
         hexsha, typename, size, stream = self._git.stream_object_data(bin_to_hex(sha))
         return OStream(hex_to_bin(hexsha), typename, size, stream)
 
     # { Interface
 
-    def partial_to_complete_sha_hex(self, partial_hexsha):
+    def partial_to_complete_sha_hex(self, partial_hexsha: AnyStr) -> bytes:
         """:return: Full binary 20 byte sha from the given partial hexsha
         :raise AmbiguousObjectName:
         :raise BadObject: