diff options
author | 2012-06-03 13:02:54 +0200 | |
---|---|---|
committer | 2012-06-03 13:02:54 +0200 | |
commit | 897671db979e64754de2c53cbbe83fcbae37bb02 (patch) | |
tree | 11ac9ede303971d2bcaf270d833fd4112c923509 /pygithub3/services/issues/comments.py | |
parent | Merge 'services/orgs' (diff) | |
parent | Change "Edit" to "Update" in docstring (diff) | |
download | python-github3-897671db979e64754de2c53cbbe83fcbae37bb02.tar.xz python-github3-897671db979e64754de2c53cbbe83fcbae37bb02.zip |
Merge branch 'services/issues' of https://github.com/alejandrogomez/python-github3 into services/issues
Conflicts:
docs/services.rst
pygithub3/github.py
pygithub3/requests/repos/__init__.py
Diffstat (limited to 'pygithub3/services/issues/comments.py')
-rw-r--r-- | pygithub3/services/issues/comments.py | 75 |
1 files changed, 75 insertions, 0 deletions
diff --git a/pygithub3/services/issues/comments.py b/pygithub3/services/issues/comments.py new file mode 100644 index 0000000..d007286 --- /dev/null +++ b/pygithub3/services/issues/comments.py @@ -0,0 +1,75 @@ +#!/usr/bin/env python +# -*- encoding: utf-8 -*- + +from pygithub3.services.base import Service + +class Comments(Service): + """ Consume `Comments API + <http://developer.github.com/v3/issues/comments>`_ """ + + def list(self, user, repo, number): + """ List comments for an issue + + :param str user: Username + :param str repo: Repo name + :param int number: Issue number + :returns: A :doc:`result` + """ + request = self.request_builder('issues.comments.list', user=user, + repo=repo, number=number) + return self._get_result(request) + + def get(self, user, repo, id): + """ Get a single comment + + :param str user: Username + :param str repo: Repo name + :param int id: Comment id + """ + request = self.request_builder('issues.comments.get', user=user, + repo=repo, id=id) + return self._get(request) + + def create(self, user, repo, number, message): + """ 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 + + .. warning:: + You must be authenticated + """ + request = self.request_builder('issues.comments.create', user=user, + repo=repo, number=number, body={'body': message}) + return self._post(request) + + def update(self, user, repo, id, message): + """ 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 + + .. warning:: + You must be authenticated + """ + 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): + """ Delete a single comment + + :param str user: Username + :param str repo: Repo name + :param int id: Comment id + + .. warning:: + You must be authenticated + """ + request = self.request_builder('issues.comments.delete', user=user, + repo=repo, id=id) + self._delete(request) |