FazBrowse GitHub Viewer
|
Trending
|
URL:
|
Home
Tools:
[Download Repo ZIP]
[View Raw Code]
[Original HTTPS Page]
python-gitlab/gitlab/v4/objects/epics.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
/
epics.py
Copy path
More file actions
More file actions
Latest commit
History
History
History
118 lines (96 loc) · 3.92 KB
Breadcrumbs
python-gitlab
/
gitlab
/
v4
/
objects
/
epics.py
Copy path
File metadata and controls
118 lines (96 loc) · 3.92 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
from
__future__
import
annotations
from
typing
import
Any
,
TYPE_CHECKING
from
gitlab
import
exceptions
as
exc
from
gitlab
import
types
from
gitlab
.
base
import
RESTObject
from
gitlab
.
mixins
import
(
CreateMixin
,
CRUDMixin
,
DeleteMixin
,
ListMixin
,
ObjectDeleteMixin
,
SaveMixin
,
UpdateMixin
,
)
from
gitlab
.
types
import
RequiredOptional
from
.
events
import
GroupEpicResourceLabelEventManager
# noqa: F401
from
.
notes
import
GroupEpicNoteManager
# noqa: F401
__all__
=
[
"GroupEpic"
,
"GroupEpicManager"
,
"GroupEpicIssue"
,
"GroupEpicIssueManager"
]
class
GroupEpic
(
ObjectDeleteMixin
,
SaveMixin
,
RESTObject
):
_id_attr
=
"iid"
issues
:
GroupEpicIssueManager
resourcelabelevents
:
GroupEpicResourceLabelEventManager
notes
:
GroupEpicNoteManager
class
GroupEpicManager
(
CRUDMixin
[
GroupEpic
]):
_path
=
"/groups/{group_id}/epics"
_obj_cls
=
GroupEpic
_from_parent_attrs
=
{
"group_id"
:
"id"
}
_list_filters
=
(
"author_id"
,
"labels"
,
"order_by"
,
"sort"
,
"search"
)
_create_attrs
=
RequiredOptional
(
required
=
(
"title"
,),
optional
=
(
"labels"
,
"description"
,
"start_date"
,
"end_date"
),
)
_update_attrs
=
RequiredOptional
(
optional
=
(
"title"
,
"labels"
,
"description"
,
"start_date"
,
"end_date"
)
)
_types
=
{
"labels"
:
types
.
CommaSeparatedListAttribute
}
class
GroupEpicIssue
(
ObjectDeleteMixin
,
SaveMixin
,
RESTObject
):
_id_attr
=
"epic_issue_id"
# Define type for 'manager' here So mypy won't complain about
# 'self.manager.update()' call in the 'save' method.
manager
:
GroupEpicIssueManager
def
save
(
self
,
**
kwargs
:
Any
)
->
None
:
"""Save 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)
Raise:
GitlabAuthenticationError: If authentication is not correct
GitlabUpdateError: If the server cannot perform the request
"""
updated_data
=
self
.
_get_updated_data
()
# Nothing to update. Server fails if sent an empty dict.
if
not
updated_data
:
return
# call the manager
obj_id
=
self
.
encoded_id
self
.
manager
.
update
(
obj_id
,
updated_data
,
**
kwargs
)
class
GroupEpicIssueManager
(
ListMixin
[
GroupEpicIssue
],
CreateMixin
[
GroupEpicIssue
],
UpdateMixin
[
GroupEpicIssue
],
DeleteMixin
[
GroupEpicIssue
],
):
_path
=
"/groups/{group_id}/epics/{epic_iid}/issues"
_obj_cls
=
GroupEpicIssue
_from_parent_attrs
=
{
"group_id"
:
"group_id"
,
"epic_iid"
:
"iid"
}
_create_attrs
=
RequiredOptional
(
required
=
(
"issue_id"
,))
_update_attrs
=
RequiredOptional
(
optional
=
(
"move_before_id"
,
"move_after_id"
))
@
exc
.
on_http_error
(
exc
.
GitlabCreateError
)
def
create
(
self
,
data
:
dict
[
str
,
Any
]
|
None
=
None
,
**
kwargs
:
Any
)
->
GroupEpicIssue
:
"""Create a new object.
Args:
data: Parameters to send to the server to create the
resource
**kwargs: Extra options to send to the server (e.g. sudo)
Raises:
GitlabAuthenticationError: If authentication is not correct
GitlabCreateError: If the server cannot perform the request
Returns:
A new instance of the manage object class build with
the data sent by the server
"""
if
TYPE_CHECKING
:
assert
data
is
not
None
self
.
_create_attrs
.
validate_attrs
(
data
=
data
)
path
=
f"
{
self
.
path
}
/
{
data
.
pop
(
'issue_id'
)
}
"
server_data
=
self
.
gitlab
.
http_post
(
path
,
**
kwargs
)
if
TYPE_CHECKING
:
assert
isinstance
(
server_data
,
dict
)
# The epic_issue_id attribute doesn't exist when creating the resource,
# but is used everywhere elese. Let's create it to be consistent client
# side
server_data
[
"epic_issue_id"
]
=
server_data
[
"id"
]
return
self
.
_obj_cls
(
self
,
server_data
)
Back
|
FazBrowse Home
|
New Git URL