FazBrowse GitHub Viewer
|
Trending
|
URL:
|
Home
Tools:
[Download Repo ZIP]
[View Raw Code]
[Original HTTPS Page]
python-gitlab/gitlab/v4/objects/labels.py at v7.1.0 · python-gitlab/python-gitlab · GitHub
python-gitlab
python-gitlab
Repository navigation
Code
Issues
16
(16)
Pull requests
15
(15)
Discussions
Actions
Projects
Security and quality
Insights
Expand file tree
Breadcrumbs
python-gitlab
/
gitlab
/
v4
/
objects
/
labels.py
Copy path
More file actions
More file actions
Latest commit
History
History
History
139 lines (114 loc) · 4.32 KB
Breadcrumbs
python-gitlab
/
gitlab
/
v4
/
objects
/
labels.py
Copy path
File metadata and controls
139 lines (114 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
139
from
__future__
import
annotations
from
typing
import
Any
from
gitlab
import
exceptions
as
exc
from
gitlab
.
base
import
RESTObject
from
gitlab
.
mixins
import
(
CreateMixin
,
DeleteMixin
,
ObjectDeleteMixin
,
PromoteMixin
,
RetrieveMixin
,
SaveMixin
,
SubscribableMixin
,
UpdateMixin
,
)
from
gitlab
.
types
import
RequiredOptional
__all__
=
[
"GroupLabel"
,
"GroupLabelManager"
,
"ProjectLabel"
,
"ProjectLabelManager"
]
class
GroupLabel
(
SubscribableMixin
,
SaveMixin
,
ObjectDeleteMixin
,
RESTObject
):
_id_attr
=
"name"
manager
:
GroupLabelManager
# Update without ID, but we need an ID to get from list.
@
exc
.
on_http_error
(
exc
.
GitlabUpdateError
)
def
save
(
self
,
**
kwargs
:
Any
)
->
None
:
"""Saves the changes made to the object to the server.
The object is updated to match what the server returns.
Args:
**kwargs: Extra options to send to the server (e.g. sudo)
Raises:
GitlabAuthenticationError: If authentication is not correct.
GitlabUpdateError: If the server cannot perform the request.
"""
updated_data
=
self
.
_get_updated_data
()
# call the manager
server_data
=
self
.
manager
.
update
(
None
,
updated_data
,
**
kwargs
)
self
.
_update_attrs
(
server_data
)
class
GroupLabelManager
(
RetrieveMixin
[
GroupLabel
],
CreateMixin
[
GroupLabel
],
UpdateMixin
[
GroupLabel
],
DeleteMixin
[
GroupLabel
],
):
_path
=
"/groups/{group_id}/labels"
_obj_cls
=
GroupLabel
_from_parent_attrs
=
{
"group_id"
:
"id"
}
_create_attrs
=
RequiredOptional
(
required
=
(
"name"
,
"color"
),
optional
=
(
"description"
,
"priority"
)
)
_update_attrs
=
RequiredOptional
(
required
=
(
"name"
,),
optional
=
(
"new_name"
,
"color"
,
"description"
,
"priority"
)
)
# Update without ID.
# NOTE(jlvillal): Signature doesn't match UpdateMixin.update() so ignore
# type error
def
update
(
# type: ignore[override]
self
,
name
:
str
|
None
,
new_data
:
dict
[
str
,
Any
]
|
None
=
None
,
**
kwargs
:
Any
)
->
dict
[
str
,
Any
]:
"""Update a Label on the server.
Args:
name: The name of the label
**kwargs: Extra options to send to the server (e.g. sudo)
"""
new_data
=
new_data
or
{}
if
name
:
new_data
[
"name"
]
=
name
return
super
().
update
(
id
=
None
,
new_data
=
new_data
,
**
kwargs
)
class
ProjectLabel
(
PromoteMixin
,
SubscribableMixin
,
SaveMixin
,
ObjectDeleteMixin
,
RESTObject
):
_id_attr
=
"name"
manager
:
ProjectLabelManager
# Update without ID, but we need an ID to get from list.
@
exc
.
on_http_error
(
exc
.
GitlabUpdateError
)
def
save
(
self
,
**
kwargs
:
Any
)
->
None
:
"""Saves the changes made to the object to the server.
The object is updated to match what the server returns.
Args:
**kwargs: Extra options to send to the server (e.g. sudo)
Raises:
GitlabAuthenticationError: If authentication is not correct.
GitlabUpdateError: If the server cannot perform the request.
"""
updated_data
=
self
.
_get_updated_data
()
# call the manager
server_data
=
self
.
manager
.
update
(
None
,
updated_data
,
**
kwargs
)
self
.
_update_attrs
(
server_data
)
class
ProjectLabelManager
(
RetrieveMixin
[
ProjectLabel
],
CreateMixin
[
ProjectLabel
],
UpdateMixin
[
ProjectLabel
],
DeleteMixin
[
ProjectLabel
],
):
_path
=
"/projects/{project_id}/labels"
_obj_cls
=
ProjectLabel
_from_parent_attrs
=
{
"project_id"
:
"id"
}
_create_attrs
=
RequiredOptional
(
required
=
(
"name"
,
"color"
),
optional
=
(
"description"
,
"priority"
)
)
_update_attrs
=
RequiredOptional
(
required
=
(
"name"
,),
optional
=
(
"new_name"
,
"color"
,
"description"
,
"priority"
)
)
# Update without ID.
# NOTE(jlvillal): Signature doesn't match UpdateMixin.update() so ignore
# type error
def
update
(
# type: ignore[override]
self
,
name
:
str
|
None
,
new_data
:
dict
[
str
,
Any
]
|
None
=
None
,
**
kwargs
:
Any
)
->
dict
[
str
,
Any
]:
"""Update a Label on the server.
Args:
name: The name of the label
**kwargs: Extra options to send to the server (e.g. sudo)
"""
new_data
=
new_data
or
{}
if
name
:
new_data
[
"name"
]
=
name
return
super
().
update
(
id
=
None
,
new_data
=
new_data
,
**
kwargs
)
Back
|
FazBrowse Home
|
New Git URL