GitPython 3.1.34__py3-none-any.whl → 3.1.36__py3-none-any.whl

{GitPython-3.1.34.dist-info → GitPython-3.1.36.dist-info}/AUTHORS

@@ -51,4 +51,5 @@ Contributors are:
 -Luke Twist <itsluketwist@gmail.com>
 -Joseph Hale <me _at_ jhale.dev>
 -Santos Gallegos <stsewd _at_ proton.me>
+-Wenhan Zhu <wzhu.cosmos _at_ gmail.com>
 Portions derived from other open source works and are clearly marked.

{GitPython-3.1.34.dist-info → GitPython-3.1.36.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: GitPython
-Version: 3.1.34
+Version: 3.1.36
 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
@@ -22,12 +22,23 @@ Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
 Requires-Python: >=3.7
 Description-Content-Type: text/markdown
 License-File: LICENSE
 License-File: AUTHORS
 Requires-Dist: gitdb <5,>=4.0.1
 Requires-Dist: typing-extensions >=3.7.4.3 ; python_version < "3.8"
+Provides-Extra: test
+Requires-Dist: black ; extra == 'test'
+Requires-Dist: coverage[toml] ; extra == 'test'
+Requires-Dist: ddt !=1.4.3,>=1.1.1 ; extra == 'test'
+Requires-Dist: mypy ; extra == 'test'
+Requires-Dist: pre-commit ; extra == 'test'
+Requires-Dist: pytest ; extra == 'test'
+Requires-Dist: pytest-cov ; extra == 'test'
+Requires-Dist: pytest-sugar ; extra == 'test'
+Requires-Dist: virtualenv ; extra == 'test'
 
 ![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)
@@ -80,30 +91,51 @@ The installer takes care of installing them for you.
 
 ### INSTALL
 
-If you have downloaded the source code:
+GitPython and its required package dependencies can be installed in any of the following ways, all of which should typically be done in a [virtual environment](https://docs.python.org/3/tutorial/venv.html).
 
-```bash
-python setup.py install
-```
+#### From PyPI
 
-or if you want to obtain a copy from the Pypi repository:
+To obtain and install a copy [from PyPI](https://pypi.org/project/GitPython/), run:
 
 ```bash
 pip install GitPython
 ```
 
-Both commands will install the required package dependencies.
+(A distribution package can also be downloaded for manual installation at [the PyPI page](https://pypi.org/project/GitPython/).)
+
+#### From downloaded source code
+
+If you have downloaded the source code, run this from inside the unpacked `GitPython` directory:
+
+```bash
+pip install .
+```
 
-A distribution package can be obtained for manual installation at: <http://pypi.python.org/pypi/GitPython>.
+#### By cloning the source code repository
 
-If you like to clone from source, you can do it like so:
+To clone the [the GitHub repository](https://github.com/gitpython-developers/GitPython) from source to work on the code, you can do it like so:
 
 ```bash
 git clone https://github.com/gitpython-developers/GitPython
-git submodule update --init --recursive
+cd GitPython
+git fetch --tags
 ./init-tests-after-clone.sh
 ```
 
+If you are cloning [your own fork](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/about-forks), then replace the above `git clone` command with one that gives the URL of your fork. Or use this [`gh`](https://cli.github.com/) command (assuming you have `gh` and your fork is called `GitPython`):
+
+```bash
+gh repo clone GitPython
+```
+
+Having cloned the repo, create and activate your [virtual environment](https://docs.python.org/3/tutorial/venv.html). Then make an [editable install](https://pip.pypa.io/en/stable/topics/local-project-installs/#editable-installs):
+
+```bash
+pip install -e ".[test]"
+```
+
+In the less common case that you do not want to install test dependencies, `pip install -e .` can be used instead.
+
 ### Limitations
 
 #### Leakage of System Resources
@@ -124,28 +156,57 @@ See [Issue #525](https://github.com/gitpython-developers/GitPython/issues/525).
 
 ### RUNNING TESTS
 
-_Important_: Right after cloning this repository, please be sure to have executed
-the `./init-tests-after-clone.sh` script in the repository root. Otherwise
-you will encounter test failures.
+_Important_: Right after cloning this repository, please be sure to have
+executed `git fetch --tags` followed by the `./init-tests-after-clone.sh`
+script in the repository root. Otherwise you will encounter test failures.
 
 On _Windows_, make sure you have `git-daemon` in your PATH. For MINGW-git, the `git-daemon.exe`
 exists in `Git\mingw64\libexec\git-core\`; CYGWIN has no daemon, but should get along fine
 with MINGW's.
 
-Ensure testing libraries are installed.
-In the root directory, run: `pip install -r test-requirements.txt`
+#### Install test dependencies
 
-To lint, run: `pre-commit run --all-files`
+Ensure testing libraries are installed. This is taken care of already if you installed with:
 
-To typecheck, run: `mypy -p git`
+```bash
+pip install -e ".[test]"
+```
 
-To test, run: `pytest`
+Otherwise, you can run:
 
-For automatic code formatting run: `black git`
+```bash
+pip install -r test-requirements.txt
+```
+
+#### Test commands
+
+To test, run:
+
+```bash
+pytest
+```
+
+To lint, run:
+
+```bash
+pre-commit run --all-files
+```
+
+To typecheck, run:
+
+```bash
+mypy -p git
+```
+
+For automatic code formatting, run:
+
+```bash
+black git
+```
 
-Configuration for flake8 is in the ./.flake8 file.
+Configuration for flake8 is in the `./.flake8` file.
 
-Configurations for mypy, pytest and coverage.py are in ./pyproject.toml.
+Configurations for `mypy`, `pytest`, `coverage.py`, and `black` are in `./pyproject.toml`.
 
 The same linting and testing will also be performed against different supported python versions
 upon submitting a pull request (or on each push if you have a fork with a "main" branch and actions enabled).
@@ -169,13 +230,15 @@ Please have a look at the [contributions file][contributing].
 
 ### How to make a new release
 
-- Update/verify the **version** in the `VERSION` file
-- Update/verify that the `doc/source/changes.rst` changelog file was updated
-- Commit everything
-- Run `git tag -s <version>` to tag the version in Git
-- Run `make release`
+- Update/verify the **version** in the `VERSION` file.
+- Update/verify that the `doc/source/changes.rst` changelog file was updated.
+- Commit everything.
+- Run `git tag -s <version>` to tag the version in Git.
+- _Optionally_ create and activate a [virtual environment](https://packaging.python.org/en/latest/guides/installing-using-pip-and-virtual-environments/#creating-a-virtual-environment) using `venv` or `virtualenv`.\
+(When run in a virtual environment, the next step will automatically take care of installing `build` and `twine` in it.)
+- Run `make release`.
 - Close the milestone mentioned in the _changelog_ and create a new one. _Do not reuse milestones by renaming them_.
-- Got to [GitHub Releases](https://github.com/gitpython-developers/GitPython/releases) and publish a new one with the recently pushed tag. Generate the changelog.
+- Go to [GitHub Releases](https://github.com/gitpython-developers/GitPython/releases) and publish a new one with the recently pushed tag. Generate the changelog.
 
 ### How to verify a release (DEPRECATED)
 

{GitPython-3.1.34.dist-info → GitPython-3.1.36.dist-info}/RECORD

@@ -1,5 +1,5 @@
-git/__init__.py,sha256=D1Xxk-x8AlLUEvwpeBbIaEjfKRX76JAeMXXjZR_UDWw,2379
-git/cmd.py,sha256=Js_9VXq-4ss288i-_Ii9ptoCThWBa9v1RS75-f7mxWY,54090
+git/__init__.py,sha256=k6nrx92KdrotIDHFnn1z0bZSxWtvaYZcKkMTaQO1Lsw,2379
+git/cmd.py,sha256=g9VI2IZU7jF4oYf9C1hLDqY6mD10wET_Du8BVZQi_P0,54069
 git/compat.py,sha256=3wWLkD9QrZvLiV6NtNxJILwGrLE2nw_SoLqaTEPH364,2256
 git/config.py,sha256=_84Pc5-jF9aNMGHMkF2sE0_UClLDkRD92Hbm7zaqAgw,34578
 git/db.py,sha256=dEs2Bn-iDuHyero9afw8mrXHrLE7_CDExv943iWU9WI,2244
@@ -8,7 +8,7 @@ git/exc.py,sha256=h5OD3BrolG94u4sS97HlXf8VYYUMQWn_JoUBgKrMrl0,6444
 git/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 git/remote.py,sha256=LCUY4dmMufudQWrzrzX7hyQKvuZMzwRXtpaWz1Ye-04,45068
 git/types.py,sha256=y7gKGGB7mEu8VAgo57EXr17t85OXxtp6y58t0-tXk_8,3096
-git/util.py,sha256=JNoyKL8vPXgIRNbbDSq2ESRdhZCS5Ia1nU7MbW2JvpI,39746
+git/util.py,sha256=5ITzeAGWkUMi6ZjX3MZRz1kYn5F_s7VxkwBcklV-qWc,40205
 git/index/__init__.py,sha256=43ovvVNocVRNiQd4fLqvUMuGGmwhBQ9SsiQ46vkvk1E,89
 git/index/base.py,sha256=9H9pTfhfB4yHysz7HRO39OyfVKqHMacYQBn6QLcpRfk,57492
 git/index/fun.py,sha256=LovPTfZMkusNQXYIbzrWDqTbTSsF-XT5HBxxD2uAq44,16433
@@ -23,7 +23,7 @@ git/objects/tag.py,sha256=ZXOLK_lV9E5G2aDl5t0hYDN2hhIhGF23HILHBnZgRX0,3840
 git/objects/tree.py,sha256=cSQbt3nn3cIrbVrBasB1wm2r-vzotYWhka1yDjOHf-k,14230
 git/objects/util.py,sha256=g7j2D3cdTZ-c1n-22ih3lmSeVXOUEmvwLBG1CsE24aI,22275
 git/objects/submodule/__init__.py,sha256=OsMeiex7cG6ev2f35IaJ5csH-eXchSoNKCt4HXUG5Ws,93
-git/objects/submodule/base.py,sha256=R4jTjBJyMjFOfDAYwsA6Q3Lt6qeFYERPE4PABACW6GE,61539
+git/objects/submodule/base.py,sha256=hiM9J3yW4xEUyJ95lUwcILv9iX7LXq99dtiRN81uvtU,61691
 git/objects/submodule/root.py,sha256=Ev_RnGzv4hi3UqEFMHuSR-uGR7kYpwOgwZFUG31X-Hc,19568
 git/objects/submodule/util.py,sha256=u2zQGFWBmryqET0XWf9BuiY1OOgWB8YCU3Wz0xdp4E4,3380
 git/refs/__init__.py,sha256=PMF97jMUcivbCCEJnl2zTs-YtECNFp8rL8GHK8AitXU,203
@@ -31,14 +31,14 @@ git/refs/head.py,sha256=rZ4LbFd05Gs9sAuSU5VQRDmJZfrwMwWtBpLlmiUQ-Zg,9756
 git/refs/log.py,sha256=Z8X9_ZGZrVTWz9p_-fk1N3m47G-HTRPwozoZBDd70DI,11892
 git/refs/reference.py,sha256=DUx7QvYqTBeVxG53ntPfKCp3wuJyDBRIZcPCy1OD22s,5414
 git/refs/remote.py,sha256=E63Bh5ig1GYrk6FE46iNtS5P6ZgODyPXot8eJw-mxts,2556
-git/refs/symbolic.py,sha256=XwfeYr1Zp-fuHAoGuVAXKk4EYlsuUMVu99OjJWuWDTQ,29967
+git/refs/symbolic.py,sha256=nbgWkQlQCj2KZiyfvVTmSU5hilYQp0t7Wm1BSEwAxP8,30065
 git/refs/tag.py,sha256=FNoCZ3BdDl2i5kD3si2P9hoXU9rDAZ_YK0Rn84TmKT8,4419
 git/repo/__init__.py,sha256=XMpdeowJRtTEd80jAcrKSQfMu2JZGMfPlpuIYHG2ZCk,80
 git/repo/base.py,sha256=3iOwwyXSrXPycEEr2dEI-mjl9m_BvV6KrEkYxMspxKE,55134
 git/repo/fun.py,sha256=VTRODXAb_x8bazkSd8g-Pkk8M2iLVK4kPoKQY9HXjZc,12962
-GitPython-3.1.34.dist-info/AUTHORS,sha256=0F09KKrRmwH3zJ4gqo1tJMVlalC9bSunDNKlRvR6q2c,2158
-GitPython-3.1.34.dist-info/LICENSE,sha256=_WV__CzvY9JceMq3gI1BTdA6KC5jiTSR_RHDL5i-Z_s,1521
-GitPython-3.1.34.dist-info/METADATA,sha256=tSyIQdMqDDUUBYsnGolqfBlosTf0jvfiTx57xbrKEh8,10019
-GitPython-3.1.34.dist-info/WHEEL,sha256=yQN5g4mg4AybRjkgi-9yy4iQEFibGQmlz78Pik5Or-A,92
-GitPython-3.1.34.dist-info/top_level.txt,sha256=0hzDuIp8obv624V3GmbqsagBWkk8ohtGU-Bc1PmTT0o,4
-GitPython-3.1.34.dist-info/RECORD,,
+GitPython-3.1.36.dist-info/AUTHORS,sha256=MTQl3FsmhgQKZ6l496gsyG82rHY_FdJJ8MgVKbVvU8Y,2199
+GitPython-3.1.36.dist-info/LICENSE,sha256=_WV__CzvY9JceMq3gI1BTdA6KC5jiTSR_RHDL5i-Z_s,1521
+GitPython-3.1.36.dist-info/METADATA,sha256=deOWQkShWVuYb_YV9FTF4900-VW4qVEhfy-UCPSSwms,12249
+GitPython-3.1.36.dist-info/WHEEL,sha256=yQN5g4mg4AybRjkgi-9yy4iQEFibGQmlz78Pik5Or-A,92
+GitPython-3.1.36.dist-info/top_level.txt,sha256=0hzDuIp8obv624V3GmbqsagBWkk8ohtGU-Bc1PmTT0o,4
+GitPython-3.1.36.dist-info/RECORD,,

git/__init__.py

@@ -14,13 +14,13 @@ import os.path as osp
 from typing import Optional
 from git.types import PathLike
 
-__version__ = '3.1.34'
+__version__ = '3.1.36'
 
 
 # { Initialization
 def _init_externals() -> None:
     """Initialize external projects by putting them into the path"""
-    if __version__ == '3.1.34' and "PYOXIDIZER" not in os.environ:
+    if __version__ == '3.1.36' and "PYOXIDIZER" not in os.environ:
         sys.path.insert(1, osp.join(osp.dirname(__file__), "ext", "gitdb"))
 
     try:

git/cmd.py

@@ -14,7 +14,6 @@ from subprocess import call, Popen, PIPE, DEVNULL
 import subprocess
 import threading
 from textwrap import dedent
-import unittest.mock
 
 from git.compat import (
     defenc,
@@ -24,7 +23,7 @@ from git.compat import (
     is_win,
 )
 from git.exc import CommandError
-from git.util import is_cygwin_git, cygpath, expand_path, remove_password_if_present
+from git.util import is_cygwin_git, cygpath, expand_path, remove_password_if_present, patch_env
 
 from .exc import GitCommandError, GitCommandNotFound, UnsafeOptionError, UnsafeProtocolError
 from .util import (
@@ -965,10 +964,10 @@ class Git(LazyMixin):
                     '"kill_after_timeout" feature is not supported on Windows.',
                 )
             # Only search PATH, not CWD. This must be in the *caller* environment. The "1" can be any value.
-            patch_caller_env = unittest.mock.patch.dict(os.environ, {"NoDefaultCurrentDirectoryInExePath": "1"})
+            maybe_patch_caller_env = patch_env("NoDefaultCurrentDirectoryInExePath", "1")
         else:
             cmd_not_found_exception = FileNotFoundError  # NOQA # exists, flake8 unknown @UndefinedVariable
-            patch_caller_env = contextlib.nullcontext()
+            maybe_patch_caller_env = contextlib.nullcontext()
         # end handle
 
         stdout_sink = PIPE if with_stdout else getattr(subprocess, "DEVNULL", None) or open(os.devnull, "wb")
@@ -984,7 +983,7 @@ class Git(LazyMixin):
             istream_ok,
         )
         try:
-            with patch_caller_env:
+            with maybe_patch_caller_env:
                 proc = Popen(
                     command,
                     env=env,

git/objects/submodule/base.py

@@ -1402,6 +1402,10 @@ class Submodule(IndexObject, TraversableIterableObj):
                 # END handle keyerror
             # END handle critical error
 
+            # Make sure we are looking at a submodule object
+            if type(sm) != git.objects.submodule.base.Submodule:
+                continue
+
             # fill in remaining info - saves time as it doesn't have to be parsed again
             sm._name = n
             if pc != repo.commit():

git/refs/symbolic.py

@@ -168,6 +168,8 @@ class SymbolicReference(object):
         """Return: (str(sha), str(target_ref_path)) if available, the sha the file at
         rela_path points to, or None. target_ref_path is the reference we
         point to, or None"""
+        if ".." in str(ref_path):
+            raise ValueError(f"Invalid reference '{ref_path}'")
         tokens: Union[None, List[str], Tuple[str, str]] = None
         repodir = _git_dir(repo, ref_path)
         try:

git/util.py

@@ -150,6 +150,7 @@ def unbare_repo(func: Callable[..., T]) -> Callable[..., T]:
 
 @contextlib.contextmanager
 def cwd(new_dir: PathLike) -> Generator[PathLike, None, None]:
+    """Context manager to temporarily change directory. Not reentrant."""
     old_dir = os.getcwd()
     os.chdir(new_dir)
     try:
@@ -158,6 +159,20 @@ def cwd(new_dir: PathLike) -> Generator[PathLike, None, None]:
         os.chdir(old_dir)
 
 
+@contextlib.contextmanager
+def patch_env(name: str, value: str) -> Generator[None, None, None]:
+    """Context manager to temporarily patch an environment variable."""
+    old_value = os.getenv(name)
+    os.environ[name] = value
+    try:
+        yield
+    finally:
+        if old_value is None:
+            del os.environ[name]
+        else:
+            os.environ[name] = old_value
+
+
 def rmtree(path: PathLike) -> None:
     """Remove the given recursively.
 
@@ -935,7 +950,7 @@ class LockFile(object):
             )
 
         try:
-            with open(lock_file, mode='w'):
+            with open(lock_file, mode="w"):
                 pass
         except OSError as e:
             raise IOError(str(e)) from e