etlplus 0.5.5__py3-none-any.whl → 0.6.1__py3-none-any.whl

etlplus/cli/handlers.py

@@ -18,8 +18,8 @@ from typing import cast
 
 from ..config import PipelineConfig
 from ..config import load_pipeline_config
-from ..ddl import load_table_spec
-from ..ddl import render_tables
+from ..database import load_table_spec
+from ..database import render_tables
 from ..enums import FileFormat
 from ..extract import extract
 from ..file import File

etlplus/database/__init__.py

@@ -0,0 +1,23 @@
+"""
+:mod:`etlplus.database` package.
+
+This package defines database-related utilities for ETLPlus, including:
+- DDL rendering and schema management.
+"""
+
+from __future__ import annotations
+
+from .ddl import load_table_spec
+from .ddl import render_table_sql
+from .ddl import render_tables
+from .ddl import render_tables_to_string
+
+# SECTION: EXPORTS ========================================================== #
+
+
+__all__ = [
+    'load_table_spec',
+    'render_table_sql',
+    'render_tables',
+    'render_tables_to_string',
+]

etlplus/{ddl.py → database/ddl.py}

@@ -11,18 +11,20 @@ can emit DDLs without shelling out to that script.
 from __future__ import annotations
 
 import importlib.resources
-import json
 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
 from jinja2 import Environment
 from jinja2 import FileSystemLoader
 from jinja2 import StrictUndefined
 
+from ..file import File
+
 # SECTION: EXPORTS ========================================================== #
 
 
@@ -31,13 +33,26 @@ __all__ = [
     'load_table_spec',
     'render_table_sql',
     'render_tables',
+    'render_tables_to_string',
 ]
 
 
+# SECTION: INTERNAL CONSTANTS =============================================== #
+
+
+_SUPPORTED_SPEC_SUFFIXES: Final[frozenset[str]] = frozenset(
+    {
+        '.json',
+        '.yml',
+        '.yaml',
+    },
+)
+
+
 # SECTION: CONSTANTS ======================================================== #
 
 
