python-gitlab/gitlab/mixins.py at main · python-gitlab/python-gitlab · GitHub

Repository navigation

History

1058 lines (865 loc) · 34.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

539

540

541

542

543

544

545

546

547

548

549

550

551

552

553

554

555

556

557

558

559

560

561

562

563

564

565

566

567

568

569

570

571

572

573

574

575

576

577

578

579

580

581

582

583

584

585

586

587

588

589

590

591

592

593

594

595

596

597

598

599

600

601

602

603

604

605

606

607

608

609

610

611

612

613

614

615

616

617

618

619

620

621

622

623

624

625

626

627

628

629

630

631

632

633

634

635

636

637

638

639

640

641

642

643

644

645

646

647

648

649

650

651

652

653

654

655

656

657

658

659

660

661

662

663

664

665

666

667

668

669

670

671

672

673

674

675

676

677

678

679

680

681

682

683

684

685

686

687

688

689

690

691

692

693

694

695

696

697

698

699

700

701

702

703

704

705

706

707

708

709

710

711

712

713

714

715

716

717

718

719

720

721

722

723

724

725

726

727

728

729

730

731

732

733

734

735

736

737

738

739

740

741

742

743

744

745

746

747

748

749

750

751

752

753

754

755

756

757

758

759

760

761

762

763

764

765

766

767

768

769

770

771

772

773

774

775

776

777

778

779

780

781

782

783

784

785

786

787

788

789

790

791

792

793

794

795

796

797

798

799

800

801

802

803

804

805

806

807

808

809

810

811

812

813

814

815

816

817

818

819

820

821

822

823

824

825

826

827

828

829

830

831

832

833

834

835

836

837

838

839

840

841

842

843

844

845

846

847

848

849

850

851

852

853

854

855

856

857

858

859

860

861

862

863

864

865

866

867

868

869

870

871

872

873

874

875

876

877

878

879

880

881

882

883

884

885

886

887

888

889

890

891

892

893

894

895

896

897

898

899

900

901

902

903

904

905

906

907

908

909

910

911

912

913

914

915

916

917

918

919

920

921

922

923

924

925

926

927

928

929

930

931

932

933

934

935

936

937

938

939

940

941

942

943

944

945

946

947

948

949

950

951

952

953

954

955

956

957

958

959

960

961

962

963

964

965

966

967

968

969

970

971

972

973

974

975

976

977

978

979

980

981

982

983

984

985

986

987

988

989

990

991

992

993

994

995

996

997

998

999

1000

from __future__ import annotations

import enum

from collections.abc import Iterator

from types import ModuleType

from typing import Any, Callable, Literal, overload, TYPE_CHECKING

import requests

import gitlab

from gitlab import base, cli

from gitlab import exceptions as exc

from gitlab import utils

__all__ = [

"GetMixin",

"GetWithoutIdMixin",

"RefreshMixin",

"ListMixin",

"RetrieveMixin",

"CreateMixin",

"UpdateMixin",

"SetMixin",

"DeleteMixin",

"CRUDMixin",

"NoUpdateMixin",

"SaveMixin",

"ObjectDeleteMixin",

"UserAgentDetailMixin",

"AccessRequestMixin",

"DownloadMixin",

"SubscribableMixin",

"TodoMixin",

"TimeTrackingMixin",

"ParticipantsMixin",

"BadgeRenderMixin",

]

if TYPE_CHECKING:

# When running mypy we use these as the base classes

_RestObjectBase = base.RESTObject

else:

_RestObjectBase = object

class HeadMixin(base.RESTManager[base.TObjCls]):

@exc.on_http_error(exc.GitlabHeadError)

def head(

self, id: str | int | None = None, **kwargs: Any

) -> requests.structures.CaseInsensitiveDict[Any]:

"""Retrieve headers from an endpoint.

Args:

id: ID of the object to retrieve

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

Returns:

A requests header object.

Raises:

GitlabAuthenticationError: If authentication is not correct

GitlabHeadError: If the server cannot perform the request

"""

