python-gitlab/gitlab/objects.py at master · hungld/python-gitlab · GitHub

Repository navigation

History

1679 lines (1327 loc) · 56.4 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

# -*- coding: utf-8 -*-

# This program is free software: you can redistribute it and/or modify

# it under the terms of the GNU Lesser General Public License as published by

# the Free Software Foundation, either version 3 of the License, or

# (at your option) any later version.

# This program is distributed in the hope that it will be useful,

# but WITHOUT ANY WARRANTY; without even the implied warranty of

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

# GNU Lesser General Public License for more details.

# You should have received a copy of the GNU Lesser General Public License

# along with this program. If not, see <http://www.gnu.org/licenses/>.

from __future__ import print_function

from __future__ import division

from __future__ import absolute_import

import base64

import copy

import itertools

import json

import sys

import warnings

import six

import gitlab

from gitlab.exceptions import * # noqa

class jsonEncoder(json.JSONEncoder):

def default(self, obj):

if isinstance(obj, GitlabObject):

return obj.as_dict()

elif isinstance(obj, gitlab.Gitlab):

return {'url': obj._url}

return json.JSONEncoder.default(self, obj)

class BaseManager(object):

"""Base manager class for API operations.

Managers provide method to manage GitLab API objects, such as retrieval,

listing, creation.

Inherited class must define the ``obj_cls`` attribute.

Attributes:

obj_cls (class): class of objects wrapped by this manager.

"""

obj_cls = None

def __init__(self, gl, parent=None, args=[]):

"""Constructs a manager.

Args:

gl (gitlab.Gitlab): Gitlab object referencing the GitLab server.

parent (Optional[Manager]): A parent manager.

args (list): A list of tuples defining a link between the

parent/child attributes.

Raises:

AttributeError: If `obj_cls` is None.

"""

self.gitlab = gl

self.args = args

self.parent = parent

if self.obj_cls is None:

raise AttributeError("obj_cls must be defined")

def _set_parent_args(self, **kwargs):

args = copy.copy(kwargs)

if self.parent is not None:

for attr, parent_attr in self.args:

args.setdefault(attr, getattr(self.parent, parent_attr))

return args

def get(self, id=None, **kwargs):

"""Get a GitLab object.

Args:

id: ID of the object to retrieve.

**kwargs: Additional arguments to send to GitLab.

Returns:

object: An object of class `obj_cls`.

Raises:

NotImplementedError: If objects cannot be retrieved.

GitlabGetError: If the server fails to perform the request.

"""

args = self._set_parent_args(**kwargs)

if not self.obj_cls.canGet:

raise NotImplementedError

return self.obj_cls.get(self.gitlab, id, **args)

def list(self, **kwargs):

"""Get a list of GitLab objects.

Args:

**kwargs: Additional arguments to send to GitLab.

Returns:

list[object]: A list of `obj_cls` objects.

Raises:

NotImplementedError: If objects cannot be listed.

GitlabListError: If the server fails to perform the request.

"""

args = self._set_parent_args(**kwargs)

if not self.obj_cls.canList:

raise NotImplementedError

return self.obj_cls.list(self.gitlab, **args)

def create(self, data, **kwargs):

"""Create a new object of class `obj_cls`.

Args:

data (dict): The parameters to send to the GitLab server to create

the object. Required and optional arguments are defined in the

`requiredCreateAttrs` and `optionalCreateAttrs` of the

`obj_cls` class.

**kwargs: Additional arguments to send to GitLab.

Returns:

object: A newly create `obj_cls` object.

Raises:

NotImplementedError: If objects cannot be created.

GitlabCreateError: If the server fails to perform the request.

"""

args = self._set_parent_args(**kwargs)

if not self.obj_cls.canCreate:

raise NotImplementedError

return self.obj_cls.create(self.gitlab, data, **args)

def delete(self, id, **kwargs):

"""Delete a GitLab object.

Args:

id: ID of the object to delete.

Raises:

NotImplementedError: If objects cannot be deleted.

GitlabDeleteError: If the server fails to perform the request.

"""

args = self._set_parent_args(**kwargs)

if not self.obj_cls.canDelete:

raise NotImplementedError

self.gitlab.delete(self.obj_cls, id, **args)

class GitlabObject(object):

"""Base class for all classes that interface with GitLab."""

#: Url to use in GitLab for this object

_url = None

# Some objects (e.g. merge requests) have different urls for singular and

# plural

_urlPlural = None

_id_in_delete_url = True

_id_in_update_url = True

_constructorTypes = None

#: Whether _get_list_or_object should return list or object when id is None

getListWhenNoId = True

#: Tells if GitLab-api allows retrieving single objects.

canGet = True

#: Tells if GitLab-api allows listing of objects.

canList = True

#: Tells if GitLab-api allows creation of new objects.

canCreate = True

#: Tells if GitLab-api allows updating object.

canUpdate = True

#: Tells if GitLab-api allows deleting object.

canDelete = True

#: Attributes that are required for constructing url.

requiredUrlAttrs = []

#: Attributes that are required when retrieving list of objects.

requiredListAttrs = []

#: Attributes that are required when retrieving single object.

requiredGetAttrs = []

#: Attributes that are required when deleting object.

requiredDeleteAttrs = []

#: Attributes that are required when creating a new object.

requiredCreateAttrs = []

#: Attributes that are optional when creating a new object.

optionalCreateAttrs = []

#: Attributes that are required when updating an object.

requiredUpdateAttrs = []

#: Attributes that are optional when updating an object.

optionalUpdateAttrs = []

#: Whether the object ID is required in the GET url.

getRequiresId = True

#: List of managers to create.

managers = []

#: Name of the identifier of an object.

idAttr = 'id'

#: Attribute to use as ID when displaying the object.

shortPrintAttr = None

def _data_for_gitlab(self, extra_parameters={}, update=False):

data = {}

if update and (self.requiredUpdateAttrs or self.optionalUpdateAttrs):

attributes = itertools.chain(self.requiredUpdateAttrs,

self.optionalUpdateAttrs)

else:

attributes = itertools.chain(self.requiredCreateAttrs,

self.optionalCreateAttrs)

attributes = list(attributes) + ['sudo', 'page', 'per_page']

for attribute in attributes:

if hasattr(self, attribute):

data[attribute] = getattr(self, attribute)

data.update(extra_parameters)

return json.dumps(data)

@classmethod

def list(cls, gl, **kwargs):

"""Retrieve a list of objects from GitLab.

Args:

gl (gitlab.Gitlab): Gitlab object referencing the GitLab server.

per_page (int): Maximum number of items to return.

page (int): ID of the page to return when using pagination.

Returns:

list[object]: A list of objects.

Raises:

NotImplementedError: If objects can't be listed.

GitlabListError: If the server cannot perform the request.

"""

if not cls.canList:

raise NotImplementedError

if not cls._url:

raise NotImplementedError

return gl.list(cls, **kwargs)

@classmethod

def get(cls, gl, id, **kwargs):

"""Retrieve a single object.

Args:

gl (gitlab.Gitlab): Gitlab object referencing the GitLab server.

id (int or str): ID of the object to retrieve.

Returns:

object: The found GitLab object.

Raises:

NotImplementedError: If objects can't be retrieved.

GitlabGetError: If the server cannot perform the request.

"""

if cls.canGet is False:

raise NotImplementedError

elif cls.canGet is True:

return cls(gl, id, **kwargs)

elif cls.canGet == 'from_list':

for obj in cls.list(gl, **kwargs):

obj_id = getattr(obj, obj.idAttr)

if str(obj_id) == str(id):

return obj

raise GitlabGetError("Object not found")

@classmethod

def _get_list_or_object(cls, gl, id, **kwargs):

if id is None and cls.getListWhenNoId:

return cls.list(gl, **kwargs)

else:

return cls.get(gl, id, **kwargs)

def _get_object(self, k, v):

if self._constructorTypes and k in self._constructorTypes:

return globals()[self._constructorTypes[k]](self.gitlab, v)

else:

return v

def _set_from_dict(self, data):

for k, v in data.items():

if isinstance(v, list):

self.__dict__[k] = []

for i in v:

