etlplus 0.7.1__py3-none-any.whl → 0.7.2__py3-none-any.whl

etlplus/database/__init__.py

@@ -18,6 +18,7 @@ from .engine import engine
 from .engine import load_database_url_from_config
 from .engine import make_engine
 from .engine import session
+from .orm import Base
 from .orm import build_models
 from .orm import load_and_build_models
 from .schema import load_table_specs
@@ -36,6 +37,7 @@ __all__ = [
     'render_table_sql',
     'render_tables',
     'render_tables_to_string',
+    'Base',
     # Singletons
     'engine',
     'session',

etlplus/database/ddl.py

@@ -15,7 +15,6 @@ import os
 from collections.abc import Iterable
 from collections.abc import Mapping
 from pathlib import Path
-from typing import Any
 from typing import Final
 
 from jinja2 import DictLoader
@@ -24,6 +23,9 @@ from jinja2 import FileSystemLoader
 from jinja2 import StrictUndefined
 
 from ..file import File
+from ..types import StrAnyMap
+from ..types import StrPath
+from .types import TemplateKey
 
 # SECTION: EXPORTS ========================================================== #
 
@@ -52,7 +54,7 @@ _SUPPORTED_SPEC_SUFFIXES: Final[frozenset[str]] = frozenset(
 # SECTION: CONSTANTS ======================================================== #
 
 
-TEMPLATES: Final[dict[str, str]] = {
+TEMPLATES: Final[dict[TemplateKey, str]] = {
     'ddl': 'ddl.sql.j2',
     'view': 'view.sql.j2',
 }
@@ -64,7 +66,8 @@ TEMPLATES: Final[dict[str, str]] = {
 def _load_template_text(
     filename: str,
 ) -> str:
-    """Return the bundled template text.
+    """
+    Return the bundled template text.
 
     Parameters
     ----------
@@ -99,16 +102,17 @@ def _load_template_text(
 
 def _resolve_template(
     *,
-    template_key: str | None,
-    template_path: str | None,
+    template_key: TemplateKey | None,
+    template_path: StrPath | None,
 ) -> tuple[Environment, str]:
-    """Return environment and template name for rendering.
+    """
+    Return environment and template name for rendering.
 
     Parameters
     ----------
-    template_key : str | None
+    template_key : TemplateKey | None
         Named template key bundled with the package.
-    template_path : str | None
+    template_path : StrPath | None
         Explicit template file override.
 
     Returns
@@ -123,7 +127,11 @@ def _resolve_template(
     ValueError
         If the template key is unknown.
     """
-    file_override = template_path or os.environ.get('TEMPLATE_NAME')
+    file_override = (
+        str(template_path)
+        if template_path is not None
+        else os.environ.get('TEMPLATE_NAME')
+    )
     if file_override:
         path = Path(file_override)
         if not path.exists():
@@ -137,14 +145,14 @@ def _resolve_template(
         )
         return env, path.name
 
-    key = (template_key or 'ddl').strip()
+    key: TemplateKey = template_key or 'ddl'
     if key not in TEMPLATES:
         choices = ', '.join(sorted(TEMPLATES))
         raise ValueError(
             f'Unknown template key "{key}". Choose from: {choices}',
         )
 
-    # Load template from package data
+    # Load template from package data.
     template_filename = TEMPLATES[key]
     template_source = _load_template_text(template_filename)
 
@@ -161,19 +169,19 @@ def _resolve_template(
 
 
 def load_table_spec(
-    path: Path | str,
-) -> dict[str, Any]:
+    path: StrPath,
+) -> StrAnyMap:
     """
     Load a table specification from disk.
 
     Parameters
     ----------
-    path : Path | str
+    path : StrPath
         Path to the JSON or YAML specification file.
 
     Returns
     -------
-    dict[str, Any]
+    StrAnyMap
         Parsed table specification mapping.
 
     Raises
@@ -210,9 +218,9 @@ def load_table_spec(
 
 
 def render_table_sql(
-    spec: Mapping[str, Any],
+    spec: StrAnyMap,
     *,
-    template: str | None = 'ddl',
+    template: TemplateKey | None = 'ddl',
     template_path: str | None = None,
 ) -> str:
     """
@@ -220,9 +228,9 @@ def render_table_sql(
 
     Parameters
     ----------
-    spec : Mapping[str, Any]
+    spec : StrAnyMap
         Table specification mapping.
-    template : str | None, optional
+    template : TemplateKey | None, optional
         Template key to use (default: 'ddl').
     template_path : str | None, optional
         Path to a custom template file (overrides ``template``).
@@ -241,9 +249,9 @@ def render_table_sql(
 
 
 def render_tables(
-    specs: Iterable[Mapping[str, Any]],
+    specs: Iterable[StrAnyMap],
     *,
-    template: str | None = 'ddl',
+    template: TemplateKey | None = 'ddl',
     template_path: str | None = None,
 ) -> list[str]:
     """
@@ -251,9 +259,9 @@ def render_tables(
 
     Parameters
     ----------
-    specs : Iterable[Mapping[str, Any]]
+    specs : Iterable[StrAnyMap]
         Table specification mappings.
-    template : str | None, optional
+    template : TemplateKey | None, optional
         Template key to use (default: 'ddl').
     template_path : str | None, optional
         Path to a custom template file (overrides ``template``).
@@ -271,21 +279,21 @@ def render_tables(
 
 
 def render_tables_to_string(
-    spec_paths: Iterable[Path | str],
+    spec_paths: Iterable[StrPath],
     *,
-    template: str | None = 'ddl',
-    template_path: Path | str | None = None,
+    template: TemplateKey | None = 'ddl',
+    template_path: StrPath | None = None,
 ) -> str:
     """
     Render one or more specs and concatenate the SQL payloads.
 
     Parameters
     ----------
-    spec_paths : Iterable[Path | str]
+    spec_paths : Iterable[StrPath]
         Paths to table specification files.
-    template : str | None, optional
+    template : TemplateKey | None, optional
         Template key bundled with ETLPlus. Defaults to ``'ddl'``.
-    template_path : Path | str | None, optional
+    template_path : StrPath | None, optional
         Custom Jinja template to override the bundled templates.
 
     Returns

etlplus/database/engine.py

@@ -10,12 +10,15 @@ import os
 from collections.abc import Mapping
 from pathlib import Path
 from typing import Any
+from typing import Final
 
 from sqlalchemy import create_engine
 from sqlalchemy.engine import Engine
 from sqlalchemy.orm import sessionmaker
 
 from ..file import File
+from ..types import StrAnyMap
+from ..types import StrPath
 
 # SECTION: EXPORTS ========================================================== #
 
@@ -33,7 +36,7 @@ __all__ = [
 # SECTION: INTERNAL CONSTANTS =============================================== #
 
 
-DATABASE_URL: str = (
+DATABASE_URL: Final[str] = (
     os.getenv('DATABASE_URL')
     or os.getenv('DATABASE_DSN')
     or 'sqlite+pysqlite:///:memory:'
@@ -43,13 +46,15 @@ DATABASE_URL: str = (
 # SECTION: INTERNAL FUNCTIONS =============================================== #
 
 
-def _resolve_url_from_mapping(cfg: Mapping[str, Any]) -> str | None:
+def _resolve_url_from_mapping(
+    cfg: StrAnyMap,
+) -> str | None:
     """
     Return a URL/DSN from a mapping if present.
 
     Parameters
     ----------
-    cfg : Mapping[str, Any]
+    cfg : StrAnyMap
         Configuration mapping potentially containing connection fields.
 
     Returns
@@ -74,7 +79,7 @@ def _resolve_url_from_mapping(cfg: Mapping[str, Any]) -> str | None:
 
 
 def load_database_url_from_config(
-    path: str | Path,
+    path: StrPath,
     *,
     name: str | None = None,
 ) -> str:
@@ -88,7 +93,7 @@ def load_database_url_from_config(
 
     Parameters
     ----------
-    path : str | Path
+    path : StrPath
         Location of the configuration file.
     name : str | None, optional
         Named database entry under the ``databases`` map (default:

etlplus/database/orm.py

@@ -13,9 +13,8 @@ Usage
 from __future__ import annotations
 
 import re
-from collections.abc import Callable
-from pathlib import Path
 from typing import Any
+from typing import Final
 
 from sqlalchemy import Boolean
 from sqlalchemy import CheckConstraint
@@ -41,11 +40,15 @@ from sqlalchemy.orm import DeclarativeBase
 from sqlalchemy.orm import mapped_column
 from sqlalchemy.types import TypeEngine
 
+from ..types import StrPath
 from .schema import ForeignKeySpec
 from .schema import TableSpec
 from .schema import load_table_specs
+from .types import ModelRegistry
+from .types import TypeFactory
+
+# SECTION: EXPORTS ========================================================== #
 
-# SECTION: INTERNAL CONSTANTS =============================================== #
 
 __all__ = [
     # Classes
@@ -57,7 +60,9 @@ __all__ = [
 ]
 
 
-_TYPE_MAPPING: dict[str, Callable[[list[int]], TypeEngine]] = {
+# SECTION: INTERNAL CONSTANTS =============================================== #
+
+_TYPE_MAPPING: Final[dict[str, TypeFactory]] = {
     'int': lambda _: Integer(),
     'integer': lambda _: Integer(),
     'bigint': lambda _: Integer(),
@@ -102,6 +107,8 @@ _TYPE_MAPPING: dict[str, Callable[[list[int]], TypeEngine]] = {
 class Base(DeclarativeBase):
     """Base class for all ORM models."""
 
+    __abstract__ = True
+
 
 # SECTION: INTERNAL FUNCTIONS =============================================== #
 
@@ -191,7 +198,7 @@ def build_models(
     specs: list[TableSpec],
     *,
     base: type[DeclarativeBase] = Base,
-) -> dict[str, type[DeclarativeBase]]:
+) -> ModelRegistry:
     """
     Build SQLAlchemy ORM models from table specifications.
     Parameters
@@ -202,10 +209,10 @@ def build_models(
         Base class for the ORM models (default: :class:`Base`).
     Returns
     -------
-    dict[str, type[DeclarativeBase]]
+    ModelRegistry
         Registry mapping fully qualified table names to ORM model classes.
     """
-    registry: dict[str, type[DeclarativeBase]] = {}
+    registry: ModelRegistry = {}
 
     for spec in specs:
         table_args: list[object] = []
@@ -302,23 +309,23 @@ def build_models(
 
 
 def load_and_build_models(
-    path: str | Path,
+    path: StrPath,
     *,
     base: type[DeclarativeBase] = Base,
-) -> dict[str, type[DeclarativeBase]]:
+) -> ModelRegistry:
     """
     Load table specifications from a file and build SQLAlchemy models.
 
     Parameters
     ----------
-    path : str | Path
+    path : StrPath
         Path to the YAML file containing table specifications.
     base : type[DeclarativeBase], optional
         Base class for the ORM models (default: :class:`Base`).
 
     Returns
     -------
-    dict[str, type[DeclarativeBase]]
+    ModelRegistry
         Registry mapping fully qualified table names to ORM model classes.
     """
     return build_models(load_table_specs(path), base=base)

etlplus/database/schema.py

@@ -16,6 +16,7 @@ from pydantic import ConfigDict
 from pydantic import Field
 
 from ..file import File
+from ..types import StrPath
 
 # SECTION: EXPORTS ========================================================== #
 
@@ -244,14 +245,14 @@ class TableSpec(BaseModel):
 
 
 def load_table_specs(
-    path: str | Path,
+    path: StrPath,
 ) -> list[TableSpec]:
     """
     Load table specifications from a YAML file.
 
     Parameters
     ----------
-    path : str | Path
+    path : StrPath
         Path to the YAML file containing table specifications.
 
     Returns

etlplus/database/types.py

@@ -0,0 +1,38 @@
+"""
+:mod:`etlplus.database.types` module.
+
+Shared type aliases leveraged across :mod:`etlplus.database` modules.
+"""
+
+from __future__ import annotations
+
+from collections.abc import Callable
+from typing import Literal
+
+from sqlalchemy.orm import DeclarativeBase
+from sqlalchemy.types import TypeEngine
+
+# SECTION: EXPORTS ========================================================== #
+
+
+__all__ = [
+    # Type Aliases
+    'ModelRegistry',
+    'TemplateKey',
+    'TypeFactory',
+]
+
+
+# SECTION: TYPE ALIASES ===================================================== #
+
+
+# pylint: disable=invalid-name
+
+# Registry mapping fully qualified table names to declarative classes.
+type ModelRegistry = dict[str, type[DeclarativeBase]]
+
+# Allowed template keys for bundled DDL rendering.
+type TemplateKey = Literal['ddl', 'view']
+
+# Callable producing a SQLAlchemy TypeEngine from parsed parameters.
+type TypeFactory = Callable[[list[int]], TypeEngine]

{etlplus-0.7.1.dist-info → etlplus-0.7.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: etlplus
-Version: 0.7.1
+Version: 0.7.2
 Summary: A Swiss Army knife for simple ETL operations
 Home-page: https://github.com/Dagitali/ETLPlus
 Author: ETLPlus Team

{etlplus-0.7.1.dist-info → etlplus-0.7.2.dist-info}/RECORD

@@ -41,19 +41,20 @@ etlplus/config/pipeline.py,sha256=Va4MQY6KEyKqHGMKPmh09ZcGpx95br-iNUjpkqtzVbw,95
 etlplus/config/profile.py,sha256=Ss2zedQGjkaGSpvBLTD4SZaWViMJ7TJPLB8Q2_BTpPg,1898
 etlplus/config/types.py,sha256=a0epJ3z16HQ5bY3Ctf8s_cQPa3f0HHcwdOcjCP2xoG4,4954
 etlplus/config/utils.py,sha256=4SUHMkt5bKBhMhiJm-DrnmE2Q4TfOgdNCKz8PJDS27o,3443
-etlplus/database/__init__.py,sha256=0gWnMlQiVHS6SVUxIT9zklQUHU36y-2RF_gN1cx7icg,1018
-etlplus/database/ddl.py,sha256=lIar9KIOoBRslp_P0DnpoMDXzkjt64J5-iVV7CeSV_M,7747
-etlplus/database/engine.py,sha256=54f-XtNKIuogJhsLV9cX_xPoBwcl_HNJTL5HqMCi8kw,3986
-etlplus/database/orm.py,sha256=StjeguokM70oNKq7mNXLyc4_mYUZR-EKW3oGRlsd8QE,9962
-etlplus/database/schema.py,sha256=BmRP2wwX2xex1phLm0tnHrP6A2AQgguA-hSLnK0xwwc,7003
+etlplus/database/__init__.py,sha256=AKJsDl2RHuRGPS-eXgNJeh4aSncJP5Y0yLApBF6i7i8,1052
+etlplus/database/ddl.py,sha256=gpybAxs5xCukr9HkzNHm2sJo1_q42Qg70jiSEl60yaY,7915
+etlplus/database/engine.py,sha256=7rr7YndA8LwyWJL8k1YhQbqxxmW4gWEUQjp0NwQcYtc,4061
+etlplus/database/orm.py,sha256=gCSqH-CjQz6tV9133-VqgiwokK5ylun0BwXaIWfImAo,10008
+etlplus/database/schema.py,sha256=HNTgglI8qvQLInr7gq--2lLmLKHzAZTL2MJUOIw9DlY,7025
+etlplus/database/types.py,sha256=42d6MVc0x58T7xITus-vOiHmrL4SwwxI7rvZrsIhDl4,935
 etlplus/templates/__init__.py,sha256=tsniN7XJYs3NwYxJ6c2HD5upHP3CDkLx-bQCMt97UOM,106
 etlplus/templates/ddl.sql.j2,sha256=s8fMWvcb4eaJVXkifuib1aQPljtZ8buuyB_uA-ZdU3Q,4734
 etlplus/templates/view.sql.j2,sha256=Iy8DHfhq5yyvrUKDxqp_aHIEXY4Tm6j4wT7YDEFWAhk,2180
 etlplus/validation/__init__.py,sha256=Pe5Xg1_EA4uiNZGYu5WTF3j7odjmyxnAJ8rcioaplSQ,1254
 etlplus/validation/utils.py,sha256=Mtqg449VIke0ziy_wd2r6yrwJzQkA1iulZC87FzXMjo,10201
-etlplus-0.7.1.dist-info/licenses/LICENSE,sha256=MuNO63i6kWmgnV2pbP2SLqP54mk1BGmu7CmbtxMmT-U,1069
-etlplus-0.7.1.dist-info/METADATA,sha256=Y2MYm3-8rGosgvY29er_Pt_j9qxgBVndnRXK3k0xUBM,19383
-etlplus-0.7.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-etlplus-0.7.1.dist-info/entry_points.txt,sha256=6w-2-jzuPa55spzK34h-UKh2JTEShh38adFRONNP9QE,45
-etlplus-0.7.1.dist-info/top_level.txt,sha256=aWWF-udn_sLGuHTM6W6MLh99ArS9ROkUWO8Mi8y1_2U,8
-etlplus-0.7.1.dist-info/RECORD,,
+etlplus-0.7.2.dist-info/licenses/LICENSE,sha256=MuNO63i6kWmgnV2pbP2SLqP54mk1BGmu7CmbtxMmT-U,1069
+etlplus-0.7.2.dist-info/METADATA,sha256=AHc-GAyaSgkfORQiT6Da2wsEtOtAxGMdPjO1jrZBNPg,19383
+etlplus-0.7.2.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+etlplus-0.7.2.dist-info/entry_points.txt,sha256=6w-2-jzuPa55spzK34h-UKh2JTEShh38adFRONNP9QE,45
+etlplus-0.7.2.dist-info/top_level.txt,sha256=aWWF-udn_sLGuHTM6W6MLh99ArS9ROkUWO8Mi8y1_2U,8
+etlplus-0.7.2.dist-info/RECORD,,