Improve typing: add Branches to Repository

The following command
    mypy test
reports
    Found 280 errors in 8 files (checked 50 source files)
after this change.

Author: BenediktSeidl

pygit2/_pygit2.pyi

@@ -126,7 +126,7 @@ class Branch(Reference):
     def delete(self) -> None: ...
     def is_checked_out(self) -> bool: ...
     def is_head(self) -> bool: ...
-    def rename(self, name: str, force: bool = False) -> None: ...
+    def rename(self, name: str, force: bool = False) -> 'Branch': ...  # type: ignore[override]
 
 class Commit(Object):
     author: Signature
@@ -390,6 +390,23 @@ class RemoteCollection:
     def add_fetch(self, name: str, refspec: str) -> None: ...
     def add_push(self, name: str, refspec: str) -> None: ...
 
+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: Commit, force: bool = False) -> Branch: ...
+    def delete(self, name: str) -> None: ...
+    def with_commit(self, commit: Commit | _OidArg | None) -> 'Branches': ...
+    def __contains__(self, name: _OidArg) -> bool: ...
+
 class Repository:
     _pointer: bytes
     default_signature: Signature
@@ -405,6 +422,7 @@ class Repository:
     workdir: str
     references: References
     remotes: RemoteCollection
+    branches: Branches
     def __init__(self, *args, **kwargs) -> None: ...
     def TreeBuilder(self, src: Tree | _OidArg = ...) -> TreeBuilder: ...
     def _disown(self, *args, **kwargs) -> None: ...

test/test_branch.py

@@ -29,6 +29,7 @@
 import pytest
 import os
 from pygit2.enums import BranchType
+from pygit2 import Repository
 
 
 LAST_COMMIT = '2be5719152d4f82c7302b1c0932d8e5f0a4a0e98'
@@ -38,7 +39,7 @@
 SHARED_COMMIT = '4ec4389a8068641da2d6578db0419484972284c8'
 
 
-def test_branches_getitem(testrepo):
+def test_branches_getitem(testrepo: Repository) -> None:
     branch = testrepo.branches['master']
     assert branch.target == LAST_COMMIT
 
@@ -49,12 +50,12 @@ def test_branches_getitem(testrepo):
         testrepo.branches['not-exists']
 
 
-def test_branches(testrepo):
+def test_branches(testrepo: Repository) -> None:
     branches = sorted(testrepo.branches)
     assert branches == ['i18n', 'master']
 
 
-def test_branches_create(testrepo):
+def test_branches_create(testrepo: Repository) -> None:
     commit = testrepo[LAST_COMMIT]
     reference = testrepo.branches.create('version1', commit)
     assert 'version1' in testrepo.branches
@@ -70,53 +71,53 @@ def test_branches_create(testrepo):
     assert reference.target == LAST_COMMIT
 
 
-def test_branches_delete(testrepo):
+def test_branches_delete(testrepo: Repository) -> None:
     testrepo.branches.delete('i18n')
     assert testrepo.branches.get('i18n') is None
 
 
-def test_branches_delete_error(testrepo):
+def test_branches_delete_error(testrepo: Repository) -> None:
     with pytest.raises(pygit2.GitError):
         testrepo.branches.delete('master')
 
 
-def test_branches_is_head(testrepo):
+def test_branches_is_head(testrepo: Repository) -> None:
     branch = testrepo.branches.get('master')
     assert branch.is_head()
 
 
-def test_branches_is_not_head(testrepo):
+def test_branches_is_not_head(testrepo: Repository) -> None:
     branch = testrepo.branches.get('i18n')
     assert not branch.is_head()
 
 
-def test_branches_rename(testrepo):
+def test_branches_rename(testrepo: Repository) -> None:
     new_branch = testrepo.branches['i18n'].rename('new-branch')
     assert new_branch.target == I18N_LAST_COMMIT
 
     new_branch_2 = testrepo.branches.get('new-branch')
     assert new_branch_2.target == I18N_LAST_COMMIT
 
 
-def test_branches_rename_error(testrepo):
+def test_branches_rename_error(testrepo: Repository) -> None:
     original_branch = testrepo.branches.get('i18n')
     with pytest.raises(ValueError):
         original_branch.rename('master')
 
 
-def test_branches_rename_force(testrepo):
+def test_branches_rename_force(testrepo: Repository) -> None:
     original_branch = testrepo.branches.get('master')
     new_branch = original_branch.rename('i18n', True)
     assert new_branch.target == LAST_COMMIT
 
 
-def test_branches_rename_invalid(testrepo):
+def test_branches_rename_invalid(testrepo: Repository) -> None:
     original_branch = testrepo.branches.get('i18n')
     with pytest.raises(ValueError):
         original_branch.rename('abc@{123')
 
 
-def test_branches_name(testrepo):
+def test_branches_name(testrepo: Repository) -> None:
     branch = testrepo.branches.get('master')
     assert branch.branch_name == 'master'
     assert branch.name == 'refs/heads/master'
@@ -128,7 +129,7 @@ def test_branches_name(testrepo):
     assert branch.raw_branch_name == branch.branch_name.encode('utf-8')
 
 
-def test_branches_with_commit(testrepo):
+def test_branches_with_commit(testrepo: Repository) -> None:
     branches = testrepo.branches.with_commit(EXCLUSIVE_MASTER_COMMIT)
     assert sorted(branches) == ['master']
     assert branches.get('i18n') is None