aboutsummaryrefslogtreecommitdiffstats
path: root/pygithub3/services/issues/comments.py
diff options
context:
space:
mode:
authorDavid Medina <davidmedina9@gmail.com>2012-06-16 13:56:29 +0200
committerDavid Medina <davidmedina9@gmail.com>2012-06-16 13:58:12 +0200
commit107b12b3b48040488ff6ddd54cb1300200dc8b37 (patch)
treef35c57bb8b5c5cd85511aaad1c0df0e4f97c0c25 /pygithub3/services/issues/comments.py
parentMerge #5 'services/orgs' (diff)
parentTests on services.issues working (diff)
downloadpython-github3-107b12b3b48040488ff6ddd54cb1300200dc8b37.tar.xz
python-github3-107b12b3b48040488ff6ddd54cb1300200dc8b37.zip
Merge #12 'services/issues'
Diffstat (limited to 'pygithub3/services/issues/comments.py')
-rw-r--r--pygithub3/services/issues/comments.py90
1 files changed, 90 insertions, 0 deletions
diff --git a/pygithub3/services/issues/comments.py b/pygithub3/services/issues/comments.py
new file mode 100644
index 0000000..54d4287
--- /dev/null
+++ b/pygithub3/services/issues/comments.py
@@ -0,0 +1,90 @@
+#!/usr/bin/env python
+# -*- encoding: utf-8 -*-
+
+from pygithub3.services.base import Service, MimeTypeMixin
+
+class Comments(Service, MimeTypeMixin):
+ """ Consume `Comments API
+ <http://developer.github.com/v3/issues/comments>`_ """
+
+ 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
+ :returns: A :doc:`result`
+
+ .. note::
+ Remember :ref:`config precedence`
+ """
+ request = self.make_request('issues.comments.list', user=user,
+ repo=repo, number=number)
+ return self._get_result(request)
+
+ 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
+
+ .. note::
+ Remember :ref:`config precedence`
+ """
+ request = self.make_request('issues.comments.get', user=user,
+ repo=repo, id=id)
+ return self._get(request)
+
+ def create(self, number, message, user=None, repo=None):
+ """ Create a comment on an issue
+
+ :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.make_request('issues.comments.create', user=user,
+ repo=repo, number=number, body={'body': message})
+ return self._post(request)
+
+ def update(self, id, message, user=None, repo=None):
+ """ Update a comment on an issue
+
+ :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.make_request('issues.comments.edit', user=user,
+ repo=repo, id=id, body={'body': message})
+ return self._patch(request)
+
+ 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
+
+ .. warning::
+ You must be authenticated
+
+ .. note::
+ Remember :ref:`config precedence`
+ """
+ request = self.make_request('issues.comments.delete', user=user,
+ repo=repo, id=id)
+ self._delete(request)