mypy: enable disallow_untyped_calls for test folder

and fix remaining errors
mainly driven by test/test_config.py

Author: BenediktSeidl

mypy.ini

@@ -2,3 +2,4 @@
 
 [mypy-test.*]
 disallow_untyped_defs = True
+disallow_untyped_calls = True

pygit2/_libgit2/ffi.pyi

@@ -38,6 +38,12 @@ char_pointer = NewType('char_pointer', object)
 class size_t:
     def __getitem__(self, item: Literal[0]) -> int: ...
 
+class int_c:
+    def __getitem__(self, item: Literal[0]) -> int: ...
+
+class int64_t:
+    def __getitem__(self, item: Literal[0]) -> int: ...
+
 class _Pointer(Generic[T]):
     def __setitem__(self, item: Literal[0], a: T) -> None: ...
     @overload
@@ -141,9 +147,14 @@ class GitConfigC:
     # incomplete
     pass
 
+class GitConfigIteratorC:
+    # incomplete
+    pass
+
 class GitConfigEntryC:
     # incomplete
     name: char_pointer
+    value: char_pointer
     level: int
 
 class GitDescribeFormatOptionsC:
@@ -269,6 +280,8 @@ def new(a: Literal['git_config *']) -> GitConfigC: ...
 @overload
 def new(a: Literal['git_config **']) -> _Pointer[GitConfigC]: ...
 @overload
+def new(a: Literal['git_config_iterator **']) -> _Pointer[GitConfigIteratorC]: ...
+@overload
 def new(a: Literal['git_config_entry **']) -> _Pointer[GitConfigEntryC]: ...
 @overload
 def new(a: Literal['git_describe_format_options *']) -> GitDescribeFormatOptionsC: ...
@@ -297,6 +310,10 @@ def new(a: Literal['git_signature *']) -> GitSignatureC: ...
 @overload
 def new(a: Literal['git_signature **']) -> _Pointer[GitSignatureC]: ...
 @overload
+def new(a: Literal['int *']) -> int_c: ...
+@overload
+def new(a: Literal['int64_t *']) -> int64_t: ...
+@overload
 def new(
     a: Literal['git_remote_head ***'],
 ) -> _Pointer[_MultiPointer[GitRemoteHeadC]]: ...

pygit2/config.py

@@ -24,7 +24,8 @@
 # Boston, MA 02110-1301, USA.
 
 from os import PathLike
-from typing import TYPE_CHECKING
+from pathlib import Path
+from typing import TYPE_CHECKING, Callable, Iterator
 
 try:
     from functools import cached_property
@@ -48,20 +49,20 @@ def str_to_bytes(value: str | PathLike[str] | bytes, name: str) -> bytes:
 
 
 class ConfigIterator:
-    def __init__(self, config, ptr):
+    def __init__(self, config, ptr) -> None:
         self._iter = ptr
         self._config = config
 
-    def __del__(self):
+    def __del__(self) -> None:
         C.git_config_iterator_free(self._iter)
 
-    def __iter__(self):
+    def __iter__(self) -> 'ConfigIterator':
         return self
 
-    def __next__(self):
+    def __next__(self) -> 'ConfigEntry':
         return self._next_entry()
 
-    def _next_entry(self):
+    def _next_entry(self) -> 'ConfigEntry':
         centry = ffi.new('git_config_entry **')
         err = C.git_config_next(centry, self._iter)
         check_error(err)
@@ -70,7 +71,7 @@ def _next_entry(self):
 
 
 class ConfigMultivarIterator(ConfigIterator):
-    def __next__(self):
+    def __next__(self) -> str:  # type: ignore[override]
         entry = self._next_entry()
         return entry.value
 
@@ -124,7 +125,7 @@ def _get_entry(self, key: str | bytes) -> 'ConfigEntry':
         check_error(err)
         return entry
 
-    def __contains__(self, key):
+    def __contains__(self, key: str | bytes) -> bool:
         err, cstr = self._get(key)
 
         if err == C.GIT_ENOTFOUND:
@@ -134,7 +135,7 @@ def __contains__(self, key):
 
         return True
 
