fix: respect TYPER_USE_RICH in shell completion help text (fixes #1643)#1819
Closed
mshzy wants to merge 3 commits into
Closed
fix: respect TYPER_USE_RICH in shell completion help text (fixes #1643)#1819mshzy wants to merge 3 commits into
mshzy wants to merge 3 commits into
Conversation
_sanitize_help_text() checked whether rich is installed but ignored the HAS_RICH flag from TYPER_USE_RICH env var. When users set TYPER_USE_RICH=false, completions would still import Rich. Fix: import HAS_RICH from .core and check it. Fixes fastapi#1643
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
3 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.
Problem
_sanitize_help_text() in _completion_classes.py only checked whether rich is installed via importlib.util.find_spec(). It did not respect HAS_RICH / TYPER_USE_RICH. Users with TYPER_USE_RICH=false still had Rich loaded during completions.
Fix
Import HAS_RICH from .core and check it before using Rich for help text sanitization.
Fixes #1643