Display non-default debris values in help screen

bittner · Sep 20, 2023 · 9a36735 · 9a36735
1 parent 5b25a89
commit 9a36735
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 1 deletion.
diff --git a/pyclean/cli.py b/pyclean/cli.py
@@ -52,7 +52,11 @@ def parse_arguments():
                         nargs='*', default=argparse.SUPPRESS, choices=debris_choices,
                         help='remove leftovers from popular Python development '
                              'tools (may be specified multiple times; '
-                             'default: %s)' % ' '.join(debris_default_topics))
+                             'optional: all %s; default: %s)' % (
+                                ' '.join(debris_optional_topics),
+                                ' '.join(debris_default_topics),
+                             ),
+                       )
     parser.add_argument('-e', '--erase', metavar='PATTERN', action='extend',
                         nargs='+', default=[],
                         help='delete files or folders matching a globbing '

diff --git a/tests/test_cli.py b/tests/test_cli.py
@@ -179,6 +179,22 @@ def test_debris_default_args():
     assert args.debris == ['cache', 'coverage', 'package', 'pytest']
 
 
+@pytest.mark.skipif(sys.version_info < (3,), reason="requires Python 3")
+def test_debris_optional_args():
+    """
+    Does the help screen explain all --debris options?
+    """
+    expected_debris_options_help = (
+        '(may be specified multiple times; '
+        'optional: all jupyter mypy ruff tox; '
+        'default: cache coverage package pytest)'
+    )
+
+    result = shell('pyclean --help')
+
+    assert expected_debris_options_help in result.stdout
+
+
 def test_debris_all():
     """
     Does calling `pyclean --debris all` pick all topics?