self.__dict__[k].append(self._get_object(k, i))

elif v is None:

self.__dict__[k] = None

else:

self.__dict__[k] = self._get_object(k, v)

def _create(self, **kwargs):

if not self.canCreate:

raise NotImplementedError

json = self.gitlab.create(self, **kwargs)

self._set_from_dict(json)

self._from_api = True

def _update(self, **kwargs):

if not self.canUpdate:

raise NotImplementedError

json = self.gitlab.update(self, **kwargs)

self._set_from_dict(json)

def save(self, **kwargs):

if self._from_api:

self._update(**kwargs)

else:

self._create(**kwargs)

def delete(self, **kwargs):

if not self.canDelete:

raise NotImplementedError

if not self._from_api:

raise GitlabDeleteError("Object not yet created")

return self.gitlab.delete(self, **kwargs)

@classmethod

def create(cls, gl, data, **kwargs):

"""Create an object.

Args:

gl (gitlab.Gitlab): Gitlab object referencing the GitLab server.

data (dict): The data used to define the object.

Returns:

object: The new object.

Raises:

NotImplementedError: If objects can't be created.

GitlabCreateError: If the server cannot perform the request.

"""

if not cls.canCreate:

raise NotImplementedError

obj = cls(gl, data, **kwargs)

obj.save()

return obj

def __init__(self, gl, data=None, **kwargs):

"""Constructs a new object.

Do not use this method. Use the `get` or `create` class methods

instead.

Args:

gl (gitlab.Gitlab): Gitlab object referencing the GitLab server.

data: If `data` is a dict, create a new object using the

information. If it is an int or a string, get a GitLab object

from an API request.

**kwargs: Additional arguments to send to GitLab.

"""

self._from_api = False

#: (gitlab.Gitlab): Gitlab connection.

self.gitlab = gl

if (data is None or isinstance(data, six.integer_types) or

isinstance(data, six.string_types)):

if not self.canGet:

raise NotImplementedError

data = self.gitlab.get(self.__class__, data, **kwargs)

self._from_api = True

self._set_from_dict(data)

if kwargs:

for k, v in kwargs.items():

self.__dict__[k] = v

# Special handling for api-objects that don't have id-number in api

# responses. Currently only Labels and Files

if not hasattr(self, "id"):

self.id = None

self._set_managers()

def _set_managers(self):

for var, cls, attrs in self.managers:

manager = cls(self.gitlab, self, attrs)

setattr(self, var, manager)

def __str__(self):

return '%s => %s' % (type(self), str(self.__dict__))

def display(self, pretty):

if pretty:

self.pretty_print()

else:

self.short_print()

def short_print(self, depth=0):

"""Print the object on the standard output (verbose).

Args:

depth (int): Used internaly for recursive call.

"""

id = self.__dict__[self.idAttr]

print("%s%s: %s" % (" " * depth * 2, self.idAttr, id))

if self.shortPrintAttr:

print("%s%s: %s" % (" " * depth * 2,

self.shortPrintAttr.replace('_', '-'),

self.__dict__[self.shortPrintAttr]))

@staticmethod

def _get_display_encoding():

return sys.stdout.encoding or sys.getdefaultencoding()

@staticmethod

def _obj_to_str(obj):

if isinstance(obj, dict):

s = ", ".join(["%s: %s" %

(x, GitlabObject._obj_to_str(y))

for (x, y) in obj.items()])

return "{ %s }" % s

elif isinstance(obj, list):

s = ", ".join([GitlabObject._obj_to_str(x) for x in obj])

return "[ %s ]" % s

elif six.PY2 and isinstance(obj, six.text_type):

return obj.encode(GitlabObject._get_display_encoding(), "replace")

else:

return str(obj)

def pretty_print(self, depth=0):

"""Print the object on the standard output (verbose).

Args:

depth (int): Used internaly for recursive call.

"""

id = self.__dict__[self.idAttr]

print("%s%s: %s" % (" " * depth * 2, self.idAttr, id))

for k in sorted(self.__dict__.keys()):

if k in (self.idAttr, 'id', 'gitlab'):

continue

if k[0] == '_':

