Add utility function to strip '.py' extensions #3658
Merged
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
The previous use of str.strip(".py") is a bug waiting to happen,
because it strips from both sides of the string (instead of just
the end), and more importantly, treats ".py" as a set of
characters rather than a substring to look for:
$ python3
>>> "ppp.yyy".strip(".py")
''
>>> "no_dot_py".strip(".py")
'no_dot_'
>>> ".py_prefix".strip(".py")
'_prefix'
mguaypaq
added
bug
Codecov Report
Flags with carried forward coverage won't be shown. Click here to find out more.
|
There was a problem hiding this comment.
I think your concerns are valid! Just as an alternate suggestion, though, how do you feel about using str.removesuffix instead? It's also mentioned in the docs for str.rstrip.
That way there's one fewer utility function we have to maintain in our codebase.
EDIT: I missed the "New in version 3.9". Oops! We can't use the feature that I suggested, since we're on Python 3.7 atm.
Until we upgrade to Python 3.9, which has this string method as a builtin, we can use the code from PEP 616.
joshuacwnewton
approved these changes
Jan 24, 2022
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.
Checklist
GitHub
PR contents
Description
The previous use of
str.strip(".py")is a bug waiting to happen,because it strips from both sides of the string (instead of just
the end), and more importantly, treats
".py"as a set ofcharacters rather than a substring to look for (see the docs):
All uses of
.strip(".py")are either inutils/sys.pyitself or import this module, so it seemed like the natural place to add this utility function.Linked issues