snowflake-cli-labs 3.0.0rc4__py3-none-any.whl → 3.0.1__py3-none-any.whl

snowflake/cli/_plugins/nativeapp/v2_conversions/v2_to_v1_decorator.py

@@ -1,262 +0,0 @@
-# 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 inspect
-from functools import wraps
-from typing import Any, Dict, Optional, Type, TypeVar, Union
-
-import typer
-from click import ClickException
-from snowflake.cli._plugins.nativeapp.entities.application import ApplicationEntityModel
-from snowflake.cli._plugins.nativeapp.entities.application_package import (
-    ApplicationPackageEntityModel,
-)
-from snowflake.cli.api.cli_global_context import (
-    get_cli_context,
-    get_cli_context_manager,
-)
-from snowflake.cli.api.commands.decorators import _options_decorator_factory
-from snowflake.cli.api.project.schemas.entities.common import EntityModelBase
-from snowflake.cli.api.project.schemas.project_definition import (
-    DefinitionV11,
-    DefinitionV20,
-)
-from snowflake.cli.api.project.schemas.v1.native_app.path_mapping import PathMapping
-from snowflake.cli.api.utils.definition_rendering import render_definition_template
-
-
-def _convert_v2_artifact_to_v1_dict(
-    v2_artifact: Union[PathMapping, str]
-) -> Union[Dict, str]:
-    if isinstance(v2_artifact, PathMapping):
-        return {
-            "src": v2_artifact.src,
-            "dest": v2_artifact.dest,
-            "processors": v2_artifact.processors,
-        }
-    return v2_artifact
-
-
-def _pdf_v2_to_v1(
-    v2_definition: DefinitionV20,
-    package_entity_id: str = "",
-    app_entity_id: str = "",
-    app_required: bool = False,
-) -> DefinitionV11:
-    pdfv1: Dict[str, Any] = {"definition_version": "1.1", "native_app": {}}
-
-    # Determine the application entity to convert, there can be zero or one
-    app_definition = find_entity(
-        v2_definition,
-        ApplicationEntityModel,
-        app_entity_id,
-        disambiguation_option="--app-entity-id",
-        required=app_required,
-    )
-
-    # Infer or verify the package if we have an app entity to convert
-    if app_definition:
-        target_package = app_definition.from_.target
-        if package_entity_id:
-            # If the user specified a package entity ID,
-            # check that the app entity targets the user-specified package entity
-            # if the app entity is used by the command being run
-            if target_package != package_entity_id and app_required:
-                raise ClickException(
-                    f"The application entity {app_definition.entity_id} does not "
-                    f"target the application package entity {package_entity_id}. Either"
-                    f"use --package-entity-id {target_package} to target the correct package entity, "
-                    f"or omit the --package-entity-id flag to automatically use the package entity "
-                    f"that the application entity targets."
-                )
-        elif target_package in v2_definition.get_entities_by_type(
-            ApplicationPackageEntityModel.get_type()
-        ):
-            # If the user didn't target a specific package entity, use the one the app entity targets
-            package_entity_id = target_package
-
-    # Determine the package entity to convert, there must be one
-    app_package_definition = find_entity(
-        v2_definition,
-        ApplicationPackageEntityModel,
-        package_entity_id,
-        disambiguation_option="--package-entity-id",
-        required=True,
-    )
-    assert app_package_definition is not None  # satisfy mypy
-
-    # NativeApp
-    if app_definition and app_definition.fqn.identifier:
-        pdfv1["native_app"]["name"] = app_definition.fqn.identifier
-    else:
-        pdfv1["native_app"]["name"] = app_package_definition.fqn.identifier.split(
-            "_pkg_"
-        )[0]
-    pdfv1["native_app"]["artifacts"] = [
-        _convert_v2_artifact_to_v1_dict(a) for a in app_package_definition.artifacts
-    ]
-    pdfv1["native_app"]["source_stage"] = app_package_definition.stage
-    pdfv1["native_app"]["bundle_root"] = app_package_definition.bundle_root
-    pdfv1["native_app"]["generated_root"] = app_package_definition.generated_root
-    pdfv1["native_app"]["deploy_root"] = app_package_definition.deploy_root
-    pdfv1["native_app"]["scratch_stage"] = app_package_definition.scratch_stage
-
-    # Package
-    pdfv1["native_app"]["package"] = {}
-    pdfv1["native_app"]["package"]["name"] = app_package_definition.fqn.identifier
-    if app_package_definition.distribution:
-        pdfv1["native_app"]["package"][
-            "distribution"
-        ] = app_package_definition.distribution
-    if app_package_definition.meta and app_package_definition.meta.post_deploy:
-        pdfv1["native_app"]["package"][
-            "post_deploy"
-        ] = app_package_definition.meta.post_deploy
-    if app_package_definition.meta:
-        if app_package_definition.meta.role:
-            pdfv1["native_app"]["package"]["role"] = app_package_definition.meta.role
-        if app_package_definition.meta.warehouse:
-            pdfv1["native_app"]["package"][
-                "warehouse"
-            ] = app_package_definition.meta.warehouse
-
-    # Application
-    if app_definition:
-        pdfv1["native_app"]["application"] = {}
-        pdfv1["native_app"]["application"]["name"] = app_definition.fqn.identifier
-        if app_definition.debug:
-            pdfv1["native_app"]["application"]["debug"] = app_definition.debug
-        if app_definition.meta:
-            if app_definition.meta.role:
-                pdfv1["native_app"]["application"]["role"] = app_definition.meta.role
-            if app_definition.meta.warehouse:
-                pdfv1["native_app"]["application"][
-                    "warehouse"
-                ] = app_definition.meta.warehouse
-            if app_definition.meta.post_deploy:
-                pdfv1["native_app"]["application"][
-                    "post_deploy"
-                ] = app_definition.meta.post_deploy
-
-    result = render_definition_template(pdfv1, {})
-    # Override the definition object in global context
-    return result.project_definition
-
-
-T = TypeVar("T", bound=EntityModelBase)
-
-
-def find_entity(
-    project_definition: DefinitionV20,
-    entity_class: Type[T],
-    entity_id: str,
-    disambiguation_option: str,
-    required: bool,
-) -> T | None:
-    """
-    Find an entity of the specified type in the project definition file.
-
-    If an ID is passed, only that entity will be considered,
-    otherwise look for a single entity of the specified type.
-
-    If there are multiple entities of the specified type,
-    the user must specify which one to use using the CLI option
-    named in the disambiguation_option parameter.
-
-    If no entity is found, an error is raised if required is True,
-    otherwise None is returned.
-    """
-
-    entity_type = entity_class.get_type()
-    entities = project_definition.get_entities_by_type(entity_type)
-
-    entity: Optional[T] = None
-
-    if entity_id:
-        # If we're looking for a specific entity, use that one directly
-        entity = entities.get(entity_id)
-    elif len(entities) == 1:
-        # Otherwise, if there is only one entity, fall back to that one
-        entity = next(iter(entities.values()))
-    elif len(entities) > 1 and required:
-        # If there are multiple entities and it's required,
-        # the user must specify which one to use
-        raise ClickException(
-            f"More than one {entity_type} entity exists in the project definition file, "
-            f"specify {disambiguation_option} to choose which one to operate on."
-        )
-
-    # If we don't have a package entity to convert, error out if it's required
-    if not entity and required:
-        with_id = f'with ID "{entity_id}" ' if entity_id else ""
-        raise ClickException(
-            f"Could not find an {entity_type} entity {with_id}in the project definition file."
-        )
-
-    return entity
-
-
-def nativeapp_definition_v2_to_v1(*, app_required: bool = False):
-    """
-    A command decorator that attempts to automatically convert a native app project from
-    definition v2 to v1.1. Assumes with_project_definition() has already been called.
-    The definition object in CliGlobalContext will be replaced with the converted object.
-    Exactly one application package entity type is expected, and up to one application
-    entity type is expected.
-    """
-
-    def decorator(func):
-        @wraps(func)
-        def wrapper(*args, **kwargs):
-            original_pdf: Optional[DefinitionV20] = get_cli_context().project_definition
-            if not original_pdf:
-                raise ValueError(
-                    "Project definition could not be found. The nativeapp_definition_v2_to_v1 command decorator assumes with_project_definition() was called before it."
-                )
-            if original_pdf.definition_version == "2":
-                package_entity_id = kwargs.get("package_entity_id", "")
-                app_entity_id = kwargs.get("app_entity_id", "")
-                pdfv1 = _pdf_v2_to_v1(
-                    original_pdf, package_entity_id, app_entity_id, app_required
-                )
-                get_cli_context_manager().override_project_definition = pdfv1
-            return func(*args, **kwargs)
-
-        return _options_decorator_factory(
-            wrapper,
-            additional_options=[
-                inspect.Parameter(
-                    "package_entity_id",
-                    inspect.Parameter.KEYWORD_ONLY,
-                    annotation=Optional[str],
-                    default=typer.Option(
-                        default="",
-                        help="The ID of the package entity on which to operate when definition_version is 2 or higher.",
-                    ),
-                ),
-                inspect.Parameter(
-                    "app_entity_id",
-                    inspect.Parameter.KEYWORD_ONLY,
-                    annotation=Optional[str],
-                    default=typer.Option(
-                        default="",
-                        help="The ID of the application entity on which to operate when definition_version is 2 or higher.",
-                    ),
-                ),
-            ],
-        )
-
-    return decorator

