Sort options (#708)

Co-authored-by: Zhiwei Liang <[email protected]>
Co-authored-by: Zhiwei Liang <[email protected]>

Author: gergelyk

linodecli/__init__.py

@@ -20,6 +20,7 @@
 from .cli import CLI
 from .completion import get_completions
 from .configuration import ENV_TOKEN_NAME
+from .help_formatter import SortingHelpFormatter
 from .help_pages import (
     HELP_TOPICS,
     print_help_action,
@@ -64,6 +65,7 @@ def main():  # pylint: disable=too-many-branches,too-many-statements
     parser = argparse.ArgumentParser(
         "linode-cli",
         add_help=False,
+        formatter_class=SortingHelpFormatter,
         description="The Linode Command Line Interface.\n\nAliases: lin, linode",
     )
     parsed, args = register_args(parser).parse_known_args()

linodecli/baked/operation.py

@@ -29,6 +29,7 @@
 from linodecli.baked.response import OpenAPIResponse
 from linodecli.baked.util import unescape_arg_segment
 from linodecli.exit_codes import ExitCodes
+from linodecli.help_formatter import SortingHelpFormatter
 from linodecli.output.output_handler import OutputHandler
 from linodecli.overrides import OUTPUT_OVERRIDES
 
@@ -831,6 +832,7 @@ def parse_args(self, args: Any) -> argparse.Namespace:
         #  build an argparse
         parser = argparse.ArgumentParser(
             prog=f"linode-cli {self.command} {self.action}",
+            formatter_class=SortingHelpFormatter,
             description=self.summary,
         )
         for param in self.params:

linodecli/help_formatter.py

@@ -0,0 +1,16 @@
+"""
+Contains sorting formatter for help menu.
+"""
+
+from argparse import HelpFormatter
+from operator import attrgetter
+
+
+class SortingHelpFormatter(HelpFormatter):
+    """
+    The formatter class for help menu.
+    """
+
+    def add_arguments(self, actions):
+        actions = sorted(actions, key=attrgetter("option_strings"))
+        super().add_arguments(actions)

linodecli/plugins/firewall-editor.py

@@ -15,6 +15,7 @@
 from rich.table import Table
 
 from linodecli.exit_codes import ExitCodes
+from linodecli.help_formatter import SortingHelpFormatter
 from linodecli.plugins import inherit_plugin_args
 
 BOLD = "\033[1m"
@@ -581,8 +582,13 @@ def call(args, context):
     Invokes the Interactive Firewall Plugin
     """
     parser = inherit_plugin_args(
-        argparse.ArgumentParser("firewall-editor", add_help=True)
+        argparse.ArgumentParser(
+            "firewall-editor",
+            add_help=True,
+            formatter_class=SortingHelpFormatter,
+        )
     )
+
     parser.add_argument("firewall_id", help="The ID of the firewall to edit.")
 
     parsed = parser.parse_args(args)

linodecli/plugins/get-kubeconfig.py

@@ -14,6 +14,7 @@
 import yaml
 
 from linodecli.exit_codes import ExitCodes
+from linodecli.help_formatter import SortingHelpFormatter
 
 PLUGIN_BASE = "linode-cli get-kubeconfig"
 
@@ -22,7 +23,9 @@ def call(args, context):
     """
     The entrypoint for this plugin
     """
-    parser = argparse.ArgumentParser(PLUGIN_BASE, add_help=True)
+    parser = argparse.ArgumentParser(
+        PLUGIN_BASE, add_help=True, formatter_class=SortingHelpFormatter
+    )
 
     group = parser.add_mutually_exclusive_group()
 

linodecli/plugins/image-upload.py

@@ -15,6 +15,7 @@
 import requests
 
 from linodecli.exit_codes import ExitCodes
+from linodecli.help_formatter import SortingHelpFormatter
 from linodecli.plugins import inherit_plugin_args
 
 PLUGIN_BASE = "linode-cli image-upload"
@@ -68,7 +69,9 @@ def call(args, context):
     The entrypoint for this plugin
     """
     parser = inherit_plugin_args(
-        argparse.ArgumentParser(PLUGIN_BASE, add_help=True)
+        argparse.ArgumentParser(
+            PLUGIN_BASE, add_help=True, formatter_class=SortingHelpFormatter
+        )
     )
 
     parser.add_argument(

linodecli/plugins/metadata.py

@@ -17,6 +17,7 @@
 from rich.table import Table
 
 from linodecli.exit_codes import ExitCodes
+from linodecli.help_formatter import SortingHelpFormatter
 from linodecli.helpers import register_debug_arg
 
 PLUGIN_BASE = "linode-cli metadata"
@@ -184,7 +185,9 @@ def get_metadata_parser():
     """
     Builds argparser for Metadata plug-in
     """
-    parser = ArgumentParser(PLUGIN_BASE, add_help=False)
+    parser = ArgumentParser(
+        PLUGIN_BASE, add_help=False, formatter_class=SortingHelpFormatter
+    )
 
     register_debug_arg(parser)
 

linodecli/plugins/obj/__init__.py

@@ -20,6 +20,7 @@
 from linodecli.configuration import _do_get_request
 from linodecli.configuration.helpers import _default_text_input
 from linodecli.exit_codes import ExitCodes
+from linodecli.help_formatter import SortingHelpFormatter
 from linodecli.plugins import PluginContext, inherit_plugin_args
 from linodecli.plugins.obj.buckets import create_bucket, delete_bucket
 from linodecli.plugins.obj.config import (
@@ -68,7 +69,11 @@ def generate_url(get_client, args, **kwargs):  # pylint: disable=unused-argument
     """
     Generates a URL to an object
     """
-    parser = inherit_plugin_args(ArgumentParser(PLUGIN_BASE + " signurl"))
+    parser = inherit_plugin_args(
+        ArgumentParser(
+            PLUGIN_BASE + " signurl", formatter_class=SortingHelpFormatter
+        )
+    )
 
     parser.add_argument(
         "bucket",
@@ -119,7 +124,11 @@ def set_acl(get_client, args, **kwargs):  # pylint: disable=unused-argument
     """
     Modify Access Control List for a Bucket or Objects
     """
-    parser = inherit_plugin_args(ArgumentParser(PLUGIN_BASE + " setacl"))
+    parser = inherit_plugin_args(
+        ArgumentParser(
+            PLUGIN_BASE + " setacl", formatter_class=SortingHelpFormatter
+        )
+    )
 
     parser.add_argument(
         "bucket", metavar="BUCKET", type=str, help="The bucket to modify."
@@ -183,7 +192,11 @@ def show_usage(get_client, args, **kwargs):  # pylint: disable=unused-argument
     """
     Shows space used by all buckets in this cluster, and total space
     """
-    parser = inherit_plugin_args(ArgumentParser(PLUGIN_BASE + " du"))
+    parser = inherit_plugin_args(
+        ArgumentParser(
+            PLUGIN_BASE + " du", formatter_class=SortingHelpFormatter
+        )
+    )
 
     parser.add_argument(
         "bucket",
@@ -290,7 +303,11 @@ def get_obj_args_parser():
     """
     Initialize and return the argument parser for the obj plug-in.
     """
-    parser = inherit_plugin_args(ArgumentParser(PLUGIN_BASE, add_help=False))
+    parser = inherit_plugin_args(
+        ArgumentParser(
+            PLUGIN_BASE, add_help=False, formatter_class=SortingHelpFormatter
+        )
+    )
 
     parser.add_argument(
         "command",

linodecli/plugins/obj/buckets.py

@@ -6,6 +6,7 @@
 from argparse import ArgumentParser
 
 from linodecli.exit_codes import ExitCodes
+from linodecli.help_formatter import SortingHelpFormatter
 from linodecli.plugins import inherit_plugin_args
 from linodecli.plugins.obj.config import PLUGIN_BASE
 from linodecli.plugins.obj.helpers import _delete_all_objects
@@ -17,7 +18,11 @@ def create_bucket(
     """
     Creates a new bucket
     """
-    parser = inherit_plugin_args(ArgumentParser(PLUGIN_BASE + " mb"))
+    parser = inherit_plugin_args(
+        ArgumentParser(
+            PLUGIN_BASE + " mb", formatter_class=SortingHelpFormatter
+        )
+    )
 
     parser.add_argument(
         "name",
@@ -41,7 +46,11 @@ def delete_bucket(
     """
     Deletes a bucket
     """
-    parser = inherit_plugin_args(ArgumentParser(PLUGIN_BASE + " rb"))
+    parser = inherit_plugin_args(
+        ArgumentParser(
+            PLUGIN_BASE + " rb", formatter_class=SortingHelpFormatter
+        )
+    )
 
     parser.add_argument(
         "name",

linodecli/plugins/obj/list.py

@@ -8,6 +8,7 @@
 from rich import print as rprint
 
 from linodecli.exit_codes import ExitCodes
+from linodecli.help_formatter import SortingHelpFormatter
 from linodecli.helpers import register_pagination_args_shared
 from linodecli.plugins import inherit_plugin_args
 from linodecli.plugins.obj.config import PLUGIN_BASE
@@ -31,7 +32,12 @@ def list_objects_or_buckets(
     """
     Lists buckets or objects
     """
-    parser = inherit_plugin_args(ArgumentParser(PLUGIN_BASE + " ls"))
+    parser = inherit_plugin_args(
+        ArgumentParser(
+            PLUGIN_BASE + " ls", formatter_class=SortingHelpFormatter
+        )
+    )
+
     register_pagination_args_shared(parser)
 
     parser.add_argument(
@@ -130,7 +136,12 @@ def list_all_objects(
     Lists all objects in all buckets
     """
     # this is for printing help when --help is in the args
-    parser = inherit_plugin_args(ArgumentParser(PLUGIN_BASE + " la"))
+    parser = inherit_plugin_args(
+        ArgumentParser(
+            PLUGIN_BASE + " la", formatter_class=SortingHelpFormatter
+        )
+    )
+
     register_pagination_args_shared(parser)
 
     parsed = parser.parse_args(args)