continue

v = self.__dict__[k]

pretty_k = k.replace('_', '-')

if six.PY2:

pretty_k = pretty_k.encode(

GitlabObject._get_display_encoding(), "replace")

if isinstance(v, GitlabObject):

if depth == 0:

print("%s:" % pretty_k)

v.pretty_print(1)

else:

print("%s: %s" % (pretty_k, v.id))

elif isinstance(v, BaseManager):

continue

else:

if hasattr(v, __name__) and v.__name__ == 'Gitlab':

continue

v = GitlabObject._obj_to_str(v)

print("%s%s: %s" % (" " * depth * 2, pretty_k, v))

def json(self):

"""Dump the object as json.

Returns:

str: The json string.

"""

return json.dumps(self, cls=jsonEncoder)

def as_dict(self):

"""Dump the object as a dict."""

return {k: v for k, v in six.iteritems(self.__dict__)

if (not isinstance(v, BaseManager) and not k[0] == '_')}

def __eq__(self, other):

if type(other) is type(self):

return self.as_dict() == other.as_dict()

return False

def __ne__(self, other):

return not self.__eq__(other)

class UserKey(GitlabObject):

_url = '/users/%(user_id)s/keys'

canGet = 'from_list'

canUpdate = False

requiredUrlAttrs = ['user_id']

requiredCreateAttrs = ['title', 'key']

class UserKeyManager(BaseManager):

obj_cls = UserKey

class User(GitlabObject):

_url = '/users'

shortPrintAttr = 'username'

requiredCreateAttrs = ['email', 'username', 'name', 'password']

optionalCreateAttrs = ['skype', 'linkedin', 'twitter', 'projects_limit',

'extern_uid', 'provider', 'bio', 'admin',

'can_create_group', 'website_url', 'confirm',

'external']

requiredUpdateAttrs = ['email', 'username', 'name']

optionalUpdateAttrs = ['password', 'skype', 'linkedin', 'twitter',

'projects_limit', 'extern_uid', 'provider', 'bio',

'admin', 'can_create_group', 'website_url',

'confirm', 'external']

managers = [('keys', UserKeyManager, [('user_id', 'id')])]

def _data_for_gitlab(self, extra_parameters={}, update=False):

if hasattr(self, 'confirm'):

self.confirm = str(self.confirm).lower()

return super(User, self)._data_for_gitlab(extra_parameters)

def Key(self, id=None, **kwargs):

warnings.warn("`Key` is deprecated, use `keys` instead",

DeprecationWarning)

return UserKey._get_list_or_object(self.gitlab, id,

user_id=self.id,

**kwargs)

def block(self, **kwargs):

"""Blocks the user."""

url = '/users/%s/block' % self.id

r = self.gitlab._raw_put(url, **kwargs)

raise_error_from_response(r, GitlabBlockError)

self.state = 'blocked'

def unblock(self, **kwargs):

"""Unblocks the user."""

url = '/users/%s/unblock' % self.id

r = self.gitlab._raw_put(url, **kwargs)

raise_error_from_response(r, GitlabUnblockError)

self.state = 'active'

def __eq__(self, other):

if type(other) is type(self):

selfdict = self.as_dict()

otherdict = other.as_dict()

selfdict.pop('password', None)

otherdict.pop('password', None)

return selfdict == otherdict

return False

class UserManager(BaseManager):

obj_cls = User

def search(self, query, **kwargs):

"""Search users.

Args:

query (str): The query string to send to GitLab for the search.

all (bool): If True, return all the items, without pagination

**kwargs: Additional arguments to send to GitLab.

Returns:

list(User): A list of matching users.

Raises:

GitlabConnectionError: If the server cannot be reached.

GitlabListError: If the server fails to perform the request.

"""

url = self.obj_cls._url + '?search=' + query

return self.gitlab._raw_list(url, self.obj_cls, **kwargs)

def get_by_username(self, username, **kwargs):

"""Get a user by its username.

Args:

username (str): The name of the user.

**kwargs: Additional arguments to send to GitLab.

Returns:

User: The matching user.

Raises:

GitlabConnectionError: If the server cannot be reached.

GitlabGetError: If the server fails to perform the request.

"""