path = self.path

if id is not None:

path = f"{path}/{utils.EncodedId(id)}"

return self.gitlab.http_head(path, **kwargs)

class GetMixin(HeadMixin[base.TObjCls]):

_optional_get_attrs: tuple[str, ...] = ()

@exc.on_http_error(exc.GitlabGetError)

def get(self, id: str | int, lazy: bool = False, **kwargs: Any) -> base.TObjCls:

"""Retrieve a single object.

Args:

id: ID of the object to retrieve

lazy: If True, don't request the server, but create a

shallow object giving access to the managers. This is

useful if you want to avoid useless calls to the API.

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

Returns:

The generated RESTObject.

Raises:

GitlabAuthenticationError: If authentication is not correct

GitlabGetError: If the server cannot perform the request

"""

if isinstance(id, str):

id = utils.EncodedId(id)

path = f"{self.path}/{id}"

if lazy is True:

if TYPE_CHECKING:

assert self._obj_cls._id_attr is not None

return self._obj_cls(self, {self._obj_cls._id_attr: id}, lazy=lazy)

server_data = self.gitlab.http_get(path, **kwargs)

if TYPE_CHECKING:

assert not isinstance(server_data, requests.Response)

return self._obj_cls(self, server_data, lazy=lazy)

class GetWithoutIdMixin(HeadMixin[base.TObjCls]):

_optional_get_attrs: tuple[str, ...] = ()

@exc.on_http_error(exc.GitlabGetError)

def get(self, **kwargs: Any) -> base.TObjCls:

"""Retrieve a single object.

Args:

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

Returns:

The generated RESTObject

Raises:

GitlabAuthenticationError: If authentication is not correct

GitlabGetError: If the server cannot perform the request

"""

server_data = self.gitlab.http_get(self.path, **kwargs)

if TYPE_CHECKING:

assert not isinstance(server_data, requests.Response)

return self._obj_cls(self, server_data)

class RefreshMixin(_RestObjectBase):

_id_attr: str | None

_attrs: dict[str, Any]

_module: ModuleType

_parent_attrs: dict[str, Any]

_updated_attrs: dict[str, Any]

manager: base.RESTManager[Any]

@exc.on_http_error(exc.GitlabGetError)

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

"""Refresh a single object from server.

Args:

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

Returns None (updates the object)

Raises:

GitlabAuthenticationError: If authentication is not correct

GitlabGetError: If the server cannot perform the request

"""

if self._id_attr:

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

else:

if TYPE_CHECKING:

assert self.manager.path is not None

path = self.manager.path

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

if TYPE_CHECKING:

assert not isinstance(server_data, requests.Response)

self._update_attrs(server_data)

class ListMixin(HeadMixin[base.TObjCls]):

_list_filters: tuple[str, ...] = ()

@overload

def list(

self, *, iterator: Literal[False] = False, **kwargs: Any

) -> list[base.TObjCls]: ...

@overload

def list(

self, *, iterator: Literal[True] = True, **kwargs: Any

) -> base.RESTObjectList[base.TObjCls]: ...

@overload

def list(

self, *, iterator: bool = False, **kwargs: Any

) -> base.RESTObjectList[base.TObjCls] | list[base.TObjCls]: ...

@exc.on_http_error(exc.GitlabListError)

def list(

self, *, iterator: bool = False, **kwargs: Any

) -> base.RESTObjectList[base.TObjCls] | list[base.TObjCls]:

"""Retrieve a list of objects.

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)

iterator: If set to True and no pagination option is

defined, return a generator instead of a list

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

Returns:

The list of objects, or a generator if `iterator` is True

Raises:

GitlabAuthenticationError: If authentication is not correct

GitlabListError: If the server cannot perform the request

"""

data, _ = utils._transform_types(

data=kwargs,

custom_types=self._types,

transform_data=True,

transform_files=False,

)

