Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork966
Expand file tree
/
Copy pathtag.py
More file actions
126 lines (93 loc) · 4.17 KB
/
tag.py
File metadata and controls
126 lines (93 loc) · 4.17 KB
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
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
from .referenceimportReference
__all__= ["TagReference","Tag"]
# typing ------------------------------------------------------------------
fromtypingimportAny,Type,Union,TYPE_CHECKING
fromgit.typesimportCommit_ish,PathLike
ifTYPE_CHECKING:
fromgit.repoimportRepo
fromgit.objectsimportCommit
fromgit.objectsimportTagObject
fromgit.refsimportSymbolicReference
# ------------------------------------------------------------------------------
classTagReference(Reference):
"""Class representing a lightweight tag reference which either points to a commit
,a tag object or any other object. In the latter case additional information,
like the signature or the tag-creator, is available.
This tag object will always point to a commit object, but may carry additional
information in a tag object::
tagref = TagReference.list_items(repo)[0]
print(tagref.commit.message)
if tagref.tag is not None:
print(tagref.tag.message)"""
__slots__= ()
_common_default="tags"
_common_path_default=Reference._common_path_default+"/"+_common_default
@property
defcommit(self)->'Commit':# type: ignore[override] # LazyMixin has unrelated comit method
""":return: Commit object the tag ref points to
:raise ValueError: if the tag points to a tree or blob"""
obj=self.object
whileobj.type!='commit':
ifobj.type=="tag":
# it is a tag object which carries the commit as an object - we can point to anything
obj=obj.object
else:
raiseValueError(("Cannot resolve commit as tag %s points to a %s object - "+
"use the `.object` property instead to access it")% (self,obj.type))
returnobj
@property
deftag(self)->Union['TagObject',None]:
"""
:return: Tag object this tag ref points to or None in case
we are a light weight tag"""
obj=self.object
ifobj.type=="tag":
returnobj
returnNone
# make object read-only
# It should be reasonably hard to adjust an existing tag
# object = property(Reference._get_object)
@property
defobject(self)->Commit_ish:# type: ignore[override]
returnReference._get_object(self)
@classmethod
defcreate(cls:Type['TagReference'],repo:'Repo',path:PathLike,
reference:Union[str,'SymbolicReference']='HEAD',
logmsg:Union[str,None]=None,
force:bool=False,**kwargs:Any)->'TagReference':
"""Create a new tag reference.
:param path:
The name of the tag, i.e. 1.0 or releases/1.0.
The prefix refs/tags is implied
:param ref:
A reference to the Object you want to tag. The Object can be a commit, tree or
blob.
:param logmsg:
If not None, the message will be used in your tag object. This will also
create an additional tag object that allows to obtain that information, i.e.::
tagref.tag.message
:param message:
Synonym for :param logmsg:
Included for backwards compatability. :param logmsg is used in preference if both given.
:param force:
If True, to force creation of a tag even though that tag already exists.
:param kwargs:
Additional keyword arguments to be passed to git-tag
:return: A new TagReference"""
if'ref'inkwargsandkwargs['ref']:
reference=kwargs['ref']
iflogmsg:
kwargs['m']=logmsg
elif'message'inkwargsandkwargs['message']:
kwargs['m']=kwargs['message']
ifforce:
kwargs['f']=True
args= (path,reference)
repo.git.tag(*args,**kwargs)
returnTagReference(repo,"%s/%s"% (cls._common_path_default,path))
@classmethod
defdelete(cls,repo:'Repo',*tags:'TagReference')->None:# type: ignore[override]
"""Delete the given existing tag or tags"""
repo.git.tag("-d",*tags)
# provide an alias
Tag=TagReference