snowflake-cli-labs 2.8.0rc0__py3-none-any.whl → 2.8.1__py3-none-any.whl

snowflake/cli/plugins/object/commands.py

@@ -18,9 +18,14 @@ from typing import List, Optional, Tuple
 
 import typer
 from click import ClickException
-from snowflake.cli.api.commands.flags import like_option, parse_key_value_variables
+from snowflake.cli.api.commands.flags import (
+    IdentifierType,
+    like_option,
+    parse_key_value_variables,
+)
 from snowflake.cli.api.commands.snow_typer import SnowTyperFactory
 from snowflake.cli.api.constants import SUPPORTED_OBJECTS, VALID_SCOPES
+from snowflake.cli.api.identifiers import FQN
 from snowflake.cli.api.output.types import MessageResult, QueryResult
 from snowflake.cli.api.project.util import is_valid_identifier
 from snowflake.cli.plugins.object.manager import ObjectManager
@@ -31,7 +36,9 @@ app = SnowTyperFactory(
 )
 
 
-NameArgument = typer.Argument(help="Name of the object")
+NameArgument = typer.Argument(
+    help="Name of the object.", show_default=False, click_type=IdentifierType()
+)
 ObjectArgument = typer.Argument(
     help="Type of object. For example table, database, compute-pool.",
     case_sensitive=False,
@@ -112,8 +119,8 @@ def list_(
     help=f"Drops Snowflake object of given name and type. {SUPPORTED_TYPES_MSG}",
     requires_connection=True,
 )
-def drop(object_type: str = ObjectArgument, object_name: str = NameArgument, **options):
-    return QueryResult(ObjectManager().drop(object_type=object_type, name=object_name))
+def drop(object_type: str = ObjectArgument, object_name: FQN = NameArgument, **options):
+    return QueryResult(ObjectManager().drop(object_type=object_type, fqn=object_name))
 
 
 # Image repository is the only supported object that does not have a DESCRIBE command.
@@ -125,10 +132,10 @@ DESCRIBE_SUPPORTED_TYPES_MSG = f"\n\nSupported types: {', '.join(obj for obj in
     requires_connection=True,
 )
 def describe(
-    object_type: str = ObjectArgument, object_name: str = NameArgument, **options
+    object_type: str = ObjectArgument, object_name: FQN = NameArgument, **options
 ):
     return QueryResult(
-        ObjectManager().describe(object_type=object_type, name=object_name)
+        ObjectManager().describe(object_type=object_type, fqn=object_name)
     )
 
 

snowflake/cli/plugins/object/manager.py

@@ -22,6 +22,7 @@ from snowflake.cli.api.constants import (
     OBJECT_TO_NAMES,
     ObjectNames,
 )
+from snowflake.cli.api.identifiers import FQN
 from snowflake.cli.api.rest_api import RestApi
 from snowflake.cli.api.sql_execution import SqlExecutionMixin
 from snowflake.connector import ProgrammingError
@@ -53,22 +54,22 @@ class ObjectManager(SqlExecutionMixin):
             query += f" in {scope[0].replace('-', ' ')} {scope[1]}"
         return self._execute_query(query, **kwargs)
 
-    def drop(self, *, object_type: str, name: str) -> SnowflakeCursor:
+    def drop(self, *, object_type: str, fqn: FQN) -> SnowflakeCursor:
         object_name = _get_object_names(object_type).sf_name
-        return self._execute_query(f"drop {object_name} {name}")
+        return self._execute_query(f"drop {object_name} {fqn.sql_identifier}")
 
-    def describe(self, *, object_type: str, name: str):
+    def describe(self, *, object_type: str, fqn: FQN):
         # Image repository is the only supported object that does not have a DESCRIBE command.
         if object_type == "image-repository":
             raise ClickException(
                 f"Describe is currently not supported for object of type image-repository"
             )
         object_name = _get_object_names(object_type).sf_name
-        return self._execute_query(f"describe {object_name} {name}")
+        return self._execute_query(f"describe {object_name} {fqn.sql_identifier}")
 
-    def object_exists(self, *, object_type: str, name: str):
+    def object_exists(self, *, object_type: str, fqn: FQN):
         try:
-            self.describe(object_type=object_type, name=name)
+            self.describe(object_type=object_type, fqn=fqn)
             return True
         except ProgrammingError:
             return False

snowflake/cli/plugins/snowpark/commands.py

@@ -173,9 +173,7 @@ def deploy(
     stage_name = snowpark.stage_name
     stage_manager = StageManager()
     stage_name = FQN.from_string(stage_name).using_context()
-    stage_manager.create(
-        stage_name=stage_name, comment="deployments managed by Snowflake CLI"
-    )
+    stage_manager.create(fqn=stage_name, comment="deployments managed by Snowflake CLI")
 
     snowflake_dependencies = _read_snowflake_requrements_file(
         paths.snowflake_requirements_file
@@ -251,7 +249,7 @@ def _find_existing_objects(
         try:
             current_state = om.describe(
                 object_type=object_type.value.sf_name,
-                name=identifier,
+                fqn=FQN.from_string(identifier),
             )
             existing_objects[identifier] = current_state
         except ProgrammingError:
@@ -528,7 +526,7 @@ def list_(
 @app.command("drop", requires_connection=True)
 def drop(
     object_type: _SnowparkObject = ObjectTypeArgument,
-    identifier: str = IdentifierArgument,
+    identifier: FQN = IdentifierArgument,
     **options,
 ):
     """Drop procedure or function."""
@@ -538,7 +536,7 @@ def drop(
 @app.command("describe", requires_connection=True)
 def describe(
     object_type: _SnowparkObject = ObjectTypeArgument,
-    identifier: str = IdentifierArgument,
+    identifier: FQN = IdentifierArgument,
     **options,
 ):
     """Provides description of a procedure or function."""

snowflake/cli/plugins/snowpark/models.py

@@ -128,13 +128,14 @@ class WheelMetadata:
                 if line.startswith(dep_keyword)
             ]
             name = cls._get_name_from_wheel_filename(wheel_path.name)
+
             return cls(name=name, wheel_path=wheel_path, dependencies=dependencies)
 
     @staticmethod
     def _get_name_from_wheel_filename(wheel_filename: str) -> str:
         # wheel filename is in format {name}-{version}[-{extra info}]
         # https://peps.python.org/pep-0491/#file-name-convention
-        return wheel_filename.split("-")[0]
+        return wheel_filename.split("-")[0].lower()
 
     @staticmethod
     def to_wheel_name_format(package_name: str) -> str:

snowflake/cli/plugins/snowpark/package/manager.py

@@ -17,6 +17,7 @@ from __future__ import annotations
 import logging
 from pathlib import Path
 
+from snowflake.cli.api.identifiers import FQN
 from snowflake.cli.api.secure_path import SecurePath
 from snowflake.cli.plugins.snowpark.package.utils import prepare_app_zip
 from snowflake.cli.plugins.stage.manager import StageManager
@@ -30,7 +31,7 @@ def upload(file: Path, stage: str, overwrite: bool):
         temp_app_zip_path = prepare_app_zip(SecurePath(file), temp_dir)
         sm = StageManager()
 
-        sm.create(sm.get_stage_from_path(stage))
+        sm.create(FQN.from_string(sm.get_stage_from_path(stage)))
         put_response = sm.put(
             temp_app_zip_path.path, stage, overwrite=overwrite
         ).fetchone()

snowflake/cli/plugins/spcs/compute_pool/commands.py

@@ -21,10 +21,12 @@ from click import ClickException
 from snowflake.cli.api.commands.flags import (
     IfNotExistsOption,
     OverrideableOption,
+    identifier_argument,
     like_option,
 )
 from snowflake.cli.api.commands.snow_typer import SnowTyperFactory
 from snowflake.cli.api.constants import ObjectType
+from snowflake.cli.api.identifiers import FQN
 from snowflake.cli.api.output.types import CommandResult, SingleQueryResult
 from snowflake.cli.api.project.util import is_valid_object_name
 from snowflake.cli.plugins.object.command_aliases import (
@@ -43,22 +45,21 @@ app = SnowTyperFactory(
 )
 
 
-def _compute_pool_name_callback(name: str) -> str:
+def _compute_pool_name_callback(name: FQN) -> FQN:
     """
     Verifies that compute pool name is a single valid identifier.
     """
-    if not is_valid_object_name(name, max_depth=0, allow_quoted=False):
+    if not is_valid_object_name(name.identifier, max_depth=0, allow_quoted=False):
         raise ClickException(
             f"'{name}' is not a valid compute pool name. Note that compute pool names must be unquoted identifiers."
         )
     return name
 
 
-ComputePoolNameArgument = typer.Argument(
-    ...,
-    help="Name of the compute pool.",
+ComputePoolNameArgument = identifier_argument(
+    sf_object="compute pool",
+    example="my_compute_pool",
     callback=_compute_pool_name_callback,
-    show_default=False,
 )
 
 
@@ -106,7 +107,7 @@ add_object_command_aliases(
 
 @app.command(requires_connection=True)
 def create(
-    name: str = ComputePoolNameArgument,
+    name: FQN = ComputePoolNameArgument,
     instance_family: str = typer.Option(
         ...,
         "--family",
@@ -131,7 +132,7 @@ def create(
     """
     max_nodes = validate_and_set_instances(min_nodes, max_nodes, "nodes")
     cursor = ComputePoolManager().create(
-        pool_name=name,
+        pool_name=name.identifier,
         min_nodes=min_nodes,
         max_nodes=max_nodes,
         instance_family=instance_family,
@@ -145,33 +146,33 @@ def create(
 
 
 @app.command("stop-all", requires_connection=True)
-def stop_all(name: str = ComputePoolNameArgument, **options) -> CommandResult:
+def stop_all(name: FQN = ComputePoolNameArgument, **options) -> CommandResult:
     """
     Deletes all services running on the compute pool.
     """
-    cursor = ComputePoolManager().stop(pool_name=name)
+    cursor = ComputePoolManager().stop(pool_name=name.identifier)
     return SingleQueryResult(cursor)
 
 
 @app.command(requires_connection=True)
-def suspend(name: str = ComputePoolNameArgument, **options) -> CommandResult:
+def suspend(name: FQN = ComputePoolNameArgument, **options) -> CommandResult:
     """
     Suspends the compute pool by suspending all currently running services and then releasing compute pool nodes.
     """
-    return SingleQueryResult(ComputePoolManager().suspend(name))
+    return SingleQueryResult(ComputePoolManager().suspend(name.identifier))
 
 
 @app.command(requires_connection=True)
-def resume(name: str = ComputePoolNameArgument, **options) -> CommandResult:
+def resume(name: FQN = ComputePoolNameArgument, **options) -> CommandResult:
     """
     Resumes the compute pool from a SUSPENDED state.
     """
-    return SingleQueryResult(ComputePoolManager().resume(name))
+    return SingleQueryResult(ComputePoolManager().resume(name.identifier))
 
 
 @app.command("set", requires_connection=True)
 def set_property(
-    name: str = ComputePoolNameArgument,
+    name: FQN = ComputePoolNameArgument,
     min_nodes: Optional[int] = MinNodesOption(default=None, show_default=False),
     max_nodes: Optional[int] = MaxNodesOption(show_default=False),
     auto_resume: Optional[bool] = AutoResumeOption(default=None, show_default=False),
@@ -187,7 +188,7 @@ def set_property(
     Sets one or more properties for the compute pool.
     """
     cursor = ComputePoolManager().set_property(
-        pool_name=name,
+        pool_name=name.identifier,
         min_nodes=min_nodes,
         max_nodes=max_nodes,
         auto_resume=auto_resume,
@@ -199,7 +200,7 @@ def set_property(
 
 @app.command("unset", requires_connection=True)
 def unset_property(
-    name: str = ComputePoolNameArgument,
+    name: FQN = ComputePoolNameArgument,
     auto_resume: bool = AutoResumeOption(
         default=False,
         param_decls=["--auto-resume"],
@@ -223,7 +224,7 @@ def unset_property(
     Resets one or more properties for the compute pool to their default value(s).
     """
     cursor = ComputePoolManager().unset_property(
-        pool_name=name,
+        pool_name=name.identifier,
         auto_resume=auto_resume,
         auto_suspend_secs=auto_suspend_secs,
         comment=comment,
@@ -232,9 +233,9 @@ def unset_property(
 
 
 @app.command(requires_connection=True)
-def status(pool_name: str = ComputePoolNameArgument, **options) -> CommandResult:
+def status(pool_name: FQN = ComputePoolNameArgument, **options) -> CommandResult:
     """
     Retrieves the status of a compute pool along with a relevant message, if one exists.
     """
-    cursor = ComputePoolManager().status(pool_name=pool_name)
+    cursor = ComputePoolManager().status(pool_name=pool_name.identifier)
     return SingleQueryResult(cursor)

snowflake/cli/plugins/spcs/image_repository/commands.py

@@ -23,11 +23,13 @@ from click import ClickException
 from snowflake.cli.api.commands.flags import (
     IfNotExistsOption,
     ReplaceOption,
+    identifier_argument,
     like_option,
 )
 from snowflake.cli.api.commands.snow_typer import SnowTyperFactory
 from snowflake.cli.api.console import cli_console
 from snowflake.cli.api.constants import ObjectType
+from snowflake.cli.api.identifiers import FQN
 from snowflake.cli.api.output.types import (
     CollectionResult,
     MessageResult,
@@ -48,18 +50,18 @@ app = SnowTyperFactory(
 )
 
 
-def _repo_name_callback(name: str):
-    if not is_valid_object_name(name, max_depth=2, allow_quoted=False):
+def _repo_name_callback(name: FQN):
+    if not is_valid_object_name(name.identifier, max_depth=2, allow_quoted=False):
         raise ClickException(
             f"'{name}' is not a valid image repository name. Note that image repository names must be unquoted identifiers. The same constraint also applies to database and schema names where you create an image repository."
         )
     return name
 
 
-REPO_NAME_ARGUMENT = typer.Argument(
-    help="Name of the image repository.",
+REPO_NAME_ARGUMENT = identifier_argument(
+    sf_object="image repository",
+    example="my_repository",
     callback=_repo_name_callback,
-    show_default=False,
 )
 
 add_object_command_aliases(
@@ -76,7 +78,7 @@ add_object_command_aliases(
 
 @app.command(requires_connection=True)
 def create(
-    name: str = REPO_NAME_ARGUMENT,
+    name: FQN = REPO_NAME_ARGUMENT,
     replace: bool = ReplaceOption(),
     if_not_exists: bool = IfNotExistsOption(),
     **options,
@@ -86,21 +88,21 @@ def create(
     """
     return SingleQueryResult(
         ImageRepositoryManager().create(
-            name=name, replace=replace, if_not_exists=if_not_exists
+            name=name.identifier, replace=replace, if_not_exists=if_not_exists
         )
     )
 
 
 @app.command("list-images", requires_connection=True)
 def list_images(
-    name: str = REPO_NAME_ARGUMENT,
+    name: FQN = REPO_NAME_ARGUMENT,
     **options,
 ) -> CollectionResult:
     """Lists images in the given repository."""
     repository_manager = ImageRepositoryManager()
     database = repository_manager.get_database()
     schema = repository_manager.get_schema()
-    url = repository_manager.get_repository_url(name)
+    url = repository_manager.get_repository_url(name.identifier)
     api_url = repository_manager.get_repository_api_url(url)
     bearer_login = RegistryManager().login_to_registry(api_url)
     repos = []
@@ -136,7 +138,7 @@ def list_images(
 
 @app.command("list-tags", requires_connection=True)
 def list_tags(
-    name: str = REPO_NAME_ARGUMENT,
+    name: FQN = REPO_NAME_ARGUMENT,
     image_name: str = typer.Option(
         ...,
         "--image-name",
@@ -150,7 +152,7 @@ def list_tags(
     """Lists tags for the given image in a repository."""
 
     repository_manager = ImageRepositoryManager()
-    url = repository_manager.get_repository_url(name)
+    url = repository_manager.get_repository_url(name.identifier)
     api_url = repository_manager.get_repository_api_url(url)
     bearer_login = RegistryManager().login_to_registry(api_url)
 
@@ -187,10 +189,14 @@ def list_tags(
 
 @app.command("url", requires_connection=True)
 def repo_url(
-    name: str = REPO_NAME_ARGUMENT,
+    name: FQN = REPO_NAME_ARGUMENT,
     **options,
 ):
     """Returns the URL for the given repository."""
     return MessageResult(
-        (ImageRepositoryManager().get_repository_url(repo_name=name, with_scheme=False))
+        (
+            ImageRepositoryManager().get_repository_url(
+                repo_name=name.identifier, with_scheme=False
+            )
+        )
     )

snowflake/cli/plugins/spcs/services/commands.py

@@ -23,10 +23,12 @@ from click import ClickException
 from snowflake.cli.api.commands.flags import (
     IfNotExistsOption,
     OverrideableOption,
+    identifier_argument,
     like_option,
 )
 from snowflake.cli.api.commands.snow_typer import SnowTyperFactory
 from snowflake.cli.api.constants import ObjectType
+from snowflake.cli.api.identifiers import FQN
 from snowflake.cli.api.output.types import (
     CommandResult,
     QueryJsonValueResult,
@@ -52,19 +54,18 @@ app = SnowTyperFactory(
 )
 
 
-def _service_name_callback(name: str) -> str:
-    if not is_valid_object_name(name, max_depth=2, allow_quoted=False):
+def _service_name_callback(name: FQN) -> FQN:
+    if not is_valid_object_name(name.identifier, max_depth=2, allow_quoted=False):
         raise ClickException(
             f"'{name}' is not a valid service name. Note service names must be unquoted identifiers. The same constraint also applies to database and schema names where you create a service."
         )
     return name
 
 
-ServiceNameArgument = typer.Argument(
-    ...,
-    help="Name of the service.",
+ServiceNameArgument = identifier_argument(
+    sf_object="service pool",
+    example="my_service",
     callback=_service_name_callback,
-    show_default=False,
 )
 
 SpecPathOption = typer.Option(
@@ -116,7 +117,7 @@ add_object_command_aliases(
 
 @app.command(requires_connection=True)
 def create(
-    name: str = ServiceNameArgument,
+    name: FQN = ServiceNameArgument,
     compute_pool: str = typer.Option(
         ...,
         "--compute-pool",
@@ -145,7 +146,7 @@ def create(
         min_instances, max_instances, "instances"
     )
     cursor = ServiceManager().create(
-        service_name=name,
+        service_name=name.identifier,
         min_instances=min_instances,
         max_instances=max_instances,
         compute_pool=compute_pool,
@@ -161,17 +162,17 @@ def create(
 
 
 @app.command(requires_connection=True)
-def status(name: str = ServiceNameArgument, **options) -> CommandResult:
+def status(name: FQN = ServiceNameArgument, **options) -> CommandResult:
     """
     Retrieves the status of a service.
     """
-    cursor = ServiceManager().status(service_name=name)
+    cursor = ServiceManager().status(service_name=name.identifier)
     return QueryJsonValueResult(cursor)
 
 
 @app.command(requires_connection=True)
 def logs(
-    name: str = ServiceNameArgument,
+    name: FQN = ServiceNameArgument,
     container_name: str = typer.Option(
         ...,
         "--container-name",
@@ -193,7 +194,7 @@ def logs(
     Retrieves local logs from a service container.
     """
     results = ServiceManager().logs(
-        service_name=name,
+        service_name=name.identifier,
         instance_id=instance_id,
         container_name=container_name,
         num_lines=num_lines,
@@ -205,7 +206,7 @@ def logs(
 
 @app.command(requires_connection=True)
 def upgrade(
-    name: str = ServiceNameArgument,
+    name: FQN = ServiceNameArgument,
     spec_path: Path = SpecPathOption,
     **options,
 ):
@@ -213,20 +214,20 @@ def upgrade(
     Updates an existing service with a new specification file.
     """
     return SingleQueryResult(
-        ServiceManager().upgrade_spec(service_name=name, spec_path=spec_path)
+        ServiceManager().upgrade_spec(service_name=name.identifier, spec_path=spec_path)
     )
 
 
 @app.command("list-endpoints", requires_connection=True)
-def list_endpoints(name: str = ServiceNameArgument, **options):
+def list_endpoints(name: FQN = ServiceNameArgument, **options):
     """
     Lists the endpoints in a service.
     """
-    return QueryResult(ServiceManager().list_endpoints(service_name=name))
+    return QueryResult(ServiceManager().list_endpoints(service_name=name.identifier))
 
 
 @app.command(requires_connection=True)
-def suspend(name: str = ServiceNameArgument, **options) -> CommandResult:
+def suspend(name: FQN = ServiceNameArgument, **options) -> CommandResult:
     """
     Suspends the service, shutting down and deleting all its containers.
     """
@@ -234,7 +235,7 @@ def suspend(name: str = ServiceNameArgument, **options) -> CommandResult:
 
 
 @app.command(requires_connection=True)
-def resume(name: str = ServiceNameArgument, **options) -> CommandResult:
+def resume(name: FQN = ServiceNameArgument, **options) -> CommandResult:
     """
     Resumes the service from a SUSPENDED state.
     """
@@ -243,7 +244,7 @@ def resume(name: str = ServiceNameArgument, **options) -> CommandResult:
 
 @app.command("set", requires_connection=True)
 def set_property(
-    name: str = ServiceNameArgument,
+    name: FQN = ServiceNameArgument,
     min_instances: Optional[int] = MinInstancesOption(default=None, show_default=False),
     max_instances: Optional[int] = MaxInstancesOption(show_default=False),
     query_warehouse: Optional[str] = QueryWarehouseOption(show_default=False),
@@ -255,7 +256,7 @@ def set_property(
     Sets one or more properties for the service.
     """
     cursor = ServiceManager().set_property(
-        service_name=name,
+        service_name=name.identifier,
         min_instances=min_instances,
         max_instances=max_instances,
         query_warehouse=query_warehouse,
@@ -267,7 +268,7 @@ def set_property(
 
 @app.command("unset", requires_connection=True)
 def unset_property(
-    name: str = ServiceNameArgument,
+    name: FQN = ServiceNameArgument,
     min_instances: bool = MinInstancesOption(
         default=False,
         help=f"Reset the MIN_INSTANCES property - {_MIN_INSTANCES_HELP}",
@@ -301,7 +302,7 @@ def unset_property(
     Resets one or more properties for the service to their default value(s).
     """
     cursor = ServiceManager().unset_property(
-        service_name=name,
+        service_name=name.identifier,
         min_instances=min_instances,
         max_instances=max_instances,
         query_warehouse=query_warehouse,

snowflake/cli/plugins/stage/commands.py

@@ -26,11 +26,13 @@ from snowflake.cli.api.commands.flags import (
     ExecuteVariablesOption,
     OnErrorOption,
     PatternOption,
+    identifier_argument,
     like_option,
 )
 from snowflake.cli.api.commands.snow_typer import SnowTyperFactory
 from snowflake.cli.api.console import cli_console
 from snowflake.cli.api.constants import ObjectType
+from snowflake.cli.api.identifiers import FQN
 from snowflake.cli.api.output.formats import OutputFormat
 from snowflake.cli.api.output.types import (
     CollectionResult,
@@ -56,7 +58,7 @@ app = SnowTyperFactory(
     help="Manages stages.",
 )
 
-StageNameArgument = typer.Argument(..., help="Name of the stage.", show_default=False)
+StageNameArgument = identifier_argument(sf_object="stage", example="@my_stage")
 
 add_object_command_aliases(
     app=app,
@@ -142,17 +144,17 @@ def copy(
 
 
 @app.command("create", requires_connection=True)
-def stage_create(stage_name: str = StageNameArgument, **options) -> CommandResult:
+def stage_create(stage_name: FQN = StageNameArgument, **options) -> CommandResult:
     """
     Creates a named stage if it does not already exist.
     """
-    cursor = StageManager().create(stage_name=stage_name)
+    cursor = StageManager().create(fqn=stage_name)
     return SingleQueryResult(cursor)
 
 
 @app.command("remove", requires_connection=True)
 def stage_remove(
-    stage_name: str = StageNameArgument,
+    stage_name: FQN = StageNameArgument,
     file_name: str = typer.Argument(
         ...,
         help="Name of the file to remove.",
@@ -164,7 +166,7 @@ def stage_remove(
     Removes a file from a stage.
     """
 
-    cursor = StageManager().remove(stage_name=stage_name, path=file_name)
+    cursor = StageManager().remove(stage_name=stage_name.identifier, path=file_name)
     return SingleQueryResult(cursor)