url = self.obj_cls._url + '?username=' + username

results = self.gitlab._raw_list(url, self.obj_cls, **kwargs)

assert len(results) in (0, 1)

try:

return results[0]

except IndexError:

raise GitlabGetError('no such user: ' + username)

class CurrentUserKey(GitlabObject):

_url = '/user/keys'

canUpdate = False

shortPrintAttr = 'title'

requiredCreateAttrs = ['title', 'key']

class CurrentUserKeyManager(BaseManager):

obj_cls = CurrentUserKey

class CurrentUser(GitlabObject):

_url = '/user'

canList = False

canCreate = False

canUpdate = False

canDelete = False

shortPrintAttr = 'username'

managers = [('keys', CurrentUserKeyManager, [('user_id', 'id')])]

def Key(self, id=None, **kwargs):

warnings.warn("`Key` is deprecated, use `keys` instead",

DeprecationWarning)

return CurrentUserKey._get_list_or_object(self.gitlab, id, **kwargs)

class ApplicationSettings(GitlabObject):

_url = '/application/settings'

_id_in_update_url = False

optionalUpdateAttrs = ['after_sign_out_path', 'default_branch_protection',

'default_project_visibility',

'default_projects_limit',

'default_snippet_visibility', 'gravatar_enabled',

'home_page_url', 'restricted_signup_domains',

'restricted_visibility_levels',

'session_expire_delay', 'sign_in_text',

'signin_enabled', 'signup_enabled',

'twitter_sharing_enabled',

'user_oauth_applications']

canList = False

canCreate = False

canDelete = False

class ApplicationSettingsManager(BaseManager):

obj_cls = ApplicationSettings

class GroupMember(GitlabObject):

_url = '/groups/%(group_id)s/members'

canGet = 'from_list'

requiredUrlAttrs = ['group_id']

requiredCreateAttrs = ['access_level', 'user_id']

requiredUpdateAttrs = ['access_level']

shortPrintAttr = 'username'

def _update(self, **kwargs):

self.user_id = self.id

super(GroupMember, self)._update(**kwargs)

class GroupMemberManager(BaseManager):

obj_cls = GroupMember

class Group(GitlabObject):

_url = '/groups'

canUpdate = False

_constructorTypes = {'projects': 'Project'}

requiredCreateAttrs = ['name', 'path']

optionalCreateAttrs = ['description', 'visibility_level']

shortPrintAttr = 'name'

managers = [('members', GroupMemberManager, [('group_id', 'id')])]

GUEST_ACCESS = 10

REPORTER_ACCESS = 20

DEVELOPER_ACCESS = 30

MASTER_ACCESS = 40

OWNER_ACCESS = 50

VISIBILITY_PRIVATE = 0

VISIBILITY_INTERNAL = 10

VISIBILITY_PUBLIC = 20

def Member(self, id=None, **kwargs):

warnings.warn("`Member` is deprecated, use `members` instead",

DeprecationWarning)

return GroupMember._get_list_or_object(self.gitlab, id,

group_id=self.id,

**kwargs)

def transfer_project(self, id, **kwargs):

"""Transfers a project to this new groups.

Attrs:

id (int): ID of the project to transfer.

Raises:

GitlabConnectionError: If the server cannot be reached.

GitlabTransferProjectError: If the server fails to perform the

request.

"""

url = '/groups/%d/projects/%d' % (self.id, id)

r = self.gitlab._raw_post(url, None, **kwargs)

raise_error_from_response(r, GitlabTransferProjectError, 201)

class GroupManager(BaseManager):

obj_cls = Group

def search(self, query, **kwargs):

"""Searches groups by name.

Args:

query (str): The search string

all (bool): If True, return all the items, without pagination

Returns:

list(Group): a list of matching groups.

"""

url = '/groups?search=' + query

return self.gitlab._raw_list(url, self.obj_cls, **kwargs)

class Hook(GitlabObject):

_url = '/hooks'

canUpdate = False

requiredCreateAttrs = ['url']

shortPrintAttr = 'url'

class HookManager(BaseManager):