if self.gitlab.per_page:

data.setdefault("per_page", self.gitlab.per_page)

# global keyset pagination

if self.gitlab.pagination:

data.setdefault("pagination", self.gitlab.pagination)

if self.gitlab.order_by:

data.setdefault("order_by", self.gitlab.order_by)

# Allow to overwrite the path, handy for custom listings

path = data.pop("path", self.path)

obj = self.gitlab.http_list(path, iterator=iterator, **data)

if isinstance(obj, list):

return [self._obj_cls(self, item, created_from_list=True) for item in obj]

return base.RESTObjectList(self, self._obj_cls, obj)

class RetrieveMixin(ListMixin[base.TObjCls], GetMixin[base.TObjCls]): ...

class CreateMixin(base.RESTManager[base.TObjCls]):

@exc.on_http_error(exc.GitlabCreateError)

def create(self, data: dict[str, Any] | None = None, **kwargs: Any) -> base.TObjCls:

"""Create a new object.

Args:

data: parameters to send to the server to create the

resource

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

Returns:

A new instance of the managed object class built with

the data sent by the server

Raises:

GitlabAuthenticationError: If authentication is not correct

GitlabCreateError: If the server cannot perform the request

"""

if data is None:

data = {}

self._create_attrs.validate_attrs(data=data)

data, files = utils._transform_types(

data=data, custom_types=self._types, transform_data=False

)

# Handle specific URL for creation

path = kwargs.pop("path", self.path)

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

if TYPE_CHECKING:

assert not isinstance(server_data, requests.Response)

return self._obj_cls(self, server_data)

@enum.unique

class UpdateMethod(enum.IntEnum):

PUT = 1

POST = 2

PATCH = 3

class UpdateMixin(base.RESTManager[base.TObjCls]):

# Update mixins attrs for easier implementation

_update_method: UpdateMethod = UpdateMethod.PUT

def _get_update_method(self) -> Callable[..., dict[str, Any] | requests.Response]:

"""Return the HTTP method to use.

Returns:

http_put (default) or http_post

"""

if self._update_method is UpdateMethod.POST:

http_method = self.gitlab.http_post

elif self._update_method is UpdateMethod.PATCH:

# only patch uses required kwargs, so our types are a bit misaligned

http_method = self.gitlab.http_patch # type: ignore[assignment]

else:

http_method = self.gitlab.http_put

return http_method

@exc.on_http_error(exc.GitlabUpdateError)

def update(

self,

id: str | int | None = None,

new_data: dict[str, Any] | None = None,

**kwargs: Any,

) -> dict[str, Any]:

"""Update an object on the server.

Args:

id: ID of the object to update (can be None if not required)

new_data: the update data for the object

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

Returns:

The new object data (*not* a RESTObject)

Raises:

GitlabAuthenticationError: If authentication is not correct

GitlabUpdateError: If the server cannot perform the request

"""

new_data = new_data or {}

if id is None:

path = self.path

else:

path = f"{self.path}/{utils.EncodedId(id)}"

excludes = []

if self._obj_cls is not None and self._obj_cls._id_attr is not None:

excludes = [self._obj_cls._id_attr]

self._update_attrs.validate_attrs(data=new_data, excludes=excludes)

new_data, files = utils._transform_types(

data=new_data, custom_types=self._types, transform_data=False

)

http_method = self._get_update_method()

result = http_method(path, post_data=new_data, files=files, **kwargs)

if TYPE_CHECKING:

assert not isinstance(result, requests.Response)

return result

class SetMixin(base.RESTManager[base.TObjCls]):

@exc.on_http_error(exc.GitlabSetError)

def set(self, key: str, value: str, **kwargs: Any) -> base.TObjCls:

"""Create or update the object.

Args:

key: The key of the object to create/update

value: The value to set for the object

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

Raises:

GitlabAuthenticationError: If authentication is not correct

GitlabSetError: If an error occurred

Returns:

The created/updated attribute

"""

