8000 Rename Issue#iter_labels · qiwsir/github3.py@cf888d5 · GitHub
[go: up one dir, main page]
Skip to content

Commit cf888d5

Browse files
sigmavirus24sigmavirus24
committed
Rename Issue#iter_labels
1 parent 9fec508 commit cf888d5

File tree

6 files changed

+25
-20
lines changed

6 files changed

+25
-20
lines changed

‎LATEST_VERSION_NOTES.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,7 @@ Old name New name
5454
``GitHub#iter_user_teams`` ``GitHub#user_teams``
5555
``Issue#iter_comments`` ``Issue#comments``
5656
``Issue#iter_events`` ``Issue#events``
57+
``Issue#iter_labels`` ``Issue#labels``
5758
``Organization#iter_members`` ``Organization#members``
5859
``Organization#iter_public_members`` ``Organization#public_members``
5960
``Organization#iter_repos`` ``Organization#repositories``

‎github3/issues/issue.py

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,9 @@ def __init__(self, issue, session=None):
6464
self.id = issue.get('id')
6565
#: Returns the list of :class:`Label <github3.issues.label.Label>`\ s
6666
#: on this issue.
67-
self.labels = [Label(l, self._session) for l in issue.get('labels')]
67+
self.original_labels = [
68+
Label(l, self._session) for l in issue.get('labels')
69+
]
6870
labels_url = issue.get('labels_url')
6971
#: Labels URL Template. Expand with ``name``
7072
self.labels_urlt = URITemplate(labels_url) if labels_url else None
@@ -123,7 +125,7 @@ def assign(self, login):
123125
if not login:
124126
return False
125127
number = self.milestone.number if self.milestone else None
126-
labels = [str(l) for l in self.labels]
128+
labels = [str(l) for l in self.original_labels]
127129
return self.edit(self.title, self.body, login, self.state, number,
128130
labels)
129131

@@ -135,7 +137,7 @@ def close(self):
135137
"""
136138
assignee = self.assignee.login if self.assignee else ''
137139
number = self.milestone.number if self.milestone else None
138-
labels = [str(l) for l in self.labels]
140+
labels = [str(l) for l in self.original_labels]
139141
return self.edit(self.title, self.body, assignee, 'closed',
140142
number, labels)
141143

@@ -232,7 +234,7 @@ def is_closed(self):
232234
return True
233235
return False
234236

235-
def iter_labels(self, number=-1, etag=None):
237+
def labels(self, number=-1, etag=None):
236238
"""Iterate over the labels associated with this issue.
237239
238240
:param int number: (optional), number of labels to return. Default: -1
@@ -285,6 +287,6 @@ def reopen(self):
285287
"""
286288
assignee = self.assignee.login if self.assignee else ''
287289
number = self.milestone.number if self.milestone else None
288-
labels = [str(l) for l in self.labels]
290+
labels = [str(l) for l in self.original_labels]
289291
return self.edit(self.title, self.body, assignee, 'open',
290292
number, labels)

‎tests/cassettes/Issue_iter_labels.json renamed to ‎tests/cassettes/Issue_labels.json

File renamed without changes.

‎tests/integration/test_issue.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,11 +32,11 @@ def test_events(self):
3232
assert event.issue is None
3333
assert isinstance(event.actor, github3.users.User)
3434

35-
def test_iter_labels(self):
35+
def test_labels(self):
3636
"""Test the ability to iterate over issue labels."""
37-
cassette_name = self.cassette_name('iter_labels')
37+
cassette_name = self.cassette_name('labels')
3838
with self.recorder.use_cassette(cassette_name):
3939
issue = self.gh.issue('sigmavirus24', 'github3.py', 187)
4040
assert issue is not None
41-
for label in issue.iter_labels():
41+
for label in issue.labels():
4242
assert isinstance(label, github3.issues.label.Label)

‎tests/test_issues.py

Lines changed: 3 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -94,15 +94,6 @@ def test_due_on(self):
9494
m = Milestone(json)
9595
assert isinstance(m.due_on, datetime.datetime)
9696

97-
def test_iter_labels(self):
98-
self.response('label', _iter=True)
99-
self.get(self.api + '/labels')
100-
101-
i = self.m.iter_labels()
102-
assert isinstance(i, github3.structs.GitHubIterator)
103-
assert isinstance((next(i)), Label)
104-
self.mock_assertions()
105-
10697
def test_update(self):
10798
self.response('milestone', 200)
10899
self.patch(self.api)
@@ -173,7 +164,7 @@ def test_assign(self):
173164
self.not_called()
174165
assert self.i.assign('sigmavirus24')
175166
n = self.i.milestone.number if self.i.milestone else None
176-
labels = [str(l) for l in self.i.labels]
167+
labels = [str(l) for l in self.i.original_labels]
177168
ed.assert_called_once_with(
178169
self.i.title, self.i.body, 'sigmavirus24', self.i.state, n,
179170
labels
@@ -190,7 +181,7 @@ def test_close(self):
190181
assert self.i.close()
191182
u = self.i.assignee.login if self.i.assignee else ''
192183
n = self.i.milestone.number if self.i.milestone else None
193-
l = [str(label) for label in self.i.labels]
184+
l = [str(label) for label in self.i.original_labels]
194185
ed.assert_called_once_with(
195186
self.i.title, self.i.body, u, self.i.state, n, l
196187
)
@@ -286,7 +277,7 @@ def test_reopen(self):
286277
with mock.patch.object(Issue, 'edit') as ed:
287278
ed.return_value = True
288279
assert self.i.reopen()
289-
labels = [str(l) for l in self.i.labels]
280+
labels = [str(l) for l in self.i.original_labels]
290281
ed.assert_called_once_with(
291282
self.i.title, self.i.body, u, 'open', n, labels
292283
)

‎tests/unit/test_issues_issue.py

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,3 +39,14 @@ def test_events(self):
3939
params={'per_page': 100},
4040
headers={}
4141
)
42+
43+
def test_labels(self):
44+
"""Test the request to retrieve an issue's labels."""
45+
i = self.instance.labels()
46+
self.get_next(i)
47+
48+
self.session.get.assert_called_once_with(
49+
url_for('labels'),
50+
params={'per_page': 100},
51+
headers={}
52+
)

0 commit comments

Comments
 (0)
0