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

Repository navigation

History

538 lines (461 loc) · 17.9 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

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

"""

GitLab API:

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

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

"""

from __future__ import annotations

from typing import Any, TYPE_CHECKING

import requests

import gitlab

from gitlab import cli

from gitlab import exceptions as exc

from gitlab import types

from gitlab.base import RESTObject, RESTObjectList

from gitlab.mixins import (

CRUDMixin,

ListMixin,

ObjectDeleteMixin,

ParticipantsMixin,

RetrieveMixin,

SaveMixin,

SubscribableMixin,

TimeTrackingMixin,

TodoMixin,

)

from gitlab.types import RequiredOptional

from .award_emojis import ProjectMergeRequestAwardEmojiManager # noqa: F401

from .commits import ProjectCommit, ProjectCommitManager

from .discussions import ProjectMergeRequestDiscussionManager # noqa: F401

from .draft_notes import ProjectMergeRequestDraftNoteManager

from .events import ( # noqa: F401

ProjectMergeRequestResourceLabelEventManager,

ProjectMergeRequestResourceMilestoneEventManager,

ProjectMergeRequestResourceStateEventManager,

)

from .issues import ProjectIssue, ProjectIssueManager

from .merge_request_approvals import ( # noqa: F401

ProjectMergeRequestApprovalManager,

ProjectMergeRequestApprovalRuleManager,

ProjectMergeRequestApprovalStateManager,

)

from .notes import ProjectMergeRequestNoteManager # noqa: F401

from .pipelines import ProjectMergeRequestPipelineManager # noqa: F401

from .reviewers import ProjectMergeRequestReviewerDetailManager

from .status_checks import ProjectMergeRequestStatusCheckManager

__all__ = [

"MergeRequest",

"MergeRequestManager",

"GroupMergeRequest",

"GroupMergeRequestManager",

"ProjectMergeRequest",

"ProjectMergeRequestManager",

"ProjectDeploymentMergeRequest",

"ProjectDeploymentMergeRequestManager",

"ProjectMergeRequestDiff",

"ProjectMergeRequestDiffManager",

]

class MergeRequest(RESTObject):

pass

class MergeRequestManager(ListMixin[MergeRequest]):

_path = "/merge_requests"

_obj_cls = MergeRequest

_list_filters = (

"state",

"order_by",

"sort",

"milestone",

"view",

"labels",

"with_labels_details",

"with_merge_status_recheck",

"created_after",

"created_before",

"updated_after",

"updated_before",

"scope",

"author_id",

"author_username",

"assignee_id",

"approver_ids",

"approved_by_ids",

"reviewer_id",

"reviewer_username",

"my_reaction_emoji",

"source_branch",

"target_branch",

"search",

"in",

"wip",

"not",

"environment",

"deployed_before",

"deployed_after",

)

_types = {

"approver_ids": types.ArrayAttribute,

"approved_by_ids": types.ArrayAttribute,

"in": types.CommaSeparatedListAttribute,

"labels": types.CommaSeparatedListAttribute,

}

class GroupMergeRequest(RESTObject):

pass

class GroupMergeRequestManager(ListMixin[GroupMergeRequest]):

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

_obj_cls = GroupMergeRequest

_from_parent_attrs = {"group_id": "id"}

_list_filters = (

"state",

"order_by",

"sort",

"milestone",

"view",

"labels",

"created_after",

"created_before",

"updated_after",

"updated_before",

"scope",

"author_id",

"assignee_id",

"approver_ids",

"approved_by_ids",

"my_reaction_emoji",

"source_branch",

"target_branch",

"search",

"wip",

)

_types = {

"approver_ids": types.ArrayAttribute,

"approved_by_ids": types.ArrayAttribute,

"labels": types.CommaSeparatedListAttribute,

}

