def default(self, obj):

if isinstance(obj, GitlabObject):

return obj.as_dict()

elif isinstance(obj, gitlab.Gitlab):

return {'url': obj._url}

"""Base manager class for API operations.

obj_cls = None

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

"""Constructs a manager.

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 = 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 = 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 = 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 = self._set_parent_args(**kwargs)

if not self.obj_cls.canDelete:

raise NotImplementedError

"""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 optional when retrieving list of objects.

optionalListAttrs = []

#: Attributes that are optional when retrieving single object.

optionalGetAttrs = []

#: 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):

value = getattr(self, attribute)

if isinstance(value, list):

value = ",".join(value)

data[attribute] = value

data.update(extra_parameters)

return json.dumps(data)

@classmethod

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

"""Retrieve a list of objects from GitLab.

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.

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.

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.

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

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

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.

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

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

canGet = 'from_list'

canUpdate = False

requiredUrlAttrs = ['user_id']

_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

obj_cls = User

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

"""Search users.

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.

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:

_url = '/user/keys'

canUpdate = False

shortPrintAttr = 'title'

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

_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

_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

_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.

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

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

obj_cls = Group

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

"""Searches groups by name.

url = '/groups?search=' + query

_url = '/hooks'

canUpdate = False

requiredCreateAttrs = ['url']

_url = '/issues'

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

'milestone': 'ProjectMilestone'}

canGet = 'from_list'

canDelete = False

canUpdate = False

canCreate = False

_url = '/licenses'

canDelete = False

canUpdate = False

canCreate = False

idAttr = 'key'

optionalListAttrs = ['popular']

_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."""

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

_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.

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.

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)

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

canUpdate = False

canDelete = False

requiredUrlAttrs = ['project_id', 'commit_id']

requiredCreateAttrs = ['state']

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

canUpdate = False

requiredUrlAttrs = ['project_id']

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

canGet = 'from_list'

canDelete = False

canUpdate = False

canCreate = False

requiredUrlAttrs = ['project_id']

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

canUpdate = False

canDelete = False

canList = False

canGet = False

_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']

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

_constructorTypes = {'author': 'User'}

canDelete = False

requiredUrlAttrs = ['project_id', 'issue_id']

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