Refactor VariableOption flag

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

@@ -449,15 +449,22 @@ def _password_callback(value: str):
 
 NoInteractiveOption = typer.Option(False, "--no-interactive", help="Disable prompting.")
 
-VariablesOption = typer.Option(
-    None,
-    "--variable",
-    "-D",
-    help='Variables for the execution context. For example: `-D "<key>=<value>"`. '
+
+def variables_option(description: str):
+    return typer.Option(
+        None,
+        "--variable",
+        "-D",
+        help=description,
+        show_default=False,
+    )
+
+
+ExecuteVariablesOption = variables_option(
+    'Variables for the execution context. For example: `-D "<key>=<value>"`. '
     "For SQL files variables are use to expand the template and any unknown variable will cause an error. "
     "For Python files variables are used to update os.environ dictionary. Provided keys are capitalized to adhere to best practices."
     "In case of SQL files string values must be quoted in `''` (consider embedding quoting in the file).",
-    show_default=False,
 )
 
 

src/snowflake/cli/plugins/git/commands.py

@@ -23,9 +23,9 @@
 import typer
 from click import ClickException
 from snowflake.cli.api.commands.flags import (
+    ExecuteVariablesOption,
     OnErrorOption,
     PatternOption,
-    VariablesOption,
     identifier_argument,
     like_option,
 )
@@ -276,7 +276,7 @@ def copy(
 def execute(
     repository_path: str = RepoPathArgument,
     on_error: OnErrorType = OnErrorOption,
-    variables: Optional[List[str]] = VariablesOption,
+    variables: Optional[List[str]] = ExecuteVariablesOption,
     **options,
 ):
     """

src/snowflake/cli/plugins/init/commands.py

@@ -22,8 +22,8 @@
 from click import ClickException
 from snowflake.cli.api.commands.flags import (
     NoInteractiveOption,
-    VariablesOption,
     parse_key_value_variables,
+    variables_option,
 )
 from snowflake.cli.api.commands.snow_typer import SnowTyperFactory
 from snowflake.cli.api.constants import DEFAULT_SIZE_LIMIT_MB
@@ -70,6 +70,9 @@ def _path_argument_callback(path: str) -> str:
     default=DEFAULT_SOURCE,
     help=f"local path to template directory or URL to git repository with templates.",
 )
+VariablesOption = variables_option(
+    "String in `key=value` format. Provided variables will not be prompted for."
+)
 
 TEMPLATE_METADATA_FILE_NAME = "template.yml"
 

src/snowflake/cli/plugins/sql/commands.py

@@ -21,6 +21,7 @@
 from snowflake.cli.api.commands.decorators import with_project_definition
 from snowflake.cli.api.commands.flags import (
     parse_key_value_variables,
+    variables_option,
 )
 from snowflake.cli.api.commands.snow_typer import SnowTyperFactory
 from snowflake.cli.api.output.types import CommandResult, MultipleResults, QueryResult
@@ -55,11 +56,8 @@ def execute_sql(
         "-i",
         help="Read the query from standard input. Use it when piping input to this command.",
     ),
-    data_override: List[str] = typer.Option(
-        None,
-        "--variable",
-        "-D",
-        help="String in format of key=value. If provided the SQL content will "
+    data_override: List[str] = variables_option(
+        "String in format of key=value. If provided the SQL content will "
         "be treated as template and rendered using provided data.",
     ),
     **options,

src/snowflake/cli/plugins/stage/commands.py

@@ -23,9 +23,9 @@
 import typer
 from snowflake.cli.api.cli_global_context import cli_context
 from snowflake.cli.api.commands.flags import (
+    ExecuteVariablesOption,
     OnErrorOption,
     PatternOption,
-    VariablesOption,
     like_option,
 )
 from snowflake.cli.api.commands.snow_typer import SnowTyperFactory
@@ -201,7 +201,7 @@ def execute(
         show_default=False,
     ),
     on_error: OnErrorType = OnErrorOption,
-    variables: Optional[List[str]] = VariablesOption,
+    variables: Optional[List[str]] = ExecuteVariablesOption,
     **options,
 ):
     """

tests/__snapshots__/test_help_messages.ambr

@@ -2032,16 +2032,8 @@
   |                                  git repository with templates.              |
   |                                  [default:                                   |
   |                                  https://github.com/snowflakedb/snowflake-c… |
-  | --variable         -D      TEXT  Variables for the execution context. For    |
-  |                                  example: `-D "<key>=<value>"`. For SQL      |
-  |                                  files variables are use to expand the       |
-  |                                  template and any unknown variable will      |
-  |                                  cause an error. For Python files variables  |
-  |                                  are used to update os.environ dictionary.   |
-  |                                  Provided keys are capitalized to adhere to  |
-  |                                  best practices.In case of SQL files string  |
-  |                                  values must be quoted in `''` (consider     |
-  |                                  embedding quoting in the file).             |
+  | --variable         -D      TEXT  String in `key=value` format. Provided      |
+  |                                  variables will not be prompted for.         |
   | --no-interactive                 Disable prompting.                          |
   | --help             -h            Show this message and exit.                 |
   +------------------------------------------------------------------------------+
@@ -6756,7 +6748,6 @@
   | --variable  -D      TEXT  String in format of key=value. If provided the SQL |
   |                           content will be treated as template and rendered   |
   |                           using provided data.                               |
-  |                           [default: None]                                    |
   | --project   -p      TEXT  Path where Snowflake project resides. Defaults to  |
   |                           current working directory.                         |
   | --env               TEXT  String in format of key=value. Overrides variables |