Start fixing annotations that used the old Commit_ish

Author: EliahKagan

git/objects/base.py

@@ -3,28 +3,30 @@
 # This module is part of GitPython and is released under the
 # 3-Clause BSD License: https://opensource.org/license/bsd-3-clause/
 
-from git.exc import WorkTreeRepositoryUnsupported
-from git.util import LazyMixin, join_path_native, stream_copy, bin_to_hex
-
 import gitdb.typ as dbtyp
 import os.path as osp
 
+from git.exc import WorkTreeRepositoryUnsupported
+from git.util import LazyMixin, join_path_native, stream_copy, bin_to_hex
+
 from .util import get_object_type_by_name
 
 
 # typing ------------------------------------------------------------------
 
 from typing import Any, TYPE_CHECKING, Union
 
-from git.types import GitObjectTypeString, Old_commit_ish, PathLike
+from git.types import AnyGitObject, GitObjectTypeString, PathLike
 
 if TYPE_CHECKING:
-    from git.repo import Repo
     from gitdb.base import OStream
+
+    from git.refs.reference import Reference
+    from git.repo import Repo
+
     from .tree import Tree
     from .blob import Blob
     from .submodule.base import Submodule
-    from git.refs.reference import Reference
 
 IndexObjUnion = Union["Tree", "Blob", "Submodule"]
 
@@ -115,7 +117,7 @@ def __init__(self, repo: "Repo", binsha: bytes):
         )
 
     @classmethod
-    def new(cls, repo: "Repo", id: Union[str, "Reference"]) -> Old_commit_ish:
+    def new(cls, repo: "Repo", id: Union[str, "Reference"]) -> AnyGitObject:
         """
         :return:
             New :class:`Object` instance of a type appropriate to the object type behind
@@ -132,7 +134,7 @@ def new(cls, repo: "Repo", id: Union[str, "Reference"]) -> Old_commit_ish:
         return repo.rev_parse(str(id))
 
     @classmethod
-    def new_from_sha(cls, repo: "Repo", sha1: bytes) -> Old_commit_ish:
+    def new_from_sha(cls, repo: "Repo", sha1: bytes) -> AnyGitObject:
         """
         :return:
             New object instance of a type appropriate to represent the given binary sha1

git/refs/symbolic.py

@@ -6,39 +6,38 @@
 from git.compat import defenc
 from git.objects import Object
 from git.objects.commit import Commit
+from git.refs.log import RefLog
 from git.util import (
+    LockedFD,
+    assure_directory_exists,
+    hex_to_bin,
     join_path,
     join_path_native,
     to_native_path_linux,
-    assure_directory_exists,
-    hex_to_bin,
-    LockedFD,
 )
-from gitdb.exc import BadObject, BadName
-
-from .log import RefLog
+from gitdb.exc import BadName, BadObject
 
 # typing ------------------------------------------------------------------
 
 from typing import (
     Any,
     Iterator,
     List,
+    TYPE_CHECKING,
     Tuple,
     Type,
     TypeVar,
     Union,
-    TYPE_CHECKING,
     cast,
 )
-from git.types import Old_commit_ish, PathLike
+from git.types import AnyGitObject, PathLike
 
 if TYPE_CHECKING:
-    from git.repo import Repo
-    from git.refs import Head, TagReference, RemoteReference, Reference
-    from .log import RefLogEntry
     from git.config import GitConfigParser
     from git.objects.commit import Actor
+    from git.refs import Head, TagReference, RemoteReference, Reference
+    from git.refs.log import RefLogEntry
+    from git.repo import Repo
 
 
 T_References = TypeVar("T_References", bound="SymbolicReference")
