Merge pull request #1202 from Yobmod/main

Add more types

Author: Byron

git/__init__.py

@@ -5,18 +5,20 @@
 # the BSD License: http://www.opensource.org/licenses/bsd-license.php
 # flake8: noqa
 #@PydevCodeAnalysisIgnore
+fromgit.excimport*# @NoMove @IgnorePep8
 importinspect
 importos
 importsys
-
 importos.pathasosp
 
+fromtypingimportOptional
+fromgit.typesimportPathLike
 
 __version__='git'
 
 
 #{Initialization
-def_init_externals():
+def_init_externals()->None:
 """Initialize external projects by putting them into the path"""
 if__version__=='git'and'PYOXIDIZER'notinos.environ:
 sys.path.insert(1, osp.join(osp.dirname(__file__), 'ext', 'gitdb'))
@@ -29,13 +31,13 @@ def _init_externals():
 
 #} END initialization
 
+
 #################
 _init_externals()
 #################
 
 #{Imports
 
-fromgit.excimport*# @NoMove @IgnorePep8
 try:
 fromgit.configimportGitConfigParser# @NoMove @IgnorePep8
 fromgit.objectsimport*# @NoMove @IgnorePep8
@@ -65,7 +67,8 @@ def _init_externals():
 #{Initialize git executable path
 GIT_OK=None
 
-defrefresh(path=None):
+
+defrefresh(path: Optional[PathLike] =None) ->None:
 """Convenience method for setting the git executable path."""
 globalGIT_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):
 returnself
-
+
 def__next__(self):
 returnself.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 @@
 importos
 importsys
 
-
 fromgitdb.utils.encodingimport (
 force_bytes, # @UnusedImport
 force_text# @UnusedImport
 )
 
+# typing --------------------------------------------------------------------
+
+fromtypingimportAny, AnyStr, Dict, Optional, Type
+fromgit.typesimportTBD
+
+# ---------------------------------------------------------------------------
 
-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()
 
 
-defsafe_decode(s):
+defsafe_decode(s: Optional[AnyStr]) ->Optional[str]:
 """Safely decodes a binary string to unicode"""
 ifisinstance(s, str):
 returns
 elifisinstance(s, bytes):
 returns.decode(defenc, 'surrogateescape')
-elifsisnotNone:
+elifsisNone:
+returnNone
+else:
 raiseTypeError('Expected bytes or text, but got %r'% (s,))
 
 
-defsafe_encode(s):
-"""Safely decodes a binary string to unicode"""
+defsafe_encode(s: Optional[AnyStr]) ->Optional[bytes]:
+"""Safely encodes a binary string to unicode"""
 ifisinstance(s, str):
 returns.encode(defenc)
 elifisinstance(s, bytes):
 returns
-elifsisnotNone:
+elifsisNone:
+returnNone
+else:
 raiseTypeError('Expected bytes or text, but got %r'% (s,))
 
 
-defwin_encode(s):
+defwin_encode(s: Optional[AnyStr]) ->Optional[bytes]:
 """Encode unicodes for process arguments on Windows."""
 ifisinstance(s, str):
 returns.encode(locale.getpreferredencoding(False))
 elifisinstance(s, bytes):
 returns
 elifsisnotNone:
 raiseTypeError('Expected bytes or text, but got %r'% (s,))
+returnNone
+
 
 
-defwith_metaclass(meta, *bases):
+defwith_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"""
-classmetaclass(meta):
+
+classmetaclass(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:
 ifnbasesisNone:
 returntype.__new__(cls, name, (), d)
 returnmeta(name, bases, d)
+
 returnmetaclass(meta.__name__+'Helper', None,{})

git/config.py

@@ -16,6 +16,8 @@
 importfnmatch
 fromcollectionsimportOrderedDict
 
+fromtyping_extensionsimportLiteral
+
 fromgit.compatimport (
 defenc,
 force_text,
@@ -194,7 +196,7 @@ def items_all(self):
 return [(k, self.getall(k)) forkinself]
 
 
-defget_config_path(config_level):
+defget_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 @@
 fromgitdb.dbimportGitDB# @UnusedImport
 fromgitdb.dbimportLooseObjectDB
 
-from .excimport (
-GitCommandError,
-BadObject
-)
+fromgitdb.excimportBadObject
+fromgit.excimportGitCommandError
+
+# typing-------------------------------------------------
+
+fromtypingimportTYPE_CHECKING, AnyStr
+fromgit.typesimportPathLike
+
+ifTYPE_CHECKING:
+fromgit.cmdimportGit
+
 
+# --------------------------------------------------------
 
 __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
 
-definfo(self, sha):
+definfo(self, sha: bytes) ->OInfo:
 hexsha, typename, size=self._git.get_object_header(bin_to_hex(sha))
 returnOInfo(hex_to_bin(hexsha), typename, size)
 
-defstream(self, sha):
+defstream(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))
 returnOStream(hex_to_bin(hexsha), typename, size, stream)
 
 #{Interface
 
-defpartial_to_complete_sha_hex(self, partial_hexsha):
+defpartial_to_complete_sha_hex(self, partial_hexsha: AnyStr) ->bytes:
 """:return: Full binary 20 byte sha from the given partial hexsha
  :raise AmbiguousObjectName:
  :raise BadObject: