8000 Rename Issue#iter_events · qiwsir/github3.py@9fec508 · GitHub
[go: up one dir, main page]

Skip to content

Commit 9fec508

Browse files
committed
Rename Issue#iter_events
1 parent fd977a7 commit 9fec508

File tree

6 files changed

+25
-22
lines changed

6 files changed

+25
-22
lines changed

LATEST_VERSION_NOTES.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,7 @@ Old name New name
5353
``GitHub#iter_user_repos`` ``GitHub#repositories_by``
5454
``GitHub#iter_user_teams`` ``GitHub#user_teams``
5555
``Issue#iter_comments`` ``Issue#comments``
56+
``Issue#iter_events`` ``Issue#events``
5657
``Organization#iter_members`` ``Organization#members``
5758
``Organization#iter_public_members`` ``Organization#public_members``
5859
``Organization#iter_repos`` ``Organization#repositories``

github3/issues/issue.py

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -212,16 +212,7 @@ def edit(self, title=None, body=None, assignee=None, state=None,
212212
return True
213213
return False
214214

215-
def is_closed(self):
216-
"""Checks if the issue is closed.
217-
218-
:returns: bool
219-
"""
220-
if self.closed_at or (self.state == 'closed'):
221-
return True
222-
return False
223-
224-
def iter_events(self, number=-1):
215+
def events(self, number=-1):
225216
"""Iterate over events associated with this issue only.
226217
227218
:param int number: (optional), number of events to return. Default: -1
@@ -232,6 +223,15 @@ def iter_events(self, number=-1):
232223
url = self._build_url('events', base_url=self._api)
233224
return self._iter(int(number), url, IssueEvent)
234225

226+
def is_closed(self):
227+
"""Checks if the issue is closed.
228+
229+
:returns: bool
230+
"""
231+
if self.closed_at or (self.state == 'closed'):
232+
return True
233+
return False
234+
235235
def iter_labels(self, number=-1, etag=None):
236236
"""Iterate over the labels associated with this issue.
237237

tests/integration/test_issue.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,14 +20,14 @@ def test_comments(self):
2020
for comment in comments:
2121
assert isinstance(comment, github3.issues.comment.IssueComment)
2222

23-
def test_iter_events(self):
23+
def test_events(self):
2424
"""Test the ability to iterate over issue events."""
2525
self.token_login()
26-
cassette_name = self.cassette_name('iter_events')
26+
cassette_name = self.cassette_name('events')
2727
with self.recorder.use_cassette(cassette_name):
2828
repository = self.gh.repository('sigmavirus24', 'github3.py')
2929
issue = repository.issue(218)
30-
for event in issue.iter_events():
30+
for event in issue.events():
3131
assert isinstance(event, github3.issues.event.IssueEvent)
3232
assert event.issue is None
3333
assert isinstance(event.actor, github3.users.User)

tests/test_issues.py

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -241,15 +241,6 @@ def test_is_closed(self):
241241
self.i.state = 'open'
242242
assert self.i.is_closed() is False
243243

244-
def test_iter_events(self):
245-
self.response('issue_event', _iter=True)
246-
self.get(self.api + '/events')
247-
248-
e = next(self.i.iter_events())
249-
assert isinstance(e, IssueEvent)
250-
assert repr(e).startswith('<Issue Event')
251-
self.mock_assertions()
252-
253244
def test_remove_label(self):
254245
self.response('', 204)
255246
self.delete(self.api + '/labels/name')

tests/unit/test_issues_issue.py

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,3 +28,14 @@ def test_comments(self):
2828
params={'per_page': 100},
2929
headers={}
3030
)
31+
32+
def test_events(self):
33+
"""Test the request to retrieve an issue's events."""
34+
i = self.instance.events()
35+
self.get_next(i)
36+
37+
self.session.get.assert_called_once_with(
38+
url_for('events'),
39+
params={'per_page': 100},
40+
headers={}
41+
)

0 commit comments

Comments
 (0)
0