snowflake-cli-labs 2.8.0rc1__py3-none-any.whl → 3.0.0__py3-none-any.whl

snowflake/cli/{plugins → _plugins}/nativeapp/version/commands.py

@@ -19,27 +19,22 @@ from typing import Optional
 
 import typer
 from click import MissingParameter
-from snowflake.cli.api.cli_global_context import cli_context
+from snowflake.cli._plugins.nativeapp.common_flags import ForceOption, InteractiveOption
+from snowflake.cli._plugins.nativeapp.run_processor import NativeAppRunProcessor
+from snowflake.cli._plugins.nativeapp.v2_conversions.v2_to_v1_decorator import (
+    nativeapp_definition_v2_to_v1,
+)
+from snowflake.cli._plugins.nativeapp.version.version_processor import (
+    NativeAppVersionCreateProcessor,
+    NativeAppVersionDropProcessor,
+)
+from snowflake.cli.api.cli_global_context import get_cli_context
 from snowflake.cli.api.commands.decorators import (
     with_project_definition,
 )
 from snowflake.cli.api.commands.snow_typer import SnowTyperFactory
 from snowflake.cli.api.output.types import CommandResult, MessageResult, QueryResult
 from snowflake.cli.api.project.project_verification import assert_project_type
-from snowflake.cli.plugins.nativeapp.common_flags import ForceOption, InteractiveOption
-from snowflake.cli.plugins.nativeapp.policy import (
-    AllowAlwaysPolicy,
-    AskAlwaysPolicy,
-    DenyAlwaysPolicy,
-)
-from snowflake.cli.plugins.nativeapp.run_processor import NativeAppRunProcessor
-from snowflake.cli.plugins.nativeapp.v2_conversions.v2_to_v1_decorator import (
-    nativeapp_definition_v2_to_v1,
-)
-from snowflake.cli.plugins.nativeapp.version.version_processor import (
-    NativeAppVersionCreateProcessor,
-    NativeAppVersionDropProcessor,
-)
 
 app = SnowTyperFactory(
     name="version",
@@ -51,7 +46,7 @@ log = logging.getLogger(__name__)
 
 @app.command(requires_connection=True)
 @with_project_definition()
-@nativeapp_definition_v2_to_v1
+@nativeapp_definition_v2_to_v1()
 def create(
     version: Optional[str] = typer.Argument(
         None,
@@ -82,41 +77,24 @@ def create(
     if version is None and patch is not None:
         raise MissingParameter("Cannot provide a patch without version!")
 
-    is_interactive = False
-    if force:
-        policy = AllowAlwaysPolicy()
-    elif interactive:
-        is_interactive = True
-        policy = AskAlwaysPolicy()
-    else:
-        policy = DenyAlwaysPolicy()
-
-    if skip_git_check:
-        git_policy = DenyAlwaysPolicy()
-    else:
-        git_policy = AllowAlwaysPolicy()
-
+    cli_context = get_cli_context()
     processor = NativeAppVersionCreateProcessor(
         project_definition=cli_context.project_definition.native_app,
         project_root=cli_context.project_root,
     )
-
-    # We need build_bundle() to (optionally) find version in manifest.yml and create an application package
-    bundle_map = processor.build_bundle()
     processor.process(
-        bundle_map=bundle_map,
         version=version,
         patch=patch,
-        policy=policy,
-        git_policy=git_policy,
-        is_interactive=is_interactive,
+        force=force,
+        interactive=interactive,
+        skip_git_check=skip_git_check,
     )
     return MessageResult(f"Version create is now complete.")
 
 
 @app.command("list", requires_connection=True)
 @with_project_definition()
-@nativeapp_definition_v2_to_v1
+@nativeapp_definition_v2_to_v1()
 def version_list(
     **options,
 ) -> CommandResult:
@@ -126,6 +104,7 @@ def version_list(
 
     assert_project_type("native_app")
 
+    cli_context = get_cli_context()
     processor = NativeAppRunProcessor(
         project_definition=cli_context.project_definition.native_app,
         project_root=cli_context.project_root,
@@ -136,7 +115,7 @@ def version_list(
 
 @app.command(requires_connection=True)
 @with_project_definition()
-@nativeapp_definition_v2_to_v1
+@nativeapp_definition_v2_to_v1()
 def drop(
     version: Optional[str] = typer.Argument(
         None,
@@ -153,18 +132,10 @@ def drop(
 
     assert_project_type("native_app")
 
-    is_interactive = False
-    if force:
-        policy = AllowAlwaysPolicy()
-    elif interactive:
-        is_interactive = True
-        policy = AskAlwaysPolicy()
-    else:
-        policy = DenyAlwaysPolicy()
-
+    cli_context = get_cli_context()
     processor = NativeAppVersionDropProcessor(
         project_definition=cli_context.project_definition.native_app,
         project_root=cli_context.project_root,
     )
-    processor.process(version, policy, is_interactive)
+    processor.process(version, force, interactive)
     return MessageResult(f"Version drop is now complete.")

snowflake/cli/_plugins/nativeapp/version/version_processor.py

@@ -0,0 +1,98 @@
+# Copyright (c) 2024 Snowflake Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from __future__ import annotations
+
+from pathlib import Path
+from typing import Dict, Optional
+
+from snowflake.cli._plugins.nativeapp.entities.application_package import (
+    ApplicationPackageEntity,
+)
+from snowflake.cli._plugins.nativeapp.manager import (
+    NativeAppCommandProcessor,
+    NativeAppManager,
+)
+from snowflake.cli._plugins.nativeapp.run_processor import NativeAppRunProcessor
+from snowflake.cli.api.console import cli_console as cc
+from snowflake.cli.api.project.schemas.v1.native_app.native_app import NativeApp
+
+
+class NativeAppVersionCreateProcessor(NativeAppRunProcessor):
+    def __init__(self, project_definition: Dict, project_root: Path):
+        super().__init__(project_definition, project_root)
+
+    def process(
+        self,
+        version: Optional[str],
+        patch: Optional[int],
+        force: bool,
+        interactive: bool,
+        skip_git_check: bool,
+        *args,
+        **kwargs,
+    ):
+        return ApplicationPackageEntity.version_create(
+            console=cc,
+            project_root=self.project_root,
+            deploy_root=self.deploy_root,
+            bundle_root=self.bundle_root,
+            generated_root=self.generated_root,
+            artifacts=self.artifacts,
+            package_name=self.package_name,
+            package_role=self.package_role,
+            package_distribution=self.package_distribution,
+            prune=True,
+            recursive=True,
+            paths=None,
+            print_diff=True,
+            validate=True,
+            stage_fqn=self.stage_fqn,
+            package_warehouse=self.package_warehouse,
+            post_deploy_hooks=self.package_post_deploy_hooks,
+            package_scripts=self.package_scripts,
+            version=version,
+            patch=patch,
+            force=force,
+            interactive=interactive,
+            skip_git_check=skip_git_check,
+        )
+
+
+class NativeAppVersionDropProcessor(NativeAppManager, NativeAppCommandProcessor):
+    def __init__(self, project_definition: NativeApp, project_root: Path):
+        super().__init__(project_definition, project_root)
+
+    def process(
+        self,
+        version: Optional[str],
+        force: bool,
+        interactive: bool,
+        *args,
+        **kwargs,
+    ):
+        return ApplicationPackageEntity.version_drop(
+            console=cc,
+            project_root=self.project_root,
+            deploy_root=self.deploy_root,
+            bundle_root=self.bundle_root,
+            generated_root=self.generated_root,
+            artifacts=self.artifacts,
+            package_name=self.package_name,
+            package_role=self.package_role,
+            package_distribution=self.package_distribution,
+            version=version,
+            force=force,
+            interactive=interactive,
+        )

snowflake/cli/{plugins → _plugins}/notebook/commands.py

@@ -15,11 +15,12 @@
 import logging
 
 import typer
+from snowflake.cli._plugins.notebook.manager import NotebookManager
+from snowflake.cli._plugins.notebook.types import NotebookStagePath
 from snowflake.cli.api.commands.flags import identifier_argument
 from snowflake.cli.api.commands.snow_typer import SnowTyperFactory
+from snowflake.cli.api.identifiers import FQN
 from snowflake.cli.api.output.types import MessageResult
-from snowflake.cli.plugins.notebook.manager import NotebookManager
-from snowflake.cli.plugins.notebook.types import NotebookName, NotebookStagePath
 from typing_extensions import Annotated
 
 app = SnowTyperFactory(
@@ -33,12 +34,13 @@ NotebookFile: NotebookStagePath = typer.Option(
     "--notebook-file",
     "-f",
     help="Stage path with notebook file. For example `@stage/path/to/notebook.ipynb`",
+    show_default=False,
 )
 
 
 @app.command(requires_connection=True)
 def execute(
-    identifier: str = NOTEBOOK_IDENTIFIER,
+    identifier: FQN = NOTEBOOK_IDENTIFIER,
     **options,
 ):
     """
@@ -51,7 +53,7 @@ def execute(
 
 @app.command(requires_connection=True)
 def get_url(
-    identifier: str = NOTEBOOK_IDENTIFIER,
+    identifier: FQN = NOTEBOOK_IDENTIFIER,
     **options,
 ):
     """Return a url to a notebook."""
@@ -61,7 +63,7 @@ def get_url(
 
 @app.command(name="open", requires_connection=True)
 def open_cmd(
-    identifier: str = NOTEBOOK_IDENTIFIER,
+    identifier: FQN = NOTEBOOK_IDENTIFIER,
     **options,
 ):
     """Opens a notebook in default browser"""
@@ -72,7 +74,7 @@ def open_cmd(
 
 @app.command(requires_connection=True)
 def create(
-    identifier: Annotated[NotebookName, NOTEBOOK_IDENTIFIER],
+    identifier: Annotated[FQN, NOTEBOOK_IDENTIFIER],
     notebook_file: Annotated[NotebookStagePath, NotebookFile],
     **options,
 ):

snowflake/cli/{plugins → _plugins}/notebook/manager.py

@@ -15,28 +15,28 @@
 from pathlib import Path
 from textwrap import dedent
 
-from snowflake.cli.api.cli_global_context import cli_context
+from snowflake.cli._plugins.connection.util import make_snowsight_url
+from snowflake.cli._plugins.notebook.exceptions import NotebookStagePathError
+from snowflake.cli._plugins.notebook.types import NotebookStagePath
+from snowflake.cli.api.cli_global_context import get_cli_context
 from snowflake.cli.api.identifiers import FQN
 from snowflake.cli.api.sql_execution import SqlExecutionMixin
-from snowflake.cli.plugins.connection.util import make_snowsight_url
-from snowflake.cli.plugins.notebook.exceptions import NotebookStagePathError
-from snowflake.cli.plugins.notebook.types import NotebookName, NotebookStagePath
 
 
 class NotebookManager(SqlExecutionMixin):
-    def execute(self, notebook_name: NotebookName):
-        query = f"EXECUTE NOTEBOOK {notebook_name}()"
+    def execute(self, notebook_name: FQN):
+        query = f"EXECUTE NOTEBOOK {notebook_name.sql_identifier}()"
         return self._execute_query(query=query)
 
-    def get_url(self, notebook_name: NotebookName):
-        fqn = FQN.from_string(notebook_name).using_connection(self._conn)
+    def get_url(self, notebook_name: FQN):
+        fqn = notebook_name.using_connection(self._conn)
         return make_snowsight_url(
             self._conn,
             f"/#/notebooks/{fqn.url_identifier}",
         )
 
     @staticmethod
-    def parse_stage_as_path(notebook_file: NotebookName) -> Path:
+    def parse_stage_as_path(notebook_file: str) -> Path:
         """Parses notebook file path to pathlib.Path."""
         if not notebook_file.endswith(".ipynb"):
             raise NotebookStagePathError(notebook_file)
@@ -48,19 +48,19 @@ class NotebookManager(SqlExecutionMixin):
 
     def create(
         self,
-        notebook_name: NotebookName,
+        notebook_name: FQN,
         notebook_file: NotebookStagePath,
     ) -> str:
-        notebook_fqn = FQN.from_string(notebook_name).using_connection(self._conn)
+        notebook_fqn = notebook_name.using_connection(self._conn)
         stage_path = self.parse_stage_as_path(notebook_file)
 
         queries = dedent(
             f"""
-            CREATE OR REPLACE NOTEBOOK {notebook_fqn.identifier}
+            CREATE OR REPLACE NOTEBOOK {notebook_fqn.sql_identifier}
             FROM '{stage_path.parent}'
-            QUERY_WAREHOUSE = '{cli_context.connection.warehouse}'
+            QUERY_WAREHOUSE = '{get_cli_context().connection.warehouse}'
             MAIN_FILE = '{stage_path.name}';
-
+            // Cannot use IDENTIFIER(...)
             ALTER NOTEBOOK {notebook_fqn.identifier} ADD LIVE VERSION FROM LAST;
             """
         )

snowflake/cli/{plugins/nativeapp → _plugins/notebook}/plugin_spec.py

@@ -12,13 +12,13 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+from snowflake.cli._plugins.notebook import commands
 from snowflake.cli.api.plugins.command import (
     SNOWCLI_ROOT_COMMAND_PATH,
     CommandSpec,
     CommandType,
     plugin_hook_impl,
 )
-from snowflake.cli.plugins.nativeapp import commands
 
 
 @plugin_hook_impl

snowflake/cli/{plugins → _plugins}/notebook/types.py

@@ -12,5 +12,4 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-NotebookName = str
 NotebookStagePath = str

snowflake/cli/{plugins → _plugins}/object/command_aliases.py

@@ -18,15 +18,16 @@ from typing import List, Optional, Tuple
 
 import typer
 from click import ClickException
-from snowflake.cli.api.commands.snow_typer import SnowTyperFactory
-from snowflake.cli.api.constants import ObjectType
-from snowflake.cli.plugins.object.commands import (
+from snowflake.cli._plugins.object.commands import (
     ScopeOption,
     describe,
     drop,
     list_,
     scope_option,  # noqa: F401
 )
+from snowflake.cli.api.commands.snow_typer import SnowTyperFactory
+from snowflake.cli.api.constants import ObjectType
+from snowflake.cli.api.identifiers import FQN
 
 
 def add_object_command_aliases(
@@ -72,7 +73,7 @@ def add_object_command_aliases(
     if "drop" not in ommit_commands:
 
         @app.command("drop", requires_connection=True)
-        def drop_cmd(name: str = name_argument, **options):
+        def drop_cmd(name: FQN = name_argument, **options):
             return drop(
                 object_type=object_type.value.cli_name,
                 object_name=name,
@@ -84,7 +85,7 @@ def add_object_command_aliases(
     if "describe" not in ommit_commands:
 
         @app.command("describe", requires_connection=True)
-        def describe_cmd(name: str = name_argument, **options):
+        def describe_cmd(name: FQN = name_argument, **options):
             return describe(
                 object_type=object_type.value.cli_name,
                 object_name=name,

snowflake/cli/{plugins → _plugins}/object/commands.py

@@ -18,12 +18,18 @@ 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._plugins.object.manager import ObjectManager
+from snowflake.cli.api.commands.flags import (
+    IdentifierType,
+    like_option,
+)
 from snowflake.cli.api.commands.snow_typer import SnowTyperFactory
+from snowflake.cli.api.commands.utils import parse_key_value_variables
 from snowflake.cli.api.constants import SUPPORTED_OBJECTS, VALID_SCOPES
+from snowflake.cli.api.exceptions import IncompatibleParametersError
+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
 
 app = SnowTyperFactory(
     name="object",
@@ -31,7 +37,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 +120,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 +133,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)
     )
 
 
@@ -146,9 +154,7 @@ def create(
     import json
 
     if object_attributes and object_json:
-        raise ClickException(
-            "Conflict: both object attributes and JSON definition are provided"
-        )
+        raise IncompatibleParametersError(["object_attributes", "--json"])
 
     if object_json:
         object_data = json.loads(object_json)

snowflake/cli/{plugins → _plugins}/object/manager.py

@@ -14,7 +14,6 @@
 
 from __future__ import annotations
 
-from textwrap import dedent
 from typing import Any, Dict, Optional, Tuple, Union
 
 from click import ClickException
@@ -22,11 +21,13 @@ 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
 from snowflake.connector.cursor import SnowflakeCursor
 from snowflake.connector.errors import BadRequest
+from snowflake.connector.vendored.requests.exceptions import HTTPError
 
 
 def _get_object_names(object_type: str) -> ObjectNames:
@@ -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
@@ -76,21 +77,42 @@ class ObjectManager(SqlExecutionMixin):
     def create(self, object_type: str, object_data: Dict[str, Any]) -> str:
         rest = RestApi(self._conn)
         url = rest.determine_url_for_create_query(object_type=object_type)
-
         try:
             response = rest.send_rest_request(url=url, method="post", data=object_data)
-            # workaround as SnowflakeRestful class ignores some errors, dropping their info and returns {} instead.
-            if not response:
+        except Exception as err:
+            _handle_create_error_codes(err)
+        return response["status"]
+
+
+def _handle_create_error_codes(err: Exception) -> None:
+    # according to https://docs.snowflake.com/developer-guide/snowflake-rest-api/reference/
+    if isinstance(err, BadRequest):
+        raise ClickException(
+            "400 bad request: Incorrect object definition (arguments misspelled or malformatted)."
+        )
+    if isinstance(err, HTTPError):
+        match err_code := err.response.status_code:
+            case 401:
                 raise ClickException(
-                    dedent(
-                        """                An unexpected error occurred while creating the object. Try again with --debug for more info.
-                Most probable reasons:
-                  * object you are trying to create already exists
-                  * role you are using do not have permissions to create this object"""
-                    )
+                    "401 unauthorized: role you are using does not have permissions to create this object."
                 )
-            return response["status"]
-        except BadRequest:
-            raise ClickException(
-                "Incorrect object definition (arguments misspelled or malformatted)."
-            )
+            # error 403 should be handled by connector
+            # error 404 is handled by determine-url logic
+            # error 405 should not happen under assumption that "all listable objects can be created"
+            case 408:
+                raise ClickException(
+                    "408 timeout: the request timed out and was not completed by the server."
+                )
+            case 409:
+                raise ClickException(
+                    "409 conflict: object you're trying to create already exists."
+                )
+            # error 410 is a network maintenance debugging - should not happen to the user
+            case 429:
+                raise ClickException(
+                    "429 too many requests. The number of requests hit the rate limit."
+                )
+            case 500 | 503 | 504:
+                raise ClickException(f"{err_code} internal server error.")
+            case _:
+                raise err

snowflake/cli/{plugins → _plugins}/object/plugin_spec.py

@@ -12,13 +12,13 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+from snowflake.cli._plugins.object import commands
 from snowflake.cli.api.plugins.command import (
     SNOWCLI_ROOT_COMMAND_PATH,
     CommandSpec,
     CommandType,
     plugin_hook_impl,
 )
-from snowflake.cli.plugins.object import commands
 
 
 @plugin_hook_impl