1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
|
# Copyright 2010-2025 The pygit2 contributors
#
# This file is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License, version 2,
# as published by the Free Software Foundation.
#
# In addition to the permissions in the GNU General Public License,
# the authors give you unlimited permission to link the compiled
# version of this file into combinations with other programs,
# and to distribute those combinations without any restriction
# coming from the use of this file. (The General Public License
# restrictions do apply in other respects; for example, they cover
# modification of the file, and distribution when not linked into
# a combined executable.)
#
# This file is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; see the file COPYING. If not, write to
# the Free Software Foundation, 51 Franklin Street, Fifth Floor,
# Boston, MA 02110-1301, USA.
from __future__ import annotations
from typing import TYPE_CHECKING
from .enums import ReferenceFilter
# Need BaseRepository for type hints, but don't let it cause a circular dependency
if TYPE_CHECKING:
from .repository import BaseRepository
class References:
def __init__(self, repository: BaseRepository):
self._repository = repository
def __getitem__(self, name: str):
return self._repository.lookup_reference(name)
def get(self, key: str):
try:
return self[key]
except KeyError:
return None
def __iter__(self):
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: ReferenceFilter = ReferenceFilter.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: ReferenceFilter
Optional specifier to filter references. By default, all references are
returned.
The following values are accepted:
- ReferenceFilter.ALL, fetches all refs, this is the default
- ReferenceFilter.BRANCHES, fetches only branches
- ReferenceFilter.TAGS, fetches only tags
TODO: Add support for filtering by reference types notes and remotes.
"""
# Enforce ReferenceFilter type - raises ValueError if we're given an invalid value
references_return_type = ReferenceFilter(references_return_type)
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)
def delete(self, name: str):
self[name].delete()
def __contains__(self, name: str):
return self.get(name) is not None
@property
def objects(self):
return self._repository.listall_reference_objects()
def compress(self):
return self._repository.compress_references()
|