path = f"{self.path}/{utils.EncodedId(key)}"

data = {"value": value}

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

if TYPE_CHECKING:

assert not isinstance(server_data, requests.Response)

return self._obj_cls(self, server_data)

class DeleteMixin(base.RESTManager[base.TObjCls]):

@exc.on_http_error(exc.GitlabDeleteError)

def delete(self, id: str | int | None = None, **kwargs: Any) -> None:

"""Delete an object on the server.

Args:

id: ID of the object to delete

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

Raises:

GitlabAuthenticationError: If authentication is not correct

GitlabDeleteError: If the server cannot perform the request

"""

if id is None:

path = self.path

else:

path = f"{self.path}/{utils.EncodedId(id)}"

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

class CRUDMixin(

GetMixin[base.TObjCls],

ListMixin[base.TObjCls],

CreateMixin[base.TObjCls],

UpdateMixin[base.TObjCls],

DeleteMixin[base.TObjCls],

): ...

class NoUpdateMixin(

GetMixin[base.TObjCls],

ListMixin[base.TObjCls],

CreateMixin[base.TObjCls],

DeleteMixin[base.TObjCls],

): ...

class SaveMixin(_RestObjectBase):

"""Mixin for RESTObject's that can be updated."""

_id_attr: str | None

_attrs: dict[str, Any]

_module: ModuleType

_parent_attrs: dict[str, Any]

_updated_attrs: dict[str, Any]

manager: base.RESTManager[Any]

def _get_updated_data(self) -> dict[str, Any]:

updated_data = {}

for attr in self.manager._update_attrs.required:

# Get everything required, no matter if it's been updated

updated_data[attr] = getattr(self, attr)

# Add the updated attributes

updated_data.update(self._updated_attrs)

return updated_data

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

"""Save the changes made to the object to the server.

The object is updated to match what the server returns.

Args:

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

Returns:

The new object data (*not* a RESTObject)

Raise:

GitlabAuthenticationError: If authentication is not correct

GitlabUpdateError: If the server cannot perform the request

"""

updated_data = self._get_updated_data()

# Nothing to update. Server fails if sent an empty dict.

if not updated_data:

return None

# call the manager

obj_id = self.encoded_id

if TYPE_CHECKING:

assert isinstance(self.manager, UpdateMixin)

server_data = self.manager.update(obj_id, updated_data, **kwargs)

self._update_attrs(server_data)

return server_data

class ObjectDeleteMixin(_RestObjectBase):

"""Mixin for RESTObject's that can be deleted."""

_id_attr: str | None

_attrs: dict[str, Any]

_module: ModuleType

_parent_attrs: dict[str, Any]

_updated_attrs: dict[str, Any]

manager: base.RESTManager[Any]

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

"""Delete the object from the server.

Args:

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

Raises:

GitlabAuthenticationError: If authentication is not correct

GitlabDeleteError: If the server cannot perform the request

"""

if TYPE_CHECKING:

assert isinstance(self.manager, DeleteMixin)

assert self.encoded_id is not None

self.manager.delete(self.encoded_id, **kwargs)

class UserAgentDetailMixin(_RestObjectBase):

_id_attr: str | None

_attrs: dict[str, Any]

_module: ModuleType

_parent_attrs: dict[str, Any]

_updated_attrs: dict[str, Any]

manager: base.RESTManager[Any]

@cli.register_custom_action(cls_names=("Snippet", "ProjectSnippet", "ProjectIssue"))

@exc.on_http_error(exc.GitlabGetError)

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

"""Get the user agent detail.

Args:

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

Raises:

GitlabAuthenticationError: If authentication is not correct

GitlabGetError: If the server cannot perform the request

"""

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

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

if TYPE_CHECKING:

assert not isinstance(result, requests.Response)

return result

class AccessRequestMixin(_RestObjectBase):

_id_attr: str | None

