Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Return Python enums from Object.filemode and Reference.type #1273

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jdavid merged 2 commits into from
Jan 28, 2024
Merged

Return Python enums from Object.filemode and Reference.type #1273

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bdca78a
Return enums.FileMode from Object.filemode
jorio Jan 27, 2024
f1dba75
Return enums.ReferenceType from Reference.type
jorio Jan 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions pygit2/_pygit2.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ from .enums import (
ObjectType,
Option,
ReferenceFilter,
ReferenceType,
ResetMode,
SortMode,
)
Expand All @@ -34,7 +35,7 @@ LIBGIT2_VER_REVISION: int

class Object:
_pointer: bytes
filemode: int
filemode: FileMode
hex: str
id: Oid
name: str | None
Expand Down Expand Up @@ -69,7 +70,7 @@ class Reference:
raw_target: Oid | bytes
shorthand: str
target: Oid | str
type: int
type: ReferenceType
def __init__(self, *args) -> None: ...
def delete(self) -> None: ...
def log(self) -> Iterator[RefLogEntry]: ...
Expand Down
21 changes: 17 additions & 4 deletions pygit2/enums.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1004,10 +1004,23 @@ class ReferenceFilter(IntEnum):
class ReferenceType(IntFlag):
""" Basic type of any Git reference. """

INVALID = _pygit2.GIT_REF_INVALID
OID = _pygit2.GIT_REF_OID
SYMBOLIC = _pygit2.GIT_REF_SYMBOLIC
LISTALL = _pygit2.GIT_REF_LISTALL
INVALID = C.GIT_REFERENCE_INVALID
"Invalid reference"

DIRECT = C.GIT_REFERENCE_DIRECT
"A reference that points at an object id"

SYMBOLIC = C.GIT_REFERENCE_SYMBOLIC
"A reference that points at another reference"

ALL = C.GIT_REFERENCE_ALL
"Bitwise OR of (DIRECT | SYMBOLIC)"

# Deprecated entries
OID = DIRECT
"Deprecated, use DIRECT instead"
LISTALL = ALL
"Deprecated, use ALL instead"


class RepositoryInitFlag(IntFlag):
Expand Down
7 changes: 4 additions & 3 deletions src/object.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ extern PyTypeObject TreeType;
extern PyTypeObject CommitType;
extern PyTypeObject BlobType;
extern PyTypeObject TagType;
extern PyObject *FileModeEnum;

PyTypeObject ObjectType;

Expand Down Expand Up @@ -159,7 +160,7 @@ Object__pointer__get__(Object *self)
}

PyDoc_STRVAR(Object_name__doc__,
"Name (will be None if the object was not reached trough a tree)");
"Name (or None if the object was not reached through a tree)");
PyObject *
Object_name__get__(Object *self)
{
Expand All @@ -181,14 +182,14 @@ Object_raw_name__get__(Object *self)
}

PyDoc_STRVAR(Object_filemode__doc__,
"Filemode (will be None if the object was not reached trough a tree)");
"An enums.FileMode constant (or None if the object was not reached through a tree)");
PyObject *
Object_filemode__get__(Object *self)
{
if (self->entry == NULL)
Py_RETURN_NONE;

return PyLong_FromLong(git_tree_entry_filemode(self->entry));
return pygit2_enum(FileModeEnum, git_tree_entry_filemode(self->entry));
}


Expand Down
12 changes: 8 additions & 4 deletions src/pygit2.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ PyObject *FileModeEnum;
PyObject *FileStatusEnum;
PyObject *MergeAnalysisEnum;
PyObject *MergePreferenceEnum;
PyObject *ReferenceTypeEnum;

extern PyTypeObject RepositoryType;
extern PyTypeObject OdbType;
Expand Down Expand Up @@ -377,6 +378,7 @@ forget_enums(void)
Py_CLEAR(FileStatusEnum);
Py_CLEAR(MergeAnalysisEnum);
Py_CLEAR(MergePreferenceEnum);
Py_CLEAR(ReferenceTypeEnum);
}

