Add enum RevSpecFlags

libgit2 · Nov 22, 2023 · 983fef5 · 983fef5
1 parent b6f0af8
commit 983fef5
Show file tree

Hide file tree

Showing 7 changed files with 29 additions and 11 deletions.
diff --git a/docs/revparse.rst b/docs/revparse.rst
@@ -16,6 +16,6 @@ You can use any of the fancy `<rev>` forms supported by libgit2::
 
 Constants:
 
-.. py:data:: GIT_REVPARSE_SINGLE
-.. py:data:: GIT_REVPARSE_RANGE
-.. py:data:: GIT_REVPARSE_MERGE_BASE
+.. py:data:: RevparseFlags.SINGLE
+.. py:data:: RevparseFlags.RANGE
+.. py:data:: RevparseFlags.MERGE_BASE
diff --git a/pygit2/__init__.py b/pygit2/__init__.py
@@ -69,6 +69,7 @@
     RepositoryOpenFlags,
     RepositoryState,
     ResetType,
+    RevSpecFlags,
     StashApplyProgress,
     StatusFlags,
     SubmoduleIgnore,

diff --git a/pygit2/_pygit2.pyi b/pygit2/_pygit2.pyi
@@ -22,9 +22,6 @@ GIT_OID_HEXSZ: int
 GIT_OID_HEX_ZERO: str
 GIT_OID_MINPREFIXLEN: int
 GIT_OID_RAWSZ: int
-GIT_REVPARSE_MERGE_BASE: int
-GIT_REVPARSE_RANGE: int
-GIT_REVPARSE_SINGLE: int
 LIBGIT2_VERSION: str
 LIBGIT2_VER_MAJOR: int
 LIBGIT2_VER_MINOR: int

diff --git a/pygit2/enums.py b/pygit2/enums.py
@@ -928,6 +928,22 @@ class ResetType(IntEnum):
     "MIXED plus changes in working tree discarded"
 
 
+class RevSpecFlags(IntFlag):
+    """
+    Revparse flags.
+    These indicate the intended behavior of the spec passed to Repository.revparse()
+    """
+
+    SINGLE = _pygit2.GIT_REVSPEC_SINGLE
+    "The spec targeted a single object."
+
+    RANGE = _pygit2.GIT_REVSPEC_RANGE
+    "The spec targeted a range of commits."
+
+    MERGE_BASE = _pygit2.GIT_REVSPEC_MERGE_BASE
+    "The spec used the '...' operator, which invokes special semantics."
+
+
 class StatusFlags(IntFlag):
     """
     Status flags for a single file.

diff --git a/src/pygit2.c b/src/pygit2.c
@@ -551,6 +551,10 @@ PyInit__pygit2(void)
      */
     INIT_TYPE(RevSpecType, NULL, NULL)
     ADD_TYPE(m, RevSpec)
+    ADD_CONSTANT_INT(m, GIT_REVSPEC_SINGLE)
+    ADD_CONSTANT_INT(m, GIT_REVSPEC_RANGE)
+    ADD_CONSTANT_INT(m, GIT_REVSPEC_MERGE_BASE)
+    /* Deprecated enums */
     ADD_CONSTANT_INT(m, GIT_REVPARSE_SINGLE)
     ADD_CONSTANT_INT(m, GIT_REVPARSE_RANGE)
     ADD_CONSTANT_INT(m, GIT_REVPARSE_MERGE_BASE)

diff --git a/src/revspec.c b/src/revspec.c
@@ -84,7 +84,7 @@ RevSpec_to_object__get__(RevSpec *self)
 }
 
 PyDoc_STRVAR(RevSpec_flags__doc__,
-    "A combination of GIT_REVPARSE_* flags which indicate the\n"
+    "A combination of RevSpecFlags which indicate the\n"
     "intended behavior of the spec passed to Repository.revparse()");
 
 PyObject *

diff --git a/test/test_revparse.py b/test/test_revparse.py
@@ -25,7 +25,7 @@
 
 """Tests for revision parsing."""
 
-from pygit2 import GIT_REVPARSE_SINGLE, GIT_REVPARSE_RANGE, GIT_REVPARSE_MERGE_BASE, InvalidSpecError
+from pygit2 import RevSpecFlags, InvalidSpecError
 from pytest import raises
 
 HEAD_SHA = '2be5719152d4f82c7302b1c0932d8e5f0a4a0e98'
@@ -61,21 +61,21 @@ def test_revparse_1(testrepo):
     s = testrepo.revparse('master')
     assert s.from_object.hex == HEAD_SHA
     assert s.to_object is None
-    assert s.flags == GIT_REVPARSE_SINGLE
+    assert s.flags == RevSpecFlags.SINGLE
 
 
 def test_revparse_range_1(testrepo):
     s = testrepo.revparse('HEAD^1..acecd5e')
     assert s.from_object.hex == PARENT_SHA
     assert s.to_object.hex.startswith('acecd5e')
-    assert s.flags == GIT_REVPARSE_RANGE
+    assert s.flags == RevSpecFlags.RANGE
 
 
 def test_revparse_range_2(testrepo):
     s = testrepo.revparse('HEAD...i18n')
     assert s.from_object.hex.startswith('2be5719')
     assert s.to_object.hex.startswith('5470a67')
-    assert s.flags == GIT_REVPARSE_RANGE | GIT_REVPARSE_MERGE_BASE
+    assert s.flags == RevSpecFlags.RANGE | RevSpecFlags.MERGE_BASE
     assert testrepo.merge_base(s.from_object.id, s.to_object.id) is not None