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

snowflake/cli/_app/dev/docs/commands_docs_generator.py

@@ -1,118 +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 Any, List, Optional
-
-from click import Command
-from snowflake.cli._app.dev.docs.template_utils import get_template_environment
-from snowflake.cli.api.secure_path import SecurePath
-from typer.core import TyperArgument
-
-log = logging.getLogger(__name__)
-
-CMD_USAGE_TMPL = "usage.rst.jinja2"
-OVERVIEW_TMPL = "overview.rst.jinja2"
-
-
-def generate_command_docs(
-    root: SecurePath, command: Command, cmd_parts: Optional[List] = None
-):
-    """
-    Iterates recursively through commands info. Creates a file structure resembling
-    commands structure. For each terminal command creates a "usage" rst file.
-    """
-    if getattr(command, "hidden", False):
-        return
-
-    root.mkdir(exist_ok=True)
-    if cmd_parts is None:
-        _render_command_usage(command, root, cmd_parts, template_name=OVERVIEW_TMPL)
-
-    cmd_parts = cmd_parts or []
-    if hasattr(command, "commands"):
-        for command_name, command_info in command.commands.items():
-            path = root / command.name if command.name != "default" else root
-            generate_command_docs(path, command_info, [*cmd_parts, command_name])
-    else:
-        _render_command_usage(command, root, cmd_parts)
-
-
-def get_main_option(options: List[str]) -> str:
-    long_options = [option for option in options if option.startswith("--")]
-    if long_options:
-        return long_options[0]
-
-    short_options = [option for option in options if option.startswith("-")]
-    if short_options:
-        return short_options[0]
-
-    return ""
-
-
-def _render_command_usage(
-    command: Command,
-    root: SecurePath,
-    path: Optional[List] = None,
-    template_name: str = CMD_USAGE_TMPL,
-):
-    # This is end command
-    command_name = command.name
-    env = get_template_environment()
-    env.filters[get_main_option.__name__] = get_main_option
-    template = env.get_template(template_name)
-    arguments = []
-    options = []
-    for param in command.params:
-        if isinstance(param, TyperArgument):
-            arguments.append(param)
-        else:
-            options.append(param)
-
-    # RST files are presumed to be standalone pages in the docs with a matching item in the left nav.
-    # Included files, which these are, need to use the .txt extension.
-    file_path = root / f"usage-{command_name}.txt"
-    log.info("Creating %s", file_path)
-    command_help_params = _split_docstring(command.help)
-    template_params = {
-        "name": command_name,
-        "options": options,
-        "arguments": arguments,
-        "path": path,
-    }
-    with file_path.open("w+") as fh:
-        fh.write(template.render(command_help_params | template_params))
-
-
-def _split_docstring(command_help: Optional[str]) -> dict[str, Any]:
-    if command_help is None:
-        return {}
-
-    split_command_help = command_help.split("## ")
-
-    if len(split_command_help) == 1:
-        return {"help": split_command_help[0]}
-
-    additional_sections = []
-    for section in split_command_help[1:]:
-        lines = section.split("\n")
-        additional_sections.append(
-            {"title": lines[0], "content": "\n".join(lines[1:]).strip()}
-        )
-    return {
-        "help": split_command_help[0],
-        "additional_sections": additional_sections,
-    }

snowflake/cli/_app/dev/docs/generator.py

@@ -1,35 +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 click import Command
-from snowflake.cli._app.dev.docs.commands_docs_generator import generate_command_docs
-from snowflake.cli._app.dev.docs.project_definition_docs_generator import (
-    generate_project_definition_docs,
-)
-from snowflake.cli.api.secure_path import SecurePath
-
-log = logging.getLogger(__name__)
-
-
-def generate_docs(root: SecurePath, command: Command):
-    """
-    Generates documentation for each command, its options and for the project definition.
-    """
-    root.mkdir(exist_ok=True)
-    generate_command_docs(root / "commands", command)
-    generate_project_definition_docs(root / "project_definition")

snowflake/cli/_app/dev/docs/project_definition_docs_generator.py