obj_cls = Hook

class Issue(GitlabObject):

_url = '/issues'

_constructorTypes = {'author': 'User', 'assignee': 'User',

'milestone': 'ProjectMilestone'}

canGet = 'from_list'

canDelete = False

canUpdate = False

canCreate = False

shortPrintAttr = 'title'

class IssueManager(BaseManager):

obj_cls = Issue

class ProjectBranch(GitlabObject):

_url = '/projects/%(project_id)s/repository/branches'

_constructorTypes = {'author': 'User', "committer": "User"}

idAttr = 'name'

canUpdate = False

requiredUrlAttrs = ['project_id']

requiredCreateAttrs = ['branch_name', 'ref']

def protect(self, protect=True, **kwargs):

"""Protects the project."""

url = self._url % {'project_id': self.project_id}

action = 'protect' if protect else 'unprotect'

url = "%s/%s/%s" % (url, self.name, action)

r = self.gitlab._raw_put(url, data=None, content_type=None, **kwargs)

raise_error_from_response(r, GitlabProtectError)

if protect:

self.protected = protect

else:

del self.protected

def unprotect(self, **kwargs):

"""Unprotects the project."""

self.protect(False, **kwargs)

class ProjectBranchManager(BaseManager):

obj_cls = ProjectBranch

class ProjectBuild(GitlabObject):

_url = '/projects/%(project_id)s/builds'

_constructorTypes = {'user': 'User',

'commit': 'ProjectCommit'}

requiredUrlAttrs = ['project_id']

canDelete = False

canUpdate = False

canCreate = False

def cancel(self):

"""Cancel the build."""

url = '/projects/%s/builds/%s/cancel' % (self.project_id, self.id)

r = self.gitlab._raw_post(url)

raise_error_from_response(r, GitlabBuildCancelError, 201)

def retry(self):

"""Retry the build."""

url = '/projects/%s/builds/%s/retry' % (self.project_id, self.id)

r = self.gitlab._raw_post(url)

raise_error_from_response(r, GitlabBuildRetryError, 201)

class ProjectBuildManager(BaseManager):

obj_cls = ProjectBuild

class ProjectCommit(GitlabObject):

_url = '/projects/%(project_id)s/repository/commits'

canDelete = False

canUpdate = False

canCreate = False

requiredUrlAttrs = ['project_id']

shortPrintAttr = 'title'

def diff(self, **kwargs):

"""Generate the commit diff."""

url = ('/projects/%(project_id)s/repository/commits/%(commit_id)s/diff'

% {'project_id': self.project_id, 'commit_id': self.id})

r = self.gitlab._raw_get(url, **kwargs)

raise_error_from_response(r, GitlabGetError)

return r.json()

def blob(self, filepath, **kwargs):

"""Generate the content of a file for this commit.

Args:

filepath (str): Path of the file to request.

Returns:

str: The content of the file

Raises:

GitlabConnectionError: If the server cannot be reached.

GitlabGetError: If the server fails to perform the request.

"""

url = ('/projects/%(project_id)s/repository/blobs/%(commit_id)s' %

{'project_id': self.project_id, 'commit_id': self.id})

url += '?filepath=%s' % filepath

r = self.gitlab._raw_get(url, **kwargs)

raise_error_from_response(r, GitlabGetError)

return r.content

def builds(self, **kwargs):

"""List the build for this commit.

Returns:

list(ProjectBuild): A list of builds.

Raises:

GitlabConnectionError: If the server cannot be reached.

GitlabListError: If the server fails to perform the request.

"""

url = '/projects/%s/repository/commits/%s/builds' % (self.project_id,

self.id)

r = self.gitlab._raw_get(url, **kwargs)

raise_error_from_response(r, GitlabListError)

l = []

for j in r.json():

o = ProjectBuild(self, j)

o._from_api = True

l.append(o)

return l

class ProjectCommitManager(BaseManager):

obj_cls = ProjectCommit

class ProjectCommitStatus(GitlabObject):

_url = '/projects/%(project_id)s/statuses/%(commit_id)s'

canUpdate = False

canDelete = False

