aboutsummaryrefslogtreecommitdiffstats
path: root/pygithub3/services/pull_requests/comments.py
blob: 3aa6d0ea0900d139d248e61c35b16a4a1fee459c (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
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)
        )