1717
1818class ProjectArtifact (RESTObject ):
1919"""Dummy object to manage custom actions on artifacts"""
20+
2021_id_attr = "ref_name"
2122
2223
@@ -57,6 +58,7 @@ def download(
5758** kwargs :Any ,
5859 )-> Optional [bytes ]:
5960"""Get the job artifacts archive from a specific tag or branch.
61+
6062 Args:
6163 ref_name: Branch or tag name in repository. HEAD or SHA references
6264 are not supported.
@@ -69,9 +71,11 @@ def download(
6971 data
7072 chunk_size: Size of each chunk
7173 **kwargs: Extra options to send to the server (e.g. sudo)
74+
7275 Raises:
7376 GitlabAuthenticationError: If authentication is not correct
7477 GitlabGetError: If the artifacts could not be retrieved
78+
7579 Returns:
7680 The artifacts if `streamed` is False, None otherwise.
7781 """
@@ -83,7 +87,9 @@ def download(
8387assert isinstance (result ,requests .Response )
8488return utils .response_content (result ,streamed ,action ,chunk_size )
8589
86- @cli .register_custom_action ("ProjectArtifactManager" , ("ref_name" ,"artifact_path" ,"job" ))
90+ @cli .register_custom_action (
91+ "ProjectArtifactManager" , ("ref_name" ,"artifact_path" ,"job" )
92+ )
8793@exc .on_http_error (exc .GitlabGetError )
8894def raw (
8995self ,
@@ -97,6 +103,7 @@ def raw(
97103 )-> Optional [bytes ]:
98104"""Download a single artifact file from a specific tag or branch from
99105 within the job's artifacts archive.
106+
100107 Args:
101108 ref_name: Branch or tag name in repository. HEAD or SHA references
102109 are not supported.
@@ -109,9 +116,11 @@ def raw(
109116 data
110117 chunk_size: Size of each chunk
111118 **kwargs: Extra options to send to the server (e.g. sudo)
119+
112120 Raises:
113121 GitlabAuthenticationError: If authentication is not correct
114122 GitlabGetError: If the artifacts could not be retrieved
123+
115124 Returns:
116125 The artifact if `streamed` is False, None otherwise.
117126 """