GitPython 3.1.46__tar.gz → 3.1.47__tar.gz

{gitpython-3.1.46 → gitpython-3.1.47}/AUTHORS

@@ -56,5 +56,6 @@ Contributors are:
 -Ethan Lin <et.repositories _at_ gmail.com>
 -Jonas Scharpf <jonas.scharpf _at_ checkmk.com>
 -Gordon Marx
+-Enji Cooper
 
 Portions derived from other open source works and are clearly marked.

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: GitPython
-Version: 3.1.46
+Version: 3.1.47
 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
@@ -41,7 +41,7 @@ Requires-Dist: pytest-mock; extra == "test"
 Requires-Dist: pytest-sugar; extra == "test"
 Requires-Dist: typing-extensions; python_version < "3.11" and extra == "test"
 Provides-Extra: doc
-Requires-Dist: sphinx<7.2,>=7.1.2; extra == "doc"
+Requires-Dist: sphinx<8,>=7.4.7; extra == "doc"
 Requires-Dist: sphinx_rtd_theme; extra == "doc"
 Requires-Dist: sphinx-autodoc-typehints; extra == "doc"
 Dynamic: author
@@ -105,7 +105,7 @@ by setting the `GIT_PYTHON_GIT_EXECUTABLE=<path/to/git>` environment variable.
 - Git (1.7.x or newer)
 - Python >= 3.7
 
