python-gitlab/gitlab/v4/objects/packages.py at main · python-gitlab/python-gitlab · GitHub

Repository navigation

History

270 lines (226 loc) · 8.05 KB

Raw

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

"""

GitLab API:

https://docs.gitlab.com/ee/api/packages.html

https://docs.gitlab.com/ee/user/packages/generic_packages/

"""

from __future__ import annotations

from pathlib import Path

from typing import Any, BinaryIO, 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 RESTManager, RESTObject

from gitlab.mixins import DeleteMixin, GetMixin, ListMixin, ObjectDeleteMixin

__all__ = [

"GenericPackage",

"GenericPackageManager",

"GroupPackage",

"GroupPackageManager",

"ProjectPackage",

"ProjectPackageManager",

"ProjectPackageFile",

"ProjectPackageFileManager",

"ProjectPackagePipeline",

"ProjectPackagePipelineManager",

]

class GenericPackage(RESTObject):

_id_attr = "package_name"

class GenericPackageManager(RESTManager[GenericPackage]):

_path = "/projects/{project_id}/packages/generic"

_obj_cls = GenericPackage

_from_parent_attrs = {"project_id": "id"}

@cli.register_custom_action(

cls_names="GenericPackageManager",

required=("package_name", "package_version", "file_name", "path"),

)

@exc.on_http_error(exc.GitlabUploadError)

def upload(

self,

package_name: str,

package_version: str,

file_name: str,

path: str | Path | None = None,

select: str | None = None,

data: bytes | BinaryIO | None = None,

**kwargs: Any,

) -> GenericPackage:

"""Upload a file as a generic package.

Args:

package_name: The package name. Must follow generic package

name regex rules

package_version: The package version. Must follow semantic

version regex rules

file_name: The name of the file as uploaded in the registry

path: The path to a local file to upload

select: GitLab API accepts a value of 'package_file'

Raises:

GitlabConnectionError: If the server cannot be reached

GitlabUploadError: If the file upload fails

GitlabUploadError: If ``path`` cannot be read

GitlabUploadError: If both ``path`` and ``data`` are passed

Returns:

An object storing the metadata of the uploaded package.

https://docs.gitlab.com/ee/user/packages/generic_packages/

"""

if path is None and data is None:

raise exc.GitlabUploadError("No file contents or path specified")

if path is not None and data is not None:

raise exc.GitlabUploadError("File contents and file path specified")

file_data: bytes | BinaryIO | None = data

if not file_data:

if TYPE_CHECKING:

assert path is not None

try:

with open(path, "rb") as f:

file_data = f.read()

except OSError as e:

raise exc.GitlabUploadError(

f"Failed to read package file {path}"

) from e

url = f"{self._computed_path}/{package_name}/{package_version}/{file_name}"

query_data = {} if select is None else {"select": select}

server_data = self.gitlab.http_put(

url, query_data=query_data, post_data=file_data, raw=True, **kwargs

)

if TYPE_CHECKING:

assert isinstance(server_data, dict)

attrs = {

"package_name": package_name,

"package_version": package_version,

"file_name": file_name,

"path": path,

}

attrs.update(server_data)

return self._obj_cls(self, attrs=attrs)

@overload

def download(

self,

package_name: str,

package_version: str,

file_name: str,

streamed: Literal[False] = False,

action: None = None,

chunk_size: int = 1024,

iterator: Literal[False] = False,

**kwargs: Any,

) -> bytes: ...

@overload

def download(

self,

package_name: str,

package_version: str,

file_name: str,

streamed: bool = False,

action: None = None,

chunk_size: int = 1024,

iterator: Literal[True] = True,

**kwargs: Any,

) -> Iterator[Any]: ...

@overload

def download(

self,

package_name: str,

package_version: str,

file_name: 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="GenericPackageManager",

required=("package_name", "package_version", "file_name"),

)

@exc.on_http_error(exc.GitlabGetError)

def download(

self,

package_name: str,

package_version: str,

file_name: str,

streamed: bool = False,

action: Callable[[bytes], Any] | None = None,

chunk_size: int = 1024,

iterator: bool = False,

**kwargs: Any,

) -> bytes | Iterator[Any] | None:

"""Download a generic package.

Args:

package_name: The package name.

package_version: The package version.

file_name: The name of the file in the registry

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 server failed to perform the request

Returns:

The package content if streamed is False, None otherwise

"""

path = f"{self._computed_path}/{package_name}/{package_version}/{file_name}"

result = self.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 GroupPackage(RESTObject):

pass

class GroupPackageManager(ListMixin[GroupPackage]):

_path = "/groups/{group_id}/packages"

_obj_cls = GroupPackage

_from_parent_attrs = {"group_id": "id"}

_list_filters = (

"exclude_subgroups",

"order_by",

"sort",

"package_type",

"package_name",

"package_version",

"include_versionless",

"status",

)

class ProjectPackage(ObjectDeleteMixin, RESTObject):

package_files: ProjectPackageFileManager

pipelines: ProjectPackagePipelineManager

class ProjectPackageManager(

ListMixin[ProjectPackage], GetMixin[ProjectPackage], DeleteMixin[ProjectPackage]

_path = "/projects/{project_id}/packages"

_obj_cls = ProjectPackage

_from_parent_attrs = {"project_id": "id"}

_list_filters = (

"order_by",

"sort",

"package_type",

"package_name",

"package_version",

"include_versionless",

"status",

)

class ProjectPackageFile(ObjectDeleteMixin, RESTObject):

pass

class ProjectPackageFileManager(

DeleteMixin[ProjectPackageFile], ListMixin[ProjectPackageFile]

_path = "/projects/{project_id}/packages/{package_id}/package_files"

_obj_cls = ProjectPackageFile

_from_parent_attrs = {"project_id": "project_id", "package_id": "id"}

class ProjectPackagePipeline(RESTObject):

pass

class ProjectPackagePipelineManager(ListMixin[ProjectPackagePipeline]):

_path = "/projects/{project_id}/packages/{package_id}/pipelines"

_obj_cls = ProjectPackagePipeline

_from_parent_attrs = {"project_id": "project_id", "package_id": "id"}

python-gitlab/gitlab/v4/objects/packages.py at main · python-gitlab/python-gitlab · GitHub

Repository navigation

Expand file tree

Breadcrumbs

packages.py

Latest commit

History

Breadcrumbs

packages.py

File metadata and controls