pygit2 1.15.0__tar.gz → 1.16.0__tar.gz

{pygit2-1.15.0 → pygit2-1.16.0}/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
@@ -113,6 +113,7 @@ Authors:
     Kevin KIN-FOO
     Marcel Waldvogel
     Masud Rahman
+    Mathieu Parent
     Michael Sondergaard
     Natanael Arndt
     Ondřej Nový
@@ -184,16 +185,17 @@ Authors:
     Lukas Berk
     Martin von Zweigbergk
     Mathieu Bridon
-    Mathieu Parent
     Mathieu Pillard
     Matthaus Woolard
     Maxwell G
     Michał Górny
+    Na'aman Hirschfeld
     Nicolás Sanguinetti
     Nikita Kartashov
     Nikolai Zujev
     Nils Philippsen
     Noah Fontes
+    Or Hayat
     Óscar San José
     Patrick Lühne
     Paul Wagland
@@ -215,6 +217,7 @@ Authors:
     Steven Winfield
     Tad Hardesty
     Timo Röhling
+    Victor Florea
     Vladimir Rutsky
     Wim Jeantine-Glenn
     Yu Jianjian

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

@@ -1,3 +1,53 @@
+# 1.16.0 (2024-10-11)
+
+- Add support for Python 3.13
+
+- Drop support for Python 3.9
+
+- New `Repository.hashfile(...)`
+  [#1298](https://github.com/libgit2/pygit2/pull/1298)
+
+- New `Option.GET_MWINDOW_FILE_LIMIT` and `Option.SET_MWINDOW_FILE_LIMIT`
+  [#1312](https://github.com/libgit2/pygit2/pull/1312)
+
+- Fix overriding `certificate_check(...)` callback via argument to `RemoteCallbacks(...)`
+  [#1321](https://github.com/libgit2/pygit2/pull/1321)
+
+- Add py.typed
+  [#1310](https://github.com/libgit2/pygit2/pull/1310)
+
+- Fix `discover_repository(...)` annotation
+  [#1313](https://github.com/libgit2/pygit2/pull/1313)
+
+
+# 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.16.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pygit2
-Version: 1.15.0
+Version: 1.16.0
 Summary: Python bindings for libgit2.
 Home-page: https://github.com/libgit2/pygit2
 Maintainer: J. David Ibáñez
@@ -14,23 +14,24 @@ Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: Implementation :: PyPy
 Classifier: Programming Language :: Python :: Implementation :: CPython
 Classifier: Topic :: Software Development :: Version Control
-Requires-Python: >=3.9
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: COPYING
 License-File: AUTHORS.md
-Requires-Dist: cffi>=1.16.0
+Requires-Dist: cffi>=1.17.0
 
 # pygit2 - libgit2 bindings in Python
 
 Bindings to the libgit2 shared library, implements Git plumbing.
-Supports Python 3.9 to 3.12 and PyPy3 7.3+
+Supports Python 3.10 to 3.13 and PyPy3 7.3+
 
 [![image](https://github.com/libgit2/pygit2/actions/workflows/tests.yml/badge.svg)](https://github.com/libgit2/pygit2/actions/workflows/tests.yml)
 

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

@@ -1,7 +1,7 @@
 # pygit2 - libgit2 bindings in Python
 
 Bindings to the libgit2 shared library, implements Git plumbing.
-Supports Python 3.9 to 3.12 and PyPy3 7.3+
+Supports Python 3.10 to 3.13 and PyPy3 7.3+
 
 [![image](https://github.com/libgit2/pygit2/actions/workflows/tests.yml/badge.svg)](https://github.com/libgit2/pygit2/actions/workflows/tests.yml)
 

pygit2-1.16.0/SPONSORS.md

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

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

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

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

@@ -1,15 +1,15 @@
 from typing import Iterator, Literal, Optional, overload
 from io import IOBase
-from . import Index, Submodule
+from . import Index
 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:
@@ -558,7 +558,7 @@ class Worktree:
 
 def discover_repository(
     path: str, across_fs: bool = False, ceiling_dirs: str = ...
-) -> str: ...
+) -> str | None: ...
 def hash(data: bytes) -> Oid: ...
 def hashfile(path: str) -> Oid: ...
 def init_file_backend(path: str, flags: int = 0) -> object: ...

{pygit2-1.15.0 → pygit2-1.16.0}/pygit2/callbacks.py

@@ -113,12 +113,12 @@ class RemoteCallbacks(Payload):
     RemoteCallbacks(certificate=certificate).
     """
 
-    def __init__(self, credentials=None, certificate=None):
+    def __init__(self, credentials=None, certificate_check=None):
         super().__init__()
         if credentials is not None:
             self.credentials = credentials
-        if certificate is not None:
-            self.certificate = certificate
+        if certificate_check is not None:
+            self.certificate_check = certificate_check
 
     def sideband_progress(self, string):
         """
@@ -344,7 +344,7 @@ def git_fetch_options(payload, opts=None):
     opts.callbacks.transfer_progress = C._transfer_progress_cb
     opts.callbacks.update_tips = C._update_tips_cb
     opts.callbacks.credentials = C._credentials_cb
-    opts.callbacks.certificate_check = C._certificate_cb
+    opts.callbacks.certificate_check = C._certificate_check_cb
     # Payload
     handle = ffi.new_handle(payload)
     opts.callbacks.payload = handle
@@ -368,7 +368,7 @@ def git_push_options(payload, opts=None):
     opts.callbacks.transfer_progress = C._transfer_progress_cb
     opts.callbacks.update_tips = C._update_tips_cb
     opts.callbacks.credentials = C._credentials_cb
-    opts.callbacks.certificate_check = C._certificate_cb
+    opts.callbacks.certificate_check = C._certificate_check_cb
     opts.callbacks.push_update_reference = C._push_update_reference_cb
     # Payload
     handle = ffi.new_handle(payload)
@@ -457,7 +457,7 @@ def libgit2_callback_void(f):
 
 
 @libgit2_callback
-def _certificate_cb(cert_i, valid, host, data):
+def _certificate_check_cb(cert_i, valid, host, data):
     # We want to simulate what should happen if libgit2 supported pass-through
     # for this callback. For SSH, 'valid' is always False, because it doesn't
     # look at known_hosts, but we do want to let it through in order to do what

{pygit2-1.15.0 → pygit2-1.16.0}/pygit2/decl/callbacks.h

@@ -1,4 +1,4 @@
-extern "Python" int _certificate_cb(
+extern "Python" int _certificate_check_cb(
     git_cert *cert,
     int valid,
     const char *host,

{pygit2-1.15.0 → pygit2-1.16.0}/pygit2/decl/repository.h

@@ -83,6 +83,7 @@ int git_repository_set_head_detached(
 	git_repository* repo,
 	const git_oid* commitish);
 
+int git_repository_hashfile(git_oid *out, git_repository *repo, const char *path, git_object_t type, const char *as_path);
 int git_repository_ident(const char **name, const char **email, const git_repository *repo);
 int git_repository_set_ident(git_repository *repo, const char *name, const char *email);
 int git_repository_index(git_index **out, git_repository *repo);

pygit2-1.16.0/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.16.0}/pygit2/decl/types.h

@@ -57,3 +57,14 @@ typedef enum {
 	GIT_SUBMODULE_IGNORE_DIRTY     = 3,
 	GIT_SUBMODULE_IGNORE_ALL       = 4,
 } git_submodule_ignore_t;
+
+typedef enum {
+	GIT_OBJECT_ANY       = ...,
+	GIT_OBJECT_INVALID   = ...,
+	GIT_OBJECT_COMMIT    = ...,
+	GIT_OBJECT_TREE      = ...,
+	GIT_OBJECT_BLOB      = ...,
+	GIT_OBJECT_TAG       = ...,
+	GIT_OBJECT_OFS_DELTA = ...,
+	GIT_OBJECT_REF_DELTA = ...,
+} git_object_t;

{pygit2-1.15.0 → pygit2-1.16.0}/pygit2/enums.py

@@ -979,8 +979,8 @@ class Option(IntEnum):
     SET_PACK_MAX_OBJECTS = _pygit2.GIT_OPT_SET_PACK_MAX_OBJECTS
     DISABLE_PACK_KEEP_FILE_CHECKS = _pygit2.GIT_OPT_DISABLE_PACK_KEEP_FILE_CHECKS
     # ENABLE_HTTP_EXPECT_CONTINUE = _pygit2.GIT_OPT_ENABLE_HTTP_EXPECT_CONTINUE
-    # GET_MWINDOW_FILE_LIMIT = _pygit2.GIT_OPT_GET_MWINDOW_FILE_LIMIT
-    # SET_MWINDOW_FILE_LIMIT = _pygit2.GIT_OPT_SET_MWINDOW_FILE_LIMIT
+    GET_MWINDOW_FILE_LIMIT = _pygit2.GIT_OPT_GET_MWINDOW_FILE_LIMIT
+    SET_MWINDOW_FILE_LIMIT = _pygit2.GIT_OPT_SET_MWINDOW_FILE_LIMIT
     # SET_ODB_PACKED_PRIORITY = _pygit2.GIT_OPT_SET_ODB_PACKED_PRIORITY
     # SET_ODB_LOOSE_PRIORITY = _pygit2.GIT_OPT_SET_ODB_LOOSE_PRIORITY
     # GET_EXTENSIONS = _pygit2.GIT_OPT_GET_EXTENSIONS

pygit2-1.16.0/pygit2/py.typed

@@ -0,0 +1 @@
+# python type marker, see: https://peps.python.org/pep-0561/

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

@@ -51,6 +51,7 @@ from .enums import (
     MergeFavor,
     MergeFileFlag,
     MergeFlag,
+    ObjectType,
     RepositoryOpenFlag,
     RepositoryState,
 )
@@ -129,6 +130,58 @@ class BaseRepository(_Repository):
 
         return builder.written_objects_count
 
+    def hashfile(
+        self,
+        path: str,
+        object_type: ObjectType = ObjectType.BLOB,
+        as_path: typing.Optional[str] = None,
+    ):
+        """Calculate the hash of a file using repository filtering rules.
+
+        If you simply want to calculate the hash of a file on disk with no filters,
+        you can just use `pygit2.hashfile()`. However, if you want to hash a file
+        in the repository and you want to apply filtering rules (e.g. crlf filters)
+        before generating the SHA, then use this function.
+
+        Note: if the repository has `core.safecrlf` set to fail and the filtering
+        triggers that failure, then this function will raise an error and not
+        calculate the hash of the file.
+
+        Returns: Output value of calculated SHA (Oid)
+
+        Parameters:
+
+        path
+            Path to file on disk whose contents should be hashed. This may be
+            an absolute path or a relative path, in which case it will be treated
+            as a path within the working directory.
+
+        object_type
+            The object type to hash (e.g. enums.ObjectType.BLOB)
+
+        as_path
+            The path to use to look up filtering rules. If this is an empty string
+            then no filters will be applied when calculating the hash.
+            If this is `None` and the `path` parameter is a file within the
+            repository's working directory, then the `path` will be used.
+        """
+        c_path = to_bytes(path)
+
+        if as_path is None:
+            c_as_path = ffi.NULL
+        else:
+            c_as_path = to_bytes(as_path)
+
+        c_oid = ffi.new('git_oid *')
+
+        err = C.git_repository_hashfile(
+            c_oid, self._repo, c_path, int(object_type), c_as_path
+        )
+        check_error(err)
+
+        oid = Oid(raw=bytes(ffi.buffer(c_oid.id)[:]))
+        return oid
+
     def __iter__(self):
         return iter(self.odb)
 
@@ -1343,6 +1396,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 +1614,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.16.0}/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.16.0}/pyproject.toml

@@ -25,7 +25,7 @@ environment = {LIBGIT2_VERSION="1.8.1", LIBSSH2_VERSION="1.11.0", OPENSSL_VERSIO
 repair-wheel-command = "DYLD_LIBRARY_PATH=/Users/runner/work/pygit2/pygit2/ci/lib delocate-wheel --require-archs {delocate_archs} -w {dest_dir} {wheel}"
 
 [tool.ruff]
-target-version = "py39"  # oldest supported Python version
+target-version = "py310"  # oldest supported Python version
 fix = true
 extend-exclude = [
     ".cache",

{pygit2-1.15.0 → pygit2-1.16.0}/setup.py

@@ -75,13 +75,14 @@ classifiers = [
     'Intended Audience :: Developers',
     'Programming Language :: Python',
     'Programming Language :: Python :: 3',
-    'Programming Language :: Python :: 3.9',
     'Programming Language :: Python :: 3.10',
     'Programming Language :: Python :: 3.11',
     'Programming Language :: Python :: 3.12',
+    'Programming Language :: Python :: 3.13',
     'Programming Language :: Python :: Implementation :: PyPy',
     'Programming Language :: Python :: Implementation :: CPython',
     'Topic :: Software Development :: Version Control',
+    'Typing :: Typed',
 ]
 
 __dir__ = Path(__file__).parent
@@ -144,15 +145,15 @@ setup(
     long_description=long_description,
     long_description_content_type='text/markdown',
     packages=['pygit2'],
-    package_data={'pygit2': ['decl/*.h', '*.pyi']},
+    package_data={'pygit2': ['decl/*.h', '*.pyi', 'py.typed']},
     zip_safe=False,
     cmdclass=cmdclass,
     cffi_modules=['pygit2/_run.py:ffi'],
     ext_modules=ext_modules,
     # Requirements
-    python_requires='>=3.9',
-    setup_requires=['cffi>=1.16.0'],
-    install_requires=['cffi>=1.16.0'],
+    python_requires='>=3.10',
+    setup_requires=['cffi>=1.17.0'],
+    install_requires=['cffi>=1.17.0'],
     # URLs
     url='https://github.com/libgit2/pygit2',
     project_urls={

{pygit2-1.15.0 → pygit2-1.16.0}/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 *