FazBrowse GitHub Viewer
|
Trending
|
URL:
|
Home
Tools:
[Download Repo ZIP]
[View Raw Code]
[Original HTTPS Page]
GitPython/git/refs/tag.py at main · CoderboticsAI/GitPython · GitHub
CoderboticsAI
GitPython
Repository navigation
Code
Pull requests
Actions
Projects
Security and quality
Insights
Expand file tree
Breadcrumbs
GitPython
/
git
/
refs
/
tag.py
Copy path
More file actions
More file actions
Latest commit
History
History
History
138 lines (104 loc) · 4.32 KB
Breadcrumbs
GitPython
/
git
/
refs
/
tag.py
Copy path
File metadata and controls
138 lines (104 loc) · 4.32 KB
Raw
Copy raw file
Download raw file
Open symbols panel
Edit and raw actions
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
127
128
129
130
131
132
133
134
135
136
137
138
from
.
reference
import
Reference
__all__
=
[
"TagReference"
,
"Tag"
]
# typing ------------------------------------------------------------------
from
typing
import
Any
,
Type
,
Union
,
TYPE_CHECKING
from
git
.
types
import
Commit_ish
,
PathLike
if
TYPE_CHECKING
:
from
git
.
repo
import
Repo
from
git
.
objects
import
Commit
from
git
.
objects
import
TagObject
from
git
.
refs
import
SymbolicReference
# ------------------------------------------------------------------------------
class
TagReference
(
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
def
commit
(
self
)
->
"Commit"
:
# type: ignore[override] # LazyMixin has unrelated commit method
""":return: Commit object the tag ref points to
:raise ValueError: if the tag points to a tree or blob"""
obj
=
self
.
object
while
obj
.
type
!=
"commit"
:
if
obj
.
type
==
"tag"
:
# it is a tag object which carries the commit as an object - we can point to anything
obj
=
obj
.
object
else
:
raise
ValueError
(
(
"Cannot resolve commit as tag %s points to a %s object - "
+
"use the `.object` property instead to access it"
)
%
(
self
,
obj
.
type
)
)
return
obj
@
property
def
tag
(
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
if
obj
.
type
==
"tag"
:
return
obj
return
None
# make object read-only
# It should be reasonably hard to adjust an existing tag
# object = property(Reference._get_object)
@
property
def
object
(
self
)
->
Commit_ish
:
# type: ignore[override]
return
Reference
.
_get_object
(
self
)
@
classmethod
def
create
(
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 compatibility. :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"
in
kwargs
and
kwargs
[
"ref"
]:
reference
=
kwargs
[
"ref"
]
if
"message"
in
kwargs
and
kwargs
[
"message"
]:
kwargs
[
"m"
]
=
kwargs
[
"message"
]
del
kwargs
[
"message"
]
if
logmsg
:
kwargs
[
"m"
]
=
logmsg
if
force
:
kwargs
[
"f"
]
=
True
args
=
(
path
,
reference
)
repo
.
git
.
tag
(
*
args
,
**
kwargs
)
return
TagReference
(
repo
,
"%s/%s"
%
(
cls
.
_common_path_default
,
path
))
@
classmethod
def
delete
(
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
Back
|
FazBrowse Home
|
New Git URL