snowflake-cli-labs 2.8.0rc1__py3-none-any.whl → 3.0.0rc0__py3-none-any.whl

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

@@ -21,8 +21,20 @@ from typing import List, Optional
 import click
 import typer
 from click import UsageError
-from snowflake.cli.api.cli_global_context import cli_context
-from snowflake.cli.api.commands.flags import readable_file_option
+from snowflake.cli._plugins.cortex.constants import DEFAULT_MODEL
+from snowflake.cli._plugins.cortex.manager import CortexManager
+from snowflake.cli._plugins.cortex.types import (
+    Language,
+    Model,
+    Question,
+    SourceDocument,
+    Text,
+)
+from snowflake.cli.api.cli_global_context import get_cli_context
+from snowflake.cli.api.commands.overrideable_parameter import (
+    OverrideableArgument,
+    OverrideableOption,
+)
 from snowflake.cli.api.commands.snow_typer import SnowTyperFactory
 from snowflake.cli.api.constants import PYTHON_3_12
 from snowflake.cli.api.output.types import (
@@ -31,15 +43,6 @@ from snowflake.cli.api.output.types import (
     MessageResult,
 )
 from snowflake.cli.api.secure_path import SecurePath
-from snowflake.cli.plugins.cortex.constants import DEFAULT_MODEL
-from snowflake.cli.plugins.cortex.manager import CortexManager
-from snowflake.cli.plugins.cortex.types import (
-    Language,
-    Model,
-    Question,
-    SourceDocument,
-    Text,
-)
 
 app = SnowTyperFactory(
     name="cortex",
@@ -48,6 +51,25 @@ app = SnowTyperFactory(
 
 SEARCH_COMMAND_ENABLED = sys.version_info < PYTHON_3_12
 
+SOURCE_EXCLUSIVE_OPTION_NAMES = ["text", "file", "source_document_text"]
+
+# Creates a Typer option and verifies if the mutually exclusive options are set in the command.
+ExclusiveReadableFileOption = OverrideableOption(
+    None,
+    "--file",
+    mutually_exclusive=SOURCE_EXCLUSIVE_OPTION_NAMES,
+    exists=True,
+    file_okay=True,
+    dir_okay=False,
+    readable=True,
+    show_default=False,
+)
+
+# Creates a Typer argument and verifies if the mutually exclusive options are set in the command.
+ExclusiveTextSourceArgument = OverrideableArgument(
+    mutually_exclusive=SOURCE_EXCLUSIVE_OPTION_NAMES,
+)
+
 
 @app.command(
     requires_connection=True,
@@ -79,7 +101,7 @@ def search(
     if not columns:
         columns = []
 
-    conn = cli_context.connection
+    conn = get_cli_context().connection
 
     search_service = (
         Root(conn)
@@ -100,8 +122,8 @@ def search(
     requires_connection=True,
 )
 def complete(
-    text: Optional[str] = typer.Argument(
-        None,
+    text: Optional[str] = ExclusiveTextSourceArgument(
+        default=None,
         help="Prompt to be used to generate a completion. Cannot be combined with --file option.",
         show_default=False,
     ),
@@ -110,9 +132,8 @@ def complete(
         "--model",
         help="String specifying the model to be used.",
     ),
-    file: Optional[Path] = readable_file_option(
-        param_name="--file",
-        help_str="JSON file containing conversation history to be used to generate a completion. Cannot be combined with TEXT argument.",
+    file: Optional[Path] = ExclusiveReadableFileOption(
+        help="JSON file containing conversation history to be used to generate a completion. Cannot be combined with TEXT argument.",
     ),
     **options,
 ) -> CommandResult:
@@ -124,8 +145,6 @@ def complete(
 
     manager = CortexManager()
 
-    if text and file:
-        raise UsageError("--file option cannot be used together with TEXT argument.")
     if text:
         result_text = manager.complete_for_prompt(
             text=Text(text),
@@ -152,14 +171,13 @@ def extract_answer(
         help="String containing the question to be answered.",
         show_default=False,
     ),
-    source_document_text: Optional[str] = typer.Argument(
-        None,
+    source_document_text: Optional[str] = ExclusiveTextSourceArgument(
+        default=None,
         help="String containing the plain-text or JSON document that contains the answer to the question. Cannot be combined with --file option.",
         show_default=False,
     ),
-    file: Optional[Path] = readable_file_option(
-        param_name="--file",
-        help_str="File containing the plain-text or JSON document that contains the answer to the question. Cannot be combined with SOURCE_DOCUMENT_TEXT argument.",
+    file: Optional[Path] = ExclusiveReadableFileOption(
+        help="File containing the plain-text or JSON document that contains the answer to the question. Cannot be combined with SOURCE_DOCUMENT_TEXT argument.",
     ),
     **options,
 ) -> CommandResult:
@@ -170,10 +188,6 @@ def extract_answer(
 
     manager = CortexManager()
 
-    if source_document_text and file:
-        raise UsageError(
-            "--file option cannot be used together with SOURCE_DOCUMENT_TEXT argument."
-        )
     if source_document_text:
         result_text = manager.extract_answer_from_source_document(
             source_document=SourceDocument(source_document_text),
@@ -197,14 +211,13 @@ def extract_answer(
     requires_connection=True,
 )
 def sentiment(
-    text: Optional[str] = typer.Argument(
-        None,
+    text: Optional[str] = ExclusiveTextSourceArgument(
+        default=None,
         help="String containing the text for which a sentiment score should be calculated. Cannot be combined with --file option.",
         show_default=False,
     ),
-    file: Optional[Path] = readable_file_option(
-        param_name="--file",
-        help_str="File containing the text for which a sentiment score should be calculated. Cannot be combined with TEXT argument.",
+    file: Optional[Path] = ExclusiveReadableFileOption(
+        help="File containing the text for which a sentiment score should be calculated. Cannot be combined with TEXT argument.",
     ),
     **options,
 ) -> CommandResult:
@@ -216,8 +229,6 @@ def sentiment(
 
     manager = CortexManager()
 
-    if text and file:
-        raise UsageError("--file option cannot be used together with TEXT argument.")
     if text:
         result_text = manager.calculate_sentiment_for_text(
             text=Text(text),
@@ -237,14 +248,13 @@ def sentiment(
     requires_connection=True,
 )
 def summarize(
-    text: Optional[str] = typer.Argument(
-        None,
+    text: Optional[str] = ExclusiveTextSourceArgument(
+        default=None,
         help="String containing the English text from which a summary should be generated. Cannot be combined with --file option.",
         show_default=False,
     ),
-    file: Optional[Path] = readable_file_option(
-        param_name="--file",
-        help_str="File containing the English text from which a summary should be generated. Cannot be combined with TEXT argument.",
+    file: Optional[Path] = ExclusiveReadableFileOption(
+        help="File containing the English text from which a summary should be generated. Cannot be combined with TEXT argument.",
     ),
     **options,
 ) -> CommandResult:
@@ -254,8 +264,6 @@ def summarize(
 
     manager = CortexManager()
 
-    if text and file:
-        raise UsageError("--file option cannot be used together with TEXT argument.")
     if text:
         result_text = manager.summarize_text(
             text=Text(text),
@@ -275,8 +283,8 @@ def summarize(
     requires_connection=True,
 )
 def translate(
-    text: Optional[str] = typer.Argument(
-        None,
+    text: Optional[str] = ExclusiveTextSourceArgument(
+        default=None,
         help="String containing the text to be translated. Cannot be combined with --file option.",
         show_default=False,
     ),
@@ -292,9 +300,8 @@ def translate(
         help="String specifying the language code into which the text should be translated. See Snowflake Cortex documentation for a list of supported language codes.",
         show_default=False,
     ),
-    file: Optional[Path] = readable_file_option(
-        param_name="--file",
-        help_str="File containing the text to be translated. Cannot be combined with TEXT argument.",
+    file: Optional[Path] = ExclusiveReadableFileOption(
+        help="File containing the text to be translated. Cannot be combined with TEXT argument.",
     ),
     **options,
 ) -> CommandResult:
@@ -307,8 +314,6 @@ def translate(
     source_language = None if from_language is None else Language(from_language)
     target_language = Language(to_language)
 
-    if text and file:
-        raise UsageError("--file option cannot be used together with TEXT argument.")
     if text:
         result_text = manager.translate_text(
             text=Text(text),

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

@@ -12,6 +12,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-from snowflake.cli.plugins.cortex.types import Model
+from snowflake.cli._plugins.cortex.types import Model
 
 DEFAULT_MODEL: Model = Model("snowflake-arctic")

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 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
 
 app = SnowTyperFactory(
     name="git",
@@ -71,6 +71,7 @@ RepoPathArgument = typer.Argument(
         " For example: @my_repo/branches/main/"
     ),
     callback=_repo_path_argument_callback,
+    show_default=False,
 )
 add_object_command_aliases(
     app=app,
@@ -82,10 +83,12 @@ add_object_command_aliases(
     scope_option=scope_option(help_example="`list --in database my_db`"),
 )
 
+from snowflake.cli.api.identifiers import FQN
 
-def _assure_repository_does_not_exist(om: ObjectManager, repository_name: str) -> None:
+
+def _assure_repository_does_not_exist(om: ObjectManager, repository_name: FQN) -> None:
     if om.object_exists(
-        object_type=ObjectType.GIT_REPOSITORY.value.cli_name, name=repository_name
+        object_type=ObjectType.GIT_REPOSITORY.value.cli_name, fqn=repository_name
     ):
         raise ClickException(f"Repository '{repository_name}' already exists")
 
@@ -97,12 +100,14 @@ def _validate_origin_url(url: str) -> None:
 
 @app.command("setup", requires_connection=True)
 def setup(
-    repository_name: str = RepoNameArgument,
+    repository_name: FQN = RepoNameArgument,
     **options,
 ) -> CommandResult:
     """
     Sets up a git repository object.
 
+    ## Usage notes
+
     You will be prompted for:
 
     * url - address of repository to be used for git clone operation
@@ -127,8 +132,9 @@ def setup(
         secret_name = typer.prompt(
             "Secret identifier (will be created if not exists)", default=secret_name
         )
+        secret_fqn = FQN.from_string(secret_name)
         if om.object_exists(
-            object_type=ObjectType.SECRET.value.cli_name, name=secret_name
+            object_type=ObjectType.SECRET.value.cli_name, fqn=secret_fqn
         ):
             cli_console.step(f"Using existing secret '{secret_name}'")
         else:
@@ -142,18 +148,19 @@ def setup(
         "API integration identifier (will be created if not exists)",
         default=api_integration,
     )
+    api_integration_fqn = FQN.from_string(api_integration)
 
     if should_create_secret:
         manager.create_password_secret(
-            name=secret_name, username=secret_username, password=secret_password
+            name=secret_fqn, username=secret_username, password=secret_password
         )
         cli_console.step(f"Secret '{secret_name}' successfully created.")
 
     if not om.object_exists(
-        object_type=ObjectType.INTEGRATION.value.cli_name, name=api_integration
+        object_type=ObjectType.INTEGRATION.value.cli_name, fqn=api_integration_fqn
     ):
         manager.create_api_integration(
-            name=api_integration,
+            name=api_integration_fqn,
             api_provider="git_https_api",
             allowed_prefix=url,
             secret=secret_name,
@@ -177,7 +184,7 @@ def setup(
     requires_connection=True,
 )
 def list_branches(
-    repository_name: str = RepoNameArgument,
+    repository_name: FQN = RepoNameArgument,
     like=like_option(
         help_example='`list-branches --like "%_test"` lists all branches that end with "_test"'
     ),
@@ -186,7 +193,9 @@ def list_branches(
     """
     List all branches in the repository.
     """
-    return QueryResult(GitManager().show_branches(repo_name=repository_name, like=like))
+    return QueryResult(
+        GitManager().show_branches(repo_name=repository_name.identifier, like=like)
+    )
 
 
 @app.command(
@@ -194,7 +203,7 @@ def list_branches(
     requires_connection=True,
 )
 def list_tags(
-    repository_name: str = RepoNameArgument,
+    repository_name: FQN = RepoNameArgument,
     like=like_option(
         help_example='`list-tags --like "v2.0%"` lists all tags that start with "v2.0"'
     ),
@@ -203,7 +212,9 @@ def list_tags(
     """
     List all tags in the repository.
     """
-    return QueryResult(GitManager().show_tags(repo_name=repository_name, like=like))
+    return QueryResult(
+        GitManager().show_tags(repo_name=repository_name.identifier, like=like)
+    )
 
 
 @app.command(
@@ -228,13 +239,13 @@ def list_files(
     requires_connection=True,
 )
 def fetch(
-    repository_name: str = RepoNameArgument,
+    repository_name: FQN = RepoNameArgument,
     **options,
 ) -> CommandResult:
     """
     Fetch changes from origin to Snowflake repository.
     """
-    return QueryResult(GitManager().fetch(repo_name=repository_name))
+    return QueryResult(GitManager().fetch(fqn=repository_name))
 
 
 @app.command(
@@ -245,6 +256,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

@@ -18,12 +18,13 @@ from pathlib import Path
 from textwrap import dedent
 from typing import List
 
-from snowflake.cli.plugins.stage.manager import (
+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
 
 
@@ -63,15 +64,15 @@ class GitManager(StageManager):
     def show_tags(self, repo_name: str, like: str) -> SnowflakeCursor:
         return self._execute_query(f"show git tags like '{like}' in {repo_name}")
 
-    def fetch(self, repo_name: str) -> SnowflakeCursor:
-        return self._execute_query(f"alter git repository {repo_name} fetch")
+    def fetch(self, fqn: FQN) -> SnowflakeCursor:
+        return self._execute_query(f"alter git repository {fqn} fetch")
 
     def create(
-        self, repo_name: str, api_integration: str, url: str, secret: str
+        self, repo_name: FQN, api_integration: str, url: str, secret: str
     ) -> SnowflakeCursor:
         query = dedent(
             f"""
-            create git repository {repo_name}
+            create git repository {repo_name.sql_identifier}
             api_integration = {api_integration}
             origin = '{url}'
             """

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 → _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 (
@@ -68,7 +68,8 @@ TemplateOption = typer.Option(
     show_default=False,
 )
 SourceOption = typer.Option(
-    default=DEFAULT_SOURCE,
+    DEFAULT_SOURCE,
+    "--template-source",
     help=f"local path to template directory or URL to git repository with templates.",
 )
 VariablesOption = variables_option(
@@ -106,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:
@@ -132,13 +133,13 @@ def _fetch_remote_template(
     return template_root
 
 
-def _read_template_metadata(template_root: SecurePath) -> Template:
+def _read_template_metadata(template_root: SecurePath, args_error_msg: str) -> Template:
     """Parse template.yml file."""
     template_metadata_path = template_root / TEMPLATE_METADATA_FILE_NAME
     log.debug("Reading template metadata from %s", template_metadata_path.path)
     if not template_metadata_path.exists():
         raise InvalidTemplate(
-            f"Template does not have {TEMPLATE_METADATA_FILE_NAME} file."
+            f"File {TEMPLATE_METADATA_FILE_NAME} not found. {args_error_msg}"
         )
     with template_metadata_path.open(read_file_limit_mb=DEFAULT_SIZE_LIMIT_MB) as fd:
         yaml_contents = yaml.safe_load(fd) or {}
@@ -203,6 +204,7 @@ def init(
     is_remote = any(
         template_source.startswith(prefix) for prefix in ["git@", "http://", "https://"]  # type: ignore
     )
+    args_error_msg = f"Check whether {TemplateOption.param_decls[0]} and {SourceOption.param_decls[0]} arguments are correct."
 
     # copy/download template into tmpdir, so it is going to be removed in case command ends with an error
     with SecurePath.temporary_directory() as tmpdir:
@@ -217,7 +219,9 @@ def init(
                 destination=tmpdir,
             )
 
-        template_metadata = _read_template_metadata(template_root)
+        template_metadata = _read_template_metadata(
+            template_root, args_error_msg=args_error_msg
+        )
         if template_metadata.minimum_cli_version:
             _validate_cli_version(template_metadata.minimum_cli_version)
 

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

@@ -199,6 +199,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 +246,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 +667,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
     ):

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.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._plugins.nativeapp.bundle_context import BundleContext
 from snowflake.cli.api.project.schemas.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(