python-gitlab-python-gitlab/gitlab/v4/objects/epics.py at master · alvistack/python-gitlab-python-gitlab · GitHub

Repository navigation

History

105 lines (86 loc) · 3.42 KB

Raw

100

101

102

103

104

105

from gitlab import exceptions as exc

from gitlab import types

from gitlab.base import RequiredOptional, RESTManager, RESTObject

from gitlab.mixins import (

CreateMixin,

CRUDMixin,

DeleteMixin,

ListMixin,

ObjectDeleteMixin,

SaveMixin,

UpdateMixin,

)

from .events import GroupEpicResourceLabelEventManager # noqa: F401

__all__ = [

"GroupEpic",

"GroupEpicManager",

"GroupEpicIssue",

"GroupEpicIssueManager",

]

class GroupEpic(ObjectDeleteMixin, SaveMixin, RESTObject):

_id_attr = "iid"

_managers = (

("issues", "GroupEpicIssueManager"),

("resourcelabelevents", "GroupEpicResourceLabelEventManager"),

)

class GroupEpicManager(CRUDMixin, RESTManager):

_path = "/groups/%(group_id)s/epics"

_obj_cls = GroupEpic

_from_parent_attrs = {"group_id": "id"}

_list_filters = ("author_id", "labels", "order_by", "sort", "search")

_create_attrs = RequiredOptional(

required=("title",),

optional=("labels", "description", "start_date", "end_date"),

)

_update_attrs = RequiredOptional(

optional=("title", "labels", "description", "start_date", "end_date"),

)

_types = {"labels": types.ListAttribute}

class GroupEpicIssue(ObjectDeleteMixin, SaveMixin, RESTObject):

_id_attr = "epic_issue_id"

def save(self, **kwargs):

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

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

# call the manager

obj_id = self.get_id()

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

class GroupEpicIssueManager(

ListMixin, CreateMixin, UpdateMixin, DeleteMixin, RESTManager

_path = "/groups/%(group_id)s/epics/%(epic_iid)s/issues"

_obj_cls = GroupEpicIssue

_from_parent_attrs = {"group_id": "group_id", "epic_iid": "iid"}

_create_attrs = RequiredOptional(required=("issue_id",))

_update_attrs = RequiredOptional(optional=("move_before_id", "move_after_id"))

@exc.on_http_error(exc.GitlabCreateError)

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

"""Create a new object.

Args:

data (dict): Parameters to send to the server to create the

resource

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

Raises:

GitlabAuthenticationError: If authentication is not correct

GitlabCreateError: If the server cannot perform the request

Returns:

RESTObject: A new instance of the manage object class build with

the data sent by the server

"""

CreateMixin._check_missing_create_attrs(self, data)

path = "%s/%s" % (self.path, data.pop("issue_id"))

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

# The epic_issue_id attribute doesn't exist when creating the resource,

# but is used everywhere elese. Let's create it to be consistent client

# side

server_data["epic_issue_id"] = server_data["id"]

return self._obj_cls(self, server_data)

python-gitlab-python-gitlab/gitlab/v4/objects/epics.py at master · alvistack/python-gitlab-python-gitlab · GitHub

Repository navigation

Expand file tree

Breadcrumbs

epics.py

Latest commit

History

Breadcrumbs

epics.py

File metadata and controls