snowflake-cli-labs 3.0.0rc3__py3-none-any.whl → 3.0.0rc5__py3-none-any.whl

snowflake/cli/__about__.py

@@ -14,4 +14,4 @@
 
 from __future__ import annotations
 
-VERSION = "3.0.0rc3"
+VERSION = "3.0.0rc5"

snowflake/cli/_app/telemetry.py

@@ -37,6 +37,12 @@ from snowflake.connector.telemetry import (
 from snowflake.connector.time_util import get_time_millis
 
 
+@unique
+class CLIInstallationSource(Enum):
+    BINARY = "binary"
+    PYPI = "pypi"
+
+
 @unique
 class CLITelemetryField(Enum):
     # Basic information
@@ -44,6 +50,7 @@ class CLITelemetryField(Enum):
     VERSION_CLI = "version_cli"
     VERSION_PYTHON = "version_python"
     VERSION_OS = "version_os"
+    INSTALLATION_SOURCE = "installation_source"
     # Command execution context
     COMMAND = "command"
     COMMAND_GROUP = "command_group"
@@ -54,6 +61,8 @@ class CLITelemetryField(Enum):
     COMMAND_EXECUTION_TIME = "command_execution_time"
     # Configuration
     CONFIG_FEATURE_FLAGS = "config_feature_flags"
+    # Metrics
+    COUNTERS = "counters"
     # Information
     EVENT = "event"
     ERROR_MSG = "error_msg"
@@ -72,6 +81,16 @@ class TelemetryEvent(Enum):
 TelemetryDict = Dict[Union[CLITelemetryField, TelemetryField], Any]
 
 
+def _get_command_metrics() -> TelemetryDict:
+    cli_context = get_cli_context()
+
+    return {
+        CLITelemetryField.COUNTERS: {
+            **cli_context.metrics.counters,
+        }
+    }
+
+
 def _find_command_info() -> TelemetryDict:
     ctx = click.get_current_context()
     command_path = ctx.command_path.split(" ")[1:]
@@ -97,6 +116,12 @@ def _get_definition_version() -> str | None:
     return None
 
 
+def _get_installation_source() -> CLIInstallationSource:
+    if getattr(sys, "frozen", False) and hasattr(sys, "_MEIPASS"):
+        return CLIInstallationSource.BINARY
+    return CLIInstallationSource.PYPI
+
+
 def command_info() -> str:
     info = _find_command_info()
     command = ".".join(info[CLITelemetryField.COMMAND])
@@ -119,6 +144,7 @@ class CLITelemetryClient:
     ) -> Dict[str, Any]:
         data = {
             CLITelemetryField.SOURCE: PARAM_APPLICATION_NAME,
+            CLITelemetryField.INSTALLATION_SOURCE: _get_installation_source().value,
             CLITelemetryField.VERSION_CLI: VERSION,
             CLITelemetryField.VERSION_OS: platform.platform(),
             CLITelemetryField.VERSION_PYTHON: python_version(),
@@ -168,6 +194,7 @@ def log_command_result(execution: ExecutionMetadata):
             CLITelemetryField.COMMAND_EXECUTION_ID: execution.execution_id,
             CLITelemetryField.COMMAND_RESULT_STATUS: execution.status.value,
             CLITelemetryField.COMMAND_EXECUTION_TIME: execution.get_duration(),
+            **_get_command_metrics(),
         }
     )
 
@@ -183,6 +210,7 @@ def log_command_execution_error(exception: Exception, execution: ExecutionMetada
             CLITelemetryField.ERROR_TYPE: exception_type,
             CLITelemetryField.IS_CLI_EXCEPTION: is_cli_exception,
             CLITelemetryField.COMMAND_EXECUTION_TIME: execution.get_duration(),
+            **_get_command_metrics(),
         }
     )
 

snowflake/cli/_plugins/connection/commands.py

