feat: Add custom pretty printing for pathlib.Path objects #3863
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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 pretty-printing of
pathlib.Pathobjects by rendering them as strings instead of their default object representation.Problem
Currently,
rich.pretty.pprintdisplays apathlib.Pathobject using its default__repr__, which looks likePosixPath('/path/to/file.txt'). While technically correct, this is verbose and doesn't stand out in complex outputs where file paths are common.Solution
The changes in this PR intercept
pathlib.Pathobjects during the rendering process and convert them to their string equivalent.Before:
PosixPath('my_folder/my_script.py')After:
'my_folder/my_script.py'(This will be colored as a string by the highlighter)