aboutsummaryrefslogtreecommitdiffstats
path: root/pygithub3/services/pull_requests
diff options
context:
space:
mode:
authorDavid Medina <davidmedina9@gmail.com>2012-04-28 23:43:28 +0200
committerDavid Medina <davidmedina9@gmail.com>2012-04-28 23:43:28 +0200
commitc24e6efbb59065dcb6655d47bb7b0254f2753bff (patch)
tree32290846e640555ec4804c53c4aab62cbbe7bd13 /pygithub3/services/pull_requests
parent:sparkles: Release 0.3 :sparkles: (diff)
parentdocstring link typo (diff)
downloadpython-github3-c24e6efbb59065dcb6655d47bb7b0254f2753bff.tar.xz
python-github3-c24e6efbb59065dcb6655d47bb7b0254f2753bff.zip
Merged pull request #4 from natw:services/pull_requests
Diffstat (limited to 'pygithub3/services/pull_requests')
-rw-r--r--pygithub3/services/pull_requests/__init__.py118
-rw-r--r--pygithub3/services/pull_requests/comments.py73
2 files changed, 191 insertions, 0 deletions
diff --git a/pygithub3/services/pull_requests/__init__.py b/pygithub3/services/pull_requests/__init__.py
new file mode 100644
index 0000000..66d9e58
--- /dev/null
+++ b/pygithub3/services/pull_requests/__init__.py
@@ -0,0 +1,118 @@
+from pygithub3.exceptions import BadRequest, NotFound
+from pygithub3.services.base import Service, MimeTypeMixin
+from .comments import Comments
+
+
+class PullRequests(Service, MimeTypeMixin):
+ """Consume `Pull Request API <http://developer.github.com/v3/pulls/>`_"""
+
+ def __init__(self, **config):
+ self.comments = Comments(**config)
+ super(PullRequests, self).__init__(**config)
+
+ def list(self, user=None, repo=None):
+ """List all of the pull requests for a repo
+
+ :param str user: Username
+ :param str repo: Repository
+
+ """
+ return self._get_result(
+ self.make_request('pull_requests.list', user=user, repo=repo)
+ )
+
+ def get(self, number, user=None, repo=None):
+ """Get a single pull request
+
+ :param str number: The number of the pull request to get
+ :param str user: Username
+ :param str repo: Repository
+
+ """
+ return self._get(
+ self.make_request('pull_requests.get', number=number, user=user,
+ repo=repo)
+ )
+
+ def create(self, body, user=None, repo=None):
+ """Create a pull request
+
+ :param dict body: Data for the new pull request
+ :param str user: Username
+ :param str repo: Repository
+
+ """
+ return self._post(
+ self.make_request('pull_requests.create', body=body, user=user,
+ repo=repo)
+ )
+
+ def update(self, number, body, 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 str user: Username
+ :param str repo: Repository
+
+ """
+ return self._patch(
+ self.make_request('pull_requests.update', number=number,
+ body=body, user=user, repo=repo)
+ )
+
+ def list_commits(self, number, user=None, repo=None):
+ """List the commits for a pull request
+
+ :param str number: The number of the pull request to list commits for
+ :param str user: Username
+ :param str repo: Repository
+
+ """
+ return self._get_result(
+ self.make_request('pull_requests.list_commits', number=number,
+ user=user, repo=repo)
+ )
+
+ def list_files(self, number, user=None, repo=None):
+ """List the files for a pull request
+
+ :param str number: The number of the pull request to list files for
+ :param str user: Username
+ :param str repo: Repository
+
+ """
+ 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):
+ """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
+
+ """
+ return self._bool(
+ self.make_request('pull_requests.merge_status', number=number,
+ user=user, repo=repo)
+ )
+
+ def merge(self, number, message='', user=None, repo=None):
+ """Merge a pull request.
+
+ :param str number: The pull request to merge
+ :param str user: Username
+ :param str repo: Repository
+
+ This currently raises an HTTP 405 error if the request is not
+ mergable.
+
+ """
+ body = {'commit_message': message}
+ return self._put(
+ self.make_request('pull_requests.merge', number=number,
+ body=body, user=user, repo=repo)
+ )
diff --git a/pygithub3/services/pull_requests/comments.py b/pygithub3/services/pull_requests/comments.py
new file mode 100644
index 0000000..3aa6d0e
--- /dev/null
+++ b/pygithub3/services/pull_requests/comments.py
@@ -0,0 +1,73 @@
+from pygithub3.services.base import Service, MimeTypeMixin
+
+
+class Comments(Service, MimeTypeMixin):
+ """Consume `Review Comments API
+ <http://developer.github.com/v3/pulls/comments/>`_
+
+ """
+
+ def list(self, number, user=None, repo=None):
+ """List all the comments for a pull request
+
+ :param str number: The number of the pull request
+ :param str user: Username
+ :param str repo: Repository
+
+ """
+ return self._get_result(
+ self.make_request('pull_requests.comments.list', number=number,
+ user=user, repo=repo)
+ )
+
+ def get(self, number, user=None, repo=None):
+ """Get a single comment
+
+ :param str number: The comment to get
+ :param str user: Username
+ :param str repo: Repository
+
+ """
+ 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):
+ """Create a comment
+
+ :param str number: the pull request to comment on
+ :param str user: Username
+ :param str repo: Repository
+
+ """
+ return self._post(
+ self.make_request('pull_requests.comments.create', number=number,
+ body=body, user=user, repo=repo)
+ )
+
+ def edit(self, number, body, user=None, repo=None):
+ """Edit a comment
+
+ :param str number: The id of the comment to edit
+ :param str user: Username
+ :param str repo: Repository
+
+ """
+ return self._patch(
+ self.make_request('pull_requests.comments.edit', number=number,
+ body=body, user=user, repo=repo)
+ )
+
+ def delete(self, number, user=None, repo=None):
+ """Delete a comment
+
+ :param str number: The comment to delete
+ :param str user: Username
+ :param str repo: Repository
+
+ """
+ return self._delete(
+ self.make_request('pull_requests.comments.delete', number=number,
+ user=user, repo=repo)
+ )