_attrs: dict[str, Any]

_module: ModuleType

_parent_attrs: dict[str, Any]

_updated_attrs: dict[str, Any]

manager: base.RESTManager[Any]

@cli.register_custom_action(

cls_names=("ProjectAccessRequest", "GroupAccessRequest"),

optional=("access_level",),

)

@exc.on_http_error(exc.GitlabUpdateError)

def approve(

self, access_level: int = gitlab.const.DEVELOPER_ACCESS, **kwargs: Any

) -> None:

"""Approve an access request.

Args:

access_level: The access level for the user

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

Raises:

GitlabAuthenticationError: If authentication is not correct

GitlabUpdateError: If the server fails to perform the request

"""

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

data = {"access_level": access_level}

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

if TYPE_CHECKING:

assert not isinstance(server_data, requests.Response)

self._update_attrs(server_data)

class DownloadMixin(_RestObjectBase):

_id_attr: str | None

_attrs: dict[str, Any]

_module: ModuleType

_parent_attrs: dict[str, Any]

_updated_attrs: dict[str, Any]

manager: base.RESTManager[Any]

@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=("GroupExport", "ProjectExport"))

@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 archive of a resource export.

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

Returns:

The blob content if streamed is False, None otherwise

"""

path = f"{self.manager.path}/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 RotateMixin(base.RESTManager[base.TObjCls]):

@cli.register_custom_action(

cls_names=(

"PersonalAccessTokenManager",

"GroupAccessTokenManager",

"ProjectAccessTokenManager",

"GroupServiceAccountAccessTokenManager",

"ProjectServiceAccountAccessTokenManager",

optional=("expires_at",),

)

@exc.on_http_error(exc.GitlabRotateError)

def rotate(

self, id: str | int, expires_at: str | None = None, **kwargs: Any

) -> dict[str, Any]:

"""Rotate an access token.

Args:

id: ID of the token to rotate

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

Raises:

GitlabAuthenticationError: If authentication is not correct

GitlabRotateError: If the server cannot perform the request

"""

path = f"{self.path}/{utils.EncodedId(id)}/rotate"

data: dict[str, Any] = {}

if expires_at is not None:

data = {"expires_at": expires_at}

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

if TYPE_CHECKING:

assert not isinstance(server_data, requests.Response)

return server_data

class ObjectRotateMixin(_RestObjectBase):

_id_attr: str | None

_attrs: dict[str, Any]

_module: ModuleType

_parent_attrs: dict[str, Any]

_updated_attrs: dict[str, Any]

manager: base.RESTManager[Any]

@cli.register_custom_action(

cls_names=(

"PersonalAccessToken",

"GroupAccessToken",

"ProjectAccessToken",

"GroupServiceAccountAccessToken",

"ProjectServiceAccountAccessToken",

optional=("expires_at",),

)

@exc.on_http_error(exc.GitlabRotateError)

def rotate(self, *, self_rotate: bool = False, **kwargs: Any) -> dict[str, Any]:

"""Rotate the current access token object.

Args:

self_rotate: If True, the current access token object will be rotated.

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

Raises:

GitlabAuthenticationError: If authentication is not correct

GitlabRotateError: If the server cannot perform the request

"""

if TYPE_CHECKING:

assert isinstance(self.manager, RotateMixin)

assert self.encoded_id is not None

token_id = "self" if self_rotate else self.encoded_id

server_data = self.manager.rotate(token_id, **kwargs)

self._update_attrs(server_data)

return server_data

class SubscribableMixin(_RestObjectBase):

_id_attr: str | None

_attrs: dict[str, Any]

_module: ModuleType

_parent_attrs: dict[str, Any]

_updated_attrs: dict[str, Any]

manager: base.RESTManager[Any]

@cli.register_custom_action(

cls_names=("ProjectIssue", "ProjectMergeRequest", "ProjectLabel", "GroupLabel")

)

@exc.on_http_error(exc.GitlabSubscribeError)

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

"""Subscribe to the object notifications.