-    def __getitem__(self, key):
+    def __getitem__(self, key: str | bytes) -> str:
         """
         When using the mapping interface, the value is returned as a string. In
         order to apply the git-config parsing rules, you can use
@@ -144,7 +145,7 @@ def __getitem__(self, key):
 
         return entry.value
 
-    def __setitem__(self, key, value):
+    def __setitem__(self, key: str | bytes, value: bool | int | str | bytes) -> None:
         key = str_to_bytes(key, 'key')
 
         err = 0
@@ -157,13 +158,13 @@ def __setitem__(self, key, value):
 
         check_error(err)
 
-    def __delitem__(self, key):
+    def __delitem__(self, key: str | bytes) -> None:
         key = str_to_bytes(key, 'key')
 
         err = C.git_config_delete_entry(self._config, key)
         check_error(err)
 
-    def __iter__(self):
+    def __iter__(self) -> Iterator['ConfigEntry']:
         """
         Iterate over configuration entries, returning a ``ConfigEntry``
         objects. These contain the name, level, and value of each configuration
@@ -176,22 +177,26 @@ def __iter__(self):
 
         return ConfigIterator(self, citer[0])
 
-    def get_multivar(self, name, regex=None):
+    def get_multivar(
+        self, name: str | bytes, regex: str | None = None
+    ) -> ConfigMultivarIterator:
         """Get each value of a multivar ''name'' as a list of strings.
 
         The optional ''regex'' parameter is expected to be a regular expression
         to filter the variables we're interested in.
         """
         name = str_to_bytes(name, 'name')
-        regex = to_bytes(regex or None)
+        regex_bytes = to_bytes(regex or None)
 
         citer = ffi.new('git_config_iterator **')
-        err = C.git_config_multivar_iterator_new(citer, self._config, name, regex)
+        err = C.git_config_multivar_iterator_new(citer, self._config, name, regex_bytes)
         check_error(err)
 
         return ConfigMultivarIterator(self, citer[0])
 
-    def set_multivar(self, name, regex, value):
+    def set_multivar(
+        self, name: str | bytes, regex: str | bytes, value: str | bytes
+    ) -> None:
         """Set a multivar ''name'' to ''value''. ''regexp'' is a regular
         expression to indicate which values to replace.
         """
@@ -202,7 +207,7 @@ def set_multivar(self, name, regex, value):
         err = C.git_config_set_multivar(self._config, name, regex, value)
         check_error(err)
 
-    def delete_multivar(self, name, regex):
+    def delete_multivar(self, name: str | bytes, regex: str | bytes) -> None:
         """Delete a multivar ''name''. ''regexp'' is a regular expression to
         indicate which values to delete.
         """
@@ -212,7 +217,7 @@ def delete_multivar(self, name, regex):
         err = C.git_config_delete_multivar(self._config, name, regex)
         check_error(err)
 
-    def get_bool(self, key):
+    def get_bool(self, key: str | bytes) -> bool:
         """Look up *key* and parse its value as a boolean as per the git-config
         rules. Return a boolean value (True or False).
 
@@ -227,7 +232,7 @@ def get_bool(self, key):
 
         return res[0] != 0
 
-    def get_int(self, key):
+    def get_int(self, key: bytes | str) -> int:
         """Look up *key* and parse its value as an integer as per the git-config
         rules. Return an integer.
 
@@ -242,15 +247,15 @@ def get_int(self, key):
 
         return res[0]
 
-    def add_file(self, path, level=0, force=0):
+    def add_file(self, path: str | Path, level: int = 0, force: int = 0) -> None:
         """Add a config file instance to an existing config."""
 
         err = C.git_config_add_file_ondisk(
             self._config, to_bytes(path), level, ffi.NULL, force
         )
         check_error(err)
 
