Repository navigation
Expand file tree
/
Copy pathnotifications.py
More file actions
283 lines (190 loc) · 8.17 KB
/
Copy pathnotifications.py
File metadata and controls
283 lines (190 loc) · 8.17 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
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
"""
This module contains the classes relating to notifications.
See also: http://developer.github.com/v3/activity/notifications/
"""
from json import dumps
from . import models
class Thread(models.GitHubCore):
"""Object representing a notification thread.
.. versionchanged:: 1.0.0
The ``comment``, ``thread``, and ``url`` attributes are no longer
present because GitHub stopped returning the comment that caused
the notification.
The ``is_unread`` method was removed since it just returned the
``unread`` attribute.
This object has the following attributes:
.. attribute:: id
The unique identifier for this notification across all GitHub
notifications.
.. attribute:: last_read_at
A :class:`~datetime.datetime` object representing the date and time
when the authenticated user last read this thread.
.. attribute:: reason
The reason the authenticated user is receiving this notification.
.. attribute:: repository
A :class:`~github3.repos.ShortRepository` this thread originated on.
.. attribute:: subject
A dictionary with the subject of the notification, for example, which
issue, pull request, or diff this is in relation to.
.. attribute:: unread
A boolean attribute indicating whether this thread has been read or
not.
.. attribute:: updated_at
A :class:`~datetime.datetime` representing the date and time when this
thread was last updated.
See also:
http://developer.github.com/v3/activity/notifications/
"""
def _update_attributes(self, thread):
from . import repos
self._api = thread["url"]
self.id = thread["id"]
self.last_read_at = self._strptime(thread["last_read_at"])
self.reason = thread["reason"]
self.repository = repos.ShortRepository(thread["repository"], self)
self.subject = thread["subject"]
self.unread = thread["unread"]
self.updated_at = self._strptime(thread["updated_at"])
def _repr(self):
return "<Thread [{}]>".format(self.subject.get("title"))
def delete_subscription(self):
"""Delete subscription for this thread.
:returns:
True if successful, False otherwise
:rtype:
bool
"""
url = self._build_url("subscription", base_url=self._api)
return self._boolean(self._delete(url), 204, 404)
def mark(self):
"""Mark the thread as read.
:returns:
True if successful, False otherwise
:rtype:
bool
"""
return self._boolean(self._patch(self._api), 205, 404)
def set_subscription(self, subscribed, ignored):
"""Set the user's subscription for this thread.
:param bool subscribed:
(required), determines if notifications should be received from
this thread.
:param bool ignored:
(required), determines if notifications should be ignored from this
thread.
:returns:
new subscription
:rtype:
:class:`~github3.notifications.ThreadSubscription`
"""
url = self._build_url("subscription", base_url=self._api)
sub = {"subscribed": subscribed, "ignored": ignored}
json = self._json(self._put(url, data=dumps(sub)), 200)
return self._instance_or_null(ThreadSubscription, json)
def subscription(self):
"""Check the status of the user's subscription to this thread.
:returns:
the subscription for this thread
:rtype:
:class:`~github3.notifications.ThreadSubscription`
"""
url = self._build_url("subscription", base_url=self._api)
json = self._json(self._get(url), 200)
return self._instance_or_null(ThreadSubscription, json)
class _Subscription(models.GitHubCore):
"""This object wraps thread and repository subscription information.
See also:
developer.github.com/v3/activity/notifications/#get-a-thread-subscription
.. versionchanged:: 1.0.0
The ``is_ignored`` and ``is_subscribed`` methods were removed. Use the
:attr`ignored` and :attr:`subscribed` attributes instead.
This object has the following attributes:
.. attribute:: created_at
A :class:`~datetime.datetime` object representing the date and time
the user was subscribed to the thread.
.. attribute:: ignored
A boolean attribute indicating whether the user ignored this.
.. attribute:: reason
The reason the user is subscribed to the thread.
.. attribute:: subscribed
A boolean attribute indicating whether the user is subscribed or not.
.. attribute:: thread_url
The URL of the thread resource in the GitHub API.
"""
class_name = "_Subscription"
def _update_attributes(self, sub):
self._api = sub["url"]
self.created_at = self._strptime(sub["created_at"])
self.ignored = sub["ignored"]
self.reason = sub["reason"]
self.subscribed = sub["subscribed"]
def _repr(self):
return f"<{self.class_name} [{self.subscribed}]>"
def delete(self):
"""Delete this subscription.
:returns:
True if successful, False otherwise
:rtype:
bool
"""
return self._boolean(self._delete(self._api), 204, 404)
def set(self, subscribed, ignored):
"""Set the user's subscription for this subscription.
:param bool subscribed:
(required), determines if notifications should be received from
this thread.
:param bool ignored:
(required), determines if notifications should be ignored from this
thread.
"""
sub = {"subscribed": subscribed, "ignored": ignored}
json = self._json(self._put(self._api, data=dumps(sub)), 200)
self._update_attributes(json)
class ThreadSubscription(_Subscription):
"""This object provides a representation of a thread subscription.
See also:
developer.github.com/v3/activity/notifications/#get-a-thread-subscription
.. versionchanged:: 1.0.0
The ``is_ignored`` and ``is_subscribed`` methods were removed. Use the
:attr`ignored` and :attr:`subscribed` attributes instead.
This object has the following attributes:
.. attribute:: created_at
A :class:`~datetime.datetime` object representing the date and time
the user was subscribed to the thread.
.. attribute:: ignored
A boolean attribute indicating whether the user ignored this.
.. attribute:: reason
The reason the user is subscribed to the thread.
.. attribute:: subscribed
A boolean attribute indicating whether the user is subscribed or not.
.. attribute:: thread_url
The URL of the thread resource in the GitHub API.
"""
class_name = "ThreadSubscription"
def _update_subscription(self, sub):
super()._update_attributes(sub)
self.thread_url = sub["thread_url"]
class RepositorySubscription(_Subscription):
"""This object provides a representation of a thread subscription.
See also:
developer.github.com/v3/activity/notifications/#get-a-thread-subscription
.. versionchanged:: 1.0.0
The ``is_ignored`` and ``is_subscribed`` methods were removed. Use the
:attr`ignored` and :attr:`subscribed` attributes instead.
This object has the following attributes:
.. attribute:: created_at
A :class:`~datetime.datetime` object representing the date and time
the user was subscribed to the thread.
.. attribute:: ignored
A boolean attribute indicating whether the user ignored this.
.. attribute:: reason
The reason the user is subscribed to the thread.
.. attribute:: repository_url
The URL of the repository resource in the GitHub API.
.. attribute:: subscribed
A boolean attribute indicating whether the user is subscribed or not.
"""
class_name = "RepositorySubscription"
def _update_subscription(self, sub):
super()._update_attributes(sub)
self.repository_url = sub.get("repository_url")