@@ -1,58 +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 Any, Dict
-
-from pydantic.json_schema import model_json_schema
-from snowflake.cli._app.dev.docs.project_definition_generate_json_schema import (
-    ProjectDefinitionGenerateJsonSchema,
-)
-from snowflake.cli._app.dev.docs.template_utils import get_template_environment
-from snowflake.cli.api.project.schemas.project_definition import DefinitionV11
-from snowflake.cli.api.secure_path import SecurePath
-
-log = logging.getLogger(__name__)
-
-DEFINITION_DESCRIPTION = "definition_description.rst.jinja2"
-
-
-def generate_project_definition_docs(root: SecurePath):
-    """
-    Recursively traverses the generated project definition schema,
-    creating a file for each section that mirrors the YAML structure.
-    Each file contains the definition for every field within that section.
-    """
-
-    root.mkdir(exist_ok=True)
-    list_of_sections = model_json_schema(
-        DefinitionV11, schema_generator=ProjectDefinitionGenerateJsonSchema
-    )["result"]
-    for section in list_of_sections:
-        _render_definition_description(root, section)
-    return
-
-
-def _render_definition_description(root: SecurePath, section: Dict[str, Any]) -> None:
-    env = get_template_environment()
-
-    # RST files are presumed to be standalone pages in the docs with a matching item in the left nav.
-    # Included files, which these are, need to use the .txt extension.
-    file_path = root / f"definition_{section['name']}.txt"
-    log.info("Creating %s", file_path)
-    template = env.get_template(DEFINITION_DESCRIPTION)
-    with file_path.open("w+") as fh:
-        fh.write(template.render(section))

snowflake/cli/_app/dev/docs/project_definition_generate_json_schema.py

@@ -1,227 +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 dataclasses import asdict, dataclass
-from typing import Any, Dict, List, Tuple
-
-from pydantic.json_schema import GenerateJsonSchema
-
-
-@dataclass
-class ProjectDefinitionProperty:
-    """
-    Class for storing data of properties to be used in project definition generators.
-    """
-
-    path: str
-    title: str
-    indents: int
-    item_index: int
-    required: bool
-    name: str
-    description: str
-    add_types: bool
-    types: str
-
-
-class ProjectDefinitionGenerateJsonSchema(GenerateJsonSchema):
-    def __init__(self, by_alias: bool = False, ref_template: str = ""):
-        super().__init__(by_alias, "{model}")
-        self._remapped_definitions: Dict[str, Any] = {}
-
-    def generate(self, schema, mode="validation"):
-        """
-        Transforms the generated json from the model to a list of project definition sections with its properties.
-        For example:
-        {
-            "result": [
-                {
-                    "title": "Native app definitions for the project",
-                    "name": "native_app",
-                    "properties": [
-                        {
-                            "path": "Version of the project definition schema, which is currently 1",
-                            "title": "Title of field A",
-                            "indents": 0,
-                            "item_index": 0,
-                            "required": True,
-                            "name": "definition_version",
-                            "add_types": True,
-                            "types": "string | integer",
-                        },
-                        {
-                            "path": "native_app.name",
-                            "title": "Project identifier",
-                            "indents": 1,
-                            "item_index": 0,
-                            "required": True,
-                            "name": "name",
-                            "add_types": True,
-                            "types": "string",
-                        }
-                    ]
-                }
-            ]
-        }
-        """
-        json_schema = super().generate(schema, mode=mode)
-        self._remapped_definitions = json_schema["$defs"]
-        return {"result": self._get_definition_sections(json_schema)}
-
-    def _get_definition_sections(
-        self, current_definition: Dict[str, Any]
-    ) -> List[Dict[str, Any]]:
-        required_properties: List[Dict[str, Any]] = []
-        sections: List[Dict[str, Any]] = []
-
-        for property_name, property_model in current_definition["properties"].items():
-            is_required = (
-                "required" in current_definition
-                and property_name in current_definition["required"]
-            )
-            children_properties = self._get_children_properties(
-                property_model, property_name
-            )
-
-            new_property = ProjectDefinitionProperty(
-                path=property_name,
-                title=property_model.get("title", ""),
-                description=property_model.get("description", ""),
-                indents=0,
-                item_index=0,
-                required=is_required,
-                name=property_name,
-                add_types=len(children_properties) == 0,
-                types=" | ".join(self._get_property_types(property_model)),
-            )
-            properties = [asdict(new_property)] + children_properties
-
-            if is_required:
-                required_properties.extend(properties)
-            else:
-                sections.append(
-                    {
-                        "properties": properties,
-                        "title": property_model["title"],
-                        "name": property_name,
-                    }
-                )
-
-        for section in sections:
-            section["properties"] = required_properties + section["properties"]
-
-        return sections
-
-    def _get_section_properties(
-        self,
-        current_definition: Dict[str, Any],
-        current_path: str = "",
-        depth: int = 0,
-        is_array_item: bool = False,
-    ) -> List[Dict[str, Any]]:
-        required_properties: List[Dict[str, Any]] = []
-        optional_properties: List[Dict[str, Any]] = []
-        item_index = 0
-
-        for property_name, property_model in current_definition["properties"].items():
-            item_index += 1 if is_array_item else 0
-            is_required = (
-                "required" in current_definition
-                and property_name in current_definition["required"]
-            )
-            new_current_path = (
-                property_name
-                if current_path == ""
-                else current_path + "." + property_name
-            )
-            children_properties = self._get_children_properties(
-                property_model, new_current_path, depth
-            )
-            new_property = ProjectDefinitionProperty(
-                path=new_current_path,
-                title=property_model.get("title", ""),
-                description=property_model.get("description", ""),
-                indents=depth,
-                item_index=item_index,
-                required=is_required,
-                name=property_name,
-                add_types=len(children_properties) == 0,
-                types=" | ".join(self._get_property_types(property_model)),
-            )
-            properties = [asdict(new_property)] + children_properties
-            if is_required:
-                required_properties.extend(properties)
-            else:
-                optional_properties.extend(properties)
-        return required_properties + optional_properties
-
-    def _get_children_properties(
-        self,
-        property_model: Dict[str, Any],
-        current_path: str,
-        depth: int = 0,
-    ) -> List[Dict[str, Any]]:
-        child_properties: List[Dict[str, Any]] = []
-        references: List[Tuple[str, bool]] = self._get_property_references(
-            property_model
-        )
-        for reference, is_array_item in references:
-            child_properties.extend(
-                self._get_section_properties(
-                    self._remapped_definitions[reference],
-                    current_path,
-                    depth + 1,
-                    is_array_item,
-                )
-            )
-
-        return child_properties
-
-    def _get_property_references(
-        self,
-        model_with_type: Dict[str, Any],
-        is_array_item: bool = False,
-    ) -> list[tuple[str, bool]]:
-        result: List[Tuple[str, bool]] = []
-
-        if "$ref" in model_with_type:
-            return [(model_with_type["$ref"], is_array_item)]
-
-        if "type" in model_with_type and model_with_type["type"] == "array":
-            result.extend(self._get_property_references(model_with_type["items"], True))
-
-        if "anyOf" in model_with_type:
-            for property_type in model_with_type["anyOf"]:
-                result.extend(
-                    self._get_property_references(property_type, is_array_item)
-                )
-        return result
-
-    def _get_property_types(self, model_with_type: Dict[str, Any]) -> list[str]:
-        types_result: List[str] = []
-        if "type" in model_with_type:
-            if model_with_type["type"] == "array":
-                items_types = self._get_property_types(model_with_type["items"])
-                if len(items_types) > 0:
-                    types_result.append(f"array[{' | '.join(items_types)}]")
-
-            elif model_with_type["type"] != "null":
-                types_result.append(model_with_type["type"])
-        elif "anyOf" in model_with_type:
-            for property_type in model_with_type["anyOf"]:
-                types = self._get_property_types(property_type)
-                types_result.extend(types)
-        return types_result

