pygit2 1.15.0__tar.gz → 1.15.1__tar.gz

{pygit2-1.15.0 → pygit2-1.15.1}/CHANGELOG.md

@@ -1,3 +1,31 @@
+# 1.15.1 (2024-07-07)
+
+- New `Repository.revert(...)`
+  [#1297](https://github.com/libgit2/pygit2/pull/1297)
+
+- New optional `depth` argument in submodules `add()` and `update()` methods
+  [#1296](https://github.com/libgit2/pygit2/pull/1296)
+
+- Now `Submodule.url` returns `None` when the submodule does not have a url
+  [#1294](https://github.com/libgit2/pygit2/pull/1294)
+
+- Fix use after free bug in error reporting
+  [#1299](https://github.com/libgit2/pygit2/pull/1299)
+
+- Fix `Submodule.head_id` when the submodule is not in the current HEAD tree
+  [#1300](https://github.com/libgit2/pygit2/pull/1300)
+
+- Fix `Submodule.open()` when subclassing `Repository`
+  [#1295](https://github.com/libgit2/pygit2/pull/1295)
+
+- Fix error in the test suite when running with address sanitizer
+  [#1304](https://github.com/libgit2/pygit2/pull/1304)
+  [#1301](https://github.com/libgit2/pygit2/issues/1301)
+
+- Annotations and documentation fixes
+  [#1293](https://github.com/libgit2/pygit2/pull/1293)
+
+
 # 1.15.0 (2024-05-18)
 
 - Many deprecated features have been removed, see below

{pygit2-1.15.0 → pygit2-1.15.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pygit2
-Version: 1.15.0
+Version: 1.15.1
 Summary: Python bindings for libgit2.
 Home-page: https://github.com/libgit2/pygit2
 Maintainer: J. David Ibáñez
@@ -47,6 +47,8 @@ Supports Python 3.9 to 3.12 and PyPy3 7.3+
 
 ## Sponsors
 
+- [Microsoft](https://github.com/microsoft)
+
 Add your name and link here, [become a
 sponsor](https://github.com/sponsors/jdavid).
 

{pygit2-1.15.0 → pygit2-1.15.1}/README.md

@@ -18,6 +18,8 @@ Supports Python 3.9 to 3.12 and PyPy3 7.3+
 
 ## Sponsors
 
+- [Microsoft](https://github.com/microsoft)
+
 Add your name and link here, [become a
 sponsor](https://github.com/sponsors/jdavid).
 

{pygit2-1.15.0 → pygit2-1.15.1}/SPONSORS.md

@@ -1,5 +1,6 @@
 Friends of pygit2:
 
+- [Microsoft](https://github.com/microsoft)
 
 Add your name to the list,
 [become a friend of pygit2](https://github.com/sponsors/jdavid).
@@ -8,4 +9,5 @@ Past sponsors:
 
 - [Iterative](https://iterative.ai/)
 - [SourceHut](https://sourcehut.org)
+- [GitHub](https://github.com/github)
 - [omniproc](https://github.com/omniproc)

{pygit2-1.15.0 → pygit2-1.15.1}/pygit2/_build.py

@@ -34,7 +34,7 @@ from pathlib import Path
 #
 # The version number of pygit2
 #
-__version__ = '1.15.0'
+__version__ = '1.15.1'
 
 
 #

{pygit2-1.15.0 → pygit2-1.15.1}/pygit2/_pygit2.pyi

@@ -4,12 +4,12 @@ from . import Index, Submodule
 from .enums import (
     ApplyLocation,
     BranchType,
+    DeltaStatus,
     DiffFind,
     DiffFlag,
     DiffOption,
     DiffStatsFormat,
     FileMode,
-    FileStatus,
     MergeAnalysis,
     MergePreference,
     ObjectType,
@@ -171,7 +171,7 @@ class DiffDelta:
     new_file: DiffFile
     old_file: DiffFile
     similarity: int
-    status: FileStatus
+    status: DeltaStatus
     def status_char(self) -> str: ...
 
 class DiffFile:

pygit2-1.15.1/pygit2/decl/revert.h

@@ -0,0 +1,21 @@
+#define GIT_REVERT_OPTIONS_VERSION ...
+
+typedef struct {
+	unsigned int version;
+	unsigned int mainline;
+	git_merge_options merge_opts;
+	git_checkout_options checkout_opts;
+} git_revert_options;
+
+int git_revert(
+	git_repository *repo,
+	git_commit *commit,
+	const git_revert_options *given_opts);
+
+int git_revert_commit(
+	git_index **out,
+	git_repository *repo,
+	git_commit *revert_commit,
+	git_commit *our_commit,
+	unsigned int mainline,
+	const git_merge_options *merge_options);

{pygit2-1.15.0 → pygit2-1.15.1}/pygit2/repository.py

@@ -1343,6 +1343,19 @@ class BaseRepository(_Repository):
         err = C.git_repository_set_ident(self._repo, to_bytes(name), to_bytes(email))
         check_error(err)
 
+    def revert(self, commit: Commit):
+        """
+        Revert the given commit, producing changes in the index and working
+        directory.
+
+        This operation updates the repository's state and prepared message
+        (MERGE_MSG).
+        """
+        commit_ptr = ffi.new('git_commit **')
+        ffi.buffer(commit_ptr)[:] = commit._pointer[:]
+        err = C.git_revert(self._repo, commit_ptr[0], ffi.NULL)
+        check_error(err)
+
     def revert_commit(self, revert_commit, our_commit, mainline=0):
         """
         Revert the given Commit against the given "our" Commit, producing an
@@ -1548,6 +1561,6 @@ class Repository(BaseRepository):
         cptr = ffi.new('git_repository **')
         cptr[0] = ptr
         repo = cls.__new__(cls)
-        super(cls, repo)._from_c(bytes(ffi.buffer(cptr)[:]), owned)
+        BaseRepository._from_c(repo, bytes(ffi.buffer(cptr)[:]), owned)
         repo._common_init()
         return repo

{pygit2-1.15.0 → pygit2-1.15.1}/pygit2/submodules.py

@@ -31,7 +31,7 @@ from .callbacks import git_fetch_options, RemoteCallbacks
 from .enums import SubmoduleIgnore, SubmoduleStatus
 from .errors import check_error
 from .ffi import ffi, C
-from .utils import to_bytes
+from .utils import to_bytes, maybe_string
 
 # Need BaseRepository for type hints, but don't let it cause a circular dependency
 if TYPE_CHECKING:
@@ -73,7 +73,9 @@ class Submodule:
         err = C.git_submodule_init(self._subm, int(overwrite))
         check_error(err)
 
-    def update(self, init: bool = False, callbacks: RemoteCallbacks = None):
+    def update(
+        self, init: bool = False, callbacks: RemoteCallbacks = None, depth: int = 0
+    ):
         """
         Update a submodule. This will clone a missing submodule and checkout
         the subrepository to the commit specified in the index of the
@@ -90,12 +92,17 @@ class Submodule:
 
         callbacks
             Optional RemoteCallbacks to clone or fetch the submodule.
+
+        depth
+            Number of commits to fetch.
+            The default is 0 (full commit history).
         """
 
         opts = ffi.new('git_submodule_update_options *')
         C.git_submodule_update_options_init(
             opts, C.GIT_SUBMODULE_UPDATE_OPTIONS_VERSION
         )
+        opts.fetch_opts.depth = depth
 
         with git_fetch_options(callbacks, opts=opts.fetch_opts) as payload:
             err = C.git_submodule_update(self._subm, int(init), opts)
@@ -129,10 +136,10 @@ class Submodule:
         return ffi.string(path).decode('utf-8')
 
     @property
-    def url(self):
+    def url(self) -> Union[str, None]:
         """URL of the submodule."""
         url = C.git_submodule_url(self._subm)
-        return ffi.string(url).decode('utf-8')
+        return maybe_string(url)
 
     @property
     def branch(self):
@@ -141,10 +148,17 @@ class Submodule:
         return ffi.string(branch).decode('utf-8')
 
     @property
-    def head_id(self):
-        """Head of the submodule."""
+    def head_id(self) -> Union[Oid, None]:
+        """
+        The submodule's HEAD commit id (as recorded in the superproject's
+        current HEAD tree).
+        Returns None if the superproject's HEAD doesn't contain the submodule.
+        """
+
         head = C.git_submodule_head_id(self._subm)
-        return Oid(raw=bytes(ffi.buffer(head)[:]))
+        if head == ffi.NULL:
+            return None
+        return Oid(raw=bytes(ffi.buffer(head.id)[:]))
 
 
 class SubmoduleCollection:
@@ -188,6 +202,7 @@ class SubmoduleCollection:
         path: str,
         link: bool = True,
         callbacks: Optional[RemoteCallbacks] = None,
+        depth: int = 0,
     ) -> Submodule:
         """
         Add a submodule to the index.
@@ -208,6 +223,10 @@ class SubmoduleCollection:
 
         callbacks
             Optional RemoteCallbacks to clone the submodule.
+
+        depth
+            Number of commits to fetch.
+            The default is 0 (full commit history).
         """
         csub = ffi.new('git_submodule **')
         curl = ffi.new('char[]', to_bytes(url))
@@ -226,6 +245,7 @@ class SubmoduleCollection:
         C.git_submodule_update_options_init(
             opts, C.GIT_SUBMODULE_UPDATE_OPTIONS_VERSION
         )
+        opts.fetch_opts.depth = depth
 
         with git_fetch_options(callbacks, opts=opts.fetch_opts) as payload:
             crepo = ffi.new('git_repository **')
@@ -268,6 +288,7 @@ class SubmoduleCollection:
         submodules: Optional[Iterable[str]] = None,
         init: bool = False,
         callbacks: Optional[RemoteCallbacks] = None,
+        depth: int = 0,
     ):
         """
         Update submodules. This will clone a missing submodule and checkout
@@ -289,6 +310,10 @@ class SubmoduleCollection:
 
         callbacks
             Optional RemoteCallbacks to clone or fetch the submodule.
+
+        depth
+            Number of commits to fetch.
+            The default is 0 (full commit history).
         """
         if submodules is None:
             submodules = self._repository.listall_submodules()
@@ -296,7 +321,7 @@ class SubmoduleCollection:
         instances = [self[s] for s in submodules]
 
         for submodule in instances:
-            submodule.update(init, callbacks)
+            submodule.update(init, callbacks, depth)
 
     def status(
         self, name: str, ignore: SubmoduleIgnore = SubmoduleIgnore.UNSPECIFIED

{pygit2-1.15.0 → pygit2-1.15.1}/src/diff.c

@@ -323,7 +323,7 @@ DiffDelta_is_binary__get__(DiffDelta *self)
 }
 
 PyDoc_STRVAR(DiffDelta_status__doc__,
-    "An enums.FileStatus constant."
+    "An enums.DeltaStatus constant."
 );
 
 PyObject *

{pygit2-1.15.0 → pygit2-1.15.1}/src/pygit2.c

@@ -109,6 +109,7 @@ discover_repository(PyObject *self, PyObject *args)
     const char *ceiling_dirs = NULL;
     PyObject *py_repo_path = NULL;
     int err;
+    PyObject *result = NULL;
 
     if (!PyArg_ParseTuple(args, "O&|IO&", PyUnicode_FSConverter, &py_path, &across_fs,
                           PyUnicode_FSConverter, &py_ceiling_dirs))
@@ -122,18 +123,20 @@ discover_repository(PyObject *self, PyObject *args)
     memset(&repo_path, 0, sizeof(git_buf));
     err = git_repository_discover(&repo_path, path, across_fs, ceiling_dirs);
 
-    Py_XDECREF(py_path);
-    Py_XDECREF(py_ceiling_dirs);
-
-    if (err == GIT_ENOTFOUND)
-        Py_RETURN_NONE;
-    if (err < 0)
-        return Error_set_str(err, path);
+    if (err == GIT_OK) {
+        py_repo_path = PyUnicode_DecodeFSDefault(repo_path.ptr);
+        git_buf_dispose(&repo_path);
+        result = py_repo_path;
+    } else if (err == GIT_ENOTFOUND) {
+        result = Py_None;
+    } else {
+        result = Error_set_str(err, path);
+    }
 
-    py_repo_path = PyUnicode_DecodeFSDefault(repo_path.ptr);
-    git_buf_dispose(&repo_path);
+    Py_XDECREF(py_ceiling_dirs);
+    Py_XDECREF(py_path);
 
-    return py_repo_path;
+    return result;
 };
 
 PyDoc_STRVAR(hashfile__doc__,
@@ -200,6 +203,7 @@ init_file_backend(PyObject *self, PyObject *args)
     unsigned int flags = 0;
     int err = GIT_OK;
     git_repository *repository = NULL;
+    PyObject *result = NULL;
 
     if (!PyArg_ParseTuple(args, "O&|I", PyUnicode_FSConverter, &py_path, &flags))
         return NULL;
@@ -208,25 +212,23 @@ init_file_backend(PyObject *self, PyObject *args)
 
     err = git_repository_open_ext(&repository, path, flags, NULL);
 
-    Py_XDECREF(py_path);
-
-    if (err < 0) {
+    if (err == GIT_OK) {
+        result = PyCapsule_New(repository, "backend", NULL);
+    } else {
+        result = NULL;
         Error_set_str(err, path);
-        goto cleanup;
-    }
-
-    return PyCapsule_New(repository, "backend", NULL);
 
-cleanup:
-    if (repository) {
-        git_repository_free(repository);
-    }
+        if (repository) {
+            git_repository_free(repository);
+        }
 
-    if (err == GIT_ENOTFOUND) {
-        PyErr_Format(GitError, "Repository not found at %s", path);
+        if (err == GIT_ENOTFOUND) {
+            PyErr_Format(GitError, "Repository not found at %s", path);
+        }
     }
 
-    return NULL;
+    Py_XDECREF(py_path);
+    return result;
 }
 
 

{pygit2-1.15.0 → pygit2-1.15.1}/test/test_diff.py

@@ -339,6 +339,8 @@ def test_deltas(barerepo):
     assert len(deltas) == len(patches)
     for i, delta in enumerate(deltas):
         patch_delta = patches[i].delta
+        assert isinstance(delta.status, DeltaStatus)
+        assert isinstance(patch_delta.status, DeltaStatus)
         assert delta.status == patch_delta.status
         assert delta.similarity == patch_delta.similarity
         assert delta.nfiles == patch_delta.nfiles

{pygit2-1.15.0 → pygit2-1.15.1}/test/test_remote.py

@@ -373,10 +373,9 @@ def test_push_options(mock_callbacks, origin, clone, remote):
     remote.push(['refs/heads/master'], push_options=['foo'])
     remote_push_options = mock_callbacks.return_value.push_options.remote_push_options
     assert remote_push_options.count == 1
-    assert ffi.string(remote_push_options.strings[0]) == b'foo'
+    # strings pointed to by remote_push_options.strings[] are already freed
 
     remote.push(['refs/heads/master'], push_options=['Option A', 'Option B'])
     remote_push_options = mock_callbacks.return_value.push_options.remote_push_options
     assert remote_push_options.count == 2
-    assert ffi.string(remote_push_options.strings[0]) == b'Option A'
-    assert ffi.string(remote_push_options.strings[1]) == b'Option B'
+    # strings pointed to by remote_push_options.strings[] are already freed

{pygit2-1.15.0 → pygit2-1.15.1}/test/test_repository.py

@@ -39,6 +39,7 @@ from pygit2.enums import (
     FileStatus,
     ObjectType,
     RepositoryOpenFlag,
+    RepositoryState,
     ResetMode,
     StashApplyProgress,
 )
@@ -538,7 +539,7 @@ def test_stash_apply_checkout_options(testrepo):
         assert f.read() == 'stashed content'
 
 
-def test_revert(testrepo):
+def test_revert_commit(testrepo):
     master = testrepo.head.peel()
     commit_to_revert = testrepo['4ec4389a8068641da2d6578db0419484972284c8']
     parent = commit_to_revert.parents[0]
@@ -552,6 +553,26 @@ def test_revert(testrepo):
     assert revert_diff_stats.files_changed == commit_diff_stats.files_changed
 
 
+def test_revert(testrepo):
+    hello_txt = Path(testrepo.workdir) / 'hello.txt'
+    commit_to_revert = testrepo['4ec4389a8068641da2d6578db0419484972284c8']
+
+    assert testrepo.state() == RepositoryState.NONE
+    assert not testrepo.message
+    assert 'bonjour le monde' in hello_txt.read_text()
+
+    # Revert addition of French line in hello.txt
+    testrepo.revert(commit_to_revert)
+
+    assert 'bonjour le monde' not in hello_txt.read_text()
+    assert testrepo.status()['hello.txt'] == FileStatus.INDEX_MODIFIED
+    assert testrepo.state() == RepositoryState.REVERT
+    assert (
+        testrepo.message
+        == f'Revert "Say hello in French"\n\nThis reverts commit {commit_to_revert.id}.\n'
+    )
+
+
 def test_default_signature(testrepo):
     config = testrepo.config
     config['user.name'] = 'Random J Hacker'

{pygit2-1.15.0 → pygit2-1.15.1}/test/test_submodule.py

@@ -38,6 +38,7 @@ SUBM_NAME = 'TestGitRepository'
 SUBM_PATH = 'TestGitRepository'
 SUBM_URL = 'https://github.com/libgit2/TestGitRepository'
 SUBM_HEAD_SHA = '49322bb17d3acc9146f98c97d078513228bbf3c0'
+SUBM_BOTTOM_SHA = '6c8b137b1c652731597c89668f417b8695f28dd7'
 
 
 @pytest.fixture
@@ -91,6 +92,20 @@ def test_submodule_open(repo):
     assert r.head.target == SUBM_HEAD_SHA
 
 
+@utils.requires_network
+def test_submodule_open_from_repository_subclass(repo):
+    class CustomRepoClass(pygit2.Repository):
+        pass
+
+    custom_repo = CustomRepoClass(repo.workdir)
+    s = custom_repo.submodules[SUBM_PATH]
+    custom_repo.submodules.init()
+    custom_repo.submodules.update()
+    r = s.open()
+    assert isinstance(r, CustomRepoClass)
+    assert r.head.target == SUBM_HEAD_SHA
+
+
 def test_name(repo):
     s = repo.submodules[SUBM_PATH]
     assert SUBM_NAME == s.name
@@ -106,6 +121,15 @@ def test_url(repo):
     assert SUBM_URL == s.url
 
 
+def test_missing_url(repo):
+    # Remove "url" from .gitmodules
+    with open(Path(repo.workdir, '.gitmodules'), 'wt') as f:
+        f.write('[submodule "TestGitRepository"]\n')
+        f.write('\tpath = TestGitRepository\n')
+    s = repo.submodules[SUBM_PATH]
+    assert not s.url
+
+
 @utils.requires_network
 def test_init_and_update(repo):
     subrepo_file_path = Path(repo.workdir) / SUBM_PATH / 'master.txt'
@@ -143,27 +167,43 @@ def test_update_instance(repo):
 
 
 @utils.requires_network
-def test_oneshot_update(repo):
+@pytest.mark.parametrize('depth', [0, 1])
+def test_oneshot_update(repo, depth):
     status = repo.submodules.status(SUBM_NAME)
     assert status == (SS.IN_HEAD | SS.IN_INDEX | SS.IN_CONFIG | SS.WD_UNINITIALIZED)
 
     subrepo_file_path = Path(repo.workdir) / SUBM_PATH / 'master.txt'
     assert not subrepo_file_path.exists()
-    repo.submodules.update(init=True)
+    repo.submodules.update(init=True, depth=depth)
     assert subrepo_file_path.exists()
 
     status = repo.submodules.status(SUBM_NAME)
     assert status == (SS.IN_HEAD | SS.IN_INDEX | SS.IN_CONFIG | SS.IN_WD)
 
+    sm_repo = repo.submodules[SUBM_NAME].open()
+    if depth == 0:
+        sm_repo[SUBM_BOTTOM_SHA]  # full history must be available
+    else:
+        with pytest.raises(KeyError):
+            sm_repo[SUBM_BOTTOM_SHA]  # shallow clone
+
 
 @utils.requires_network
-def test_oneshot_update_instance(repo):
+@pytest.mark.parametrize('depth', [0, 1])
+def test_oneshot_update_instance(repo, depth):
     subrepo_file_path = Path(repo.workdir) / SUBM_PATH / 'master.txt'
     assert not subrepo_file_path.exists()
     sm = repo.submodules[SUBM_NAME]
-    sm.update(init=True)
+    sm.update(init=True, depth=depth)
     assert subrepo_file_path.exists()
 
+    sm_repo = sm.open()
+    if depth == 0:
+        sm_repo[SUBM_BOTTOM_SHA]  # full history must be available
+    else:
+        with pytest.raises(KeyError):
+            sm_repo[SUBM_BOTTOM_SHA]  # shallow clone
+
 
 @utils.requires_network
 def test_head_id(repo):
@@ -171,9 +211,28 @@ def test_head_id(repo):
 
 
 @utils.requires_network
-def test_add_submodule(repo):
+def test_head_id_null(repo):
+    gitmodules_newlines = (
+        '\n'
+        '[submodule "uncommitted_submodule"]\n'
+        '    path = pygit2\n'
+        '    url = https://github.com/libgit2/pygit2\n'
+        '\n'
+    )
+    with open(Path(repo.workdir, '.gitmodules'), 'a') as f:
+        f.write(gitmodules_newlines)
+
+    subm = repo.submodules['uncommitted_submodule']
+
+    # The submodule isn't in the HEAD yet, so head_id should be None
+    assert subm.head_id is None
+
+
+@utils.requires_network
+@pytest.mark.parametrize('depth', [0, 1])
+def test_add_submodule(repo, depth):
     sm_repo_path = 'test/testrepo'
-    sm = repo.submodules.add(SUBM_URL, sm_repo_path)
+    sm = repo.submodules.add(SUBM_URL, sm_repo_path, depth=depth)
 
     status = repo.submodules.status(sm_repo_path)
     assert status == (SS.IN_INDEX | SS.IN_CONFIG | SS.IN_WD | SS.INDEX_ADDED)
@@ -183,6 +242,12 @@ def test_add_submodule(repo):
     assert SUBM_URL == sm.url
     assert not sm_repo.is_empty
 
+    if depth == 0:
+        sm_repo[SUBM_BOTTOM_SHA]  # full history must be available
+    else:
+        with pytest.raises(KeyError):
+            sm_repo[SUBM_BOTTOM_SHA]  # shallow clone
+
 
 @utils.requires_network
 def test_submodule_status(repo):

pygit2-1.15.0/pygit2/decl/revert.h

@@ -1,7 +0,0 @@
-int git_revert_commit(
-	git_index **out,
-	git_repository *repo,
-	git_commit *revert_commit,
-	git_commit *our_commit,
-	unsigned int mainline,
-	const git_merge_options *merge_options);

{pygit2-1.15.0 → pygit2-1.15.1}/AUTHORS.md

@@ -50,6 +50,7 @@ Authors:
     Dan Sully
     David Versmisse
     Grégory Herrero
+    Michał Kępień
     Mikhail Yushkovskiy
     Robin Stocker
     Rohit Sanjay
@@ -72,7 +73,6 @@ Authors:
     Jason Ziglar
     Leonardo Rhodes
     Mark Adams
-    Michał Kępień
     Nika Layzell
     Peter-Yi Zhang
     Petr Viktorin