improve types according to test/test_remote.py

Author: BenediktSeidl

pygit2/_libgit2/ffi.pyi

@@ -35,13 +35,19 @@ NULL: NULL_TYPE = ...
 char = NewType('char', object)
 char_pointer = NewType('char_pointer', object)
 
+class size_t:
+    def __getitem__(self, item: Literal[0]) -> int: ...
+
 class _Pointer(Generic[T]):
     def __setitem__(self, item: Literal[0], a: T) -> None: ...
     @overload
     def __getitem__(self, item: Literal[0]) -> T: ...
     @overload
     def __getitem__(self, item: slice[None, None, None]) -> bytes: ...
 
+class _MultiPointer(Generic[T]):
+    def __getitem__(self, item: int) -> T: ...
+
 class ArrayC(Generic[T]):
     # incomplete!
     # def _len(self, ?) -> ?: ...
@@ -83,6 +89,13 @@ class GitSubmoduleC:
 class GitSubmoduleUpdateOptionsC:
     fetch_opts: GitFetchOptionsC
 
+class GitRemoteHeadC:
+    local: int
+    oid: GitOidC
+    loid: GitOidC
+    name: char_pointer
+    symref_target: char_pointer
+
 class UnsignedIntC:
     def __getitem__(self, item: Literal[0]) -> int: ...
 
@@ -284,6 +297,12 @@ def new(a: Literal['git_signature *']) -> GitSignatureC: ...
 @overload
 def new(a: Literal['git_signature **']) -> _Pointer[GitSignatureC]: ...
 @overload
+def new(
+    a: Literal['git_remote_head ***'],
+) -> _Pointer[_MultiPointer[GitRemoteHeadC]]: ...
+@overload
+def new(a: Literal['size_t *']) -> size_t: ...
+@overload
 def new(a: Literal['git_stash_save_options *']) -> GitStashSaveOptionsC: ...
 @overload
 def new(a: Literal['git_strarray *']) -> GitStrrayC: ...

pygit2/remotes.py

@@ -25,11 +25,12 @@
 
 from __future__ import annotations
 
-from typing import TYPE_CHECKING, Any
-
-from . import utils
+from typing import TYPE_CHECKING, Any, TypedDict
 
 # Import from pygit2
+from pygit2 import RemoteCallbacks
+
+from . import utils
 from ._pygit2 import Oid
 from .callbacks import (
     git_fetch_options,
@@ -48,6 +49,14 @@
     from .repository import BaseRepository
 
 
+class LsRemotesDict(TypedDict):
+    local: bool
+    loid: None | Oid
+    name: str | None
+    symref_target: str | None
+    oid: Oid
+
+
 class TransferProgress:
     """Progress downloading and indexing data during a fetch."""
 
@@ -180,7 +189,9 @@ def fetch(
 
         return TransferProgress(C.git_remote_stats(self._remote))
 
-    def ls_remotes(self, callbacks=None, proxy=None):
+    def ls_remotes(
+        self, callbacks: RemoteCallbacks | None = None, proxy: str | None | bool = None
+    ) -> list[LsRemotesDict]:
         """
         Return a list of dicts that maps to `git_remote_head` from a
         `ls_remotes` call.
@@ -209,13 +220,15 @@ def ls_remotes(self, callbacks=None, proxy=None):
             else:
                 loid = None
 
-            remote = {
-                'local': local,
-                'loid': loid,
-                'name': maybe_string(ref.name),
-                'symref_target': maybe_string(ref.symref_target),
-                'oid': Oid(raw=bytes(ffi.buffer(ref.oid.id)[:])),
-            }
+            remote = LsRemotesDict(
+                {
+                    'local': local,
+                    'loid': loid,
+                    'name': maybe_string(ref.name),
+                    'symref_target': maybe_string(ref.symref_target),
+                    'oid': Oid(raw=bytes(ffi.buffer(ref.oid.id)[:])),
+                }
+            )
 
             results.append(remote)
 
@@ -256,7 +269,14 @@ def push_refspecs(self):
         check_error(err)
         return strarray_to_strings(specs)
 
-    def push(self, specs, callbacks=None, proxy=None, push_options=None, threads=1):
+    def push(
+        self,
+        specs: list[str],
+        callbacks: RemoteCallbacks | None = None,
+        proxy: None | bool | str = None,
+        push_options: None | list[str] = None,
+        threads: int = 1,
+    ) -> None:
         """
         Push the given refspec to the remote. Raises ``GitError`` on protocol
         error or unpack failure.
@@ -272,6 +292,8 @@ def push(self, specs, callbacks=None, proxy=None, push_options=None, threads=1):
         specs : [str]
             Push refspecs to use.
 
+        callbacks :
+
         proxy : None or True or str
             Proxy configuration. Can be one of:
 

test/test_remote.py

@@ -282,11 +282,13 @@ def test_update_tips(emptyrepo: Repository) -> None:
     ]
 
     class MyCallbacks(pygit2.RemoteCallbacks):
-        def __init__(self, tips):
+        tips: list[tuple[str, pygit2.Oid, pygit2.Oid]]
+
+        def __init__(self, tips: list[tuple[str, pygit2.Oid, pygit2.Oid]]) -> None:
             self.tips = tips
             self.i = 0
 
-        def update_tips(self, name, old, new):
+        def update_tips(self, name: str, old: pygit2.Oid, new: pygit2.Oid) -> None:
             assert self.tips[self.i] == (name, old, new)
             self.i += 1
 
@@ -342,7 +344,7 @@ def clone(tmp_path: Path) -> Generator[Repository, None, None]:
 
 
 @pytest.fixture
-def remote(origin, clone):
+def remote(origin: Repository, clone: Repository) -> Generator[Remote, None, None]:
     yield clone.remotes.create('origin', origin.path)