python-gitlab/gitlab/v4/objects/repositories.py at master · kernelport/python-gitlab · GitHub

Repository navigation

History

246 lines (209 loc) · 9.16 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

"""

GitLab API: https://docs.gitlab.com/ee/api/repositories.html

Currently this module only contains repository-related methods for projects.

"""

from typing import Any, Callable, Dict, List, Optional, TYPE_CHECKING, Union

import requests

import gitlab

from gitlab import cli

from gitlab import exceptions as exc

from gitlab import utils

if TYPE_CHECKING:

# When running mypy we use these as the base classes

_RestObjectBase = gitlab.base.RESTObject

else:

_RestObjectBase = object

class RepositoryMixin(_RestObjectBase):

@cli.register_custom_action("Project", ("submodule", "branch", "commit_sha"))

@exc.on_http_error(exc.GitlabUpdateError)

def update_submodule(

self, submodule: str, branch: str, commit_sha: str, **kwargs: Any

) -> Union[Dict[str, Any], requests.Response]:

"""Update a project submodule

Args:

submodule: Full path to the submodule

branch: Name of the branch to commit into

commit_sha: Full commit SHA to update the submodule to

commit_message: Commit message. If no message is provided, a

default one will be set (optional)

Raises:

GitlabAuthenticationError: If authentication is not correct

GitlabPutError: If the submodule could not be updated

"""

submodule = utils._url_encode(submodule)

path = f"/projects/{self.get_id()}/repository/submodules/{submodule}"

data = {"branch": branch, "commit_sha": commit_sha}

if "commit_message" in kwargs:

data["commit_message"] = kwargs["commit_message"]

return self.manager.gitlab.http_put(path, post_data=data)

@cli.register_custom_action("Project", tuple(), ("path", "ref", "recursive"))

@exc.on_http_error(exc.GitlabGetError)

def repository_tree(

self, path: str = "", ref: str = "", recursive: bool = False, **kwargs: Any

) -> Union[gitlab.client.GitlabList, List[Dict[str, Any]]]:

"""Return a list of files in the repository.

Args:

path: Path of the top folder (/ by default)

ref: Reference to a commit or branch

recursive: Whether to get the tree recursively

all: If True, return all the items, without pagination

per_page: Number of items to retrieve per request

page: ID of the page to return (starts with page 1)

as_list: If set to False and no pagination option is

defined, return a generator instead of a list

**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 representation of the tree

"""

gl_path = f"/projects/{self.get_id()}/repository/tree"

query_data: Dict[str, Any] = {"recursive": recursive}

if path:

query_data["path"] = path

if ref:

query_data["ref"] = ref

return self.manager.gitlab.http_list(gl_path, query_data=query_data, **kwargs)

@cli.register_custom_action("Project", ("sha",))

@exc.on_http_error(exc.GitlabGetError)

def repository_blob(

self, sha: str, **kwargs: Any

) -> Union[Dict[str, Any], requests.Response]:

"""Return a file by blob SHA.

Args:

sha: ID of the blob

**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 blob content and metadata

"""

path = f"/projects/{self.get_id()}/repository/blobs/{sha}"

return self.manager.gitlab.http_get(path, **kwargs)

@cli.register_custom_action("Project", ("sha",))

@exc.on_http_error(exc.GitlabGetError)

def repository_raw_blob(

self,

sha: str,

streamed: bool = False,

action: Optional[Callable[..., Any]] = None,

chunk_size: int = 1024,

**kwargs: Any,

) -> Optional[bytes]:

"""Return the raw file contents for a blob.

Args:

sha: ID of the blob

streamed: If True the data will be processed by chunks of

`chunk_size` and each chunk is passed to `action` for

treatment

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 blob content if streamed is False, None otherwise

"""

path = f"/projects/{self.get_id()}/repository/blobs/{sha}/raw"

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)

@cli.register_custom_action("Project", ("from_", "to"))

@exc.on_http_error(exc.GitlabGetError)

def repository_compare(

self, from_: str, to: str, **kwargs: Any

) -> Union[Dict[str, Any], requests.Response]:

"""Return a diff between two branches/commits.

Args:

from_: Source branch/SHA

to: Destination branch/SHA

**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 diff

"""

path = f"/projects/{self.get_id()}/repository/compare"

query_data = {"from": from_, "to": to}

return self.manager.gitlab.http_get(path, query_data=query_data, **kwargs)

@cli.register_custom_action("Project")

@exc.on_http_error(exc.GitlabGetError)

def repository_contributors(

self, **kwargs: Any

) -> Union[gitlab.client.GitlabList, List[Dict[str, Any]]]:

"""Return a list of contributors for the project.

Args:

all: If True, return all the items, without pagination

per_page: Number of items to retrieve per request

page: ID of the page to return (starts with page 1)

as_list: If set to False and no pagination option is

defined, return a generator instead of a list

**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 contributors

"""

path = f"/projects/{self.get_id()}/repository/contributors"

return self.manager.gitlab.http_list(path, **kwargs)

@cli.register_custom_action("Project", tuple(), ("sha", "format"))

@exc.on_http_error(exc.GitlabListError)

def repository_archive(

self,

sha: str = None,

streamed: bool = False,

action: Optional[Callable[..., Any]] = None,

chunk_size: int = 1024,

format: Optional[str] = None,

**kwargs: Any,

) -> Optional[bytes]:

"""Return an archive of the repository.

Args:

sha: ID of the commit (default branch by default)

streamed: If True the data will be processed by chunks of

`chunk_size` and each chunk is passed to `action` for

treatment

action: Callable responsible of dealing with chunk of

data

chunk_size: Size of each chunk

format: file format (tar.gz by default)

**kwargs: Extra options to send to the server (e.g. sudo)

Raises:

GitlabAuthenticationError: If authentication is not correct

GitlabListError: If the server failed to perform the request

Returns:

The binary data of the archive

"""

path = f"/projects/{self.get_id()}/repository/archive"

if format:

path += "." + format

query_data = {}

if sha:

query_data["sha"] = sha

result = self.manager.gitlab.http_get(

path, query_data=query_data, raw=True, streamed=streamed, **kwargs

)

if TYPE_CHECKING:

assert isinstance(result, requests.Response)

return utils.response_content(result, streamed, action, chunk_size)

@cli.register_custom_action("Project")

@exc.on_http_error(exc.GitlabDeleteError)

def delete_merged_branches(self, **kwargs: Any) -> None:

"""Delete merged branches.

Args:

**kwargs: Extra options to send to the server (e.g. sudo)

Raises:

GitlabAuthenticationError: If authentication is not correct

GitlabDeleteError: If the server failed to perform the request

"""

path = f"/projects/{self.get_id()}/repository/merged_branches"

self.manager.gitlab.http_delete(path, **kwargs)

python-gitlab/gitlab/v4/objects/repositories.py at master · kernelport/python-gitlab · GitHub

Repository navigation

Expand file tree

Breadcrumbs

repositories.py

Latest commit

History

Breadcrumbs

repositories.py

File metadata and controls