Skip to content

Fix #251: Correct return type for next_version() #254

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 19 commits into from
May 13, 2020
Merged

Fix #251: Correct return type for next_version() #254

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
f1d7cde
Add __getitem__ method to allow easy access to version parts
tlaferriere Aug 16, 2019
ba5899e
Add unit tests for index access to version parts
tlaferriere Aug 19, 2019
e88e0ba
Remove whitespace on blank line
tlaferriere Aug 19, 2019
c30d38f
Merge remote-tracking branch 'kbx/master'
tlaferriere Oct 1, 2019
26a7e03
Merge upstream into fork and fix conflicts
tlaferriere Oct 8, 2019
80da20c
Fix stash conflicts and create more test vectors. Also add private ut…
tlaferriere Oct 8, 2019
a610c22
Use simpler implementation that allows negative indices and remove no…
tlaferriere Oct 8, 2019
95e79d8
Add param and raises to __getitem__ docstring
tlaferriere Oct 10, 2019
ab35e38
Merge branch 'master' of github.com:k-bx/python-semver
tlaferriere Nov 2, 2019
27632b7
Reiterate the logic for __getitem__ and update tests to follow the ac…
tlaferriere Nov 20, 2019
976a4ee
Update __getitem__ docstring
tlaferriere Nov 20, 2019
cf65b3d
Fix lint issues
tlaferriere Nov 20, 2019
dabebd9
Fix lint issues
tlaferriere Nov 20, 2019
847083b
Merge remote-tracking branch 'origin/master'
May 13, 2020
c358a33
Add documentation to VersionInfo.next_version and return only Version…
May 13, 2020
85f7a88
Add :class:
May 13, 2020
a32de10
Add 2.10.1 to changelog
tlaferriere May 13, 2020
d5a7f62
Update PR number in changelog
tlaferriere May 13, 2020
bb4464d
Update CHANGELOG.rst
tomschr May 13, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions CHANGELOG.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,32 @@ Change Log
All notable changes to this code base will be documented in this file,
in every released version.

Version 2.10.1 (WIP)
====================

:Released: 2020-0x-0y
:Maintainer:


Features
--------


Bug Fixes
---------

* :gh:`251` (:pr:`254`): Fixed return type of ``semver.VersionInfo.next_version``
to always return a ``VersionInfo`` instance.


Additions
---------


Removals
--------


Version 2.10.0
==============

Expand Down
5 changes: 3 additions & 2 deletions semver.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -471,7 +471,8 @@ def next_version(self, part, prerelease_token="rc"):

:param part: One of "major", "minor", "patch", or "prerelease"
:param prerelease_token: prefix string of prerelease, defaults to 'rc'
:return:
:return: new object with the appropriate part raised
:rtype: :class:`VersionInfo`
"""
validparts = {
"major",
Expand All @@ -495,7 +496,7 @@ def next_version(self, part, prerelease_token="rc"):
return version.replace(prerelease=None, build=None)

if part in ("major", "minor", "patch"):
return str(getattr(version, "bump_" + part)())
return getattr(version, "bump_" + part)()

if not version.prerelease:
version = version.bump_patch()
Expand Down
4 changes: 3 additions & 1 deletion test_semver.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1050,4 +1050,6 @@ def test_next_version_with_invalid_parts():
)
def test_next_version_with_versioninfo(version, part, expected):
ver = VersionInfo.parse(version)
assert str(ver.next_version(part)) == expected
next_version = ver.next_version(part)
assert isinstance(next_version, VersionInfo)
assert str(next_version) == expected