GitPython 3.1.45__tar.gz → 3.1.46__tar.gz

{gitpython-3.1.45 → gitpython-3.1.46/GitPython.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: GitPython
-Version: 3.1.45
+Version: 3.1.46
 Summary: GitPython is a Python library used to interact with Git repositories
 Home-page: https://github.com/gitpython-developers/GitPython
 Author: Sebastian Thiel, Michael Trier
@@ -32,7 +32,7 @@ Provides-Extra: test
 Requires-Dist: coverage[toml]; extra == "test"
 Requires-Dist: ddt!=1.4.3,>=1.1.1; extra == "test"
 Requires-Dist: mock; python_version < "3.8" and extra == "test"
-Requires-Dist: mypy; extra == "test"
+Requires-Dist: mypy==1.18.2; python_version >= "3.9" and extra == "test"
 Requires-Dist: pre-commit; extra == "test"
 Requires-Dist: pytest>=7.3.1; extra == "test"
 Requires-Dist: pytest-cov; extra == "test"

{gitpython-3.1.45 → gitpython-3.1.46}/GitPython.egg-info/requires.txt

@@ -11,7 +11,6 @@ sphinx-autodoc-typehints
 [test]
 coverage[toml]
 ddt!=1.4.3,>=1.1.1
-mypy
 pre-commit
 pytest>=7.3.1
 pytest-cov
@@ -24,3 +23,6 @@ typing-extensions
 
 [test:python_version < "3.8"]
 mock
+
+[test:python_version >= "3.9"]
+mypy==1.18.2

{gitpython-3.1.45/GitPython.egg-info → gitpython-3.1.46}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: GitPython
-Version: 3.1.45
+Version: 3.1.46
 Summary: GitPython is a Python library used to interact with Git repositories
 Home-page: https://github.com/gitpython-developers/GitPython
 Author: Sebastian Thiel, Michael Trier
@@ -32,7 +32,7 @@ Provides-Extra: test
 Requires-Dist: coverage[toml]; extra == "test"
 Requires-Dist: ddt!=1.4.3,>=1.1.1; extra == "test"
 Requires-Dist: mock; python_version < "3.8" and extra == "test"
-Requires-Dist: mypy; extra == "test"
+Requires-Dist: mypy==1.18.2; python_version >= "3.9" and extra == "test"
 Requires-Dist: pre-commit; extra == "test"
 Requires-Dist: pytest>=7.3.1; extra == "test"
 Requires-Dist: pytest-cov; extra == "test"

gitpython-3.1.46/VERSION

@@ -0,0 +1 @@
+3.1.46

{gitpython-3.1.45 → gitpython-3.1.46}/doc/source/changes.rst

@@ -2,6 +2,12 @@
 Changelog
 =========
 
+3.1.46
+======
+
+See the following for all changes.
+https://github.com/gitpython-developers/GitPython/releases/tag/3.1.46
+
 3.1.45
 ======
 
@@ -111,7 +117,7 @@ https://github.com/gitpython-developers/gitpython/milestone/61?closed=1
   but a necessary fix for https://github.com/gitpython-developers/GitPython/issues/1515.
   Please take a look at the PR for more information and how to bypass these protections
   in case they cause breakage: https://github.com/gitpython-developers/GitPython/pull/1521.
-  
+
 
 See the following for all changes.
 https://github.com/gitpython-developers/gitpython/milestone/60?closed=1
@@ -176,38 +182,38 @@ https://github.com/gitpython-developers/gitpython/milestone/53?closed=1
 * General:
 
   - Remove python 3.6 support
-  
+
   - Remove distutils ahead of deprecation in standard library.
-  
+
   - Update sphinx to 4.1.12 and use autodoc-typehints.
-  
+
   - Include README as long_description on PyPI
-  
+
   - Test against earliest and latest minor version available on Github Actions (e.g. 3.9.0 and 3.9.7)
-  
+
 
 * Typing:
 
   - Add types to ALL functions.
-  
+
   - Ensure py.typed is collected.
-  
+
   - Increase mypy strictness with disallow_untyped_defs, warn_redundant_casts, warn_unreachable.
-  
+
   - Use typing.NamedTuple and typing.OrderedDict now 3.6 dropped.
-  
+
   - Make Protocol classes ABCs at runtime due to new behaviour/bug in 3.9.7 & 3.10.0-rc1
-  
+
   - Remove use of typing.TypeGuard until later release, to allow dependent libs time to update.
-  
+
   - Tracking issue: https://github.com/gitpython-developers/GitPython/issues/1095
 
 * Runtime improvements:
 
   - Add clone_multi_options support to submodule.add()
-  
+
   - Delay calling get_user_id() unless essential, to support sand-boxed environments.
-  
+
   - Add timeout to handle_process_output(), in case thread.join() hangs.
 
 See the following for details:

{gitpython-3.1.45 → gitpython-3.1.46}/git/__init__.py

@@ -86,7 +86,7 @@ __all__ = [
     "to_hex_sha",
 ]
 
-__version__ = '3.1.45'
+__version__ = '3.1.46'
 
 from typing import Any, List, Optional, Sequence, TYPE_CHECKING, Tuple, Union
 

{gitpython-3.1.45 → gitpython-3.1.46}/git/config.py

@@ -66,7 +66,7 @@ _logger = logging.getLogger(__name__)
 CONFIG_LEVELS: ConfigLevels_Tup = ("system", "user", "global", "repository")
 """The configuration level of a configuration file."""
 
-CONDITIONAL_INCLUDE_REGEXP = re.compile(r"(?<=includeIf )\"(gitdir|gitdir/i|onbranch):(.+)\"")
+CONDITIONAL_INCLUDE_REGEXP = re.compile(r"(?<=includeIf )\"(gitdir|gitdir/i|onbranch|hasconfig:remote\.\*\.url):(.+)\"")
 """Section pattern to detect conditional includes.
 
 See: https://git-scm.com/docs/git-config#_conditional_includes
@@ -574,11 +574,11 @@ class GitConfigParser(cp.RawConfigParser, metaclass=MetaParserBuilder):
                 if keyword.endswith("/i"):
                     value = re.sub(
                         r"[a-zA-Z]",
-                        lambda m: "[{}{}]".format(m.group().lower(), m.group().upper()),
+                        lambda m: f"[{m.group().lower()!r}{m.group().upper()!r}]",
                         value,
                     )
                 if self._repo.git_dir:
-                    if fnmatch.fnmatchcase(str(self._repo.git_dir), value):
+                    if fnmatch.fnmatchcase(os.fspath(self._repo.git_dir), value):
                         paths += self.items(section)
 
             elif keyword == "onbranch":
@@ -590,7 +590,11 @@ class GitConfigParser(cp.RawConfigParser, metaclass=MetaParserBuilder):
 
                 if fnmatch.fnmatchcase(branch_name, value):
                     paths += self.items(section)
-
+            elif keyword == "hasconfig:remote.*.url":
+                for remote in self._repo.remotes:
+                    if fnmatch.fnmatchcase(remote.url, value):
+                        paths += self.items(section)
+                        break
         return paths
 
     def read(self) -> None:  # type: ignore[override]
@@ -629,8 +633,6 @@ class GitConfigParser(cp.RawConfigParser, metaclass=MetaParserBuilder):
                 file_path = cast(IO[bytes], file_path)
                 self._read(file_path, file_path.name)
             else:
-                # Assume a path if it is not a file-object.
-                file_path = cast(PathLike, file_path)
                 try:
                     with open(file_path, "rb") as fp:
                         file_ok = True
@@ -764,7 +766,7 @@ class GitConfigParser(cp.RawConfigParser, metaclass=MetaParserBuilder):
         if self.read_only:
             raise IOError("Cannot execute non-constant method %s.%s" % (self, method_name))
 
-    def add_section(self, section: str) -> None:
+    def add_section(self, section: "cp._SectionName") -> None:
         """Assures added options will stay in order."""
         return super().add_section(section)
 

{gitpython-3.1.45 → gitpython-3.1.46}/git/diff.py

@@ -23,13 +23,14 @@ from typing import (
     List,
     Match,
     Optional,
+    Sequence,
     Tuple,
     TYPE_CHECKING,
     TypeVar,
     Union,
     cast,
 )
-from git.types import Literal, PathLike
+from git.types import PathLike, Literal
 
 if TYPE_CHECKING:
     from subprocess import Popen
@@ -289,7 +290,7 @@ class DiffIndex(List[T_Diff]):
     The class improves the diff handling convenience.
     """
 
-    change_type = ("A", "C", "D", "R", "M", "T")
+    change_type: Sequence[Literal["A", "C", "D", "R", "M", "T"]] = ("A", "C", "D", "R", "M", "T")  # noqa: F821
     """Change type invariant identifying possible ways a blob can have changed:
 
     * ``A`` = Added

{gitpython-3.1.45 → gitpython-3.1.46}/git/index/base.py

@@ -407,7 +407,7 @@ class IndexFile(LazyMixin, git_diff.Diffable, Serializable):
         r = str(self.repo.working_tree_dir)
         rs = r + os.sep
         for path in paths:
-            abs_path = str(path)
+            abs_path = os.fspath(path)
             if not osp.isabs(abs_path):
                 abs_path = osp.join(r, path)
             # END make absolute path
@@ -656,10 +656,10 @@ class IndexFile(LazyMixin, git_diff.Diffable, Serializable):
             return path
         if self.repo.bare:
             raise InvalidGitRepositoryError("require non-bare repository")
-        if not osp.normpath(str(path)).startswith(str(self.repo.working_tree_dir)):
+        if not osp.normpath(path).startswith(str(self.repo.working_tree_dir)):
             raise ValueError("Absolute path %r is not in git repository at %r" % (path, self.repo.working_tree_dir))
         result = os.path.relpath(path, self.repo.working_tree_dir)
-        if str(path).endswith(os.sep) and not result.endswith(os.sep):
+        if os.fspath(path).endswith(os.sep) and not result.endswith(os.sep):
             result += os.sep
         return result
 
@@ -1036,7 +1036,7 @@ class IndexFile(LazyMixin, git_diff.Diffable, Serializable):
         args.append("--")
 
         # Preprocess paths.
-        paths = self._items_to_rela_paths(items)
+        paths = list(map(os.fspath, self._items_to_rela_paths(items)))  # type: ignore[arg-type]
         removed_paths = self.repo.git.rm(args, paths, **kwargs).splitlines()
 
         # Process output to gain proper paths.
@@ -1359,11 +1359,11 @@ class IndexFile(LazyMixin, git_diff.Diffable, Serializable):
                 try:
                     self.entries[(co_path, 0)]
                 except KeyError:
-                    folder = str(co_path)
+                    folder = co_path
                     if not folder.endswith("/"):
                         folder += "/"
                     for entry in self.entries.values():
-                        if str(entry.path).startswith(folder):
+                        if os.fspath(entry.path).startswith(folder):
                             p = entry.path
                             self._write_path_to_stdin(proc, p, p, make_exc, fprogress, read_from_stdout=False)
                             checked_out_files.append(p)

{gitpython-3.1.45 → gitpython-3.1.46}/git/index/fun.py

@@ -36,7 +36,7 @@ from git.objects.fun import (
 )
 from git.util import IndexFileSHA1Writer, finalize_process
 
-from .typ import BaseIndexEntry, IndexEntry, CE_NAMEMASK, CE_STAGESHIFT
+from .typ import CE_EXTENDED, BaseIndexEntry, IndexEntry, CE_NAMEMASK, CE_STAGESHIFT
 from .util import pack, unpack
 
 # typing -----------------------------------------------------------------------------
@@ -87,7 +87,7 @@ def run_commit_hook(name: str, index: "IndexFile", *args: str) -> None:
         return
 
     env = os.environ.copy()
-    env["GIT_INDEX_FILE"] = safe_decode(str(index.path))
+    env["GIT_INDEX_FILE"] = safe_decode(os.fspath(index.path))
     env["GIT_EDITOR"] = ":"
     cmd = [hp]
     try:
@@ -158,7 +158,7 @@ def write_cache(
     write = stream_sha.write
 
     # Header
-    version = 2
+    version = 3 if any(entry.extended_flags for entry in entries) else 2
     write(b"DIRC")
     write(pack(">LL", version, len(entries)))
 
@@ -172,6 +172,8 @@ def write_cache(
         plen = len(path) & CE_NAMEMASK  # Path length
         assert plen == len(path), "Path %s too long to fit into index" % entry.path
         flags = plen | (entry.flags & CE_NAMEMASK_INV)  # Clear possible previous values.
+        if entry.extended_flags:
+            flags |= CE_EXTENDED
         write(
             pack(
                 ">LLLLLL20sH",
@@ -185,6 +187,8 @@ def write_cache(
                 flags,
             )
         )
+        if entry.extended_flags:
+            write(pack(">H", entry.extended_flags))
         write(path)
         real_size = (tell() - beginoffset + 8) & ~7
         write(b"\0" * ((beginoffset + real_size) - tell()))
@@ -206,8 +210,7 @@ def read_header(stream: IO[bytes]) -> Tuple[int, int]:
     unpacked = cast(Tuple[int, int], unpack(">LL", stream.read(4 * 2)))
     version, num_entries = unpacked
 
-    # TODO: Handle version 3: extended data, see read-cache.c.
-    assert version in (1, 2), "Unsupported git index version %i, only 1 and 2 are supported" % version
+    assert version in (1, 2, 3), "Unsupported git index version %i, only 1, 2, and 3 are supported" % version
     return version, num_entries
 
 
@@ -260,12 +263,15 @@ def read_cache(
         ctime = unpack(">8s", read(8))[0]
         mtime = unpack(">8s", read(8))[0]
         (dev, ino, mode, uid, gid, size, sha, flags) = unpack(">LLLLLL20sH", read(20 + 4 * 6 + 2))
+        extended_flags = 0
+        if flags & CE_EXTENDED:
+            extended_flags = unpack(">H", read(2))[0]
         path_size = flags & CE_NAMEMASK
         path = read(path_size).decode(defenc)
 
         real_size = (tell() - beginoffset + 8) & ~7
         read((beginoffset + real_size) - tell())
-        entry = IndexEntry((mode, sha, flags, path, ctime, mtime, dev, ino, uid, gid, size))
+        entry = IndexEntry((mode, sha, flags, path, ctime, mtime, dev, ino, uid, gid, size, extended_flags))
         # entry_key would be the method to use, but we save the effort.
         entries[(path, entry.stage)] = entry
         count += 1

{gitpython-3.1.45 → gitpython-3.1.46}/git/index/typ.py

@@ -32,6 +32,9 @@ CE_EXTENDED = 0x4000
 CE_VALID = 0x8000
 CE_STAGESHIFT = 12
 
+CE_EXT_SKIP_WORKTREE = 0x4000
+CE_EXT_INTENT_TO_ADD = 0x2000
+
 # } END invariants
 
 
@@ -87,6 +90,8 @@ class BaseIndexEntryHelper(NamedTuple):
     uid: int = 0
     gid: int = 0
     size: int = 0
+    # version 3 extended flags, only when (flags & CE_EXTENDED) is set
+    extended_flags: int = 0
 
 
 class BaseIndexEntry(BaseIndexEntryHelper):
@@ -102,7 +107,7 @@ class BaseIndexEntry(BaseIndexEntryHelper):
         cls,
         inp_tuple: Union[
             Tuple[int, bytes, int, PathLike],
-            Tuple[int, bytes, int, PathLike, bytes, bytes, int, int, int, int, int],
+            Tuple[int, bytes, int, PathLike, bytes, bytes, int, int, int, int, int, int],
         ],
     ) -> "BaseIndexEntry":
         """Override ``__new__`` to allow construction from a tuple for backwards
@@ -134,6 +139,14 @@ class BaseIndexEntry(BaseIndexEntryHelper):
         """
         return (self.flags & CE_STAGEMASK) >> CE_STAGESHIFT
 
+    @property
+    def skip_worktree(self) -> bool:
+        return (self.extended_flags & CE_EXT_SKIP_WORKTREE) > 0
+
+    @property
+    def intent_to_add(self) -> bool:
+        return (self.extended_flags & CE_EXT_INTENT_TO_ADD) > 0
+
     @classmethod
     def from_blob(cls, blob: Blob, stage: int = 0) -> "BaseIndexEntry":
         """:return: Fully equipped BaseIndexEntry at the given stage"""
@@ -179,7 +192,7 @@ class IndexEntry(BaseIndexEntry):
             Instance of type :class:`BaseIndexEntry`.
         """
         time = pack(">LL", 0, 0)
-        return IndexEntry((base.mode, base.binsha, base.flags, base.path, time, time, 0, 0, 0, 0, 0))
+        return IndexEntry((base.mode, base.binsha, base.flags, base.path, time, time, 0, 0, 0, 0, 0))  # type: ignore[arg-type]
 
     @classmethod
     def from_blob(cls, blob: Blob, stage: int = 0) -> "IndexEntry":
@@ -198,5 +211,5 @@ class IndexEntry(BaseIndexEntry):
                 0,
                 0,
                 blob.size,
-            )
+            )  # type: ignore[arg-type]
         )

