move types for Branches to implementation

Author: BenediktSeidl

pygit2/_pygit2.pyi

@@ -1,5 +1,4 @@
 import tarfile
-from collections.abc import Generator
 from io import DEFAULT_BUFFER_SIZE, IOBase
 from pathlib import Path
 from queue import Queue
@@ -28,6 +27,7 @@ from ._libgit2.ffi import (
     _Pointer,
 )
 from .blame import Blame
+from .branches import Branches
 from .callbacks import CheckoutCallbacks, StashApplyCallbacks
 from .config import Config
 from .enums import (
@@ -63,7 +63,6 @@ from .index import MergeFileResult
 from .packbuilder import PackBuilder
 from .references import References
 from .remotes import RemoteCollection
-from .repository import BaseRepository
 from .submodules import SubmoduleCollection
 
 GIT_OBJ_BLOB = Literal[3]
@@ -691,25 +690,6 @@ class _LsRemotesDict(TypedDict):
     symref_target: str | None
     oid: Oid
 
-class Branches:
-    local: 'Branches'
-    remote: 'Branches'
-    def __init__(
-        self,
-        repository: BaseRepository,
-        flag: BranchType = ...,
-        commit: Commit | _OidArg | None = None,
-    ) -> None: ...
-    def __getitem__(self, name: str) -> Branch: ...
-    def get(self, key: str) -> Branch: ...
-    def __iter__(self) -> Iterator[str]: ...
-    def create(
-        self, name: str, commit: Object | Commit, force: bool = False
-    ) -> Branch: ...
-    def delete(self, name: str) -> None: ...
-    def with_commit(self, commit: Object | Commit | _OidArg | None) -> 'Branches': ...
-    def __contains__(self, name: _OidArg) -> bool: ...
-
 class Repository:
     _pointer: GitRepositoryC
     _repo: GitRepositoryC

pygit2/branches.py

@@ -25,9 +25,9 @@
 
 from __future__ import annotations
 
-from typing import TYPE_CHECKING
+from typing import TYPE_CHECKING, Iterator
 
-from ._pygit2 import Commit, Oid
+from ._pygit2 import Branch, Commit, Oid
 from .enums import BranchType, ReferenceType
 
 # Need BaseRepository for type hints, but don't let it cause a circular dependency
@@ -36,9 +36,15 @@
 
 
 class Branches:
+    local: 'Branches'
+    remote: 'Branches'
+
     def __init__(
-        self, repository: BaseRepository, flag: BranchType = BranchType.ALL, commit=None
-    ):
+        self,
+        repository: BaseRepository,
+        flag: BranchType = BranchType.ALL,
+        commit: Commit | Oid | str | None = None,
+    ) -> None:
         self._repository = repository
         self._flag = flag
         if commit is not None:
