improve types according to test/test_describe.py

Author: BenediktSeidl

pygit2/_pygit2.pyi

@@ -36,6 +36,7 @@ from .enums import (
     BranchType,
     CheckoutStrategy,
     DeltaStatus,
+    DescribeStrategy,
     DiffFind,
     DiffFlag,
     DiffOption,
@@ -842,6 +843,18 @@ class Repository:
         interhunk_lines: int = 0,
     ) -> Diff: ...
     def descendant_of(self, oid1: _OidArg, oid2: _OidArg) -> bool: ...
+    def describe(
+        self,
+        committish: str | Reference | Commit | None = None,
+        max_candidates_tags: int | None = None,
+        describe_strategy: DescribeStrategy = DescribeStrategy.DEFAULT,
+        pattern: str | None = None,
+        only_follow_first_parent: bool | None = None,
+        show_commit_oid_as_fallback: bool | None = None,
+        abbreviated_size: object | None = None,
+        always_use_long_format: bool | None = None,
+        dirty_suffix: str | None = None,
+    ) -> str: ...
     def expand_id(self, hex: str) -> Oid: ...
     def free(self) -> None: ...
     def get(self, key: _OidArg, default: Optional[Commit] = None) -> None | Object: ...

test/test_describe.py

@@ -28,32 +28,33 @@
 import pytest
 
 import pygit2
+from pygit2 import Oid, Repository
 from pygit2.enums import DescribeStrategy, ObjectType
 
 
-def add_tag(repo, name, target):
+def add_tag(repo: Repository, name: str, target: str) -> Oid:
     message = 'Example tag.\n'
     tagger = pygit2.Signature('John Doe', 'jdoe@example.com', 12347, 0)
 
     sha = repo.create_tag(name, target, ObjectType.COMMIT, tagger, message)
     return sha
 
 
-def test_describe(testrepo):
+def test_describe(testrepo: Repository) -> None:
     add_tag(testrepo, 'thetag', '4ec4389a8068641da2d6578db0419484972284c8')
     assert 'thetag-2-g2be5719' == testrepo.describe()
 
 
-def test_describe_without_ref(testrepo):
+def test_describe_without_ref(testrepo: Repository) -> None:
     with pytest.raises(pygit2.GitError):
         testrepo.describe()
 
 
-def test_describe_default_oid(testrepo):
+def test_describe_default_oid(testrepo: Repository) -> None:
     assert '2be5719' == testrepo.describe(show_commit_oid_as_fallback=True)
 
 
-def test_describe_strategies(testrepo):
+def test_describe_strategies(testrepo: Repository) -> None:
     assert 'heads/master' == testrepo.describe(describe_strategy=DescribeStrategy.ALL)
 
     testrepo.create_reference(
@@ -66,14 +67,14 @@ def test_describe_strategies(testrepo):
     )
 
 
-def test_describe_pattern(testrepo):
+def test_describe_pattern(testrepo: Repository) -> None:
     add_tag(testrepo, 'private/tag1', '5ebeeebb320790caf276b9fc8b24546d63316533')
     add_tag(testrepo, 'public/tag2', '4ec4389a8068641da2d6578db0419484972284c8')
 
     assert 'public/tag2-2-g2be5719' == testrepo.describe(pattern='public/*')
 
 
-def test_describe_committish(testrepo):
+def test_describe_committish(testrepo: Repository) -> None:
     add_tag(testrepo, 'thetag', 'acecd5ea2924a4b900e7e149496e1f4b57976e51')
     assert 'thetag-4-g2be5719' == testrepo.describe(committish='HEAD')
     assert 'thetag-1-g5ebeeeb' == testrepo.describe(committish='HEAD^')
@@ -86,28 +87,28 @@ def test_describe_committish(testrepo):
     assert 'thetag-1-g6aaa262' == testrepo.describe(committish='6aaa262')
 
 
-def test_describe_follows_first_branch_only(testrepo):
+def test_describe_follows_first_branch_only(testrepo: Repository) -> None:
     add_tag(testrepo, 'thetag', '4ec4389a8068641da2d6578db0419484972284c8')
     with pytest.raises(KeyError):
         testrepo.describe(only_follow_first_parent=True)
 
 
-def test_describe_abbreviated_size(testrepo):
+def test_describe_abbreviated_size(testrepo: Repository) -> None:
     add_tag(testrepo, 'thetag', '4ec4389a8068641da2d6578db0419484972284c8')
     assert 'thetag-2-g2be5719152d4f82c' == testrepo.describe(abbreviated_size=16)
     assert 'thetag' == testrepo.describe(abbreviated_size=0)
 
 
-def test_describe_long_format(testrepo):
+def test_describe_long_format(testrepo: Repository) -> None:
     add_tag(testrepo, 'thetag', '2be5719152d4f82c7302b1c0932d8e5f0a4a0e98')
     assert 'thetag-0-g2be5719' == testrepo.describe(always_use_long_format=True)
 
 
-def test_describe_dirty(dirtyrepo):
+def test_describe_dirty(dirtyrepo: Repository) -> None:
     add_tag(dirtyrepo, 'thetag', 'a763aa560953e7cfb87ccbc2f536d665aa4dff22')
     assert 'thetag' == dirtyrepo.describe()
 
 
-def test_describe_dirty_with_suffix(dirtyrepo):
+def test_describe_dirty_with_suffix(dirtyrepo: Repository) -> None:
     add_tag(dirtyrepo, 'thetag', 'a763aa560953e7cfb87ccbc2f536d665aa4dff22')
     assert 'thetag-dirty' == dirtyrepo.describe(dirty_suffix='-dirty')