snowflake-cli-labs 2.6.0rc0__py3-none-any.whl → 2.7.0__py3-none-any.whl

snowflake/cli/plugins/streamlit/commands.py

@@ -35,6 +35,7 @@ from snowflake.cli.api.output.types import (
     MessageResult,
     SingleQueryResult,
 )
+from snowflake.cli.api.project.project_verification import assert_project_type
 from snowflake.cli.api.project.schemas.streamlit.streamlit import Streamlit
 from snowflake.cli.plugins.object.command_aliases import (
     add_object_command_aliases,
@@ -49,8 +50,18 @@ app = SnowTyperFactory(
 log = logging.getLogger(__name__)
 
 
+class IdentifierType(click.ParamType):
+    name = "TEXT"
+
+    def convert(self, value, param, ctx):
+        return FQN.from_string(value)
+
+
 StreamlitNameArgument = typer.Argument(
-    ..., help="Name of the Streamlit app.", show_default=False
+    ...,
+    help="Name of the Streamlit app.",
+    show_default=False,
+    click_type=IdentifierType(),
 )
 OpenOption = typer.Option(
     False,
@@ -79,7 +90,7 @@ add_object_command_aliases(
 
 @app.command("share", requires_connection=True)
 def streamlit_share(
-    name: str = StreamlitNameArgument,
+    name: FQN = StreamlitNameArgument,
     to_role: str = typer.Argument(
         ..., help="Role with which to share the Streamlit app."
     ),
@@ -108,7 +119,7 @@ def _default_file_callback(param_name: str):
 
 
 @app.command("deploy", requires_connection=True)
-@with_project_definition("streamlit")
+@with_project_definition()
 @with_experimental_behaviour()
 def streamlit_deploy(
     replace: bool = ReplaceOption(
@@ -122,6 +133,9 @@ def streamlit_deploy(
     environment.yml and any other pages or folders, if present. If you don’t specify a stage name, the `streamlit`
     stage is used. If the specified stage does not exist, the command creates it.
     """
+
+    assert_project_type("streamlit")
+
     streamlit: Streamlit = cli_context.project_definition.streamlit
     if not streamlit:
         return MessageResult("No streamlit were specified in project definition.")
@@ -138,10 +152,10 @@ def streamlit_deploy(
     elif pages_dir is None:
         pages_dir = "pages"
 
-    streamlit_name = FQN.from_identifier_model(streamlit).using_context()
+    streamlit_id = FQN.from_identifier_model(streamlit).using_context()
 
     url = StreamlitManager().deploy(
-        streamlit=streamlit_name,
+        streamlit_id=streamlit_id,
         environment_file=Path(environment_file),
         pages_dir=Path(pages_dir),
         stage_name=streamlit.stage,
@@ -161,7 +175,7 @@ def streamlit_deploy(
 
 @app.command("get-url", requires_connection=True)
 def get_url(
-    name: str = StreamlitNameArgument,
+    name: FQN = StreamlitNameArgument,
     open_: bool = OpenOption,
     **options,
 ):

snowflake/cli/plugins/streamlit/manager.py

@@ -15,6 +15,7 @@
 from __future__ import annotations
 
 import logging
+import os
 from pathlib import Path
 from typing import List, Optional
 
@@ -25,7 +26,8 @@ from snowflake.cli.api.feature_flags import FeatureFlag
 from snowflake.cli.api.identifiers import FQN
 from snowflake.cli.api.sql_execution import SqlExecutionMixin
 from snowflake.cli.plugins.connection.util import (
-    MissingConnectionHostError,
+    MissingConnectionAccountError,
+    MissingConnectionRegionError,
     make_snowsight_url,
 )
 from snowflake.cli.plugins.stage.manager import StageManager
@@ -36,9 +38,9 @@ log = logging.getLogger(__name__)
 
 
 class StreamlitManager(SqlExecutionMixin):
-    def share(self, streamlit_name: str, to_role: str) -> SnowflakeCursor:
+    def share(self, streamlit_name: FQN, to_role: str) -> SnowflakeCursor:
         return self._execute_query(
-            f"grant usage on streamlit {streamlit_name} to role {to_role}"
+            f"grant usage on streamlit {streamlit_name.sql_identifier} to role {to_role}"
         )
 
     def _put_streamlit_files(
@@ -47,7 +49,7 @@ class StreamlitManager(SqlExecutionMixin):
         main_file: Path,
         environment_file: Optional[Path],
         pages_dir: Optional[Path],
-        additional_source_files: Optional[List[str]],
+        additional_source_files: Optional[List[Path]],
     ):
         stage_manager = StageManager()
 
@@ -61,18 +63,15 @@ class StreamlitManager(SqlExecutionMixin):
 
         if additional_source_files:
             for file in additional_source_files:
-                # If the file is in a folder, PUT it to the same folder in the stage
-                # If not, just PUT it to the root of the stage
-                destination = (
-                    f"{root_location}/{str(Path(file).parent)}"
-                    if "/" in file
-                    else root_location
-                )
+                if os.sep in str(file):
+                    destination = f"{root_location}/{str(file.parent)}"
+                else:
+                    destination = root_location
                 stage_manager.put(file, destination, 4, True)
 
     def _create_streamlit(
         self,
-        fully_qualified_name: str,
+        streamlit_id: FQN,
         main_file: Path,
         replace: Optional[bool] = None,
         experimental: Optional[bool] = None,
@@ -82,15 +81,17 @@ class StreamlitManager(SqlExecutionMixin):
     ):
         query = []
         if replace:
-            query.append(f"CREATE OR REPLACE STREAMLIT {fully_qualified_name}")
+            query.append(f"CREATE OR REPLACE STREAMLIT {streamlit_id.sql_identifier}")
         elif experimental:
             # For experimental behaviour, we need to use CREATE STREAMLIT IF NOT EXISTS
             # for a streamlit app with an embedded stage
             # because this is analogous to the behavior for non-experimental
             # deploy which does CREATE STAGE IF NOT EXISTS
-            query.append(f"CREATE STREAMLIT IF NOT EXISTS {fully_qualified_name}")
+            query.append(
+                f"CREATE STREAMLIT IF NOT EXISTS {streamlit_id.sql_identifier}"
+            )
         else:
-            query.append(f"CREATE STREAMLIT {fully_qualified_name}")
+            query.append(f"CREATE STREAMLIT {streamlit_id.sql_identifier}")
 
         if from_stage_name:
             query.append(f"ROOT_LOCATION = '{from_stage_name}'")
@@ -106,25 +107,25 @@ class StreamlitManager(SqlExecutionMixin):
 
     def deploy(
         self,
-        streamlit: FQN,
+        streamlit_id: FQN,
         main_file: Path,
         environment_file: Optional[Path] = None,
         pages_dir: Optional[Path] = None,
         stage_name: Optional[str] = None,
         query_warehouse: Optional[str] = None,
         replace: Optional[bool] = False,
-        additional_source_files: Optional[List[str]] = None,
+        additional_source_files: Optional[List[Path]] = None,
         title: Optional[str] = None,
         **options,
     ):
         # for backwards compatibility - quoted stage path might be case-sensitive
         # https://docs.snowflake.com/en/sql-reference/identifiers-syntax#double-quoted-identifiers
-        streamlit_name_for_root_location = streamlit.name
-        fully_qualified_name = streamlit.identifier
-
+        streamlit_name_for_root_location = streamlit_id.name
+        use_versioned_stage = FeatureFlag.ENABLE_STREAMLIT_VERSIONED_STAGE.is_enabled()
         if (
             experimental_behaviour_enabled()
             or FeatureFlag.ENABLE_STREAMLIT_EMBEDDED_STAGE.is_enabled()
+            or use_versioned_stage
         ):
             """
             1. Create streamlit object
@@ -133,7 +134,7 @@ class StreamlitManager(SqlExecutionMixin):
             # TODO: Support from_stage
             # from_stage_stmt = f"FROM_STAGE = '{stage_name}'" if stage_name else ""
             self._create_streamlit(
-                fully_qualified_name,
+                streamlit_id,
                 main_file,
                 replace=replace,
                 query_warehouse=query_warehouse,
@@ -141,17 +142,30 @@ class StreamlitManager(SqlExecutionMixin):
                 title=title,
             )
             try:
-                self._execute_query(f"ALTER streamlit {fully_qualified_name} CHECKOUT")
+                if use_versioned_stage:
+                    self._execute_query(
+                        f"ALTER STREAMLIT {streamlit_id.identifier} ADD LIVE VERSION FROM LAST"
+                    )
+                elif not FeatureFlag.ENABLE_STREAMLIT_NO_CHECKOUTS.is_enabled():
+                    self._execute_query(
+                        f"ALTER streamlit {streamlit_id.identifier} CHECKOUT"
+                    )
             except ProgrammingError as e:
-                # If an error is raised because a CHECKOUT has already occurred,
-                # simply skip it and continue
-                if "Checkout already exists" in str(e):
+                # If an error is raised because a CHECKOUT has already occurred or a LIVE VERSION already exists, simply skip it and continue
+                if "Checkout already exists" in str(
+                    e
+                ) or "There is already a live version" in str(e):
                     log.info("Checkout already exists, continuing")
                 else:
                     raise
-            stage_path = streamlit.identifier
+
+            stage_path = streamlit_id.identifier
             embedded_stage_name = f"snow://streamlit/{stage_path}"
-            root_location = f"{embedded_stage_name}/default_checkout"
+            if use_versioned_stage:
+                # "LIVE" is the only supported version for now, but this may change later.
+                root_location = f"{embedded_stage_name}/versions/live"
+            else:
+                root_location = f"{embedded_stage_name}/default_checkout"
 
             self._put_streamlit_files(
                 root_location,
@@ -186,7 +200,7 @@ class StreamlitManager(SqlExecutionMixin):
             )
 
             self._create_streamlit(
-                fully_qualified_name,
+                streamlit_id,
                 main_file,
                 replace=replace,
                 query_warehouse=query_warehouse,
@@ -195,14 +209,14 @@ class StreamlitManager(SqlExecutionMixin):
                 title=title,
             )
 
-        return self.get_url(fully_qualified_name)
+        return self.get_url(streamlit_name=streamlit_id)
 
-    def get_url(self, streamlit_name: str, database=None, schema=None) -> str:
+    def get_url(self, streamlit_name: FQN) -> str:
         try:
-            fqn = FQN.from_string(streamlit_name).using_connection(self._conn)
+            fqn = streamlit_name.using_connection(self._conn)
             return make_snowsight_url(
                 self._conn,
                 f"/#/streamlit-apps/{fqn.url_identifier}",
             )
-        except MissingConnectionHostError as e:
+        except (MissingConnectionRegionError, MissingConnectionAccountError) as e:
             return "https://app.snowflake.com"

snowflake/cli/plugins/workspace/__init__.py

@@ -0,0 +1,13 @@
+# 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.

snowflake/cli/plugins/workspace/commands.py

@@ -0,0 +1,35 @@
+# 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 snowflake.cli.api.commands.decorators import with_project_definition
+from snowflake.cli.api.commands.snow_typer import SnowTyper
+from snowflake.cli.api.output.types import MessageResult
+
+ws = SnowTyper(
+    name="ws",
+    hidden=True,
+    help="Deploy and interact with snowflake.yml-based entities.",
+)
+
+
+@ws.command(requires_connection=True)
+@with_project_definition()
+def validate(
+    **options,
+):
+    """Validates the project definition file."""
+    # If we get to this point, @with_project_definition() has already validated the PDF schema
+    return MessageResult("Project definition is valid.")

snowflake/cli/plugins/workspace/plugin_spec.py

@@ -0,0 +1,30 @@
+# 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 snowflake.cli.api.plugins.command import (
+    SNOWCLI_ROOT_COMMAND_PATH,
+    CommandSpec,
+    CommandType,
+    plugin_hook_impl,
+)
+from snowflake.cli.plugins.workspace import commands
+
+
+@plugin_hook_impl
+def command_spec():
+    return CommandSpec(
+        parent_command_path=SNOWCLI_ROOT_COMMAND_PATH,
+        command_type=CommandType.COMMAND_GROUP,
+        typer_instance=commands.ws,
+    )

snowflake/cli/templates/default_snowpark/app/__init__.py

@@ -1,13 +0,0 @@
-# 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.

snowflake/cli/templates/default_snowpark/app/common.py

@@ -1,17 +1,2 @@
-# 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.
-
-
 def print_hello(name: str):
     return f"Hello {name}!"

snowflake/cli/templates/default_snowpark/app/functions.py

@@ -1,17 +1,3 @@
-# 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
 
 import sys

snowflake/cli/templates/default_snowpark/app/procedures.py

@@ -1,17 +1,3 @@
-# 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
 
 import sys

snowflake/cli/templates/default_streamlit/common/hello.py

@@ -1,17 +1,2 @@
-# 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.
-
-
 def say_hello():
     return "Hello!"

snowflake/cli/templates/default_streamlit/pages/my_page.py

@@ -1,17 +1,3 @@
-# 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.
-
 import streamlit as st
 
 st.title("Example page")

snowflake/cli/templates/default_streamlit/streamlit_app.py

@@ -1,17 +1,3 @@
-# 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.
-
 import streamlit as st
 from common.hello import say_hello
 

{snowflake_cli_labs-2.6.0rc0.dist-info → snowflake_cli_labs-2.7.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: snowflake-cli-labs
-Version: 2.6.0rc0
+Version: 2.7.0
 Summary: Snowflake CLI
 Project-URL: Source code, https://github.com/snowflakedb/snowflake-cli
 Project-URL: Bug Tracker, https://github.com/snowflakedb/snowflake-cli/issues
@@ -222,22 +222,23 @@ Requires-Dist: jinja2==3.1.4
 Requires-Dist: packaging
 Requires-Dist: pip
 Requires-Dist: pluggy==1.5.0
-Requires-Dist: pydantic==2.8.0
+Requires-Dist: pydantic==2.8.2
 Requires-Dist: pyyaml==6.0.1
 Requires-Dist: requests==2.32.3
 Requires-Dist: requirements-parser==0.9.0
 Requires-Dist: rich==13.7.1
-Requires-Dist: setuptools==70.1.1
+Requires-Dist: setuptools==70.3.0
 Requires-Dist: snowflake-connector-python[secure-local-storage]==3.11.0
 Requires-Dist: snowflake-core==0.8.0; python_version < '3.12'
-Requires-Dist: tomlkit==0.12.5
+Requires-Dist: snowflake-snowpark-python>=1.15.0; python_version < '3.12'
+Requires-Dist: tomlkit==0.13.0
 Requires-Dist: typer==0.12.3
 Requires-Dist: urllib3<2.3,>=1.24.3
 Provides-Extra: development
-Requires-Dist: coverage==7.5.4; extra == 'development'
+Requires-Dist: coverage==7.6.0; extra == 'development'
 Requires-Dist: pre-commit>=3.5.0; extra == 'development'
 Requires-Dist: pytest-randomly==3.15.0; extra == 'development'
-Requires-Dist: pytest==8.2.2; extra == 'development'
+Requires-Dist: pytest==8.3.1; extra == 'development'
 Requires-Dist: syrupy==4.6.1; extra == 'development'
 Description-Content-Type: text/markdown