-    def snapshot(self):
+    def snapshot(self) -> 'Config':
         """Create a snapshot from this Config object.
 
         This means that looking up multiple values will use the same version
@@ -267,15 +272,15 @@ def snapshot(self):
     #
 
     @staticmethod
-    def parse_bool(text):
+    def parse_bool(text: str) -> bool:
         res = ffi.new('int *')
         err = C.git_config_parse_bool(res, to_bytes(text))
         check_error(err)
 
         return res[0] != 0
 
     @staticmethod
-    def parse_int(text):
+    def parse_int(text: str) -> int:
         res = ffi.new('int64_t *')
         err = C.git_config_parse_int64(res, to_bytes(text))
         check_error(err)
@@ -287,7 +292,7 @@ def parse_int(text):
     #
 
     @staticmethod
-    def _from_found_config(fn):
+    def _from_found_config(fn: Callable) -> 'Config':
         buf = ffi.new('git_buf *', (ffi.NULL, 0))
         err = fn(buf)
         check_error(err, io=True)
@@ -297,17 +302,17 @@ def _from_found_config(fn):
         return Config(cpath)
 
     @staticmethod
-    def get_system_config():
+    def get_system_config() -> 'Config':
         """Return a <Config> object representing the system configuration file."""
         return Config._from_found_config(C.git_config_find_system)
 
     @staticmethod
-    def get_global_config():
+    def get_global_config() -> 'Config':
         """Return a <Config> object representing the global configuration file."""
         return Config._from_found_config(C.git_config_find_global)
 
     @staticmethod
-    def get_xdg_config():
+    def get_xdg_config() -> 'Config':
         """Return a <Config> object representing the global configuration file."""
         return Config._from_found_config(C.git_config_find_xdg)
 
@@ -349,7 +354,7 @@ def __del__(self) -> None:
             C.git_config_entry_free(self._entry)
 
     @property
-    def c_value(self):
+    def c_value(self) -> 'ffi.char_pointer':
         """The raw ``cData`` entry value."""
         return self._entry.value
 

pygit2/index.py

@@ -103,7 +103,7 @@ def __getitem__(self, key: str | int | PathLike[str]) -> 'IndexEntry':
     def __iter__(self):
         return GenericIterator(self)
 
-    def read(self, force=True):
+    def read(self, force: bool = True) -> None:
         """
         Update the contents of the Index by reading from a file.
 

pygit2/refspec.py

@@ -23,6 +23,8 @@
 # the Free Software Foundation, 51 Franklin Street, Fifth Floor,
 # Boston, MA 02110-1301, USA.
 
+from typing import Callable
+
 # Import from pygit2
 from .errors import check_error
 from .ffi import C, ffi
@@ -37,22 +39,22 @@ def __init__(self, owner, ptr):
         self._refspec = ptr
 
     @property
-    def src(self):
+    def src(self) -> str:
         """Source or lhs of the refspec"""
         return ffi.string(C.git_refspec_src(self._refspec)).decode('utf-8')
 
     @property
-    def dst(self):
+    def dst(self) -> str:
         """Destination or rhs of the refspec"""
         return ffi.string(C.git_refspec_dst(self._refspec)).decode('utf-8')
 
     @property
-    def force(self):
+    def force(self) -> bool:
         """Whether this refspeca llows non-fast-forward updates"""
         return bool(C.git_refspec_force(self._refspec))
 
     @property
-    def string(self):
+    def string(self) -> str:
         """String which was used to create this refspec"""
         return ffi.string(C.git_refspec_string(self._refspec)).decode('utf-8')
 
@@ -61,18 +63,18 @@ def direction(self):
         """Direction of this refspec (fetch or push)"""
         return C.git_refspec_direction(self._refspec)
 
-    def src_matches(self, ref):
+    def src_matches(self, ref: str) -> bool:
         """Return True if the given string matches the source of this refspec,
         False otherwise.
         """
         return bool(C.git_refspec_src_matches(self._refspec, to_bytes(ref)))
 
-    def dst_matches(self, ref):
+    def dst_matches(self, ref: str) -> bool:
         """Return True if the given string matches the destination of this
         refspec, False otherwise."""
         return bool(C.git_refspec_dst_matches(self._refspec, to_bytes(ref)))
 
-    def _transform(self, ref, fn):
+    def _transform(self, ref: str, fn: Callable) -> str:
         buf = ffi.new('git_buf *', (ffi.NULL, 0))
         err = fn(buf, self._refspec, to_bytes(ref))
         check_error(err)
@@ -82,13 +84,13 @@ def _transform(self, ref, fn):
         finally:
             C.git_buf_dispose(buf)
 
-    def transform(self, ref):
+    def transform(self, ref: str) -> str:
         """Transform a reference name according to this refspec from the lhs to
         the rhs. Return an string.
         """
         return self._transform(ref, C.git_refspec_transform)
 
-    def rtransform(self, ref):
+    def rtransform(self, ref: str) -> str:
         """Transform a reference name according to this refspec from the lhs to
         the rhs. Return an string.
         """

pygit2/remotes.py

@@ -246,7 +246,7 @@ def refspec_count(self):
 
         return C.git_remote_refspec_count(self._remote)
 
-    def get_refspec(self, n):
+    def get_refspec(self, n: int) -> Refspec:
         """Return the <Refspec> object at the given position."""
         spec = C.git_remote_get_refspec(self._remote, n)
         return Refspec(self, spec)