{gitpython-3.1.45 → gitpython-3.1.46}/git/index/util.py

@@ -15,7 +15,7 @@ from types import TracebackType
 
 # typing ----------------------------------------------------------------------
 
-from typing import Any, Callable, TYPE_CHECKING, Optional, Type
+from typing import Any, Callable, TYPE_CHECKING, Optional, Type, cast
 
 from git.types import Literal, PathLike, _T
 
@@ -106,7 +106,7 @@ def git_working_dir(func: Callable[..., _T]) -> Callable[..., _T]:
     @wraps(func)
     def set_git_working_dir(self: "IndexFile", *args: Any, **kwargs: Any) -> _T:
         cur_wd = os.getcwd()
-        os.chdir(str(self.repo.working_tree_dir))
+        os.chdir(cast(PathLike, self.repo.working_tree_dir))
         try:
             return func(self, *args, **kwargs)
         finally:

{gitpython-3.1.45 → gitpython-3.1.46}/git/objects/blob.py

@@ -6,6 +6,7 @@
 __all__ = ["Blob"]
 
 from mimetypes import guess_type
+import os
 import sys
 
 if sys.version_info >= (3, 8):
@@ -44,5 +45,5 @@ class Blob(base.IndexObject):
         """
         guesses = None
         if self.path:
-            guesses = guess_type(str(self.path))
+            guesses = guess_type(os.fspath(self.path))
         return guesses and guesses[0] or self.DEFAULT_MIME_TYPE

{gitpython-3.1.45 → gitpython-3.1.46}/git/objects/commit.py

@@ -900,7 +900,7 @@ class Commit(base.Object, TraversableIterableObj, Diffable, Serializable):
         if self.message:
             results = re.findall(
                 r"^Co-authored-by: (.*) <(.*?)>$",
-                self.message,
+                str(self.message),
                 re.MULTILINE,
             )
             for author in results:

{gitpython-3.1.45 → gitpython-3.1.46}/git/objects/submodule/base.py

@@ -66,7 +66,7 @@ from git.types import Commit_ish, PathLike, TBD
 if TYPE_CHECKING:
     from git.index import IndexFile
     from git.objects.commit import Commit
-    from git.refs import Head
+    from git.refs import Head, RemoteReference
     from git.repo import Repo
 
 # -----------------------------------------------------------------------------
@@ -352,10 +352,10 @@ class Submodule(IndexObject, TraversableIterableObj):
             module_abspath_dir = osp.dirname(module_abspath)
             if not osp.isdir(module_abspath_dir):
                 os.makedirs(module_abspath_dir)
-            module_checkout_path = osp.join(str(repo.working_tree_dir), path)
+            module_checkout_path = osp.join(repo.working_tree_dir, path)  # type: ignore[arg-type]
 
         if url.startswith("../"):
-            remote_name = repo.active_branch.tracking_branch().remote_name
+            remote_name = cast("RemoteReference", repo.active_branch.tracking_branch()).remote_name
             repo_remote_url = repo.remote(remote_name).url
             url = os.path.join(repo_remote_url, url)
 
@@ -541,7 +541,7 @@ class Submodule(IndexObject, TraversableIterableObj):
         if sm.exists():
             # Reretrieve submodule from tree.
             try:
-                sm = repo.head.commit.tree[str(path)]
+                sm = repo.head.commit.tree[os.fspath(path)]
                 sm._name = name
                 return sm
             except KeyError:

{gitpython-3.1.45 → gitpython-3.1.46}/git/objects/tree.py

@@ -5,6 +5,7 @@
 
 __all__ = ["TreeModifier", "Tree"]
 
+import os
 import sys
 
 import git.diff as git_diff
@@ -230,7 +231,7 @@ class Tree(IndexObject, git_diff.Diffable, util.Traversable, util.Serializable):
                 raise TypeError("Unknown mode %o found in tree data for path '%s'" % (mode, path)) from e
         # END for each item
 
-    def join(self, file: str) -> IndexObjUnion:
+    def join(self, file: PathLike) -> IndexObjUnion:
         """Find the named object in this tree's contents.
 
         :return:
