snowflake-cli 3.4.1__py3-none-any.whl → 3.5.0__py3-none-any.whl

snowflake/cli/_plugins/streamlit/commands.py

@@ -16,11 +16,10 @@ from __future__ import annotations
 
 import logging
 from pathlib import Path
-from typing import Dict
 
 import click
 import typer
-from click import ClickException, UsageError
+from click import ClickException
 from snowflake.cli._plugins.object.command_aliases import (
     add_object_command_aliases,
     scope_option,
@@ -44,6 +43,7 @@ from snowflake.cli.api.commands.flags import (
     like_option,
 )
 from snowflake.cli.api.commands.snow_typer import SnowTyperFactory
+from snowflake.cli.api.commands.utils import get_entity_for_operation
 from snowflake.cli.api.constants import ObjectType
 from snowflake.cli.api.exceptions import NoProjectDefinitionError
 from snowflake.cli.api.identifiers import FQN
@@ -133,7 +133,8 @@ def _default_file_callback(param_name: str):
 @with_experimental_behaviour()
 def streamlit_deploy(
     replace: bool = ReplaceOption(
-        help="Replace the Streamlit app if it already exists."
+        help="Replaces the Streamlit app if it already exists. It only uploads new and overwrites existing files, "
+        "but does not remove any files already on the stage."
     ),
     entity_id: str = entity_argument("streamlit"),
     open_: bool = OpenOption,
@@ -155,30 +156,14 @@ def streamlit_deploy(
             )
         pd = convert_project_definition_to_v2(cli_context.project_root, pd)
 
-    streamlits: Dict[str, StreamlitEntityModel] = pd.get_entities_by_type(
-        entity_type="streamlit"
+    streamlit: StreamlitEntityModel = get_entity_for_operation(
+        cli_context=cli_context,
+        entity_id=entity_id,
+        project_definition=pd,
+        entity_type="streamlit",
     )
 
     streamlit_project_paths = StreamlitProjectPaths(cli_context.project_root)
-
-    if not streamlits:
-        raise NoProjectDefinitionError(
-            project_type="streamlit", project_root=cli_context.project_root
-        )
-
-    if entity_id and entity_id not in streamlits:
-        raise UsageError(f"No '{entity_id}' entity in project definition file.")
-
-    if len(streamlits.keys()) == 1:
-        entity_id = list(streamlits.keys())[0]
-
-    if entity_id is None:
-        raise UsageError(
-            "Multiple Streamlit apps found. Please provide entity id for the operation."
-        )
-
-    # Get first streamlit
-    streamlit: StreamlitEntityModel = streamlits[entity_id]
     url = StreamlitManager().deploy(
         streamlit=streamlit,
         streamlit_project_paths=streamlit_project_paths,

snowflake/cli/_plugins/streamlit/manager.py

@@ -15,7 +15,6 @@
 from __future__ import annotations
 
 import logging
-from pathlib import PurePosixPath
 from typing import List, Optional
 
 from click import ClickException
@@ -32,8 +31,7 @@ from snowflake.cli._plugins.streamlit.streamlit_entity_model import (
 from snowflake.cli._plugins.streamlit.streamlit_project_paths import (
     StreamlitProjectPaths,
 )
-from snowflake.cli.api.artifacts.bundle_map import BundleMap
-from snowflake.cli.api.artifacts.utils import symlink_or_copy
+from snowflake.cli.api.artifacts.upload import put_files
 from snowflake.cli.api.commands.experimental_behaviour import (
     experimental_behaviour_enabled,
 )
@@ -65,40 +63,11 @@ class StreamlitManager(SqlExecutionMixin):
         artifacts: Optional[List[PathMapping]] = None,
     ):
         cli_console.step(f"Deploying files to {stage_root}")
-        if not artifacts:
-            return
-        stage_manager = StageManager()
-        # We treat the bundle root as deploy root
-        bundle_map = BundleMap(
-            project_root=streamlit_project_paths.project_root,
-            deploy_root=streamlit_project_paths.bundle_root,
+        put_files(
+            project_paths=streamlit_project_paths,
+            stage_root=stage_root,
+            artifacts=artifacts,
         )
-        for artifact in artifacts:
-            bundle_map.add(PathMapping(src=str(artifact.src), dest=artifact.dest))
-
-        # Clean up bundle root
-        streamlit_project_paths.remove_up_bundle_root()
-
-        for (absolute_src, absolute_dest) in bundle_map.all_mappings(
-            absolute=True, expand_directories=True
-        ):
-            if absolute_src.is_file():
-                # We treat the bundle/streamlit root as deploy root
-                symlink_or_copy(
-                    absolute_src,
-                    absolute_dest,
-                    deploy_root=streamlit_project_paths.bundle_root,
-                )
-                # Temporary solution, will be replaced with diff
-                stage_path = (
-                    PurePosixPath(absolute_dest)
-                    .relative_to(streamlit_project_paths.bundle_root)
-                    .parent
-                )
-                full_stage_path = f"{stage_root}/{stage_path}".rstrip("/")
-                stage_manager.put(
-                    local_path=absolute_dest, stage_path=full_stage_path, overwrite=True
-                )
 
     def _create_streamlit(
         self,

snowflake/cli/api/artifacts/upload.py

@@ -0,0 +1,51 @@
+from pathlib import PurePosixPath
+from typing import List, Optional
+
+from snowflake.cli._plugins.stage.manager import StageManager
+from snowflake.cli.api.artifacts.bundle_map import BundleMap
+from snowflake.cli.api.artifacts.utils import symlink_or_copy
+from snowflake.cli.api.console import cli_console
+from snowflake.cli.api.project.project_paths import ProjectPaths
+from snowflake.cli.api.project.schemas.entities.common import PathMapping
+
+
+def put_files(
+    project_paths: ProjectPaths,
+    stage_root: str,
+    artifacts: Optional[List[PathMapping]] = None,
+):
+    if not artifacts:
+        return
+    stage_manager = StageManager()
+    # We treat the bundle root as deploy root
+    bundle_map = BundleMap(
+        project_root=project_paths.project_root,
+        deploy_root=project_paths.bundle_root,
+    )
+    for artifact in artifacts:
+        bundle_map.add(PathMapping(src=str(artifact.src), dest=artifact.dest))
+
+    # Clean up bundle root
+    project_paths.remove_up_bundle_root()
+
+    for (absolute_src, absolute_dest) in bundle_map.all_mappings(
+        absolute=True, expand_directories=True
+    ):
+        if absolute_src.is_file():
+            # We treat the bundle/streamlit root as deploy root
+            symlink_or_copy(
+                absolute_src,
+                absolute_dest,
+                deploy_root=project_paths.bundle_root,
+            )
+            # Temporary solution, will be replaced with diff
+            stage_path = (
+                PurePosixPath(absolute_dest)
+                .relative_to(project_paths.bundle_root)
+                .parent
+            )
+            full_stage_path = f"{stage_root}/{stage_path}".rstrip("/")
+            cli_console.step(f"Uploading {absolute_dest} to {full_stage_path}")
+            stage_manager.put(
+                local_path=absolute_dest, stage_path=full_stage_path, overwrite=True
+            )

snowflake/cli/api/commands/flags.py

@@ -14,7 +14,6 @@
 
 from __future__ import annotations
 
-import tempfile
 from pathlib import Path
 from typing import Any, Callable, Optional
 
@@ -277,7 +276,7 @@ MfaPasscodeOption = typer.Option(
 EnableDiagOption = typer.Option(
     False,
     "--enable-diag",
-    help="Run Python connector diagnostic test",
+    help="Whether to generate a connection diagnostic report.",
     callback=_connection_callback("enable_diag"),
     show_default=False,
     is_flag=True,
@@ -286,20 +285,29 @@ EnableDiagOption = typer.Option(
 
 # Set default via callback to avoid including tempdir path in generated docs (snow --docs).
 # Use constant instead of None, as None is removed from telemetry data.
-_DIAG_LOG_DEFAULT_VALUE = "<temporary_directory>"
+_DIAG_LOG_DEFAULT_VALUE = "<system_temporary_directory>"
 
 
 def _diag_log_path_callback(path: str):
     if path == _DIAG_LOG_DEFAULT_VALUE:
+        import tempfile
+
         path = tempfile.gettempdir()
-    get_cli_context_manager().connection_context.diag_log_path = Path(path)
-    return path
+
+    absolute_path = Path(path).absolute()
+    if not absolute_path.exists():
+        # if the path does not exist the report is not generated
+        from snowflake.cli.api.secure_path import SecurePath
+
+        SecurePath(absolute_path).mkdir(parents=True)
+
+    return _connection_callback("diag_log_path")(absolute_path)
 
 
 DiagLogPathOption: Path = typer.Option(
     _DIAG_LOG_DEFAULT_VALUE,
     "--diag-log-path",
-    help="Diagnostic report path",
+    help="Path for the generated report. Defaults to system temporary directory.",
     callback=_diag_log_path_callback,
     show_default=False,
     rich_help_panel=_CONNECTION_SECTION,
@@ -307,11 +315,17 @@ DiagLogPathOption: Path = typer.Option(
     writable=True,
 )
 
+
+def _diag_log_allowlist_path_callback(path: str):
+    absolute_path = Path(path).absolute() if path else None
+    return _connection_callback("diag_allowlist_path")(absolute_path)
+
+
 DiagAllowlistPathOption: Path = typer.Option(
     None,
     "--diag-allowlist-path",
-    help="Diagnostic report path to optional allowlist",
-    callback=_connection_callback("diag_allowlist_path"),
+    help="Path to a JSON file containing allowlist parameters.",
+    callback=_diag_log_allowlist_path_callback,
     show_default=False,
     rich_help_panel=_CONNECTION_SECTION,
     exists=True,
@@ -492,9 +506,10 @@ def identifier_argument(
     example: str,
     click_type: click.ParamType = IdentifierType(),
     callback: Callable | None = None,
+    is_optional: bool = False,
 ) -> typer.Argument:
     return typer.Argument(
-        ...,
+        None if is_optional else ...,
         help=f"Identifier of the {sf_object}; for example: {example}",
         show_default=False,
         click_type=click_type,

snowflake/cli/api/commands/snow_typer.py

@@ -19,6 +19,7 @@ import logging
 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.output.types import CommandResult
 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 @@ class SnowTyper(typer.Typer):
             no_args_is_help=True,
             add_completion=True,
             rich_markup_mode="markdown",
+            cls=SortedTyperGroup,
         )
 
     @staticmethod

snowflake/cli/api/commands/utils.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from typing import Dict, List, Optional
 
 from click import ClickException, UsageError

snowflake/cli/api/config.py

@@ -20,7 +20,7 @@ import warnings
 from contextlib import contextmanager
 from dataclasses import asdict, dataclass, field
 from pathlib import Path
-from typing import Any, Dict, Optional, Union
+from typing import Any, Dict, List, Optional, Union
 
 import tomlkit
 from click import ClickException
@@ -58,6 +58,7 @@ PLUGINS_SECTION = "plugins"
 
 LOGS_SECTION_PATH = [CLI_SECTION, LOGS_SECTION]
 PLUGINS_SECTION_PATH = [CLI_SECTION, PLUGINS_SECTION]
+PLUGIN_ENABLED_KEY = "enabled"
 FEATURE_FLAGS_SECTION_PATH = [CLI_SECTION, "features"]
 
 CONFIG_MANAGER.add_option(
@@ -140,8 +141,7 @@ def add_connection_to_proper_file(name: str, connection_config: ConnectionConfig
         return CONNECTIONS_FILE
     else:
         set_config_value(
-            section=CONNECTIONS_SECTION,
-            key=name,
+            path=[CONNECTIONS_SECTION, name],
             value=connection_config.to_dict_of_all_non_empty_values(),
         )
         return CONFIG_MANAGER.file_path
@@ -200,14 +200,19 @@ def _initialise_logs_section():
             conf_file_cache[CLI_SECTION][LOGS_SECTION] = _DEFAULT_LOGS_CONFIG
 
 
-def set_config_value(section: str | None, key: str, value: Any):
+def set_config_value(path: List[str], value: Any) -> None:
+    """Sets value in config.
+    For example to set value "val" to key "key" in section [a.b.c], call
+    set_config_value(["a", "b", "c", "key"], "val").
+    If you want to override a whole section, value should be a dictionary.
+    """
     with _config_file() as conf_file_cache:
-        if section:
-            if conf_file_cache.get(section) is None:
-                conf_file_cache[section] = {}
-            conf_file_cache[section][key] = value
-        else:
-            conf_file_cache[key] = value
+        current_config_dict = conf_file_cache
+        for key in path[:-1]:
+            if key not in current_config_dict:
+                current_config_dict[key] = {}
+            current_config_dict = current_config_dict[key]
+        current_config_dict[path[-1]] = value
 
 
 def get_logs_config() -> dict:

snowflake/cli/api/exceptions.py

@@ -15,7 +15,7 @@
 from __future__ import annotations
 
 from pathlib import Path
-from typing import Optional
+from typing import List, Optional
 
 from click.exceptions import ClickException, UsageError
 from snowflake.cli.api.constants import ObjectType
@@ -54,6 +54,13 @@ class InvalidPluginConfiguration(ClickException):
         return f"Invalid plugin configuration. {self.message}"
 
 
+class PluginNotInstalledError(ClickException):
+    def __init__(self, plugin_name, installed_plugins: List[str]):
+        super().__init__(
+            f"Plugin {plugin_name} is not installed. Available plugins: {', '.join(installed_plugins)}."
+        )
+
+
 class SnowflakeConnectionError(ClickException):
     def __init__(self, snowflake_err: Exception):
         super().__init__(f"Could not connect to Snowflake. Reason: {snowflake_err}")

snowflake/cli/api/feature_flags.py

@@ -67,3 +67,4 @@ class FeatureFlag(FeatureFlagMixin):
         "ENABLE_SEPARATE_AUTHENTICATION_POLICY_ID", False
     )
     ENABLE_SNOWPARK_GLOB_SUPPORT = BooleanFlag("ENABLE_SNOWPARK_GLOB_SUPPORT", False)
+    ENABLE_SPCS_SERVICE_EVENTS = BooleanFlag("ENABLE_SPCS_SERVICE_EVENTS", False)

snowflake/cli/api/plugins/plugin_config.py

@@ -17,6 +17,16 @@ from __future__ import annotations
 from dataclasses import dataclass
 from typing import Any, Dict, List
 
+from snowflake.cli.api.config import (
+    PLUGIN_ENABLED_KEY,
+    PLUGINS_SECTION_PATH,
+    config_section_exists,
+    get_config_section,
+    get_config_value,
+    get_plugins_config,
+)
+from snowflake.cli.api.exceptions import InvalidPluginConfiguration
+
 
 @dataclass
 class PluginConfig:
@@ -25,8 +35,37 @@ class PluginConfig:
 
 
 class PluginConfigProvider:
-    def get_enabled_plugin_names(self) -> List[str]:
-        raise NotImplementedError()
+    @staticmethod
+    def get_enabled_plugin_names() -> List[str]:
+        enabled_plugins = []
+        for plugin_name, plugin_config_section in get_plugins_config().items():
+            enabled = plugin_config_section.get(PLUGIN_ENABLED_KEY, False)
+            _assert_value_is_bool(
+                enabled, value_name=PLUGIN_ENABLED_KEY, plugin_name=plugin_name
+            )
+            if enabled:
+                enabled_plugins.append(plugin_name)
+        return enabled_plugins
+
+    @staticmethod
+    def get_config(plugin_name: str) -> PluginConfig:
+        config_path = PLUGINS_SECTION_PATH + [plugin_name]
+        plugin_config = PluginConfig(is_plugin_enabled=False, internal_config={})
+        plugin_config.is_plugin_enabled = get_config_value(
+            *config_path, key=PLUGIN_ENABLED_KEY, default=False
+        )
+        _assert_value_is_bool(
+            plugin_config.is_plugin_enabled,
+            value_name=PLUGIN_ENABLED_KEY,
+            plugin_name=plugin_name,
+        )
+        if config_section_exists(*config_path, "config"):
+            plugin_config.internal_config = get_config_section(*config_path, "config")
+        return plugin_config
+
 
-    def get_config(self, plugin_name: str) -> PluginConfig:
-        raise NotImplementedError()
+def _assert_value_is_bool(value, *, value_name: str, plugin_name: str) -> None:
+    if type(value) is not bool:
+        raise InvalidPluginConfiguration(
+            f'[{plugin_name}]: "{value_name}" must be a boolean'
+        )

snowflake/cli/api/project/definition_helper.py

@@ -0,0 +1,31 @@
+from typing import Optional
+
+from click import UsageError
+from snowflake.cli.api.cli_global_context import get_cli_context
+from snowflake.cli.api.constants import ObjectType
+from snowflake.cli.api.exceptions import NoProjectDefinitionError
+
+
+def get_entity_from_project_definition(
+    entity_type: ObjectType, entity_id: Optional[str] = None
+):
+    cli_context = get_cli_context()
+    pd = cli_context.project_definition
+    entities = pd.get_entities_by_type(entity_type=entity_type.value.cli_name)
+
+    if not entities:
+        raise NoProjectDefinitionError(
+            project_type=entity_type.value.sf_name,
+            project_root=cli_context.project_root,
+        )
+
+    if entity_id and entity_id not in entities:
+        raise UsageError(f"No '{entity_id}' entity in project definition file.")
+    elif len(entities.keys()) == 1:
+        entity_id = list(entities.keys())[0]
+
+    if entity_id is None:
+        raise UsageError(
+            f"Multiple {entity_type.value.sf_plural_name} found. Please provide entity id for the operation."
+        )
+    return entities[entity_id]

snowflake/cli/api/project/schemas/entities/entities.py

@@ -26,6 +26,10 @@ from snowflake.cli._plugins.nativeapp.entities.application_package import (
 )
 from snowflake.cli._plugins.notebook.notebook_entity import NotebookEntity
 from snowflake.cli._plugins.notebook.notebook_entity_model import NotebookEntityModel
+from snowflake.cli._plugins.project.project_entity_model import (
+    ProjectEntity,
+    ProjectEntityModel,
+)
 from snowflake.cli._plugins.snowpark.snowpark_entity import (
     FunctionEntity,
     ProcedureEntity,
@@ -34,6 +38,20 @@ from snowflake.cli._plugins.snowpark.snowpark_entity_model import (
     FunctionEntityModel,
     ProcedureEntityModel,
 )
+from snowflake.cli._plugins.spcs.compute_pool.compute_pool_entity import (
+    ComputePoolEntity,
+)
+from snowflake.cli._plugins.spcs.compute_pool.compute_pool_entity_model import (
+    ComputePoolEntityModel,
+)
+from snowflake.cli._plugins.spcs.image_repository.image_repository_entity import (
+    ImageRepositoryEntity,
+)
+from snowflake.cli._plugins.spcs.image_repository.image_repository_entity_model import (
+    ImageRepositoryEntityModel,
+)
+from snowflake.cli._plugins.spcs.services.service_entity import ServiceEntity
+from snowflake.cli._plugins.spcs.services.service_entity_model import ServiceEntityModel
 from snowflake.cli._plugins.streamlit.streamlit_entity import StreamlitEntity
 from snowflake.cli._plugins.streamlit.streamlit_entity_model import (
     StreamlitEntityModel,
@@ -44,7 +62,11 @@ Entity = Union[
     ApplicationPackageEntity,
     StreamlitEntity,
     ProcedureEntity,
+    ProjectEntity,
     FunctionEntity,
+    ComputePoolEntity,
+    ImageRepositoryEntity,
+    ServiceEntity,
     NotebookEntity,
 ]
 EntityModel = Union[
@@ -53,7 +75,11 @@ EntityModel = Union[
     StreamlitEntityModel,
     FunctionEntityModel,
     ProcedureEntityModel,
+    ComputePoolEntityModel,
+    ImageRepositoryEntityModel,
+    ServiceEntityModel,
     NotebookEntityModel,
+    ProjectEntityModel,
 ]
 
 ALL_ENTITIES: List[Entity] = [*get_args(Entity)]

{snowflake_cli-3.4.1.dist-info → snowflake_cli-3.5.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: snowflake-cli
-Version: 3.4.1
+Version: 3.5.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
@@ -218,30 +218,30 @@ Classifier: Programming Language :: SQL
 Classifier: Topic :: Database
 Requires-Python: >=3.10
 Requires-Dist: gitpython==3.1.44
-Requires-Dist: jinja2==3.1.5
+Requires-Dist: jinja2==3.1.6
 Requires-Dist: packaging
 Requires-Dist: pip
 Requires-Dist: pluggy==1.5.0
-Requires-Dist: pydantic==2.10.4
+Requires-Dist: pydantic==2.10.6
 Requires-Dist: pyyaml==6.0.2
 Requires-Dist: requests==2.32.3
 Requires-Dist: requirements-parser==0.11.0
 Requires-Dist: rich==13.9.4
 Requires-Dist: setuptools==75.8.0
-Requires-Dist: snowflake-connector-python[secure-local-storage]==3.13.2
+Requires-Dist: snowflake-connector-python[secure-local-storage]==3.14.0
 Requires-Dist: snowflake-core==1.0.2; python_version < '3.12'
 Requires-Dist: snowflake-snowpark-python<1.26.0,>=1.15.0; python_version < '3.12'
 Requires-Dist: tomlkit==0.13.2
-Requires-Dist: typer==0.12.5
+Requires-Dist: typer==0.15.1
 Requires-Dist: urllib3<2.4,>=1.24.3
 Provides-Extra: development
-Requires-Dist: coverage==7.6.10; extra == 'development'
-Requires-Dist: factory-boy==3.3.1; extra == 'development'
-Requires-Dist: faker==35.2.0; extra == 'development'
+Requires-Dist: coverage==7.6.12; extra == 'development'
+Requires-Dist: factory-boy==3.3.3; extra == 'development'
+Requires-Dist: faker==36.1.1; extra == 'development'
 Requires-Dist: pre-commit>=3.5.0; extra == 'development'
 Requires-Dist: pytest-randomly==3.16.0; extra == 'development'
 Requires-Dist: pytest==8.3.4; extra == 'development'
-Requires-Dist: syrupy==4.8.1; extra == 'development'
+Requires-Dist: syrupy==4.8.2; extra == 'development'
 Provides-Extra: packaging
 Requires-Dist: pyinstaller~=6.10; extra == 'packaging'
 Description-Content-Type: text/markdown