-The list of dependencies are listed in `./requirements.txt` and `./test-requirements.txt`.
+The list of dependencies are listed in [`./requirements.txt`](https://github.com/gitpython-developers/GitPython/blob/main/requirements.txt) and [`./test-requirements.txt`](https://github.com/gitpython-developers/GitPython/blob/main/test-requirements.txt).
 The installer takes care of installing them for you.
 
 ### INSTALL
@@ -239,7 +239,7 @@ Style and formatting checks, and running tests on all the different supported Py
 
 #### Configuration files
 
-Specific tools are all configured in the `./pyproject.toml` file:
+Specific tools are all configured in the [`./pyproject.toml`](https://github.com/gitpython-developers/GitPython/blob/main/pyproject.toml) file:
 
 - `pytest` (test runner)
 - `coverage.py` (code coverage)
@@ -248,9 +248,9 @@ Specific tools are all configured in the `./pyproject.toml` file:
 
 Orchestration tools:
 
-- Configuration for `pre-commit` is in the `./.pre-commit-config.yaml` file.
-- Configuration for `tox` is in `./tox.ini`.
-- Configuration for GitHub Actions (CI) is in files inside `./.github/workflows/`.
+- Configuration for `pre-commit` is in the [`./.pre-commit-config.yaml`](https://github.com/gitpython-developers/GitPython/blob/main/.pre-commit-config.yaml) file.
+- Configuration for `tox` is in [`./tox.ini`](https://github.com/gitpython-developers/GitPython/blob/main/tox.ini).
+- Configuration for GitHub Actions (CI) is in files inside [`./.github/workflows/`](https://github.com/gitpython-developers/GitPython/tree/main/.github/workflows).
 
 ### Contributions
 
@@ -271,8 +271,8 @@ Please have a look at the [contributions file][contributing].
 
 ### How to make a new release
 
-1. Update/verify the **version** in the `VERSION` file.
-2. Update/verify that the `doc/source/changes.rst` changelog file was updated. It should include a link to the forthcoming release page: `https://github.com/gitpython-developers/GitPython/releases/tag/<version>`
+1. Update/verify the **version** in the [`VERSION`](https://github.com/gitpython-developers/GitPython/blob/main/VERSION) file.
+2. Update/verify that the [`doc/source/changes.rst`](https://github.com/gitpython-developers/GitPython/blob/main/doc/source/changes.rst) changelog file was updated. It should include a link to the forthcoming release page: `https://github.com/gitpython-developers/GitPython/releases/tag/<version>`
 3. Commit everything.
 4. Run `git tag -s <version>` to tag the version in Git.
 5. _Optionally_ create and activate a [virtual environment](https://packaging.python.org/en/latest/guides/installing-using-pip-and-virtual-environments/#creating-a-virtual-environment). (Then the next step can install `build` and `twine`.)
@@ -299,7 +299,7 @@ Please have a look at the [contributions file][contributing].
 
 [3-Clause BSD License](https://opensource.org/license/bsd-3-clause/), also known as the New BSD License. See the [LICENSE file][license].
 
-One file exclusively used for fuzz testing is subject to [a separate license, detailed here](./fuzzing/README.md#license).
+One file exclusively used for fuzz testing is subject to [a separate license, detailed here](https://github.com/gitpython-developers/GitPython/blob/main/fuzzing/README.md#license).
 This file is not included in the wheel or sdist packages published by the maintainers of GitPython.
 
 [contributing]: https://github.com/gitpython-developers/GitPython/blob/main/CONTRIBUTING.md

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

@@ -4,7 +4,7 @@ gitdb<5,>=4.0.1
 typing-extensions>=3.10.0.2
 
 [doc]
-sphinx<7.2,>=7.1.2
+sphinx<8,>=7.4.7
 sphinx_rtd_theme
 sphinx-autodoc-typehints
 

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: GitPython
-Version: 3.1.46
+Version: 3.1.47
 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
@@ -41,7 +41,7 @@ Requires-Dist: pytest-mock; extra == "test"
 Requires-Dist: pytest-sugar; extra == "test"
 Requires-Dist: typing-extensions; python_version < "3.11" and extra == "test"
 Provides-Extra: doc
-Requires-Dist: sphinx<7.2,>=7.1.2; extra == "doc"
+Requires-Dist: sphinx<8,>=7.4.7; extra == "doc"
 Requires-Dist: sphinx_rtd_theme; extra == "doc"
 Requires-Dist: sphinx-autodoc-typehints; extra == "doc"
 Dynamic: author
@@ -105,7 +105,7 @@ by setting the `GIT_PYTHON_GIT_EXECUTABLE=<path/to/git>` environment variable.
 - Git (1.7.x or newer)
 - Python >= 3.7
 
-The list of dependencies are listed in `./requirements.txt` and `./test-requirements.txt`.
+The list of dependencies are listed in [`./requirements.txt`](https://github.com/gitpython-developers/GitPython/blob/main/requirements.txt) and [`./test-requirements.txt`](https://github.com/gitpython-developers/GitPython/blob/main/test-requirements.txt).
 The installer takes care of installing them for you.
 
 ### INSTALL
@@ -239,7 +239,7 @@ Style and formatting checks, and running tests on all the different supported Py
 
 #### Configuration files
 
-Specific tools are all configured in the `./pyproject.toml` file:
+Specific tools are all configured in the [`./pyproject.toml`](https://github.com/gitpython-developers/GitPython/blob/main/pyproject.toml) file:
 
 - `pytest` (test runner)
 - `coverage.py` (code coverage)
@@ -248,9 +248,9 @@ Specific tools are all configured in the `./pyproject.toml` file:
 
 Orchestration tools:
 
-- Configuration for `pre-commit` is in the `./.pre-commit-config.yaml` file.
-- Configuration for `tox` is in `./tox.ini`.
-- Configuration for GitHub Actions (CI) is in files inside `./.github/workflows/`.
+- Configuration for `pre-commit` is in the [`./.pre-commit-config.yaml`](https://github.com/gitpython-developers/GitPython/blob/main/.pre-commit-config.yaml) file.
+- Configuration for `tox` is in [`./tox.ini`](https://github.com/gitpython-developers/GitPython/blob/main/tox.ini).
+- Configuration for GitHub Actions (CI) is in files inside [`./.github/workflows/`](https://github.com/gitpython-developers/GitPython/tree/main/.github/workflows).
 
 ### Contributions
 
@@ -271,8 +271,8 @@ Please have a look at the [contributions file][contributing].
 
 ### How to make a new release
 
-1. Update/verify the **version** in the `VERSION` file.
-2. Update/verify that the `doc/source/changes.rst` changelog file was updated. It should include a link to the forthcoming release page: `https://github.com/gitpython-developers/GitPython/releases/tag/<version>`
+1. Update/verify the **version** in the [`VERSION`](https://github.com/gitpython-developers/GitPython/blob/main/VERSION) file.
+2. Update/verify that the [`doc/source/changes.rst`](https://github.com/gitpython-developers/GitPython/blob/main/doc/source/changes.rst) changelog file was updated. It should include a link to the forthcoming release page: `https://github.com/gitpython-developers/GitPython/releases/tag/<version>`
 3. Commit everything.
 4. Run `git tag -s <version>` to tag the version in Git.
 5. _Optionally_ create and activate a [virtual environment](https://packaging.python.org/en/latest/guides/installing-using-pip-and-virtual-environments/#creating-a-virtual-environment). (Then the next step can install `build` and `twine`.)
@@ -299,7 +299,7 @@ Please have a look at the [contributions file][contributing].
 
 [3-Clause BSD License](https://opensource.org/license/bsd-3-clause/), also known as the New BSD License. See the [LICENSE file][license].
 
-One file exclusively used for fuzz testing is subject to [a separate license, detailed here](./fuzzing/README.md#license).
+One file exclusively used for fuzz testing is subject to [a separate license, detailed here](https://github.com/gitpython-developers/GitPython/blob/main/fuzzing/README.md#license).
 This file is not included in the wheel or sdist packages published by the maintainers of GitPython.
 
 [contributing]: https://github.com/gitpython-developers/GitPython/blob/main/CONTRIBUTING.md

{gitpython-3.1.46 → gitpython-3.1.47}/README.md

@@ -46,7 +46,7 @@ by setting the `GIT_PYTHON_GIT_EXECUTABLE=<path/to/git>` environment variable.
 - Git (1.7.x or newer)
 - Python >= 3.7
 
-The list of dependencies are listed in `./requirements.txt` and `./test-requirements.txt`.
+The list of dependencies are listed in [`./requirements.txt`](https://github.com/gitpython-developers/GitPython/blob/main/requirements.txt) and [`./test-requirements.txt`](https://github.com/gitpython-developers/GitPython/blob/main/test-requirements.txt).
 The installer takes care of installing them for you.
 
 ### INSTALL
@@ -180,7 +180,7 @@ Style and formatting checks, and running tests on all the different supported Py
 
 #### Configuration files
 
-Specific tools are all configured in the `./pyproject.toml` file:
+Specific tools are all configured in the [`./pyproject.toml`](https://github.com/gitpython-developers/GitPython/blob/main/pyproject.toml) file:
 
 - `pytest` (test runner)
 - `coverage.py` (code coverage)
@@ -189,9 +189,9 @@ Specific tools are all configured in the `./pyproject.toml` file:
 
 Orchestration tools:
 
-- Configuration for `pre-commit` is in the `./.pre-commit-config.yaml` file.
-- Configuration for `tox` is in `./tox.ini`.
-- Configuration for GitHub Actions (CI) is in files inside `./.github/workflows/`.
+- Configuration for `pre-commit` is in the [`./.pre-commit-config.yaml`](https://github.com/gitpython-developers/GitPython/blob/main/.pre-commit-config.yaml) file.
+- Configuration for `tox` is in [`./tox.ini`](https://github.com/gitpython-developers/GitPython/blob/main/tox.ini).
+- Configuration for GitHub Actions (CI) is in files inside [`./.github/workflows/`](https://github.com/gitpython-developers/GitPython/tree/main/.github/workflows).
 
 ### Contributions
 
@@ -212,8 +212,8 @@ Please have a look at the [contributions file][contributing].
 
 ### How to make a new release
 
-1. Update/verify the **version** in the `VERSION` file.
-2. Update/verify that the `doc/source/changes.rst` changelog file was updated. It should include a link to the forthcoming release page: `https://github.com/gitpython-developers/GitPython/releases/tag/<version>`
+1. Update/verify the **version** in the [`VERSION`](https://github.com/gitpython-developers/GitPython/blob/main/VERSION) file.
+2. Update/verify that the [`doc/source/changes.rst`](https://github.com/gitpython-developers/GitPython/blob/main/doc/source/changes.rst) changelog file was updated. It should include a link to the forthcoming release page: `https://github.com/gitpython-developers/GitPython/releases/tag/<version>`
 3. Commit everything.
 4. Run `git tag -s <version>` to tag the version in Git.
 5. _Optionally_ create and activate a [virtual environment](https://packaging.python.org/en/latest/guides/installing-using-pip-and-virtual-environments/#creating-a-virtual-environment). (Then the next step can install `build` and `twine`.)
@@ -240,7 +240,7 @@ Please have a look at the [contributions file][contributing].
 
 [3-Clause BSD License](https://opensource.org/license/bsd-3-clause/), also known as the New BSD License. See the [LICENSE file][license].
 
-One file exclusively used for fuzz testing is subject to [a separate license, detailed here](./fuzzing/README.md#license).
+One file exclusively used for fuzz testing is subject to [a separate license, detailed here](https://github.com/gitpython-developers/GitPython/blob/main/fuzzing/README.md#license).
 This file is not included in the wheel or sdist packages published by the maintainers of GitPython.
 
 [contributing]: https://github.com/gitpython-developers/GitPython/blob/main/CONTRIBUTING.md

gitpython-3.1.47/VERSION

@@ -0,0 +1 @@
+3.1.47

{gitpython-3.1.46 → gitpython-3.1.47}/doc/requirements.txt

@@ -1,3 +1,3 @@
-sphinx >= 7.1.2, < 7.2
+sphinx >= 7.4.7, < 8
 sphinx_rtd_theme
 sphinx-autodoc-typehints

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

@@ -2,6 +2,15 @@
 Changelog
 =========
 
+3.1.47
+======
+
+Address various security issues related to bypassing injection-protection
+of unsafe Git flags.
+
+See the following for all changes.
+https://github.com/gitpython-developers/GitPython/releases/tag/3.1.47
+
 3.1.46
 ======
 

{gitpython-3.1.46 → gitpython-3.1.47}/doc/source/tutorial.rst

@@ -513,6 +513,12 @@ The GitDB is a pure-python implementation of the git object database. It is the
 
     repo = Repo("path/to/repo", odbt=GitDB)
 
+.. warning::
+   ``GitDB`` may fail or become extremely slow when traversing trees in
+   repositories with very large commits (thousands of changed files in a
+   single commit). If you encounter ``RecursionError`` or excessive
+   slowness during tree traversal, switch to ``GitCmdObjectDB`` instead.
+
 
 GitCmdObjectDB
 ==============

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

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

{gitpython-3.1.46 → gitpython-3.1.47}/git/cmd.py

@@ -368,8 +368,12 @@ class _AutoInterrupt:
             status = proc.wait()  # Ensure the process goes away.
 
             self.status = self._status_code_if_terminate or status
-        except OSError as ex:
-            _logger.info("Ignored error after process had died: %r", ex)
+        except (OSError, AttributeError) as ex:
+            # On interpreter shutdown (notably on Windows), parts of the stdlib used by
+            # subprocess can already be torn down (e.g. `subprocess._winapi` becomes None),
+            # which can cause AttributeError during terminate(). In that case, we prefer
+            # to silently ignore to avoid noisy "Exception ignored in: __del__" messages.
+            _logger.info("Ignored error while terminating process: %r", ex)
         # END exception handling
 
     def __del__(self) -> None:
@@ -940,6 +944,21 @@ class Git(metaclass=_GitMeta):
                 f"The `{protocol}::` protocol looks suspicious, use `allow_unsafe_protocols=True` to allow it."
             )
 
+    @classmethod
+    def _canonicalize_option_name(cls, option: str) -> str:
+        """Return the option name used for unsafe-option checks.
+
+        Examples:
+            ``"--upload-pack=/tmp/helper"`` -> ``"upload-pack"``
+            ``"upload_pack"`` -> ``"upload-pack"``
+            ``"--config core.filemode=false"`` -> ``"config"``
+        """
+        option_name = option.lstrip("-").split("=", 1)[0]
+        option_tokens = option_name.split(None, 1)
+        if not option_tokens:
+            return ""
+        return dashify(option_tokens[0])
+
     @classmethod
     def check_unsafe_options(cls, options: List[str], unsafe_options: List[str]) -> None:
         """Check for unsafe options.
@@ -947,15 +966,12 @@ class Git(metaclass=_GitMeta):
         Some options that are passed to ``git <command>`` can be used to execute
         arbitrary commands. These are blocked by default.
         """
-        # Options can be of the form `foo`, `--foo bar`, or `--foo=bar`, so we need to
-        # check if they start with "--foo" or if they are equal to "foo".
-        bare_unsafe_options = [option.lstrip("-") for option in unsafe_options]
+        # Options can be of the form `foo`, `--foo`, `--foo bar`, or `--foo=bar`.
+        canonical_unsafe_options = {cls._canonicalize_option_name(option): option for option in unsafe_options}
         for option in options:
-            for unsafe_option, bare_option in zip(unsafe_options, bare_unsafe_options):
-                if option.startswith(unsafe_option) or option == bare_option:
-                    raise UnsafeOptionError(
-                        f"{unsafe_option} is not allowed, use `allow_unsafe_options=True` to allow it."
-                    )
+            unsafe_option = canonical_unsafe_options.get(cls._canonicalize_option_name(option))
+            if unsafe_option is not None:
+                raise UnsafeOptionError(f"{unsafe_option} is not allowed, use `allow_unsafe_options=True` to allow it.")
 
     AutoInterrupt: TypeAlias = _AutoInterrupt
 
@@ -1360,25 +1376,29 @@ class Git(metaclass=_GitMeta):
             if output_stream is None:
                 stdout_value, stderr_value = communicate()
                 # Strip trailing "\n".
-                if stdout_value.endswith(newline) and strip_newline_in_stdout:  # type: ignore[arg-type]
+                if stdout_value is not None and stdout_value.endswith(newline) and strip_newline_in_stdout:  # type: ignore[arg-type]
                     stdout_value = stdout_value[:-1]
-                if stderr_value.endswith(newline):  # type: ignore[arg-type]
+                if stderr_value is not None and stderr_value.endswith(newline):  # type: ignore[arg-type]
                     stderr_value = stderr_value[:-1]
 
                 status = proc.returncode
             else:
                 max_chunk_size = max_chunk_size if max_chunk_size and max_chunk_size > 0 else io.DEFAULT_BUFFER_SIZE
-                stream_copy(proc.stdout, output_stream, max_chunk_size)
-                stdout_value = proc.stdout.read()
-                stderr_value = proc.stderr.read()
+                if proc.stdout is not None:
+                    stream_copy(proc.stdout, output_stream, max_chunk_size)
+                    stdout_value = proc.stdout.read()
+                if proc.stderr is not None:
+                    stderr_value = proc.stderr.read()
                 # Strip trailing "\n".
-                if stderr_value.endswith(newline):  # type: ignore[arg-type]
+                if stderr_value is not None and stderr_value.endswith(newline):  # type: ignore[arg-type]
                     stderr_value = stderr_value[:-1]
                 status = proc.wait()
             # END stdout handling
         finally:
-            proc.stdout.close()
-            proc.stderr.close()
+            if proc.stdout is not None:
+                proc.stdout.close()
+            if proc.stderr is not None:
+                proc.stderr.close()
 
         if self.GIT_PYTHON_TRACE == "full":
             cmdstr = " ".join(redacted_command)
@@ -1568,7 +1588,7 @@ class Git(metaclass=_GitMeta):
 
         turns into::
 
-            git rev-list max-count 10 --header master
+            git rev-list --max-count=10 --header=master
 
         :return:
             Same as :meth:`execute`. If no args are given, used :meth:`execute`'s

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

@@ -549,11 +549,21 @@ class GitConfigParser(cp.RawConfigParser, metaclass=MetaParserBuilder):
         :return:
             The list of paths, where each path is a tuple of (option, value).
         """
+
+        def _all_items(section: str) -> List[Tuple[str, str]]:
+            """Return all (key, value) pairs for a section, including duplicate keys."""
+            return [
+                (key, value)
+                for key, values in self._sections[section].items_all()
+                if key != "__name__"
+                for value in values
+            ]
+
         paths = []
 
         for section in self.sections():
             if section == "include":
-                paths += self.items(section)
+                paths += _all_items(section)
 
             match = CONDITIONAL_INCLUDE_REGEXP.search(section)
             if match is None or self._repo is None:
@@ -579,7 +589,7 @@ class GitConfigParser(cp.RawConfigParser, metaclass=MetaParserBuilder):
                     )
                 if self._repo.git_dir:
                     if fnmatch.fnmatchcase(os.fspath(self._repo.git_dir), value):
-                        paths += self.items(section)
+                        paths += _all_items(section)
 
             elif keyword == "onbranch":
                 try:
@@ -589,11 +599,11 @@ class GitConfigParser(cp.RawConfigParser, metaclass=MetaParserBuilder):
                     continue
 
                 if fnmatch.fnmatchcase(branch_name, value):
-                    paths += self.items(section)
+                    paths += _all_items(section)
             elif keyword == "hasconfig:remote.*.url":
                 for remote in self._repo.remotes:
                     if fnmatch.fnmatchcase(remote.url, value):
-                        paths += self.items(section)
+                        paths += _all_items(section)
                         break
         return paths
 

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

@@ -1133,6 +1133,7 @@ class IndexFile(LazyMixin, git_diff.Diffable, Serializable):
         author_date: Union[datetime.datetime, str, None] = None,
         commit_date: Union[datetime.datetime, str, None] = None,
         skip_hooks: bool = False,
+        trailers: Union[None, "Dict[str, str]", "List[Tuple[str, str]]"] = None,
     ) -> Commit:
         """Commit the current default index file, creating a
         :class:`~git.objects.commit.Commit` object.
@@ -1169,6 +1170,7 @@ class IndexFile(LazyMixin, git_diff.Diffable, Serializable):
             committer=committer,
             author_date=author_date,
             commit_date=commit_date,
+            trailers=trailers,
         )
         if not skip_hooks:
             run_commit_hook("post-commit", self)

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

@@ -450,14 +450,7 @@ class Commit(base.Object, TraversableIterableObj, Diffable, Serializable):
         :return:
             List containing key-value tuples of whitespace stripped trailer information.
         """
-        cmd = ["git", "interpret-trailers", "--parse"]
-        proc: Git.AutoInterrupt = self.repo.git.execute(  # type: ignore[call-overload]
-            cmd,
-            as_process=True,
-            istream=PIPE,
-        )
-        trailer: str = proc.communicate(str(self.message).encode())[0].decode("utf8")
-        trailer = trailer.strip()
+        trailer = self._interpret_trailers(self.repo, self.message, ["--parse"], encoding=self.encoding).strip()
 
         if not trailer:
             return []
@@ -469,6 +462,27 @@ class Commit(base.Object, TraversableIterableObj, Diffable, Serializable):
 
         return trailer_list
 
+    @classmethod
+    def _interpret_trailers(
+        cls,
+        repo: "Repo",
+        message: Union[str, bytes],
+        trailer_args: Sequence[str],
+        encoding: str = default_encoding,
+    ) -> str:
+        message_bytes = message if isinstance(message, bytes) else message.encode(encoding, errors="strict")
+        cmd = [repo.git.GIT_PYTHON_GIT_EXECUTABLE, "interpret-trailers", *trailer_args]
+        proc: Git.AutoInterrupt = repo.git.execute(  # type: ignore[call-overload]
+            cmd,
+            as_process=True,
+            istream=PIPE,
+        )
+        try:
+            stdout_bytes, _ = proc.communicate(message_bytes)
+            return stdout_bytes.decode(encoding, errors="strict")
+        finally:
+            finalize_process(proc)
+
     @property
     def trailers_dict(self) -> Dict[str, List[str]]:
         """Get the trailers of the message as a dictionary.
@@ -570,6 +584,7 @@ class Commit(base.Object, TraversableIterableObj, Diffable, Serializable):
         committer: Union[None, Actor] = None,
         author_date: Union[None, str, datetime.datetime] = None,
         commit_date: Union[None, str, datetime.datetime] = None,
+        trailers: Union[None, Dict[str, str], List[Tuple[str, str]]] = None,
     ) -> "Commit":
         """Commit the given tree, creating a :class:`Commit` object.
 
@@ -609,6 +624,14 @@ class Commit(base.Object, TraversableIterableObj, Diffable, Serializable):
         :param commit_date:
             The timestamp for the committer field.
 
+        :param trailers:
+            Optional trailer key-value pairs to append to the commit message.
+            Can be a dictionary mapping trailer keys to values, or a list of
+            ``(key, value)`` tuples (useful when the same key appears multiple
+            times, e.g. multiple ``Signed-off-by`` trailers). Trailers are
+            appended using ``git interpret-trailers``.
+            See :manpage:`git-interpret-trailers(1)`.
+
         :return:
             :class:`Commit` object representing the new commit.
 
@@ -678,6 +701,21 @@ class Commit(base.Object, TraversableIterableObj, Diffable, Serializable):
             tree = repo.tree(tree)
         # END tree conversion
 
+        # APPLY TRAILERS
+        if trailers:
+            trailer_args: List[str] = []
+            if isinstance(trailers, dict):
+                for key, val in trailers.items():
+                    trailer_args.append("--trailer")
+                    trailer_args.append(f"{key}: {val}")
+            else:
+                for key, val in trailers:
+                    trailer_args.append("--trailer")
+                    trailer_args.append(f"{key}: {val}")
+
+            message = cls._interpret_trailers(repo, str(message), trailer_args)
+        # END apply trailers
+
         # CREATE NEW COMMIT
         new_commit = cls(
             repo,

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

@@ -1042,11 +1042,19 @@ class Repo:
         :raise TypeError:
             If HEAD is detached.
 
+        :raise ValueError:
+            If HEAD points to the ``.invalid`` ref Git uses to mark refs as
+            incompatible with older clients.
+
         :return:
             :class:`~git.refs.head.Head` to the active branch
         """
-        # reveal_type(self.head.reference)  # => Reference
-        return self.head.reference
+        active_branch = self.head.reference
+        if active_branch.name == ".invalid":
+            raise ValueError(
+                "HEAD points to 'refs/heads/.invalid', which Git uses to mark refs as incompatible with older clients"
+            )
+        return active_branch
 
     def blame_incremental(self, rev: str | HEAD | None, file: str, **kwargs: Any) -> Iterator["BlameEntry"]:
         """Iterator for blame information for the given file at the given revision.
@@ -1378,8 +1386,8 @@ class Repo:
             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:
-            Git.check_unsafe_options(options=multi_options, unsafe_options=cls.unsafe_git_clone_options)
+        if not allow_unsafe_options and multi:
+            Git.check_unsafe_options(options=multi, unsafe_options=cls.unsafe_git_clone_options)
 
         proc = git.clone(
             multi,

gitpython-3.1.46/VERSION

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