@@ -52,7 +58,7 @@ def __init__(
             self.local = Branches(repository, flag=BranchType.LOCAL, commit=commit)
             self.remote = Branches(repository, flag=BranchType.REMOTE, commit=commit)
 
-    def __getitem__(self, name: str):
+    def __getitem__(self, name: str) -> Branch:
         branch = None
         if self._flag & BranchType.LOCAL:
             branch = self._repository.lookup_branch(name, BranchType.LOCAL)
@@ -65,36 +71,38 @@ def __getitem__(self, name: str):
 
         return branch
 
-    def get(self, key: str):
+    def get(self, key: str) -> Branch:
         try:
             return self[key]
         except KeyError:
-            return None
+            return None  # type:ignore #  next commit
 
-    def __iter__(self):
+    def __iter__(self) -> Iterator[str]:
         for branch_name in self._repository.listall_branches(self._flag):
             if self._commit is None or self.get(branch_name) is not None:
                 yield branch_name
 
-    def create(self, name: str, commit, force=False):
+    def create(self, name: str, commit: Commit, force: bool = False) -> Branch:
         return self._repository.create_branch(name, commit, force)
 
-    def delete(self, name: str):
+    def delete(self, name: str) -> None:
         self[name].delete()
 
-    def _valid(self, branch):
+    def _valid(self, branch: Branch) -> bool:
         if branch.type == ReferenceType.SYMBOLIC:
-            branch = branch.resolve()
+            branch_direct = branch.resolve()
+        else:
+            branch_direct = branch
 
         return (
             self._commit is None
-            or branch.target == self._commit
-            or self._repository.descendant_of(branch.target, self._commit)
+            or branch_direct.target == self._commit
+            or self._repository.descendant_of(branch_direct.target, self._commit)
         )
 
-    def with_commit(self, commit):
+    def with_commit(self, commit: Commit | Oid | str | None) -> 'Branches':
         assert self._commit is None
         return Branches(self._repository, self._flag, commit)
 
-    def __contains__(self, name):
+    def __contains__(self, name: str) -> bool:
         return self.get(name) is not None

pygit2/utils.py

@@ -28,8 +28,8 @@
 from types import TracebackType
 from typing import (
     TYPE_CHECKING,
-    Generic,
     Generator,
+    Generic,
     Iterator,
     Optional,
     Protocol,
@@ -46,7 +46,7 @@
     from ._libgit2.ffi import ArrayC, GitStrrayC, char, char_pointer
 
 
-def maybe_string(ptr: 'char_pointer' | None) -> str | None:
+def maybe_string(ptr: 'char_pointer | None') -> str | None:
     if not ptr:
         return None
 
@@ -106,7 +106,7 @@ def ptr_to_bytes(ptr_cdata):
 
 
 @contextlib.contextmanager
-def new_git_strarray() -> Generator[GitStrrayC, None, None]:
+def new_git_strarray() -> Generator['GitStrrayC', None, None]:
     strarray = ffi.new('git_strarray *')
     yield strarray
     C.git_strarray_dispose(strarray)

test/test_branch.py

@@ -58,6 +58,7 @@ def test_branches(testrepo: Repository) -> None:
 
 def test_branches_create(testrepo: Repository) -> None:
     commit = testrepo[LAST_COMMIT]
+    assert isinstance(commit, Commit)
     reference = testrepo.branches.create('version1', commit)
     assert 'version1' in testrepo.branches
     reference = testrepo.branches['version1']
@@ -142,7 +143,9 @@ def test_branches_with_commit(testrepo: Repository) -> None:
     branches = testrepo.branches.with_commit(LAST_COMMIT)
     assert sorted(branches) == ['master']
 
-    branches = testrepo.branches.with_commit(testrepo[LAST_COMMIT])
+    commit = testrepo[LAST_COMMIT]
+    assert isinstance(commit, Commit)
+    branches = testrepo.branches.with_commit(commit)
     assert sorted(branches) == ['master']
 
     branches = testrepo.branches.remote.with_commit(LAST_COMMIT)

test/test_branch_empty.py

@@ -58,7 +58,9 @@ def test_branches_remote_getitem(repo: Repository) -> None:
 
 def test_branches_upstream(repo: Repository) -> None:
     remote_master = repo.branches.remote['origin/master']
-    master = repo.branches.create('master', repo[remote_master.target])
+    commit = repo[remote_master.target]
+    assert isinstance(commit, Commit)
+    master = repo.branches.create('master', commit)
 
     assert master.upstream is None
     master.upstream = remote_master
@@ -76,7 +78,9 @@ def set_bad_upstream():
 
 def test_branches_upstream_name(repo: Repository) -> None:
     remote_master = repo.branches.remote['origin/master']
-    master = repo.branches.create('master', repo[remote_master.target])
+    commit = repo[remote_master.target]
+    assert isinstance(commit, Commit)
+    master = repo.branches.create('master', commit)
 
     master.upstream = remote_master
     assert master.upstream_name == 'refs/remotes/origin/master'

test/test_repository.py

@@ -906,6 +906,7 @@ def test_worktree_custom_ref(testrepo: Repository) -> None:
 
     # New branch based on head
     tip = testrepo.revparse_single('HEAD')
+    assert isinstance(tip, Commit)
     worktree_ref = testrepo.branches.create(branch_name, tip)
     # Delete temp path so that it's not present when we attempt to add the
     # worktree later