Merge pull request #229 from dwreeves/main

Handful of small updates

Author: dwreeves

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## Version 1.8.8 (2025-03-09)
+
+- Make text wrap instead of using ellipses for overflowing metavars in options tables.
+- Added `--errors-in-output-format` flag to `rich-click` CLI.
+- Actually fixed regression in stderr handling [[#164](https://github.com/ewels/rich-click/issues/164)].
+
 ## Version 1.8.7 (2025-03-08)
 
 - Add ability to turn off option/command deduplication in groups [[#226](https://github.com/ewels/rich-click/issues/226)]

src/rich_click/__init__.py

@@ -6,7 +6,7 @@
 customization required.
 """
 
-__version__ = "1.8.7"
+__version__ = "1.8.8"
 
 # Import the entire click API here.
 # We need to manually import these instead of `from click import *` to force

src/rich_click/cli.py

@@ -158,6 +158,13 @@ def _get_module_path_and_function_name(script: str, suppress_warnings: bool) ->
     type=click.Choice(["html", "svg"], case_sensitive=False),
     help="Optionally render help text as HTML or SVG. By default, help text is rendered normally.",
 )
+@click.option(
+    "--errors-in-output-format",
+    is_flag=True,
+    help="If set, forces the CLI to render CLI error messages"
+    " in the format specified by the --output option."
+    " By default, error messages render normally, i.e. they are not converted to html or svg.",
+)
 @click.option(
     "--suppress-warnings/--do-not-suppress-warnings",
     is_flag=True,
@@ -188,6 +195,7 @@ def main(
     ctx: RichContext,
     script_and_args: List[str],
     output: Literal[None, "html", "svg"],
+    errors_in_output_format: bool,
     suppress_warnings: bool,
     rich_config: Optional[RichHelpConfiguration],
     show_help: bool,
@@ -241,6 +249,8 @@ def main(
 
     if output is not None:
         RichContext.export_console_as = output
+        if errors_in_output_format:
+            RichContext.errors_in_output_format = True
 
     prog = module_path.split(".", 1)[0]
     sys.argv = [prog, *args]

src/rich_click/rich_command.py

@@ -98,6 +98,20 @@ def _generate_rich_help_config(self) -> RichHelpConfiguration:
             click.echo(f"{e.__class__.__name__}{e.args}", file=sys.stderr)
         return RichHelpConfiguration()
 
+    def _error_formatter(self, ctx: Optional[RichContext]) -> RichHelpFormatter:
+        if ctx is not None:
+            formatter = ctx.make_formatter(error=True)
+        else:
+            config = self._generate_rich_help_config()
+            if self.context_class.errors_in_output_format and self.context_class.export_console_as is not None:
+                formatter = self.context_class.formatter_class(
+                    console=self.console, config=config, file=open(os.devnull, "w")
+                )
+                formatter.console.record = True
+            else:
+                formatter = self.context_class.formatter_class(console=self.console, config=config, file=sys.stderr)
+        return formatter
+
     def main(
         self,
         args: Optional[Sequence[str]] = None,
@@ -166,14 +180,15 @@ def main(
             except click.exceptions.ClickException as e:
                 if not standalone_mode:
                     raise
-                if ctx is not None:
-                    formatter = ctx.make_formatter()
-                else:
-                    config = self._generate_rich_help_config()
-                    formatter = self.context_class.formatter_class(console=self.console, config=config, file=sys.stderr)
+                formatter = self._error_formatter(ctx)
                 from rich_click.rich_help_rendering import rich_format_error
 
-                rich_format_error(e, formatter)
+                if self.context_class.errors_in_output_format:
+                    export_console_as = self.context_class.export_console_as
+                else:
+                    export_console_as = None
+
+                rich_format_error(e, formatter, export_console_as=export_console_as)
                 sys.exit(e.exit_code)
             except OSError as e:
                 if e.errno == errno.EPIPE:
@@ -191,11 +206,7 @@ def main(
             if not standalone_mode:
                 raise
             try:
-                if ctx is not None:
-                    formatter = ctx.make_formatter()
-                else:
-                    config = self._generate_rich_help_config()
-                    formatter = self.context_class.formatter_class(console=self.console, config=config, file=sys.stderr)
+                formatter = self._error_formatter(ctx)
             except Exception:
                 click.echo("Aborted!", file=sys.stderr)
             else:

src/rich_click/rich_context.py

@@ -1,4 +1,5 @@
 import os
+import sys
 from typing import TYPE_CHECKING, Any, Mapping, Optional, Type, Union
 
 import click
@@ -20,6 +21,7 @@ class RichContext(click.Context):
     formatter_class: Type[RichHelpFormatter] = RichHelpFormatter
     console: Optional["Console"] = None
     export_console_as: Literal[None, "html", "svg"] = None
+    errors_in_output_format: bool = False
 
     def __init__(
         self,
@@ -64,14 +66,18 @@ def __init__(
         else:
             self.help_config = rich_help_config
 
-    def make_formatter(self) -> RichHelpFormatter:
+    def make_formatter(self, error: bool = False) -> RichHelpFormatter:
         """Create the Rich Help Formatter."""
         formatter = self.formatter_class(
             width=self.terminal_width,
             max_width=self.max_content_width,
             config=self.help_config,
             console=self.console,
-            file=open(os.devnull, "w") if self.export_console_as is not None else None,
+            file=(
+                open(os.devnull, "w")
+                if error and self.export_console_as is not None and self.errors_in_output_format
+                else sys.stderr if error else open(os.devnull, "w") if self.export_console_as is not None else None
+            ),
         )
         if self.export_console_as is not None:
             if self.console is None:
@@ -98,4 +104,6 @@ def exit(self, code: int = 0) -> NoReturn:
                 print(self.console.export_html(inline_styles=True, code_format="{code}"))
             elif self.export_console_as == "svg":
                 print(self.console.export_svg())
+                # Todo: In 1.9, replace above with the following:
+                # print(self.console.export_svg(title="rich-click " + " ".join(sys.argv)))
         super().exit(code)

src/rich_click/rich_help_formatter.py

@@ -2,6 +2,7 @@
 from typing import IO, TYPE_CHECKING, Any, Optional
 
 import click
+from typing_extensions import Literal
 
 from rich_click.rich_help_configuration import RichHelpConfiguration
 
@@ -68,6 +69,8 @@ class RichHelpFormatter(click.HelpFormatter):
     not be created directly
     """
 
+    export_console_as: Literal[None, "html", "svg"] = None
+
     def __init__(
         self,
         indent_increment: int = 2,
@@ -101,8 +104,8 @@ def __init__(
 
         if console:
             self.console = console
-            # if file:
-            #     self.console.file = file
+            if file:
+                self.console.file = file
         else:
             self.console = create_console(self.config, file=file)
 

src/rich_click/rich_help_rendering.py

@@ -1,5 +1,6 @@
 import inspect
 import re
+import sys
 from fnmatch import fnmatch
 from typing import TYPE_CHECKING, Any, Dict, Iterable, List, Optional, Tuple, TypeVar, Union, overload
 
@@ -605,6 +606,8 @@ class MetavarHighlighter(RegexHighlighter):
 
             kw.update(option_group.get("panel_styles", {}))
 
+            options_table.columns[0].overflow = "fold"
+
             formatter.write(Panel(options_table, **kw))
 
 
@@ -721,7 +724,9 @@ def get_rich_epilog(
         )
 
 
-def rich_format_error(self: click.ClickException, formatter: RichHelpFormatter) -> None:
+def rich_format_error(
+    self: click.ClickException, formatter: RichHelpFormatter, export_console_as: Literal[None, "html", "svg"] = None
+) -> None:
     """
     Print richly formatted click errors.
 
@@ -732,6 +737,7 @@ def rich_format_error(self: click.ClickException, formatter: RichHelpFormatter)
     ----
         self (click.ClickException): Click exception to format.
         formatter: formatter object.
+        export_console_as: If set, outputs error message as HTML or SVG.
     """
     config = formatter.config
     # Print usage
@@ -798,6 +804,11 @@ def rich_format_error(self: click.ClickException, formatter: RichHelpFormatter)
         )
     if config.errors_epilogue:
         formatter.write(Padding(config.errors_epilogue, (0, 1, 1, 1)))
+    if formatter.console.record:
+        if export_console_as == "html":
+            print(formatter.console.export_html(inline_styles=True, code_format="{code}"))
+        elif export_console_as == "svg":
+            print(formatter.console.export_svg(title="rich-click " + " ".join(sys.argv)))
 
 
 def rich_abort_error(formatter: RichHelpFormatter) -> None:

tests/test_rich_click_cli.py

@@ -18,11 +18,6 @@
 from tests.conftest import AssertStr
 
 
-# TODO:
-#  I need to make it so these tests don't cause side effects
-# pytest.skip(allow_module_level=True)
-
-
 @pytest.fixture(autouse=True)
 def default_config(initialize_rich_click: None) -> None:
     # Default config settings from https://github.com/Textualize/rich/blob/master/tests/render.py
@@ -373,3 +368,60 @@ def cli():
     """
 
     assert_str(actual=res.stdout.decode(), expectation=expected_output)
+
+
+@pytest.mark.skipif(CLICK_IS_BEFORE_VERSION_8X, reason="Warning message gets in the way.")
+def test_error_to_stderr(mock_script_writer: Callable[[str], Path], assert_str: AssertStr) -> None:
+    mock_script_writer(
+        '''
+        import click
+
+        @click.group("foo")
+        def foo():
+            """foo group"""
+
+        @foo.command("bar")
+        def bar():
+            """bar command"""
+        '''
+    )
+
+    res_grp = subprocess.run(
+        [sys.executable, "-m", "src.rich_click", "mymodule:foo", "--bad-input"],
+        stdout=subprocess.PIPE,
+        stderr=subprocess.PIPE,
+        env={**os.environ, "TERMINAL_WIDTH": "100", "FORCE_COLOR": "False"},
+    )
+    assert res_grp.returncode == 2
+
+    expected_output_grp = """
+     Usage: python -m src.rich_click.mymodule [OPTIONS] COMMAND [ARGS]...
+
+    Try 'python -m src.rich_click.mymodule --help' for help
+    ╭─ Error ──────────────────────────────────────────────────────────────────────────────────────────╮
+    │ No such option: --bad-input                                                                      │
+    ╰──────────────────────────────────────────────────────────────────────────────────────────────────╯
+    """
+
+    assert_str(actual=res_grp.stdout.decode(), expectation="")
+    assert_str(actual=res_grp.stderr.decode(), expectation=expected_output_grp)
+
+    res_cmd = subprocess.run(
+        [sys.executable, "-m", "src.rich_click", "mymodule:foo", "bar", "--bad-input"],
+        stdout=subprocess.PIPE,
+        stderr=subprocess.PIPE,
+        env={**os.environ, "TERMINAL_WIDTH": "100", "FORCE_COLOR": "False"},
+    )
+    assert res_cmd.returncode == 2
+
+    expected_output_grp = """
+     Usage: python -m src.rich_click.mymodule bar [OPTIONS]
+
+    Try 'python -m src.rich_click.mymodule bar --help' for help
+    ╭─ Error ──────────────────────────────────────────────────────────────────────────────────────────╮
+    │ No such option: --bad-input                                                                      │
+    ╰──────────────────────────────────────────────────────────────────────────────────────────────────╯
+    """
+
+    assert_str(actual=res_cmd.stdout.decode(), expectation="")
+    assert_str(actual=res_cmd.stderr.decode(), expectation=expected_output_grp)