feat: john's ugly vertical help formatter :)

JohnVillalovos · JohnVillalovos · commit d7f6e78efcff · 2022-07-27T01:01:53.000-07:00
diff --git a/gitlab/cli.py b/gitlab/cli.py
@@ -106,11 +106,49 @@ def cls_to_gitlab_resource(cls: RESTObject) -> str:
     return dasherized_lowercase.lower()
 
 
+class VerticalHelpFormatter(argparse.HelpFormatter):
+    def _format_action(self, action: Any) -> str:
+        result = super()._format_action(action=action)
+        if not result.strip().startswith("{"):
+            return result
+        output = ""
+        for line in result.splitlines(keepends=True):
+            if line.strip().startswith("{"):
+                line = line.strip().strip(" {}")
+                values = line.split(",")
+                indentation = self._indent_increment * " "
+                output += indentation + "{\n"
+                sep = ",\n" + (indentation * 2)
+                output += (indentation * 2) + sep.join(values)
+                output += "\n" + indentation + "}\n"
+            else:
+                output += line
+        return output
+
+    def _format_usage(self, usage: Any, actions: Any, groups: Any, prefix: Any) -> str:
+        result = super()._format_usage(
+            usage=usage, actions=actions, groups=groups, prefix=prefix
+        )
+        new_result = ""
+        for line in result.splitlines(keepends=True):
+            if not line.lstrip().startswith("{"):
+                new_result += line
+                continue
+            leading_whitespace = line.split("{")[0]
+            line = line.strip().strip(" {}")
+            new_result += leading_whitespace + "{\n"
+            for resource in line.split(","):
+                new_result += f"{leading_whitespace}  {resource},\n"
+            new_result += leading_whitespace + "}\n"
+        return new_result
+
+
 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",
