Nov 29, 2025 · Nov 28, 2025 · Nov 28, 2025 · Nov 28, 2025 · Nov 28, 2025 · Nov 28, 2025
diff --git a/.github/workflows/pythonpackage.yml b/.github/workflows/pythonpackage.yml
      continue-on-error: true

    - name: Check types with mypy
      if: matrix.python-version != '3.7' && matrix.python-version != '3.8'
      run: |
        mypy --python-version="${PYTHON_VERSION%t}"  # Version only, with no "t" for free-threaded.
      env:
        MYPY_FORCE_COLOR: "1"
        TERM: "xterm-256color"  # For color: https://github.com/python/mypy/issues/13817
        PYTHON_VERSION: ${{ matrix.python-version }}
      # With new versions of mypy new issues might arise. This is a problem if there is
      # nobody able to fix them, so we have to ignore errors until that changes.
      continue-on-error: true

    - name: Test with pytest
      run: |
diff --git a/git/config.py b/git/config.py
                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:
                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
        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)

diff --git a/git/diff.py b/git/diff.py
    List,
    Match,
    Optional,
    Sequence,
    Tuple,
    TYPE_CHECKING,
    TypeVar,
    Union,
    cast,
 )
 from git.types importLiteral, PathLike
 from git.types importPathLike, Literal

 if TYPE_CHECKING:
    from subprocess import Popen
    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
diff --git a/git/index/typ.py b/git/index/typ.py
            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":
                0,
                0,
                blob.size,
            )
            )  # type: ignore[arg-type]
        )
diff --git a/git/objects/commit.py b/git/objects/commit.py
        if self.message:
            results = re.findall(
                r"^Co-authored-by: (.*) <(.*?)>$",
                self.message,
 str(self.message),
                re.MULTILINE,
            )
            for author in results:
diff --git a/git/objects/submodule/base.py b/git/objects/submodule/base.py
 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

 # -----------------------------------------------------------------------------
            module_checkout_path = osp.join(str(repo.working_tree_dir), path)

        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)

diff --git a/git/refs/head.py b/git/refs/head.py
 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


    __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))
    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:
diff --git a/git/refs/log.py b/git/refs/log.py
 actor=Actor._from_string(info[82 :email_end+1])
 time,tz_offset=parse_date(info[email_end+2 :])# skipcq: PYL-W0621

 returnRefLogEntry((oldhexsha,newhexsha,actor, (time,tz_offset),msg))
 returnRefLogEntry((oldhexsha,newhexsha,actor, (time,tz_offset),msg))# type: ignore [arg-type]


 classRefLog(List[RefLogEntry],Serializable):
diff --git a/git/refs/symbolic.py b/git/refs/symbolic.py
 SymbolicReference,
        ):
 try:
 instance:T_References
 instance=ref_type(repo,path)
 instance=cast(T_References,ref_type(repo,path))
 ifinstance.__class__isSymbolicReferenceandinstance.is_detached:
 raiseValueError("SymbolicRef was detached, we drop it")
 else:
diff --git a/git/refs/tag.py b/git/refs/tag.py
    _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:
        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
diff --git a/git/repo/base.py b/git/repo/base.py
        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)
            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,
            url,
            to_path,
            GitCmdObjectDB,
            progress,
            progress,  # type: ignore[arg-type]
            multi_options,
            allow_unsafe_protocols=allow_unsafe_protocols,
            allow_unsafe_options=allow_unsafe_options,
diff --git a/git/repo/fun.py b/git/repo/fun.py
            # 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

diff --git a/git/types.py b/git/types.py
    Sequence as Sequence,
    Tuple,
    TYPE_CHECKING,
    Type,
    TypeVar,
    Union,
 )
 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
diff --git a/git/util.py b/git/util.py
        # 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
            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)
        ifnotisinstance(index,int):
        if isinstance(index,str):
            delindex = -1
            name = self._prefix + index
            for i, item in enumerate(self):
diff --git a/pyproject.toml b/pyproject.toml
 # filterwarnings ignore::WarningType  # ignores those warnings

 [tool.mypy]
 python_version = "3.8"
 files = ["git/", "test/deprecation/"]
 disallow_untyped_defs = true
 no_implicit_optional = true
diff --git a/test-requirements.txt b/test-requirements.txt
 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
diff --git a/test/deprecation/test_types.py b/test/deprecation/test_types.py
    assert 'Literal["commit", "tag"]' in message, "Has new definition."
    assert "GitObjectTypeString" in message, "Has new type name for old definition."

    _: Lit_commit_ish = "commit"  # type: ignore[valid-type]
    _: Lit_commit_ish = "commit"

    # It should be as documented (even though deliberately unusable in static checks).
    assert Lit_commit_ish == Literal["commit", "tag"]
