FazBrowse GitHub Viewer
|
Trending
|
URL:
|
Home
Tools:
[Download Repo ZIP]
[View Raw Code]
[Original HTTPS Page]
python-gitlab/gitlab/v4/objects/jobs.py at main · muya/python-gitlab · GitHub
muya
python-gitlab
Repository navigation
Code
Pull requests
Actions
Projects
Security and quality
Insights
Expand file tree
Breadcrumbs
python-gitlab
/
gitlab
/
v4
/
objects
/
jobs.py
Copy path
More file actions
More file actions
Latest commit
History
History
History
252 lines (215 loc) · 8.93 KB
Breadcrumbs
python-gitlab
/
gitlab
/
v4
/
objects
/
jobs.py
Copy path
File metadata and controls
252 lines (215 loc) · 8.93 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
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
from
typing
import
Any
,
Callable
,
cast
,
Dict
,
Iterator
,
Optional
,
TYPE_CHECKING
,
Union
import
requests
from
gitlab
import
cli
from
gitlab
import
exceptions
as
exc
from
gitlab
import
utils
from
gitlab
.
base
import
RESTManager
,
RESTObject
from
gitlab
.
mixins
import
RefreshMixin
,
RetrieveMixin
from
gitlab
.
types
import
ArrayAttribute
__all__
=
[
"ProjectJob"
,
"ProjectJobManager"
,
]
class
ProjectJob
(
RefreshMixin
,
RESTObject
):
@
cli
.
register_custom_action
(
cls_names
=
"ProjectJob"
)
@
exc
.
on_http_error
(
exc
.
GitlabJobCancelError
)
def
cancel
(
self
,
**
kwargs
:
Any
)
->
Dict
[
str
,
Any
]:
"""Cancel the job.
Args:
**kwargs: Extra options to send to the server (e.g. sudo)
Raises:
GitlabAuthenticationError: If authentication is not correct
GitlabJobCancelError: If the job could not be canceled
"""
path
=
f"
{
self
.
manager
.
path
}
/
{
self
.
encoded_id
}
/cancel"
result
=
self
.
manager
.
gitlab
.
http_post
(
path
,
**
kwargs
)
if
TYPE_CHECKING
:
assert
isinstance
(
result
,
dict
)
return
result
@
cli
.
register_custom_action
(
cls_names
=
"ProjectJob"
)
@
exc
.
on_http_error
(
exc
.
GitlabJobRetryError
)
def
retry
(
self
,
**
kwargs
:
Any
)
->
Dict
[
str
,
Any
]:
"""Retry the job.
Args:
**kwargs: Extra options to send to the server (e.g. sudo)
Raises:
GitlabAuthenticationError: If authentication is not correct
GitlabJobRetryError: If the job could not be retried
"""
path
=
f"
{
self
.
manager
.
path
}
/
{
self
.
encoded_id
}
/retry"
result
=
self
.
manager
.
gitlab
.
http_post
(
path
,
**
kwargs
)
if
TYPE_CHECKING
:
assert
isinstance
(
result
,
dict
)
return
result
@
cli
.
register_custom_action
(
cls_names
=
"ProjectJob"
)
@
exc
.
on_http_error
(
exc
.
GitlabJobPlayError
)
def
play
(
self
,
**
kwargs
:
Any
)
->
None
:
"""Trigger a job explicitly.
Args:
**kwargs: Extra options to send to the server (e.g. sudo)
Raises:
GitlabAuthenticationError: If authentication is not correct
GitlabJobPlayError: If the job could not be triggered
"""
path
=
f"
{
self
.
manager
.
path
}
/
{
self
.
encoded_id
}
/play"
result
=
self
.
manager
.
gitlab
.
http_post
(
path
,
**
kwargs
)
if
TYPE_CHECKING
:
assert
isinstance
(
result
,
dict
)
self
.
_update_attrs
(
result
)
@
cli
.
register_custom_action
(
cls_names
=
"ProjectJob"
)
@
exc
.
on_http_error
(
exc
.
GitlabJobEraseError
)
def
erase
(
self
,
**
kwargs
:
Any
)
->
None
:
"""Erase the job (remove job artifacts and trace).
Args:
**kwargs: Extra options to send to the server (e.g. sudo)
Raises:
GitlabAuthenticationError: If authentication is not correct
GitlabJobEraseError: If the job could not be erased
"""
path
=
f"
{
self
.
manager
.
path
}
/
{
self
.
encoded_id
}
/erase"
self
.
manager
.
gitlab
.
http_post
(
path
,
**
kwargs
)
@
cli
.
register_custom_action
(
cls_names
=
"ProjectJob"
)
@
exc
.
on_http_error
(
exc
.
GitlabCreateError
)
def
keep_artifacts
(
self
,
**
kwargs
:
Any
)
->
None
:
"""Prevent artifacts from being deleted when expiration is set.
Args:
**kwargs: Extra options to send to the server (e.g. sudo)
Raises:
GitlabAuthenticationError: If authentication is not correct
GitlabCreateError: If the request could not be performed
"""
path
=
f"
{
self
.
manager
.
path
}
/
{
self
.
encoded_id
}
/artifacts/keep"
self
.
manager
.
gitlab
.
http_post
(
path
,
**
kwargs
)
@
cli
.
register_custom_action
(
cls_names
=
"ProjectJob"
)
@
exc
.
on_http_error
(
exc
.
GitlabCreateError
)
def
delete_artifacts
(
self
,
**
kwargs
:
Any
)
->
None
:
"""Delete artifacts of a job.
Args:
**kwargs: Extra options to send to the server (e.g. sudo)
Raises:
GitlabAuthenticationError: If authentication is not correct
GitlabDeleteError: If the request could not be performed
"""
path
=
f"
{
self
.
manager
.
path
}
/
{
self
.
encoded_id
}
/artifacts"
self
.
manager
.
gitlab
.
http_delete
(
path
,
**
kwargs
)
@
cli
.
register_custom_action
(
cls_names
=
"ProjectJob"
)
@
exc
.
on_http_error
(
exc
.
GitlabGetError
)
def
artifacts
(
self
,
streamed
:
bool
=
False
,
action
:
Optional
[
Callable
[...,
Any
]]
=
None
,
chunk_size
:
int
=
1024
,
*
,
iterator
:
bool
=
False
,
**
kwargs
:
Any
,
)
->
Optional
[
Union
[
bytes
,
Iterator
[
Any
]]]:
"""Get the job artifacts.
Args:
streamed: If True the data will be processed by chunks of
`chunk_size` and each chunk is passed to `action` for
treatment
iterator: If True directly return the underlying response
iterator
action: Callable responsible of dealing with chunk of
data
chunk_size: Size of each chunk
**kwargs: Extra options to send to the server (e.g. sudo)
Raises:
GitlabAuthenticationError: If authentication is not correct
GitlabGetError: If the artifacts could not be retrieved
Returns:
The artifacts if `streamed` is False, None otherwise.
"""
path
=
f"
{
self
.
manager
.
path
}
/
{
self
.
encoded_id
}
/artifacts"
result
=
self
.
manager
.
gitlab
.
http_get
(
path
,
streamed
=
streamed
,
raw
=
True
,
**
kwargs
)
if
TYPE_CHECKING
:
assert
isinstance
(
result
,
requests
.
Response
)
return
utils
.
response_content
(
result
,
streamed
,
action
,
chunk_size
,
iterator
=
iterator
)
@
cli
.
register_custom_action
(
cls_names
=
"ProjectJob"
)
@
exc
.
on_http_error
(
exc
.
GitlabGetError
)
def
artifact
(
self
,
path
:
str
,
streamed
:
bool
=
False
,
action
:
Optional
[
Callable
[...,
Any
]]
=
None
,
chunk_size
:
int
=
1024
,
*
,
iterator
:
bool
=
False
,
**
kwargs
:
Any
,
)
->
Optional
[
Union
[
bytes
,
Iterator
[
Any
]]]:
"""Get a single artifact file from within the job's artifacts archive.
Args:
path: Path of the artifact
streamed: If True the data will be processed by chunks of
`chunk_size` and each chunk is passed to `action` for
treatment
iterator: If True directly return the underlying response
iterator
action: Callable responsible of dealing with chunk of
data
chunk_size: Size of each chunk
**kwargs: Extra options to send to the server (e.g. sudo)
Raises:
GitlabAuthenticationError: If authentication is not correct
GitlabGetError: If the artifacts could not be retrieved
Returns:
The artifacts if `streamed` is False, None otherwise.
"""
path
=
f"
{
self
.
manager
.
path
}
/
{
self
.
encoded_id
}
/artifacts/
{
path
}
"
result
=
self
.
manager
.
gitlab
.
http_get
(
path
,
streamed
=
streamed
,
raw
=
True
,
**
kwargs
)
if
TYPE_CHECKING
:
assert
isinstance
(
result
,
requests
.
Response
)
return
utils
.
response_content
(
result
,
streamed
,
action
,
chunk_size
,
iterator
=
iterator
)
@
cli
.
register_custom_action
(
cls_names
=
"ProjectJob"
)
@
exc
.
on_http_error
(
exc
.
GitlabGetError
)
def
trace
(
self
,
streamed
:
bool
=
False
,
action
:
Optional
[
Callable
[...,
Any
]]
=
None
,
chunk_size
:
int
=
1024
,
*
,
iterator
:
bool
=
False
,
**
kwargs
:
Any
,
)
->
Optional
[
Union
[
bytes
,
Iterator
[
Any
]]]:
"""Get the job trace.
Args:
streamed: If True the data will be processed by chunks of
`chunk_size` and each chunk is passed to `action` for
treatment
iterator: If True directly return the underlying response
iterator
action: Callable responsible of dealing with chunk of
data
chunk_size: Size of each chunk
**kwargs: Extra options to send to the server (e.g. sudo)
Raises:
GitlabAuthenticationError: If authentication is not correct
GitlabGetError: If the artifacts could not be retrieved
Returns:
The trace
"""
path
=
f"
{
self
.
manager
.
path
}
/
{
self
.
encoded_id
}
/trace"
result
=
self
.
manager
.
gitlab
.
http_get
(
path
,
streamed
=
streamed
,
raw
=
True
,
**
kwargs
)
if
TYPE_CHECKING
:
assert
isinstance
(
result
,
requests
.
Response
)
return
utils
.
response_content
(
result
,
streamed
,
action
,
chunk_size
,
iterator
=
iterator
)
class
ProjectJobManager
(
RetrieveMixin
,
RESTManager
):
_path
=
"/projects/{project_id}/jobs"
_obj_cls
=
ProjectJob
_from_parent_attrs
=
{
"project_id"
:
"id"
}
_list_filters
=
(
"scope"
,)
_types
=
{
"scope"
:
ArrayAttribute
}
def
get
(
self
,
id
:
Union
[
str
,
int
],
lazy
:
bool
=
False
,
**
kwargs
:
Any
)
->
ProjectJob
:
return
cast
(
ProjectJob
,
super
().
get
(
id
=
id
,
lazy
=
lazy
,
**
kwargs
))
Back
|
FazBrowse Home
|
New Git URL