gh-134639: Clarify what "canonical" means in os.path.realpath #134755
+12
−4
Conversation
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
Improve documentation for os.path.realpath by clearly defining what a "canonical path" means. The updated documentation now explicitly states that a canonical path: - Is an absolute path - Has all symbolic links resolved - Is normalized (redundant separators, '.' and '..' components removed) Also clarify platform-specific behavior: - On Windows: resolves MS-DOS (8.3) style names and junction points - On POSIX: roughly equivalent to the system's realpath() function Closes python#134639
bedevere-app
bot
added
awaiting review
docs
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.
Summary
This PR improves the documentation for
os.path.realpathby clearly defining what a "canonical path" means. The current documentation only mentions symlink resolution but doesn't explain other aspects of canonicalization.Details
The updated documentation now explicitly states that a canonical path:
It also clarifies platform-specific behavior:
Related Issues
Closes #134639
Related to #134639
os.path.realpath#134639📚 Documentation preview 📚: https://cpython-previews--134755.org.readthedocs.build/