snowflake-cli-labs 3.0.0rc2__py3-none-any.whl → 3.0.0rc4__py3-none-any.whl

snowflake/cli/api/project/definition_conversion.py

@@ -20,36 +20,62 @@ from snowflake.cli.api.entities.utils import render_script_template
 from snowflake.cli.api.project.schemas.entities.common import (
     SqlScriptHookType,
 )
-from snowflake.cli.api.project.schemas.native_app.application import (
-    Application,
-    ApplicationV11,
-)
-from snowflake.cli.api.project.schemas.native_app.native_app import NativeApp
-from snowflake.cli.api.project.schemas.native_app.package import Package, PackageV11
 from snowflake.cli.api.project.schemas.project_definition import (
     ProjectDefinition,
     ProjectDefinitionV2,
 )
-from snowflake.cli.api.project.schemas.snowpark.callable import (
+from snowflake.cli.api.project.schemas.v1.native_app.application import (
+    Application,
+    ApplicationV11,
+)
+from snowflake.cli.api.project.schemas.v1.native_app.native_app import NativeApp
+from snowflake.cli.api.project.schemas.v1.native_app.package import Package, PackageV11
+from snowflake.cli.api.project.schemas.v1.snowpark.callable import (
     FunctionSchema,
     ProcedureSchema,
 )
-from snowflake.cli.api.project.schemas.snowpark.snowpark import Snowpark
-from snowflake.cli.api.project.schemas.streamlit.streamlit import Streamlit
+from snowflake.cli.api.project.schemas.v1.snowpark.snowpark import Snowpark
+from snowflake.cli.api.project.schemas.v1.streamlit.streamlit import Streamlit
 from snowflake.cli.api.rendering.jinja import get_basic_jinja_env
 
 log = logging.getLogger(__name__)
 
 
+def _is_field_defined(template_context: Optional[Dict[str, Any]], *path: str) -> bool:
+    """
+    Determines if a field is defined in the provided template context. For example,
+
+    _is_field_defined({"ctx": {"native_app": {"bundle_root": "my_root"}}}, "ctx", "native_app", "bundle_root")
+
+    returns True. If the provided template context is None, this function returns True for all paths.
+
+    """
+    if template_context is None:
+        return True  # No context, so assume that all variables are defined
+
+    current_dict = template_context
+    for key in path:
+        if not isinstance(current_dict, dict):
+            return False
+        if key not in current_dict:
+            return False
+        current_dict = current_dict[key]
+
+    return True
+
+
 def convert_project_definition_to_v2(
-    project_root: Path, pd: ProjectDefinition, accept_templates: bool = False
+    project_root: Path,
+    pd: ProjectDefinition,
+    accept_templates: bool = False,
+    template_context: Optional[Dict[str, Any]] = None,
 ) -> ProjectDefinitionV2:
     _check_if_project_definition_meets_requirements(pd, accept_templates)
 
     snowpark_data = convert_snowpark_to_v2_data(pd.snowpark) if pd.snowpark else {}
     streamlit_data = convert_streamlit_to_v2_data(pd.streamlit) if pd.streamlit else {}
     native_app_data = (
-        convert_native_app_to_v2_data(project_root, pd.native_app)
+        convert_native_app_to_v2_data(project_root, pd.native_app, template_context)
         if pd.native_app
         else {}
     )
@@ -157,6 +183,7 @@ def convert_streamlit_to_v2_data(streamlit: Streamlit) -> Dict[str, Any]:
                 "type": "streamlit",
                 "identifier": identifier,
                 "title": streamlit.title,
+                "comment": streamlit.comment,
                 "query_warehouse": streamlit.query_warehouse,
                 "main_file": str(streamlit.main_file),
                 "pages_dir": str(streamlit.pages_dir),
@@ -169,7 +196,9 @@ def convert_streamlit_to_v2_data(streamlit: Streamlit) -> Dict[str, Any]:
 
 
 def convert_native_app_to_v2_data(
-    project_root, native_app: NativeApp
+    project_root,
+    native_app: NativeApp,
+    template_context: Optional[Dict[str, Any]] = None,
 ) -> Dict[str, Any]:
     def _make_meta(obj: Application | Package):
         meta = {}
@@ -249,14 +278,24 @@ def convert_native_app_to_v2_data(
         "identifier": package_identifier,
         "manifest": _find_manifest(),
         "artifacts": native_app.artifacts,
-        "bundle_root": native_app.bundle_root,
-        "generated_root": native_app.generated_root,
-        "deploy_root": native_app.deploy_root,
-        "stage": native_app.source_stage,
-        "scratch_stage": native_app.scratch_stage,
     }
+
+    if _is_field_defined(template_context, "ctx", "native_app", "bundle_root"):
+        package["bundle_root"] = native_app.bundle_root
+    if _is_field_defined(template_context, "ctx", "native_app", "generated_root"):
+        package["generated_root"] = native_app.generated_root
+    if _is_field_defined(template_context, "ctx", "native_app", "deploy_root"):
+        package["deploy_root"] = native_app.deploy_root
+    if _is_field_defined(template_context, "ctx", "native_app", "source_stage"):
+        package["stage"] = native_app.source_stage
+    if _is_field_defined(template_context, "ctx", "native_app", "scratch_stage"):
+        package["scratch_stage"] = native_app.scratch_stage
+
     if native_app.package:
-        package["distribution"] = native_app.package.distribution
+        if _is_field_defined(
+            template_context, "ctx", "native_app", "package", "distribution"
+        ):
+            package["distribution"] = native_app.package.distribution
         package_meta = _make_meta(native_app.package)
         if native_app.package.scripts:
             converted_post_deploy_hooks = _convert_package_script_files(
@@ -288,6 +327,10 @@ def convert_native_app_to_v2_data(
     if native_app.application:
         if app_meta := _make_meta(native_app.application):
             app["meta"] = app_meta
+        if _is_field_defined(
+            template_context, "ctx", "native_app", "application", "debug"
+        ):
+            app["debug"] = native_app.application.debug
 
     return {
         "entities": {

snowflake/cli/api/project/schemas/entities/common.py

@@ -15,11 +15,10 @@
 from __future__ import annotations
 
 from abc import ABC
-from typing import Generic, List, Optional, TypeVar, Union
+from typing import Dict, Generic, List, Optional, TypeVar, Union
 
 from pydantic import Field, PrivateAttr, field_validator
 from snowflake.cli.api.identifiers import FQN
-from snowflake.cli.api.project.schemas.identifier_model import Identifier
 from snowflake.cli.api.project.schemas.updatable_model import (
     IdentifierField,
     UpdatableModel,
@@ -61,6 +60,12 @@ class MetaField(UpdatableModel):
         return mixins
 
 
+class Identifier(UpdatableModel):
+    name: str = Field(title="Entity name")
+    schema_: Optional[str] = Field(title="Entity schema", alias="schema", default=None)
+    database: Optional[str] = Field(title="Entity database", default=None)
+
+
 class EntityModelBase(ABC, UpdatableModel):
     @classmethod
     def get_type(cls) -> str:
@@ -112,9 +117,17 @@ class TargetField(UpdatableModel, Generic[TargetType]):
         return self.__pydantic_generic_metadata__["args"][0]
 
 
-from typing import Dict, List, Optional
+class ImportsBaseModel:
+    imports: Optional[List[str]] = Field(
+        title="Stage and path to previously uploaded files you want to import",
+        default=[],
+    )
 
-from pydantic import Field
+    def get_imports_sql(self) -> str | None:
+        if not self.imports:
+            return None
+        imports = ", ".join(f"'{i}'" for i in self.imports)
+        return f"IMPORTS = ({imports})"
 
 
 class ExternalAccessBaseModel:

snowflake/cli/api/project/schemas/entities/entities.py

@@ -16,23 +16,24 @@ from __future__ import annotations
 
 from typing import Dict, List, Union, get_args
 
-from snowflake.cli.api.entities.application_entity import ApplicationEntity
-from snowflake.cli.api.entities.application_package_entity import (
-    ApplicationPackageEntity,
-)
-from snowflake.cli.api.entities.snowpark_entity import FunctionEntity, ProcedureEntity
-from snowflake.cli.api.entities.streamlit_entity import StreamlitEntity
-from snowflake.cli.api.project.schemas.entities.application_entity_model import (
+from snowflake.cli._plugins.nativeapp.entities.application import (
+    ApplicationEntity,
     ApplicationEntityModel,
 )
-from snowflake.cli.api.project.schemas.entities.application_package_entity_model import (
+from snowflake.cli._plugins.nativeapp.entities.application_package import (
+    ApplicationPackageEntity,
     ApplicationPackageEntityModel,
 )
-from snowflake.cli.api.project.schemas.entities.snowpark_entity import (
+from snowflake.cli._plugins.snowpark.snowpark_entity import (
+    FunctionEntity,
+    ProcedureEntity,
+)
+from snowflake.cli._plugins.snowpark.snowpark_entity_model import (
     FunctionEntityModel,
     ProcedureEntityModel,
 )
-from snowflake.cli.api.project.schemas.entities.streamlit_entity_model import (
+from snowflake.cli._plugins.streamlit.streamlit_entity import StreamlitEntity
+from snowflake.cli._plugins.streamlit.streamlit_entity_model import (
     StreamlitEntityModel,
 )
 

snowflake/cli/api/project/schemas/project_definition.py

@@ -19,10 +19,8 @@ from typing import Any, Dict, List, Optional, Union
 
 from packaging.version import Version
 from pydantic import Field, ValidationError, field_validator, model_validator
+from snowflake.cli._plugins.nativeapp.entities.application import ApplicationEntityModel
 from snowflake.cli.api.project.errors import SchemaValidationError
-from snowflake.cli.api.project.schemas.entities.application_entity_model import (
-    ApplicationEntityModel,
-)
 from snowflake.cli.api.project.schemas.entities.common import (
     TargetField,
 )
@@ -30,13 +28,13 @@ from snowflake.cli.api.project.schemas.entities.entities import (
     EntityModel,
     v2_entity_model_types_map,
 )
-from snowflake.cli.api.project.schemas.native_app.native_app import (
+from snowflake.cli.api.project.schemas.updatable_model import UpdatableModel
+from snowflake.cli.api.project.schemas.v1.native_app.native_app import (
     NativeApp,
     NativeAppV11,
 )
-from snowflake.cli.api.project.schemas.snowpark.snowpark import Snowpark
-from snowflake.cli.api.project.schemas.streamlit.streamlit import Streamlit
-from snowflake.cli.api.project.schemas.updatable_model import UpdatableModel
+from snowflake.cli.api.project.schemas.v1.snowpark.snowpark import Snowpark
+from snowflake.cli.api.project.schemas.v1.streamlit.streamlit import Streamlit
 from snowflake.cli.api.utils.types import Context
 from typing_extensions import Annotated
 

snowflake/cli/api/project/schemas/{identifier_model.py → v1/identifier_model.py}

@@ -19,16 +19,9 @@ from typing import Optional, cast
 from pydantic import Field
 from snowflake.cli.api.project.schemas.updatable_model import (
     IdentifierField,
-    UpdatableModel,
 )
 
 
-class Identifier(UpdatableModel):
-    name: str = Field(title="Entity name")
-    schema_: Optional[str] = Field(title="Entity schema", alias="schema", default=None)
-    database: Optional[str] = Field(title="Entity database", default=None)
-
-
 class ObjectIdentifierBaseModel:
     """
     Type representing a base class defining object that can be identified by fully qualified name (db.schema.name).

snowflake/cli/api/project/schemas/{native_app → v1/native_app}/native_app.py

@@ -18,13 +18,13 @@ import re
 from typing import List, Optional, Union
 
 from pydantic import Field, field_validator
-from snowflake.cli.api.project.schemas.native_app.application import (
+from snowflake.cli.api.project.schemas.updatable_model import UpdatableModel
+from snowflake.cli.api.project.schemas.v1.native_app.application import (
     Application,
     ApplicationV11,
 )
-from snowflake.cli.api.project.schemas.native_app.package import Package, PackageV11
-from snowflake.cli.api.project.schemas.native_app.path_mapping import PathMapping
-from snowflake.cli.api.project.schemas.updatable_model import UpdatableModel
+from snowflake.cli.api.project.schemas.v1.native_app.package import Package, PackageV11
+from snowflake.cli.api.project.schemas.v1.native_app.path_mapping import PathMapping
 from snowflake.cli.api.project.util import (
     SCHEMA_AND_NAME,
 )

snowflake/cli/api/project/schemas/{snowpark → v1/snowpark}/callable.py

@@ -17,9 +17,9 @@ from __future__ import annotations
 from typing import Dict, List, Optional, Union
 
 from pydantic import Field, field_validator
-from snowflake.cli.api.project.schemas.identifier_model import ObjectIdentifierModel
-from snowflake.cli.api.project.schemas.snowpark.argument import Argument
 from snowflake.cli.api.project.schemas.updatable_model import UpdatableModel
+from snowflake.cli.api.project.schemas.v1.identifier_model import ObjectIdentifierModel
+from snowflake.cli.api.project.schemas.v1.snowpark.argument import Argument
 
 
 class _CallableBase(UpdatableModel):

snowflake/cli/api/project/schemas/{snowpark → v1/snowpark}/snowpark.py

@@ -17,11 +17,11 @@ from __future__ import annotations
 from typing import List, Optional
 
 from pydantic import Field
-from snowflake.cli.api.project.schemas.snowpark.callable import (
+from snowflake.cli.api.project.schemas.updatable_model import UpdatableModel
+from snowflake.cli.api.project.schemas.v1.snowpark.callable import (
     FunctionSchema,
     ProcedureSchema,
 )
-from snowflake.cli.api.project.schemas.updatable_model import UpdatableModel
 
 
 class Snowpark(UpdatableModel):

snowflake/cli/api/project/schemas/{streamlit → v1/streamlit}/streamlit.py

@@ -18,8 +18,8 @@ from pathlib import Path
 from typing import List, Optional
 
 from pydantic import Field
-from snowflake.cli.api.project.schemas.identifier_model import ObjectIdentifierModel
 from snowflake.cli.api.project.schemas.updatable_model import UpdatableModel
+from snowflake.cli.api.project.schemas.v1.identifier_model import ObjectIdentifierModel
 
 
 class Streamlit(UpdatableModel, ObjectIdentifierModel(object_name="Streamlit")):  # type: ignore
@@ -44,3 +44,4 @@ class Streamlit(UpdatableModel, ObjectIdentifierModel(object_name="Streamlit")):
     title: Optional[str] = Field(
         title="Human-readable title for the Streamlit dashboard", default=None
     )
+    comment: Optional[str] = Field(title="Comment for the Streamlit app", default=None)

snowflake/cli/api/rendering/sql_templates.py

@@ -21,6 +21,7 @@ from jinja2 import Environment, StrictUndefined, loaders, meta
 from snowflake.cli.api.cli_global_context import get_cli_context
 from snowflake.cli.api.console.console import cli_console
 from snowflake.cli.api.exceptions import InvalidTemplate
+from snowflake.cli.api.metrics import CLICounterField
 from snowflake.cli.api.rendering.jinja import (
     CONTEXT_KEY,
     FUNCTION_KEY,
@@ -96,4 +97,9 @@ def snowflake_sql_jinja_render(content: str, data: Dict | None = None) -> str:
     context_data = get_cli_context().template_context
     context_data.update(data)
     env = choose_sql_jinja_env_based_on_template_syntax(content)
+
+    get_cli_context().metrics.set_counter(
+        CLICounterField.SQL_TEMPLATES, int(has_sql_templates(content))
+    )
+
     return env.from_string(content).render(context_data)

snowflake/cli/api/rest_api.py

@@ -21,8 +21,9 @@ from typing import Any, Dict, Optional
 from click import ClickException
 from snowflake.cli.api.constants import SF_REST_API_URL_PREFIX
 from snowflake.connector.connection import SnowflakeConnection
-from snowflake.connector.errors import BadRequest, InterfaceError
+from snowflake.connector.errors import BadRequest
 from snowflake.connector.network import SnowflakeRestful
+from snowflake.connector.vendored.requests.exceptions import HTTPError
 
 log = logging.getLogger(__name__)
 
@@ -47,10 +48,10 @@ class RestApi:
         Check whether [get] endpoint exists under given URL.
         """
         try:
-            result = self.send_rest_request(url, method="get")
-            return bool(result) or result == []
-        except InterfaceError as err:
-            if "404 Not Found" in str(err):
+            self.send_rest_request(url, method="get")
+            return True
+        except HTTPError as err:
+            if err.response.status_code == 404:
                 return False
             raise err
 
@@ -60,6 +61,10 @@ class RestApi:
             return bool(result)
         except BadRequest:
             return False
+        except HTTPError as err:
+            if err.response.status_code == 404:
+                return False
+            raise err
 
     def send_rest_request(
         self, url: str, method: str, data: Optional[Dict[str, Any]] = None
@@ -91,6 +96,7 @@ class RestApi:
             token=self.rest.token,
             data=json.dumps(data if data else {}),
             no_retry=True,
+            raise_raw_http_failure=True,
         )
 
     def _database_exists(self, db_name: str) -> bool:

snowflake/cli/api/sql_execution.py

@@ -98,11 +98,7 @@ class SqlExecutor:
             )
 
     def current_role(self) -> str:
-        *_, cursor = self._execute_string(
-            "select current_role()", cursor_class=DictCursor
-        )
-        role_result = cursor.fetchone()
-        return role_result["CURRENT_ROLE()"]
+        return self._execute_query(f"select current_role()").fetchone()[0]
 
     @contextmanager
     def use_role(self, new_role: str):
@@ -110,10 +106,7 @@ class SqlExecutor:
         Switches to a different role for a while, then switches back.
         This is a no-op if the requested role is already active.
         """
-        role_result = self._execute_query(
-            f"select current_role()", cursor_class=DictCursor
-        ).fetchone()
-        prev_role = role_result["CURRENT_ROLE()"]
+        prev_role = self.current_role()
         is_different_role = new_role.lower() != prev_role.lower()
         if is_different_role:
             self._log.debug("Assuming different role: %s", new_role)
@@ -126,9 +119,9 @@ class SqlExecutor:
 
     def session_has_warehouse(self) -> bool:
         result = self._execute_query(
-            "select current_warehouse() is not null as result", cursor_class=DictCursor
+            "select current_warehouse() is not null"
         ).fetchone()
-        return bool(result.get("RESULT"))
+        return bool(result[0])
 
     @contextmanager
     def use_warehouse(self, new_wh: str):
@@ -138,12 +131,10 @@ class SqlExecutor:
         If there is no default warehouse in the account, it will throw an error.
         """
 
-        wh_result = self._execute_query(
-            f"select current_warehouse()", cursor_class=DictCursor
-        ).fetchone()
+        wh_result = self._execute_query(f"select current_warehouse()").fetchone()
         # If user has an assigned default warehouse, prev_wh will contain a value even if the warehouse is suspended.
         try:
-            prev_wh = wh_result["CURRENT_WAREHOUSE()"]
+            prev_wh = wh_result[0]
         except:
             prev_wh = None
 

snowflake/cli/api/utils/definition_rendering.py

@@ -19,8 +19,10 @@ from typing import Any, Optional
 
 from jinja2 import Environment, TemplateSyntaxError, nodes
 from packaging.version import Version
+from snowflake.cli.api.cli_global_context import get_cli_context
 from snowflake.cli.api.console import cli_console as cc
 from snowflake.cli.api.exceptions import CycleDetectedError, InvalidTemplate
+from snowflake.cli.api.metrics import CLICounterField
 from snowflake.cli.api.project.schemas.project_definition import (
     ProjectProperties,
     build_project_definition,
@@ -266,6 +268,12 @@ def _get_referenced_vars_in_definition(
     return referenced_vars
 
 
+def _has_referenced_vars_in_definition(
+    template_env: TemplatedEnvironment, definition: Definition
+) -> bool:
+    return len(_get_referenced_vars_in_definition(template_env, definition)) > 0
+
+
 def _template_version_warning():
     cc.warning(
         "Ignoring template pattern in project definition file. "
@@ -291,6 +299,17 @@ def _add_defaults_to_definition(original_definition: Definition) -> Definition:
     return definition_with_defaults
 
 
+def _update_metrics(template_env: TemplatedEnvironment, definition: Definition):
+    metrics = get_cli_context().metrics
+
+    # render_definition_template is invoked multiple times both by the user
+    # and by us so we should make sure we don't overwrite a 1 with a 0 here
+    metrics.set_counter_default(CLICounterField.PDF_TEMPLATES, 0)
+
+    if _has_referenced_vars_in_definition(template_env, definition):
+        metrics.set_counter(CLICounterField.PDF_TEMPLATES, 1)
+
+
 def render_definition_template(
     original_definition: Optional[Definition], context_overrides: Context
 ) -> ProjectProperties:
@@ -326,10 +345,7 @@ def render_definition_template(
         definition["definition_version"]
     ) < Version("1.1"):
         try:
-            referenced_vars = _get_referenced_vars_in_definition(
-                template_env, definition
-            )
-            if referenced_vars:
+            if _has_referenced_vars_in_definition(template_env, definition):
                 _template_version_warning()
         except Exception:
             # also warn on Exception, as it means the user is incorrectly attempting to use templating
@@ -340,6 +356,10 @@ def render_definition_template(
         project_context[CONTEXT_KEY]["env"] = environment_overrides
         return ProjectProperties(project_definition, project_context)
 
+    # need to have the metrics added here since we add defaults to the
+    # definition that the user might not have added themselves later
+    _update_metrics(template_env, definition)
+
     definition = _add_defaults_to_definition(definition)
     project_context = {CONTEXT_KEY: definition}
 

{snowflake_cli_labs-3.0.0rc2.dist-info → snowflake_cli_labs-3.0.0rc4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: snowflake-cli-labs
-Version: 3.0.0rc2
+Version: 3.0.0rc4
 Summary: Snowflake CLI
 Project-URL: Source code, https://github.com/snowflakedb/snowflake-cli
 Project-URL: Bug Tracker, https://github.com/snowflakedb/snowflake-cli/issues
@@ -222,14 +222,14 @@ Requires-Dist: jinja2==3.1.4
 Requires-Dist: packaging
 Requires-Dist: pip
 Requires-Dist: pluggy==1.5.0
-Requires-Dist: pydantic==2.9.1
+Requires-Dist: pydantic==2.9.2
 Requires-Dist: pyyaml==6.0.2
 Requires-Dist: requests==2.32.3
 Requires-Dist: requirements-parser==0.11.0
-Requires-Dist: rich==13.8.0
-Requires-Dist: setuptools==74.1.2
-Requires-Dist: snowflake-connector-python[secure-local-storage]==3.12.1
-Requires-Dist: snowflake-core==0.8.0; python_version < '3.12'
+Requires-Dist: rich==13.8.1
+Requires-Dist: setuptools==75.1.0
+Requires-Dist: snowflake-connector-python[secure-local-storage]==3.12.2
+Requires-Dist: snowflake-core==0.12.1; python_version < '3.12'
 Requires-Dist: snowflake-snowpark-python>=1.15.0; python_version < '3.12'
 Requires-Dist: tomlkit==0.13.2
 Requires-Dist: typer==0.12.5
@@ -238,8 +238,10 @@ Provides-Extra: development
 Requires-Dist: coverage==7.6.1; extra == 'development'
 Requires-Dist: pre-commit>=3.5.0; extra == 'development'
 Requires-Dist: pytest-randomly==3.15.0; extra == 'development'
-Requires-Dist: pytest==8.3.2; extra == 'development'
+Requires-Dist: pytest==8.3.3; extra == 'development'
 Requires-Dist: syrupy==4.7.1; extra == 'development'
+Provides-Extra: packaging
+Requires-Dist: pyinstaller~=6.10; extra == 'packaging'
 Description-Content-Type: text/markdown
 
 <!--