class ProjectMergeRequest(

SubscribableMixin,

TodoMixin,

TimeTrackingMixin,

ParticipantsMixin,

SaveMixin,

ObjectDeleteMixin,

RESTObject,

_id_attr = "iid"

approval_rules: ProjectMergeRequestApprovalRuleManager

approval_state: ProjectMergeRequestApprovalStateManager

approvals: ProjectMergeRequestApprovalManager

awardemojis: ProjectMergeRequestAwardEmojiManager

diffs: ProjectMergeRequestDiffManager

discussions: ProjectMergeRequestDiscussionManager

draft_notes: ProjectMergeRequestDraftNoteManager

notes: ProjectMergeRequestNoteManager

pipelines: ProjectMergeRequestPipelineManager

resourcelabelevents: ProjectMergeRequestResourceLabelEventManager

resourcemilestoneevents: ProjectMergeRequestResourceMilestoneEventManager

resourcestateevents: ProjectMergeRequestResourceStateEventManager

reviewer_details: ProjectMergeRequestReviewerDetailManager

status_checks: ProjectMergeRequestStatusCheckManager

@cli.register_custom_action(cls_names="ProjectMergeRequest")

@exc.on_http_error(exc.GitlabMROnBuildSuccessError)

def cancel_merge_when_pipeline_succeeds(self, **kwargs: Any) -> dict[str, str]:

"""Cancel merge when the pipeline succeeds.

Args:

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

Raises:

GitlabAuthenticationError: If authentication is not correct

GitlabMROnBuildSuccessError: If the server could not handle the

request

Returns:

dict of the parsed json returned by the server

"""

path = (

f"{self.manager.path}/{self.encoded_id}/cancel_merge_when_pipeline_succeeds"

)

server_data = self.manager.gitlab.http_post(path, **kwargs)

# 2022-10-30: The docs at

# https://docs.gitlab.com/ee/api/merge_requests.html#cancel-merge-when-pipeline-succeeds

# are incorrect in that the return value is actually just:

# {'status': 'success'} for a successful cancel.

if TYPE_CHECKING:

assert isinstance(server_data, dict)

return server_data

@cli.register_custom_action(cls_names="ProjectMergeRequest")

@exc.on_http_error(exc.GitlabListError)

def related_issues(self, **kwargs: Any) -> RESTObjectList[ProjectIssue]:

"""List issues related to this merge request."

Args:

get_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)

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

Raises:

GitlabAuthenticationError: If authentication is not correct

GitlabListError: If the list could not be retrieved

Returns:

List of issues

"""

path = f"{self.manager.path}/{self.encoded_id}/related_issues"

data_list = self.manager.gitlab.http_list(path, iterator=True, **kwargs)

if TYPE_CHECKING:

assert isinstance(data_list, gitlab.GitlabList)

manager = ProjectIssueManager(self.manager.gitlab, parent=self.manager._parent)

return RESTObjectList(manager, ProjectIssue, data_list)

@cli.register_custom_action(cls_names="ProjectMergeRequest")

@exc.on_http_error(exc.GitlabListError)

def closes_issues(self, **kwargs: Any) -> RESTObjectList[ProjectIssue]:

"""List issues that will close on merge."

Args:

get_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)

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

Raises:

GitlabAuthenticationError: If authentication is not correct

GitlabListError: If the list could not be retrieved

Returns:

List of issues

"""

path = f"{self.manager.path}/{self.encoded_id}/closes_issues"

data_list = self.manager.gitlab.http_list(path, iterator=True, **kwargs)

if TYPE_CHECKING:

assert isinstance(data_list, gitlab.GitlabList)

manager = ProjectIssueManager(self.manager.gitlab, parent=self.manager._parent)

return RESTObjectList(manager, ProjectIssue, data_list)

@cli.register_custom_action(cls_names="ProjectMergeRequest")

@exc.on_http_error(exc.GitlabListError)

def commits(self, **kwargs: Any) -> RESTObjectList[ProjectCommit]:

"""List the merge request commits.

Args:

get_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)

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

Raises:

GitlabAuthenticationError: If authentication is not correct

GitlabListError: If the list could not be retrieved

Returns:

The list of commits

"""

path = f"{self.manager.path}/{self.encoded_id}/commits"

data_list = self.manager.gitlab.http_list(path, iterator=True, **kwargs)

if TYPE_CHECKING:

assert isinstance(data_list, gitlab.GitlabList)

manager = ProjectCommitManager(self.manager.gitlab, parent=self.manager._parent)

return RESTObjectList(manager, ProjectCommit, data_list)

@cli.register_custom_action(

cls_names="ProjectMergeRequest", optional=("access_raw_diffs",)

)

@exc.on_http_error(exc.GitlabListError)

def changes(self, **kwargs: Any) -> dict[str, Any] | requests.Response:

"""List the merge request changes.

Args:

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

Raises:

GitlabAuthenticationError: If authentication is not correct

GitlabListError: If the list could not be retrieved

Returns:

List of changes

"""

path = f"{self.manager.path}/{self.encoded_id}/changes"

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

@cli.register_custom_action(cls_names="ProjectMergeRequest", optional=("sha",))

@exc.on_http_error(exc.GitlabMRApprovalError)

def approve(self, sha: str | None = None, **kwargs: Any) -> dict[str, Any]:

"""Approve the merge request.

Args:

sha: Head SHA of MR

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

Raises:

GitlabAuthenticationError: If authentication is not correct

GitlabMRApprovalError: If the approval failed

Returns:

A dict containing the result.

https://docs.gitlab.com/ee/api/merge_request_approvals.html#approve-merge-request

"""

path = f"{self.manager.path}/{self.encoded_id}/approve"

data = {}

if sha:

data["sha"] = sha

server_data = self.manager.gitlab.http_post(path, post_data=data, **kwargs)

if TYPE_CHECKING:

assert isinstance(server_data, dict)

self._update_attrs(server_data)

return server_data

@cli.register_custom_action(cls_names="ProjectMergeRequest")

@exc.on_http_error(exc.GitlabMRApprovalError)

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

"""Unapprove the merge request.

Args:

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

Raises:

GitlabAuthenticationError: If authentication is not correct

GitlabMRApprovalError: If the unapproval failed

https://docs.gitlab.com/ee/api/merge_request_approvals.html#unapprove-merge-request

"""

path = f"{self.manager.path}/{self.encoded_id}/unapprove"

data: dict[str, Any] = {}

server_data = self.manager.gitlab.http_post(path, post_data=data, **kwargs)

if TYPE_CHECKING:

assert isinstance(server_data, dict)

self._update_attrs(server_data)

@cli.register_custom_action(cls_names="ProjectMergeRequest")

@exc.on_http_error(exc.GitlabMRRebaseError)

def rebase(self, **kwargs: Any) -> dict[str, Any] | requests.Response:

"""Attempt to rebase the source branch onto the target branch

Args:

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

Raises:

GitlabAuthenticationError: If authentication is not correct

GitlabMRRebaseError: If rebasing failed

"""

path = f"{self.manager.path}/{self.encoded_id}/rebase"

data: dict[str, Any] = {}

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

@cli.register_custom_action(cls_names="ProjectMergeRequest")

@exc.on_http_error(exc.GitlabMRResetApprovalError)

def reset_approvals(self, **kwargs: Any) -> dict[str, Any] | requests.Response:

"""Clear all approvals of the merge request.

Args:

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

Raises:

GitlabAuthenticationError: If authentication is not correct

GitlabMRResetApprovalError: If reset approval failed

"""

path = f"{self.manager.path}/{self.encoded_id}/reset_approvals"

data: dict[str, Any] = {}

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

@cli.register_custom_action(cls_names="ProjectMergeRequest")

@exc.on_http_error(exc.GitlabGetError)

def merge_ref(self, **kwargs: Any) -> dict[str, Any] | requests.Response:

"""Attempt to merge changes between source and target branches into

`refs/merge-requests/:iid/merge`.

Args:

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

Raises:

GitlabGetError: If cannot be merged

"""

path = f"{self.manager.path}/{self.encoded_id}/merge_ref"

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

@cli.register_custom_action(

cls_names="ProjectMergeRequest",

optional=(

"merge_commit_message",

"should_remove_source_branch",

"merge_when_pipeline_succeeds",

)

@exc.on_http_error(exc.GitlabMRClosedError)

def merge(

self,

merge_commit_message: str | None = None,

should_remove_source_branch: bool | None = None,

merge_when_pipeline_succeeds: bool | None = None,

**kwargs: Any,

) -> dict[str, Any]:

"""Accept the merge request.

Args:

merge_commit_message: Commit message

should_remove_source_branch: If True, removes the source

branch

merge_when_pipeline_succeeds: Wait for the build to succeed,

then merge

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

Raises:

GitlabAuthenticationError: If authentication is not correct

GitlabMRClosedError: If the merge failed

"""

path = f"{self.manager.path}/{self.encoded_id}/merge"

data: dict[str, Any] = {}

if merge_commit_message:

data["merge_commit_message"] = merge_commit_message

if should_remove_source_branch is not None:

data["should_remove_source_branch"] = should_remove_source_branch

if merge_when_pipeline_succeeds is not None:

data["merge_when_pipeline_succeeds"] = merge_when_pipeline_succeeds

server_data = self.manager.gitlab.http_put(path, post_data=data, **kwargs)

if TYPE_CHECKING:

assert isinstance(server_data, dict)

self._update_attrs(server_data)

return server_data

class ProjectMergeRequestManager(CRUDMixin[ProjectMergeRequest]):

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

_obj_cls = ProjectMergeRequest

_from_parent_attrs = {"project_id": "id"}

_optional_get_attrs = (

"render_html",

"include_diverged_commits_count",

"include_rebase_in_progress",

)

_create_attrs = RequiredOptional(

required=("source_branch", "target_branch", "title"),

optional=(

"allow_collaboration",

"allow_maintainer_to_push",

"approvals_before_merge",

"assignee_id",

"assignee_ids",

"description",

"labels",

"milestone_id",

"remove_source_branch",

"reviewer_ids",

"squash",

"target_project_id",

)

_update_attrs = RequiredOptional(

optional=(

"target_branch",

"assignee_id",

"title",

"description",

"state_event",

"labels",

"milestone_id",

"remove_source_branch",

"discussion_locked",

"allow_maintainer_to_push",

"squash",

"reviewer_ids",

)

_list_filters = (

"state",

"order_by",

"sort",

"milestone",

"view",

"labels",

"created_after",

"created_before",

"updated_after",

"updated_before",

"scope",

"iids",

"author_id",

"assignee_id",

"approver_ids",

"approved_by_ids",

"my_reaction_emoji",

"source_branch",

"target_branch",

"search",

"wip",

)

_types = {

"approver_ids": types.ArrayAttribute,

"approved_by_ids": types.ArrayAttribute,

"iids": types.ArrayAttribute,

"labels": types.CommaSeparatedListAttribute,

}

class ProjectDeploymentMergeRequest(MergeRequest):

pass

class ProjectDeploymentMergeRequestManager(MergeRequestManager):

_path = "/projects/{project_id}/deployments/{deployment_id}/merge_requests"

_obj_cls = ProjectDeploymentMergeRequest

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

class ProjectMergeRequestDiff(RESTObject):

pass

class ProjectMergeRequestDiffManager(RetrieveMixin[ProjectMergeRequestDiff]):

_path = "/projects/{project_id}/merge_requests/{mr_iid}/versions"

_obj_cls = ProjectMergeRequestDiff

_from_parent_attrs = {"project_id": "project_id", "mr_iid": "iid"}

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

Repository navigation

Expand file tree

Breadcrumbs

merge_requests.py

Latest commit

History

Breadcrumbs

merge_requests.py

File metadata and controls