diff options
Diffstat (limited to 'pygithub3/services')
| -rw-r--r-- | pygithub3/services/pull_requests/__init__.py | 40 | ||||
| -rw-r--r-- | pygithub3/services/pull_requests/comments.py | 31 |
2 files changed, 52 insertions, 19 deletions
diff --git a/pygithub3/services/pull_requests/__init__.py b/pygithub3/services/pull_requests/__init__.py index 66d9e58..545f862 100644 --- a/pygithub3/services/pull_requests/__init__.py +++ b/pygithub3/services/pull_requests/__init__.py @@ -1,4 +1,5 @@ -from pygithub3.exceptions import BadRequest, NotFound +# -*- encoding: utf-8 -*- + from pygithub3.services.base import Service, MimeTypeMixin from .comments import Comments @@ -15,7 +16,10 @@ class PullRequests(Service, MimeTypeMixin): :param str user: Username :param str repo: Repository + :returns: A :doc:`result` + .. note:: + Remember :ref:`config precedence` """ return self._get_result( self.make_request('pull_requests.list', user=user, repo=repo) @@ -28,37 +32,43 @@ class PullRequests(Service, MimeTypeMixin): :param str user: Username :param str repo: Repository + .. note:: + Remember :ref:`config precedence` """ return self._get( self.make_request('pull_requests.get', number=number, user=user, repo=repo) ) - def create(self, body, user=None, repo=None): + def create(self, data, user=None, repo=None): """Create a pull request - :param dict body: Data for the new pull request + :param dict data: Input. See `github pullrequests doc`_ :param str user: Username :param str repo: Repository + .. note:: + Remember :ref:`config precedence` """ return self._post( - self.make_request('pull_requests.create', body=body, user=user, + self.make_request('pull_requests.create', body=data, user=user, repo=repo) ) - def update(self, number, body, user=None, repo=None): + def update(self, number, data, user=None, repo=None): """Update a pull request :param str number: The number of the the pull request to update - :param dict body: The data to update the pull request with + :param dict data: Input. See `github pullrequests doc`_ :param str user: Username :param str repo: Repository + .. note:: + Remember :ref:`config precedence` """ return self._patch( self.make_request('pull_requests.update', number=number, - body=body, user=user, repo=repo) + body=data, user=user, repo=repo) ) def list_commits(self, number, user=None, repo=None): @@ -67,7 +77,10 @@ class PullRequests(Service, MimeTypeMixin): :param str number: The number of the pull request to list commits for :param str user: Username :param str repo: Repository + :returns: A :doc:`result` + .. note:: + Remember :ref:`config precedence` """ return self._get_result( self.make_request('pull_requests.list_commits', number=number, @@ -80,23 +93,28 @@ class PullRequests(Service, MimeTypeMixin): :param str number: The number of the pull request to list files for :param str user: Username :param str repo: Repository + :returns: A :doc:`result` + .. note:: + Remember :ref:`config precedence` """ return self._get_result( self.make_request('pull_requests.list_files', number=number, user=user, repo=repo) ) - def merge_status(self, number, user=None, repo=None): + def is_merged(self, number, user=None, repo=None): """Gets whether a pull request has been merged or not. :param str number: The pull request to check :param str user: Username :param str repo: Repository + .. note:: + Remember :ref:`config precedence` """ return self._bool( - self.make_request('pull_requests.merge_status', number=number, + self.make_request('pull_requests.is_merged', number=number, user=user, repo=repo) ) @@ -104,9 +122,13 @@ class PullRequests(Service, MimeTypeMixin): """Merge a pull request. :param str number: The pull request to merge + :param str message: Message of pull request :param str user: Username :param str repo: Repository + .. note:: + Remember :ref:`config precedence` + This currently raises an HTTP 405 error if the request is not mergable. diff --git a/pygithub3/services/pull_requests/comments.py b/pygithub3/services/pull_requests/comments.py index 3aa6d0e..2edbfdf 100644 --- a/pygithub3/services/pull_requests/comments.py +++ b/pygithub3/services/pull_requests/comments.py @@ -1,11 +1,10 @@ +# -*- encoding: utf-8 -*- from pygithub3.services.base import Service, MimeTypeMixin class Comments(Service, MimeTypeMixin): """Consume `Review Comments API - <http://developer.github.com/v3/pulls/comments/>`_ - - """ + <http://developer.github.com/v3/pulls/comments/>`_ """ def list(self, number, user=None, repo=None): """List all the comments for a pull request @@ -13,7 +12,10 @@ class Comments(Service, MimeTypeMixin): :param str number: The number of the pull request :param str user: Username :param str repo: Repository + :returns: A :doc:`result` + .. note:: + Remember :ref:`config precedence` """ return self._get_result( self.make_request('pull_requests.comments.list', number=number, @@ -27,37 +29,44 @@ class Comments(Service, MimeTypeMixin): :param str user: Username :param str repo: Repository + .. note:: + Remember :ref:`config precedence` """ return self._get( self.make_request('pull_requests.comments.get', number=number, user=user, repo=repo) ) - def create(self, number, body, user=None, repo=None): + def create(self, number, data, user=None, repo=None): """Create a comment :param str number: the pull request to comment on + :param dict data: Input. See `github pullrequests comments doc`_ :param str user: Username :param str repo: Repository + .. note:: + Remember :ref:`config precedence` """ return self._post( self.make_request('pull_requests.comments.create', number=number, - body=body, user=user, repo=repo) + body=data, user=user, repo=repo) ) - def edit(self, number, body, user=None, repo=None): + def update(self, number, message, user=None, repo=None): """Edit a comment :param str number: The id of the comment to edit + :param str message: Comment message :param str user: Username :param str repo: Repository + .. note:: + Remember :ref:`config precedence` """ - return self._patch( - self.make_request('pull_requests.comments.edit', number=number, - body=body, user=user, repo=repo) - ) + request = self.make_request('pull_requests.comments.edit', + number=number, body={'body': message}, user=user, repo=repo) + return self._patch(request) def delete(self, number, user=None, repo=None): """Delete a comment @@ -66,6 +75,8 @@ class Comments(Service, MimeTypeMixin): :param str user: Username :param str repo: Repository + .. note:: + Remember :ref:`config precedence` """ return self._delete( self.make_request('pull_requests.comments.delete', number=number, |