Add styles to theme for prompt-toolkit completion styles#1653
Open
tleonhardt wants to merge 20 commits intomainfrom
Open
Add styles to theme for prompt-toolkit completion styles#1653tleonhardt wants to merge 20 commits intomainfrom
tleonhardt wants to merge 20 commits intomainfrom
Conversation
…round color This is an attempt to provide higher-contrast color options and to make them configurable as part of a theme.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1653 +/- ##
==========================================
- Coverage 99.51% 99.50% -0.02%
==========================================
Files 21 21
Lines 4737 4812 +75
==========================================
+ Hits 4714 4788 +74
- Misses 23 24 +1
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
Also: - Cache prompt-toolkit completion menu styles for efficiency - Fixed color check bug related to default terminal style
BRIGHT_GREEN is one of the standard 16 colors typically configured by a user's terminal theme. LIGHT_GREEN is from the extended 256-color range.
Created a new converter function to safely extract the correct string representation for prompt-toolkit: - For `ColorSystem.STANDARD` colors (0-15), it maps directly to `prompt-toolkit`'s `ansicolor` names (e.g. `ansired`, `ansibrightred`). This ensures that `prompt-toolkit` delegates to the terminal's theme for the basic 16 colors. - For `ColorSystem.EIGHT_BIT` and `ColorSystem.TRUECOLOR`, it falls back to parsing the RGB hex code (e.g., `#ff0000`), which `prompt-toolkit` supports natively. Also: - Renamed `to_pt_style` to `rich_to_pt_style` to make its intent more obvious - Added tests for the new `rich_to_pt_color` conversion function
where StyleType = Style | str
kmvanbrunt
reviewed
May 5, 2026
kmvanbrunt
reviewed
May 5, 2026
kmvanbrunt
reviewed
May 5, 2026
kmvanbrunt
reviewed
May 5, 2026
kmvanbrunt
reviewed
May 5, 2026
kmvanbrunt
reviewed
May 5, 2026
kmvanbrunt
reviewed
May 5, 2026
kmvanbrunt
requested changes
May 5, 2026
Since prommpt-toolkit calls the lex_document method of the Cmd2Lexer instance quite frequnetly, we don't want to dynamically fetech the colors to use on every call. Instead I extracted the code for retrieving the lexer colors from the rich theme into a set_colors helper method and the set_theme method will call this for any Cmd2Lexer instances.
… styles rich_to_pt_style should now support all styles in common between rich and prompt-toolkit
kmvanbrunt
reviewed
May 5, 2026
kmvanbrunt
reviewed
May 5, 2026
Also: - Updated outdated docstring that was insufficiently broad - Updated rich_theme.py example to use new completion styles - Updated CHANGELOG and documentation
tleonhardt
changed the title
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
2 participants
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.
Add styles to theme for completion item and metadata foreground and background colors.
This is an attempt to provide higher-contrast color options and to make them configurable as part of a theme.
Added
rich_to_pt_styleandrich_to_pt_colorconversion helper functions to convert fromrichcolor/style objects toprompt-toolkitcolor/style strings.ColorSystem.STANDARDcolors (0-15), it maps directly toprompt-toolkit'sansicolornames (e.g.ansired,ansibrightred). This ensures thatprompt-toolkitdelegates to the terminal's theme for the basic 16 colors.ColorSystem.EIGHT_BITandColorSystem.TRUECOLOR, it falls back to parsing the RGB hex code (e.g.,#ff0000), whichprompt-toolkitsupports natively.Also added the existing
Cmd2Lexercolors to the styles and theme.