improve types according to test/test_archive.py

Author: BenediktSeidl

pygit2/_pygit2.pyi

@@ -1,6 +1,7 @@
 from typing import Iterator, Literal, Optional, overload, Type, TypedDict
 from io import IOBase, DEFAULT_BUFFER_SIZE
 from queue import Queue
+import tarfile
 from threading import Event
 from . import Index
 from .enums import (
@@ -290,6 +291,7 @@ class Object:
     type: 'Literal[GIT_OBJ_COMMIT] | Literal[GIT_OBJ_TREE] | Literal[GIT_OBJ_TAG] | Literal[GIT_OBJ_BLOB]'
     type_str: "Literal['commit'] | Literal['tree'] | Literal['tag'] | Literal['blob']"
     author: Signature
+    committer: Signature
     tree: Tree
     @overload
     def peel(
@@ -838,6 +840,13 @@ class Repository:
     def walk(
         self, oid: _OidArg | None, sort_mode: SortMode = SortMode.NONE
     ) -> Walker: ...
+    def write_archive(
+        self,
+        treeish: str | Tree | Object | Oid,
+        archive: tarfile.TarFile,
+        timestamp: int | None = None,
+        prefix: str = '',
+    ) -> None: ...
 
 class RevSpec:
     flags: int

pygit2/index.py

@@ -42,7 +42,7 @@ class Index:
     # a proper implementation in some places: e.g. checking the index type
     # from C code (see Tree_diff_to_index)
 
-    def __init__(self, path=None):
+    def __init__(self, path: str | None = None) -> None:
         """Create a new Index
 
         If path is supplied, the read and write methods will use that path
@@ -69,13 +69,13 @@ def from_c(cls, repo, ptr):
     def _pointer(self):
         return bytes(ffi.buffer(self._cindex)[:])
 
-    def __del__(self):
+    def __del__(self) -> None:
         C.git_index_free(self._index)
 
-    def __len__(self):
+    def __len__(self) -> int:
         return C.git_index_entrycount(self._index)
 
-    def __contains__(self, path):
+    def __contains__(self, path) -> bool:
         err = C.git_index_find(ffi.NULL, self._index, to_bytes(path))
         if err == C.GIT_ENOTFOUND:
             return False

test/test_archive.py

@@ -26,14 +26,16 @@
 from pathlib import Path
 import tarfile
 
-from pygit2 import Index, Oid, Tree, Object
+from pygit2 import Index, Oid, Tree, Object, Repository
 
 
 TREE_HASH = 'fd937514cb799514d4b81bb24c5fcfeb6472b245'
 COMMIT_HASH = '2be5719152d4f82c7302b1c0932d8e5f0a4a0e98'
 
 
-def check_writing(repo, treeish, timestamp=None):
+def check_writing(
+    repo: Repository, treeish: str | Tree | Oid | Object, timestamp: int | None = None
+) -> None:
     archive = tarfile.open('foo.tar', mode='w')
     repo.write_archive(treeish, archive)
 
@@ -55,13 +57,13 @@ def check_writing(repo, treeish, timestamp=None):
     path.unlink()
 
 
-def test_write_tree(testrepo):
+def test_write_tree(testrepo: Repository) -> None:
     check_writing(testrepo, TREE_HASH)
     check_writing(testrepo, Oid(hex=TREE_HASH))
     check_writing(testrepo, testrepo[TREE_HASH])
 
 
-def test_write_commit(testrepo):
+def test_write_commit(testrepo: Repository) -> None:
     commit_timestamp = testrepo[COMMIT_HASH].committer.time
     check_writing(testrepo, COMMIT_HASH, commit_timestamp)
     check_writing(testrepo, Oid(hex=COMMIT_HASH), commit_timestamp)