Show help if called with no options, closes #14

simonw · Jun 19, 2023 · b002482 · b002482
1 parent 9d467b8
commit b002482
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 0 deletions.
diff --git a/symbex/cli.py b/symbex/cli.py
@@ -70,6 +70,10 @@ def cli(symbols, files, directories, signatures, silent):
         # View signatures for all test functions
         symbex 'test_*' -s
     """
+    if not symbols and not signatures:
+        ctx = click.get_current_context()
+        click.echo(ctx.get_help())
+        ctx.exit()
     if signatures and not symbols:
         symbols = ["*"]
     if not files and not directories:

diff --git a/tests/test_symbex.py b/tests/test_symbex.py
@@ -6,6 +6,13 @@
 from symbex.cli import cli
 
 
+def test_no_args_shows_help():
+    runner = CliRunner()
+    result = runner.invoke(cli, catch_exceptions=False)
+    assert result.exit_code == 0
+    assert "Usage: cli [OPTIONS]" in result.stdout
+
+
 @pytest.fixture
 def directory_full_of_code(tmpdir):
     for path, content in (