diff --git a/test/lib/helper.py b/test/lib/helper.py
 os.chdir(rw_repo.working_dir)
 try:
 returnfunc(self,rw_repo)
 except:# noqa: E722 B001
 except:# noqa: E722
 _logger.info("Keeping repo after failure: %s",repo_dir)
 repo_dir=None
 raise
 withcwd(rw_repo.working_dir):
 try:
 returnfunc(self,rw_repo,rw_daemon_repo)
 except:# noqa: E722 B001
 except:# noqa: E722
 _logger.info(
 "Keeping repos after failure:\n  rw_repo_dir: %s\n  rw_daemon_repo_dir: %s",
 rw_repo_dir,
diff --git a/test/test_remote.py b/test/test_remote.py
 class TestRemoteProgress(RemoteProgress):
    __slots__ = ("_seen_lines", "_stages_per_op", "_num_progress_messages")

    def __init__(self):
    def __init__(self) -> None:
        super().__init__()
        self._seen_lines = []
        self._stages_per_op = {}
        assert self._num_progress_messages


 TestRemoteProgress.__test__ = False  # type: ignore


 class TestRemote(TestBase):
    def tearDown(self):
        gc.collect()
diff --git a/test/test_submodule.py b/test/test_submodule.py
 print(op,cur_count,max_count,message)


 TestRootProgress.__test__=False
 prog=TestRootProgress()


 csm.repo.index.commit("Have to commit submodule change for algorithm to pick it up")
 assertcsm.url=="bar"

 self.assertRaises(
 self.assertRaises(# noqa: B017
 Exception,
 rsm.update,
 recursive=True,
Original file line number	Diff line number	Diff line change
Expand Up		@@ -95,15 +95,13 @@ jobs:
		continue-on-error: true

		- name: Check types with mypy
		if: matrix.python-version != '3.7' && matrix.python-version != '3.8'
		run: \|
		mypy --python-version="${PYTHON_VERSION%t}" # Version only, with no "t" for free-threaded.
		env:
		MYPY_FORCE_COLOR: "1"
		TERM: "xterm-256color" # For color: https://github.com/python/mypy/issues/13817
		PYTHON_VERSION: ${{ matrix.python-version }}
		# With new versions of mypy new issues might arise. This is a problem if there is
		# nobody able to fix them, so we have to ignore errors until that changes.
		continue-on-error: true

		- name: Test with pytest
		run: \|
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -574,7 +574,7 @@ def _included_paths(self) -> List[Tuple[str, str]]:
		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}]",
George-Ogden marked this conversation as resolved. Show resolvedHide resolved
		value,
		)
		if self._repo.git_dir:
Expand DownExpand Up		@@ -633,8 +633,6 @@ def read(self) -> None: # type: ignore[override]
		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
Expand DownExpand Up		@@ -768,7 +766,7 @@ def _assure_writable(self, method_name: str) -> None:
		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)

Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -23,13 +23,14 @@
		List,
		Match,
		Optional,
		Sequence,
		Tuple,
		TYPE_CHECKING,
		TypeVar,
		Union,
		cast,
		)
		from git.types importLiteral, PathLike
		from git.types importPathLike, Literal

		if TYPE_CHECKING:
		from subprocess import Popen
Expand DownExpand Up		@@ -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
George-Ogden marked this conversation as resolved. Show resolvedHide resolved
		"""Change type invariant identifying possible ways a blob can have changed:

		* ``A`` = Added
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -192,7 +192,7 @@ def from_base(cls, base: "BaseIndexEntry") -> "IndexEntry":
		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":
Expand All		@@ -211,5 +211,5 @@ def from_blob(cls, blob: Blob, stage: int = 0) -> "IndexEntry":
		0,
		0,
		blob.size,
		)
		) # type: ignore[arg-type]
		)
Original file line number	Diff line number	Diff line change
Expand Up		@@ -900,7 +900,7 @@ def co_authors(self) -> List[Actor]:
		if self.message:
		results = re.findall(
		r"^Co-authored-by: (.) <(.?)>$",
		self.message,
		str(self.message),
		re.MULTILINE,
		)
		for author in results:
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -66,7 +66,7 @@
		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
George-Ogden marked this conversation as resolved. Show resolvedHide resolved
		from git.repo import Repo

		# -----------------------------------------------------------------------------
Expand DownExpand Up		@@ -355,7 +355,7 @@ def _clone_repo(
		module_checkout_path = osp.join(str(repo.working_tree_dir), path)

		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)

Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -22,7 +22,6 @@
		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

Expand All		@@ -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))
Expand DownExpand Up		@@ -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:
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -145,7 +145,7 @@ def from_line(cls, line: bytes) -> "RefLogEntry":
		actor=Actor._from_string(info[82 :email_end+1])
		time,tz_offset=parse_date(info[email_end+2 :])# skipcq: PYL-W0621

		returnRefLogEntry((oldhexsha,newhexsha,actor, (time,tz_offset),msg))
		returnRefLogEntry((oldhexsha,newhexsha,actor, (time,tz_offset),msg))# type: ignore [arg-type]


		classRefLog(List[RefLogEntry],Serializable):
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -916,8 +916,7 @@ def from_path(cls: Type[T_References], repo: "Repo", path: PathLike) -> T_Refere
		SymbolicReference,
		):
		try:
		instance:T_References
		instance=ref_type(repo,path)
		instance=cast(T_References,ref_type(repo,path))
		ifinstance.__class__isSymbolicReferenceandinstance.is_detached:
		raiseValueError("SymbolicRef was detached, we drop it")
		else:
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -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:
Expand DownExpand Up		@@ -80,8 +80,8 @@ def tag(self) -> Union["TagObject", None]:
		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
Expand Down