Skip to content

🔧 [Bug]: Fixing TYPER_USE_RICH environment variable not handled in _sanitize_help_text #1643

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

Open
albin-paul-saju wants to merge 5 commits into
base: master
Choose a base branch
from
+12 −1
Open

🔧 [Bug]: Fixing TYPER_USE_RICH environment variable not handled in _sanitize_help_text #1643

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
aa1858a
🔧 Update help text sanitization to check for HAS_RICH before importin…
albin-paul-saju Mar 18, 2026
41cfbff
🧪 Add test for help text sanitization when HAS_RICH is False
albin-paul-saju Mar 18, 2026
ab89b41
🎨 Auto format
pre-commit-ci-lite[bot] Mar 18, 2026
cb98d75
🧪 Remove unnecessary blank line in test_sanitize_help_text function
albin-paul-saju Mar 18, 2026
60c8133
🎨 Auto format
pre-commit-ci-lite[bot] Mar 18, 2026
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
10 changes: 10 additions & 0 deletions tests/test_completion/test_sanitization.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,3 +36,13 @@ def test_sanitize_help_text(
with patch("importlib.util.find_spec", return_value=find_spec) as mock_find_spec:
assert _sanitize_help_text(help_text) == expected
mock_find_spec.assert_called_once_with("rich")


def test_sanitize_help_text_no_rich():
with patch("typer._completion_classes.HAS_RICH", False):
with patch("importlib.util.find_spec") as mock_find_spec:
assert (
_sanitize_help_text("help [bold]with[/] rich tags")
== "help [bold]with[/] rich tags"
)
mock_find_spec.assert_not_called()
3 changes: 2 additions & 1 deletion typer/_completion_classes.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,12 @@
COMPLETION_SCRIPT_ZSH,
Shells,
)
from .core import HAS_RICH


def _sanitize_help_text(text: str) -> str:
"""Sanitizes the help text by removing rich tags"""
if not importlib.util.find_spec("rich"):
if not HAS_RICH or not importlib.util.find_spec("rich"):
return text
from . import rich_utils

Expand Down
Loading