-TEMPLATES = {
+TEMPLATES: Final[dict[str, str]] = {
     'ddl': 'ddl.sql.j2',
     'view': 'view.sql.j2',
 }
@@ -46,12 +61,68 @@ TEMPLATES = {
 # SECTION: INTERNAL FUNCTIONS =============================================== #
 
 
-def _build_env(
+def _load_template_text(
+    filename: str,
+) -> str:
+    """Return the bundled template text.
+
+    Parameters
+    ----------
+    filename : str
+        Template filename located inside the package data folder.
+
+    Returns
+    -------
+    str
+        Raw template contents.
+
+    Raises
+    ------
+    FileNotFoundError
+        If the template file cannot be located in package data.
+    """
+
+    try:
+        return (
+            importlib.resources.files(
+                'etlplus.templates',
+            )
+            .joinpath(filename)
+            .read_text(encoding='utf-8')
+        )
+    except FileNotFoundError as exc:  # pragma: no cover - deployment guard
+        raise FileNotFoundError(
+            f'Could not load template {filename} '
+            f'from etlplus.templates package data.',
+        ) from exc
+
+
+def _resolve_template(
     *,
     template_key: str | None,
     template_path: str | None,
-) -> Environment:
-    """Return a Jinja2 environment using a built-in or file template."""
+) -> tuple[Environment, str]:
+    """Return environment and template name for rendering.
+
+    Parameters
+    ----------
+    template_key : str | None
+        Named template key bundled with the package.
+    template_path : str | None
+        Explicit template file override.
+
+    Returns
+    -------
+    tuple[Environment, str]
+        Pair of configured Jinja environment and the template identifier.
+
+    Raises
+    ------
+    FileNotFoundError
+        If the provided template path does not exist.
+    ValueError
+        If the template key is unknown.
+    """
     file_override = template_path or os.environ.get('TEMPLATE_NAME')
     if file_override:
         path = Path(file_override)
@@ -64,8 +135,7 @@ def _build_env(
             trim_blocks=True,
             lstrip_blocks=True,
         )
-        env.globals['TEMPLATE_NAME'] = path.name
-        return env
+        return env, path.name
 
     key = (template_key or 'ddl').strip()
     if key not in TEMPLATES:
@@ -84,51 +154,59 @@ def _build_env(
         trim_blocks=True,
         lstrip_blocks=True,
     )
-    env.globals['TEMPLATE_NAME'] = key
-    return env
+    return env, key
 
 
-def _load_template_text(filename: str) -> str:
-    """Return the raw template text bundled with the package."""
+# SECTION: FUNCTIONS ======================================================== #
 
-    try:
-        return (
-            importlib.resources.files(
-                'etlplus.templates',
-            )
-            .joinpath(filename)
-            .read_text(encoding='utf-8')
-        )
-    except FileNotFoundError as exc:  # pragma: no cover - deployment guard
-        raise FileNotFoundError(
-            f'Could not load template {filename} '
-            f'from etlplus.templates package data.',
-        ) from exc
 
+def load_table_spec(
+    path: Path | str,
+) -> dict[str, Any]:
+    """
+    Load a table specification from disk.
 
-# SECTION: FUNCTIONS ======================================================== #
+    Parameters
+    ----------
+    path : Path | str
+        Path to the JSON or YAML specification file.
 
+    Returns
+    -------
+    dict[str, Any]
+        Parsed table specification mapping.
 
-def load_table_spec(path: Path | str) -> dict[str, Any]:
-    """Load a table spec from JSON or YAML."""
+    Raises
+    ------
+    ImportError
+        If the file cannot be read due to missing dependencies.
+    RuntimeError
+        If the YAML dependency is missing for YAML specs.
+    TypeError
+        If the loaded spec is not a mapping.
+    ValueError
+        If the file suffix is not supported.
+    """
 
     spec_path = Path(path)
-    text = spec_path.read_text(encoding='utf-8')
     suffix = spec_path.suffix.lower()
 
-    if suffix == '.json':
-        return json.loads(text)
+    if suffix not in _SUPPORTED_SPEC_SUFFIXES:
+        raise ValueError('Spec must be .json, .yml, or .yaml')
 
-    if suffix in {'.yml', '.yaml'}:
-        try:
-            import yaml  # type: ignore
-        except Exception as exc:  # pragma: no cover
+    try:
+        spec = File.read_file(spec_path)
+    except ImportError as e:
+        if suffix in {'.yml', '.yaml'}:
             raise RuntimeError(
                 'Missing dependency: pyyaml is required for YAML specs.',
-            ) from exc
-        return yaml.safe_load(text)
+            ) from e
+        raise
 
-    raise ValueError('Spec must be .json, .yml, or .yaml')
+    if not isinstance(spec, Mapping):
+        raise TypeError('Table spec must be a mapping')
+
+    return dict(spec)
 
 
 def render_table_sql(
@@ -153,16 +231,11 @@ def render_table_sql(
     -------
     str
         Rendered SQL string.
-
-    Raises
-    ------
-    TypeError
-        If the loaded template name is not a string.
     """
-    env = _build_env(template_key=template, template_path=template_path)
-    template_name = env.globals.get('TEMPLATE_NAME')
-    if not isinstance(template_name, str):
-        raise TypeError('TEMPLATE_NAME must be a string.')
+    env, template_name = _resolve_template(
+        template_key=template,
+        template_path=template_path,
+    )
     tmpl = env.get_template(template_name)
     return tmpl.render(spec=spec).rstrip() + '\n'
 
@@ -195,3 +268,44 @@ def render_tables(
         render_table_sql(spec, template=template, template_path=template_path)
         for spec in specs
     ]
+
+
+def render_tables_to_string(
+    spec_paths: Iterable[Path | str],
+    *,
+    template: str | None = 'ddl',
+    template_path: Path | str | None = None,
+) -> str:
+    """
+    Render one or more specs and concatenate the SQL payloads.
+
+    Parameters
+    ----------
+    spec_paths : Iterable[Path | str]
+        Paths to table specification files.
+    template : str | None, optional
+        Template key bundled with ETLPlus. Defaults to ``'ddl'``.
+    template_path : Path | str | None, optional
+        Custom Jinja template to override the bundled templates.
+
+    Returns
+    -------
+    str
+        Concatenated SQL payload suitable for writing to disk or stdout.
+    """
+
+    resolved_template_path = (
+        str(template_path) if template_path is not None else None
+    )
+    rendered_sql: list[str] = []
+    for spec_path in spec_paths:
+        spec = load_table_spec(spec_path)
+        rendered_sql.append(
+            render_table_sql(
+                spec,
+                template=template,
+                template_path=resolved_template_path,
+            ),
+        )
+
+    return ''.join(rendered_sql)

{etlplus-0.5.5.dist-info → etlplus-0.6.1.dist-info}/METADATA

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

{etlplus-0.5.5.dist-info → etlplus-0.6.1.dist-info}/RECORD

@@ -1,7 +1,6 @@
 etlplus/__init__.py,sha256=M2gScnyir6WOMAh_EuoQIiAzdcTls0_5hbd_Q6of8I0,1021
 etlplus/__main__.py,sha256=btoROneNiigyfBU7BSzPKZ1R9gzBMpxcpsbPwmuHwTM,479
 etlplus/__version__.py,sha256=1E0GMK_yUWCMQFKxXjTvyMwofi0qT2k4CDNiHWiymWE,327
-etlplus/ddl.py,sha256=uYkiMTx1uDlUypnXCYy0K5ARnHRMHFVzzg8PizBQRLg,5306
 etlplus/enums.py,sha256=V_j18Ud2BCXpFsBk2pZGrvCVrvAMJ7uja1z9fppFGso,10175
 etlplus/extract.py,sha256=f44JdHhNTACxgn44USx05paKTwq7LQY-V4wANCW9hVM,6173
 etlplus/file.py,sha256=RxIAsGDN4f_vNA2B5-ct88JNd_ISAyYbooIRE5DstS8,17972
@@ -33,7 +32,7 @@ etlplus/api/rate_limiting/config.py,sha256=2b4wIynblN-1EyMqI4aXa71SljzSjXYh5N1Nn
 etlplus/api/rate_limiting/rate_limiter.py,sha256=Uxozqd_Ej5Lsj-M-mLT2WexChgWh7x35_YP10yqYPQA,7159
 etlplus/cli/__init__.py,sha256=J97-Rv931IL1_b4AXnB7Fbbd7HKnHBpx18NQfC_kE6c,299
 etlplus/cli/app.py,sha256=SYPO-NDwXgymJrACw39jZ_NJrSKAs0O8anuWR5o42WM,35893
-etlplus/cli/handlers.py,sha256=ZPoV9N48mtpUMf4S_czAKpo4ZqLFVb4tcTq0B36v-84,18941
+etlplus/cli/handlers.py,sha256=nFMvqHQhJ8kJZPisDCiUHeOhjlqAO6hJvRjXiJTcU74,18951
 etlplus/cli/main.py,sha256=ijYOy72SEsxrTEBan5yADW8CZyr0yddVF8HeMgFw6Zg,16576
 etlplus/config/__init__.py,sha256=VZWzOg7d2YR9NT6UwKTv44yf2FRUMjTHynkm1Dl5Qzo,1486
 etlplus/config/connector.py,sha256=0-TIwevHbKRHVmucvyGpPd-3tB1dKHB-dj0yJ6kq5eY,9809
@@ -42,14 +41,16 @@ 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=MNaqpiPNTMbwbHxdh865GXS3q4H4dkAn2YLl3GFQU8E,525
+etlplus/database/ddl.py,sha256=Hvg1PwwaIMU3y8emMWml4CzvQGvvg6KZfsHo3-EWJjg,7738
 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.5.5.dist-info/licenses/LICENSE,sha256=MuNO63i6kWmgnV2pbP2SLqP54mk1BGmu7CmbtxMmT-U,1069
-etlplus-0.5.5.dist-info/METADATA,sha256=I6_4VqX4PBWV2T5KYctjcoL9aCwp6Iixc9IZhgLUKFQ,19288
-etlplus-0.5.5.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-etlplus-0.5.5.dist-info/entry_points.txt,sha256=6w-2-jzuPa55spzK34h-UKh2JTEShh38adFRONNP9QE,45
-etlplus-0.5.5.dist-info/top_level.txt,sha256=aWWF-udn_sLGuHTM6W6MLh99ArS9ROkUWO8Mi8y1_2U,8
-etlplus-0.5.5.dist-info/RECORD,,
+etlplus-0.6.1.dist-info/licenses/LICENSE,sha256=MuNO63i6kWmgnV2pbP2SLqP54mk1BGmu7CmbtxMmT-U,1069
+etlplus-0.6.1.dist-info/METADATA,sha256=NX1ADs4_MZ3J9QLGj7bPRyXc43HJJxfOzfcmIg3VYHc,19288
+etlplus-0.6.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+etlplus-0.6.1.dist-info/entry_points.txt,sha256=6w-2-jzuPa55spzK34h-UKh2JTEShh38adFRONNP9QE,45
+etlplus-0.6.1.dist-info/top_level.txt,sha256=aWWF-udn_sLGuHTM6W6MLh99ArS9ROkUWO8Mi8y1_2U,8
+etlplus-0.6.1.dist-info/RECORD,,