forked from python-gitlab/python-gitlab
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy path__init__.py
More file actions
530 lines (435 loc) · 19.3 KB
/
__init__.py
File metadata and controls
530 lines (435 loc) · 19.3 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
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
# -*- coding: utf-8 -*-
#
# Copyright (C) 2013-2015 Gauvain Pocentek <gauvain@pocentek.net>
#
# 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/>.
"""Package for interfacing with GitLab-api """
from __future__ import print_function
from __future__ import division
from __future__ import absolute_import
import itertools
import json
import warnings
import requests
import six
import gitlab.config
from gitlab.exceptions import * # noqa
from gitlab.objects import * # noqa
__title__ = 'python-gitlab'
__version__ = '0.10'
__author__ = 'Gauvain Pocentek'
__email__ = 'gauvain@pocentek.net'
__license__ = 'LGPL3'
__copyright__ = 'Copyright 2013-2015 Gauvain Pocentek'
warnings.simplefilter('always', DeprecationWarning)
def _sanitize(value):
if isinstance(value, six.string_types):
return value.replace('/', '%2F')
return value
def _sanitize_dict(src):
return dict((k, _sanitize(v)) for k, v in src.items())
class Gitlab(object):
"""Represents a GitLab server connection
Args:
url (str): the URL of the Gitlab server
private_token (str): the user private token
email (str): the user email/login
password (str): the user password (associated with email)
ssl_verify (bool): (Passed to requests-library)
timeout (float or tuple(float,float)): (Passed to
requests-library). Timeout to use for requests to gitlab server
"""
def __init__(self, url, private_token=None,
email=None, password=None, ssl_verify=True, timeout=None):
self._url = '%s/api/v3' % url
#: Timeout to use for requests to gitlab server
self.timeout = timeout
#: Headers that will be used in request to GitLab
self.headers = {}
self.set_token(private_token)
#: the user email
self.email = email
#: the user password (associated with email)
self.password = password
#: (Passed to requests-library)
self.ssl_verify = ssl_verify
self.user_keys = UserKeyManager(self)
self.users = UserManager(self)
self.group_members = GroupMemberManager(self)
self.groups = GroupManager(self)
self.hooks = HookManager(self)
self.issues = IssueManager(self)
self.project_branches = ProjectBranchManager(self)
self.project_commits = ProjectCommitManager(self)
self.project_keys = ProjectKeyManager(self)
self.project_events = ProjectEventManager(self)
self.project_hooks = ProjectHookManager(self)
self.project_issue_notes = ProjectIssueNoteManager(self)
self.project_issues = ProjectIssueManager(self)
self.project_members = ProjectMemberManager(self)
self.project_notes = ProjectNoteManager(self)
self.project_tags = ProjectTagManager(self)
self.project_mergerequest_notes = ProjectMergeRequestNoteManager(self)
self.project_mergerequests = ProjectMergeRequestManager(self)
self.project_milestones = ProjectMilestoneManager(self)
self.project_labels = ProjectLabelManager(self)
self.project_files = ProjectFileManager(self)
self.project_snippet_notes = ProjectSnippetNoteManager(self)
self.project_snippets = ProjectSnippetManager(self)
self.user_projects = UserProjectManager(self)
self.projects = ProjectManager(self)
self.team_members = TeamMemberManager(self)
self.team_projects = TeamProjectManager(self)
self.teams = TeamManager(self)
@staticmethod
def from_config(gitlab_id=None, config_files=None):
config = gitlab.config.GitlabConfigParser(gitlab_id=gitlab_id,
config_files=config_files)
return Gitlab(config.url, private_token=config.token,
ssl_verify=config.ssl_verify, timeout=config.timeout)
def auth(self):
"""Performs an authentication.
Uses either the private token, or the email/password pair.
The user attribute will hold a CurrentUser object on success.
"""
if self.private_token:
self.token_auth()
else:
self.credentials_auth()
def credentials_auth(self):
if not self.email or not self.password:
raise GitlabAuthenticationError("Missing email/password")
data = json.dumps({'email': self.email, 'password': self.password})
r = self._raw_post('/session', data, content_type='application/json')
raise_error_from_response(r, GitlabAuthenticationError, 201)
self.user = CurrentUser(self, r.json())
self.set_token(self.user.private_token)
def token_auth(self):
self.user = CurrentUser(self)
def set_url(self, url):
"""Updates the gitlab URL."""
self._url = '%s/api/v3' % url
def _construct_url(self, id_, obj, parameters):
if 'next_url' in parameters:
return parameters['next_url']
args = _sanitize_dict(parameters)
if id_ is None and obj._urlPlural is not None:
url = obj._urlPlural % args
else:
url = obj._url % args
if id_ is not None:
url = '%s%s/%s' % (self._url, url, str(id_))
else:
url = '%s%s' % (self._url, url)
return url
def _create_headers(self, content_type=None, headers={}):
request_headers = self.headers.copy()
request_headers.update(headers)
if content_type is not None:
request_headers['Content-type'] = content_type
return request_headers
def set_token(self, token):
"""Sets the private token for authentication."""
self.private_token = token if token else None
if token:
self.headers["PRIVATE-TOKEN"] = token
elif "PRIVATE-TOKEN" in self.headers:
del self.headers["PRIVATE-TOKEN"]
def set_credentials(self, email, password):
"""Sets the email/login and password for authentication."""
self.email = email
self.password = password
def _raw_get(self, path, content_type=None, **kwargs):
url = '%s%s' % (self._url, path)
headers = self._create_headers(content_type)
try:
return requests.get(url,
params=kwargs,
headers=headers,
verify=self.ssl_verify,
timeout=self.timeout)
except Exception:
raise GitlabConnectionError(
"Can't connect to GitLab server (%s)" % self._url)
def _raw_post(self, path, data=None, content_type=None, **kwargs):
url = '%s%s' % (self._url, path)
headers = self._create_headers(content_type)
try:
return requests.post(url, params=kwargs, data=data,
headers=headers,
verify=self.ssl_verify,
timeout=self.timeout)
except Exception:
raise GitlabConnectionError(
"Can't connect to GitLab server (%s)" % self._url)
def _raw_put(self, path, data=None, content_type=None, **kwargs):
url = '%s%s' % (self._url, path)
headers = self._create_headers(content_type)
try:
return requests.put(url, data=data, params=kwargs,
headers=headers,
verify=self.ssl_verify,
timeout=self.timeout)
except Exception:
raise GitlabConnectionError(
"Can't connect to GitLab server (%s)" % self._url)
def _raw_delete(self, path, content_type=None, **kwargs):
url = '%s%s' % (self._url, path)
headers = self._create_headers(content_type)
try:
return requests.delete(url,
params=kwargs,
headers=headers,
verify=self.ssl_verify,
timeout=self.timeout)
except Exception:
raise GitlabConnectionError(
"Can't connect to GitLab server (%s)" % self._url)
def list(self, obj_class, **kwargs):
missing = []
for k in itertools.chain(obj_class.requiredUrlAttrs,
obj_class.requiredListAttrs):
if k not in kwargs:
missing.append(k)
if missing:
raise GitlabListError('Missing attribute(s): %s' %
", ".join(missing))
url = self._construct_url(id_=None, obj=obj_class, parameters=kwargs)
headers = self._create_headers()
# Remove attributes that are used in url so that there is only
# url-parameters left
params = kwargs.copy()
for attribute in obj_class.requiredUrlAttrs:
del params[attribute]
try:
r = requests.get(url, params=params, headers=headers,
verify=self.ssl_verify,
timeout=self.timeout)
except Exception:
raise GitlabConnectionError(
"Can't connect to GitLab server (%s)" % self._url)
raise_error_from_response(r, GitlabListError)
cls = obj_class
if obj_class._returnClass:
cls = obj_class._returnClass
cls_kwargs = kwargs.copy()
# Add _from_api manually, because we are not creating objects
# through normal path
cls_kwargs['_from_api'] = True
get_all_results = params.get('all', False)
# Remove parameters from kwargs before passing it to constructor
for key in ['all', 'page', 'per_page', 'sudo']:
if key in cls_kwargs:
del cls_kwargs[key]
results = [cls(self, item, **cls_kwargs) for item in r.json()
if item is not None]
if ('next' in r.links and 'url' in r.links['next']
and get_all_results is True):
args = kwargs.copy()
args['next_url'] = r.links['next']['url']
results.extend(self.list(obj_class, **args))
return results
def get(self, obj_class, id=None, **kwargs):
missing = []
for k in itertools.chain(obj_class.requiredUrlAttrs,
obj_class.requiredGetAttrs):
if k not in kwargs:
missing.append(k)
if missing:
raise GitlabGetError('Missing attribute(s): %s' %
", ".join(missing))
sanitized_id = _sanitize(id)
url = self._construct_url(id_=sanitized_id, obj=obj_class,
parameters=kwargs)
headers = self._create_headers()
# Remove attributes that are used in url so that there is only
# url-parameters left
params = kwargs.copy()
for attribute in obj_class.requiredUrlAttrs:
del params[attribute]
try:
r = requests.get(url, params=params, headers=headers,
verify=self.ssl_verify, timeout=self.timeout)
except Exception:
raise GitlabConnectionError(
"Can't connect to GitLab server (%s)" % self._url)
raise_error_from_response(r, GitlabGetError)
return r.json()
def delete(self, obj, **kwargs):
params = obj.__dict__.copy()
params.update(kwargs)
missing = []
for k in itertools.chain(obj.requiredUrlAttrs,
obj.requiredDeleteAttrs):
if k not in params:
missing.append(k)
if missing:
raise GitlabDeleteError('Missing attribute(s): %s' %
", ".join(missing))
obj_id = getattr(obj, obj.idAttr)
url = self._construct_url(id_=obj_id, obj=obj, parameters=params)
headers = self._create_headers()
# Remove attributes that are used in url so that there is only
# url-parameters left
for attribute in obj.requiredUrlAttrs:
del params[attribute]
try:
r = requests.delete(url,
params=params,
headers=headers,
verify=self.ssl_verify,
timeout=self.timeout)
except Exception:
raise GitlabConnectionError(
"Can't connect to GitLab server (%s)" % self._url)
raise_error_from_response(r, GitlabDeleteError)
return True
def create(self, obj, **kwargs):
params = obj.__dict__.copy()
params.update(kwargs)
missing = []
for k in itertools.chain(obj.requiredUrlAttrs,
obj.requiredCreateAttrs):
if k not in params:
missing.append(k)
if missing:
raise GitlabCreateError('Missing attribute(s): %s' %
", ".join(missing))
url = self._construct_url(id_=None, obj=obj, parameters=params)
headers = self._create_headers(content_type="application/json")
# build data that can really be sent to server
data = obj._data_for_gitlab(extra_parameters=kwargs)
try:
r = requests.post(url, data=data,
headers=headers,
verify=self.ssl_verify,
timeout=self.timeout)
except Exception:
raise GitlabConnectionError(
"Can't connect to GitLab server (%s)" % self._url)
raise_error_from_response(r, GitlabCreateError, 201)
return r.json()
def update(self, obj, **kwargs):
params = obj.__dict__.copy()
params.update(kwargs)
missing = []
for k in itertools.chain(obj.requiredUrlAttrs,
obj.requiredCreateAttrs):
if k not in params:
missing.append(k)
if missing:
raise GitlabUpdateError('Missing attribute(s): %s' %
", ".join(missing))
url = self._construct_url(id_=obj.id, obj=obj, parameters=params)
headers = self._create_headers(content_type="application/json")
# build data that can really be sent to server
data = obj._data_for_gitlab(extra_parameters=kwargs)
try:
r = requests.put(url, data=data,
headers=headers,
verify=self.ssl_verify,
timeout=self.timeout)
except Exception:
raise GitlabConnectionError(
"Can't connect to GitLab server (%s)" % self._url)
raise_error_from_response(r, GitlabUpdateError)
return r.json()
def Hook(self, id=None, **kwargs):
"""Creates/tests/lists system hook(s) known by the GitLab server.
If id is None, returns a list of hooks.
If id is an integer, tests the matching hook.
If id is a dict, creates a new object using attributes provided. The
object is NOT saved on the server. Use the save() method on the object
to write it on the server.
"""
return Hook._get_list_or_object(self, id, **kwargs)
def Project(self, id=None, **kwargs):
"""Creates/gets/lists project(s) known by the GitLab server.
If id is None, returns a list of projects.
If id is an integer, returns the matching project (or raises a
GitlabGetError if not found)
If id is a dict, creates a new object using attributes provided. The
object is NOT saved on the server. Use the save() method on the object
to write it on the server.
"""
return Project._get_list_or_object(self, id, **kwargs)
def UserProject(self, id=None, **kwargs):
"""Creates a project for a user.
id must be a dict.
"""
return UserProject._get_list_or_object(self, id, **kwargs)
def ProjectFork(self, id=None, **kwargs):
"""Fork a project for a user.
id must be a dict.
"""
return ProjectFork._get_list_or_object(self, id, **kwargs)
def _list_projects(self, url, **kwargs):
r = self._raw_get(url, **kwargs)
raise_error_from_response(r, GitlabListError)
l = []
for o in r.json():
p = Project(self, o)
p._from_api = True
l.append(p)
return l
def search_projects(self, query, **kwargs):
"""Searches projects by name.
Returns a list of matching projects.
"""
return self._list_projects("/projects/search/" + query, **kwargs)
def all_projects(self, **kwargs):
"""Lists all the projects (need admin rights)."""
return self._list_projects("/projects/all", **kwargs)
def owned_projects(self, **kwargs):
"""Lists owned projects."""
return self._list_projects("/projects/owned", **kwargs)
def Group(self, id=None, **kwargs):
"""Creates/gets/lists group(s) known by the GitLab server
Args:
id: If id is None, returns a list of groups.
id: If id is an integer,
returns the matching group (or raises a GitlabGetError if not
found).
id: If id is a dict, creates a new object using attributes
provided. The object is NOT saved on the server. Use the
save() method on the object to write it on the server.
kwargs: Arbitrary keyword arguments
"""
return Group._get_list_or_object(self, id, **kwargs)
def Issue(self, id=None, **kwargs):
"""Lists issues(s) known by the GitLab server.
Does not support creation or getting a single issue unlike other
methods in this class yet.
"""
return Issue._get_list_or_object(self, id, **kwargs)
def User(self, id=None, **kwargs):
"""Creates/gets/lists users(s) known by the GitLab server.
If id is None, returns a list of users.
If id is an integer, returns the matching user (or raises a
GitlabGetError if not found)
If id is a dict, creates a new object using attributes provided. The
object is NOT saved on the server. Use the save() method on the object
to write it on the server.
"""
return User._get_list_or_object(self, id, **kwargs)
def Team(self, id=None, **kwargs):
"""Creates/gets/lists team(s) known by the GitLab server.
If id is None, returns a list of teams.
If id is an integer, returns the matching team (or raises a
GitlabGetError if not found)
If id is a dict, create a new object using attributes provided. The
object is NOT saved on the server. Use the save() method on the object
to write it on the server.
"""
return Team._get_list_or_object(self, id, **kwargs)