Add --help unit test for test coverage of ArgparseStyleCommand

Author: assadyousuf

pydantic_ai_slim/pydantic_ai/_cli.py

@@ -92,24 +92,15 @@ class ArgparseStyleCommand(click.Command):
     """Command subclass that keeps the argparse-style output."""
 
     def get_usage(self, ctx: click.Context) -> str:
-        # exact synopsis argparse produced previously (without the program name)
         return '[-h] [-m [MODEL]] [-a AGENT] [-l] [-t [CODE_THEME]] [--no-stream] [--version] [PROMPT]'
 
-    # override usage line
     def format_usage(self, ctx: click.Context, formatter: HelpFormatter) -> None:
         formatter.write_usage(ctx.command_path, self.get_usage(ctx))
 
-    # Keep the positional prompt argument details in the README
     def format_help(self, ctx: click.Context, formatter: HelpFormatter) -> None:
-        # usage
         self.format_usage(ctx, formatter)
         formatter.write_paragraph()
 
-        if self.help:
-            with formatter.section('Description'):
-                formatter.write_text(self.help)
-
-        # positional argument description
         with formatter.section('positional arguments'):
             formatter.write_dl([('prompt', 'AI Prompt, if omitted fall into interactive mode')])
 
@@ -212,7 +203,7 @@ def click_cli(
             raise SystemExit(0)
 
         return result if result is not None else 0
-    except click.ClickException as e:
+    except click.ClickException as e:  # pragma: no cover
         e.show()
         return 1
 

tests/test_cli.py

@@ -154,6 +154,36 @@ def test_list_models(capfd: CaptureFixture[str]):
     assert models == set(), models
 
 
+def test_cli_help(capfd: CaptureFixture[str]):
+    with pytest.raises(SystemExit):
+        cli(['--help'])
+
+    assert capfd.readouterr().out.splitlines() == snapshot(
+        [
+            IsStr(),
+            '           [--version] [PROMPT]',
+            '',
+            '',
+            IsStr(regex='[A-Za-z0-9_]+.*'),
+            '  prompt  AI Prompt, if omitted fall into interactive mode',
+            '',
+            IsStr(regex='[A-Za-z0-9_]+.*'),
+            '  -m, --model TEXT       Model to use, in format "<provider>:<model>" e.g.',
+            '                         "openai:gpt-4.1" or "anthropic:claude-sonnet-4-0".',
+            '                         Defaults to "openai:gpt-4.1".',
+            '  -a, --agent TEXT       Custom Agent to use, in format "module:variable",',
+            '                         e.g. "mymodule.submodule:my_agent"',
+            '  -l, --list-models      List all available models and exit',
+            '  -t, --code-theme TEXT  Which colors to use for code, can be "dark", "light"',
+            '                         or any theme from pygments.org/styles/. Defaults to',
+            '                         "dark" which works well on dark terminals.',
+            '  --no-stream            Disable streaming from the model',
+            '  --version              Show version and exit',
+            '  -h, --help             Show this message and exit.',
+        ]
+    )
+
+
 def test_cli_prompt(capfd: CaptureFixture[str], env: TestEnv):
     env.set('OPENAI_API_KEY', 'test')
     with cli_agent.override(model=TestModel(custom_output_text='# result\n\n```py\nx = 1\n```')):