requiredUrlAttrs = ['project_id', 'commit_id']

requiredCreateAttrs = ['state']

optionalCreateAttrs = ['description', 'name', 'ref', 'target_url']

class ProjectCommitStatusManager(BaseManager):

obj_cls = ProjectCommitStatus

class ProjectKey(GitlabObject):

_url = '/projects/%(project_id)s/keys'

canUpdate = False

requiredUrlAttrs = ['project_id']

requiredCreateAttrs = ['title', 'key']

class ProjectKeyManager(BaseManager):

obj_cls = ProjectKey

class ProjectEvent(GitlabObject):

_url = '/projects/%(project_id)s/events'

canGet = 'from_list'

canDelete = False

canUpdate = False

canCreate = False

requiredUrlAttrs = ['project_id']

shortPrintAttr = 'target_title'

class ProjectEventManager(BaseManager):

obj_cls = ProjectEvent

class ProjectFork(GitlabObject):

_url = '/projects/fork/%(project_id)s'

canUpdate = False

canDelete = False

canList = False

canGet = False

requiredUrlAttrs = ['project_id']

class ProjectForkManager(BaseManager):

obj_cls = ProjectFork

class ProjectHook(GitlabObject):

_url = '/projects/%(project_id)s/hooks'

requiredUrlAttrs = ['project_id']

requiredCreateAttrs = ['url']

optionalCreateAttrs = ['push_events', 'issues_events',

'merge_requests_events', 'tag_push_events',

'build_events', 'enable_ssl_verification']

shortPrintAttr = 'url'

class ProjectHookManager(BaseManager):

obj_cls = ProjectHook

class ProjectIssueNote(GitlabObject):

_url = '/projects/%(project_id)s/issues/%(issue_id)s/notes'

_constructorTypes = {'author': 'User'}

canUpdate = False

canDelete = False

requiredUrlAttrs = ['project_id', 'issue_id']

requiredCreateAttrs = ['body']

class ProjectIssueNoteManager(BaseManager):

obj_cls = ProjectIssueNote

class ProjectIssue(GitlabObject):

_url = '/projects/%(project_id)s/issues/'

_constructorTypes = {'author': 'User', 'assignee': 'User',

'milestone': 'ProjectMilestone'}

requiredUrlAttrs = ['project_id']

requiredCreateAttrs = ['title']

# FIXME: state_event is only valid with update

optionalCreateAttrs = ['description', 'assignee_id', 'milestone_id',

'labels', 'state_event']

shortPrintAttr = 'title'

managers = [('notes', ProjectIssueNoteManager,

[('project_id', 'project_id'), ('issue_id', 'id')])]

def _data_for_gitlab(self, extra_parameters={}, update=False):

# Gitlab-api returns labels in a json list and takes them in a

# comma separated list.

if hasattr(self, "labels"):

if (self.labels is not None and

not isinstance(self.labels, six.string_types)):

labels = ", ".join(self.labels)

extra_parameters['labels'] = labels

return super(ProjectIssue, self)._data_for_gitlab(extra_parameters)

def Note(self, id=None, **kwargs):

warnings.warn("`Note` is deprecated, use `notes` instead",

DeprecationWarning)

return ProjectIssueNote._get_list_or_object(self.gitlab, id,

project_id=self.project_id,

issue_id=self.id,

**kwargs)

class ProjectIssueManager(BaseManager):

obj_cls = ProjectIssue

class ProjectMember(GitlabObject):

_url = '/projects/%(project_id)s/members'

requiredUrlAttrs = ['project_id']

requiredCreateAttrs = ['access_level', 'user_id']

shortPrintAttr = 'username'

class ProjectMemberManager(BaseManager):

obj_cls = ProjectMember

class ProjectNote(GitlabObject):

_url = '/projects/%(project_id)s/notes'

_constructorTypes = {'author': 'User'}

canUpdate = False

canDelete = False

View remainder of file in raw view

python-gitlab/gitlab/objects.py at master · hungld/python-gitlab · GitHub

Repository navigation

Expand file tree

Breadcrumbs

objects.py

Latest commit

History

Breadcrumbs

objects.py

File metadata and controls