snowflake-cli-labs 3.0.0rc5__py3-none-any.whl → 3.0.2__py3-none-any.whl

snowflake/cli/_plugins/git/commands.py

@@ -1,358 +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 itertools
-import logging
-from os import path
-from pathlib import Path
-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,
-    PatternOption,
-    identifier_argument,
-    like_option,
-)
-from snowflake.cli.api.commands.snow_typer import SnowTyperFactory
-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.connector import DictCursor
-
-app = SnowTyperFactory(
-    name="git",
-    help="Manages git repositories in Snowflake.",
-)
-log = logging.getLogger(__name__)
-
-
-def _repo_path_argument_callback(path):
-    # All repository paths must start with repository scope:
-    # "@repo_name/tag/example_tag/*"
-    if not is_stage_path(path) or path.count("/") < 3:
-        raise ClickException(
-            "REPOSITORY_PATH should be a path to git repository stage with scope provided."
-            " Path to the repository root must end with '/'."
-            " For example: @my_repo/branches/main/"
-        )
-
-    return path
-
-
-RepoNameArgument = identifier_argument(sf_object="git repository", example="my_repo")
-RepoPathArgument = typer.Argument(
-    metavar="REPOSITORY_PATH",
-    help=(
-        "Path to git repository stage with scope provided."
-        " Path to the repository root must end with '/'."
-        " For example: @my_repo/branches/main/"
-    ),
-    callback=_repo_path_argument_callback,
-    show_default=False,
-)
-add_object_command_aliases(
-    app=app,
-    object_type=ObjectType.GIT_REPOSITORY,
-    name_argument=RepoNameArgument,
-    like_option=like_option(
-        help_example='`list --like "my%"` lists all git repositories with name that begin with “my”',
-    ),
-    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: FQN) -> None:
-    if om.object_exists(
-        object_type=ObjectType.GIT_REPOSITORY.value.cli_name, fqn=repository_name
-    ):
-        raise ClickException(f"Repository '{repository_name}' already exists")
-
-
-def _validate_origin_url(url: str) -> None:
-    if not url.startswith("https://"):
-        raise ClickException("Url address should start with 'https'")
-
-
-def _unique_new_object_name(
-    om: ObjectManager, object_type: ObjectType, proposed_fqn: FQN
-) -> str:
-    existing_objects: List[Dict] = om.show(
-        object_type=object_type.value.cli_name,
-        like=f"{proposed_fqn.name}%",
-        cursor_class=DictCursor,
-    ).fetchall()
-    existing_names = set(o["name"].upper() for o in existing_objects)
-
-    result = proposed_fqn.name
-    i = 1
-    while result.upper() in existing_names:
-        result = proposed_fqn.name + str(i)
-        i += 1
-    return result
-
-
-@app.command("setup", requires_connection=True)
-def setup(
-    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
-
-    * secret - Snowflake secret containing authentication credentials. Not needed if origin repository does not require
-    authentication for RO operations (clone, fetch)
-
-    * API integration - object allowing Snowflake to interact with git repository.
-    """
-    manager = GitManager()
-    om = ObjectManager()
-    _assure_repository_does_not_exist(om, repository_name)
-
-    url = typer.prompt("Origin url")
-    _validate_origin_url(url)
-
-    secret_needed = typer.confirm("Use secret for authentication?")
-    should_create_secret = False
-    secret_name = None
-    if secret_needed:
-        default_secret_name = (
-            FQN.from_string(f"{repository_name.name}_secret")
-            .set_schema(repository_name.schema)
-            .set_database(repository_name.database)
-        )
-        default_secret_name.set_name(
-            _unique_new_object_name(
-                om, object_type=ObjectType.SECRET, proposed_fqn=default_secret_name
-            ),
-        )
-        secret_name = FQN.from_string(
-            typer.prompt(
-                "Secret identifier (will be created if not exists)",
-                default=default_secret_name.name,
-            )
-        )
-        if not secret_name.database:
-            secret_name.set_database(repository_name.database)
-        if not secret_name.schema:
-            secret_name.set_schema(repository_name.schema)
-
-        if om.object_exists(
-            object_type=ObjectType.SECRET.value.cli_name, fqn=secret_name
-        ):
-            cli_console.step(f"Using existing secret '{secret_name}'")
-        else:
-            should_create_secret = True
-            cli_console.step(f"Secret '{secret_name}' will be created")
-            secret_username = typer.prompt("username")
-            secret_password = typer.prompt("password/token", hide_input=True)
-
-    # API integration is an account-level object
-    api_integration = FQN.from_string(f"{repository_name.name}_api_integration")
-    api_integration.set_name(
-        typer.prompt(
-            "API integration identifier (will be created if not exists)",
-            default=_unique_new_object_name(
-                om,
-                object_type=ObjectType.INTEGRATION,
-                proposed_fqn=api_integration,
-            ),
-        )
-    )
-
-    if should_create_secret:
-        manager.create_password_secret(
-            name=secret_name, 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, fqn=api_integration
-    ):
-        manager.create_api_integration(
-            name=api_integration,
-            api_provider="git_https_api",
-            allowed_prefix=url,
-            secret=secret_name,
-        )
-        cli_console.step(f"API integration '{api_integration}' successfully created.")
-    else:
-        cli_console.step(f"Using existing API integration '{api_integration}'.")
-
-    return QueryResult(
-        manager.create(
-            repo_name=repository_name,
-            url=url,
-            api_integration=api_integration,
-            secret=secret_name,
-        )
-    )
-
-
-@app.command(
-    "list-branches",
-    requires_connection=True,
-)
-def list_branches(
-    repository_name: FQN = RepoNameArgument,
-    like=like_option(
-        help_example='`list-branches --like "%_test"` lists all branches that end with "_test"'
-    ),
-    **options,
-) -> CommandResult:
-    """
-    List all branches in the repository.
-    """
-    return QueryResult(
-        GitManager().show_branches(repo_name=repository_name.identifier, like=like)
-    )
-
-
-@app.command(
-    "list-tags",
-    requires_connection=True,
-)
-def list_tags(
-    repository_name: FQN = RepoNameArgument,
-    like=like_option(
-        help_example='`list-tags --like "v2.0%"` lists all tags that start with "v2.0"'
-    ),
-    **options,
-) -> CommandResult:
-    """
-    List all tags in the repository.
-    """
-    return QueryResult(
-        GitManager().show_tags(repo_name=repository_name.identifier, like=like)
-    )
-
-
-@app.command(
-    "list-files",
-    requires_connection=True,
-)
-def list_files(
-    repository_path: str = RepoPathArgument,
-    pattern=PatternOption,
-    **options,
-) -> CommandResult:
-    """
-    List files from given state of git repository.
-    """
-    return QueryResult(
-        GitManager().list_files(stage_name=repository_path, pattern=pattern)
-    )
-
-
-@app.command(
-    "fetch",
-    requires_connection=True,
-)
-def fetch(
-    repository_name: FQN = RepoNameArgument,
-    **options,
-) -> CommandResult:
-    """
-    Fetch changes from origin to Snowflake repository.
-    """
-    return QueryResult(GitManager().fetch(fqn=repository_name))
-
-
-@app.command(
-    "copy",
-    requires_connection=True,
-)
-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,
-        help="Number of parallel threads to use when downloading files.",
-    ),
-    **options,
-):
-    """
-    Copies all files from given state of repository to local directory or stage.
-
-    If the source path ends with '/', the command copies contents of specified directory.
-    Otherwise, it creates a new directory or file in the destination directory.
-    """
-    is_copy = is_stage_path(destination_path)
-    if is_copy:
-        return QueryResult(
-            GitManager().copy_files(
-                source_path=repository_path, destination_path=destination_path
-            )
-        )
-    return get(
-        source_path=repository_path,
-        destination_path=destination_path,
-        parallel=parallel,
-    )
-
-
-@app.command("execute", requires_connection=True)
-def execute(
-    repository_path: str = RepoPathArgument,
-    on_error: OnErrorType = OnErrorOption,
-    variables: Optional[List[str]] = ExecuteVariablesOption,
-    **options,
-):
-    """
-    Execute immediate all files from the repository path. Files can be filtered with glob like pattern,
-    e.g. `@my_repo/branches/main/*.sql`, `@my_repo/branches/main/dev/*`. Only files with `.sql`
-    extension will be executed.
-    """
-    results = GitManager().execute(
-        stage_path=repository_path, on_error=on_error, variables=variables
-    )
-    return CollectionResult(results)
-
-
-def get(source_path: str, destination_path: str, parallel: int):
-    target = Path(destination_path).resolve()
-
-    cursors = GitManager().get_recursive(
-        stage_path=source_path, dest_path=target, parallel=parallel
-    )
-    results = [list(QueryResult(c).result) for c in cursors]
-    flattened_results = list(itertools.chain.from_iterable(results))
-    sorted_results = sorted(
-        flattened_results,
-        key=lambda e: (path.dirname(e["file"]), path.basename(e["file"])),
-    )
-    return CollectionResult(sorted_results)

snowflake/cli/_plugins/git/manager.py

@@ -1,151 +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, PurePosixPath
-from textwrap import dedent
-from typing import List
-
-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 = 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[OMIT_FIRST]
-        self.stage_name = "/".join([git_repo_name, *stage_path_parts[1:3], ""])
-        self.directory = "/".join(stage_path_parts[OMIT_STAGE])
-        self.is_directory = True if stage_path.endswith("/") else False
-
-    @property
-    def path(self) -> str:
-        return f"{self.stage_name.rstrip('/')}/{self.directory}"
-
-    @classmethod
-    def get_directory(cls, stage_path: str) -> str:
-        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:
-        return f"{self.stage.rstrip('/')}/{self.directory}"
-
-    def replace_stage_prefix(self, file_path: str) -> str:
-        stage = Path(self.stage).parts[0]
-        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:
-        stage = self.stage.rstrip("/")
-        return f"{stage}/{file_path.lstrip('/')}"
-
-    def get_directory_from_file_path(self, file_path: str) -> List[str]:
-        stage_path_length = len(Path(self.directory).parts)
-        return list(Path(file_path).parts[3 + stage_path_length : -1])
-
-
-class GitManager(StageManager):
-    def show_branches(self, repo_name: str, like: str) -> SnowflakeCursor:
-        return self._execute_query(f"show git branches like '{like}' in {repo_name}")
-
-    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, fqn: FQN) -> SnowflakeCursor:
-        return self._execute_query(f"alter git repository {fqn} fetch")
-
-    def create(
-        self, repo_name: FQN, api_integration: str, url: str, secret: str
-    ) -> SnowflakeCursor:
-        query = dedent(
-            f"""
-            create git repository {repo_name.sql_identifier}
-            api_integration = {api_integration}
-            origin = '{url}'
-            """
-        )
-        if secret is not None:
-            query += f"git_credentials = {secret}\n"
-        return self._execute_query(query)
-
-    @staticmethod
-    def get_stage_from_path(path: str):
-        """
-        Returns stage name from potential path on stage. For example
-        repo/branches/main/foo/bar -> repo/branches/main/
-        """
-        path_parts = GitManager.split_git_path(path)
-        return f"{'/'.join(path_parts[ONLY_STAGE])}/"
-
-    @staticmethod
-    def _stage_path_part_factory(stage_path: str) -> StagePathParts:
-        stage_path = StageManager.get_standard_stage_prefix(stage_path)
-        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/git/plugin_spec.py

@@ -1,30 +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 snowflake.cli._plugins.git import commands
-from snowflake.cli.api.plugins.command import (
-    SNOWCLI_ROOT_COMMAND_PATH,
-    CommandSpec,
-    CommandType,
-    plugin_hook_impl,
-)
-
-
-@plugin_hook_impl
-def command_spec():
-    return CommandSpec(
-        parent_command_path=SNOWCLI_ROOT_COMMAND_PATH,
-        command_type=CommandType.COMMAND_GROUP,
-        typer_instance=commands.app.create_instance(),
-    )

snowflake/cli/_plugins/helpers/__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/helpers/commands.py

@@ -1,90 +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 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/helpers/plugin_spec.py

@@ -1,30 +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 snowflake.cli._plugins.helpers import commands
-from snowflake.cli.api.plugins.command import (
-    SNOWCLI_ROOT_COMMAND_PATH,
-    CommandSpec,
-    CommandType,
-    plugin_hook_impl,
-)
-
-
-@plugin_hook_impl
-def command_spec():
-    return CommandSpec(
-        parent_command_path=SNOWCLI_ROOT_COMMAND_PATH,
-        command_type=CommandType.COMMAND_GROUP,
-        typer_instance=commands.app.create_instance(),
-    )

snowflake/cli/_plugins/init/__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.