Rename example_project module, capitalize class constants

Author: treysp

sqlmesh/cli/main.py

@@ -9,7 +9,7 @@
 from sqlmesh import configure_logging, remove_excess_logs
 from sqlmesh.cli import error_handler
 from sqlmesh.cli import options as opt
-from sqlmesh.cli.example_project import (
+from sqlmesh.cli.project_init import (
     ProjectTemplate,
     init_example_project,
     InitCliMode,

sqlmesh/cli/example_project.py sqlmesh/cli/project_init.pysqlmesh/cli/example_project.py renamed to sqlmesh/cli/project_init.py

@@ -122,13 +122,11 @@ def _gen_config(
     default_configs[ProjectTemplate.DLT] = default_configs[ProjectTemplate.DEFAULT]
 
     simple_cli_mode = """
-# --- SIMPLE CLI MODE ---
 # Minimal prompts, automatic changes, summary output
 # https://sqlmesh.readthedocs.io/en/stable/reference/configuration/#plan
 
 plan:
   no_diff: true             # Hide detailed text differences for changed models
-  use_finalized_state: true # Compare only against finalized snapshots
   no_prompts: true          # No interactive prompts
   auto_apply: true          # Apply changes automatically
 

sqlmesh/core/config/connection.py

@@ -87,9 +87,9 @@ def validate(cls: t.Any, data: t.Any) -> t.Any:
 
 class ConnectionConfig(abc.ABC, BaseConfig):
     type_: str
-    dialect: t.ClassVar[str]
-    display_name: t.ClassVar[str]
-    display_order: t.ClassVar[int]
+    DIALECT: t.ClassVar[str]
+    DISPLAY_NAME: t.ClassVar[str]
+    DISPLAY_ORDER: t.ClassVar[int]
     concurrent_tasks: int
     register_comments: bool
     pre_ping: bool
@@ -466,9 +466,9 @@ class MotherDuckConnectionConfig(BaseDuckDBConnectionConfig):
     """Configuration for the MotherDuck connection."""
 
     type_: t.Literal["motherduck"] = Field(alias="type", default="motherduck")
-    dialect: t.ClassVar[t.Literal["duckdb"]] = "duckdb"
-    display_name: t.ClassVar[t.Literal["MotherDuck"]] = "MotherDuck"
-    display_order: t.ClassVar[t.Literal[5]] = 5
+    DIALECT: t.ClassVar[t.Literal["duckdb"]] = "duckdb"
+    DISPLAY_NAME: t.ClassVar[t.Literal["MotherDuck"]] = "MotherDuck"
+    DISPLAY_ORDER: t.ClassVar[t.Literal[5]] = 5
 
     @property
     def _connection_kwargs_keys(self) -> t.Set[str]:
@@ -493,9 +493,9 @@ class DuckDBConnectionConfig(BaseDuckDBConnectionConfig):
     """Configuration for the DuckDB connection."""
 
     type_: t.Literal["duckdb"] = Field(alias="type", default="duckdb")
-    dialect: t.ClassVar[t.Literal["duckdb"]] = "duckdb"
-    display_name: t.ClassVar[t.Literal["DuckDB"]] = "DuckDB"
-    display_order: t.ClassVar[t.Literal[1]] = 1
+    DIALECT: t.ClassVar[t.Literal["duckdb"]] = "duckdb"
+    DISPLAY_NAME: t.ClassVar[t.Literal["DuckDB"]] = "DuckDB"
+    DISPLAY_ORDER: t.ClassVar[t.Literal[1]] = 1
 
 
 class SnowflakeConnectionConfig(ConnectionConfig):
@@ -546,9 +546,9 @@ class SnowflakeConnectionConfig(ConnectionConfig):
     session_parameters: t.Optional[dict] = None
 
     type_: t.Literal["snowflake"] = Field(alias="type", default="snowflake")
-    dialect: t.ClassVar[t.Literal["snowflake"]] = "snowflake"
-    display_name: t.ClassVar[t.Literal["Snowflake"]] = "Snowflake"
-    display_order: t.ClassVar[t.Literal[2]] = 2
+    DIALECT: t.ClassVar[t.Literal["snowflake"]] = "snowflake"
+    DISPLAY_NAME: t.ClassVar[t.Literal["Snowflake"]] = "Snowflake"
+    DISPLAY_ORDER: t.ClassVar[t.Literal[2]] = 2
 
     _concurrent_tasks_validator = concurrent_tasks_validator
 
@@ -745,9 +745,9 @@ class DatabricksConnectionConfig(ConnectionConfig):
     pre_ping: t.Literal[False] = False
 
     type_: t.Literal["databricks"] = Field(alias="type", default="databricks")
-    dialect: t.ClassVar[t.Literal["databricks"]] = "databricks"
-    display_name: t.ClassVar[t.Literal["Databricks"]] = "Databricks"
-    display_order: t.ClassVar[t.Literal[3]] = 3
+    DIALECT: t.ClassVar[t.Literal["databricks"]] = "databricks"
+    DISPLAY_NAME: t.ClassVar[t.Literal["Databricks"]] = "Databricks"
+    DISPLAY_ORDER: t.ClassVar[t.Literal[3]] = 3
 
     _concurrent_tasks_validator = concurrent_tasks_validator
     _http_headers_validator = http_headers_validator
@@ -1004,9 +1004,9 @@ class BigQueryConnectionConfig(ConnectionConfig):
     pre_ping: t.Literal[False] = False
 
     type_: t.Literal["bigquery"] = Field(alias="type", default="bigquery")
-    dialect: t.ClassVar[t.Literal["bigquery"]] = "bigquery"
-    display_name: t.ClassVar[t.Literal["BigQuery"]] = "BigQuery"
-    display_order: t.ClassVar[t.Literal[4]] = 4
+    DIALECT: t.ClassVar[t.Literal["bigquery"]] = "bigquery"
+    DISPLAY_NAME: t.ClassVar[t.Literal["BigQuery"]] = "BigQuery"
+    DISPLAY_ORDER: t.ClassVar[t.Literal[4]] = 4
 
     _engine_import_validator = _get_engine_import_validator("google.cloud.bigquery", "bigquery")
 
@@ -1149,9 +1149,9 @@ class GCPPostgresConnectionConfig(ConnectionConfig):
     driver: str = "pg8000"
 
     type_: t.Literal["gcp_postgres"] = Field(alias="type", default="gcp_postgres")
-    dialect: t.ClassVar[t.Literal["postgres"]] = "postgres"
-    display_name: t.ClassVar[t.Literal["GCP Postgres"]] = "GCP Postgres"
-    display_order: t.ClassVar[t.Literal[13]] = 13
+    DIALECT: t.ClassVar[t.Literal["postgres"]] = "postgres"
+    DISPLAY_NAME: t.ClassVar[t.Literal["GCP Postgres"]] = "GCP Postgres"
+    DISPLAY_ORDER: t.ClassVar[t.Literal[13]] = 13
 
     concurrent_tasks: int = 4
     register_comments: bool = True
@@ -1287,9 +1287,9 @@ class RedshiftConnectionConfig(ConnectionConfig):
     pre_ping: bool = False
 
     type_: t.Literal["redshift"] = Field(alias="type", default="redshift")
-    dialect: t.ClassVar[t.Literal["redshift"]] = "redshift"
-    display_name: t.ClassVar[t.Literal["Redshift"]] = "Redshift"
-    display_order: t.ClassVar[t.Literal[7]] = 7
+    DIALECT: t.ClassVar[t.Literal["redshift"]] = "redshift"
+    DISPLAY_NAME: t.ClassVar[t.Literal["Redshift"]] = "Redshift"
+    DISPLAY_ORDER: t.ClassVar[t.Literal[7]] = 7
 
     _engine_import_validator = _get_engine_import_validator("redshift_connector", "redshift")
 
@@ -1351,9 +1351,9 @@ class PostgresConnectionConfig(ConnectionConfig):
     pre_ping: bool = True
 
     type_: t.Literal["postgres"] = Field(alias="type", default="postgres")
-    dialect: t.ClassVar[t.Literal["postgres"]] = "postgres"
-    display_name: t.ClassVar[t.Literal["Postgres"]] = "Postgres"
-    display_order: t.ClassVar[t.Literal[12]] = 12
+    DIALECT: t.ClassVar[t.Literal["postgres"]] = "postgres"
+    DISPLAY_NAME: t.ClassVar[t.Literal["Postgres"]] = "Postgres"
+    DISPLAY_ORDER: t.ClassVar[t.Literal[12]] = 12
 
     _engine_import_validator = _get_engine_import_validator("psycopg2", "postgres")
 
@@ -1407,9 +1407,9 @@ class MySQLConnectionConfig(ConnectionConfig):
     pre_ping: bool = True
 
     type_: t.Literal["mysql"] = Field(alias="type", default="mysql")
-    dialect: t.ClassVar[t.Literal["mysql"]] = "mysql"
-    display_name: t.ClassVar[t.Literal["MySQL"]] = "MySQL"
-    display_order: t.ClassVar[t.Literal[14]] = 14
+    DIALECT: t.ClassVar[t.Literal["mysql"]] = "mysql"
+    DISPLAY_NAME: t.ClassVar[t.Literal["MySQL"]] = "MySQL"
+    DISPLAY_ORDER: t.ClassVar[t.Literal[14]] = 14
 
     _engine_import_validator = _get_engine_import_validator("pymysql", "mysql")
 
@@ -1472,9 +1472,9 @@ class MSSQLConnectionConfig(ConnectionConfig):
     pre_ping: bool = True
 
     type_: t.Literal["mssql"] = Field(alias="type", default="mssql")
-    dialect: t.ClassVar[t.Literal["tsql"]] = "tsql"
-    display_name: t.ClassVar[t.Literal["MSSQL"]] = "MSSQL"
-    display_order: t.ClassVar[t.Literal[11]] = 11
+    DIALECT: t.ClassVar[t.Literal["tsql"]] = "tsql"
+    DISPLAY_NAME: t.ClassVar[t.Literal["MSSQL"]] = "MSSQL"
+    DISPLAY_ORDER: t.ClassVar[t.Literal[11]] = 11
 
     @model_validator(mode="before")
     @classmethod
@@ -1616,8 +1616,8 @@ def _extra_engine_config(self) -> t.Dict[str, t.Any]:
 
 class AzureSQLConnectionConfig(MSSQLConnectionConfig):
     type_: t.Literal["azuresql"] = Field(alias="type", default="azuresql")  # type: ignore
-    display_name: t.ClassVar[t.Literal["Azure SQL"]] = "Azure SQL"  # type: ignore
-    display_order: t.ClassVar[t.Literal[10]] = 10  # type: ignore
+    DISPLAY_NAME: t.ClassVar[t.Literal["Azure SQL"]] = "Azure SQL"  # type: ignore
+    DISPLAY_ORDER: t.ClassVar[t.Literal[10]] = 10  # type: ignore
 
     @property
     def _extra_engine_config(self) -> t.Dict[str, t.Any]:
@@ -1638,9 +1638,9 @@ class SparkConnectionConfig(ConnectionConfig):
     pre_ping: t.Literal[False] = False
 
     type_: t.Literal["spark"] = Field(alias="type", default="spark")
-    dialect: t.ClassVar[t.Literal["spark"]] = "spark"
-    display_name: t.ClassVar[t.Literal["Spark"]] = "Spark"
-    display_order: t.ClassVar[t.Literal[8]] = 8
+    DIALECT: t.ClassVar[t.Literal["spark"]] = "spark"
+    DISPLAY_NAME: t.ClassVar[t.Literal["Spark"]] = "Spark"
+    DISPLAY_ORDER: t.ClassVar[t.Literal[8]] = 8
 
     _engine_import_validator = _get_engine_import_validator("pyspark", "spark")
 
@@ -1759,9 +1759,9 @@ class TrinoConnectionConfig(ConnectionConfig):
     pre_ping: t.Literal[False] = False
 
     type_: t.Literal["trino"] = Field(alias="type", default="trino")
-    dialect: t.ClassVar[t.Literal["trino"]] = "trino"
-    display_name: t.ClassVar[t.Literal["Trino"]] = "Trino"
-    display_order: t.ClassVar[t.Literal[9]] = 9
+    DIALECT: t.ClassVar[t.Literal["trino"]] = "trino"
+    DISPLAY_NAME: t.ClassVar[t.Literal["Trino"]] = "Trino"
+    DISPLAY_ORDER: t.ClassVar[t.Literal[9]] = 9
 
     _engine_import_validator = _get_engine_import_validator("trino", "trino")
 
@@ -1922,9 +1922,9 @@ class ClickhouseConnectionConfig(ConnectionConfig):
     connection_pool_options: t.Optional[t.Dict[str, t.Any]] = None
 
     type_: t.Literal["clickhouse"] = Field(alias="type", default="clickhouse")
-    dialect: t.ClassVar[t.Literal["clickhouse"]] = "clickhouse"
-    display_name: t.ClassVar[t.Literal["ClickHouse"]] = "ClickHouse"
-    display_order: t.ClassVar[t.Literal[6]] = 6
+    DIALECT: t.ClassVar[t.Literal["clickhouse"]] = "clickhouse"
+    DISPLAY_NAME: t.ClassVar[t.Literal["ClickHouse"]] = "ClickHouse"
+    DISPLAY_ORDER: t.ClassVar[t.Literal[6]] = 6
 
     _engine_import_validator = _get_engine_import_validator("clickhouse_connect", "clickhouse")
 
@@ -2049,9 +2049,9 @@ class AthenaConnectionConfig(ConnectionConfig):
     pre_ping: t.Literal[False] = False
 
     type_: t.Literal["athena"] = Field(alias="type", default="athena")
-    dialect: t.ClassVar[t.Literal["athena"]] = "athena"
-    display_name: t.ClassVar[t.Literal["Athena"]] = "Athena"
-    display_order: t.ClassVar[t.Literal[15]] = 15
+    DIALECT: t.ClassVar[t.Literal["athena"]] = "athena"
+    DISPLAY_NAME: t.ClassVar[t.Literal["Athena"]] = "Athena"
+    DISPLAY_ORDER: t.ClassVar[t.Literal[15]] = 15
 
     _engine_import_validator = _get_engine_import_validator("pyathena", "athena")
 
@@ -2120,9 +2120,9 @@ class RisingwaveConnectionConfig(ConnectionConfig):
     pre_ping: bool = True
 
     type_: t.Literal["risingwave"] = Field(alias="type", default="risingwave")
-    dialect: t.ClassVar[t.Literal["risingwave"]] = "risingwave"
-    display_name: t.ClassVar[t.Literal["RisingWave"]] = "RisingWave"
-    display_order: t.ClassVar[t.Literal[16]] = 16
+    DIALECT: t.ClassVar[t.Literal["risingwave"]] = "risingwave"
+    DISPLAY_NAME: t.ClassVar[t.Literal["RisingWave"]] = "RisingWave"
+    DISPLAY_ORDER: t.ClassVar[t.Literal[16]] = 16
 
     _engine_import_validator = _get_engine_import_validator("psycopg2", "risingwave")
 
@@ -2168,7 +2168,7 @@ def init(cursor: t.Any) -> None:
 }
 
 DIALECT_TO_TYPE = {
-    tpe.all_field_infos()["type_"].default: tpe.dialect
+    tpe.all_field_infos()["type_"].default: tpe.DIALECT
     for tpe in subclasses(
         __name__,
         ConnectionConfig,
@@ -2178,8 +2178,8 @@ def init(cursor: t.Any) -> None:
 
 INIT_DISPLAY_INFO_TO_TYPE = {
     tpe.all_field_infos()["type_"].default: (
-        tpe.display_order,
-        tpe.display_name,
+        tpe.DISPLAY_ORDER,
+        tpe.DISPLAY_NAME,
     )
     for tpe in subclasses(
         __name__,

sqlmesh/integrations/dlt.py

@@ -138,7 +138,7 @@ def generate_dlt_models(
     force: bool,
     dlt_path: t.Optional[str] = None,
 ) -> t.List[str]:
-    from sqlmesh.cli.example_project import _create_models
+    from sqlmesh.cli.project_init import _create_models
 
     sqlmesh_models, _, _ = generate_dlt_models_and_settings(
         pipeline_name=pipeline_name,

sqlmesh/magics.py

@@ -24,7 +24,7 @@
 from IPython.core.magic_arguments import argument, magic_arguments, parse_argstring
 from IPython.utils.process import arg_split
 from rich.jupyter import JupyterRenderable
-from sqlmesh.cli.example_project import ProjectTemplate, init_example_project
+from sqlmesh.cli.project_init import ProjectTemplate, init_example_project
 from sqlmesh.core import analytics
 from sqlmesh.core.config import load_configs
 from sqlmesh.core.config.connection import INIT_DISPLAY_INFO_TO_TYPE

tests/cli/test_cli.py

@@ -11,7 +11,7 @@
 import json
 from unittest.mock import MagicMock
 from sqlmesh import RuntimeEnv
-from sqlmesh.cli.example_project import ProjectTemplate, init_example_project
+from sqlmesh.cli.project_init import ProjectTemplate, init_example_project
 from sqlmesh.cli.main import cli
 from sqlmesh.core.context import Context
 from sqlmesh.integrations.dlt import generate_dlt_models

tests/cli/test_integration_cli.py

@@ -2,7 +2,7 @@
 from pathlib import Path
 import pytest
 import subprocess
-from sqlmesh.cli.example_project import init_example_project
+from sqlmesh.cli.project_init import init_example_project
 from sqlmesh.utils import yaml
 import shutil
 import site

tests/core/engine_adapter/integration/test_integration.py

@@ -17,7 +17,7 @@
 from sqlglot.optimizer.normalize_identifiers import normalize_identifiers
 
 from sqlmesh import Config, Context
-from sqlmesh.cli.example_project import init_example_project
+from sqlmesh.cli.project_init import init_example_project
 from sqlmesh.core.config import load_config_from_paths
 from sqlmesh.core.config.connection import ConnectionConfig
 import sqlmesh.core.dialect as d

tests/core/engine_adapter/integration/test_integration_bigquery.py

@@ -4,7 +4,7 @@
 from sqlglot import exp
 from sqlglot.optimizer.qualify_columns import quote_identifiers
 from sqlglot.helper import seq_get
-from sqlmesh.cli.example_project import ProjectTemplate, init_example_project
+from sqlmesh.cli.project_init import ProjectTemplate, init_example_project
 from sqlmesh.core.config import Config
 from sqlmesh.core.engine_adapter import BigQueryEngineAdapter
 from sqlmesh.core.engine_adapter.bigquery import _CLUSTERING_META_KEY

tests/core/state_sync/test_export_import.py

@@ -4,7 +4,7 @@
 from sqlmesh.core.state_sync.export_import import export_state, import_state
 from sqlmesh.utils.errors import SQLMeshError
 from sqlmesh.core import constants as c
-from sqlmesh.cli.example_project import init_example_project
+from sqlmesh.cli.project_init import init_example_project
 from sqlmesh.core.context import Context
 from sqlmesh.core.environment import Environment
 from sqlmesh.core.config import Config, GatewayConfig, DuckDBConnectionConfig, ModelDefaultsConfig