🐛 Fix highlighting of optional variadic argument metavars

tests/test_rich_utils.py

@@ -1,9 +1,12 @@
 import sys
 
+import pytest
 import typer
 import typer.completion
 from typer.testing import CliRunner
 
+from tests.utils import needs_rich
+
 runner = CliRunner()
 
 
@@ -99,3 +102,34 @@ def main(bar: str):
     result = runner.invoke(app, ["--help"])
     assert "Usage" in result.stdout
     assert "BAR" in result.stdout
+
+
+@needs_rich
+@pytest.mark.parametrize("input_text", ["[ARGS]", "[ARGS]..."])
+def test_metavar_highlighter(input_text: str):
+    """
+    Test that the MetavarHighlighter works correctly.
+    cf PR 1508
+    """
+    from typer.rich_utils import (
+        STYLE_METAVAR_SEPARATOR,
+        Text,
+        _get_rich_console,
+        metavar_highlighter,
+    )
+
+    console = _get_rich_console()
+
+    text = Text(input_text)
+    highlighted = metavar_highlighter(text)
+    console.print(highlighted)
+
+    # Get the style for each bracket
+    opening_bracket_style = highlighted.get_style_at_offset(console, 0)
+    closing_bracket_style = highlighted.get_style_at_offset(console, 5)
+
+    # The opening bracket should have metavar_sep style
+    assert str(opening_bracket_style) == STYLE_METAVAR_SEPARATOR
+
+    # The closing bracket should have metavar_sep style (fails before PR 1508 when there are 3 dots)
+    assert str(closing_bracket_style) == STYLE_METAVAR_SEPARATOR

tests/utils.py

@@ -4,6 +4,7 @@
 
 import pytest
 from typer._completion_shared import _get_shell_name
+from typer.core import HAS_RICH
 
 needs_py310 = pytest.mark.skipif(
     sys.version_info < (3, 10), reason="requires python3.10+"
@@ -13,6 +14,8 @@
     not sys.platform.startswith("linux"), reason="Test requires Linux"
 )
 
+needs_rich = pytest.mark.skipif(not HAS_RICH, reason="Test requires Rich")
+
 shell = _get_shell_name()
 needs_bash = pytest.mark.skipif(
     shell is None or "bash" not in shell, reason="Test requires Bash"

typer/rich_utils.py

@@ -120,8 +120,18 @@ class NegativeOptionHighlighter(RegexHighlighter):
     ]
 
 
+# Highlighter to make [ | ] and <> dim
+class MetavarHighlighter(RegexHighlighter):
+    highlights = [
+        r"^(?P<metavar_sep>(\[|<))",
+        r"(?P<metavar_sep>\|)",
+        r"(?P<metavar_sep>(\]|>))(\.\.\.)?$",
+    ]
+
+
 highlighter = OptionHighlighter()
 negative_highlighter = NegativeOptionHighlighter()
+metavar_highlighter = MetavarHighlighter()
 
 
 def _get_rich_console(stderr: bool = False) -> Console:
@@ -393,16 +403,6 @@ def _print_options_panel(
         if param.required:
             required = Text(REQUIRED_SHORT_STRING, style=STYLE_REQUIRED_SHORT)
 
-        # Highlighter to make [ | ] and <> dim
-        class MetavarHighlighter(RegexHighlighter):
-            highlights = [
-                r"^(?P<metavar_sep>(\[|<))",
-                r"(?P<metavar_sep>\|)",
-                r"(?P<metavar_sep>(\]|>)$)",
-            ]
-
-        metavar_highlighter = MetavarHighlighter()
-
         required_rows.append(required)
         options_rows.append(
             [