snowflake/cli/_app/dev/docs/template_utils.py

@@ -1,23 +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 pathlib import Path
-
-from jinja2 import Environment, FileSystemLoader
-
-_TEMPLATE_PATH = Path(__file__).parent / "templates"
-
-
-def get_template_environment() -> Environment:
-    return Environment(loader=FileSystemLoader(_TEMPLATE_PATH))

snowflake/cli/_app/dev/docs/templates/definition_description.rst.jinja2

@@ -1,38 +0,0 @@
-{{ title }}
-
-Project definition structure
-===============================================================================
-
-.. code-block::
-
-{% for property in properties %}
-{{ "  "*(property["indents"] + 1) + ("- " if property["item_index"] == 1 else "") + ("  " if property["item_index"] > 1 else "") + property["name"] }}: {% if property["add_types"] %}<{{ property["types"] }}>{% endif %}
-{%- endfor %}
-
-
-Project definition properties
-===============================================================================
-{%- if properties %}
-The following table describes the project definition properties.
-
-.. list-table:: Project definition properties
-  :widths: 30 70
-  :header-rows: 1
-
-  * - Property
-    - Definition
-{% for property in properties %}
-  * - **{{property["path"]}}**
-
-      *{{"Required" if property["required"] else "Optional"}}*{{ (", *"+property["types"]+"*") if property["types"]}}
-
-    - {{property["title"]}}
-{% if property["description"] %}
-      {{ property["description"] }}
-{% else %}{% endif -%}
-{%+ endfor %}
-{% else %}
-
-None
-
-{% endif -%}

