Merge pull request #1634 from madebylydia/main

Byron · web-flow · commit e19abe75bbd7 · 2023-08-28T08:08:14.000+02:00
feat: full typing for "progress" parameter in Repo class
diff --git a/git/repo/base.py b/git/repo/base.py
@@ -60,6 +60,7 @@
     PathLike,
     Lit_config_levels,
     Commit_ish,
+    CallableProgress,
     Tree_ish,
     assert_never,
 )
@@ -1258,7 +1259,7 @@ def _clone(
     def clone(
         self,
         path: PathLike,
-        progress: Optional[Callable] = None,
+        progress: Optional[CallableProgress] = None,
         multi_options: Optional[List[str]] = None,
         allow_unsafe_protocols: bool = False,
         allow_unsafe_options: bool = False,
@@ -1297,7 +1298,7 @@ def clone_from(
         cls,
         url: PathLike,
         to_path: PathLike,
-        progress: Optional[Callable] = None,
+        progress: CallableProgress = None,
         env: Optional[Mapping[str, str]] = None,
         multi_options: Optional[List[str]] = None,
         allow_unsafe_protocols: bool = False,
diff --git a/git/types.py b/git/types.py
@@ -8,42 +8,39 @@
 from typing import (
     Dict,
     NoReturn,
-    Sequence,
+    Sequence as Sequence,
     Tuple,
     Union,
     Any,
+    Optional,
+    Callable,
     TYPE_CHECKING,
     TypeVar,
 )  # noqa: F401
 
-if sys.version_info[:2] >= (3, 8):
+if sys.version_info >= (3, 8):
     from typing import (
         Literal,
-        SupportsIndex,
         TypedDict,
         Protocol,
+        SupportsIndex as SupportsIndex,
         runtime_checkable,
     )  # noqa: F401
 else:
     from typing_extensions import (
         Literal,
-        SupportsIndex,  # noqa: F401
+        SupportsIndex as SupportsIndex,
         TypedDict,
         Protocol,
         runtime_checkable,
     )  # noqa: F401
 
-# if sys.version_info[:2] >= (3, 10):
+# if sys.version_info >= (3, 10):
 #     from typing import TypeGuard  # noqa: F401
 # else:
 #     from typing_extensions import TypeGuard  # noqa: F401
 
-
-if sys.version_info[:2] < (3, 9):
-    PathLike = Union[str, os.PathLike]
-else:
-    # os.PathLike only becomes subscriptable from Python 3.9 onwards
-    PathLike = Union[str, os.PathLike[str]]
+PathLike = Union[str, "os.PathLike[str]"]
 
 if TYPE_CHECKING:
     from git.repo import Repo
@@ -62,6 +59,9 @@
 
 Lit_config_levels = Literal["system", "global", "user", "repository"]
 
+# Progress parameter type alias -----------------------------------------
+
+CallableProgress = Optional[Callable[[int, Union[str, float], Union[str, float, None], str], None]]
 
 # def is_config_level(inp: str) -> TypeGuard[Lit_config_levels]:
 #     # return inp in get_args(Lit_config_level)  # only py >= 3.8
diff --git a/requirements-dev.txt b/requirements-dev.txt
@@ -10,4 +10,4 @@ pytest-icdiff
 # pytest-profiling
 
 
-tox
+tox

Original file line number	Diff line number	Diff line change
`@@ -10,4 +10,4 @@ pytest-icdiff`
`10`	`10`	`# pytest-profiling`
`11`	`11`
`12`	`12`
`13`		`-tox`
	`13`	`+tox`