@@ -241,6 +242,7 @@ class Tree(IndexObject, git_diff.Diffable, util.Traversable, util.Serializable):
             If the given file or tree does not exist in this tree.
         """
         msg = "Blob or Tree named %r not found"
+        file = os.fspath(file)
         if "/" in file:
             tree = self
             item = self
@@ -269,7 +271,7 @@ class Tree(IndexObject, git_diff.Diffable, util.Traversable, util.Serializable):
             raise KeyError(msg % file)
         # END handle long paths
 
-    def __truediv__(self, file: str) -> IndexObjUnion:
+    def __truediv__(self, file: PathLike) -> IndexObjUnion:
         """The ``/`` operator is another syntax for joining.
 
         See :meth:`join` for details.

{gitpython-3.1.45 → gitpython-3.1.46}/git/refs/head.py

@@ -22,7 +22,6 @@ from typing import Any, Sequence, TYPE_CHECKING, Union
 from git.types import Commit_ish, PathLike
 
 if TYPE_CHECKING:
-    from git.objects import Commit
     from git.refs import RemoteReference
     from git.repo import Repo
 
@@ -44,9 +43,6 @@ class HEAD(SymbolicReference):
 
     __slots__ = ()
 
-    # TODO: This can be removed once SymbolicReference.commit has static type hints.
-    commit: "Commit"
-
     def __init__(self, repo: "Repo", path: PathLike = _HEAD_NAME) -> None:
         if path != self._HEAD_NAME:
             raise ValueError("HEAD instance must point to %r, got %r" % (self._HEAD_NAME, path))