@@ -278,7 +277,7 @@ def _get_ref_info(cls, repo: "Repo", ref_path: Union[PathLike, None]) -> Union[T
         """
         return cls._get_ref_info_helper(repo, ref_path)
 
-    def _get_object(self) -> Old_commit_ish:
+    def _get_object(self) -> AnyGitObject:
         """
         :return:
             The object our ref currently refers to. Refs can be cached, they will always
@@ -345,17 +344,20 @@ def set_commit(
 
     def set_object(
         self,
-        object: Union[Old_commit_ish, "SymbolicReference", str],
+        object: Union[AnyGitObject, "SymbolicReference", str],
         logmsg: Union[str, None] = None,
     ) -> "SymbolicReference":
         """Set the object we point to, possibly dereference our symbolic reference
         first. If the reference does not exist, it will be created.
 
         :param object:
             A refspec, a :class:`SymbolicReference` or an
-            :class:`~git.objects.base.Object` instance. :class:`SymbolicReference`
-            instances will be dereferenced beforehand to obtain the object they point
-            to.
+            :class:`~git.objects.base.Object` instance.
+
+            * :class:`SymbolicReference` instances will be dereferenced beforehand to
+              obtain the git object they point to.
+            * :class:`~git.objects.base.Object` instances must represent git objects
+              (:class:`~git.types.AnyGitObject`).
 
         :param logmsg:
             If not ``None``, the message will be used in the reflog entry to be written.
@@ -404,22 +406,22 @@ def _get_reference(self) -> "SymbolicReference":
 
     def set_reference(
         self,
-        ref: Union[Old_commit_ish, "SymbolicReference", str],
+        ref: Union[AnyGitObject, "SymbolicReference", str],
         logmsg: Union[str, None] = None,
     ) -> "SymbolicReference":
         """Set ourselves to the given `ref`.
 
-        It will stay a symbol if the ref is a :class:`~git.refs.reference.Reference`.
+        It will stay a symbol if the `ref` is a :class:`~git.refs.reference.Reference`.
 
-        Otherwise an Object, given as :class:`~git.objects.base.Object` instance or
-        refspec, is assumed and if valid, will be set which effectively detaches the
-        reference if it was a purely symbolic one.
+        Otherwise a git object, specified as a :class:`~git.objects.base.Object`
+        instance or refspec, is assumed. If it is valid, this reference will be set to
+        it, which effectively detaches the reference if it was a purely symbolic one.
 
         :param ref:
             A :class:`SymbolicReference` instance, an :class:`~git.objects.base.Object`
-            instance, or a refspec string. Only if the ref is a
-            :class:`SymbolicReference` instance, we will point to it. Everything else is
-            dereferenced to obtain the actual object.
+            instance (specifically an :class:`~git.types.AnyGitObject`), or a refspec
+            string. Only if the ref is a :class:`SymbolicReference` instance, we will
+            point to it. Everything else is dereferenced to obtain the actual object.
 
         :param logmsg:
             If set to a string, the message will be used in the reflog.

git/refs/tag.py

@@ -14,14 +14,15 @@
 
 # typing ------------------------------------------------------------------
 
-from typing import Any, Type, Union, TYPE_CHECKING
-from git.types import Old_commit_ish, PathLike
+from typing import Any, TYPE_CHECKING, Type, Union
+
+from git.types import AnyGitObject, PathLike
 
 if TYPE_CHECKING:
-    from git.repo import Repo
     from git.objects import Commit
     from git.objects import TagObject
     from git.refs import SymbolicReference
+    from git.repo import Repo
 
 
 # ------------------------------------------------------------------------------
@@ -82,7 +83,7 @@ def tag(self) -> Union["TagObject", None]:
 
     # Make object read-only. It should be reasonably hard to adjust an existing tag.
     @property
-    def object(self) -> Old_commit_ish:  # type: ignore[override]
+    def object(self) -> AnyGitObject:  # type: ignore[override]
         return Reference._get_object(self)
 
     @classmethod

git/remote.py

@@ -44,11 +44,9 @@
 from git.types import PathLike, Literal, Old_commit_ish
 
 if TYPE_CHECKING:
-    from git.repo.base import Repo
+    from git.objects.commit import Commit
     from git.objects.submodule.base import UpdateProgress
-
-    # from git.objects.commit import Commit
-    # from git.objects import Blob, Tree, TagObject
+    from git.repo.base import Repo
 
 flagKeyLiteral = Literal[" ", "!", "+", "-", "*", "=", "t", "?"]
 
@@ -381,7 +379,7 @@ def name(self) -> str:
         return self.ref.name
 
     @property
-    def commit(self) -> Old_commit_ish:
+    def commit(self) -> "Commit":
         """:return: Commit of our remote ref"""
         return self.ref.commit
 

git/repo/base.py

@@ -34,29 +34,29 @@
 from git.remote import Remote, add_progress, to_progress_instance
 from git.util import (
     Actor,
-    finalize_process,
     cygpath,
-    hex_to_bin,
     expand_path,
+    finalize_process,
+    hex_to_bin,
     remove_password_if_present,
 )
 
 from .fun import (
-    rev_parse,
-    is_git_dir,
     find_submodule_git_dir,
-    touch,
     find_worktree_git_dir,
+    is_git_dir,
+    rev_parse,
+    touch,
 )
 
 # typing ------------------------------------------------------
 
 from git.types import (
-    TBD,
-    PathLike,
-    Lit_config_levels,
-    Old_commit_ish,
     CallableProgress,
+    Commit_ish,
+    Lit_config_levels,
+    PathLike,
+    TBD,
     Tree_ish,
     assert_never,
 )
@@ -68,25 +68,25 @@
     Iterator,
     List,
     Mapping,
+    NamedTuple,
     Optional,
     Sequence,
+    TYPE_CHECKING,
     TextIO,
     Tuple,
     Type,
     Union,
-    NamedTuple,
     cast,
-    TYPE_CHECKING,
 )
 
 from git.types import ConfigLevels_Tup, TypedDict
 
 if TYPE_CHECKING:
-    from git.util import IterableList
-    from git.refs.symbolic import SymbolicReference
     from git.objects import Tree
     from git.objects.submodule.base import UpdateProgress
+    from git.refs.symbolic import SymbolicReference
     from git.remote import RemoteProgress
+    from git.util import IterableList
 
 # -----------------------------------------------------------
 
@@ -96,7 +96,7 @@
 
 
 class BlameEntry(NamedTuple):
-    commit: Dict[str, "Commit"]
+    commit: Dict[str, Commit]
     linenos: range
     orig_path: Optional[str]
     orig_linenos: range
@@ -696,7 +696,7 @@ def config_writer(self, config_level: Lit_config_levels = "repository") -> GitCo
         """
         return GitConfigParser(self._get_config_path(config_level), read_only=False, repo=self, merge_includes=False)
 
-    def commit(self, rev: Union[str, Old_commit_ish, None] = None) -> Commit:
+    def commit(self, rev: Union[str, Commit_ish, None] = None) -> Commit:
         """The :class:`~git.objects.commit.Commit` object for the specified revision.
 
         :param rev:
@@ -772,7 +772,7 @@ def iter_commits(
 
         return Commit.iter_items(self, rev, paths, **kwargs)
 
-    def merge_base(self, *rev: TBD, **kwargs: Any) -> List[Union[Old_commit_ish, None]]:
+    def merge_base(self, *rev: TBD, **kwargs: Any) -> List[Commit]:
         R"""Find the closest common ancestor for the given revision
         (:class:`~git.objects.commit.Commit`\s, :class:`~git.refs.tag.Tag`\s,
         :class:`~git.refs.reference.Reference`\s, etc.).
@@ -797,9 +797,9 @@ def merge_base(self, *rev: TBD, **kwargs: Any) -> List[Union[Old_commit_ish, Non
             raise ValueError("Please specify at least two revs, got only %i" % len(rev))
         # END handle input
 
-        res: List[Union[Old_commit_ish, None]] = []
+        res: List[Commit] = []
         try:
-            lines = self.git.merge_base(*rev, **kwargs).splitlines()  # List[str]
+            lines: List[str] = self.git.merge_base(*rev, **kwargs).splitlines()
         except GitCommandError as err:
             if err.status == 128:
                 raise
@@ -815,7 +815,7 @@ def merge_base(self, *rev: TBD, **kwargs: Any) -> List[Union[Old_commit_ish, Non
 
         return res
 
-    def is_ancestor(self, ancestor_rev: "Commit", rev: "Commit") -> bool:
+    def is_ancestor(self, ancestor_rev: Commit, rev: Commit) -> bool:
         """Check if a commit is an ancestor of another.
 
         :param ancestor_rev: