improve types according to test/test_options.py

Author: BenediktSeidl

pygit2/_pygit2.pyi

@@ -36,6 +36,7 @@ from .enums import (
     BlobFilter,
     BranchType,
     CheckoutStrategy,
+    ConfigLevel,
     DeltaStatus,
     DescribeStrategy,
     DiffFind,
@@ -1078,7 +1079,79 @@ def discover_repository(
 def hash(data: bytes) -> Oid: ...
 def hashfile(path: str) -> Oid: ...
 def init_file_backend(path: str, flags: int = 0) -> object: ...
-def option(opt: Option, *args) -> None: ...
+@overload
+def option(
+    opt: Literal[
+        Option.GET_MWINDOW_FILE_LIMIT,
+        Option.GET_MWINDOW_MAPPED_LIMIT,
+        Option.GET_MWINDOW_SIZE,
+    ],
+) -> int: ...
+@overload
+def option(
+    opt: Literal[
+        Option.SET_MWINDOW_FILE_LIMIT,
+        Option.SET_MWINDOW_MAPPED_LIMIT,
+        Option.SET_MWINDOW_SIZE,
+    ],
+    value: int,
+) -> None: ...
+@overload
+def option(opt: Literal[Option.GET_SEARCH_PATH], level: ConfigLevel) -> str: ...
+@overload
+def option(
+    opt: Literal[Option.SET_SEARCH_PATH], level: ConfigLevel, value: str
+) -> None: ...
+@overload
+def option(
+    opt: Literal[Option.SET_CACHE_OBJECT_LIMIT], object_type: ObjectType, limit: int
+) -> None: ...
+@overload
+def option(opt: Literal[Option.SET_CACHE_MAX_SIZE], max_size: int) -> None: ...
+@overload
+def option(opt: Literal[Option.GET_CACHED_MEMORY]) -> tuple[int, int]: ...
+
+# not implemented:
+# Option.GET_TEMPLATE_PATH
+# Option.SET_TEMPLATE_PATH
+
+@overload
+def option(
+    opt: Literal[Option.SET_SSL_CERT_LOCATIONS],
+    file: str | bytes | None,
+    dir: str | bytes | None,
+) -> None: ...
+
+# not implemented:
+# Option.SET_USER_AGENT
+
+@overload
+def option(
+    opt: Literal[
+        Option.ENABLE_CACHING,
+        Option.ENABLE_STRICT_OBJECT_CREATION,
+        Option.ENABLE_STRICT_SYMBOLIC_REF_CREATION,
+        Option.ENABLE_OFS_DELTA,
+        Option.ENABLE_FSYNC_GITDIR,
+        Option.ENABLE_STRICT_HASH_VERIFICATION,
+        Option.ENABLE_UNSAVED_INDEX_SAFETY,
+        Option.DISABLE_PACK_KEEP_FILE_CHECKS,
+        Option.SET_OWNER_VALIDATION,
+    ],
+    value: bool,
+) -> None: ...
+@overload
+def option(opt: Literal[Option.GET_OWNER_VALIDATION]) -> int: ...
+
+# not implemented:
+# Option.SET_SSL_CIPHERS
+# Option.GET_USER_AGENT
+# Option.GET_WINDOWS_SHAREMODE
+# Option.SET_WINDOWS_SHAREMODE
+# Option.SET_ALLOCATOR
+# Option.GET_PACK_MAX_OBJECTS
+# Option.SET_PACK_MAX_OBJECTS
+
 def reference_is_valid_name(refname: str) -> bool: ...
 def tree_entry_cmp(a: Object, b: Object) -> int: ...
 def _cache_enums() -> None: ...

pygit2/settings.py

@@ -27,20 +27,21 @@
 Settings mapping.
 """
 
-from ssl import get_default_verify_paths
+from ssl import DefaultVerifyPaths, get_default_verify_paths
+from typing import overload
 
 import pygit2.enums
 
 from ._pygit2 import option
-from .enums import Option
+from .enums import ConfigLevel, Option
 from .errors import GitError
 
 
 class SearchPathList:
-    def __getitem__(self, key):
+    def __getitem__(self, key: ConfigLevel) -> str:
         return option(Option.GET_SEARCH_PATH, key)
 
-    def __setitem__(self, key, value):
+    def __setitem__(self, key: ConfigLevel, value: str) -> None:
         option(Option.SET_SEARCH_PATH, key, value)
 
 
@@ -50,12 +51,15 @@ class Settings:
     __slots__ = '_default_tls_verify_paths', '_ssl_cert_dir', '_ssl_cert_file'
 
     _search_path = SearchPathList()
+    _default_tls_verify_paths: DefaultVerifyPaths | None
+    _ssl_cert_file: str | bytes | None
+    _ssl_cert_dir: str | bytes | None
 
-    def __init__(self):
+    def __init__(self) -> None:
         """Initialize global pygit2 and libgit2 settings."""
         self._initialize_tls_certificate_locations()
 
-    def _initialize_tls_certificate_locations(self):
+    def _initialize_tls_certificate_locations(self) -> None:
         """Set up initial TLS file and directory lookup locations."""
         self._default_tls_verify_paths = get_default_verify_paths()
         try:
@@ -72,7 +76,7 @@ def _initialize_tls_certificate_locations(self):
             self._ssl_cert_dir = None
 
     @property
-    def search_path(self):
+    def search_path(self) -> SearchPathList:
         """Configuration file search path.
 
         This behaves like an array whose indices correspond to ConfigLevel values.
@@ -81,35 +85,35 @@ def search_path(self):
         return self._search_path
 
     @property
-    def mwindow_size(self):
+    def mwindow_size(self) -> int:
         """Get or set the maximum mmap window size"""
         return option(Option.GET_MWINDOW_SIZE)
 
     @mwindow_size.setter
-    def mwindow_size(self, value):
+    def mwindow_size(self, value: int) -> None:
         option(Option.SET_MWINDOW_SIZE, value)
 
     @property
-    def mwindow_mapped_limit(self):
+    def mwindow_mapped_limit(self) -> int:
         """
         Get or set the maximum memory that will be mapped in total by the
         library
         """
         return option(Option.GET_MWINDOW_MAPPED_LIMIT)
 
     @mwindow_mapped_limit.setter
-    def mwindow_mapped_limit(self, value):
+    def mwindow_mapped_limit(self, value: int) -> None:
         option(Option.SET_MWINDOW_MAPPED_LIMIT, value)
 
     @property
-    def cached_memory(self):
+    def cached_memory(self) -> tuple[int, int]:
         """
         Get the current bytes in cache and the maximum that would be
         allowed in the cache.
         """
         return option(Option.GET_CACHED_MEMORY)
 
-    def enable_caching(self, value=True):
+    def enable_caching(self, value: bool = True) -> None:
         """
         Enable or disable caching completely.
 
@@ -119,15 +123,15 @@ def enable_caching(self, value=True):
         """
         return option(Option.ENABLE_CACHING, value)
 
-    def disable_pack_keep_file_checks(self, value=True):
+    def disable_pack_keep_file_checks(self, value: bool = True) -> None:
         """
         This will cause .keep file existence checks to be skipped when
         accessing packfiles, which can help performance with remote
         filesystems.
         """
         return option(Option.DISABLE_PACK_KEEP_FILE_CHECKS, value)
 
-    def cache_max_size(self, value):
+    def cache_max_size(self, value: int) -> None:
         """
         Set the maximum total data size that will be cached in memory
         across all repositories before libgit2 starts evicting objects
@@ -137,7 +141,9 @@ def cache_max_size(self, value):
         """
         return option(Option.SET_CACHE_MAX_SIZE, value)
 
-    def cache_object_limit(self, object_type: pygit2.enums.ObjectType, value):
+    def cache_object_limit(
+        self, object_type: pygit2.enums.ObjectType, value: int
+    ) -> None:
         """
         Set the maximum data size for the given type of object to be
         considered eligible for caching in memory.  Setting to value to
@@ -148,36 +154,46 @@ def cache_object_limit(self, object_type: pygit2.enums.ObjectType, value):
         return option(Option.SET_CACHE_OBJECT_LIMIT, object_type, value)
 
     @property
-    def ssl_cert_file(self):
+    def ssl_cert_file(self) -> str | bytes | None:
         """TLS certificate file path."""
         return self._ssl_cert_file
 
     @ssl_cert_file.setter
-    def ssl_cert_file(self, value):
+    def ssl_cert_file(self, value: str | bytes) -> None:
         """Set the TLS cert file path."""
         self.set_ssl_cert_locations(value, self._ssl_cert_dir)
 
     @ssl_cert_file.deleter
-    def ssl_cert_file(self):
+    def ssl_cert_file(self) -> None:
         """Reset the TLS cert file path."""
-        self.ssl_cert_file = self._default_tls_verify_paths.cafile
+        self.ssl_cert_file = self._default_tls_verify_paths.cafile  # type: ignore[union-attr]
 
     @property
-    def ssl_cert_dir(self):
+    def ssl_cert_dir(self) -> str | bytes | None:
         """TLS certificates lookup directory path."""
         return self._ssl_cert_dir
 
     @ssl_cert_dir.setter
-    def ssl_cert_dir(self, value):
+    def ssl_cert_dir(self, value: str | bytes) -> None:
         """Set the TLS certificate lookup folder."""
         self.set_ssl_cert_locations(self._ssl_cert_file, value)
 
     @ssl_cert_dir.deleter
-    def ssl_cert_dir(self):
+    def ssl_cert_dir(self) -> None:
         """Reset the TLS certificate lookup folder."""
-        self.ssl_cert_dir = self._default_tls_verify_paths.capath
-
-    def set_ssl_cert_locations(self, cert_file, cert_dir):
+        self.ssl_cert_dir = self._default_tls_verify_paths.capath  # type: ignore[union-attr]
+
+    @overload
+    def set_ssl_cert_locations(
+        self, cert_file: str | bytes | None, cert_dir: str | bytes
+    ) -> None: ...
+    @overload
+    def set_ssl_cert_locations(
+        self, cert_file: str | bytes, cert_dir: str | bytes | None
+    ) -> None: ...
+    def set_ssl_cert_locations(
+        self, cert_file: str | bytes | None, cert_dir: str | bytes | None
+    ) -> None:
         """
         Set the SSL certificate-authority locations.
 

test/test_options.py

@@ -28,83 +28,83 @@
 from pygit2.enums import ConfigLevel, ObjectType, Option
 
 
-def __option(getter, setter, value):
-    old_value = option(getter)
-    option(setter, value)
-    assert value == option(getter)
+def __option(getter: Option, setter: Option, value: object) -> None:
+    old_value = option(getter)  # type: ignore[call-overload]
+    option(setter, value)  # type: ignore[call-overload]
+    assert value == option(getter)  # type: ignore[call-overload]
     # Reset to avoid side effects in later tests
-    option(setter, old_value)
+    option(setter, old_value)  # type: ignore[call-overload]
 
 
-def __proxy(name, value):
+def __proxy(name: str, value: object) -> None:
     old_value = getattr(pygit2.settings, name)
     setattr(pygit2.settings, name, value)
     assert value == getattr(pygit2.settings, name)
     # Reset to avoid side effects in later tests
     setattr(pygit2.settings, name, old_value)
 
 
-def test_mwindow_size():
+def test_mwindow_size() -> None:
     __option(Option.GET_MWINDOW_SIZE, Option.SET_MWINDOW_SIZE, 200 * 1024)
 
 
-def test_mwindow_size_proxy():
+def test_mwindow_size_proxy() -> None:
     __proxy('mwindow_size', 300 * 1024)
 
 
-def test_mwindow_mapped_limit_200():
+def test_mwindow_mapped_limit_200() -> None:
     __option(
         Option.GET_MWINDOW_MAPPED_LIMIT, Option.SET_MWINDOW_MAPPED_LIMIT, 200 * 1024
     )
 
 
-def test_mwindow_mapped_limit_300():
+def test_mwindow_mapped_limit_300() -> None:
     __proxy('mwindow_mapped_limit', 300 * 1024)
 
 
-def test_cache_object_limit():
+def test_cache_object_limit() -> None:
     new_limit = 2 * 1024
     option(Option.SET_CACHE_OBJECT_LIMIT, ObjectType.BLOB, new_limit)
 
 
-def test_cache_object_limit_proxy():
+def test_cache_object_limit_proxy() -> None:
     new_limit = 4 * 1024
     pygit2.settings.cache_object_limit(ObjectType.BLOB, new_limit)
 
 
-def test_cached_memory():
+def test_cached_memory() -> None:
     value = option(Option.GET_CACHED_MEMORY)
     assert value[1] == 256 * 1024**2
 
 
-def test_cached_memory_proxy():
+def test_cached_memory_proxy() -> None:
     assert pygit2.settings.cached_memory[1] == 256 * 1024**2
 
 
-def test_enable_caching():
+def test_enable_caching() -> None:
     pygit2.settings.enable_caching(False)
     pygit2.settings.enable_caching(True)
     # Lower level API
     option(Option.ENABLE_CACHING, False)
     option(Option.ENABLE_CACHING, True)
 
 
-def test_disable_pack_keep_file_checks():
+def test_disable_pack_keep_file_checks() -> None:
     pygit2.settings.disable_pack_keep_file_checks(False)
     pygit2.settings.disable_pack_keep_file_checks(True)
     # Lower level API
     option(Option.DISABLE_PACK_KEEP_FILE_CHECKS, False)
     option(Option.DISABLE_PACK_KEEP_FILE_CHECKS, True)
 
 
-def test_cache_max_size_proxy():
+def test_cache_max_size_proxy() -> None:
     pygit2.settings.cache_max_size(128 * 1024**2)
     assert pygit2.settings.cached_memory[1] == 128 * 1024**2
     pygit2.settings.cache_max_size(256 * 1024**2)
     assert pygit2.settings.cached_memory[1] == 256 * 1024**2
 
 
-def test_search_path():
+def test_search_path() -> None:
     paths = [
         (ConfigLevel.GLOBAL, '/tmp/global'),
         (ConfigLevel.XDG, '/tmp/xdg'),
@@ -116,7 +116,7 @@ def test_search_path():
         assert path == option(Option.GET_SEARCH_PATH, level)
 
 
-def test_search_path_proxy():
+def test_search_path_proxy() -> None:
     paths = [
         (ConfigLevel.GLOBAL, '/tmp2/global'),
         (ConfigLevel.XDG, '/tmp2/xdg'),
@@ -128,5 +128,5 @@ def test_search_path_proxy():
         assert path == pygit2.settings.search_path[level]
 
 
-def test_owner_validation():
+def test_owner_validation() -> None:
     __option(Option.GET_OWNER_VALIDATION, Option.SET_OWNER_VALIDATION, 0)