aboutsummaryrefslogtreecommitdiffstats
path: root/pygithub3/services/pull_requests/comments.py
diff options
context:
space:
mode:
authorDavid Medina <davidmedina9@gmail.com>2012-05-12 23:08:55 +0200
committerDavid Medina <davidmedina9@gmail.com>2012-05-12 23:08:55 +0200
commit748b320dd244341694c0d247d04c7f57ad4c052e (patch)
tree37b7ffad24d21f398dbb0592395b65599594c40b /pygithub3/services/pull_requests/comments.py
parentNew install environment to prod and dev (diff)
parentSome fixes/typos and 'validate_body' related (diff)
downloadpython-github3-748b320dd244341694c0d247d04c7f57ad4c052e.tar.xz
python-github3-748b320dd244341694c0d247d04c7f57ad4c052e.zip
Merge 'services/pull_requests'
Diffstat (limited to '')
-rw-r--r--pygithub3/services/pull_requests/comments.py84
1 files changed, 84 insertions, 0 deletions
diff --git a/pygithub3/services/pull_requests/comments.py b/pygithub3/services/pull_requests/comments.py
new file mode 100644
index 0000000..2edbfdf
--- /dev/null
+++ b/pygithub3/services/pull_requests/comments.py
@@ -0,0 +1,84 @@
+# -*- 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/>`_ """
+
+ 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
+ :returns: A :doc:`result`
+
+ .. note::
+ Remember :ref:`config precedence`
+ """
+ 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
+
+ .. 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, 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=data, user=user, repo=repo)
+ )
+
+ 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`
+ """
+ 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
+
+ :param str number: The comment to delete
+ :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,
+ user=user, repo=repo)
+ )