improve types according to test/test_submodule.py

Author: BenediktSeidl

pygit2/_pygit2.pyi

@@ -7,6 +7,7 @@ from .enums import (
     ApplyLocation,
     BranchType,
     BlobFilter,
+    CheckoutStrategy,
     DeltaStatus,
     DiffFind,
     DiffFlag,
@@ -25,7 +26,9 @@ from .enums import (
 from collections.abc import Generator
 
 from .repository import BaseRepository
+from .submodules import SubmoduleCollection, Submodule
 from .remotes import Remote
+from .callbacks import CheckoutCallbacks
 
 GIT_OBJ_BLOB = Literal[3]
 GIT_OBJ_COMMIT = Literal[1]
@@ -700,10 +703,12 @@ class Repository:
     references: References
     remotes: RemoteCollection
     branches: Branches
+    submodules: SubmoduleCollection
+    index: Index
     def __init__(self, *args, **kwargs) -> None: ...
     def TreeBuilder(self, src: Tree | _OidArg = ...) -> TreeBuilder: ...
     def _disown(self, *args, **kwargs) -> None: ...
-    def _from_c(self, *args, **kwargs) -> None: ...
+    def _from_c(self, *args, **kwargs) -> 'Repository': ...
     def __getitem__(self, key: str | Oid) -> Object: ...
     def add_worktree(self, name: str, path: str, ref: Reference = ...) -> Worktree: ...
     def applies(
@@ -715,6 +720,15 @@ class Repository:
     def apply(
         self, diff: Diff, location: ApplyLocation = ApplyLocation.WORKDIR
     ) -> None: ...
+    def checkout(
+        self,
+        refname: Optional[_OidArg],
+        *,
+        strategy: CheckoutStrategy | None = None,
+        directory: str | None = None,
+        paths: list[str] | None = None,
+        callbacks: CheckoutCallbacks | None = None,
+    ) -> None: ...
     def cherrypick(self, id: _OidArg) -> None: ...
     def compress_references(self) -> None: ...
     def create_blob(self, data: bytes) -> Oid: ...

pygit2/submodules.py

@@ -25,6 +25,7 @@
 
 from __future__ import annotations
 from typing import TYPE_CHECKING, Iterable, Iterator, Optional, Union
+from pathlib import Path
 
 from ._pygit2 import Oid
 from .callbacks import git_fetch_options, RemoteCallbacks
@@ -36,6 +37,7 @@
 # Need BaseRepository for type hints, but don't let it cause a circular dependency
 if TYPE_CHECKING:
     from .repository import BaseRepository
+    from pygit2 import Repository
 
 
 class Submodule:
@@ -51,18 +53,18 @@ def _from_c(cls, repo: BaseRepository, cptr):
 
         return subm
 
-    def __del__(self):
+    def __del__(self) -> None:
         C.git_submodule_free(self._subm)
 
-    def open(self):
+    def open(self) -> Repository:
         """Open the repository for a submodule."""
         crepo = ffi.new('git_repository **')
         err = C.git_submodule_open(crepo, self._subm)
         check_error(err)
 
         return self._repo._from_c(crepo[0], True)
 
-    def init(self, overwrite: bool = False):
+    def init(self, overwrite: bool = False) -> None:
         """
         Just like "git submodule init", this copies information about the submodule
         into ".git/config".
@@ -173,7 +175,7 @@ class SubmoduleCollection:
     def __init__(self, repository: BaseRepository):
         self._repository = repository
 
-    def __getitem__(self, name: str) -> Submodule:
+    def __getitem__(self, name: str | Path) -> Submodule:
         """
         Look up submodule information by name or path.
         Raises KeyError if there is no such submodule.

test/test_submodule.py

@@ -26,8 +26,10 @@
 """Tests for Submodule objects."""
 
 from pathlib import Path
+from typing import Generator
 
 import pygit2
+from pygit2 import Repository, Submodule
 import pytest
 
 from . import utils
@@ -42,48 +44,48 @@
 
 
 @pytest.fixture
-def repo(tmp_path):
+def repo(tmp_path: Path) -> Generator[Repository, None, None]:
     with utils.TemporaryRepository('submodulerepo.zip', tmp_path) as path:
         yield pygit2.Repository(path)
 
 
-def test_lookup_submodule(repo):
-    s = repo.submodules[SUBM_PATH]
+def test_lookup_submodule(repo: Repository) -> None:
+    s: Submodule | None = repo.submodules[SUBM_PATH]
     assert s is not None
     s = repo.submodules.get(SUBM_PATH)
     assert s is not None
 
 
-def test_lookup_submodule_aspath(repo):
+def test_lookup_submodule_aspath(repo: Repository) -> None:
     s = repo.submodules[Path(SUBM_PATH)]
     assert s is not None
 
 
-def test_lookup_missing_submodule(repo):
+def test_lookup_missing_submodule(repo: Repository) -> None:
     with pytest.raises(KeyError):
         repo.submodules['does-not-exist']
     assert repo.submodules.get('does-not-exist') is None
 
 
-def test_listall_submodules(repo):
+def test_listall_submodules(repo: Repository) -> None:
     submodules = repo.listall_submodules()
     assert len(submodules) == 1
     assert submodules[0] == SUBM_PATH
 
 
-def test_contains_submodule(repo):
+def test_contains_submodule(repo: Repository) -> None:
     assert SUBM_PATH in repo.submodules
     assert 'does-not-exist' not in repo.submodules
 
 
-def test_submodule_iterator(repo):
+def test_submodule_iterator(repo: Repository) -> None:
     for s in repo.submodules:
         assert isinstance(s, pygit2.Submodule)
         assert s.path == repo.submodules[s.path].path
 
 
 @utils.requires_network
-def test_submodule_open(repo):
+def test_submodule_open(repo: Repository) -> None:
     s = repo.submodules[SUBM_PATH]
     repo.submodules.init()
     repo.submodules.update()
@@ -93,7 +95,7 @@ def test_submodule_open(repo):
 
 
 @utils.requires_network
-def test_submodule_open_from_repository_subclass(repo):
+def test_submodule_open_from_repository_subclass(repo: Repository) -> None:
     class CustomRepoClass(pygit2.Repository):
         pass
 
@@ -106,22 +108,22 @@ class CustomRepoClass(pygit2.Repository):
     assert r.head.target == SUBM_HEAD_SHA
 
 
-def test_name(repo):
+def test_name(repo: Repository) -> None:
     s = repo.submodules[SUBM_PATH]
     assert SUBM_NAME == s.name
 
 
-def test_path(repo):
+def test_path(repo: Repository) -> None:
     s = repo.submodules[SUBM_PATH]
     assert SUBM_PATH == s.path
 
 
-def test_url(repo):
+def test_url(repo: Repository) -> None:
     s = repo.submodules[SUBM_PATH]
     assert SUBM_URL == s.url
 
 
-def test_missing_url(repo):
+def test_missing_url(repo: Repository) -> None:
     # Remove "url" from .gitmodules
     with open(Path(repo.workdir, '.gitmodules'), 'wt') as f:
         f.write('[submodule "TestGitRepository"]\n')
@@ -131,7 +133,7 @@ def test_missing_url(repo):
 
 
 @utils.requires_network
-def test_init_and_update(repo):
+def test_init_and_update(repo: Repository) -> None:
     subrepo_file_path = Path(repo.workdir) / SUBM_PATH / 'master.txt'
     assert not subrepo_file_path.exists()
 
@@ -148,7 +150,7 @@ def test_init_and_update(repo):
 
 
 @utils.requires_network
-def test_specified_update(repo):
+def test_specified_update(repo: Repository) -> None:
     subrepo_file_path = Path(repo.workdir) / SUBM_PATH / 'master.txt'
     assert not subrepo_file_path.exists()
     repo.submodules.init(submodules=['TestGitRepository'])
@@ -157,7 +159,7 @@ def test_specified_update(repo):
 
 
 @utils.requires_network
-def test_update_instance(repo):
+def test_update_instance(repo: Repository) -> None:
     subrepo_file_path = Path(repo.workdir) / SUBM_PATH / 'master.txt'
     assert not subrepo_file_path.exists()
     sm = repo.submodules['TestGitRepository']
@@ -168,7 +170,7 @@ def test_update_instance(repo):
 
 @utils.requires_network
 @pytest.mark.parametrize('depth', [0, 1])
-def test_oneshot_update(repo, depth):
+def test_oneshot_update(repo: Repository, depth: int) -> None:
     status = repo.submodules.status(SUBM_NAME)
     assert status == (SS.IN_HEAD | SS.IN_INDEX | SS.IN_CONFIG | SS.WD_UNINITIALIZED)
 
@@ -190,7 +192,7 @@ def test_oneshot_update(repo, depth):
 
 @utils.requires_network
 @pytest.mark.parametrize('depth', [0, 1])
-def test_oneshot_update_instance(repo, depth):
+def test_oneshot_update_instance(repo: Repository, depth: int) -> None:
     subrepo_file_path = Path(repo.workdir) / SUBM_PATH / 'master.txt'
     assert not subrepo_file_path.exists()
     sm = repo.submodules[SUBM_NAME]
@@ -206,12 +208,12 @@ def test_oneshot_update_instance(repo, depth):
 
 
 @utils.requires_network
-def test_head_id(repo):
+def test_head_id(repo: Repository) -> None:
     assert repo.submodules[SUBM_PATH].head_id == SUBM_HEAD_SHA
 
 
 @utils.requires_network
-def test_head_id_null(repo):
+def test_head_id_null(repo: Repository) -> None:
     gitmodules_newlines = (
         '\n'
         '[submodule "uncommitted_submodule"]\n'
@@ -230,7 +232,7 @@ def test_head_id_null(repo):
 
 @utils.requires_network
 @pytest.mark.parametrize('depth', [0, 1])
-def test_add_submodule(repo, depth):
+def test_add_submodule(repo: Repository, depth: int) -> None:
     sm_repo_path = 'test/testrepo'
     sm = repo.submodules.add(SUBM_URL, sm_repo_path, depth=depth)
 
@@ -250,7 +252,7 @@ def test_add_submodule(repo, depth):
 
 
 @utils.requires_network
-def test_submodule_status(repo):
+def test_submodule_status(repo: Repository) -> None:
     common_status = SS.IN_HEAD | SS.IN_INDEX | SS.IN_CONFIG
 
     # Submodule needs initializing
@@ -302,7 +304,7 @@ def test_submodule_status(repo):
     )
 
 
-def test_submodule_cache(repo):
+def test_submodule_cache(repo: Repository) -> None:
     # When the cache is turned on, looking up the same submodule twice must return the same git_submodule object
     repo.submodules.cache_all()
     sm1 = repo.submodules[SUBM_NAME]
@@ -317,7 +319,7 @@ def test_submodule_cache(repo):
     assert sm3._subm != sm4._subm
 
 
-def test_submodule_reload(repo):
+def test_submodule_reload(repo: Repository) -> None:
     sm = repo.submodules[SUBM_NAME]
     assert sm.url == 'https://github.com/libgit2/TestGitRepository'
 

test/utils.py

@@ -31,6 +31,8 @@
 import stat
 import sys
 import zipfile
+from typing import Optional
+from types import TracebackType
 
 # Requirements
 import pytest
@@ -94,11 +96,11 @@ def rmtree(path):
 
 
 class TemporaryRepository:
-    def __init__(self, name, tmp_path):
+    def __init__(self, name: str, tmp_path: Path) -> None:
         self.name = name
         self.tmp_path = tmp_path
 
-    def __enter__(self):
+    def __enter__(self) -> Path:
         path = Path(__file__).parent / 'data' / self.name
         temp_repo_path = Path(self.tmp_path) / path.stem
         if path.suffix == '.zip':
@@ -111,7 +113,12 @@ def __enter__(self):
 
         return temp_repo_path
 
-    def __exit__(self, exc_type, exc_value, traceback):
+    def __exit__(
+        self,
+        exc_type: Optional[type[BaseException]],
+        exc_value: Optional[BaseException],
+        traceback: Optional[TracebackType],
+    ) -> None:
         pass