feat: john's ugly vertical help formatter :)

JohnVillalovos · JohnVillalovos · commit b028757bd75a · 2022-07-27T16:46:09.000-07:00
diff --git a/gitlab/cli.py b/gitlab/cli.py
@@ -22,6 +22,7 @@
 import os
 import re
 import sys
+import textwrap
 from types import ModuleType
 from typing import Any, Callable, cast, Dict, Optional, Tuple, Type, TypeVar, Union
 
@@ -106,11 +107,36 @@ def cls_to_gitlab_resource(cls: RESTObject) -> str:
     return dasherized_lowercase.lower()
 
 
+class VerticalHelpFormatter(argparse.HelpFormatter):
+    def format_help(self) -> str:
+        result = super().format_help()
+        output = ""
+        for line in result.splitlines(keepends=True):
+            if line.strip().startswith("{"):
+                leading_whitespace = line.split("{")[0]
+                resources = ", ".join(line.strip().strip("{}").split(","))
+                line = (
+                    textwrap.fill(
+                        resources,
+                        initial_indent=leading_whitespace,
+                        subsequent_indent=leading_whitespace,
+                        break_on_hyphens=False,
+                    )
+                    + "\n"
+                )
+                output += line
+
+            else:
+                output += line
+        return output
+
+
 def _get_base_parser(add_help: bool = True) -> argparse.ArgumentParser:
     parser = argparse.ArgumentParser(
         add_help=add_help,
         description="GitLab API Command Line Interface",
         allow_abbrev=False,
+        formatter_class=VerticalHelpFormatter,
     )
     parser.add_argument("--version", help="Display the version.", action="store_true")
     parser.add_argument(
diff --git a/gitlab/v4/cli.py b/gitlab/v4/cli.py
@@ -377,7 +377,9 @@ def extend_parser(parser: argparse.ArgumentParser) -> argparse.ArgumentParser:
 
     for cls in sorted(classes, key=operator.attrgetter("__name__")):
         arg_name = cli.cls_to_gitlab_resource(cls)
-        object_group = subparsers.add_parser(arg_name)
+        object_group = subparsers.add_parser(
+            arg_name, formatter_class=cli.VerticalHelpFormatter
+        )
 
         object_subparsers = object_group.add_subparsers(
             title="action",
