FazBrowse GitHub Viewer
|
Trending
|
URL:
|
Home
Tools:
[Download Repo ZIP]
[View Raw Code]
[Original HTTPS Page]
python-gitlab/gitlab/v4/objects/jobs.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
/
jobs.py
Copy path
More file actions
More file actions
Latest commit
History
History
History
350 lines (304 loc) · 11 KB
Breadcrumbs
python-gitlab
/
gitlab
/
v4
/
objects
/
jobs.py
Copy path
File metadata and controls
350 lines (304 loc) · 11 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
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
from
__future__
import
annotations
from
typing
import
Any
,
Callable
,
Iterator
,
Literal
,
overload
,
TYPE_CHECKING
import
requests
from
gitlab
import
cli
from
gitlab
import
exceptions
as
exc
from
gitlab
import
utils
from
gitlab
.
base
import
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
)
@
overload
def
artifacts
(
self
,
streamed
:
Literal
[
False
]
=
False
,
action
:
None
=
None
,
chunk_size
:
int
=
1024
,
*
,
iterator
:
Literal
[
False
]
=
False
,
**
kwargs
:
Any
,
)
->
bytes
: ...
@
overload
def
artifacts
(
self
,
streamed
:
bool
=
False
,
action
:
None
=
None
,
chunk_size
:
int
=
1024
,
*
,
iterator
:
Literal
[
True
]
=
True
,
**
kwargs
:
Any
,
)
->
Iterator
[
Any
]: ...
@
overload
def
artifacts
(
self
,
streamed
:
Literal
[
True
]
=
True
,
action
:
Callable
[[
bytes
],
Any
]
|
None
=
None
,
chunk_size
:
int
=
1024
,
*
,
iterator
:
Literal
[
False
]
=
False
,
**
kwargs
:
Any
,
)
->
None
: ...
@
cli
.
register_custom_action
(
cls_names
=
"ProjectJob"
)
@
exc
.
on_http_error
(
exc
.
GitlabGetError
)
def
artifacts
(
self
,
streamed
:
bool
=
False
,
action
:
Callable
[...,
Any
]
|
None
=
None
,
chunk_size
:
int
=
1024
,
*
,
iterator
:
bool
=
False
,
**
kwargs
:
Any
,
)
->
bytes
|
Iterator
[
Any
]
|
None
:
"""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
)
@
overload
def
artifact
(
self
,
path
:
str
,
streamed
:
Literal
[
False
]
=
False
,
action
:
None
=
None
,
chunk_size
:
int
=
1024
,
*
,
iterator
:
Literal
[
False
]
=
False
,
**
kwargs
:
Any
,
)
->
bytes
: ...
@
overload
def
artifact
(
self
,
path
:
str
,
streamed
:
bool
=
False
,
action
:
None
=
None
,
chunk_size
:
int
=
1024
,
*
,
iterator
:
Literal
[
True
]
=
True
,
**
kwargs
:
Any
,
)
->
Iterator
[
Any
]: ...
@
overload
def
artifact
(
self
,
path
:
str
,
streamed
:
Literal
[
True
]
=
True
,
action
:
Callable
[[
bytes
],
Any
]
|
None
=
None
,
chunk_size
:
int
=
1024
,
*
,
iterator
:
Literal
[
False
]
=
False
,
**
kwargs
:
Any
,
)
->
None
: ...
@
cli
.
register_custom_action
(
cls_names
=
"ProjectJob"
)
@
exc
.
on_http_error
(
exc
.
GitlabGetError
)
def
artifact
(
self
,
path
:
str
,
streamed
:
bool
=
False
,
action
:
Callable
[...,
Any
]
|
None
=
None
,
chunk_size
:
int
=
1024
,
*
,
iterator
:
bool
=
False
,
**
kwargs
:
Any
,
)
->
bytes
|
Iterator
[
Any
]
|
None
:
"""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
)
@
overload
def
trace
(
self
,
streamed
:
Literal
[
False
]
=
False
,
action
:
None
=
None
,
chunk_size
:
int
=
1024
,
*
,
iterator
:
Literal
[
False
]
=
False
,
**
kwargs
:
Any
,
)
->
bytes
: ...
@
overload
def
trace
(
self
,
streamed
:
bool
=
False
,
action
:
None
=
None
,
chunk_size
:
int
=
1024
,
*
,
iterator
:
Literal
[
True
]
=
True
,
**
kwargs
:
Any
,
)
->
Iterator
[
Any
]: ...
@
overload
def
trace
(
self
,
streamed
:
Literal
[
True
]
=
True
,
action
:
Callable
[[
bytes
],
Any
]
|
None
=
None
,
chunk_size
:
int
=
1024
,
*
,
iterator
:
Literal
[
False
]
=
False
,
**
kwargs
:
Any
,
)
->
None
: ...
@
cli
.
register_custom_action
(
cls_names
=
"ProjectJob"
)
@
exc
.
on_http_error
(
exc
.
GitlabGetError
)
def
trace
(
self
,
streamed
:
bool
=
False
,
action
:
Callable
[...,
Any
]
|
None
=
None
,
chunk_size
:
int
=
1024
,
*
,
iterator
:
bool
=
False
,
**
kwargs
:
Any
,
)
->
bytes
|
Iterator
[
Any
]
|
None
:
"""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
[
ProjectJob
]):
_path
=
"/projects/{project_id}/jobs"
_obj_cls
=
ProjectJob
_from_parent_attrs
=
{
"project_id"
:
"id"
}
_list_filters
=
(
"scope"
,
"order_by"
,
"sort"
)
_types
=
{
"scope"
:
ArrayAttribute
}
Back
|
FazBrowse Home
|
New Git URL