argpase: colorize the --help output with rich-argparse

Author: mr-c

.github/workflows/ci-tests.yml

@@ -157,7 +157,7 @@ jobs:
           chmod a-w .
 
       - name: run tests
-        run: APPTAINER_TMPDIR=${RUNNER_TEMP} make test
+        run: APPTAINER_TMPDIR=${RUNNER_TEMP} make test PYTEST_EXTRA=-vvv
 
 
   conformance_tests:

cwltool/argparser.py

@@ -6,6 +6,9 @@
 from collections.abc import MutableMapping, MutableSequence, Sequence
 from typing import Any, Callable, Optional, Union, cast
 
+import rich.markup
+from rich_argparse import RichHelpFormatter
+
 from .loghandler import _logger
 from .process import Process, shortname
 from .resolver import ga4gh_tool_registries
@@ -15,8 +18,9 @@
 
 def arg_parser() -> argparse.ArgumentParser:
     parser = argparse.ArgumentParser(
+        formatter_class=RichHelpFormatter,
         description="Reference executor for Common Workflow Language standards. "
-        "Not for production use."
+        "Not for production use.",
     )
     parser.add_argument("--basedir", type=str)
     parser.add_argument(
@@ -855,6 +859,7 @@ def add_argument(
     urljoin: Callable[[str, str], str] = urllib.parse.urljoin,
     base_uri: str = "",
 ) -> None:
+    description = rich.markup.escape(description)
     if len(name) == 1:
         flag = "-"
     else:

cwltool/main.py

@@ -22,6 +22,7 @@
 import coloredlogs
 import requests
 import ruamel.yaml
+from rich_argparse import RichHelpFormatter
 from ruamel.yaml.comments import CommentedMap, CommentedSeq
 from ruamel.yaml.main import YAML
 from schema_salad.exceptions import ValidationException
@@ -413,7 +414,10 @@ def init_job_order(
         namemap: dict[str, str] = {}
         records: list[str] = []
         toolparser = generate_parser(
-            argparse.ArgumentParser(prog=args.workflow),
+            argparse.ArgumentParser(
+                prog=args.workflow,
+                formatter_class=RichHelpFormatter,
+            ),
             process,
             namemap,
             records,

pyproject.toml

@@ -11,6 +11,7 @@ requires = [
     "cwl-utils>=0.32",
     "toml",
     "argcomplete>=1.12.0",
+    "rich-argparse"
 ]
 build-backend = "setuptools.build_meta"
 

requirements.txt

@@ -12,3 +12,4 @@ argcomplete>=1.12.0
 pyparsing!=3.0.2  # breaks --print-dot (pydot) https://github.com/pyparsing/pyparsing/issues/319
 cwl-utils>=0.32
 spython>=0.3.0
+rich-argparse

setup.py

@@ -135,6 +135,7 @@
         "pyparsing != 3.0.2",  # breaks --print-dot (pydot) https://github.com/pyparsing/pyparsing/issues/319
         "cwl-utils >= 0.32",
         "spython >= 0.3.0",
+        "rich-argparse",
     ],
     extras_require={
         "deps": [

tests/test_environment.py

@@ -4,7 +4,7 @@
 from abc import ABC, abstractmethod
 from collections.abc import Mapping
 from pathlib import Path
-from typing import Any, Callable, Union
+from typing import Callable, Union
 
 import pytest
 
@@ -198,7 +198,7 @@ def BIND(v: str, env: Env) -> bool:
 
 
 @CRT_PARAMS
-def test_basic(crt_params: CheckHolder, tmp_path: Path, monkeypatch: Any) -> None:
+def test_basic(crt_params: CheckHolder, tmp_path: Path, monkeypatch: pytest.MonkeyPatch) -> None:
     """Test that basic env vars (only) show up."""
     tmp_prefix = str(tmp_path / "canary")
     extra_env = {
@@ -218,7 +218,9 @@ def test_basic(crt_params: CheckHolder, tmp_path: Path, monkeypatch: Any) -> Non
 
 
 @CRT_PARAMS
-def test_preserve_single(crt_params: CheckHolder, tmp_path: Path, monkeypatch: Any) -> None:
+def test_preserve_single(
+    crt_params: CheckHolder, tmp_path: Path, monkeypatch: pytest.MonkeyPatch
+) -> None:
     """Test that preserving a single env var works."""
     tmp_prefix = str(tmp_path / "canary")
     extra_env = {
@@ -242,7 +244,9 @@ def test_preserve_single(crt_params: CheckHolder, tmp_path: Path, monkeypatch: A
 
 
 @CRT_PARAMS
-def test_preserve_all(crt_params: CheckHolder, tmp_path: Path, monkeypatch: Any) -> None:
+def test_preserve_all(
+    crt_params: CheckHolder, tmp_path: Path, monkeypatch: pytest.MonkeyPatch
+) -> None:
     """Test that preserving all works."""
     tmp_prefix = str(tmp_path / "canary")
     extra_env = {

tests/test_misc_cli.py

@@ -1,5 +1,7 @@
 """Tests for various command line options."""
 
+import pytest
+
 from cwltool.utils import versionstring
 
 from .util import get_data, get_main_output, needs_docker
@@ -26,9 +28,13 @@ def test_empty_cmdling() -> None:
     assert "CWL document required, no input file was provided" in stderr
 
 
-def test_tool_help() -> None:
+def test_tool_help(monkeypatch: pytest.MonkeyPatch) -> None:
     """Test --tool-help."""
-    return_code, stdout, stderr = get_main_output(["--tool-help", get_data("tests/echo.cwl")])
+    return_code, stdout, stderr = get_main_output(
+        ["--tool-help", get_data("tests/echo.cwl")],
+        extra_env={"NO_COLOR": "1"},
+        monkeypatch=monkeypatch,
+    )
     assert return_code == 0
     assert "job_order   Job input json file" in stdout
 

tests/test_singularity.py

@@ -2,7 +2,6 @@
 
 import shutil
 from pathlib import Path
-from typing import Any
 
 import pytest
 
@@ -19,7 +18,7 @@
 
 
 @needs_singularity_2_6
-def test_singularity_pullfolder(tmp_path: Path, monkeypatch: Any) -> None:
+def test_singularity_pullfolder(tmp_path: Path, monkeypatch: pytest.MonkeyPatch) -> None:
     """Test singularity respects SINGULARITY_PULLFOLDER."""
     workdir = tmp_path / "working_dir_new"
     workdir.mkdir()