diff options
Diffstat (limited to 'pygithub3/services/issues')
| -rw-r--r-- | pygithub3/services/issues/__init__.py | 97 | ||||
| -rw-r--r-- | pygithub3/services/issues/comments.py | 53 | ||||
| -rw-r--r-- | pygithub3/services/issues/events.py | 18 | ||||
| -rw-r--r-- | pygithub3/services/issues/labels.py | 170 |
4 files changed, 218 insertions, 120 deletions
diff --git a/pygithub3/services/issues/__init__.py b/pygithub3/services/issues/__init__.py index e8e3493..ada2dca 100644 --- a/pygithub3/services/issues/__init__.py +++ b/pygithub3/services/issues/__init__.py @@ -1,12 +1,16 @@ # -*- encoding: utf-8 -*- -from pygithub3.services.base import Service +from datetime import datetime + +from pygithub3.services.base import Service, MimeTypeMixin +from pygithub3.resources.base import GITHUB_DATE_FORMAT from .comments import Comments from .events import Events from .labels import Labels from .milestones import Milestones -class Issue(Service): + +class Issue(Service, MimeTypeMixin): """ Consume `Issues API <http://developer.github.com/v3/issues>`_ """ def __init__(self, **config): @@ -16,70 +20,115 @@ class Issue(Service): self.milestones = Milestones(**config) super(Issue, self).__init__(**config) - def list(self, data={}): + def list(self, filter='assigned', state='open', labels='', sort='created', + direction='desc', since=None): """ List your issues - :param dict data: Input. See `github issues doc`_ + :param str filter: 'assigned', 'created', 'mentioned' or 'subscribed' + :param str state: 'open' or 'closed' + :param str labels: List of comma separated Label names. e.g: bug,ui, + @high + :param str sort: 'created', 'updated' or 'comments' + :param str direction: 'asc' or 'desc' + :param datetime since: Date filter :returns: A :doc:`result` .. warning:: You must be authenticated """ - request = self.request_builder('issues.list', body=data) - return self._get_result(request) - - def list_by_repo(self, user, repo, data={}): + params = dict(filter=filter, state=state, labels=labels, sort=sort, + direction=direction) + try: + date = datetime.strptime(since, GITHUB_DATE_FORMAT) + params.update(since=date) + except: + pass + + request = self.request_builder('issues.list') + return self._get_result(request, **params) + + def list_by_repo(self, user=None, repo=None, milestone='*', state='open', + assignee='*', mentioned='', labels='', sort='created', + direction='desc', since=None): """ List issues for a repo - :param dict data: Input. See `github issues doc`_ + :param str milestone: Milestone ID, 'none' or '*' + :param str state: 'open' or 'closed' + :param str assignee: Username, 'none' or '*' + :param str mentioned: Username + :param str labels: List of comma separated Label names. e.g: bug,ui, + @high + :param str sort: 'created', 'updated' or 'comments' + :param str direction: 'asc' or 'desc' + :param datetime since: Date filter :returns: A :doc:`result` - """ - request = self.request_builder('issues.list_by_repo', user=user, - repo=repo, body=data) - return self._get_result(request) - def get(self, user, repo, number): + .. note:: + Remember :ref:`config precedence` + """ + params = dict(milestone=milestone, state=state, assignee=assignee, + mentioned=mentioned, labels=labels, sort=sort, direction=direction) + try: + date = datetime.strptime(since, GITHUB_DATE_FORMAT) + params.update(since=date) + except: + pass + + request = self.make_request('issues.list_by_repo', user=user, + repo=repo) + return self._get_result(request, **params) + + def get(self, number, user=None, repo=None): """ Get a single issue + :param int number: Issue number :param str user: Username :param str repo: Repo name - :param int number: Issue number + + .. note:: + Remember :ref:`config precedence` """ - request = self.request_builder('issues.get', user=user, repo=repo, + request = self.make_request('issues.get', user=user, repo=repo, number=number) return self._get(request) - def create(self, user, repo, data): + def create(self, data, user=None, repo=None): """ Create an issue + :param dict data: Input. See `github issues doc`_ :param str user: Username :param str repo: Repo name - :param dict data: Input. See `github issues doc`_ .. warning:: You must be authenticated + .. note:: + Remember :ref:`config precedence` + :: - issues_service.create(dict(title='My test issue', + issues_service.create(dict(title='My test issue', body='This needs to be fixed ASAP.', assignee='copitux')) """ - request = self.request_builder('issues.create', user=user, repo=repo, + request = self.make_request('issues.create', user=user, repo=repo, body=data) return self._post(request) - def update(self, user, repo, number, data): + def update(self, number, data, user=None, repo=None): """ Update an issue - :param str user: Username - :param str repo: Repo name :param int number: Issue number :param dict data: Input. See `github issues doc`_ + :param str user: Username + :param str repo: Repo name .. warning:: You must be authenticated + + .. note:: + Remember :ref:`config precedence` """ - request = self.request_builder('issues.edit', user=user, repo=repo, + request = self.make_request('issues.update', user=user, repo=repo, number=number, body=data) return self._patch(request) diff --git a/pygithub3/services/issues/comments.py b/pygithub3/services/issues/comments.py index d007286..2b976a8 100644 --- a/pygithub3/services/issues/comments.py +++ b/pygithub3/services/issues/comments.py @@ -1,74 +1,89 @@ #!/usr/bin/env python # -*- encoding: utf-8 -*- -from pygithub3.services.base import Service +from pygithub3.services.base import Service, MimeTypeMixin -class Comments(Service): - """ Consume `Comments API +class Comments(Service, MimeTypeMixin): + """ Consume `Comments API <http://developer.github.com/v3/issues/comments>`_ """ - def list(self, user, repo, number): + def list(self, number, user=None, repo=None): """ List comments for an issue + :param int number: Issue number :param str user: Username :param str repo: Repo name - :param int number: Issue number :returns: A :doc:`result` + + .. note:: + Remember :ref:`config precedence` """ - request = self.request_builder('issues.comments.list', user=user, + request = self.make_request('issues.comments.list', user=user, repo=repo, number=number) return self._get_result(request) - def get(self, user, repo, id): + def get(self, id, user=None, repo=None): """ Get a single comment + :param int id: Comment id :param str user: Username :param str repo: Repo name - :param int id: Comment id + + .. note:: + Remember :ref:`config precedence` """ - request = self.request_builder('issues.comments.get', user=user, + request = self.make_request('issues.comments.get', user=user, repo=repo, id=id) return self._get(request) - def create(self, user, repo, number, message): + def create(self, number, message, user=None, repo=None): """ Create a comment on an issue - :param str user: Username - :param str repo: Repo name :param int number: Issue number :param str message: Comment message + :param str user: Username + :param str repo: Repo name .. warning:: You must be authenticated + + .. note:: + Remember :ref:`config precedence` """ - request = self.request_builder('issues.comments.create', user=user, + request = self.make_request('issues.comments.create', user=user, repo=repo, number=number, body={'body': message}) return self._post(request) - def update(self, user, repo, id, message): + def update(self, id, message, user=None, repo=None): """ Update a comment on an issue - :param str user: Username - :param str repo: Repo name :param int id: Issue id :param str message: Comment message + :param str user: Username + :param str repo: Repo name .. warning:: You must be authenticated + + .. note:: + Remember :ref:`config precedence` """ - request = self.request_builder('issues.comments.edit', user=user, + request = self.request_builder('issues.comments.edit', user=user, repo=repo, id=id, body={'body': message}) return self._patch(request) - def delete(self, user, repo, id): + def delete(self, id, user=None, repo=None): """ Delete a single comment + :param int id: Comment id :param str user: Username :param str repo: Repo name - :param int id: Comment id .. warning:: You must be authenticated + + .. note:: + Remember :ref:`config precedence` """ request = self.request_builder('issues.comments.delete', user=user, repo=repo, id=id) diff --git a/pygithub3/services/issues/events.py b/pygithub3/services/issues/events.py index 8eb35e4..3fd94e3 100644 --- a/pygithub3/services/issues/events.py +++ b/pygithub3/services/issues/events.py @@ -4,39 +4,39 @@ from pygithub3.services.base import Service class Events(Service): - """ Consume `Events API + """ Consume `Events API <http://developer.github.com/v3/issues/events>`_ """ - def list_by_issue(self, user, repo, number): + def list_by_issue(self, number, user=None, repo=None): """ List events for an issue + :param int number: Issue number :param str user: Username :param str repo: Repo name - :param int number: Issue number :returns: A :doc:`result` """ - request = self.request_builder('issues.events.list_by_issue', + request = self.make_request('issues.events.list_by_issue', user=user, repo=repo, number=number) return self._get_result(request) - def list_by_repo(self, user, repo): + def list_by_repo(self, user=None, repo=None): """ List events for a repository :param str user: Username :param str repo: Repo name :returns: A :doc:`result` """ - request = self.request_builder('issues.events.list_by_repo', + request = self.request_builder('issues.events.list_by_repo', user=user, repo=repo) return self._get_result(request) - def get(self, user, repo, id): + def get(self, id, user=None, repo=None): """ Get a single event + :param int id: Comment id :param str user: Username :param str repo: Repo name - :param int id: Comment id """ - request = self.request_builder('issues.events.get', user=user, + request = self.make_request('issues.events.get', user=user, repo=repo, id=id) return self._get(request) diff --git a/pygithub3/services/issues/labels.py b/pygithub3/services/issues/labels.py index 6aea6e7..a20e48e 100644 --- a/pygithub3/services/issues/labels.py +++ b/pygithub3/services/issues/labels.py @@ -5,156 +5,190 @@ from pygithub3.services.base import Service class Labels(Service): - """ Consume `Labels API + """ Consume `Labels API <http://developer.github.com/v3/issues/labels>`_ """ - def get(self, user, repo, name): + def list(self, user=None, repo=None): + """ Get repository's labels + + :param str user: Username + :param str repo: Repository + :returns: A :doc:`result` + + .. note:: + Remember :ref:`config precedence` + """ + request = self.make_request('issues.labels.list', user=user, repo=repo) + return self._get_result(request) + + def get(self, name, user=None, repo=None): """ Get a single label + :param str name: Label name :param str user: Username :param str repo: Repo name - :param str name: Label name + + .. note:: + Remember :ref:`config precedence` """ - request = self.request_builder('issues.labels.get', user=user, + request = self.make_request('issues.labels.get', user=user, repo=repo, name=name) return self._get(request) - def create(self, user, repo, name, color): + def create(self, data, user=None, repo=None): """ Create a label on an repo + :param dict data: Input. See `github labels doc`_ :param str user: Username :param str repo: Repo name - :param str name: Label name - :param str color: Label color .. warning:: You must be authenticated + + .. note:: + Remember :ref:`config precedence` """ - request = self.request_builder('issues.labels.create', - user=user, - repo=repo, - body={'name': name, - 'color': color,}) + request = self.make_request('issues.labels.create', user=user, + repo=repo, body=data) return self._post(request) - def update(self, user, repo, name, new_name, color): + def update(self, name, data, user=None, repo=None): """ Update a label on an repo + :param str name: Label name + :param dict data: Input. See `github labels doc`_ :param str user: Username :param str repo: Repo name - :param str name: Label name - :param str name: Label new name - :param str color: Label color .. warning:: You must be authenticated + + .. note:: + Remember :ref:`config precedence` """ - request = self.request_builder('issues.labels.update', - user=user, - repo=repo, - name=name, - body={'name': new_name, - 'color': color,}) + request = self.make_request('issues.labels.update', user=user, + repo=repo, name=name, body=data) return self._patch(request) - def delete(self, user, repo, name): + def delete(self, name, user=None, repo=None): """ Delete a label on an repo + :param str name: Label name :param str user: Username :param str repo: Repo name - :param str name: Label name .. warning:: You must be authenticated - """ - request = self.request_builder('issues.labels.delete', - user=user, - repo=repo, - name=name) - return self._delete(request) - - def list_by_repo(self, user, repo): - """ List all labels for a repo - :param str user: Username - :param str repo: Repo name - :returns: A :doc:`result` + .. note:: + Remember :ref:`config precedence` """ - request = self.request_builder('issues.labels.list_by_repo', - user=user, - repo=repo,) - return self._get(request) + request = self.make_request('issues.labels.delete', user=user, + repo=repo, name=name) + return self._delete(request) - def list_by_issue(self, user, repo, number): + def list_by_issue(self, number, user=None, repo=None): """ List labels for an issue + :param int number: Issue number :param str user: Username :param str repo: Repo name - :param int number: Issue number :returns: A :doc:`result` + + .. note:: + Remember :ref:`config precedence` """ - request = self.request_builder('issues.labels.list_by_issue', user=user, + request = self.make_request('issues.labels.list_by_issue', user=user, repo=repo, number=number) return self._get(request) - def add_to_issue(self, user, repo, number, labels): + def add_to_issue(self, number, user=None, repo=None, *labels): """ Add labels to issue + :param int number: Issue number :param str user: Username :param str repo: Repo name - :param int number: Issue number - :param list labels: List of label names + :param list labels: Label names :returns: A :doc:`result` + + .. note:: + Remember :ref:`config precedence` + + :: + + labels_service.add_to_issue(2, user='github', repo='github', + 'label1', 'label2', 'label3') """ - request = self.request_builder('issues.labels.add_to_issue', - user=user, - repo=repo, - number=number, - body=labels) + request = self.make_request('issues.labels.add_to_issue', user=user, + repo=repo, number=number, body=map(str, labels)) return self._post(request) - def remove_from_issue(self, user, repo, number, label): + def remove_from_issue(self, number, label, user=None, repo=None): """ Remove a label from an issue - :param str user: Username - :param str repo: Repo name :param int number: Issue number :param str label: Label name + :param str user: Username + :param str repo: Repo name :returns: A :doc:`result` + + .. note:: + Remember :ref:`config precedence` """ - request = self.request_builder('issues.labels.remove_from_issue', - user=user, - repo=repo, + request = self.make_request('issues.labels.remove_from_issue', + user=user, + repo=repo, number=number, name=label) return self._delete(request) - def replace_all(self, user, repo, number, labels): + def replace_all(self, number, labels, user=None, repo=None): """ Replace all labels of a issue + :param int number: Issue number + :param list labels: New labels :param str user: Username :param str repo: Repo name - :param int number: Issue number - :param list labels: New labels :returns: A :doc:`result` + + .. note:: + Remember :ref:`config precedence` """ - request = self.request_builder('issues.labels.replace_all', - user=user, - repo=repo, + request = self.make_request('issues.labels.replace_all', + user=user, + repo=repo, number=number, body=labels,) return self._put(request) - def remove_all(self, user, repo, number): + def remove_all(self, number, user=None, repo=None): """ Remove all labels from a issue + :param int number: Issue number :param str user: Username :param str repo: Repo name - :param int number: Issue number :returns: A :doc:`result` + + .. note:: + Remember :ref:`config precedence` """ - request = self.request_builder('issues.labels.remove_all', - user=user, - repo=repo, + request = self.make_request('issues.labels.remove_all', + user=user, + repo=repo, number=number,) return self._delete(request) + + def list_by_milestone(self, number, user=None, repo=None): + """ Get labels for every issue in a milestone + + :param int number: Milestone ID + :param str user: Username + :param str repo: Repo name + :returns: A :doc:`result` + + .. note:: + Remember :ref:`config precedence` + """ + request = self.make_request('issues.labels.list_by_milestone', + user=user, repo=repo, number=number) + return self._get_result(request) |