Skip to content

fix: respect TYPER_USE_RICH in completion help text (fixes #1643) #1818

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
mshzy wants to merge 1 commit into from
+3 −0
Closed

fix: respect TYPER_USE_RICH in completion help text (fixes #1643) #1818

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions typer/_completion_classes.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,9 @@ def _sanitize_help_text(text: str) -> str:
"""Sanitizes the help text by removing rich tags"""
if not importlib.util.find_spec("rich"):
return text
# Respect TYPER_USE_RICH environment variable
if os.getenv("TYPER_USE_RICH", "").lower() in ("false", "0", "no", "off"):
return text
from . import rich_utils

return rich_utils.rich_render_text(text)
Expand Down
Loading