pygit2 1.17.0__tar.gz → 1.18.0__tar.gz

{pygit2-1.17.0 → pygit2-1.18.0}/AUTHORS.md

@@ -43,14 +43,16 @@ Authors:
     Chad Dombrova
     Lukas Fleischer
     Mathias Leppich
+    Mathieu Parent
+    Michał Kępień
     Nicolas Dandrimont
     Raphael Medaer (Escaux)
+    Yaroslav Halchenko
     Anatoly Techtonik
     Andrew Olsen
     Dan Sully
     David Versmisse
     Grégory Herrero
-    Michał Kępień
     Mikhail Yushkovskiy
     Robin Stocker
     Rohit Sanjay
@@ -89,6 +91,7 @@ Authors:
     Andrey Devyatkin
     Arno van Lumig
     Ben Davis
+    CJ Steiner
     Colin Watson
     Dan Yeaw
     Dustin Raimondi
@@ -114,7 +117,6 @@ Authors:
     Kyle Gottfried
     Marcel Waldvogel
     Masud Rahman
-    Mathieu Parent
     Michael Sondergaard
     Natanael Arndt
     Ondřej Nový
@@ -127,6 +129,7 @@ Authors:
     nikitalita
     Adam Gausmann
     Adam Spiers
+    Adrien Nader
     Albin Söderström
     Alexandru Fikl
     Andrew Chin
@@ -160,6 +163,7 @@ Authors:
     David Six
     Dennis Schwertel
     Devaev Maxim
+    Edmundo Carmona Antoranz
     Eric Davis
     Erik Meusel
     Erik van Zijst
@@ -180,6 +184,7 @@ Authors:
     Josh Bleecher Snyder
     Julia Evans
     Justin Clift
+    Karl Malmros
     Kevin Valk
     Konstantinos Smanis
     Kyriakos Oikonomakos
@@ -224,6 +229,7 @@ Authors:
     Timo Röhling
     Victor Florea
     Vladimir Rutsky
+    William Schueller
     Wim Jeantine-Glenn
     Yu Jianjian
     buhl

{pygit2-1.17.0 → pygit2-1.18.0}/CHANGELOG.md