@@ -149,7 +145,7 @@ class Head(Reference):
     k_config_remote_ref = "merge"  # Branch to merge from remote.
 
     @classmethod
-    def delete(cls, repo: "Repo", *heads: "Union[Head, str]", force: bool = False, **kwargs: Any) -> None:
+    def delete(cls, repo: "Repo", *heads: "Union[Head, str]", force: bool = False, **kwargs: Any) -> None:  # type: ignore[override]
         """Delete the given heads.
 
         :param force:

{gitpython-3.1.45 → gitpython-3.1.46}/git/refs/log.py

@@ -145,7 +145,7 @@ class RefLogEntry(Tuple[str, str, Actor, Tuple[int, int], str]):
         actor = Actor._from_string(info[82 : email_end + 1])
         time, tz_offset = parse_date(info[email_end + 2 :])  # skipcq: PYL-W0621
 
-        return RefLogEntry((oldhexsha, newhexsha, actor, (time, tz_offset), msg))
+        return RefLogEntry((oldhexsha, newhexsha, actor, (time, tz_offset), msg))  # type: ignore [arg-type]
 
 
 class RefLog(List[RefLogEntry], Serializable):

{gitpython-3.1.45 → gitpython-3.1.46}/git/refs/reference.py

@@ -3,6 +3,7 @@
 
 __all__ = ["Reference"]
 
+import os
 from git.util import IterableObj, LazyMixin
 
 from .symbolic import SymbolicReference, T_References
@@ -65,7 +66,7 @@ class Reference(SymbolicReference, LazyMixin, IterableObj):
             If ``False``, you can provide any path.
             Otherwise the path must start with the default path prefix of this type.
         """
