forked from sigmavirus24/github3.py
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathcomment.py
More file actions
98 lines (70 loc) · 2.7 KB
/
Copy pathcomment.py
File metadata and controls
98 lines (70 loc) · 2.7 KB
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
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
"""Module containing the logic for a GistComment."""
from .. import decorators
from .. import models
from .. import users
class GistComment(models.GitHubCore):
"""Representation of a comment left on a :class:`~github3.gists.Gist`.
See also: http://developer.github.com/v3/gists/comments/
.. versionchanged:: 1.0.0
The ``links``, ``html_url``, and ``pull_request_url`` attributes were
removed as none of them exist in the response from GitHub.
This object has the following attributes:
.. attribute:: author_association
The comment author's (:attr:`user`) association with this gist.
.. attribute:: body
The markdown formatted original text written by the author.
.. attribute:: body_html
The HTML formatted comment body.
.. attribute:: body_text
The plain-text formatted comment body.
.. attribute:: created_at
A :class:`~datetime.datetime` object representing the date and time
when this comment was created.
.. attribute:: id
The unique identifier for this comment.
.. attribute:: updated_at
A :class:`~datetime.datetime` object representing the date and time
when this comment was most recently updated.
.. attribute:: user
A :class:`~github3.users.ShortUser` representing the author of this
comment.
"""
def _update_attributes(self, comment):
self._api = comment["url"]
self.author_association = comment["author_association"]
self.body = comment["body"]
self.body_html = comment["body_html"]
self.body_text = comment["body_text"]
self.created_at = self._strptime(comment["created_at"])
self.id = comment["id"]
self.updated_at = self._strptime(comment["updated_at"])
self.user = users.ShortUser(comment["user"], self)
def _repr(self):
return f"<Gist Comment [{self.user.login}]>"
@decorators.requires_auth
def delete(self):
"""Delete this comment from the gist.
:returns:
True if successful, False otherwise
:rtype:
bool
"""
return self._boolean(self._delete(self._api), 204, 404)
@decorators.requires_auth
def edit(self, body):
"""Edit this comment.
:param str body:
(required), new body of the comment, Markdown-formatted
:returns:
True if successful, False otherwise
:rtype:
bool
"""
if body:
json = self._json(
self._patch(self._api, json={"body": body}), 200
)
if json:
self._update_attributes(json)
return True
return False