improve types according to test/test_config.py

Author: BenediktSeidl

pygit2/_libgit2/ffi.pyi

@@ -120,8 +120,14 @@ class GitCommitC:
     pass
 
 class GitConfigC:
+    # incomplete
     pass
 
+class GitConfigEntryC:
+    # incomplete
+    name: char_pointer
+    level: int
+
 class GitDescribeFormatOptionsC:
     version: int
     abbreviated_size: int
@@ -229,6 +235,10 @@ def new(a: Literal['git_commit **']) -> _Pointer[GitCommitC]: ...
 @overload
 def new(a: Literal['git_config *']) -> GitConfigC: ...
 @overload
+def new(a: Literal['git_config **']) -> _Pointer[GitConfigC]: ...
+@overload
+def new(a: Literal['git_config_entry **']) -> _Pointer[GitConfigEntryC]: ...
+@overload
 def new(a: Literal['git_describe_format_options *']) -> GitDescribeFormatOptionsC: ...
 @overload
 def new(a: Literal['git_describe_options *']) -> GitDescribeOptionsC: ...

pygit2/_pygit2.pyi

@@ -27,6 +27,7 @@ from ._libgit2.ffi import (
 )
 from .blame import Blame
 from .callbacks import CheckoutCallbacks
+from .config import Config
 from .enums import (
     ApplyLocation,
     AttrCheck,
@@ -781,6 +782,8 @@ class Repository:
     ) -> None: ...
     def cherrypick(self, id: _OidArg) -> None: ...
     def compress_references(self) -> None: ...
+    @property
+    def config(self) -> Config: ...
     def create_blob(self, data: bytes) -> Oid: ...
     def create_blob_fromdisk(self, path: str) -> Oid: ...
     def create_blob_fromiobase(self, iobase: IOBase) -> Oid: ...

pygit2/config.py

@@ -23,6 +23,9 @@
 # the Free Software Foundation, 51 Franklin Street, Fifth Floor,
 # Boston, MA 02110-1301, USA.
 
+from os import PathLike
+from typing import TYPE_CHECKING
+
 try:
     from functools import cached_property
 except ImportError:
@@ -33,8 +36,11 @@
 from .ffi import C, ffi
 from .utils import to_bytes
 
+if TYPE_CHECKING:
+    from ._libgit2.ffi import GitConfigC, GitConfigEntryC, GitRepositoryC
+
 
-def str_to_bytes(value, name):
+def str_to_bytes(value: str | PathLike[str] | bytes, name: str) -> bytes:
     if not isinstance(value, str):
         raise TypeError(f'{name} must be a string')
 
@@ -72,41 +78,44 @@ def __next__(self):
 class Config:
     """Git configuration management."""
 
-    def __init__(self, path=None):
+    _repo: 'GitRepositoryC'
+    _config: 'GitConfigC'
+
+    def __init__(self, path: str | None = None) -> None:
         cconfig = ffi.new('git_config **')
 
         if not path:
             err = C.git_config_new(cconfig)
         else:
-            path = str_to_bytes(path, 'path')
-            err = C.git_config_open_ondisk(cconfig, path)
+            path_bytes = str_to_bytes(path, 'path')
+            err = C.git_config_open_ondisk(cconfig, path_bytes)
 
         check_error(err, io=True)
         self._config = cconfig[0]
 
     @classmethod
-    def from_c(cls, repo, ptr):
+    def from_c(cls, repo: 'GitRepositoryC', ptr: 'GitConfigC') -> 'Config':
         config = cls.__new__(cls)
         config._repo = repo
         config._config = ptr
 
         return config
 
-    def __del__(self):
+    def __del__(self) -> None:
         try:
             C.git_config_free(self._config)
         except AttributeError:
             pass
 
-    def _get(self, key):
+    def _get(self, key: str | bytes) -> tuple[object, 'ConfigEntry']:
         key = str_to_bytes(key, 'key')
 
         entry = ffi.new('git_config_entry **')
         err = C.git_config_get_entry(entry, self._config, key)
 
         return err, ConfigEntry._from_c(entry[0])
 
-    def _get_entry(self, key):
+    def _get_entry(self, key: str | bytes) -> 'ConfigEntry':
         err, entry = self._get(key)
 
         if err == C.GIT_ENOTFOUND:
@@ -306,8 +315,13 @@ def get_xdg_config():
 class ConfigEntry:
     """An entry in a configuration object."""
 
+    _entry: 'GitConfigEntryC'
+    iterator: ConfigIterator | None
+
     @classmethod
-    def _from_c(cls, ptr, iterator=None):
+    def _from_c(
+        cls, ptr: 'GitConfigEntryC', iterator: ConfigIterator | None = None
+    ) -> 'ConfigEntry':
         """Builds the entry from a ``git_config_entry`` pointer.
 
         ``iterator`` must be a ``ConfigIterator`` instance if the entry was
@@ -330,7 +344,7 @@ def _from_c(cls, ptr, iterator=None):
 
         return entry
 
-    def __del__(self):
+    def __del__(self) -> None:
         if self.iterator is None:
             C.git_config_entry_free(self._entry)
 
@@ -340,24 +354,24 @@ def c_value(self):
         return self._entry.value
 
     @cached_property
-    def raw_name(self):
+    def raw_name(self) -> bytes:
         return ffi.string(self._entry.name)
 
     @cached_property
-    def raw_value(self):
+    def raw_value(self) -> bytes:
         return ffi.string(self.c_value)
 
     @cached_property
-    def level(self):
+    def level(self) -> int:
         """The entry's ``git_config_level_t`` value."""
         return self._entry.level
 
     @property
-    def name(self):
+    def name(self) -> str:
         """The entry's name."""
         return self.raw_name.decode('utf-8')
 
     @property
-    def value(self):
+    def value(self) -> str:
         """The entry's value as a string."""
         return self.raw_value.decode('utf-8')

pygit2/utils.py

@@ -25,7 +25,7 @@
 
 import contextlib
 import os
-from typing import Generic, Iterator, Protocol, TypeVar, Union
+from typing import Generic, Iterator, Protocol, TypeVar, Union, overload
 
 # Import from pygit2
 from .ffi import C, ffi
@@ -38,6 +38,18 @@ def maybe_string(ptr):
     return ffi.string(ptr).decode('utf8', errors='surrogateescape')
 
 
+@overload
+def to_bytes(
+    s: Union[str, bytes, os.PathLike[str]],
+    encoding: str = 'utf-8',
+    errors: str = 'strict',
+) -> bytes: ...
+@overload
+def to_bytes(
+    s: Union['ffi.NULL_TYPE', None],
+    encoding: str = 'utf-8',
+    errors: str = 'strict',
+) -> Union['ffi.NULL_TYPE']: ...
 def to_bytes(
     s: Union[str, bytes, 'ffi.NULL_TYPE', os.PathLike[str], None],
     encoding: str = 'utf-8',

test/test_config.py

@@ -24,18 +24,19 @@
 # Boston, MA 02110-1301, USA.
 
 from pathlib import Path
+from typing import Generator
 
 import pytest
 
-from pygit2 import Config
+from pygit2 import Config, Repository
 
 from . import utils
 
 CONFIG_FILENAME = 'test_config'
 
 
 @pytest.fixture
-def config(testrepo):
+def config(testrepo: Repository) -> Generator[object, None, None]:
     yield testrepo.config
     try:
         Path(CONFIG_FILENAME).unlink()