snowflake/cli/_plugins/nativeapp/version/__init__.py

@@ -1,13 +0,0 @@
-# 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.

snowflake/cli/_plugins/nativeapp/version/commands.py

@@ -1,141 +0,0 @@
-# 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 logging
-from typing import Optional
-
-import typer
-from click import MissingParameter
-from snowflake.cli._plugins.nativeapp.common_flags import ForceOption, InteractiveOption
-from snowflake.cli._plugins.nativeapp.run_processor import NativeAppRunProcessor
-from snowflake.cli._plugins.nativeapp.v2_conversions.v2_to_v1_decorator import (
-    nativeapp_definition_v2_to_v1,
-)
-from snowflake.cli._plugins.nativeapp.version.version_processor import (
-    NativeAppVersionCreateProcessor,
-    NativeAppVersionDropProcessor,
-)
-from snowflake.cli.api.cli_global_context import get_cli_context
-from snowflake.cli.api.commands.decorators import (
-    with_project_definition,
-)
-from snowflake.cli.api.commands.snow_typer import SnowTyperFactory
-from snowflake.cli.api.output.types import CommandResult, MessageResult, QueryResult
-from snowflake.cli.api.project.project_verification import assert_project_type
-
-app = SnowTyperFactory(
-    name="version",
-    help="Manages versions defined in an application package",
-)
-
-log = logging.getLogger(__name__)
-
-
-@app.command(requires_connection=True)
-@with_project_definition()
-@nativeapp_definition_v2_to_v1()
-def create(
-    version: Optional[str] = typer.Argument(
-        None,
-        help=f"""Version to define in your application package. If the version already exists, an auto-incremented patch is added to the version instead. Defaults to the version specified in the `manifest.yml` file.""",
-    ),
-    patch: Optional[int] = typer.Option(
-        None,
-        "--patch",
-        help=f"""The patch number you want to create for an existing version.
-        Defaults to undefined if it is not set, which means the Snowflake CLI either uses the patch specified in the `manifest.yml` file or automatically generates a new patch number.""",
-    ),
-    skip_git_check: Optional[bool] = typer.Option(
-        False,
-        "--skip-git-check",
-        help="When enabled, the Snowflake CLI skips checking if your project has any untracked or stages files in git. Default: unset.",
-        is_flag=True,
-    ),
-    interactive: bool = InteractiveOption,
-    force: Optional[bool] = ForceOption,
-    **options,
-) -> CommandResult:
-    """
-    Adds a new patch to the provided version defined in your application package. If the version does not exist, creates a version with patch 0.
-    """
-
-    assert_project_type("native_app")
-
-    if version is None and patch is not None:
-        raise MissingParameter("Cannot provide a patch without version!")
-
-    cli_context = get_cli_context()
-    processor = NativeAppVersionCreateProcessor(
-        project_definition=cli_context.project_definition.native_app,
-        project_root=cli_context.project_root,
-    )
-    processor.process(
-        version=version,
-        patch=patch,
-        force=force,
-        interactive=interactive,
-        skip_git_check=skip_git_check,
-    )
-    return MessageResult(f"Version create is now complete.")
-
-
-@app.command("list", requires_connection=True)
-@with_project_definition()
-@nativeapp_definition_v2_to_v1()
-def version_list(
-    **options,
-) -> CommandResult:
-    """
-    Lists all versions defined in an application package.
-    """
-
-    assert_project_type("native_app")
-
-    cli_context = get_cli_context()
-    processor = NativeAppRunProcessor(
-        project_definition=cli_context.project_definition.native_app,
-        project_root=cli_context.project_root,
-    )
-    cursor = processor.get_all_existing_versions()
-    return QueryResult(cursor)
-
-
-@app.command(requires_connection=True)
-@with_project_definition()
-@nativeapp_definition_v2_to_v1()
-def drop(
-    version: Optional[str] = typer.Argument(
-        None,
-        help="Version defined in an application package that you want to drop. Defaults to the version specified in the `manifest.yml` file.",
-    ),
-    interactive: bool = InteractiveOption,
-    force: Optional[bool] = ForceOption,
-    **options,
-) -> CommandResult:
-    """
-    Drops a version defined in your application package. Versions can either be passed in as an argument to the command or read from the `manifest.yml` file.
-    Dropping patches is not allowed.
-    """
-
-    assert_project_type("native_app")
-
-    cli_context = get_cli_context()
-    processor = NativeAppVersionDropProcessor(
-        project_definition=cli_context.project_definition.native_app,
-        project_root=cli_context.project_root,
-    )
-    processor.process(version, force, interactive)
-    return MessageResult(f"Version drop is now complete.")