-        if check_path and not str(path).startswith(self._common_path_default + "/"):
+        if check_path and not os.fspath(path).startswith(self._common_path_default + "/"):
             raise ValueError(f"Cannot instantiate {self.__class__.__name__!r} from path {path}")
         self.path: str  # SymbolicReference converts to string at the moment.
         super().__init__(repo, path)

{gitpython-3.1.45 → gitpython-3.1.46}/git/refs/symbolic.py

@@ -4,6 +4,7 @@
 __all__ = ["SymbolicReference"]
 
 import os
+from pathlib import Path
 
 from gitdb.exc import BadName, BadObject
 
@@ -40,6 +41,7 @@ if TYPE_CHECKING:
     from git.config import GitConfigParser
     from git.objects.commit import Actor
     from git.refs.log import RefLogEntry
+    from git.refs.reference import Reference
     from git.repo import Repo
 
 
@@ -75,10 +77,10 @@ class SymbolicReference:
 
     def __init__(self, repo: "Repo", path: PathLike, check_path: bool = False) -> None:
         self.repo = repo
-        self.path = path
+        self.path: PathLike = path
 
     def __str__(self) -> str:
-        return str(self.path)
+        return os.fspath(self.path)
 
     def __repr__(self) -> str:
         return '<git.%s "%s">' % (self.__class__.__name__, self.path)
@@ -102,7 +104,7 @@ class SymbolicReference:
             In case of symbolic references, the shortest assumable name is the path
             itself.
         """
-        return str(self.path)
+        return os.fspath(self.path)
 
     @property
     def abspath(self) -> PathLike:
@@ -177,7 +179,7 @@ class SymbolicReference:
         """
         previous: Union[str, None] = None
         one_before_previous: Union[str, None] = None
