Make RichHelpFormatter itself renderable with rich
#90
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
This is a new approach that allows the formatter itself to be rendered with rich. The handling of whitespace manipulation and wrapping is now baked into the renderable itself. This also removes the need to use `soft_wrap=True` when printing the formatted help. The downside is that the code is now very low-level in terms of rich rendering, it needs to do line-by-line handling of `Segment` objects. This could help unblock more niche use-cases like #81 and #54.
hamdanal
added a commit
that referenced
this pull request
Oct 14, 2023
PR #90 changed the internals of `RichHelpFormatter` to use low level rendering. This lifted some of the restrictions on what can be rendered without sacrificing parity with the argparse formatters. This PR officially adds support for arbitrary renderables as descriptions (both parser and groups description) and epilog. Co-authored-by: Mosquito <me@mosquito.su>
hamdanal
added a commit
that referenced
this pull request
Oct 14, 2023
PR #90 changed the internals of `RichHelpFormatter` to use low level rendering. This lifted some of the restrictions on what can be rendered without sacrificing parity with the argparse formatters. This PR officially adds support for arbitrary renderables as descriptions (both parser and groups description) and epilog. Co-authored-by: Mosquito <me@mosquito.su>
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 a new approach that allows the formatter itself to be rendered with rich. The handling of whitespace manipulation and wrapping is now baked into the renderable itself. This also removes the need to use
soft_wrap=Truewhen printing the formatted help. The downside is that the code is now very low-level in terms of rich rendering, it needs to do line-by-line handling ofSegmentobjects.This could help unblock more niche use-cases like #81 and #54.