GitPython 3.1.62__tar.gz → 3.2.0__tar.gz

{gitpython-3.1.62 → gitpython-3.2.0/GitPython.egg-info}/PKG-INFO

@@ -1,11 +1,12 @@
 Metadata-Version: 2.4
 Name: GitPython
-Version: 3.1.62
+Version: 3.2.0
 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
-Author-email: byronimo@gmail.com, mtrier@gmail.com
+Author-email: Sebastian Thiel <byronimo@gmail.com>, Michael Trier <mtrier@gmail.com>
 License: BSD-3-Clause
+Project-URL: Source code, https://github.com/gitpython-developers/GitPython
+Project-URL: Documentation, https://gitpython.readthedocs.io/en/stable/
+Keywords: git
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Environment :: Console
 Classifier: Intended Audience :: Developers
@@ -16,7 +17,6 @@ Classifier: Operating System :: MacOS :: MacOS X
 Classifier: Typing :: Typed
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.7
 Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
@@ -25,7 +25,7 @@ Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3.14
 Classifier: Programming Language :: Python :: 3.15
-Requires-Python: >=3.7
+Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE
 License-File: AUTHORS
@@ -35,7 +35,7 @@ Provides-Extra: test
 Requires-Dist: coverage[toml]; extra == "test"
 Requires-Dist: basedpyright==1.39.9; (python_version >= "3.9" and sys_platform != "cygwin") and 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: mock; 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"
@@ -44,22 +44,8 @@ Requires-Dist: pytest-instafail; extra == "test"
 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<8,>=7.4.7; extra == "doc"
-Requires-Dist: sphinx_rtd_theme; extra == "doc"
-Requires-Dist: sphinx-autodoc-typehints; extra == "doc"
-Dynamic: author
-Dynamic: author-email
-Dynamic: classifier
-Dynamic: description
-Dynamic: description-content-type
-Dynamic: home-page
 Dynamic: license
 Dynamic: license-file