@@ -1,3 +1,61 @@
+# 1.18.0 (2025-04-24)
+
+- Upgrade Linux Glibc wheels to `manylinux_2_28`
+
+- Add `RemoteCallbacks.push_transfer_progress(...)` callback
+  [#1345](https://github.com/libgit2/pygit2/pull/1345)
+
+- New `bool(oid)`
+  [#1347](https://github.com/libgit2/pygit2/pull/1347)
+
+- Now `Repository.merge(...)` accepts a commit or reference object
+  [#1348](https://github.com/libgit2/pygit2/pull/1348)
+
+- New `threads` optional argument in `Remote.push(...)`
+  [#1352](https://github.com/libgit2/pygit2/pull/1352)
+
+- New `proxy` optional argument in `clone_repository(...)`
+  [#1354](https://github.com/libgit2/pygit2/pull/1354)
+
+- New optional arguments `context_lines` and `interhunk_lines` in `Blob.diff(...)` ; and
+  now `Repository.diff(...)` honors these two arguments when the objects diffed are blobs.
+  [#1360](https://github.com/libgit2/pygit2/pull/1360)
+
+- Now `Tree.diff_to_workdir(...)` accepts keyword arguments, not just positional.
+
+- Fix when a reference name has non UTF-8 chars
+  [#1329](https://github.com/libgit2/pygit2/pull/1329)
+
+- Fix condition check in `Repository.remotes.rename(...)`
+  [#1342](https://github.com/libgit2/pygit2/pull/1342)
+
+- Add codespell workflow, fix a number of typos
+  [#1344](https://github.com/libgit2/pygit2/pull/1344)
+
+- Documentation and typing
+  [#1343](https://github.com/libgit2/pygit2/pull/1343)
+  [#1347](https://github.com/libgit2/pygit2/pull/1347)
+  [#1356](https://github.com/libgit2/pygit2/pull/1356)
+
+- CI: Use ARM runner for tests and wheels
+  [#1346](https://github.com/libgit2/pygit2/pull/1346)
+
+- Build and CI updates
+  [#1363](https://github.com/libgit2/pygit2/pull/1363)
+  [#1365](https://github.com/libgit2/pygit2/pull/1365)
+
+Deprecations:
+
+- Passing str to `Repository.merge(...)` is deprecated,
+  instead pass an oid object (or a commit, or a reference)
+  [#1349](https://github.com/libgit2/pygit2/pull/1349)
+
+Breaking changes:
+
+- Keyword argument `flag` has been renamed to `flags` in `Blob.diff(...)` and
+  `Blob.diff_to_buffer(...)`
+
+
 # 1.17.0 (2025-01-08)
 
 - Upgrade to libgit2 1.9
@@ -259,7 +317,7 @@ Deprecations:
 -   New `keep_all` and `paths` optional arguments for
     `Repository.stash(...)`
     [#1202](https://github.com/libgit2/pygit2/pull/1202)
--   New `Respository.state()`
+-   New `Repository.state()`
     [#1204](https://github.com/libgit2/pygit2/pull/1204)
 -   Improve `Repository.write_archive(...)` performance
     [#1183](https://github.com/libgit2/pygit2/pull/1183)
@@ -439,7 +497,7 @@ Breaking changes:
 
 Breaking changes:
 
--   Remove deprecated `GIT_CREDTYPE_XXX` contants, use
+-   Remove deprecated `GIT_CREDTYPE_XXX` constants, use
     `GIT_CREDENTIAL_XXX` instead.
 -   Remove deprecated `Patch.patch` getter, use `Patch.text` instead.
 
@@ -536,7 +594,7 @@ Deprecations:
 
 -   Deprecate `Repository.create_remote(...)`, use instead
     `Repository.remotes.create(...)`
--   Deprecate `GIT_CREDTYPE_XXX` contants, use `GIT_CREDENTIAL_XXX`
+-   Deprecate `GIT_CREDTYPE_XXX` constants, use `GIT_CREDENTIAL_XXX`
     instead.
 
 # 1.2.0 (2020-04-05)
@@ -657,7 +715,7 @@ Breaking changes:
 
 Breaking changes:
 
--   Now the Repository has a new attribue `odb` for object database:
+-   Now the Repository has a new attribute `odb` for object database:
 
         # Before
         repository.read(...)
@@ -862,7 +920,7 @@ Other changes:
     [#610](https://github.com/libgit2/pygit2/issues/610)
 -   Fix tests failing in some cases
     [#795](https://github.com/libgit2/pygit2/issues/795)
--   Automatize wheels upload to pypi
+-   Automate wheels upload to pypi
     [#563](https://github.com/libgit2/pygit2/issues/563)
 
 # 0.27.0 (2018-03-30)

{pygit2-1.17.0 → pygit2-1.18.0}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: pygit2
-Version: 1.17.0
+Version: 1.18.0
 Summary: Python bindings for libgit2.
 Home-page: https://github.com/libgit2/pygit2
 Maintainer: J. David Ibáñez
@@ -27,6 +27,19 @@ Description-Content-Type: text/markdown
 License-File: COPYING
 License-File: AUTHORS.md
 Requires-Dist: cffi>=1.17.0
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: license-file
+Dynamic: maintainer
+Dynamic: maintainer-email
+Dynamic: project-url
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
 
 # pygit2 - libgit2 bindings in Python
 

{pygit2-1.17.0 → pygit2-1.18.0}/build.sh

@@ -69,6 +69,7 @@ if [ "$CIBUILDWHEEL" = "1" ]; then
             yum install openssl-devel -y
         else
             yum install perl-IPC-Cmd -y
+            yum install perl-Pod-Html -y
         fi
     elif [ -f /sbin/apk ]; then
         apk add wget

{pygit2-1.17.0 → pygit2-1.18.0}/build_tag.py

@@ -1,4 +1,5 @@
-import platform, sys
+import platform
+import sys
 
 py = {'CPython': 'cp', 'PyPy': 'pp'}[platform.python_implementation()]
 print(f'{py}{sys.version_info.major}{sys.version_info.minor}')

{pygit2-1.17.0 → pygit2-1.18.0}/pygit2/__init__.py

@@ -23,9 +23,11 @@
 # the Free Software Foundation, 51 Franklin Street, Fifth Floor,
 # Boston, MA 02110-1301, USA.
 
+# ruff: noqa: F401 F403 F405
+
 # Standard Library
 import functools
-from os import PathLike
+import os
 import typing
 
 # Low level API
@@ -38,7 +40,12 @@ from ._build import __version__
 from .blame import Blame, BlameHunk
 from .blob import BlobIO
 from .callbacks import Payload, RemoteCallbacks, CheckoutCallbacks, StashApplyCallbacks
-from .callbacks import git_clone_options, git_fetch_options, get_credentials
+from .callbacks import (
+    git_clone_options,
+    git_fetch_options,
+    git_proxy_options,
+    get_credentials,
+)
 from .config import Config
 from .credentials import *
 from .errors import check_error, Passthrough
@@ -66,7 +73,7 @@ _cache_enums()
 
 
 def init_repository(
-    path: typing.Union[str, bytes, PathLike, None],
+    path: typing.Union[str, bytes, os.PathLike, None],
     bare: bool = False,
     flags: enums.RepositoryInitFlag = enums.RepositoryInitFlag.MKPATH,
     mode: typing.Union[
@@ -86,7 +93,7 @@ def init_repository(
 
     The *flags* may be a combination of enums.RepositoryInitFlag constants:
 
-    - BARE (overriden by the *bare* parameter)
+    - BARE (overridden by the *bare* parameter)
     - NO_REINIT
     - NO_DOTGIT_DIR
     - MKDIR
@@ -99,6 +106,10 @@ def init_repository(
     The *workdir_path*, *description*, *template_path*, *initial_head* and
     *origin_url* are all strings.
 
+    If a repository already exists at *path*, it may be opened successfully but
+    you must not rely on that behavior and should use the Repository
+    constructor directly instead.
+
     See libgit2's documentation on git_repository_init_ext for further details.
     """
     # Pre-process input parameters
@@ -144,14 +155,15 @@ def init_repository(
 
 
 def clone_repository(
-    url,
-    path,
-    bare=False,
-    repository=None,
-    remote=None,
-    checkout_branch=None,
-    callbacks=None,
-    depth=0,
+    url: str,
+    path: str,
+    bare: bool = False,
+    repository: typing.Callable | None = None,
+    remote: typing.Callable | None = None,
+    checkout_branch: str | None = None,
+    callbacks: RemoteCallbacks | None = None,
+    depth: int = 0,
+    proxy: None | bool | str = None,
 ):
     """
     Clones a new Git repository from *url* in the given *path*.
@@ -192,6 +204,12 @@ def clone_repository(
         If greater than 0, creates a shallow clone with a history truncated to
         the specified number of commits.
         The default is 0 (full commit history).
+    proxy : None or True or str
+        Proxy configuration. Can be one of:
+
+        * `None` (the default) to disable proxy usage
+        * `True` to enable automatic proxy detection
+        * an url to a proxy (`http://proxy.example.org:3128/`)
     """
 
     if callbacks is None:
@@ -212,9 +230,10 @@ def clone_repository(
             opts.checkout_branch = checkout_branch_ref
 
         with git_fetch_options(payload, opts=opts.fetch_opts):
-            crepo = ffi.new('git_repository **')
-            err = C.git_clone(crepo, to_bytes(url), to_bytes(path), opts)
-            payload.check_error(err)
+            with git_proxy_options(payload, opts.fetch_opts.proxy_opts, proxy):
+                crepo = ffi.new('git_repository **')
+                err = C.git_clone(crepo, to_bytes(url), to_bytes(path), opts)
+                payload.check_error(err)
 
     # Ok
     return Repository._from_c(crepo[0], owned=True)

{pygit2-1.17.0 → pygit2-1.18.0}/pygit2/_build.py

@@ -34,11 +34,11 @@ from pathlib import Path
 #
 # The version number of pygit2
 #
-__version__ = '1.17.0'
+__version__ = '1.18.0'
 
 
 #
-# Utility functions to get the paths required for bulding extensions
+# Utility functions to get the paths required for building extensions
 #
 def _get_libgit2_path():
     # LIBGIT2 environment variable takes precedence

{pygit2-1.17.0 → pygit2-1.18.0}/pygit2/_pygit2.pyi

@@ -262,7 +262,6 @@ class OdbBackendPack(OdbBackend):
     def __init__(self, *args, **kwargs) -> None: ...
 
 class Oid:
-    hex: str
     raw: bytes
     def __init__(self, raw: bytes = ..., hex: str = ...) -> None: ...
     def __eq__(self, other) -> bool: ...
@@ -272,6 +271,7 @@ class Oid:
     def __le__(self, other) -> bool: ...
     def __lt__(self, other) -> bool: ...
     def __ne__(self, other) -> bool: ...
+    def __bool__(self) -> bool: ...
 
 class Patch:
     data: bytes

{pygit2-1.17.0 → pygit2-1.18.0}/pygit2/callbacks.py

@@ -82,12 +82,12 @@ from .utils import maybe_string, to_bytes, ptr_to_bytes, StrArray
 
 
 class Payload:
-    def __init__(self, **kw):
+    def __init__(self, **kw: object):
         for key, value in kw.items():
             setattr(self, key, value)
         self._stored_exception = None
 
-    def check_error(self, error_code):
+    def check_error(self, error_code: int) -> None:
         if error_code == C.GIT_EUSER:
             assert self._stored_exception is not None
             raise self._stored_exception
@@ -120,7 +120,7 @@ class RemoteCallbacks(Payload):
         if certificate_check is not None:
             self.certificate_check = certificate_check
 
-    def sideband_progress(self, string):
+    def sideband_progress(self, string: str) -> None:
         """
         Progress output callback.  Override this function with your own
         progress reporting function
@@ -159,7 +159,7 @@ class RemoteCallbacks(Payload):
         """
         raise Passthrough
 
-    def certificate_check(self, certificate, valid, host):
+    def certificate_check(self, certificate: None, valid: bool, host: str) -> bool:
         """
         Certificate callback. Override with your own function to determine
         whether to accept the server's certificate.
@@ -183,8 +183,10 @@ class RemoteCallbacks(Payload):
 
     def transfer_progress(self, stats):
         """
-        Transfer progress callback. Override with your own function to report
-        transfer progress.
+        During the download of new data, this will be regularly called with
+        the indexer's progress.
+
+        Override with your own function to report transfer progress.
 
         Parameters:
 
@@ -192,6 +194,19 @@ class RemoteCallbacks(Payload):
             The progress up to now.
         """
 
+    def push_transfer_progress(
+        self, objects_pushed: int, total_objects: int, bytes_pushed: int
+    ):
+        """
+        During the upload portion of a push, this will be regularly called
+        with progress information.
+
+        Be aware that this is called inline with pack building operations,
+        so performance may be affected.
+
+        Override with your own function to report push transfer progress.
+        """
+
     def update_tips(self, refname, old, new):
         """
         Update tips callback. Override with your own function to report
@@ -355,6 +370,29 @@ def git_fetch_options(payload, opts=None):
     yield payload
 
 
+@contextmanager
+def git_proxy_options(
+    payload: object,
+    opts: object | None = None,
+    proxy: None | bool | str = None,
+):
+    if opts is None:
+        opts = ffi.new('git_proxy_options *')
+        C.git_proxy_options_init(opts, C.GIT_PROXY_OPTIONS_VERSION)
+    if proxy is None:
+        opts.type = C.GIT_PROXY_NONE
+    elif proxy is True:
+        opts.type = C.GIT_PROXY_AUTO
+    elif type(proxy) is str:
+        opts.type = C.GIT_PROXY_SPECIFIED
+        # Keep url in memory, otherwise memory is freed and bad things happen
+        payload.__proxy_url = ffi.new('char[]', to_bytes(proxy))
+        opts.url = payload.__proxy_url
+    else:
+        raise TypeError('Proxy must be None, True, or a string')
+    yield opts
+
+
 @contextmanager
 def git_push_options(payload, opts=None):
     if payload is None:
@@ -370,6 +408,13 @@ def git_push_options(payload, opts=None):
     opts.callbacks.credentials = C._credentials_cb
     opts.callbacks.certificate_check = C._certificate_check_cb
     opts.callbacks.push_update_reference = C._push_update_reference_cb
+    # Per libgit2 sources, push_transfer_progress may incur a performance hit.
+    # So, set it only if the user has overridden the no-op stub.
+    if (
+        type(payload).push_transfer_progress
+        is not RemoteCallbacks.push_transfer_progress
+    ):
+        opts.callbacks.push_transfer_progress = C._push_transfer_progress_cb
     # Payload
     handle = ffi.new_handle(payload)
     opts.callbacks.payload = handle
@@ -405,10 +450,10 @@ def git_remote_callbacks(payload):
 #
 # C callbacks
 #
-# These functions are called by libgit2. They cannot raise execptions, since
+# These functions are called by libgit2. They cannot raise exceptions, since
 # they return to libgit2, they can only send back error codes.
 #
-# They cannot be overriden, but sometimes the only thing these functions do is
+# They cannot be overridden, but sometimes the only thing these functions do is
 # to proxy the call to a user defined function. If user defined functions
 # raises an exception, the callback must store it somewhere and return
 # GIT_EUSER to libgit2, then the outer Python code will be able to reraise the
@@ -554,6 +599,16 @@ def _transfer_progress_cb(stats_ptr, data):
     return 0
 
 
+@libgit2_callback
+def _push_transfer_progress_cb(current, total, bytes_pushed, payload):
+    push_transfer_progress = getattr(payload, 'push_transfer_progress', None)
+    if not push_transfer_progress:
+        return 0
+
+    push_transfer_progress(current, total, bytes_pushed)
+    return 0
+
+
 @libgit2_callback
 def _update_tips_cb(refname, a, b, data):
     update_tips = getattr(data, 'update_tips', None)

{pygit2-1.17.0 → pygit2-1.18.0}/pygit2/config.py

@@ -304,7 +304,7 @@ class Config:
 
 
 class ConfigEntry:
-    """An entry in a configuation object."""
+    """An entry in a configuration object."""
 
     @classmethod
     def _from_c(cls, ptr, iterator=None):
@@ -321,7 +321,7 @@ class ConfigEntry:
         # git_config_iterator_free when we've deleted all ConfigEntry objects.
         # But it's not, to reproduce the error comment the lines below and run
         # the script in https://github.com/libgit2/pygit2/issues/970
-        # So instead we load the Python object immmediately. Ideally we should
+        # So instead we load the Python object immediately. Ideally we should
         # investigate libgit2 source code.
         if iterator is not None:
             entry.raw_name = entry.raw_name

{pygit2-1.17.0 → pygit2-1.18.0}/pygit2/credentials.py

@@ -23,11 +23,17 @@
 # the Free Software Foundation, 51 Franklin Street, Fifth Floor,
 # Boston, MA 02110-1301, USA.
 
-from .ffi import C
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
 
 from .enums import CredentialType
 
 
+if TYPE_CHECKING:
+    from pathlib import Path
+
+
 class Username:
     """Username credentials
 
@@ -35,7 +41,7 @@ class Username:
     callback and for returning from said callback.
     """
 
-    def __init__(self, username):
+    def __init__(self, username: str):
         self._username = username
 
     @property
@@ -46,7 +52,9 @@ class Username:
     def credential_tuple(self):
         return (self._username,)
 
-    def __call__(self, _url, _username, _allowed):
+    def __call__(
+        self, _url: str, _username: str | None, _allowed: CredentialType
+    ) -> Username:
         return self
 
 
@@ -57,7 +65,7 @@ class UserPass:
     callback and for returning from said callback.
     """
 
-    def __init__(self, username, password):
+    def __init__(self, username: str, password: str):
         self._username = username
         self._password = password
 
@@ -69,7 +77,9 @@ class UserPass:
     def credential_tuple(self):
         return (self._username, self._password)
 
-    def __call__(self, _url, _username, _allowed):
+    def __call__(
+        self, _url: str, _username: str | None, _allowed: CredentialType
+    ) -> UserPass:
         return self
 
 
@@ -96,7 +106,9 @@ class Keypair:
         no passphrase is required.
     """
 
-    def __init__(self, username, pubkey, privkey, passphrase):
+    def __init__(
+        self, username: str, pubkey: str | Path, privkey: str | Path, passphrase: str
+    ):
         self._username = username
         self._pubkey = pubkey
         self._privkey = privkey
@@ -110,12 +122,14 @@ class Keypair:
     def credential_tuple(self):
         return (self._username, self._pubkey, self._privkey, self._passphrase)
 
-    def __call__(self, _url, _username, _allowed):
+    def __call__(
+        self, _url: str, _username: str | None, _allowed: CredentialType
+    ) -> Keypair:
         return self
 
 
 class KeypairFromAgent(Keypair):
-    def __init__(self, username):
+    def __init__(self, username: str):
         super().__init__(username, None, None, None)
 
 

{pygit2-1.17.0 → pygit2-1.18.0}/pygit2/decl/callbacks.h

@@ -38,6 +38,12 @@ extern "Python" int _transfer_progress_cb(
     const git_indexer_progress *stats,
     void *payload);
 
+extern "Python" int _push_transfer_progress_cb(
+    unsigned int objects_pushed,
+    unsigned int total_objects,
+    size_t bytes_pushed,
+    void *payload);
+
 extern "Python" int _update_tips_cb(
 	const char *refname,
 	const git_oid *a,

{pygit2-1.17.0 → pygit2-1.18.0}/pygit2/decl/commit.h

@@ -13,4 +13,9 @@ int git_annotated_commit_lookup(
 	git_repository *repo,
 	const git_oid *id);
 
+int git_annotated_commit_from_ref(
+	git_annotated_commit **out,
+	git_repository *repo,
+	const struct git_reference *ref);
+
 void git_annotated_commit_free(git_annotated_commit *commit);

{pygit2-1.17.0 → pygit2-1.18.0}/pygit2/decl/repository.h

@@ -81,7 +81,7 @@ int git_repository_set_head(
 
 int git_repository_set_head_detached(
 	git_repository* repo,
-	const git_oid* commitish);
+	const git_oid* committish);
 
 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);

{pygit2-1.17.0 → pygit2-1.18.0}/pygit2/errors.py

@@ -42,7 +42,7 @@ def check_error(err, io=False):
     # Error message
     giterr = C.git_error_last()
     if giterr != ffi.NULL:
-        message = ffi.string(giterr.message).decode('utf8')
+        message = ffi.string(giterr.message).decode('utf8', errors='surrogateescape')
     else:
         message = f'err {err} (no message provided)'
 

{pygit2-1.17.0 → pygit2-1.18.0}/pygit2/ffi.py

@@ -24,4 +24,4 @@
 # Boston, MA 02110-1301, USA.
 
 # Import from pygit2
-from ._libgit2 import ffi, lib as C
+from ._libgit2 import ffi, lib as C  # noqa: F401

{pygit2-1.17.0 → pygit2-1.18.0}/pygit2/refspec.py

@@ -43,7 +43,7 @@ class Refspec:
 
     @property
     def dst(self):
-        """Destinaton or rhs of the refspec"""
+        """Destination or rhs of the refspec"""
         return ffi.string(C.git_refspec_dst(self._refspec)).decode('utf-8')
 
     @property