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

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
 
@@ -33,6 +32,7 @@ from snowflake.cli.api.connections import ConnectionContext
 from snowflake.cli.api.console import cli_console
 from snowflake.cli.api.identifiers import FQN
 from snowflake.cli.api.output.formats import OutputFormat
+from snowflake.cli.api.secret import SecretType
 from snowflake.cli.api.stage_path import StagePath
 
 DEFAULT_CONTEXT_SETTINGS = {"help_option_names": ["--help", "-h"]}
@@ -215,7 +215,7 @@ MasterTokenOption = typer.Option(
 TokenFilePathOption = typer.Option(
     None,
     "--token-file-path",
-    help="Path to file with an OAuth token that should be used when connecting to Snowflake",
+    help="Path to file with an OAuth token to use when connecting to Snowflake.",
     callback=_connection_callback("token_file_path"),
     show_default=False,
     rich_help_panel=_CONNECTION_SECTION,
@@ -277,7 +277,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 +286,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 +316,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 that contains allowlist parameters.",
+    callback=_diag_log_allowlist_path_callback,
     show_default=False,
     rich_help_panel=_CONNECTION_SECTION,
     exists=True,
@@ -487,14 +502,24 @@ class IdentifierStagePathType(click.ParamType):
         return StagePath.from_stage_str(value)
 
 
+class SecretTypeParser(click.ParamType):
+    name = "TEXT"
+
+    def convert(self, value, param, ctx):
+        if not isinstance(value, SecretType):
+            return SecretType(value)
+        return value
+
+
 def identifier_argument(
     sf_object: str,
     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/constants.py

@@ -47,6 +47,7 @@ class ObjectType(Enum):
     NETWORK_RULE = ObjectNames("network-rule", "network rule", "network rules")
     NOTEBOOK = ObjectNames("notebook", "notebook", "notebooks")
     PROCEDURE = ObjectNames("procedure", "procedure", "procedures")
+    PROJECT = ObjectNames("project", "project", "projects")
     ROLE = ObjectNames("role", "role", "roles")
     SCHEMA = ObjectNames("schema", "schema", "schemas")
     SERVICE = ObjectNames("service", "service", "services")
@@ -77,6 +78,7 @@ OBJECT_TO_NAMES = {o.value.cli_name: o.value for o in ObjectType}
 UNSUPPORTED_OBJECTS = {
     ObjectType.APPLICATION.value.cli_name,
     ObjectType.APPLICATION_PACKAGE.value.cli_name,
+    ObjectType.PROJECT.value.cli_name,
 }
 SUPPORTED_OBJECTS = sorted(OBJECT_TO_NAMES.keys() - UNSUPPORTED_OBJECTS)
 

snowflake/cli/api/errno.py

@@ -78,6 +78,7 @@ MAX_VERSIONS_IN_RELEASE_CHANNEL_REACHED = 512004
 MAX_UNBOUND_VERSIONS_REACHED = 512023
 CANNOT_DEREGISTER_VERSION_ASSOCIATED_WITH_CHANNEL = 512021
 TARGET_ACCOUNT_USED_BY_OTHER_RELEASE_DIRECTIVE = 93091
+CANNOT_SET_DEBUG_MODE_WITH_MANIFEST_VERSION = 93362
 
 
 ERR_JAVASCRIPT_EXECUTION = 100132

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}")
@@ -229,3 +236,10 @@ class ShowSpecificObjectMultipleRowsError(RuntimeError):
         super().__init__(
             f"Received multiple rows from result of SQL statement: {show_obj_query}. Usage of 'show_specific_object' may not be properly scoped."
         )
+
+
+class CouldNotSetKeyPairError(ClickException):
+    def __init__(self):
+        super().__init__(
+            "The public key is set already. Use the rotate command instead."
+        )

snowflake/cli/api/feature_flags.py

@@ -67,3 +67,5 @@ 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)
+    ENABLE_AUTH_KEYPAIR = BooleanFlag("ENABLE_AUTH_KEYPAIR", 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/api/rest_api.py

@@ -155,9 +155,8 @@ class RestApi:
             raise SchemaNotDefinedException(
                 "Schema not defined in connection. Please try again with `--schema` flag."
             )
-        # temporarily disable this check due to an issue on server side: SNOW-1747450
-        # if not self._schema_exists(db_name=db, schema_name=schema):
-        #     raise SchemaNotExistsException(f"Schema '{schema}' does not exist.")
+        if not self._schema_exists(db_name=db, schema_name=schema):
+            raise SchemaNotExistsException(f"Schema '{schema}' does not exist.")
         if self.get_endpoint_exists(
             url := f"{SF_REST_API_URL_PREFIX}/databases/{self.conn.database}/schemas/{self.conn.schema}/{plural_object_type}/"
         ):

snowflake/cli/{_app → api}/secret.py

@@ -5,5 +5,8 @@ class SecretType:
     def __repr__(self):
         return "SecretType(***)"
 
-    def __str___(self):
+    def __str__(self):
         return "***"
+
+    def __bool__(self):
+        return self.value is not None and self.value != ""

snowflake/cli/api/secure_path.py

@@ -21,7 +21,7 @@ import shutil
 import tempfile
 from contextlib import contextmanager
 from pathlib import Path
-from typing import Optional, Union
+from typing import IO, Any, Generator, Optional, Union
 
 from snowflake.cli.api.exceptions import DirectoryIsNotEmptyError, FileTooLargeError
 from snowflake.cli.api.secure_utils import (
@@ -38,7 +38,7 @@ UNLIMITED = -1
 
 class SecurePath:
     def __init__(self, path: Union[Path, str]):
-        self._path = Path(path)
+        self._path = Path(os.path.expanduser(path))
 
     def __repr__(self):
         return f'SecurePath("{self._path}")'
@@ -72,6 +72,12 @@ class SecurePath:
         """
         return SecurePath(self._path.absolute())
 
+    def resolve(self):
+        """
+        Make the path absolute, resolving symlinks
+        """
+        return SecurePath(self._path.resolve())
+
     def iterdir(self):
         """
         When the path points to a directory, yield path objects of the directory contents.
@@ -102,7 +108,7 @@ class SecurePath:
         Return True if the path points to a regular file (or a symbolic link pointing to a regular file),
         False if it points to another kind of file.
         """
-        return self._path.is_file()
+        return self._path.expanduser().absolute().is_file()
 
     def glob(self, pattern: str):
         """
@@ -110,6 +116,12 @@ class SecurePath:
         """
         return self._path.glob(pattern)
 
+    def as_posix(self) -> str:
+        """
+        Return the string representation of the path with forward slashes (/) as the path separator.
+        """
+        return self._path.as_posix()
+
     @property
     def name(self) -> str:
         """A string representing the final path component."""
@@ -172,7 +184,7 @@ class SecurePath:
         mode="r",
         read_file_limit_mb: Optional[int] = None,
         **open_kwargs,
-    ):
+    ) -> Generator[IO[Any], None, None]:
         """
         Open the file pointed by this path and return a file object, as
         the built-in open() function does.

snowflake/cli/api/sql_execution.py

@@ -85,9 +85,13 @@ class BaseSqlExecutor:
         )
         return stream_generator if return_cursors else list()
 
+    def execute_string(self, query: str, **kwargs) -> Iterable[SnowflakeCursor]:
+        """Executes a single SQL query and returns the results"""
+        return self._execute_string(query, **kwargs)
+
     def execute_query(self, query: str, **kwargs):
-        """Executes a single SQL query and returns the result"""
-        *_, last_result = list(self._execute_string(dedent(query), **kwargs))
+        """Executes a single SQL query and returns the last result"""
+        *_, last_result = list(self.execute_string(dedent(query), **kwargs))
         return last_result
 
     def execute_queries(self, queries: str, **kwargs):
@@ -95,7 +99,7 @@ class BaseSqlExecutor:
 
         # Without remove_comments=True, connectors might throw an error if there is a comment at the end of the file
         return list(
-            self._execute_string(dedent(queries), remove_comments=True, **kwargs)
+            self.execute_string(dedent(queries), remove_comments=True, **kwargs)
         )
 
 

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: snowflake-cli
-Version: 3.4.1
+Version: 3.6.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,32 +218,32 @@ 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: setuptools==76.0.0
+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.2
 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==37.0.0; extra == 'development'
 Requires-Dist: pre-commit>=3.5.0; extra == 'development'
+Requires-Dist: pytest-httpserver==1.1.2; 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: pytest==8.3.5; extra == 'development'
+Requires-Dist: syrupy==4.9.0; extra == 'development'
 Provides-Extra: packaging
-Requires-Dist: pyinstaller~=6.10; extra == 'packaging'
 Description-Content-Type: text/markdown
 
 <!--