snowflake/cli/_plugins/nativeapp/version/version_processor.py

@@ -1,98 +0,0 @@
-# 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
-
-from pathlib import Path
-from typing import Dict, Optional
-
-from snowflake.cli._plugins.nativeapp.entities.application_package import (
-    ApplicationPackageEntity,
-)
-from snowflake.cli._plugins.nativeapp.manager import (
-    NativeAppCommandProcessor,
-    NativeAppManager,
-)
-from snowflake.cli._plugins.nativeapp.run_processor import NativeAppRunProcessor
-from snowflake.cli.api.console import cli_console as cc
-from snowflake.cli.api.project.schemas.v1.native_app.native_app import NativeApp
-
-
-class NativeAppVersionCreateProcessor(NativeAppRunProcessor):
-    def __init__(self, project_definition: Dict, project_root: Path):
-        super().__init__(project_definition, project_root)
-
-    def process(
-        self,
-        version: Optional[str],
-        patch: Optional[int],
-        force: bool,
-        interactive: bool,
-        skip_git_check: bool,
-        *args,
-        **kwargs,
-    ):
-        return ApplicationPackageEntity.version_create(
-            console=cc,
-            project_root=self.project_root,
-            deploy_root=self.deploy_root,
-            bundle_root=self.bundle_root,
-            generated_root=self.generated_root,
-            artifacts=self.artifacts,
-            package_name=self.package_name,
-            package_role=self.package_role,
-            package_distribution=self.package_distribution,
-            prune=True,
-            recursive=True,
-            paths=None,
-            print_diff=True,
-            validate=True,
-            stage_fqn=self.stage_fqn,
-            package_warehouse=self.package_warehouse,
-            post_deploy_hooks=self.package_post_deploy_hooks,
-            package_scripts=self.package_scripts,
-            version=version,
-            patch=patch,
-            force=force,
-            interactive=interactive,
-            skip_git_check=skip_git_check,
-        )
-
-
-class NativeAppVersionDropProcessor(NativeAppManager, NativeAppCommandProcessor):
-    def __init__(self, project_definition: NativeApp, project_root: Path):
-        super().__init__(project_definition, project_root)
-
-    def process(
-        self,
-        version: Optional[str],
-        force: bool,
-        interactive: bool,
-        *args,
-        **kwargs,
-    ):
-        return ApplicationPackageEntity.version_drop(
-            console=cc,
-            project_root=self.project_root,
-            deploy_root=self.deploy_root,
-            bundle_root=self.bundle_root,
-            generated_root=self.generated_root,
-            artifacts=self.artifacts,
-            package_name=self.package_name,
-            package_role=self.package_role,
-            package_distribution=self.package_distribution,
-            version=version,
-            force=force,
-            interactive=interactive,
-        )

