Merge branch 'git-merge' of https://github.com/rohitsanj/pygit2 into git-merge

Author: rohitsanj

pygit2/_pygit2.pyi

@@ -155,6 +155,9 @@ GIT_REF_INVALID: int
 GIT_REF_LISTALL: int
 GIT_REF_OID: int
 GIT_REF_SYMBOLIC: int
+GIT_REFERENCES_ALL: int
+GIT_REFERENCES_BRANCHES: int
+GIT_REFERENCES_TAGS: int
 GIT_RESET_HARD: int
 GIT_RESET_MIXED: int
 GIT_RESET_SOFT: int
@@ -475,8 +478,6 @@ class Repository:
     def init_submodules(self, submodules: list[Submodule] = None, overwrite = False) -> None: ...
     def list_worktrees(self) -> list[str]: ...
     def listall_branches(self, flag: int = GIT_BRANCH_LOCAL) -> list[str]: ...
-    def listall_reference_objects(self) -> list[Reference]: ...
-    def listall_references(self) -> list[str]: ...
     def listall_stashes(self) -> list[Stash]: ...
     def listall_submodules(self) -> list[str]: ...
     def lookup_branch(self, branch_name: str, branch_type: int = GIT_BRANCH_LOCAL) -> Branch: ...
@@ -492,6 +493,8 @@ class Repository:
     def path_is_ignored(self, path: str) -> bool: ...
     def raw_listall_branches(self, flag: int = GIT_BRANCH_LOCAL) -> list[bytes]: ...
     def raw_listall_references(self) -> list[bytes]: ...
+    def references_iterator_init(self) -> Iterator[Reference]: ...
+    def references_iterator_next(self, iter: Iterator, references_return_type: int) -> Reference: ...
     def reset(self, oid: _OidArg, reset_type: int) -> None: ...
     def revparse(self, revspec: str) -> RevSpec: ...
     def revparse_ext(self, revision: str) -> tuple[Object,Reference]: ...

pygit2/repository.py

@@ -28,15 +28,17 @@
 from string import hexdigits
 import tarfile
 from time import time
+import typing
 import warnings
 
 # Import from pygit2
 from ._pygit2 import Repository as _Repository, init_file_backend
 from ._pygit2 import Oid, GIT_OID_HEXSZ, GIT_OID_MINPREFIXLEN
-from ._pygit2 import GIT_CHECKOUT_SAFE, GIT_CHECKOUT_RECREATE_MISSING, GIT_DIFF_NORMAL
+from ._pygit2 import GIT_DIFF_NORMAL
 from ._pygit2 import GIT_FILEMODE_LINK
 from ._pygit2 import GIT_BRANCH_LOCAL, GIT_BRANCH_REMOTE, GIT_BRANCH_ALL
 from ._pygit2 import GIT_REF_SYMBOLIC
+from ._pygit2 import GIT_REFERENCES_ALL, GIT_REFERENCES_BRANCHES, GIT_REFERENCES_TAGS
 from ._pygit2 import Reference, Tree, Commit, Blob, Signature
 from ._pygit2 import InvalidSpecError
 
@@ -47,7 +49,7 @@
 from .index import Index
 from .remote import RemoteCollection
 from .blame import Blame
-from .utils import to_bytes, StrArray
+from .utils import to_bytes
 from .submodule import Submodule
 from .packbuilder import PackBuilder
 
@@ -291,6 +293,16 @@ def create_reference(self, name, target, force=False, message=None):
         return self.create_reference_symbolic(name, target, force,
                                               message=message)
 
+    def listall_references(self) -> typing.List[str]:
+        """Return a list with all the references in the repository.
+        """
+        return list(x.name for x in self.references.iterator())
+
+    def listall_reference_objects(self) -> typing.List[Reference]:
+        """Return a list with all the reference objects in the repository.
+        """
+        return list(x for x in self.references.iterator())
+
     def resolve_refish(self, refish):
         """Convert a reference-like short name "ref-ish" to a valid
         (commit, reference) pair.
@@ -1624,8 +1636,42 @@ def get(self, key: str):
             return None
 
     def __iter__(self):
-        for ref_name in self._repository.listall_references():
-            yield ref_name
+        iter = self._repository.references_iterator_init()
+        while True:
+            ref = self._repository.references_iterator_next(iter)
+            if ref:
+                yield ref.name
+            else:
+                return
+
+    def iterator(self, references_return_type:int = GIT_REFERENCES_ALL):
+        """ Creates a new iterator and fetches references for a given repository.
+
+        Can also filter and pass all refs or only branches or only tags.
+
+        Parameters:
+
+        references_return_type: int
+            Optional specifier to filter references. By default, all references are
+            returned.
+
+            The following values are accepted:
+            0 -> GIT_REFERENCES_ALL, fetches all refs, this is the default
+            1 -> GIT_REFERENCES_BRANCHES, fetches only branches
+            2 -> GIT_REFERENCES_TAGS, fetches only tags
+
+        TODO: Add support for filtering by reference types notes and remotes.
+        """
+
+        if references_return_type not in (GIT_REFERENCES_ALL, GIT_REFERENCES_BRANCHES, GIT_REFERENCES_TAGS):
+            raise ValueError("Parameter references_return_type is invalid")
+        iter = self._repository.references_iterator_init()
+        while True:
+            ref = self._repository.references_iterator_next(iter, references_return_type)
+            if ref:
+                yield ref
+            else:
+                return
 
     def create(self, name, target, force=False):
         return self._repository.create_reference(name, target, force)

src/pygit2.c

@@ -79,6 +79,7 @@ extern PyTypeObject NoteIterType;
 extern PyTypeObject WorktreeType;
 extern PyTypeObject MailmapType;
 extern PyTypeObject StashType;
+extern PyTypeObject RefsIteratorType;
 
 
 PyDoc_STRVAR(discover_repository__doc__,
@@ -371,6 +372,7 @@ PyInit__pygit2(void)
     INIT_TYPE(TreeBuilderType, NULL, NULL)
     INIT_TYPE(BlobType, &ObjectType, NULL)
     INIT_TYPE(TagType, &ObjectType, NULL)
+    INIT_TYPE(RefsIteratorType, NULL, NULL)
     ADD_TYPE(m, Object)
     ADD_TYPE(m, Commit)
     ADD_TYPE(m, Signature)
@@ -431,6 +433,9 @@ PyInit__pygit2(void)
     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