@@ -33,7 +33,7 @@ from snowflake.cli.api.commands.flags import (
 from snowflake.cli.api.commands.snow_typer import SnowTyperFactory
 from snowflake.cli.api.config import (
     ConnectionConfig,
-    add_connection,
+    add_connection_to_proper_file,
     connection_exists,
     get_all_connections,
     get_connection_dict,
@@ -49,7 +49,7 @@ from snowflake.cli.api.output.types import (
     ObjectResult,
 )
 from snowflake.connector import ProgrammingError
-from snowflake.connector.config_manager import CONFIG_MANAGER
+from snowflake.connector.constants import CONNECTIONS_FILE
 
 app = SnowTyperFactory(
     name="connection",
@@ -91,6 +91,11 @@ def list_connections(**options) -> CommandResult:
         }
         for connection_name, connection_config in connections.items()
     )
+
+    if CONNECTIONS_FILE.exists():
+        cli_console.warning(
+            f"Reading connections from {CONNECTIONS_FILE}. Entries from config.toml are ignored."
+        )
     return CollectionResult(result)
 
 
@@ -255,7 +260,7 @@ def add(
     if connection_exists(connection_name):
         raise ClickException(f"Connection {connection_name} already exists")
 
-    add_connection(
+    connections_file = add_connection_to_proper_file(
         connection_name,
         ConnectionConfig(
             account=account,
@@ -279,7 +284,7 @@ def add(
         )
 
     return MessageResult(
-        f"Wrote new connection {connection_name} to {CONFIG_MANAGER.file_path}"
+        f"Wrote new connection {connection_name} to {connections_file}"
     )
 
 

snowflake/cli/_plugins/helpers/commands.py

@@ -16,6 +16,7 @@ from __future__ import annotations
 
 import typer
 import yaml
+from click import ClickException
 from snowflake.cli.api.commands.snow_typer import SnowTyperFactory
 from snowflake.cli.api.output.types import MessageResult
 from snowflake.cli.api.project.definition_conversion import (
@@ -35,23 +36,55 @@ def v1_to_v2(
     accept_templates: bool = typer.Option(
         False, "-t", "--accept-templates", help="Allows the migration of templates."
     ),
+    migrate_local_yml: (bool | None) = typer.Option(
+        None,
+        "-l",
+        "--migrate-local-overrides/--no-migrate-local-overrides",
+        help=(
+            "Merge values in snowflake.local.yml into the main project definition. "
+            "The snowflake.local.yml file will not be migrated, "
+            "instead its values will be reflected in the output snowflake.yml file. "
+            "If unset and snowflake.local.yml is present, an error will be raised."
+        ),
+        show_default=False,
+    ),
     **options,
 ):
     """Migrates the Snowpark, Streamlit, and Native App project definition files from V1 to V2."""
     manager = DefinitionManager()
+    local_yml_path = manager.project_root / "snowflake.local.yml"
+    has_local_yml = local_yml_path in manager.project_config_paths
+    if has_local_yml:
+        if migrate_local_yml is None:
+            raise ClickException(
+                "snowflake.local.yml file detected, "
+                "please specify --migrate-local-overrides to include "
+                "or --no-migrate-local-overrides to exclude its values."
+            )
+        if not migrate_local_yml:
+            # If we don't want the local file,
+            # remove it from the list of paths to load
+            manager.project_config_paths.remove(local_yml_path)
+
     pd = manager.unrendered_project_definition
 
     if pd.meets_version_requirement("2"):
         return MessageResult("Project definition is already at version 2.")
 
-    pd_v2 = convert_project_definition_to_v2(manager.project_root, pd, accept_templates)
+    pd_v2 = convert_project_definition_to_v2(
+        manager.project_root, pd, accept_templates, manager.template_context
+    )
 
     SecurePath("snowflake.yml").rename("snowflake_V1.yml")
+    if has_local_yml:
+        SecurePath("snowflake.local.yml").rename("snowflake_V1.local.yml")
     with open("snowflake.yml", "w") as file:
         yaml.dump(
             pd_v2.model_dump(
                 exclude_unset=True, exclude_none=True, mode="json", by_alias=True
             ),
             file,
+            sort_keys=False,
+            width=float("inf"),  # Don't break lines
         )
     return MessageResult("Project definition migrated to version 2.")

snowflake/cli/_plugins/nativeapp/codegen/compiler.py

@@ -34,7 +34,9 @@ from snowflake.cli._plugins.nativeapp.codegen.templates.templates_processor impo
     TemplatesProcessor,
 )
 from snowflake.cli._plugins.nativeapp.feature_flags import FeatureFlag
+from snowflake.cli.api.cli_global_context import get_cli_context
 from snowflake.cli.api.console import cli_console as cc
+from snowflake.cli.api.metrics import CLICounterField
 from snowflake.cli.api.project.schemas.v1.native_app.path_mapping import (
     ProcessorMapping,
 )
@@ -72,6 +74,9 @@ class NativeAppCompiler:
         Go through every artifact object in the project definition of a native app, and execute processors in order of specification for each of the artifact object.
         May have side-effects on the filesystem by either directly editing source files or the deploy root.
         """
+        metrics = get_cli_context().metrics
+        metrics.set_counter_default(CLICounterField.TEMPLATES_PROCESSOR, 0)
+        metrics.set_counter_default(CLICounterField.SNOWPARK_PROCESSOR, 0)
 
         if not self._should_invoke_processors():
             return

snowflake/cli/_plugins/nativeapp/codegen/snowpark/python_processor.py

@@ -48,7 +48,9 @@ from snowflake.cli._plugins.nativeapp.codegen.snowpark.models import (
     NativeAppExtensionFunction,
 )
 from snowflake.cli._plugins.stage.diff import to_stage_path
+from snowflake.cli.api.cli_global_context import get_cli_context
 from snowflake.cli.api.console import cli_console as cc
+from snowflake.cli.api.metrics import CLICounterField
 from snowflake.cli.api.project.schemas.v1.native_app.path_mapping import (
     PathMapping,
     ProcessorMapping,
@@ -176,6 +178,8 @@ class SnowparkAnnotationProcessor(ArtifactProcessor):
         setup script with generated SQL that registers these functions.
         """
 
+        get_cli_context().metrics.set_counter(CLICounterField.SNOWPARK_PROCESSOR, 1)
+
         bundle_map = BundleMap(
             project_root=self._bundle_ctx.project_root,
             deploy_root=self._bundle_ctx.deploy_root,

snowflake/cli/_plugins/nativeapp/codegen/templates/templates_processor.py

@@ -25,6 +25,7 @@ from snowflake.cli._plugins.nativeapp.codegen.artifact_processor import (
 from snowflake.cli._plugins.nativeapp.exceptions import InvalidTemplateInFileError
 from snowflake.cli.api.cli_global_context import get_cli_context
 from snowflake.cli.api.console import cli_console as cc
+from snowflake.cli.api.metrics import CLICounterField
 from snowflake.cli.api.project.schemas.v1.native_app.path_mapping import (
     PathMapping,
     ProcessorMapping,
@@ -98,6 +99,8 @@ class TemplatesProcessor(ArtifactProcessor):
         Process the artifact by executing the template expansion logic on it.
         """
 
+        get_cli_context().metrics.set_counter(CLICounterField.TEMPLATES_PROCESSOR, 1)
+
         bundle_map = BundleMap(
             project_root=self._bundle_ctx.project_root,
             deploy_root=self._bundle_ctx.deploy_root,

snowflake/cli/_plugins/nativeapp/commands.py

@@ -22,20 +22,15 @@ from textwrap import dedent
 from typing import Generator, Iterable, List, Optional, cast
 
 import typer
-from snowflake.cli._plugins.nativeapp.application_entity_model import (
-    ApplicationEntityModel,
-)
-from snowflake.cli._plugins.nativeapp.application_package_entity_model import (
-    ApplicationPackageEntityModel,
-)
+from click.exceptions import ClickException
 from snowflake.cli._plugins.nativeapp.common_flags import (
     ForceOption,
     InteractiveOption,
     ValidateOption,
 )
-from snowflake.cli._plugins.nativeapp.init import (
-    OFFICIAL_TEMPLATES_GITHUB_URL,
-    nativeapp_init,
+from snowflake.cli._plugins.nativeapp.entities.application import ApplicationEntityModel
+from snowflake.cli._plugins.nativeapp.entities.application_package import (
+    ApplicationPackageEntityModel,
 )
 from snowflake.cli._plugins.nativeapp.manager import NativeAppManager
 from snowflake.cli._plugins.nativeapp.policy import (
@@ -47,10 +42,6 @@ from snowflake.cli._plugins.nativeapp.run_processor import NativeAppRunProcessor
 from snowflake.cli._plugins.nativeapp.teardown_processor import (
     NativeAppTeardownProcessor,
 )
-from snowflake.cli._plugins.nativeapp.utils import (
-    get_first_paragraph_from_markdown_file,
-    shallow_git_clone,
-)
 from snowflake.cli._plugins.nativeapp.v2_conversions.v2_to_v1_decorator import (
     find_entity,
     nativeapp_definition_v2_to_v1,
@@ -71,7 +62,6 @@ from snowflake.cli.api.entities.common import EntityActions
 from snowflake.cli.api.exceptions import IncompatibleParametersError
 from snowflake.cli.api.output.formats import OutputFormat
 from snowflake.cli.api.output.types import (
-    CollectionResult,
     CommandResult,
     MessageResult,
     ObjectResult,
@@ -79,7 +69,6 @@ from snowflake.cli.api.output.types import (
 )
 from snowflake.cli.api.project.project_verification import assert_project_type
 from snowflake.cli.api.project.schemas.project_definition import ProjectDefinitionV1
-from snowflake.cli.api.secure_path import SecurePath
 from typing_extensions import Annotated
 
 app = SnowTyperFactory(
@@ -91,81 +80,15 @@ app.add_typer(versions_app)
 log = logging.getLogger(__name__)
 
 
-@app.command("init")
-def app_init(
-    path: str = typer.Argument(
-        ...,
-        help=f"""Directory to be initialized with the Snowflake Native App project. This directory must not already exist.""",
-        show_default=False,
-    ),
-    name: str = typer.Option(
-        None,
-        help=f"""The name of the Snowflake Native App project to include in snowflake.yml. When not specified, it is
-        generated from the name of the directory. Names are assumed to be unquoted identifiers whenever possible, but
-        can be forced to be quoted by including the surrounding quote characters in the provided value.""",
-    ),
-    template_repo: str = typer.Option(
-        None,
-        help=f"""Specifies the git URL to a template repository, which can be a template itself or contain many templates inside it,
-        such as https://github.com/snowflakedb/native-apps-templates.git for all official Snowflake Native App with Snowflake CLI templates.
-        If using a private Github repo, you might be prompted to enter your Github username and password.
-        Please use your personal access token in the password prompt, and refer to
-        https://docs.github.com/en/get-started/getting-started-with-git/about-remote-repositories#cloning-with-https-urls for information on currently recommended modes of authentication.""",
-    ),
-    template: str = typer.Option(
-        None,
-        help="A specific template name within the template repo to use as template for the Snowflake Native App project. Example: Default is basic if `--template-repo` is https://github.com/snowflakedb/native-apps-templates.git, and None if any other --template-repo is specified.",
-    ),
-    **options,
-) -> CommandResult:
-    """
-    Initializes a Snowflake Native App project.
+@app.command("init", hidden=True)
+def app_init(**options):
     """
-    project = nativeapp_init(
-        path=path, name=name, git_url=template_repo, template=template
-    )
-    return MessageResult(
-        f"Snowflake Native App project {project.name} has been created at: {path}"
-    )
-
+    *** Deprecated. Use snow init instead ***
 
-@app.command("list-templates", hidden=True)
-def app_list_templates(**options) -> CommandResult:
-    """
-    Prints information regarding the official templates that can be used with snow app init.
+    Initializes a Snowflake Native App project.
     """
-    with SecurePath.temporary_directory() as temp_path:
-        from git import rmtree as git_rmtree
-
-        repo = shallow_git_clone(OFFICIAL_TEMPLATES_GITHUB_URL, temp_path.path)
-
-        # Mark a directory as a template if a project definition jinja template is inside
-        template_directories = [
-            entry.name
-            for entry in repo.head.commit.tree
-            if (temp_path / entry.name / "snowflake.yml.jinja").exists()
-        ]
-
-        # get the template descriptions from the README.md in its directory
-        template_descriptions = [
-            get_first_paragraph_from_markdown_file(
-                (temp_path / directory / "README.md").path
-            )
-            for directory in template_directories
-        ]
-
-        result = (
-            {"template": directory, "description": description}
-            for directory, description in zip(
-                template_directories, template_descriptions
-            )
-        )
-
-        # proactively clean up here to avoid permission issues on Windows
-        repo.close()
-        git_rmtree(temp_path.path)
 
-        return CollectionResult(result)
+    raise ClickException("This command has been removed. Use `snow init` instead.")
 
 
 @app.command("bundle")