FazBrowse GitHub Viewer
|
Trending
|
URL:
|
Home
Tools:
[Download Repo ZIP]
[View Raw Code]
[Original HTTPS Page]
python-gitlab/gitlab/v4/objects/secure_files.py at main · 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
/
secure_files.py
Copy path
More file actions
More file actions
Latest commit
History
History
History
102 lines (87 loc) · 3.03 KB
Breadcrumbs
python-gitlab
/
gitlab
/
v4
/
objects
/
secure_files.py
Copy path
File metadata and controls
102 lines (87 loc) · 3.03 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
"""
GitLab API:
https://docs.gitlab.com/ee/api/secure_files.html
"""
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
NoUpdateMixin
,
ObjectDeleteMixin
from
gitlab
.
types
import
FileAttribute
,
RequiredOptional
__all__
=
[
"ProjectSecureFile"
,
"ProjectSecureFileManager"
]
class
ProjectSecureFile
(
ObjectDeleteMixin
,
RESTObject
):
@
overload
def
download
(
self
,
streamed
:
Literal
[
False
]
=
False
,
action
:
None
=
None
,
chunk_size
:
int
=
1024
,
*
,
iterator
:
Literal
[
False
]
=
False
,
**
kwargs
:
Any
,
)
->
bytes
: ...
@
overload
def
download
(
self
,
streamed
:
bool
=
False
,
action
:
None
=
None
,
chunk_size
:
int
=
1024
,
*
,
iterator
:
Literal
[
True
]
=
True
,
**
kwargs
:
Any
,
)
->
Iterator
[
Any
]: ...
@
overload
def
download
(
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
=
"ProjectSecureFile"
)
@
exc
.
on_http_error
(
exc
.
GitlabGetError
)
def
download
(
self
,
streamed
:
bool
=
False
,
action
:
Callable
[[
bytes
],
Any
]
|
None
=
None
,
chunk_size
:
int
=
1024
,
*
,
iterator
:
bool
=
False
,
**
kwargs
:
Any
,
)
->
bytes
|
Iterator
[
Any
]
|
None
:
"""Download the secure file.
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
.
id
}
/download"
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
ProjectSecureFileManager
(
NoUpdateMixin
[
ProjectSecureFile
]):
_path
=
"/projects/{project_id}/secure_files"
_obj_cls
=
ProjectSecureFile
_from_parent_attrs
=
{
"project_id"
:
"id"
}
_create_attrs
=
RequiredOptional
(
required
=
(
"name"
,
"file"
))
_types
=
{
"file"
:
FileAttribute
}
Back
|
FazBrowse Home
|
New Git URL