snowflake/cli/_app/dev/docs/templates/overview.rst.jinja2

@@ -1,9 +0,0 @@
-{{ help }}
-
-
-Global options
-===============================================================================
-{% for param in options if not param.hidden %}
-:samp:`{% for p in param.opts %}{{ p }}{{ ", " if not loop.last }}{% endfor %}{% if not param.is_flag %} {{ '{' }}{{ param.name }}{{ '}' }}{% endif %}`
-{% if param.help %}{{ "  " + param.help | replace("`", "``") }}{% if param.help[-1] != '.' %}.{% endif %}{% else %}  TBD{% endif %}
-{% endfor %}

snowflake/cli/_app/dev/docs/templates/usage.rst.jinja2

@@ -1,67 +0,0 @@
-{{ help | replace("`", "``") | replace("\n", " ") }}
-
-Syntax
-===============================================================================
-
-.. code-block:: console
-
-  snow {% for part in path %}{{ part }}{{ " " if not loop.last }}{% endfor %}
-{%- for param in arguments if not param.hidden %}
-    <{{ param.name }}>
-{%- endfor %}
-{%- for param in options if not param.hidden %}
-    {{ (param.opts | get_main_option) }}{% if not param.is_flag %} <{{ param.name }}>{% endif %}
-    {%- if param.type.name == "boolean" and param.secondary_opts|length > 0  %} {{ "/ " }}{{ param.secondary_opts[0] }}{% endif %}
-{%- endfor %}
-
-Arguments
-===============================================================================
-
-{%- if arguments %}
-{% for param in arguments %}
-:samp:`{{ '{' }}
-    {%- if param.required -%}
-        {{ param.make_metavar().lower() }}
-    {%- else -%}
-        {{ param.make_metavar().replace("[", "").replace("]", "").lower() }}
-    {%- endif -%}
-    {{ '}' }}`
-{% if param.help %}{{ "  " + param.help | replace("`", "``") | replace("\n", " ") }}{% if param.help[-1] != '.' %}.{% endif %}{% if param.default %} Default: {{ param.default }}.{% endif %}{% else %}  TBD{% endif %}
-{% endfor %}
-{% else %}
-
-None
-
-{% endif -%}
-
-Options
-===============================================================================
-
-{%- if options %}
-{% for param in options if not param.hidden %}
-:samp:`{% if param.type.name == "boolean" %}
-        {%- for p in param.opts %}{{ p }}{{ ", " if not loop.last }}{% endfor %}{% if param.secondary_opts|length > 0  %} {{ "/ " }}{{ param.secondary_opts[0] }}{% endif %}
-    {%- else %}
-        {%- for p in param.opts %}{{ p }}{{ ", " if not loop.last }}{% endfor %}
-    {%- endif %}
-    {%- if not param.is_flag %}
-        {%- if param.type.name != "choice" %}{{ ' {' }}{% else %} {% endif %}{{ param.make_metavar() }}{% if param.type.name != "choice" %}{{ '}' }}
-        {%- endif %}
-    {%- endif %}`
-{% if param.help %}{{ "  " + param.help | replace("`", "``") | replace("\n", " ") }}{% if param.help[-1] != '.' %}.{% endif %}{% if param.default is not none %} Default: {{ param.default }}.{% endif %}{% else %}  TBD{% endif %}
-{% endfor -%}
-{% else %}
-
-None
-
-{% endif -%}
-
-{%- if additional_sections %}
-..
-{%- for section in additional_sections %}
-  {{ section.title }}
-  ===============================================================================
-
-  {{ section.content | indent(2) }}
-{% endfor %}
-{% endif %}

snowflake/cli/_app/dev/pycharm_remote_debug.py

@@ -1,46 +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 typing import Optional
-
-from click import ClickException
-
-
-def setup_pycharm_remote_debugger_if_provided(
-    pycharm_debug_library_path: Optional[str],
-    pycharm_debug_server_host: Optional[str],
-    pycharm_debug_server_port: Optional[int],
-):
-    if pycharm_debug_library_path:
-        if (
-            pycharm_debug_server_host is not None
-            and pycharm_debug_server_port is not None
-        ):
-            import sys
-
-            sys.path.append(pycharm_debug_library_path)
-            import pydevd_pycharm
-
-            pydevd_pycharm.settrace(
-                pycharm_debug_server_host,
-                port=pycharm_debug_server_port,
-                stdoutToServer=True,
-                stderrToServer=True,
-            )
-        else:
-            raise ClickException(
-                "Debug server host and port have to be provided to use PyCharm remote debugger"
-            )