snowflake/cli/_plugins/notebook/__init__.py

@@ -1,13 +0,0 @@
-# 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.

snowflake/cli/_plugins/notebook/commands.py

@@ -1,86 +0,0 @@
-# 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.
-
-import logging
-
-import typer
-from snowflake.cli._plugins.notebook.manager import NotebookManager
-from snowflake.cli._plugins.notebook.types import NotebookStagePath
-from snowflake.cli.api.commands.flags import identifier_argument
-from snowflake.cli.api.commands.snow_typer import SnowTyperFactory
-from snowflake.cli.api.identifiers import FQN
-from snowflake.cli.api.output.types import MessageResult
-from typing_extensions import Annotated
-
-app = SnowTyperFactory(
-    name="notebook",
-    help="Manages notebooks in Snowflake.",
-)
-log = logging.getLogger(__name__)
-
-NOTEBOOK_IDENTIFIER = identifier_argument(sf_object="notebook", example="MY_NOTEBOOK")
-NotebookFile: NotebookStagePath = typer.Option(
-    "--notebook-file",
-    "-f",
-    help="Stage path with notebook file. For example `@stage/path/to/notebook.ipynb`",
-    show_default=False,
-)
-
-
-@app.command(requires_connection=True)
-def execute(
-    identifier: FQN = NOTEBOOK_IDENTIFIER,
-    **options,
-):
-    """
-    Executes a notebook in a headless mode.
-    """
-    # Execution does not return any meaningful result
-    _ = NotebookManager().execute(notebook_name=identifier)
-    return MessageResult(f"Notebook {identifier} executed.")
-
-
-@app.command(requires_connection=True)
-def get_url(
-    identifier: FQN = NOTEBOOK_IDENTIFIER,
-    **options,
-):
-    """Return a url to a notebook."""
-    url = NotebookManager().get_url(notebook_name=identifier)
-    return MessageResult(message=url)
-
-
-@app.command(name="open", requires_connection=True)
-def open_cmd(
-    identifier: FQN = NOTEBOOK_IDENTIFIER,
-    **options,
-):
-    """Opens a notebook in default browser"""
-    url = NotebookManager().get_url(notebook_name=identifier)
-    typer.launch(url)
-    return MessageResult(message=url)
-
-
-@app.command(requires_connection=True)
-def create(
-    identifier: Annotated[FQN, NOTEBOOK_IDENTIFIER],
-    notebook_file: Annotated[NotebookStagePath, NotebookFile],
-    **options,
-):
-    """Creates notebook from stage."""
-    notebook_url = NotebookManager().create(
-        notebook_name=identifier,
-        notebook_file=notebook_file,
-    )
-    return MessageResult(message=notebook_url)

snowflake/cli/_plugins/notebook/exceptions.py

@@ -1,20 +0,0 @@
-# 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 click.exceptions import ClickException
-
-
-class NotebookStagePathError(ClickException):
-    def __init__(self, path: str):
-        super().__init__(f"Cannot extract notebook file name from {path=}")