PyDoc_STRVAR(_cache_enums__doc__,
Expand Down Expand Up @@ -411,6 +413,7 @@ _cache_enums(PyObject *self, PyObject *args)
CACHE_PYGIT2_ENUM(FileStatus);
CACHE_PYGIT2_ENUM(MergeAnalysis);
CACHE_PYGIT2_ENUM(MergePreference);
CACHE_PYGIT2_ENUM(ReferenceType);

#undef CACHE_PYGIT2_ENUM

Expand Down Expand Up @@ -606,13 +609,14 @@ PyInit__pygit2(void)
ADD_TYPE(m, Reference)
ADD_TYPE(m, RefLogEntry)
ADD_TYPE(m, Note)
ADD_CONSTANT_INT(m, GIT_REFERENCES_ALL)
ADD_CONSTANT_INT(m, GIT_REFERENCES_BRANCHES)
ADD_CONSTANT_INT(m, GIT_REFERENCES_TAGS)
/* libgit2 deprecated enums */
ADD_CONSTANT_INT(m, GIT_REF_INVALID)
ADD_CONSTANT_INT(m, GIT_REF_OID)
ADD_CONSTANT_INT(m, GIT_REF_SYMBOLIC)
ADD_CONSTANT_INT(m, GIT_REF_LISTALL)
ADD_CONSTANT_INT(m, GIT_REFERENCES_ALL)
ADD_CONSTANT_INT(m, GIT_REFERENCES_BRANCHES)
ADD_CONSTANT_INT(m, GIT_REFERENCES_TAGS)

/*
* RevSpec
Expand All @@ -622,7 +626,7 @@ PyInit__pygit2(void)
ADD_CONSTANT_INT(m, GIT_REVSPEC_SINGLE)
ADD_CONSTANT_INT(m, GIT_REVSPEC_RANGE)
ADD_CONSTANT_INT(m, GIT_REVSPEC_MERGE_BASE)
/* Deprecated enums */
/* libgit2 deprecated enums */
ADD_CONSTANT_INT(m, GIT_REVPARSE_SINGLE)
ADD_CONSTANT_INT(m, GIT_REVPARSE_RANGE)
ADD_CONSTANT_INT(m, GIT_REVPARSE_MERGE_BASE)
Expand Down
6 changes: 4 additions & 2 deletions src/reference.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ extern PyObject *GitError;
extern PyTypeObject RefLogEntryType;
extern PyTypeObject RepositoryType;
extern PyTypeObject SignatureType;
extern PyObject *ReferenceTypeEnum;

PyTypeObject ReferenceType;

Expand Down Expand Up @@ -424,7 +425,7 @@ Reference_raw_shorthand__get__(Reference *self)
}

PyDoc_STRVAR(Reference_type__doc__,
"Type, either GIT_REF_OID or GIT_REF_SYMBOLIC.");
"An enums.ReferenceType constant (either OID or SYMBOLIC).");

PyObject *
Reference_type__get__(Reference *self)
Expand All @@ -433,7 +434,8 @@ Reference_type__get__(Reference *self)

CHECK_REFERENCE(self);
c_type = git_reference_type(self->reference);
return PyLong_FromLong(c_type);

return pygit2_enum(ReferenceTypeEnum, c_type);
}


Expand Down
12 changes: 8 additions & 4 deletions test/test_refs.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,8 @@ def test_refs_set_sha_prefix(testrepo):

def test_refs_get_type(testrepo):
reference = testrepo.references.get('refs/heads/master')
assert reference.type == ReferenceType.OID
assert reference.type == ReferenceType.DIRECT
assert reference.type == ReferenceType.OID # deprecated

def test_refs_get_target(testrepo):
reference = testrepo.references.get('HEAD')
Expand Down Expand Up @@ -167,7 +168,8 @@ def test_refs_resolve(testrepo):
reference = testrepo.references.get('HEAD')
assert reference.type == ReferenceType.SYMBOLIC
reference = reference.resolve()
assert reference.type == ReferenceType.OID
assert reference.type == ReferenceType.DIRECT
assert reference.type == ReferenceType.OID # deprecated
assert reference.target.hex == LAST_COMMIT

def test_refs_resolve_identity(testrepo):
Expand Down Expand Up @@ -468,7 +470,8 @@ def test_reference_set_sha_prefix(testrepo):

def test_reference_get_type(testrepo):
reference = testrepo.lookup_reference('refs/heads/master')
assert reference.type == ReferenceType.OID
assert reference.type == ReferenceType.DIRECT
assert reference.type == ReferenceType.OID # deprecated

def test_get_target(testrepo):
reference = testrepo.lookup_reference('HEAD')
Expand Down Expand Up @@ -548,7 +551,8 @@ def test_reference_resolve(testrepo):
reference = testrepo.lookup_reference('HEAD')
assert reference.type == ReferenceType.SYMBOLIC
reference = reference.resolve()
assert reference.type == ReferenceType.OID
assert reference.type == ReferenceType.DIRECT
assert reference.type == ReferenceType.OID # deprecated
assert reference.target.hex == LAST_COMMIT

def test_reference_resolve_identity(testrepo):
Expand Down