FazBrowse GitHub Viewer
|
Trending
|
URL:
|
Home
Tools:
[Download Repo ZIP]
[View Raw Code]
[Original HTTPS Page]
python-gitlab/gitlab/v4/objects/artifacts.py at docker · xuhdev/python-gitlab · GitHub
xuhdev
python-gitlab
Repository navigation
Code
Pull requests
Actions
Projects
Security and quality
Insights
Expand file tree
Breadcrumbs
python-gitlab
/
gitlab
/
v4
/
objects
/
artifacts.py
Copy path
More file actions
More file actions
Latest commit
History
History
History
144 lines (123 loc) · 4.91 KB
Breadcrumbs
python-gitlab
/
gitlab
/
v4
/
objects
/
artifacts.py
Copy path
File metadata and controls
144 lines (123 loc) · 4.91 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
"""
GitLab API:
https://docs.gitlab.com/ee/api/job_artifacts.html
"""
from
typing
import
Any
,
Callable
,
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
__all__
=
[
"ProjectArtifact"
,
"ProjectArtifactManager"
]
class
ProjectArtifact
(
RESTObject
):
"""Dummy object to manage custom actions on artifacts"""
_id_attr
=
"ref_name"
class
ProjectArtifactManager
(
RESTManager
):
_obj_cls
=
ProjectArtifact
_path
=
"/projects/{project_id}/jobs/artifacts"
_from_parent_attrs
=
{
"project_id"
:
"id"
}
@
exc
.
on_http_error
(
exc
.
GitlabDeleteError
)
def
delete
(
self
,
**
kwargs
:
Any
)
->
None
:
"""Delete the project's artifacts on the server.
Args:
**kwargs: Extra options to send to the server (e.g. sudo)
Raises:
GitlabAuthenticationError: If authentication is not correct
GitlabDeleteError: If the server cannot perform the request
"""
path
=
self
.
_compute_path
(
"/projects/{project_id}/artifacts"
)
if
TYPE_CHECKING
:
assert
path
is
not
None
self
.
gitlab
.
http_delete
(
path
,
**
kwargs
)
@
cli
.
register_custom_action
(
"ProjectArtifactManager"
, (
"ref_name"
,
"job"
), (
"job_token"
,)
)
@
exc
.
on_http_error
(
exc
.
GitlabGetError
)
def
download
(
self
,
ref_name
:
str
,
job
:
str
,
streamed
:
bool
=
False
,
action
:
Optional
[
Callable
[[
bytes
],
None
]]
=
None
,
chunk_size
:
int
=
1024
,
*
,
iterator
:
bool
=
False
,
**
kwargs
:
Any
,
)
->
Optional
[
Union
[
bytes
,
Iterator
[
Any
]]]:
"""Get the job artifacts archive from a specific tag or branch.
Args:
ref_name: Branch or tag name in repository. HEAD or SHA references
are not supported.
job: The name of the job.
job_token: Job token for multi-project pipeline triggers.
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
.
path
}
/
{
ref_name
}
/download"
result
=
self
.
gitlab
.
http_get
(
path
,
job
=
job
,
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
(
"ProjectArtifactManager"
, (
"ref_name"
,
"artifact_path"
,
"job"
)
)
@
exc
.
on_http_error
(
exc
.
GitlabGetError
)
def
raw
(
self
,
ref_name
:
str
,
artifact_path
:
str
,
job
:
str
,
streamed
:
bool
=
False
,
action
:
Optional
[
Callable
[[
bytes
],
None
]]
=
None
,
chunk_size
:
int
=
1024
,
*
,
iterator
:
bool
=
False
,
**
kwargs
:
Any
,
)
->
Optional
[
Union
[
bytes
,
Iterator
[
Any
]]]:
"""Download a single artifact file from a specific tag or branch from
within the job's artifacts archive.
Args:
ref_name: Branch or tag name in repository. HEAD or SHA references
are not supported.
artifact_path: Path to a file inside the artifacts archive.
job: The name of the job.
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 artifact if `streamed` is False, None otherwise.
"""
path
=
f"
{
self
.
path
}
/
{
ref_name
}
/raw/
{
artifact_path
}
"
result
=
self
.
gitlab
.
http_get
(
path
,
streamed
=
streamed
,
raw
=
True
,
job
=
job
,
**
kwargs
)
if
TYPE_CHECKING
:
assert
isinstance
(
result
,
requests
.
Response
)
return
utils
.
response_content
(
result
,
streamed
,
action
,
chunk_size
,
iterator
=
iterator
)
Back
|
FazBrowse Home
|
New Git URL