gh-149083: Use sentinel for os.path.{ALLOW_MISSING,ALL_BUT_LAST}#149613
Open
JelleZijlstra wants to merge 2 commits intopython:mainfrom
Open
gh-149083: Use sentinel for os.path.{ALLOW_MISSING,ALL_BUT_LAST}#149613JelleZijlstra wants to merge 2 commits intopython:mainfrom
JelleZijlstra wants to merge 2 commits intopython:mainfrom
Conversation
Documentation build overview
|
| return self.__class__.__name__ | ||
| # Sentinels. | ||
| ALL_BUT_LAST = sentinel('ALL_BUT_LAST') | ||
| """Special value for use in realpath().""" |
Member
There was a problem hiding this comment.
Is it used as a docstring of the sentinel? I wonder, how can this be implemented?
Member
Author
There was a problem hiding this comment.
Sentinels don't actually support docstrings. Putting a string like this is an established way to document a variable and I believe Sphinx supports it.
Member
There was a problem hiding this comment.
Then they are not needed.
This file contains hidden or 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
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.
ALL_BUT_LAST is new in 3.15 (#117562). ALLOW_MISSING is also recent (#135037) but was backported to other branches for security reasons.
Making these sentinels has a few effects:
os.path.ALLOW_MISSINGto justALLOW_MISSINGStill it seems worth it to simplify to standard sentinels for 3.15+.