Args:

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

raises:

GitlabAuthenticationError: If authentication is not correct

GitlabSubscribeError: If the subscription cannot be done

"""

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

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

if TYPE_CHECKING:

assert not isinstance(server_data, requests.Response)

self._update_attrs(server_data)

@cli.register_custom_action(

cls_names=("ProjectIssue", "ProjectMergeRequest", "ProjectLabel", "GroupLabel")

)

@exc.on_http_error(exc.GitlabUnsubscribeError)

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

"""Unsubscribe from the object notifications.

Args:

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

raises:

GitlabAuthenticationError: If authentication is not correct

GitlabUnsubscribeError: If the unsubscription cannot be done

"""

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

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

if TYPE_CHECKING:

assert not isinstance(server_data, requests.Response)

self._update_attrs(server_data)

class TodoMixin(_RestObjectBase):

_id_attr: str | None

_attrs: dict[str, Any]

_module: ModuleType

_parent_attrs: dict[str, Any]

_updated_attrs: dict[str, Any]

manager: base.RESTManager[Any]

@cli.register_custom_action(cls_names=("ProjectIssue", "ProjectMergeRequest"))

@exc.on_http_error(exc.GitlabTodoError)

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

"""Create a todo associated to the object.

Args:

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

Raises:

GitlabAuthenticationError: If authentication is not correct

GitlabTodoError: If the todo cannot be set

"""

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

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

class TimeTrackingMixin(_RestObjectBase):

_id_attr: str | None

_attrs: dict[str, Any]

_module: ModuleType

_parent_attrs: dict[str, Any]

_updated_attrs: dict[str, Any]

manager: base.RESTManager[Any]

@cli.register_custom_action(cls_names=("ProjectIssue", "ProjectMergeRequest"))

@exc.on_http_error(exc.GitlabTimeTrackingError)

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

"""Get time stats for the object.

Args:

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

Raises:

GitlabAuthenticationError: If authentication is not correct

GitlabTimeTrackingError: If the time tracking update cannot be done

"""

# Use the existing time_stats attribute if it exist, otherwise make an

# API call

if "time_stats" in self.attributes:

time_stats = self.attributes["time_stats"]

if TYPE_CHECKING:

assert isinstance(time_stats, dict)

return time_stats

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

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

if TYPE_CHECKING:

assert not isinstance(result, requests.Response)

return result

@cli.register_custom_action(

cls_names=("ProjectIssue", "ProjectMergeRequest"), required=("duration",)

)

@exc.on_http_error(exc.GitlabTimeTrackingError)

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

"""Set an estimated time of work for the object.

Args:

duration: Duration in human format (e.g. 3h30)

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

Raises:

GitlabAuthenticationError: If authentication is not correct

GitlabTimeTrackingError: If the time tracking update cannot be done

"""

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

data = {"duration": duration}

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

if TYPE_CHECKING:

assert not isinstance(result, requests.Response)

return result

@cli.register_custom_action(cls_names=("ProjectIssue", "ProjectMergeRequest"))

@exc.on_http_error(exc.GitlabTimeTrackingError)

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

"""Resets estimated time for the object to 0 seconds.

Args:

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

Raises:

GitlabAuthenticationError: If authentication is not correct

GitlabTimeTrackingError: If the time tracking update cannot be done

"""

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

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

if TYPE_CHECKING:

assert not isinstance(result, requests.Response)

return result

@cli.register_custom_action(

cls_names=("ProjectIssue", "ProjectMergeRequest"), required=("duration",)

)

@exc.on_http_error(exc.GitlabTimeTrackingError)

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

"""Add time spent working on the object.

Args:

duration: Duration in human format (e.g. 3h30)

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

Raises:

GitlabAuthenticationError: If authentication is not correct

GitlabTimeTrackingError: If the time tracking update cannot be done

