improve types according to test/test_packbuilder.py

Author: BenediktSeidl

pygit2/_libgit2/ffi.pyi

@@ -192,6 +192,9 @@ class GitRepositoryInitOptionsC:
 class GitCloneOptionsC:
     pass
 
+class GitPackbuilderC:
+    pass
+
 class GitProxyTC:
     pass
 
@@ -275,6 +278,8 @@ def new(a: Literal['git_object *']) -> GitObjectC: ...
 @overload
 def new(a: Literal['git_object **']) -> _Pointer[GitObjectC]: ...
 @overload
+def new(a: Literal['git_packbuilder **']) -> _Pointer[GitPackbuilderC]: ...
+@overload
 def new(a: Literal['git_signature *']) -> GitSignatureC: ...
 @overload
 def new(a: Literal['git_signature **']) -> _Pointer[GitSignatureC]: ...

pygit2/_pygit2.pyi

@@ -5,6 +5,7 @@ from pathlib import Path
 from queue import Queue
 from threading import Event
 from typing import (
+    Callable,
     Generic,
     Iterator,
     Literal,
@@ -58,6 +59,7 @@ from .enums import (
     SortMode,
 )
 from .filter import Filter
+from .packbuilder import PackBuilder
 from .remotes import Remote
 from .repository import BaseRepository
 from .submodules import SubmoduleCollection
@@ -757,6 +759,7 @@ class Repository:
     def _disown(self, *args, **kwargs) -> None: ...
     @classmethod
     def _from_c(cls, ptr: 'GitRepositoryC', owned: bool) -> 'Repository': ...
+    def __iter__(self) -> Iterator[Oid]: ...
     def __getitem__(self, key: str | Oid) -> Object: ...
     def add_worktree(self, name: str, path: str, ref: Reference = ...) -> Worktree: ...
     def amend_commit(
@@ -934,6 +937,12 @@ class Repository:
     @property
     def message(self) -> str: ...
     def notes(self) -> Iterator[Note]: ...
+    def pack(
+        self,
+        path: str | Path | None = None,
+        pack_delegate: Callable[[PackBuilder], None] | None = None,
+        n_threads: int | None = None,
+    ) -> bool: ...
     def path_is_ignored(self, path: str) -> bool: ...
     def raw_listall_branches(
         self, flag: BranchType = BranchType.LOCAL

pygit2/packbuilder.py

@@ -23,15 +23,18 @@
 # the Free Software Foundation, 51 Franklin Street, Fifth Floor,
 # Boston, MA 02110-1301, USA.
 
+from os import PathLike
 
 # Import from pygit2
+from pygit2 import Oid, Repository
+
 from .errors import check_error
 from .ffi import C, ffi
 from .utils import to_bytes
 
 
 class PackBuilder:
-    def __init__(self, repo):
+    def __init__(self, repo: Repository) -> None:
         cpackbuilder = ffi.new('git_packbuilder **')
         err = C.git_packbuilder_new(cpackbuilder, repo._repo)
         check_error(err)
@@ -41,39 +44,41 @@ def __init__(self, repo):
         self._cpackbuilder = cpackbuilder
 
     @property
-    def _pointer(self):
+    def _pointer(self) -> bytes:
         return bytes(ffi.buffer(self._packbuilder)[:])
 
-    def __del__(self):
+    def __del__(self) -> None:
         C.git_packbuilder_free(self._packbuilder)
 
-    def __len__(self):
+    def __len__(self) -> int:
         return C.git_packbuilder_object_count(self._packbuilder)
 
     @staticmethod
-    def __convert_object_to_oid(oid):
+    def __convert_object_to_oid(oid: Oid) -> 'ffi.GitOidC':
         git_oid = ffi.new('git_oid *')
         ffi.buffer(git_oid)[:] = oid.raw[:]
         return git_oid
 
-    def add(self, oid):
+    def add(self, oid: Oid) -> None:
         git_oid = self.__convert_object_to_oid(oid)
         err = C.git_packbuilder_insert(self._packbuilder, git_oid, ffi.NULL)
         check_error(err)
 
-    def add_recur(self, oid):
+    def add_recur(self, oid: Oid) -> None:
         git_oid = self.__convert_object_to_oid(oid)
         err = C.git_packbuilder_insert_recur(self._packbuilder, git_oid, ffi.NULL)
         check_error(err)
 
-    def set_threads(self, n_threads):
+    def set_threads(self, n_threads: int) -> int:
         return C.git_packbuilder_set_threads(self._packbuilder, n_threads)
 
-    def write(self, path=None):
-        path = ffi.NULL if path is None else to_bytes(path)
-        err = C.git_packbuilder_write(self._packbuilder, path, 0, ffi.NULL, ffi.NULL)
+    def write(self, path: str | bytes | PathLike[str] | None = None) -> None:
+        path_bytes = ffi.NULL if path is None else to_bytes(path)
+        err = C.git_packbuilder_write(
+            self._packbuilder, path_bytes, 0, ffi.NULL, ffi.NULL
+        )
         check_error(err)
 
     @property
-    def written_objects_count(self):
+    def written_objects_count(self) -> int:
         return C.git_packbuilder_written(self._packbuilder)

test/test_packbuilder.py

@@ -26,20 +26,21 @@
 """Tests for Index files."""
 
 from pathlib import Path
+from typing import Callable
 
 import pygit2
-from pygit2 import PackBuilder
+from pygit2 import Oid, PackBuilder, Repository
 
 from . import utils
 
 
-def test_create_packbuilder(testrepo):
+def test_create_packbuilder(testrepo: Repository) -> None:
     # simple test of PackBuilder creation
     packbuilder = PackBuilder(testrepo)
     assert len(packbuilder) == 0
 
 
-def test_add(testrepo):
+def test_add(testrepo: Repository) -> None:
     # Add a few objects and confirm that the count is correct
     packbuilder = PackBuilder(testrepo)
     objects_to_add = [obj for obj in testrepo]
@@ -49,9 +50,10 @@ def test_add(testrepo):
     assert len(packbuilder) == 2
 
 
-def test_add_recursively(testrepo):
+def test_add_recursively(testrepo: Repository) -> None:
     # Add the head object and referenced objects recursively and confirm that the count is correct
     packbuilder = PackBuilder(testrepo)
+    assert isinstance(testrepo.head.target, Oid)
     packbuilder.add_recur(testrepo.head.target)
 
     # expect a count of 4 made up of the following referenced objects:
@@ -63,14 +65,14 @@ def test_add_recursively(testrepo):
     assert len(packbuilder) == 4
 
 
-def test_repo_pack(testrepo, tmp_path):
+def test_repo_pack(testrepo: Repository, tmp_path: Path) -> None:
     # pack the repo with the default strategy
     confirm_same_repo_after_packing(testrepo, tmp_path, None)
 
 
-def test_pack_with_delegate(testrepo, tmp_path):
+def test_pack_with_delegate(testrepo: Repository, tmp_path: Path) -> None:
     # loop through all branches and add each commit to the packbuilder
-    def pack_delegate(pb):
+    def pack_delegate(pb: PackBuilder) -> None:
         for branch in pb._repo.branches:
             br = pb._repo.branches.get(branch)
             for commit in br.log():
@@ -79,15 +81,19 @@ def pack_delegate(pb):
     confirm_same_repo_after_packing(testrepo, tmp_path, pack_delegate)
 
 
-def setup_second_repo(tmp_path):
+def setup_second_repo(tmp_path: Path) -> Repository:
     # helper method to set up a second repo for comparison
     tmp_path_2 = tmp_path / 'test_repo2'
     with utils.TemporaryRepository('testrepo.zip', tmp_path_2) as path:
         testrepo = pygit2.Repository(path)
     return testrepo
 
 
-def confirm_same_repo_after_packing(testrepo, tmp_path, pack_delegate):
+def confirm_same_repo_after_packing(
+    testrepo: Repository,
+    tmp_path: Path,
+    pack_delegate: Callable[[PackBuilder], None] | None,
+) -> None:
     # Helper method to confirm the contents of two repos before and after packing
     pack_repo = setup_second_repo(tmp_path)
     pack_repo_path = Path(pack_repo.path)

test/utils.py

@@ -89,7 +89,7 @@ def force_rm_handle(remove_path, path, excinfo):
     remove_path(path)
 
 
-def rmtree(path):
+def rmtree(path: str | Path) -> None:
     """In Windows a read-only file cannot be removed, and shutil.rmtree fails.
     So we implement our own version of rmtree to address this issue.
     """