8000 Rename Repository#release_latest to Repository#latest_release · pljensen/github3.py@66cb295 · GitHub
[go: up one dir, main page]

Skip to content

Commit 66cb295

Browse files
sigmavirus24itsmemattchung
authored andcommitted
Rename Repository#release_latest to Repository#latest_release
Closes sigmavirus24#514
1 parent 5869154 commit 66cb295

File tree

5 files changed

+25
-22
lines changed

5 files changed

+25
-22
lines changed

LATEST_VERSION_NOTES.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,9 @@ Features Added (since 1.0.0a2)
2626
- Add ``Repository#release_by_tag_name`` to retrieve a Release from a
2727
Repository by its associated tag name.
2828

29+
- Add ``Repository#latest_release`` to retrieve the latest Release for a
30+
Repository.
31+
2932
- Add ``GitHub#license`` to retrieve a ``github3.license.License`` by the
3033
license name.
3134

github3/repos/repo.py

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1425,6 +1425,17 @@ def latest_pages_build(self):
14251425
json = self._json(self._get(url), 200)
14261426
return self._instance_or_null(PagesBuild, json)
14271427

1428+
def latest_release(self):
1429+
"""Get the latest release.
1430+
1431+
Draft releases and prereleases are not returned by this endpoint.
1432+
1433+
:returns: :class:`Release <github3.repos.release.Release>`
1434+
"""
1435+
url = self._build_url('releases', 'latest', base_url=self._api)
1436+
json = self._json(self._get(url), 200)
1437+
return self._instance_or_null(Release, json)
1438+
14281439
def license(self):
14291440
"""Get the contents of a license for the repo
14301441
@@ -1677,17 +1688,6 @@ def release(self, id):
16771688
json = self._json(self._get(url), 200)
16781689
return self._instance_or_null(Release, json)
16791690

1680-
def release_latest(self):
1681-
"""Get the latest release.
1682-
1683-
Draft releases and prereleases are not returned by this endpoint.
1684-
1685-
:returns: :class:`Release <github3.repos.release.Release>`
1686-
"""
1687-
url = self._build_url('releases', 'latest', base_url=self._api)
1688-
json = self._json(self._get(url), 200)
1689-
return self._instance_or_null(Release, json)
1690-
16911691
def release_from_tag(self, tag_name):
16921692
"""Get a release by tag name.
16931693

tests/integration/test_repos_repo.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -608,13 +608,13 @@ def test_release(self):
608608

609609
assert isinstance(release, github3.repos.release.Release)
610610

611-
def test_release_latest(self):
611+
def test_latest_release(self):
612612
"""Test the ability to retrieve the latest release."""
613-
cassette_name = self.cassette_name('release_latest')
613+
cassette_name = self.cassette_name('latest_release')
614614
with self.recorder.use_cassette(cassette_name):
615615
repository = self.gh.repository('sigmavirus24', 'github3.py')
616616
assert repository is not None
617-
release = repository.release_latest()
617+
release = repository.latest_release()
618618

619619
assert isinstance(release, github3.repos.release.Release)
620620

tests/unit/test_repos_repo.py

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -322,6 +322,14 @@ def test_latest_pages_build(self):
322322
url_for('pages/builds/latest')
323323
)
324324

325+
def test_latest_release(self):
326+
"""Test the request for retrieving the latest release"""
327+
self.instance.latest_release()
328+
329+
self.session.get.assert_called_once_with(
330+
url_for('releases/latest')
331+
)
332+
325333
def test_milestone(self):
326334
"""Test retrieving a specific milestone."""
327335
self.instance.milestone(20)
@@ -340,14 +348,6 @@ def test_pages(self):
340348

341349
self.session.get.assert_called_once_with(url_for('pages'))
342350

343-
def test_release_latest(self):
344-
"""Test the request for retrieving the latest release"""
345-
self.instance.release_latest()
346-
347-
self.session.get.assert_called_once_with(
348-
url_for('releases/latest')
349-
)
350-
351351
def test_release_from_tag(self):
352352
"""Test the request for retrieving release by tag name"""
353353
self.instance.release_from_tag('v1.0.0')

0 commit comments

Comments
 (0)
0