Updated sorting commands in Typer 0.13+ (#2065)

Author: sfc-gh-astus

pyproject.toml

@@ -37,7 +37,7 @@ dependencies = [
   "snowflake-connector-python[secure-local-storage]==3.13.2",
   'snowflake-snowpark-python>=1.15.0,<1.26.0;python_version < "3.12"',
   "tomlkit==0.13.2",
-  "typer==0.12.5",
+  "typer==0.15.1",
   "urllib3>=1.24.3,<2.4",
   "GitPython==3.1.44",
   "pip",

snyk/requirements.txt

@@ -10,7 +10,7 @@ snowflake.core==1.0.2; python_version < "3.12"
 snowflake-connector-python[secure-local-storage]==3.13.2
 snowflake-snowpark-python>=1.15.0,<1.26.0;python_version < "3.12"
 tomlkit==0.13.2
-typer==0.12.5
+typer==0.15.1
 urllib3>=1.24.3,<2.4
 GitPython==3.1.44
 pip

src/snowflake/cli/_app/commands_registration/builtin_plugins.py

@@ -34,7 +34,7 @@ def get_builtin_plugin_name_to_plugin_spec():
         "connection": connection_plugin_spec,
         "helpers": migrate_plugin_spec,
         "spcs": spcs_plugin_spec,
-        "nativeapp": nativeapp_plugin_spec,
+        "app": nativeapp_plugin_spec,
         "object": object_plugin_spec,
         "snowpark": snowpark_plugin_spec,
         "stage": stage_plugin_spec,

src/snowflake/cli/_app/commands_registration/command_plugins_loader.py

@@ -47,7 +47,9 @@ def __init__(self):
         self._loaded_command_paths: Dict[CommandPath, LoadedCommandPlugin] = {}
 
     def register_builtin_plugins(self) -> None:
-        for plugin_name, plugin in get_builtin_plugin_name_to_plugin_spec().items():
+        for plugin_name, plugin in sorted(
+            get_builtin_plugin_name_to_plugin_spec().items()
+        ):
             try:
                 self._plugin_manager.register(plugin=plugin, name=plugin_name)
             except Exception as ex:

src/snowflake/cli/api/commands/snow_typer.py

@@ -19,6 +19,7 @@
 from functools import wraps
 from typing import Any, Callable, Dict, List, Optional, Tuple
 
+import click
 import typer
 from click import ClickException
 from snowflake.cli.api.commands.decorators import (
@@ -35,10 +36,20 @@
 from snowflake.cli.api.sanitizers import sanitize_for_terminal
 from snowflake.cli.api.sql_execution import SqlExecutionMixin
 from snowflake.connector import DatabaseError
+from typer.core import TyperGroup
 
 log = logging.getLogger(__name__)
 
 
+class SortedTyperGroup(TyperGroup):
+    def list_commands(self, ctx: click.Context) -> List[str]:
+        """
+        From Typer 0.13.0 help items are in order of definition, this function override that approach.
+        Returns a list of subcommand names in the alphabetic order.
+        """
+        return sorted(self.commands)
+
+
 class SnowTyper(typer.Typer):
     def __init__(self, /, **kwargs):
         self._sanitize_kwargs(kwargs)
@@ -49,6 +60,7 @@ def __init__(self, /, **kwargs):
             no_args_is_help=True,
             add_completion=True,
             rich_markup_mode="markdown",
+            cls=SortedTyperGroup,
         )
 
     @staticmethod

tests/__snapshots__/test_help_messages.ambr

@@ -2,7 +2,7 @@
 # name: test_sql_help_if_no_query_file_or_stdin
   '''
 
-   Usage: default sql [OPTIONS]                                                   
+   Usage: root sql [OPTIONS]                                                      
 
    Executes Snowflake query.                                                      
    Use either query, filename or input option. Query to execute can be specified  

tests/__snapshots__/test_sql.ambr

@@ -1,8 +1,8 @@
 # serializer version: 1
 # name: test_format
   '''
-  Usage: default stage list-files [OPTIONS] STAGE_NAME
-  Try 'default stage list-files --help' for help.
+  Usage: root stage list-files [OPTIONS] STAGE_NAME
+  Try 'root stage list-files --help' for help.
   +- Error ----------------------------------------------------------------------+
   | Invalid value for '--format': 'invalid_format' is not one of 'TABLE',        |
   | 'JSON'.                                                                      |

tests/api/commands/__snapshots__/test_flags.ambr

@@ -439,8 +439,8 @@
 # ---
 # name: test_replace_and_not_exists_cannot_be_used_together
   '''
-  Usage: default object create [OPTIONS] OBJECT_TYPE [OBJECT_ATTRIBUTES]...
-  Try 'default object create --help' for help.
+  Usage: root object create [OPTIONS] OBJECT_TYPE [OBJECT_ATTRIBUTES]...
+  Try 'root object create --help' for help.
   +- Error ----------------------------------------------------------------------+
   | Parameters '--if-not-exists' and '--replace' are incompatible and cannot be  |
   | used simultaneously.                                                         |

tests/object/__snapshots__/test_object.ambr

@@ -11,8 +11,8 @@
 # ---
 # name: test_create_cli_replace_and_if_not_exists_fails
   '''
-  Usage: default spcs image-repository create [OPTIONS] NAME
-  Try 'default spcs image-repository create --help' for help.
+  Usage: root spcs image-repository create [OPTIONS] NAME
+  Try 'root spcs image-repository create --help' for help.
   +- Error ----------------------------------------------------------------------+
   | Parameters '--if-not-exists' and '--replace' are incompatible and cannot be  |
   | used simultaneously.                                                         |