Make 'part' optional (but not forbidden) when new_version is specified #51
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Includes a test to verify that the DeprecationWarning actually occurs. In two other tests, the warnings are suppressed to not litter the output of pytest.
It's 'file-like' if it includes a dot, slash or backslash. Unless of course there is matching part configuration (which includes the dot/slash/backslash). Without this change, test 'non_existing_file' fails because bump2version considers the supplied non-existing path to be an unnecessary [part] argument and only produces a DeprecationWarning for it. While of course we want a proper FileNotFoundError (IOError) if we supply an argument that looks like a file and can not be found on disk. Parametrize the 'non existing file' test to check all cases of dot, slash, backslash.
This avoids DeprecationWarning bubbling up to the pytest output.
florisla
force-pushed
the
optional-part
branch
from
61bd4de
to
47ea5da
Compare
If you supply a part when it's not required (
I think this works pretty well now. Tests are in place and I've updated the documentation. Not sure if we should use PendingDeprecationWarning instead of DeprecationWarning (see docs). |
florisla
changed the title
florisla
changed the title
florisla
changed the title
|
Going to retry this in a new PR. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is an alternative implementation to #31 which tries to be backwards compatible to existing uses
which supply a
partargument just because it's required by the CLI.Closes #22
I think this will only break if the part argument is actually present on disk as a file. That should be low probability since most files in the root will start with a dot or have an extension.
It's up to the maintainers to choose if #31 is preferred (it's definitely cleaner and less ambiguous) or if it's worth retaining backwards compatibility.
Future work would be to update the documentation, and to add a deprecation warning when a useless(done now)partis supplied.