"""

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

data = {"duration": duration}

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

if TYPE_CHECKING:

assert not isinstance(result, requests.Response)

return result

@cli.register_custom_action(cls_names=("ProjectIssue", "ProjectMergeRequest"))

@exc.on_http_error(exc.GitlabTimeTrackingError)

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

"""Resets the time spent working on the object.

Args:

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

Raises:

GitlabAuthenticationError: If authentication is not correct

GitlabTimeTrackingError: If the time tracking update cannot be done

"""

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

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

if TYPE_CHECKING:

assert not isinstance(result, requests.Response)

return result

class ParticipantsMixin(_RestObjectBase):

_id_attr: str | None

_attrs: dict[str, Any]

_module: ModuleType

_parent_attrs: dict[str, Any]

_updated_attrs: dict[str, Any]

manager: base.RESTManager[Any]

@cli.register_custom_action(cls_names=("ProjectMergeRequest", "ProjectIssue"))

@exc.on_http_error(exc.GitlabListError)

def participants(

self, **kwargs: Any

) -> gitlab.client.GitlabList | list[dict[str, Any]]:

"""List the participants.

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 participants

"""

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

result = self.manager.gitlab.http_list(path, **kwargs)

if TYPE_CHECKING:

assert not isinstance(result, requests.Response)

return result

class BadgeRenderMixin(base.RESTManager[base.TObjCls]):

@cli.register_custom_action(

cls_names=("GroupBadgeManager", "ProjectBadgeManager"),

required=("link_url", "image_url"),

)

@exc.on_http_error(exc.GitlabRenderError)

def render(self, link_url: str, image_url: str, **kwargs: Any) -> dict[str, Any]:

"""Preview link_url and image_url after interpolation.

Args:

link_url: URL of the badge link

image_url: URL of the badge image

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

Raises:

GitlabAuthenticationError: If authentication is not correct

GitlabRenderError: If the rendering failed

Returns:

The rendering properties

"""

path = f"{self.path}/render"

data = {"link_url": link_url, "image_url": image_url}

result = self.gitlab.http_get(path, data, **kwargs)

if TYPE_CHECKING:

assert not isinstance(result, requests.Response)

return result

class PromoteMixin(_RestObjectBase):

_id_attr: str | None

_attrs: dict[str, Any]

_module: ModuleType

_parent_attrs: dict[str, Any]

_updated_attrs: dict[str, Any]

_update_method: UpdateMethod = UpdateMethod.PUT

manager: base.RESTManager[Any]

def _get_update_method(self) -> Callable[..., dict[str, Any] | requests.Response]:

"""Return the HTTP method to use.

Returns:

http_put (default) or http_post

"""

if self._update_method is UpdateMethod.POST:

http_method = self.manager.gitlab.http_post

else:

http_method = self.manager.gitlab.http_put

return http_method

@exc.on_http_error(exc.GitlabPromoteError)

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

"""Promote the item.

Args:

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

Raises:

GitlabAuthenticationError: If authentication is not correct

GitlabPromoteError: If the item could not be promoted

GitlabParsingError: If the json data could not be parsed

Returns:

The updated object data (*not* a RESTObject)

"""

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

http_method = self._get_update_method()

result = http_method(path, **kwargs)

if TYPE_CHECKING:

assert not isinstance(result, requests.Response)

return result

class UploadMixin(_RestObjectBase):

_id_attr: str | None

_attrs: dict[str, Any]

_module: ModuleType

_parent_attrs: dict[str, Any]

_updated_attrs: dict[str, Any]

_upload_path: str

manager: base.RESTManager[Any]

def _get_upload_path(self) -> str:

"""Formats _upload_path with object attributes.

View remainder of file in raw view

python-gitlab/gitlab/mixins.py at main · python-gitlab/python-gitlab · GitHub

Repository navigation

Expand file tree

Breadcrumbs

mixins.py

Latest commit

History

Breadcrumbs

mixins.py

File metadata and controls