move types for References to implementation

Author: BenediktSeidl

pygit2/_pygit2.pyi

@@ -61,6 +61,7 @@ from .enums import (
 from .filter import Filter
 from .index import MergeFileResult
 from .packbuilder import PackBuilder
+from .references import References
 from .remotes import Remote
 from .repository import BaseRepository
 from .submodules import SubmoduleCollection
@@ -668,21 +669,6 @@ class RefdbBackend:
 class RefdbFsBackend(RefdbBackend):
     def __init__(self, *args, **kwargs) -> None: ...
 
-class References:
-    def __init__(self, repository: BaseRepository) -> None: ...
-    def __getitem__(self, name: str) -> Reference: ...
-    def get(self, key: str) -> Reference: ...
-    def __iter__(self) -> Iterator[str]: ...
-    def iterator(
-        self, references_return_type: ReferenceFilter = ...
-    ) -> Iterator[Reference]: ...
-    def create(self, name: str, target: _OidArg, force: bool = False) -> Reference: ...
-    def delete(self, name: str) -> None: ...
-    def __contains__(self, name: str) -> bool: ...
-    @property
-    def objects(self) -> list[Reference]: ...
-    def compress(self) -> None: ...
-
 _Proxy = None | Literal[True] | str
 
 class _StrArray:

pygit2/references.py

@@ -25,29 +25,32 @@
 
 from __future__ import annotations
 
-from typing import TYPE_CHECKING
+from typing import TYPE_CHECKING, Iterator
+
+from pygit2 import Oid
 
 from .enums import ReferenceFilter
 
 # Need BaseRepository for type hints, but don't let it cause a circular dependency
 if TYPE_CHECKING:
+    from ._pygit2 import Reference
     from .repository import BaseRepository
 
 
 class References:
-    def __init__(self, repository: BaseRepository):
+    def __init__(self, repository: BaseRepository) -> None:
         self._repository = repository
 
-    def __getitem__(self, name: str):
+    def __getitem__(self, name: str) -> 'Reference':
         return self._repository.lookup_reference(name)
 
-    def get(self, key: str):
+    def get(self, key: str) -> 'Reference':
         try:
             return self[key]
         except KeyError:
-            return None
+            return None  # type: ignore # will be corrected in next commit!
 
-    def __iter__(self):
+    def __iter__(self) -> Iterator[str]:
         iter = self._repository.references_iterator_init()
         while True:
             ref = self._repository.references_iterator_next(iter)
@@ -56,7 +59,9 @@ def __iter__(self):
             else:
                 return
 
-    def iterator(self, references_return_type: ReferenceFilter = ReferenceFilter.ALL):
+    def iterator(
+        self, references_return_type: ReferenceFilter = ReferenceFilter.ALL
+    ) -> Iterator['Reference']:
         """Creates a new iterator and fetches references for a given repository.
 
         Can also filter and pass all refs or only branches or only tags.
@@ -88,18 +93,18 @@ def iterator(self, references_return_type: ReferenceFilter = ReferenceFilter.ALL
             else:
                 return
 
-    def create(self, name, target, force=False):
+    def create(self, name: str, target: Oid | str, force: bool = False) -> 'Reference':
         return self._repository.create_reference(name, target, force)
 
-    def delete(self, name: str):
+    def delete(self, name: str) -> None:
         self[name].delete()
 
-    def __contains__(self, name: str):
+    def __contains__(self, name: str) -> bool:
         return self.get(name) is not None
 
     @property
-    def objects(self):
+    def objects(self) -> list['Reference']:
         return self._repository.listall_reference_objects()
 
-    def compress(self):
+    def compress(self) -> None:
         return self._repository.compress_references()

pygit2/repository.py

@@ -251,7 +251,13 @@ def config_snapshot(self):
     #
     # References
     #
-    def create_reference(self, name, target, force=False, message=None):
+    def create_reference(
+        self,
+        name: str,
+        target: Oid | str,
+        force: bool = False,
+        message: str | None = None,
+    ) -> 'Reference':
         """Create a new reference "name" which points to an object or to
         another reference.
 
@@ -273,12 +279,13 @@ def create_reference(self, name, target, force=False, message=None):
             repo.create_reference('refs/tags/foo', 'refs/heads/master')
             repo.create_reference('refs/tags/foo', 'bbb78a9cec580')
         """
-        direct = type(target) is Oid or (
+        direct = isinstance(target, Oid) or (
             all(c in hexdigits for c in target)
             and GIT_OID_MINPREFIXLEN <= len(target) <= GIT_OID_HEXSZ
         )
 
-        if direct:
+        # duplicate isinstance call for mypy
+        if direct or isinstance(target, Oid):
             return self.create_reference_direct(name, target, force, message=message)
 
         return self.create_reference_symbolic(name, target, force, message=message)