-Dynamic: provides-extra
-Dynamic: requires-dist
-Dynamic: requires-python
-Dynamic: summary
 
 ![Python package](https://github.com/gitpython-developers/GitPython/workflows/Python%20package/badge.svg)
 [![Documentation Status](https://readthedocs.org/projects/gitpython/badge/?version=stable)](https://readthedocs.org/projects/gitpython/?badge=stable)
@@ -107,7 +93,7 @@ GitPython needs the `git` executable to be installed on the system and available
 by setting the `GIT_PYTHON_GIT_EXECUTABLE=<path/to/git>` environment variable.
 
 - Git (1.7.x or newer)
-- Python >= 3.7
+- Python >= 3.8
 
 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.

{gitpython-3.1.62 → gitpython-3.2.0}/GitPython.egg-info/SOURCES.txt

@@ -12,12 +12,10 @@ test-requirements.txt
 GitPython.egg-info/PKG-INFO
 GitPython.egg-info/SOURCES.txt
 GitPython.egg-info/dependency_links.txt
-GitPython.egg-info/not-zip-safe
 GitPython.egg-info/requires.txt
 GitPython.egg-info/top_level.txt
 doc/.gitignore
 doc/Makefile
-doc/requirements.txt
 doc/source/changes.rst
 doc/source/conf.py
 doc/source/index.rst

{gitpython-3.1.62 → gitpython-3.2.0}/GitPython.egg-info/requires.txt

@@ -3,14 +3,10 @@ gitdb<5,>=4.0.1
 [:python_version < "3.10"]
 typing-extensions>=3.10.0.2
 
-[doc]
-sphinx<8,>=7.4.7
-sphinx_rtd_theme
-sphinx-autodoc-typehints
-
 [test]
 coverage[toml]
 ddt!=1.4.3,>=1.1.1
+mock
 pre-commit
 pytest>=7.3.1
 pytest-cov
@@ -21,9 +17,6 @@ pytest-sugar
 [test:python_version < "3.11"]
 typing-extensions
 
-[test:python_version < "3.8"]
-mock
-
 [test:python_version >= "3.9"]
 mypy==1.18.2
 

{gitpython-3.1.62/GitPython.egg-info → gitpython-3.2.0}/PKG-INFO

@@ -1,11 +1,12 @@
 Metadata-Version: 2.4
 Name: GitPython
-Version: 3.1.62
+Version: 3.2.0
 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
-Author-email: byronimo@gmail.com, mtrier@gmail.com
+Author-email: Sebastian Thiel <byronimo@gmail.com>, Michael Trier <mtrier@gmail.com>
 License: BSD-3-Clause
+Project-URL: Source code, https://github.com/gitpython-developers/GitPython
+Project-URL: Documentation, https://gitpython.readthedocs.io/en/stable/
+Keywords: git
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Environment :: Console
 Classifier: Intended Audience :: Developers
@@ -16,7 +17,6 @@ Classifier: Operating System :: MacOS :: MacOS X
 Classifier: Typing :: Typed
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.7
 Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
@@ -25,7 +25,7 @@ Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3.14
 Classifier: Programming Language :: Python :: 3.15
-Requires-Python: >=3.7
+Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE
 License-File: AUTHORS
@@ -35,7 +35,7 @@ Provides-Extra: test
 Requires-Dist: coverage[toml]; extra == "test"
 Requires-Dist: basedpyright==1.39.9; (python_version >= "3.9" and sys_platform != "cygwin") and 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: mock; 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"
@@ -44,22 +44,8 @@ Requires-Dist: pytest-instafail; extra == "test"
 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<8,>=7.4.7; extra == "doc"
-Requires-Dist: sphinx_rtd_theme; extra == "doc"
-Requires-Dist: sphinx-autodoc-typehints; extra == "doc"
-Dynamic: author
-Dynamic: author-email
-Dynamic: classifier
-Dynamic: description
-Dynamic: description-content-type
-Dynamic: home-page
 Dynamic: license
 Dynamic: license-file
-Dynamic: provides-extra
-Dynamic: requires-dist
-Dynamic: requires-python
-Dynamic: summary
 
 ![Python package](https://github.com/gitpython-developers/GitPython/workflows/Python%20package/badge.svg)
 [![Documentation Status](https://readthedocs.org/projects/gitpython/badge/?version=stable)](https://readthedocs.org/projects/gitpython/?badge=stable)
@@ -107,7 +93,7 @@ GitPython needs the `git` executable to be installed on the system and available
 by setting the `GIT_PYTHON_GIT_EXECUTABLE=<path/to/git>` environment variable.
 
 - Git (1.7.x or newer)
-- Python >= 3.7
+- Python >= 3.8
 
 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.

{gitpython-3.1.62 → gitpython-3.2.0}/README.md

@@ -44,7 +44,7 @@ GitPython needs the `git` executable to be installed on the system and available
 by setting the `GIT_PYTHON_GIT_EXECUTABLE=<path/to/git>` environment variable.
 
 - Git (1.7.x or newer)
-- Python >= 3.7
+- Python >= 3.8
 
 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.

gitpython-3.2.0/VERSION

@@ -0,0 +1 @@
+3.2.0

{gitpython-3.1.62 → gitpython-3.2.0}/doc/source/changes.rst

@@ -2,6 +2,31 @@
 Changelog
 =========
 
+3.2.0
+=====
+
+Drops support for Python 3.7 (5 years after its EOL).
+
+Security fixes for
+
+* Deprecate the pure-Python ``GitDB`` object database backend due to security and
+  performance issues. Selecting it or a subclass through ``odbt`` now emits a
+  ``DeprecationWarning``. Remove ``odbt=GitDB`` to use ``GitCmdObjectDB``, the
+  existing default, or select ``odbt=GitCmdObjectDB`` explicitly. The ``gitdb``
+  package remains a dependency for shared types and utilities.
+* https://github.com/gitpython-developers/GitPython/security/advisories/GHSA-gq48-pqfc-9p58
+* https://github.com/gitpython-developers/GitPython/security/advisories/GHSA-23mf-xhv8-69c2
+* https://github.com/gitpython-developers/GitPython/security/advisories/GHSA-f9j4-qggq-h239
+* https://github.com/gitpython-developers/GitPython/security/advisories/GHSA-w8jc-g24h-crhw
+* https://github.com/gitpython-developers/GitPython/security/advisories/GHSA-m64x-33q8-m5h7
+* https://github.com/gitpython-developers/GitPython/security/advisories/GHSA-fx3j-rwgx-fr94
+
+If you can, also try and provide feedback on the upcoming v4 branch
+https://github.com/gitpython-developers/GitPython/pull/2177 - patches welcome.
+
+See the following for all changes.
+https://github.com/gitpython-developers/GitPython/releases/tag/3.2.0
+
 3.1.62
 ======
 

{gitpython-3.1.62 → gitpython-3.2.0}/doc/source/intro.rst

@@ -13,7 +13,7 @@ The object database implementation is optimized for handling large quantities of
 Requirements
 ============
 
-* `Python`_ >= 3.7
+* `Python`_ >= 3.8
 * `Git`_ 1.7.0 or newer
     It should also work with older versions, but it may be that some operations
     involving remotes will not work as expected.

{gitpython-3.1.62 → gitpython-3.2.0}/doc/source/tutorial.rst

@@ -78,6 +78,12 @@ Query relevant repository paths ...
 
 :class:`Heads <git.refs.head.Head>` Heads are branches in git-speak. :class:`References <git.refs.reference.Reference>` are pointers to a specific commit or to other references. Heads and :class:`Tags <git.refs.tag.TagReference>` are a kind of references. GitPython allows you to query them rather intuitively.
 
+To obtain the current commit ID, use ``repo.head.commit.hexsha``. This works both
+on a branch and with a detached HEAD, provided HEAD resolves to an existing commit.
+When ``repo.head.is_detached`` is true, HEAD points directly to a commit and there
+is no active branch: reading ``repo.head.reference`` or ``repo.active_branch``
+raises :exc:`TypeError`. The branch examples below assume an attached HEAD.
+
 .. literalinclude:: ../../test/test_docs.py
     :language: python
     :dedent: 8
@@ -152,7 +158,7 @@ Examining References
     :start-after: # [2-test_references_and_objects]
     :end-before: # ![2-test_references_and_objects]
 
-A :class:`symbolic reference <git.refs.symbolic.SymbolicReference>` is a special case of a reference as it points to another reference instead of a commit.
+A :class:`symbolic reference <git.refs.symbolic.SymbolicReference>` can point to another reference. When detached, it points directly to a commit instead. Reading its ``commit`` property resolves the commit in either state. Assigning a commit to ``reference`` detaches it; reading ``reference`` then raises :exc:`TypeError`.
 
 .. literalinclude:: ../../test/test_docs.py
     :language: python
@@ -507,24 +513,29 @@ Object Databases
 
 The type of the database determines certain performance characteristics, such as the quantity of objects that can be read per second, the resource usage when reading large data files, as well as the average memory footprint of your application.
 
-GitDB
-=====
-The GitDB is a pure-python implementation of the git object database. It is the default database to use in GitPython 0.3. It uses less memory when handling huge files, but will be 2 to 5 times slower when extracting large quantities of small objects from densely packed repositories::
+GitCmdObjectDB
+==============
+``GitCmdObjectDB`` is the default and recommended backend. It reads objects and
+resolves abbreviated object IDs through persistent ``git cat-file`` processes::
 
-    repo = Repo("path/to/repo", odbt=GitDB)
+    repo = Repo("path/to/repo")
+    # Equivalent explicit selection:
+    repo = Repo("path/to/repo", odbt=GitCmdObjectDB)
 
+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.
-
+   The pure-Python ``GitDB`` backend is deprecated due to security and performance
+   issues. Its object parsers can exhaust resources or return incorrect object
+   data when processing untrusted repositories. Do not use it for untrusted data.
 
-GitCmdObjectDB
-==============
-The git command database uses persistent git-cat-file instances to read repository information. These operate very fast under all conditions, but will consume additional memory for the process itself. When extracting large files, memory usage will be much higher than ``GitDB``::
+Selecting ``odbt=GitDB`` (including a subclass) emits a ``DeprecationWarning``.
+To migrate, remove ``odbt=GitDB`` or replace it with ``odbt=GitCmdObjectDB`` when
+opening, initializing, or cloning a repository. The deprecated backend remains
+available for compatibility; deprecation does not fix its parsing issues.
 
-    repo = Repo("path/to/repo", odbt=GitCmdObjectDB)
+The ``gitdb`` package remains a dependency because GitPython still uses its shared
+types and utilities.
 
 Git Command Debugging and Customization
 ***************************************

{gitpython-3.1.62 → gitpython-3.2.0}/git/__init__.py

@@ -86,7 +86,7 @@ __all__ = [
     "to_hex_sha",
 ]
 
-__version__ = '3.1.62'
+__version__ = '3.2.0'
 
 from typing import Any, List, Optional, Sequence, TYPE_CHECKING, Tuple, Union
 
@@ -295,6 +295,6 @@ def refresh(path: Optional[PathLike] = None) -> None:
 try:
     refresh()
 except Exception as _exc:
-    raise ImportError("Failed to initialize: {0}".format(_exc)) from _exc
+    raise ImportError(f"Failed to initialize: {_exc}") from _exc
 
 # } END initialize git executable path