fix no_args_is_help in click 8.2 and assert behavior in tests

dwreeves · dwreeves · commit 2bb4a05ad460 · 2025-05-19T17:11:13.000-04:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,9 +2,12 @@
 
 ## Version 1.8.9 (2025-05-19)
 
-- Fix deprecation warning in Click 8.2. [[#215](https://github.com/ewels/rich-click/pull/215)] ([@finsberg](https://github.com/finsberg))
-- Fix typing incompatibilities with Click 8.2.
-- Added Click 8.2's support for `Parameter.deprecated: str | bool`
+Click 8.2 support:
+
+- Fix deprecation warning in Click 8.2. [[#239](https://github.com/ewels/rich-click/pull/239)] ([@finsberg](https://github.com/finsberg))
+- Fix typing incompatibilities with Click 8.2. [[#240](https://github.com/ewels/rich-click/pull/240), [[#242](https://github.com/ewels/rich-click/pull/242)] ([@finsberg](https://github.com/finsberg))
+- Fixed `no_args_is_help=True` with Click 8.2: [[#241](https://github.com/ewels/rich-click/issues/241)]
+- Added Click 8.2's support for `Parameter.deprecated: str | bool` [#242](https://github.com/ewels/rich-click/pull/242)]
 
 ## Version 1.8.8 (2025-03-09)
 
diff --git a/src/rich_click/patch.py b/src/rich_click/patch.py
@@ -21,11 +21,11 @@ class _PatchedRichMultiCommand(RichMultiCommand, _PatchedRichCommand):
     pass
 
 
-class _PatchedRichCommandCollection(RichCommandCollection, _PatchedRichCommand):  # type: ignore[misc]
+class _PatchedRichCommandCollection(RichCommandCollection, _PatchedRichCommand):
     pass
 
 
-class _PatchedRichGroup(RichGroup, _PatchedRichCommand):  # type: ignore[misc]
+class _PatchedRichGroup(RichGroup, _PatchedRichCommand):
     pass
 
 
diff --git a/src/rich_click/rich_command.py b/src/rich_click/rich_command.py
@@ -10,8 +10,9 @@
 # or else rich_click.cli.patch() causes a recursion error.
 from click import CommandCollection, Group
 from click.utils import PacifyFlushWrapper, make_str
+from typing_extensions import Literal, NoReturn
 
-from rich_click._compat_click import CLICK_IS_BEFORE_VERSION_8X, CLICK_IS_BEFORE_VERSION_9X
+from rich_click._compat_click import CLICK_IS_BEFORE_VERSION_8X, CLICK_IS_BEFORE_VERSION_9X, CLICK_IS_BEFORE_VERSION_82
 from rich_click.rich_context import RichContext
 from rich_click.rich_help_configuration import RichHelpConfiguration
 from rich_click.rich_help_formatter import RichHelpFormatter
@@ -112,6 +113,26 @@ def _error_formatter(self, ctx: Optional[RichContext]) -> RichHelpFormatter:
                 formatter = self.context_class.formatter_class(console=self.console, config=config, file=sys.stderr)
         return formatter
 
+    @overload
+    def main(
+        self,
+        args: Optional[Sequence[str]] = None,
+        prog_name: Optional[str] = None,
+        complete_var: Optional[str] = None,
+        standalone_mode: Literal[True] = True,
+        **extra: Any,
+    ) -> NoReturn: ...
+
+    @overload
+    def main(
+        self,
+        args: Optional[Sequence[str]] = None,
+        prog_name: Optional[str] = None,
+        complete_var: Optional[str] = None,
+        standalone_mode: bool = ...,
+        **extra: Any,
+    ) -> Any: ...
+
     def main(
         self,
         args: Optional[Sequence[str]] = None,
@@ -180,6 +201,11 @@ def main(
             except click.exceptions.ClickException as e:
                 if not standalone_mode:
                     raise
+
+                if not CLICK_IS_BEFORE_VERSION_82:
+                    if isinstance(e, click.exceptions.NoArgsIsHelpError):
+                        sys.exit(e.exit_code)
+
                 formatter = self._error_formatter(ctx)
                 from rich_click.rich_help_rendering import rich_format_error
 
diff --git a/src/rich_click/rich_help_rendering.py b/src/rich_click/rich_help_rendering.py
@@ -618,7 +618,7 @@ class MetavarHighlighter(RegexHighlighter):
 
 
 def get_rich_commands(
-    obj: MultiCommand,  # type: ignore[valid-type]
+    obj: MultiCommand,
     ctx: click.Context,
     formatter: RichHelpFormatter,
 ) -> None:
@@ -629,7 +629,7 @@ def get_rich_commands(
     # Look through COMMAND_GROUPS for this command
     # stick anything unmatched into a default group at the end
     cmd_groups = _resolve_groups(ctx=ctx, groups=formatter.config.command_groups, group_attribute="commands")
-    for command in obj.list_commands(ctx):  # type: ignore[attr-defined]
+    for command in obj.list_commands(ctx):
         for cmd_group in cmd_groups:
             if command in cmd_group.get("commands", []):
                 break
@@ -672,9 +672,9 @@ def get_rich_commands(
         )
         for command in cmd_group.get("commands", []):
             # Skip if command does not exist
-            if command not in obj.list_commands(ctx):  # type: ignore[attr-defined]
+            if command not in obj.list_commands(ctx):
                 continue
-            cmd = obj.get_command(ctx, command)  # type: ignore[attr-defined]
+            cmd = obj.get_command(ctx, command)
             if TYPE_CHECKING:
                 assert cmd is not None
             if cmd.hidden:
diff --git a/tests/conftest.py b/tests/conftest.py
@@ -153,7 +153,7 @@ class AssertRichFormat(Protocol):
     def __call__(
         self,
         cmd: Union[str, RichCommand, RichGroup],
-        args: str,
+        args: Optional[str],
         error: Optional[Type[Exception]],
         rich_config: Optional[Callable[[Any], Union[RichGroup, RichCommand]]],
     ) -> None:
@@ -198,7 +198,7 @@ def config_to_dict(config: RichHelpConfiguration) -> Dict[Any, Any]:
 
     def assertion(
         cmd: Union[str, RichCommand],
-        args: str,
+        args: Optional[str],
         error: Optional[Type[Exception]],
         rich_config: Optional[Callable[[Any], RichCommand]],
     ) -> None:
diff --git a/tests/expectations/test_rich_click[no args is help]-click7.out b/tests/expectations/test_rich_click[no args is help]-click7.out
@@ -0,0 +1,10 @@
+                                                                                                    
+ Usage: cli [OPTIONS]                                                                               
+                                                                                                    
+ My amazing tool does all the things.                                                               
+                                                                                                    
+╭─ Options ────────────────────────────────────────────────────────────────────────────────────────╮
+│ --version      Show the version and exit.                                                        │
+│ --help         Show this message and exit.                                                       │
+╰──────────────────────────────────────────────────────────────────────────────────────────────────╯
+
diff --git a/tests/expectations/test_rich_click[no args is help]-click8.config.json b/tests/expectations/test_rich_click[no args is help]-click8.config.json
@@ -0,0 +1,97 @@
+{
+  "style_option": "bold cyan",
+  "style_argument": "bold cyan",
+  "style_command": "bold cyan",
+  "style_switch": "bold green",
+  "style_metavar": "bold yellow",
+  "style_metavar_append": "dim yellow",
+  "style_metavar_separator": "dim",
+  "style_header_text": "",
+  "style_epilog_text": "",
+  "style_footer_text": "",
+  "style_usage": "yellow",
+  "style_usage_command": "bold",
+  "style_deprecated": "red",
+  "style_helptext_first_line": "",
+  "style_helptext": "dim",
+  "style_option_help": "",
+  "style_option_default": "dim",
+  "style_option_envvar": "dim yellow",
+  "style_required_short": "red",
+  "style_required_long": "dim red",
+  "style_options_panel_border": "dim",
+  "style_options_panel_box": "ROUNDED",
+  "align_options_panel": "left",
+  "style_options_table_show_lines": false,
+  "style_options_table_leading": 0,
+  "style_options_table_pad_edge": false,
+  "style_options_table_padding": [
+    0,
+    1
+  ],
+  "style_options_table_box": "",
+  "style_options_table_row_styles": null,
+  "style_options_table_border_style": null,
+  "style_commands_panel_border": "dim",
+  "style_commands_panel_box": "ROUNDED",
+  "align_commands_panel": "left",
+  "style_commands_table_show_lines": false,
+  "style_commands_table_leading": 0,
+  "style_commands_table_pad_edge": false,
+  "style_commands_table_padding": [
+    0,
+    1
+  ],
+  "style_commands_table_box": "",
+  "style_commands_table_row_styles": null,
+  "style_commands_table_border_style": null,
+  "style_commands_table_column_width_ratio": [
+    null,
+    null
+  ],
+  "style_errors_panel_border": "red",
+  "style_errors_panel_box": "ROUNDED",
+  "align_errors_panel": "left",
+  "style_errors_suggestion": "dim",
+  "style_errors_suggestion_command": "blue",
+  "style_aborted": "red",
+  "width": 100,
+  "max_width": null,
+  "color_system": null,
+  "force_terminal": true,
+  "header_text": null,
+  "footer_text": null,
+  "deprecated_string": "(Deprecated) ",
+  "deprecated_with_reason_string": "(Deprecated: {}) ",
+  "default_string": "[default: {}]",
+  "envvar_string": "[env var: {}]",
+  "required_short_string": "*",
+  "required_long_string": "[required]",
+  "range_string": " [{}]",
+  "append_metavars_help_string": "({})",
+  "arguments_panel_title": "Arguments",
+  "options_panel_title": "Options",
+  "commands_panel_title": "Commands",
+  "errors_panel_title": "Error",
+  "errors_suggestion": null,
+  "errors_epilogue": null,
+  "aborted_text": "Aborted.",
+  "show_arguments": false,
+  "show_metavars_column": true,
+  "append_metavars_help": false,
+  "group_arguments_options": false,
+  "option_envvar_first": false,
+  "text_markup": "ansi",
+  "use_markdown": false,
+  "use_markdown_emoji": true,
+  "use_rich_markup": false,
+  "command_groups": {},
+  "option_groups": {},
+  "use_click_short_help": false,
+  "highlighter_patterns": [
+    "(^|[^\\w\\-])(?P<switch>-([^\\W0-9][\\w\\-]*\\w|[^\\W0-9]))",
+    "(^|[^\\w\\-])(?P<option>--([^\\W0-9][\\w\\-]*\\w|[^\\W0-9]))",
+    "(?P<metavar><[^>]+>)"
+  ],
+  "legacy_windows": null
+}
diff --git a/tests/expectations/test_rich_click[no args is help]-click8.out b/tests/expectations/test_rich_click[no args is help]-click8.out
@@ -0,0 +1,9 @@
+                                                                                                    
+ Usage: cli [OPTIONS]                                                                               
+                                                                                                    
+ My amazing tool does all the things.                                                               
+                                                                                                    
+╭─ Options ────────────────────────────────────────────────────────────────────────────────────────╮
+│ --version      Show the version and exit.                                                        │
+│ --help         Show this message and exit.                                                       │
+╰──────────────────────────────────────────────────────────────────────────────────────────────────╯
diff --git a/tests/fixtures/no_args_is_help.py b/tests/fixtures/no_args_is_help.py
@@ -0,0 +1,13 @@
+import rich_click as click
+
+
+@click.command(no_args_is_help=True)
+@click.version_option(version="1.2.3")
+def cli() -> None:
+    """
+    My amazing tool does all the things.
+    """
+
+
+if __name__ == "__main__":
+    cli()
diff --git a/tests/test_help.py b/tests/test_help.py
@@ -209,12 +209,19 @@ def default_config(initialize_rich_click: None) -> None:
             ),
             id="test table styles with rich_config",
         ),
+        pytest.param(
+            "no_args_is_help",
+            None,
+            None,
+            rich_config(help_config=RichHelpConfiguration()),
+            id="no args is help",
+        ),
     ],
 )
 @pytest.mark.filterwarnings("ignore:^.*click prior to.*$:RuntimeWarning")
 def test_rich_click(
     cmd: str,
-    args: str,
+    args: Optional[str],
     error: Optional[Type[Exception]],
     rich_config: Optional[Callable[[Any], Union[RichGroup, RichCommand]]],
     assert_rich_format: AssertRichFormat,
