etlplus 0.12.3__tar.gz → 0.12.9__tar.gz

{etlplus-0.12.3/etlplus.egg-info → etlplus-0.12.9}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: etlplus
-Version: 0.12.3
+Version: 0.12.9
 Summary: A Swiss Army knife for simple ETL operations
 Home-page: https://github.com/Dagitali/ETLPlus
 Author: ETLPlus Team
@@ -68,6 +68,17 @@ package and command-line interface for data extraction, validation, transformati
   - [Features](#features)
   - [Installation](#installation)
   - [Quickstart](#quickstart)
+  - [Data Connectors](#data-connectors)
+    - [REST APIs (`api`)](#rest-apis-api)
+    - [Databases (`database`)](#databases-database)
+    - [Files (`file`)](#files-file)
+      - [Stubbed / Placeholder](#stubbed--placeholder)
+      - [Tabular \& Delimited Text](#tabular--delimited-text)
+      - [Semi-Structured Text](#semi-structured-text)
+      - [Columnar / Analytics-Friendly](#columnar--analytics-friendly)
+      - [Binary Serialization and Interchange](#binary-serialization-and-interchange)
+      - [Spreadsheets](#spreadsheets)
+      - [Data Archives](#data-archives)
   - [Usage](#usage)
     - [Command Line Interface](#command-line-interface)
       - [Argument Order and Required Options](#argument-order-and-required-options)
@@ -191,6 +202,83 @@ assert validate(filtered, rules)["valid"]
 load(filtered, "file", "temp/sample_output.json", file_format="json")
 ```
 
+## Data Connectors
+
+Data connectors abstract sources from which to extract data and targets to which to load data. They
+are differentiated by their types, each of which is represented in the subsections below.
+
+### REST APIs (`api`)
+
+ETLPlus can extract from REST APIs and load results via common HTTP methods. Supported operations
+include GET for extract and PATCH/POST/PUT for load.
+
+### Databases (`database`)
+
+Database connectors use connection strings for extraction and loading, and
+DDL can be rendered from table specs for migrations or schema checks.
+
+### Files (`file`)
+
+File formats are grouped as in `FileFormat`. Support is marked as:
+
+- **Y**: implemented (may require optional dependencies)
+- **N**: stubbed or not yet implemented
+
+#### Stubbed / Placeholder
+
+| Format | Supported | Description |
+| --- | --- | --- |
+| `stub` | N | Placeholder format for tests and future connectors. |
+
+#### Tabular & Delimited Text
+
+| Format | Supported | Description |
+| --- | --- | --- |
+| `csv` | Y | Comma-Separated Values |
+| `fwf` | N | Fixed-Width Fields |
+| `dat` | N | Generic data file, often delimited or fixed-width |
+| `psv` | N | Pipe-Separated Values |
+| `tab` | N | Often synonymous with TSV |
+| `tsv` | Y | Tab-Separated Values |
+| `txt` | Y | Plain text, often delimited or fixed-width |
+
+#### Semi-Structured Text
+
+| Format | Supported | Description |
+| --- | --- | --- |
+| `json` | Y | JavaScript Object Notation |
+| `ndjson` | Y | Newline-Delimited JSON |
+| `xml` | Y | Extensible Markup Language |
+| `yaml` | Y | YAML Ain't Markup Language |
+
+#### Columnar / Analytics-Friendly
+
+| Format | Supported | Description |
+| --- | --- | --- |
+| `feather` | Y | Apache Arrow Feather |
+| `orc` | Y | Optimized Row Columnar; common in Hadoop |
+| `parquet` | Y | Apache Parquet; common in Big Data |
+
+#### Binary Serialization and Interchange
+
+| Format | Supported | Description |
+| --- | --- | --- |
+| `avro` | Y | Apache Avro |
+
+#### Spreadsheets
+
+| Format | Supported | Description |
+| --- | --- | --- |
+| `xls` | Y | Microsoft Excel (BIFF); read-only |
+| `xlsx` | Y | Microsoft Excel (Open XML) |
+
+#### Data Archives
+
+| Format | Supported | Description |
+| --- | --- | --- |
+| `gz` | Y | Gzip-compressed file |
+| `zip` | Y | ZIP archive |
+
 ## Usage
 
 ### Command Line Interface

{etlplus-0.12.3 → etlplus-0.12.9}/README.md

@@ -18,6 +18,17 @@ package and command-line interface for data extraction, validation, transformati
   - [Features](#features)
   - [Installation](#installation)
   - [Quickstart](#quickstart)
+  - [Data Connectors](#data-connectors)
+    - [REST APIs (`api`)](#rest-apis-api)
+    - [Databases (`database`)](#databases-database)
+    - [Files (`file`)](#files-file)
+      - [Stubbed / Placeholder](#stubbed--placeholder)
+      - [Tabular \& Delimited Text](#tabular--delimited-text)
+      - [Semi-Structured Text](#semi-structured-text)
+      - [Columnar / Analytics-Friendly](#columnar--analytics-friendly)
+      - [Binary Serialization and Interchange](#binary-serialization-and-interchange)
+      - [Spreadsheets](#spreadsheets)
+      - [Data Archives](#data-archives)
   - [Usage](#usage)
     - [Command Line Interface](#command-line-interface)
       - [Argument Order and Required Options](#argument-order-and-required-options)
@@ -141,6 +152,83 @@ assert validate(filtered, rules)["valid"]
 load(filtered, "file", "temp/sample_output.json", file_format="json")
 ```
 
+## Data Connectors
+
+Data connectors abstract sources from which to extract data and targets to which to load data. They
+are differentiated by their types, each of which is represented in the subsections below.
+
+### REST APIs (`api`)
+
+ETLPlus can extract from REST APIs and load results via common HTTP methods. Supported operations
+include GET for extract and PATCH/POST/PUT for load.
+
+### Databases (`database`)
+
+Database connectors use connection strings for extraction and loading, and
+DDL can be rendered from table specs for migrations or schema checks.
+
+### Files (`file`)
+
+File formats are grouped as in `FileFormat`. Support is marked as:
+
+- **Y**: implemented (may require optional dependencies)
+- **N**: stubbed or not yet implemented
+
+#### Stubbed / Placeholder
+
+| Format | Supported | Description |
+| --- | --- | --- |
+| `stub` | N | Placeholder format for tests and future connectors. |
+
+#### Tabular & Delimited Text
+
+| Format | Supported | Description |
+| --- | --- | --- |
+| `csv` | Y | Comma-Separated Values |
+| `fwf` | N | Fixed-Width Fields |
+| `dat` | N | Generic data file, often delimited or fixed-width |
+| `psv` | N | Pipe-Separated Values |
+| `tab` | N | Often synonymous with TSV |
+| `tsv` | Y | Tab-Separated Values |
+| `txt` | Y | Plain text, often delimited or fixed-width |
+
+#### Semi-Structured Text
+
+| Format | Supported | Description |
+| --- | --- | --- |
+| `json` | Y | JavaScript Object Notation |
+| `ndjson` | Y | Newline-Delimited JSON |
+| `xml` | Y | Extensible Markup Language |
+| `yaml` | Y | YAML Ain't Markup Language |
+
+#### Columnar / Analytics-Friendly
+
+| Format | Supported | Description |
+| --- | --- | --- |
+| `feather` | Y | Apache Arrow Feather |
+| `orc` | Y | Optimized Row Columnar; common in Hadoop |
+| `parquet` | Y | Apache Parquet; common in Big Data |
+
+#### Binary Serialization and Interchange
+
+| Format | Supported | Description |
+| --- | --- | --- |
+| `avro` | Y | Apache Avro |
+
+#### Spreadsheets
+
+| Format | Supported | Description |
+| --- | --- | --- |
+| `xls` | Y | Microsoft Excel (BIFF); read-only |
+| `xlsx` | Y | Microsoft Excel (Open XML) |
+
+#### Data Archives
+
+| Format | Supported | Description |
+| --- | --- | --- |
+| `gz` | Y | Gzip-compressed file |
+| `zip` | Y | ZIP archive |
+
 ## Usage
 
 ### Command Line Interface

etlplus-0.12.9/etlplus/file/_imports.py

@@ -0,0 +1,141 @@
+"""
+:mod:`etlplus.file._imports` module.
+
+Shared helpers for optional dependency imports.
+"""
+
+from __future__ import annotations
+
+from importlib import import_module
+from typing import Any
+
+# SECTION: INTERNAL CONSTANTS =============================================== #
+
+
+_MODULE_CACHE: dict[str, Any] = {}
+
+
+# SECTION: INTERNAL FUNCTIONS =============================================== #
+
+
+def _error_message(
+    module_name: str,
+    format_name: str,
+) -> str:
+    """
+    Build an import error message for an optional dependency.
+
+    Parameters
+    ----------
+    module_name : str
+        Module name to look up.
+    format_name : str
+        Human-readable format name for templated messages.
+
+    Returns
+    -------
+    str
+        Formatted error message.
+    """
+    return (
+        f'{format_name} support requires '
+        f'optional dependency "{module_name}".\n'
+        f'Install with: pip install {module_name}'
+    )
+
+
+# SECTION: FUNCTIONS ======================================================== #
+
+
+def get_optional_module(
+    module_name: str,
+    *,
+    error_message: str,
+) -> Any:
+    """
+    Return an optional dependency module, caching on first import.
+
+    Parameters
+    ----------
+    module_name : str
+        Name of the module to import.
+    error_message : str
+        Error message to surface when the module is missing.
+
+    Returns
+    -------
+    Any
+        The imported module.
+
+    Raises
+    ------
+    ImportError
+        If the optional dependency is missing.
+    """
+    cached = _MODULE_CACHE.get(module_name)
+    if cached is not None:  # pragma: no cover - tiny branch
+        return cached
+    try:
+        module = import_module(module_name)
+    except ImportError as e:  # pragma: no cover
+        raise ImportError(error_message) from e
+    _MODULE_CACHE[module_name] = module
+    return module
+
+
+def get_fastavro() -> Any:
+    """
+    Return the fastavro module, importing it on first use.
+
+    Raises an informative ImportError if the optional dependency is missing.
+
+    Notes
+    -----
+    Prefer :func:`get_optional_module` for new call sites.
+    """
+    return get_optional_module(
+        'fastavro',
+        error_message=_error_message('fastavro', format_name='AVRO'),
+    )
+
+
+def get_pandas(
+    format_name: str,
+) -> Any:
+    """
+    Return the pandas module, importing it on first use.
+
+    Parameters
+    ----------
+    format_name : str
+        Human-readable format name for error messages.
+
+    Returns
+    -------
+    Any
+        The pandas module.
+
+    Notes
+    -----
+    Prefer :func:`get_optional_module` for new call sites.
+    """
+    return get_optional_module(
+        'pandas',
+        error_message=_error_message('pandas', format_name=format_name),
+    )
+
+
+def get_yaml() -> Any:
+    """
+    Return the PyYAML module, importing it on first use.
+
+    Raises an informative ImportError if the optional dependency is missing.
+
+    Notes
+    -----
+    Prefer :func:`get_optional_module` for new call sites.
+    """
+    return get_optional_module(
+        'yaml',
+        error_message=_error_message('PyYAML', format_name='YAML'),
+    )

{etlplus-0.12.3 → etlplus-0.12.9}/etlplus/file/_io.py

@@ -107,6 +107,7 @@ def write_delimited(path: Path, data: JSONData, *, delimiter: str) -> int:
         return 0
 
     fieldnames = sorted({key for row in rows for key in row})
+    path.parent.mkdir(parents=True, exist_ok=True)
     with path.open('w', encoding='utf-8', newline='') as handle:
         writer = csv.DictWriter(
             handle,

{etlplus-0.12.3 → etlplus-0.12.9}/etlplus/file/avro.py

@@ -10,6 +10,8 @@ from pathlib import Path
 from typing import Any
 from typing import cast
 
+from etlplus.file._imports import get_fastavro
+
 from ..types import JSONData
 from ..types import JSONDict
 from ..types import JSONList
@@ -27,9 +29,6 @@ __all__ = [
 # SECTION: INTERNAL CONSTANTS =============================================== #
 
 
-_FASTAVRO_CACHE: dict[str, Any] = {}
-
-
 _PRIMITIVE_TYPES: tuple[type, ...] = (
     bool,
     int,
@@ -43,27 +42,6 @@ _PRIMITIVE_TYPES: tuple[type, ...] = (
 # SECTION: INTERNAL FUNCTIONS =============================================== #
 
 
-def _get_fastavro() -> Any:
-    """
-    Return the fastavro module, importing it on first use.
-
-    Raises an informative ImportError if the optional dependency is missing.
-    """
-    mod = _FASTAVRO_CACHE.get('mod')
-    if mod is not None:  # pragma: no cover - tiny branch
-        return mod
-    try:
-        _fastavro = __import__('fastavro')  # type: ignore[assignment]
-    except ImportError as e:  # pragma: no cover
-        raise ImportError(
-            'AVRO support requires optional dependency "fastavro".\n'
-            'Install with: pip install fastavro',
-        ) from e
-    _FASTAVRO_CACHE['mod'] = _fastavro
-
-    return _fastavro
-
-
 def _infer_schema(records: JSONList) -> dict[str, Any]:
     """
     Infer a basic Avro schema from record payloads.
@@ -146,7 +124,7 @@ def read(
     JSONList
         The list of dictionaries read from the AVRO file.
     """
-    fastavro = _get_fastavro()
+    fastavro = get_fastavro()
     with path.open('rb') as handle:
         reader = fastavro.reader(handle)
         return [cast(JSONDict, record) for record in reader]
@@ -175,7 +153,7 @@ def write(
     if not records:
         return 0
 
-    fastavro = _get_fastavro()
+    fastavro = get_fastavro()
     schema = _infer_schema(records)
     parsed_schema = fastavro.parse_schema(schema)
 

{etlplus-0.12.3 → etlplus-0.12.9}/etlplus/file/core.py

@@ -7,25 +7,15 @@ files.
 
 from __future__ import annotations
 
+import importlib
+import inspect
 from dataclasses import dataclass
+from functools import cache
 from pathlib import Path
+from types import ModuleType
 
 from ..types import JSONData
-from . import avro
-from . import csv
-from . import feather
-from . import gz
-from . import json
-from . import ndjson
-from . import orc
-from . import parquet
-from . import tsv
-from . import txt
-from . import xls
-from . import xlsx
 from . import xml
-from . import yaml
-from . import zip as zip_
 from .enums import FileFormat
 from .enums import infer_file_format_and_compression
 
@@ -35,6 +25,53 @@ from .enums import infer_file_format_and_compression
 __all__ = ['File']
 
 
+# SECTION: INTERNAL FUNCTIONS =============================================== #
+
+
+def _accepts_root_tag(handler: object) -> bool:
+    """
+    Return True when ``handler`` supports a ``root_tag`` argument.
+
+    Parameters
+    ----------
+    handler : object
+        Callable to inspect.
+
+    Returns
+    -------
+    bool
+        True if ``root_tag`` is accepted by the handler.
+    """
+    if not callable(handler):
+        return False
+    try:
+        signature = inspect.signature(handler)
+    except (TypeError, ValueError):
+        return False
+    for param in signature.parameters.values():
+        if param.kind is param.VAR_KEYWORD:
+            return True
+    return 'root_tag' in signature.parameters
+
+
+@cache
+def _module_for_format(file_format: FileFormat) -> ModuleType:
+    """
+    Import and return the module for ``file_format``.
+
+    Parameters
+    ----------
+    file_format : FileFormat
+        File format enum value.
+
+    Returns
+    -------
+    ModuleType
+        The module implementing IO for the format.
+    """
+    return importlib.import_module(f'{__package__}.{file_format.value}')
+
+
 # SECTION: CLASSES ========================================================== #
 
 
@@ -174,6 +211,53 @@ class File:
             # Leave as None; _ensure_format() will raise on use if needed.
             return None
 
+    def _resolve_handler(self, name: str) -> object:
+        """
+        Resolve a handler from the module for the active file format.
+
+        Parameters
+        ----------
+        name : str
+            Attribute name to resolve (``'read'`` or ``'write'``).
+
+        Returns
+        -------
+        object
+            Callable handler exported by the module.
+
+        Raises
+        ------
+        ValueError
+            If the resolved file format is unsupported.
+        """
+        module = self._resolve_module()
+        try:
+            return getattr(module, name)
+        except AttributeError as e:
+            raise ValueError(
+                f'Module {module.__name__} does not implement {name}()',
+            ) from e
+
+    def _resolve_module(self) -> ModuleType:
+        """
+        Resolve the IO module for the active file format.
+
+        Returns
+        -------
+        ModuleType
+            The module that implements read/write for the format.
+
+        Raises
+        ------
+        ValueError
+            If the resolved file format is unsupported.
+        """
+        fmt = self._ensure_format()
+        try:
+            return _module_for_format(fmt)
+        except ModuleNotFoundError as e:
+            raise ValueError(f'Unsupported format: {fmt}') from e
+
     # -- Instance Methods -- #
 
     def read(self) -> JSONData:
@@ -187,43 +271,18 @@ class File:
 
         Raises
         ------
-        ValueError
-            If the resolved file format is unsupported.
+        TypeError
+            If the resolved 'read' handler is not callable.
         """
         self._assert_exists()
-        fmt = self._ensure_format()
-        match fmt:
-            case FileFormat.AVRO:
-                return avro.read(self.path)
-            case FileFormat.CSV:
-                return csv.read(self.path)
-            case FileFormat.FEATHER:
-                return feather.read(self.path)
-            case FileFormat.GZ:
-                return gz.read(self.path)
-            case FileFormat.JSON:
-                return json.read(self.path)
-            case FileFormat.NDJSON:
-                return ndjson.read(self.path)
-            case FileFormat.ORC:
-                return orc.read(self.path)
-            case FileFormat.PARQUET:
-                return parquet.read(self.path)
-            case FileFormat.TSV:
-                return tsv.read(self.path)
-            case FileFormat.TXT:
-                return txt.read(self.path)
-            case FileFormat.XLS:
-                return xls.read(self.path)
-            case FileFormat.XLSX:
-                return xlsx.read(self.path)
-            case FileFormat.XML:
-                return xml.read(self.path)
-            case FileFormat.YAML:
-                return yaml.read(self.path)
-            case FileFormat.ZIP:
-                return zip_.read(self.path)
-        raise ValueError(f'Unsupported format: {fmt}')
+        reader = self._resolve_handler('read')
+        if callable(reader):
+            return reader(self.path)
+        else:
+            raise TypeError(
+                f"'read' handler for format {self.file_format} "
+                'is not callable',
+            )
 
     def write(
         self,
@@ -249,39 +308,15 @@ class File:
 
         Raises
         ------
-        ValueError
-            If the resolved file format is unsupported.
+        TypeError
+            If the resolved 'write' handler is not callable.
         """
-        fmt = self._ensure_format()
-        match fmt:
-            case FileFormat.AVRO:
-                return avro.write(self.path, data)
-            case FileFormat.CSV:
-                return csv.write(self.path, data)
-            case FileFormat.FEATHER:
-                return feather.write(self.path, data)
-            case FileFormat.GZ:
-                return gz.write(self.path, data)
-            case FileFormat.JSON:
-                return json.write(self.path, data)
-            case FileFormat.NDJSON:
-                return ndjson.write(self.path, data)
-            case FileFormat.ORC:
-                return orc.write(self.path, data)
-            case FileFormat.PARQUET:
-                return parquet.write(self.path, data)
-            case FileFormat.TSV:
-                return tsv.write(self.path, data)
-            case FileFormat.TXT:
-                return txt.write(self.path, data)
-            case FileFormat.XLS:
-                return xls.write(self.path, data)
-            case FileFormat.XLSX:
-                return xlsx.write(self.path, data)
-            case FileFormat.XML:
-                return xml.write(self.path, data, root_tag=root_tag)
-            case FileFormat.YAML:
-                return yaml.write(self.path, data)
-            case FileFormat.ZIP:
-                return zip_.write(self.path, data)
-        raise ValueError(f'Unsupported format: {fmt}')
+        writer = self._resolve_handler('write')
+        if not callable(writer):
+            raise TypeError(
+                f"'write' handler for format {self.file_format} "
+                'is not callable',
+            )
+        if _accepts_root_tag(writer):
+            return writer(self.path, data, root_tag=root_tag)
+        return writer(self.path, data)