Fix --help / -h (#57)

* Set up TDD

* Quick Fix According to Click Doccs

* Improve Test

* Fix usage with config file

* black

* flake8

* Update config_file.py

Author: MiWeiss

docstr_coverage/cli.py

@@ -155,7 +155,7 @@ def _assert_valid_key_value(k, v):
     # TODO: Use counting instead: https://click.palletsprojects.com/en/7.x/options/#counting
     "-v",
     "--verbose",
-    type=click.Choice([0, 1, 2, 3, "0", "1", "2", "3"]),
+    type=click.Choice(["0", "1", "2", "3"]),
     default="3",
     help="Verbosity level",
     show_default=True,

docstr_coverage/config_file.py

@@ -22,7 +22,7 @@ def set_config_defaults(ctx, param, value):
     -------
     String
         Path to the configuration file"""
-    if (value is not None) and os.path.exists(value):
+    if value is not None and os.path.exists(value):
         with open(value) as f:
             config_data = yaml.safe_load(f) or {}
             ctx.params["config_file"] = value
@@ -34,6 +34,11 @@ def set_config_defaults(ctx, param, value):
             lambda config_paths: tuple([os.path.realpath(path) for path in config_paths]),
         )
         _extract_non_default_list(config_data, ctx, "ignore_patterns", lambda x: x)
+        # TODO This can be removed as part PR #52 (verbose counting).
+        #       Until then, this is for compatibility with docs
+        #       which require verbose in config-file to be an int
+        if "verbose" in config_data:
+            config_data["verbose"] = str(config_data["verbose"])
         ctx.default_map = config_data
 
     return value

tests/test_cli.py

@@ -536,3 +536,22 @@ def test_deprecations(paths, deprecated_option, runner: CliRunner):
     assert run_result.stdout.startswith(
         "Using deprecated {}".format(deprecated_option[0].split("=")[0])
     )
+
+
+@pytest.mark.parametrize(
+    ["help_flag"],
+    [pytest.param(["--help"], id="long: --help"), pytest.param(["-h"], id="short: -h")],
+)
+def test_help_smoke(help_flag: str, runner: CliRunner):
+    """Smoke test which ensures that help is printed with exit code 0
+
+    Parameters
+    ----------
+    help_flag:
+        The (short or long) help path argument
+    runner: CliRunner
+        Click utility to invoke command line scripts"""
+    run_result = runner.invoke(execute, help_flag)
+    assert run_result.exit_code == 0
+    assert isinstance(run_result.stdout, str)
+    assert "Measure docstring coverage for" in run_result.stdout