aboutsummaryrefslogtreecommitdiffstats
path: root/pygithub3/services/issues/comments.py
blob: f367a58d8416a2b5e88190ed6d4e04f408c8d59d (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
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)