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

Author: mr-c

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": [