snowflake-cli 2.8.2__py3-none-any.whl → 3.0.2__py3-none-any.whl

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

@@ -19,17 +19,17 @@ import logging
 from typing import Callable, Optional
 
 from click import ClickException
-from snowflake.cli.api.constants import DEFAULT_SIZE_LIMIT_MB
-from snowflake.cli.api.exceptions import SnowflakeSQLExecutionError
-from snowflake.cli.api.secure_path import SecurePath
-from snowflake.cli.api.sql_execution import SqlExecutionMixin
-from snowflake.cli.plugins.cortex.types import (
+from snowflake.cli._plugins.cortex.types import (
     Language,
     Model,
     Question,
     SourceDocument,
     Text,
 )
+from snowflake.cli.api.constants import DEFAULT_SIZE_LIMIT_MB
+from snowflake.cli.api.exceptions import SnowflakeSQLExecutionError
+from snowflake.cli.api.secure_path import SecurePath
+from snowflake.cli.api.sql_execution import SqlExecutionMixin
 from snowflake.connector import ProgrammingError
 from snowflake.connector.cursor import DictCursor
 

snowflake/cli/{plugins → _plugins}/cortex/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.cortex import commands
 from snowflake.cli.api.plugins.command import (
     SNOWCLI_ROOT_COMMAND_PATH,
     CommandSpec,
     CommandType,
     plugin_hook_impl,
 )
-from snowflake.cli.plugins.cortex import commands
 
 
 @plugin_hook_impl

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

@@ -22,6 +22,13 @@ from typing import Dict, List, Optional
 
 import typer
 from click import ClickException
+from snowflake.cli._plugins.git.manager import GitManager
+from snowflake.cli._plugins.object.command_aliases import (
+    add_object_command_aliases,
+    scope_option,
+)
+from snowflake.cli._plugins.object.manager import ObjectManager
+from snowflake.cli.api.commands.common import OnErrorType
 from snowflake.cli.api.commands.flags import (
     ExecuteVariablesOption,
     OnErrorOption,
@@ -34,13 +41,6 @@ from snowflake.cli.api.console.console import cli_console
 from snowflake.cli.api.constants import ObjectType
 from snowflake.cli.api.output.types import CollectionResult, CommandResult, QueryResult
 from snowflake.cli.api.utils.path_utils import is_stage_path
-from snowflake.cli.plugins.git.manager import GitManager
-from snowflake.cli.plugins.object.command_aliases import (
-    add_object_command_aliases,
-    scope_option,
-)
-from snowflake.cli.plugins.object.manager import ObjectManager
-from snowflake.cli.plugins.stage.manager import OnErrorType
 from snowflake.connector import DictCursor
 
 app = SnowTyperFactory(
@@ -72,6 +72,7 @@ RepoPathArgument = typer.Argument(
         " For example: @my_repo/branches/main/"
     ),
     callback=_repo_path_argument_callback,
+    show_default=False,
 )
 add_object_command_aliases(
     app=app,
@@ -124,6 +125,8 @@ def setup(
     """
     Sets up a git repository object.
 
+    ## Usage notes
+
     You will be prompted for:
 
     * url - address of repository to be used for git clone operation
@@ -294,6 +297,7 @@ def copy(
     repository_path: str = RepoPathArgument,
     destination_path: str = typer.Argument(
         help="Target path for copy operation. Should be a path to a directory on remote stage or local file system.",
+        show_default=False,
     ),
     parallel: int = typer.Option(
         4,

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

@@ -14,29 +14,36 @@
 
 from __future__ import annotations
 
-from pathlib import Path
+from pathlib import Path, PurePosixPath
 from textwrap import dedent
 from typing import List
 
-from snowflake.cli.api.identifiers import FQN
-from snowflake.cli.plugins.stage.manager import (
+from click import UsageError
+from snowflake.cli._plugins.stage.manager import (
     USER_STAGE_PREFIX,
     StageManager,
     StagePathParts,
     UserStagePathParts,
 )
+from snowflake.cli.api.identifiers import FQN
 from snowflake.connector.cursor import SnowflakeCursor
 
+# Replace magic numbers with constants
+OMIT_FIRST = slice(1, None)
+OMIT_STAGE = slice(3, None)
+OMIT_STAGE_IN_NEW_LIST_FILES = slice(2, None)
+ONLY_STAGE = slice(3)
+
 
 class GitStagePathParts(StagePathParts):
     def __init__(self, stage_path: str):
         self.stage = GitManager.get_stage_from_path(stage_path)
-        stage_path_parts = Path(stage_path).parts
+        stage_path_parts = GitManager.split_git_path(stage_path)
         git_repo_name = stage_path_parts[0].split(".")[-1]
         if git_repo_name.startswith("@"):
-            git_repo_name = git_repo_name[1:]
+            git_repo_name = git_repo_name[OMIT_FIRST]
         self.stage_name = "/".join([git_repo_name, *stage_path_parts[1:3], ""])
-        self.directory = "/".join(stage_path_parts[3:])
+        self.directory = "/".join(stage_path_parts[OMIT_STAGE])
         self.is_directory = True if stage_path.endswith("/") else False
 
     @property
@@ -45,7 +52,12 @@ class GitStagePathParts(StagePathParts):
 
     @classmethod
     def get_directory(cls, stage_path: str) -> str:
-        return "/".join(Path(stage_path).parts[3:])
+        git_path_parts = GitManager.split_git_path(stage_path)
+        # New file list does not have a stage name at the beginning
+        if stage_path.startswith("/"):
+            return "/".join(git_path_parts[OMIT_STAGE_IN_NEW_LIST_FILES])
+        else:
+            return "/".join(git_path_parts[OMIT_STAGE])
 
     @property
     def full_path(self) -> str:
@@ -53,7 +65,7 @@ class GitStagePathParts(StagePathParts):
 
     def replace_stage_prefix(self, file_path: str) -> str:
         stage = Path(self.stage).parts[0]
-        file_path_without_prefix = Path(file_path).parts[1:]
+        file_path_without_prefix = Path(file_path).parts[OMIT_FIRST]
         return f"{stage}/{'/'.join(file_path_without_prefix)}"
 
     def add_stage_prefix(self, file_path: str) -> str:
@@ -95,7 +107,8 @@ class GitManager(StageManager):
         Returns stage name from potential path on stage. For example
         repo/branches/main/foo/bar -> repo/branches/main/
         """
-        return f"{'/'.join(Path(path).parts[0:3])}/"
+        path_parts = GitManager.split_git_path(path)
+        return f"{'/'.join(path_parts[ONLY_STAGE])}/"
 
     @staticmethod
     def _stage_path_part_factory(stage_path: str) -> StagePathParts:
@@ -103,3 +116,36 @@ class GitManager(StageManager):
         if stage_path.startswith(USER_STAGE_PREFIX):
             return UserStagePathParts(stage_path)
         return GitStagePathParts(stage_path)
+
+    @staticmethod
+    def split_git_path(path: str):
+        # Check if path contains quotes and split it accordingly
+        if '/"' in path and '"/' in path:
+            if path.count('"') > 2:
+                raise UsageError(
+                    f'Invalid string {path}, too much " in path, expected 2.'
+                )
+
+            path_parts = path.split('"')
+            before_quoted_part = GitManager._split_path_without_empty_parts(
+                path_parts[0]
+            )
+
+            if path_parts[2] == "/":
+                after_quoted_part = []
+            else:
+                after_quoted_part = GitManager._split_path_without_empty_parts(
+                    path_parts[2]
+                )
+
+            return [
+                *before_quoted_part,
+                f'"{path_parts[1]}"',
+                *after_quoted_part,
+            ]
+        else:
+            return GitManager._split_path_without_empty_parts(path)
+
+    @staticmethod
+    def _split_path_without_empty_parts(path: str):
+        return [e for e in PurePosixPath(path).parts if e != "/"]

snowflake/cli/{plugins → _plugins}/git/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.git import commands
 from snowflake.cli.api.plugins.command import (
     SNOWCLI_ROOT_COMMAND_PATH,
     CommandSpec,
     CommandType,
     plugin_hook_impl,
 )
-from snowflake.cli.plugins.git import commands
 
 
 @plugin_hook_impl

snowflake/cli/_plugins/helpers/commands.py

@@ -0,0 +1,90 @@
+# 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 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 (
+    convert_project_definition_to_v2,
+)
+from snowflake.cli.api.project.definition_manager import DefinitionManager
+from snowflake.cli.api.secure_path import SecurePath
+
+app = SnowTyperFactory(
+    name="helpers",
+    help="Helper commands.",
+)
+
+
+@app.command()
+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, 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/notebook → _plugins/helpers}/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.helpers import commands
 from snowflake.cli.api.plugins.command import (
     SNOWCLI_ROOT_COMMAND_PATH,
     CommandSpec,
     CommandType,
     plugin_hook_impl,
 )
-from snowflake.cli.plugins.notebook import commands
 
 
 @plugin_hook_impl

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

@@ -23,10 +23,10 @@ from click import ClickException
 from snowflake.cli.__about__ import VERSION
 from snowflake.cli.api.commands.flags import (
     NoInteractiveOption,
-    parse_key_value_variables,
     variables_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 DEFAULT_SIZE_LIMIT_MB
 from snowflake.cli.api.exceptions import InvalidTemplate
 from snowflake.cli.api.output.types import (
@@ -107,7 +107,7 @@ def _fetch_remote_template(
     from git import rmtree as git_rmtree
 
     # TODO: during nativeapp refactor get rid of this dependency
-    from snowflake.cli.plugins.nativeapp.utils import shallow_git_clone
+    from snowflake.cli._plugins.nativeapp.utils import shallow_git_clone
 
     log.info("Downloading remote template from %s", url)
     try:

snowflake/cli/{plugins → _plugins}/init/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.init import commands
 from snowflake.cli.api.plugins.command import (
     SNOWCLI_ROOT_COMMAND_PATH,
     CommandSpec,
     CommandType,
     plugin_hook_impl,
 )
-from snowflake.cli.plugins.init import commands
 
 
 @plugin_hook_impl

snowflake/cli/{plugins → _plugins}/nativeapp/artifacts.py

@@ -22,7 +22,8 @@ from typing import Any, Callable, Dict, Iterable, Iterator, List, Optional, Tupl
 
 from click.exceptions import ClickException
 from snowflake.cli.api.constants import DEFAULT_SIZE_LIMIT_MB
-from snowflake.cli.api.project.schemas.native_app.path_mapping import PathMapping
+from snowflake.cli.api.project.schemas.v1.native_app.path_mapping import PathMapping
+from snowflake.cli.api.project.util import to_identifier
 from snowflake.cli.api.secure_path import SecurePath
 from yaml import safe_load
 
@@ -199,6 +200,12 @@ class _ArtifactPathMap:
         """
         return self.__src_to_dest.keys()
 
+    def is_empty(self) -> bool:
+        """
+        Returns True if this map has no source-destination mappings.
+        """
+        return len(self.__src_dest_pairs) == 0
+
     def __iter__(self) -> Iterator[Tuple[Path, Path]]:
         """
         Returns all (source, destination) pairs known to this map, in insertion order.
@@ -240,6 +247,9 @@ class BundleMap:
         self._deploy_root: Path = resolve_without_follow(deploy_root)
         self._artifact_map = _ArtifactPathMap(project_root=self._project_root)
 
+    def is_empty(self) -> bool:
+        return self._artifact_map.is_empty()
+
     def deploy_root(self) -> Path:
         return self._deploy_root
 
@@ -658,6 +668,11 @@ def build_bundle(
     for artifact in artifacts:
         bundle_map.add(artifact)
 
+    if bundle_map.is_empty():
+        raise ArtifactError(
+            "No artifacts mapping found in project definition, nothing to do."
+        )
+
     for (absolute_src, absolute_dest) in bundle_map.all_mappings(
         absolute=True, expand_directories=False
     ):
@@ -720,23 +735,23 @@ def find_setup_script_file(deploy_root: Path) -> Path:
 
 def find_version_info_in_manifest_file(
     deploy_root: Path,
-) -> Tuple[Optional[str], Optional[str]]:
+) -> Tuple[Optional[str], Optional[int]]:
     """
     Find version and patch, if available, in the manifest.yml file.
     """
-    version_field = "version"
     name_field = "name"
     patch_field = "patch"
 
     manifest_content = find_and_read_manifest_file(deploy_root=deploy_root)
 
     version_name: Optional[str] = None
-    patch_name: Optional[str] = None
+    patch_number: Optional[int] = None
 
-    if version_field in manifest_content:
-        version_info = manifest_content[version_field]
-        version_name = version_info[name_field]
+    version_info = manifest_content.get("version", None)
+    if version_info:
+        if name_field in version_info:
+            version_name = to_identifier(str(version_info[name_field]))
         if patch_field in version_info:
-            patch_name = version_info[patch_field]
+            patch_number = int(version_info[patch_field])
 
-    return version_name, patch_name
+    return version_name, patch_number

snowflake/cli/_plugins/nativeapp/bundle_context.py

@@ -0,0 +1,31 @@
+# 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 dataclasses import dataclass
+from pathlib import Path
+from typing import (
+    List,
+)
+
+from snowflake.cli.api.project.schemas.v1.native_app.path_mapping import PathMapping
+
+
+@dataclass
+class BundleContext:
+    package_name: str
+    artifacts: List[PathMapping]
+    project_root: Path
+    bundle_root: Path
+    deploy_root: Path
+    generated_root: Path

snowflake/cli/{plugins → _plugins}/nativeapp/codegen/artifact_processor.py

@@ -19,11 +19,11 @@ from pathlib import Path
 from typing import Optional
 
 from click import ClickException
-from snowflake.cli.api.project.schemas.native_app.path_mapping import (
+from snowflake.cli._plugins.nativeapp.bundle_context import BundleContext
+from snowflake.cli.api.project.schemas.v1.native_app.path_mapping import (
     PathMapping,
     ProcessorMapping,
 )
-from snowflake.cli.plugins.nativeapp.project_model import NativeAppProjectModel
 
 
 class UnsupportedArtifactProcessorError(ClickException):
@@ -74,9 +74,9 @@ class ProjectFileContextManager:
 class ArtifactProcessor(ABC):
     def __init__(
         self,
-        na_project: NativeAppProjectModel,
+        bundle_ctx: BundleContext,
     ) -> None:
-        self._na_project = na_project
+        self._bundle_ctx = bundle_ctx
 
     @abstractmethod
     def process(

snowflake/cli/{plugins → _plugins}/nativeapp/codegen/compiler.py

@@ -14,31 +14,41 @@
 
 from __future__ import annotations
 
+import copy
+import re
 from typing import Dict, Optional
 
-from snowflake.cli.api.console import cli_console as cc
-from snowflake.cli.api.project.schemas.native_app.path_mapping import (
-    ProcessorMapping,
-)
-from snowflake.cli.plugins.nativeapp.codegen.artifact_processor import (
+from click import ClickException
+from snowflake.cli._plugins.nativeapp.bundle_context import BundleContext
+from snowflake.cli._plugins.nativeapp.codegen.artifact_processor import (
     ArtifactProcessor,
     UnsupportedArtifactProcessorError,
 )
-from snowflake.cli.plugins.nativeapp.codegen.setup.native_app_setup_processor import (
+from snowflake.cli._plugins.nativeapp.codegen.setup.native_app_setup_processor import (
     NativeAppSetupProcessor,
 )
-from snowflake.cli.plugins.nativeapp.codegen.snowpark.python_processor import (
+from snowflake.cli._plugins.nativeapp.codegen.snowpark.python_processor import (
     SnowparkAnnotationProcessor,
 )
-from snowflake.cli.plugins.nativeapp.feature_flags import FeatureFlag
-from snowflake.cli.plugins.nativeapp.project_model import NativeAppProjectModel
+from snowflake.cli._plugins.nativeapp.codegen.templates.templates_processor import (
+    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,
+)
 
 SNOWPARK_PROCESSOR = "snowpark"
-NA_SETUP_PROCESSOR = "native-app-setup"
+NA_SETUP_PROCESSOR = "native app setup"
+TEMPLATES_PROCESSOR = "templates"
 
 _REGISTERED_PROCESSORS_BY_NAME = {
     SNOWPARK_PROCESSOR: SnowparkAnnotationProcessor,
     NA_SETUP_PROCESSOR: NativeAppSetupProcessor,
+    TEMPLATES_PROCESSOR: TemplatesProcessor,
 }
 
 
@@ -53,9 +63,9 @@ class NativeAppCompiler:
 
     def __init__(
         self,
-        na_project: NativeAppProjectModel,
+        bundle_ctx: BundleContext,
     ):
-        self._na_project = na_project
+        self._bundle_ctx = bundle_ctx
         # dictionary of all processors created and shared between different artifact objects.
         self.cached_processors: Dict[str, ArtifactProcessor] = {}
 
@@ -64,17 +74,20 @@ 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
 
         with cc.phase("Invoking artifact processors"):
-            if self._na_project.generated_root.exists():
+            if self._bundle_ctx.generated_root.exists():
                 raise ClickException(
-                    f"Path {self._na_project.generated_root} already exists. Please choose a different name for your generated directory in the project definition file."
+                    f"Path {self._bundle_ctx.generated_root} already exists. Please choose a different name for your generated directory in the project definition file."
                 )
 
-            for artifact in self._na_project.artifacts:
+            for artifact in self._bundle_ctx.artifacts:
                 for processor in artifact.processors:
                     if self._is_enabled(processor):
                         artifact_processor = self._try_create_processor(
@@ -110,15 +123,21 @@ class NativeAppCompiler:
             # No registered processor with the specified name
             return None
 
-        current_processor = processor_factory(
-            na_project=self._na_project,
+        processor_ctx = copy.copy(self._bundle_ctx)
+        processor_subdirectory = re.sub(r"[^a-zA-Z0-9_$]", "_", processor_name)
+        processor_ctx.bundle_root = (
+            self._bundle_ctx.bundle_root / processor_subdirectory
+        )
+        processor_ctx.generated_root = (
+            self._bundle_ctx.generated_root / processor_subdirectory
         )
+        current_processor = processor_factory(processor_ctx)
         self.cached_processors[processor_name] = current_processor
 
         return current_processor
 
     def _should_invoke_processors(self):
-        for artifact in self._na_project.artifacts:
+        for artifact in self._bundle_ctx.artifacts:
             for processor in artifact.processors:
                 if self._is_enabled(processor):
                     return True