-        for c in str(ref_path):
+        for c in os.fspath(ref_path):
             if c in " ~^:?*[\\":
                 raise ValueError(
                     f"Invalid reference '{ref_path}': references cannot contain spaces, tildes (~), carets (^),"
@@ -211,7 +213,7 @@ class SymbolicReference:
             raise ValueError(f"Invalid reference '{ref_path}': references cannot end with a forward slash (/)")
         elif previous == "@" and one_before_previous is None:
             raise ValueError(f"Invalid reference '{ref_path}': references cannot be '@'")
-        elif any(component.endswith(".lock") for component in str(ref_path).split("/")):
+        elif any(component.endswith(".lock") for component in Path(ref_path).parts):
             raise ValueError(
                 f"Invalid reference '{ref_path}': references cannot have slash-separated components that end with"
                 " '.lock'"
@@ -234,7 +236,7 @@ class SymbolicReference:
         tokens: Union[None, List[str], Tuple[str, str]] = None
         repodir = _git_dir(repo, ref_path)
         try:
-            with open(os.path.join(repodir, str(ref_path)), "rt", encoding="UTF-8") as fp:
+            with open(os.path.join(repodir, ref_path), "rt", encoding="UTF-8") as fp:  # type: ignore[arg-type]
                 value = fp.read().rstrip()
             # Don't only split on spaces, but on whitespace, which allows to parse lines like:
             # 60b64ef992065e2600bfef6187a97f92398a9144                branch 'master' of git-server:/path/to/repo
@@ -404,7 +406,7 @@ class SymbolicReference:
     def object(self, object: Union[AnyGitObject, "SymbolicReference", str]) -> "SymbolicReference":
         return self.set_object(object)
 
-    def _get_reference(self) -> "SymbolicReference":
+    def _get_reference(self) -> "Reference":
         """
         :return:
             :class:`~git.refs.reference.Reference` object we point to
@@ -416,7 +418,7 @@ class SymbolicReference:
         sha, target_ref_path = self._get_ref_info(self.repo, self.path)
         if target_ref_path is None:
             raise TypeError("%s is a detached symbolic reference as it points to %r" % (self, sha))
-        return self.from_path(self.repo, target_ref_path)
+        return cast("Reference", self.from_path(self.repo, target_ref_path))
 
     def set_reference(
         self,
@@ -502,7 +504,7 @@ class SymbolicReference:
 
     # Aliased reference
     @property
-    def reference(self) -> "SymbolicReference":
+    def reference(self) -> "Reference":
         return self._get_reference()
 
     @reference.setter
@@ -613,7 +615,7 @@ class SymbolicReference:
         full_ref_path = path
         if not cls._common_path_default:
             return full_ref_path
-        if not str(path).startswith(cls._common_path_default + "/"):
+        if not os.fspath(path).startswith(cls._common_path_default + "/"):
             full_ref_path = "%s/%s" % (cls._common_path_default, path)
         return full_ref_path
 
@@ -705,7 +707,7 @@ class SymbolicReference:
         if not force and os.path.isfile(abs_ref_path):
             target_data = str(target)
             if isinstance(target, SymbolicReference):
-                target_data = str(target.path)
+                target_data = os.fspath(target.path)
             if not resolve:
                 target_data = "ref: " + target_data
             with open(abs_ref_path, "rb") as fd:
@@ -841,7 +843,7 @@ class SymbolicReference:
 
         # Read packed refs.
         for _sha, rela_path in cls._iter_packed_refs(repo):
-            if rela_path.startswith(str(common_path)):
+            if rela_path.startswith(os.fspath(common_path)):
                 rela_paths.add(rela_path)
             # END relative path matches common path
         # END packed refs reading
@@ -915,8 +917,7 @@ class SymbolicReference:
             SymbolicReference,
         ):
             try:
-                instance: T_References
-                instance = ref_type(repo, path)
+                instance = cast(T_References, ref_type(repo, path))
                 if instance.__class__ is SymbolicReference and instance.is_detached:
                     raise ValueError("SymbolicRef was detached, we drop it")
                 else:
@@ -930,4 +931,4 @@ class SymbolicReference:
 
     def is_remote(self) -> bool:
         """:return: True if this symbolic reference points to a remote branch"""
-        return str(self.path).startswith(self._remote_common_path_default + "/")
+        return os.fspath(self.path).startswith(self._remote_common_path_default + "/")

{gitpython-3.1.45 → gitpython-3.1.46}/git/refs/tag.py

@@ -45,8 +45,8 @@ class TagReference(Reference):
     _common_default = "tags"
     _common_path_default = Reference._common_path_default + "/" + _common_default
 
-    @property
-    def commit(self) -> "Commit":  # type: ignore[override]  # LazyMixin has unrelated commit method
+    @property  # type: ignore[misc]
+    def commit(self) -> "Commit":  # LazyMixin has unrelated commit method
         """:return: Commit object the tag ref points to
 
         :raise ValueError:
@@ -80,8 +80,8 @@ class TagReference(Reference):
         return None
 
     # Make object read-only. It should be reasonably hard to adjust an existing tag.
-    @property
-    def object(self) -> AnyGitObject:  # type: ignore[override]
+    @property  # type: ignore[misc]
+    def object(self) -> AnyGitObject:
         return Reference._get_object(self)
 
     @classmethod

{gitpython-3.1.45 → gitpython-3.1.46}/git/repo/base.py

@@ -126,6 +126,7 @@ class Repo:
     working_dir: PathLike
     """The working directory of the git command."""
 
+    # stored as string for easier processing, but annotated as path for clearer intention
     _working_tree_dir: Optional[PathLike] = None
 
     git_dir: PathLike
@@ -215,15 +216,13 @@ class Repo:
         epath = path or os.getenv("GIT_DIR")
         if not epath:
             epath = os.getcwd()
+        epath = os.fspath(epath)
         if Git.is_cygwin():
             # Given how the tests are written, this seems more likely to catch Cygwin
             # git used from Windows than Windows git used from Cygwin. Therefore
             # changing to Cygwin-style paths is the relevant operation.
-            epath = cygpath(str(epath))
+            epath = cygpath(epath)
 
-        epath = epath or path or os.getcwd()
-        if not isinstance(epath, str):
-            epath = str(epath)
         if expand_vars and re.search(self.re_envvars, epath):
             warnings.warn(
                 "The use of environment variables in paths is deprecated"
@@ -520,7 +519,7 @@ class Repo:
         """
         return RootModule(self).traverse(*args, **kwargs)
 
-    def submodule_update(self, *args: Any, **kwargs: Any) -> Iterator[Submodule]:
+    def submodule_update(self, *args: Any, **kwargs: Any) -> RootModule:
         """Update the submodules, keeping the repository consistent as it will
         take the previous state into consideration.
 
@@ -684,11 +683,7 @@ class Repo:
         git_dir: Optional[PathLike] = None,
     ) -> GitConfigParser:
         if config_level is None:
-            files = [
-                self._get_config_path(cast(Lit_config_levels, f), git_dir)
-                for f in self.config_level
-                if cast(Lit_config_levels, f)
-            ]
+            files = [self._get_config_path(f, git_dir) for f in self.config_level if f]
         else:
             files = [self._get_config_path(config_level, git_dir)]
         return GitConfigParser(files, read_only=True, repo=self)
@@ -961,7 +956,7 @@ class Repo:
         if not submodules:
             default_args.append("--ignore-submodules")
         if path:
-            default_args.extend(["--", str(path)])
+            default_args.extend(["--", os.fspath(path)])
         if index:
             # diff index against HEAD.
             if osp.isfile(self.index.path) and len(self.git.diff("--cached", *default_args)):
@@ -1361,9 +1356,9 @@ class Repo:
     ) -> "Repo":
         odbt = kwargs.pop("odbt", odb_default_type)
 
-        # When pathlib.Path or other class-based path is passed
-        if not isinstance(path, str):
-            path = str(path)
+        # url may be a path and this has no effect if it is a string
+        url = os.fspath(url)
+        path = os.fspath(path)
 
         ## A bug win cygwin's Git, when `--bare` or `--separate-git-dir`
         #  it prepends the cwd or(?) the `url` into the `path, so::
@@ -1380,7 +1375,7 @@ class Repo:
             multi = shlex.split(" ".join(multi_options))
 
         if not allow_unsafe_protocols:
-            Git.check_unsafe_protocols(str(url))
+            Git.check_unsafe_protocols(url)
         if not allow_unsafe_options:
             Git.check_unsafe_options(options=list(kwargs.keys()), unsafe_options=cls.unsafe_git_clone_options)
         if not allow_unsafe_options and multi_options:
@@ -1389,7 +1384,7 @@ class Repo:
         proc = git.clone(
             multi,
             "--",
-            Git.polish_url(str(url)),
+            Git.polish_url(url),
             clone_path,
             with_extended_output=True,
             as_process=True,
@@ -1484,7 +1479,7 @@ class Repo:
             self.common_dir,
             path,
             type(self.odb),
-            progress,
+            progress,  # type: ignore[arg-type]
             multi_options,
             allow_unsafe_protocols=allow_unsafe_protocols,
             allow_unsafe_options=allow_unsafe_options,
@@ -1545,7 +1540,7 @@ class Repo:
             url,
             to_path,
             GitCmdObjectDB,
-            progress,
+            progress,  # type: ignore[arg-type]
             multi_options,
             allow_unsafe_protocols=allow_unsafe_protocols,
             allow_unsafe_options=allow_unsafe_options,

{gitpython-3.1.45 → gitpython-3.1.46}/git/repo/fun.py

@@ -286,7 +286,7 @@ def rev_parse(repo: "Repo", rev: str) -> AnyGitObject:
             # END handle refname
         else:
             if ref is not None:
-                obj = cast("Commit", ref.commit)
+                obj = ref.commit
             # END handle ref
         # END initialize obj on first token
 

{gitpython-3.1.45 → gitpython-3.1.46}/git/types.py

@@ -13,7 +13,6 @@ from typing import (
     Sequence as Sequence,
     Tuple,
     TYPE_CHECKING,
-    Type,
     TypeVar,
     Union,
 )
@@ -130,7 +129,8 @@ See :manpage:`gitglossary(7)` on "object type":
 https://git-scm.com/docs/gitglossary#def_object_type
 """
 
-Lit_commit_ish: Type[Literal["commit", "tag"]]
+if TYPE_CHECKING:
+    Lit_commit_ish = Literal["commit", "tag"]
 """Deprecated. Type of literal strings identifying typically-commitish git object types.
 
 Prior to a bugfix, this type had been defined more broadly. Any usage is in practice

{gitpython-3.1.45 → gitpython-3.1.46}/git/util.py

@@ -36,7 +36,7 @@ import getpass
 import logging
 import os
 import os.path as osp
-import pathlib
+from pathlib import Path
 import platform
 import re
 import shutil
@@ -272,9 +272,9 @@ def stream_copy(source: BinaryIO, destination: BinaryIO, chunk_size: int = 512 *
 def join_path(a: PathLike, *p: PathLike) -> PathLike:
     R"""Join path tokens together similar to osp.join, but always use ``/`` instead of
     possibly ``\`` on Windows."""
-    path = str(a)
+    path = os.fspath(a)
     for b in p:
-        b = str(b)
+        b = os.fspath(b)
         if not b:
             continue
         if b.startswith("/"):
@@ -290,18 +290,18 @@ def join_path(a: PathLike, *p: PathLike) -> PathLike:
 if sys.platform == "win32":
 
     def to_native_path_windows(path: PathLike) -> PathLike:
-        path = str(path)
+        path = os.fspath(path)
         return path.replace("/", "\\")
 
     def to_native_path_linux(path: PathLike) -> str:
-        path = str(path)
+        path = os.fspath(path)
         return path.replace("\\", "/")
 
     to_native_path = to_native_path_windows
 else:
     # No need for any work on Linux.
     def to_native_path_linux(path: PathLike) -> str:
-        return str(path)
+        return os.fspath(path)
 
     to_native_path = to_native_path_linux
 
@@ -372,7 +372,7 @@ def py_where(program: str, path: Optional[PathLike] = None) -> List[str]:
     progs = []
     if not path:
         path = os.environ["PATH"]
-    for folder in str(path).split(os.pathsep):
+    for folder in os.fspath(path).split(os.pathsep):
         folder = folder.strip('"')
         if folder:
             exe_path = osp.join(folder, program)
@@ -397,7 +397,7 @@ def _cygexpath(drive: Optional[str], path: str) -> str:
                 p = cygpath(p)
         elif drive:
             p = "/proc/cygdrive/%s/%s" % (drive.lower(), p)
-    p_str = str(p)  # ensure it is a str and not AnyPath
+    p_str = os.fspath(p)  # ensure it is a str and not AnyPath
     return p_str.replace("\\", "/")
 
 
@@ -418,7 +418,7 @@ _cygpath_parsers: Tuple[Tuple[Pattern[str], Callable, bool], ...] = (
 
 def cygpath(path: str) -> str:
     """Use :meth:`git.cmd.Git.polish_url` instead, that works on any environment."""
-    path = str(path)  # Ensure is str and not AnyPath.
+    path = os.fspath(path)  # Ensure is str and not AnyPath.
     # Fix to use Paths when 3.5 dropped. Or to be just str if only for URLs?
     if not path.startswith(("/cygdrive", "//", "/proc/cygdrive")):
         for regex, parser, recurse in _cygpath_parsers:
@@ -438,7 +438,7 @@ _decygpath_regex = re.compile(r"(?:/proc)?/cygdrive/(\w)(/.*)?")
 
 
 def decygpath(path: PathLike) -> str:
-    path = str(path)
+    path = os.fspath(path)
     m = _decygpath_regex.match(path)
     if m:
         drive, rest_path = m.groups()
@@ -465,7 +465,7 @@ def _is_cygwin_git(git_executable: str) -> bool:
             # Just a name given, not a real path.
             uname_cmd = osp.join(git_dir, "uname")
 
-            if not (pathlib.Path(uname_cmd).is_file() and os.access(uname_cmd, os.X_OK)):
+            if not (Path(uname_cmd).is_file() and os.access(uname_cmd, os.X_OK)):
                 _logger.debug(f"Failed checking if running in CYGWIN: {uname_cmd} is not an executable")
                 _is_cygwin_cache[git_executable] = is_cygwin
                 return is_cygwin
@@ -523,7 +523,7 @@ def expand_path(p: PathLike, expand_vars: bool = ...) -> str:
 
 
 def expand_path(p: Union[None, PathLike], expand_vars: bool = True) -> Optional[PathLike]:
-    if isinstance(p, pathlib.Path):
+    if isinstance(p, Path):
         return p.resolve()
     try:
         p = osp.expanduser(p)  # type: ignore[arg-type]
@@ -1143,7 +1143,7 @@ class BlockingLockFile(LockFile):
         # END endless loop
 
 
-class IterableList(List[T_IterableObj]):
+class IterableList(List[T_IterableObj]):  # type: ignore[type-var]
     """List of iterable objects allowing to query an object by id or by named index::
 
      heads = repo.heads
@@ -1214,14 +1214,14 @@ class IterableList(List[T_IterableObj]):
             raise ValueError("Index should be an int or str")
         else:
             try:
-                return getattr(self, index)
+                return getattr(self, cast(str, index))
             except AttributeError as e:
-                raise IndexError("No item found with id %r" % (self._prefix + index)) from e
+                raise IndexError(f"No item found with id {self._prefix}{index}") from e
         # END handle getattr
 
     def __delitem__(self, index: Union[SupportsIndex, int, slice, str]) -> None:
         delindex = cast(int, index)
-        if not isinstance(index, int):
+        if isinstance(index, str):
             delindex = -1
             name = self._prefix + index
             for i, item in enumerate(self):

{gitpython-3.1.45 → gitpython-3.1.46}/pyproject.toml

@@ -19,7 +19,6 @@ testpaths = "test"  # Space separated list of paths from root e.g test tests doc
 # filterwarnings ignore::WarningType  # ignores those warnings
 
 [tool.mypy]
-python_version = "3.8"
 files = ["git/", "test/deprecation/"]
 disallow_untyped_defs = true
 no_implicit_optional = true

{gitpython-3.1.45 → gitpython-3.1.46}/test-requirements.txt

@@ -1,7 +1,7 @@
 coverage[toml]
 ddt >= 1.1.1, != 1.4.3
 mock ; python_version < "3.8"
-mypy
+mypy==1.18.2 ; python_version >= "3.9" # pin mypy version to avoid new errors
 pre-commit
 pytest >= 7.3.1
 pytest-cov

gitpython-3.1.45/VERSION

@@ -1 +0,0 @@
-3.1.45