etlplus 0.10.4__py3-none-any.whl → 0.11.11__py3-none-any.whl

etlplus/file/gz.py

@@ -0,0 +1,59 @@
+"""
+:mod:`etlplus.file.gz` module.
+
+Stub helpers for GZ read/write.
+"""
+
+from __future__ import annotations
+
+from pathlib import Path
+
+from ..types import JSONData
+
+# SECTION: EXPORTS ========================================================== #
+
+
+def read(path: Path) -> JSONData:
+    """
+    Read GZ content from ``path``.
+
+    Parameters
+    ----------
+    path : Path
+        Path to the GZ file on disk.
+
+    Returns
+    -------
+    JSONData
+        Parsed payload.
+
+    Raises
+    ------
+    NotImplementedError
+        GZ :func:`read` is not implemented yet.
+    """
+    raise NotImplementedError('GZ read is not implemented yet')
+
+
+def write(path: Path, data: JSONData) -> int:
+    """
+    Write ``data`` to GZ at ``path``.
+
+    Parameters
+    ----------
+    path : Path
+        Path to the GZ file on disk.
+    data : JSONData
+        Data to write.
+
+    Returns
+    -------
+    int
+        Number of records written.
+
+    Raises
+    ------
+    NotImplementedError
+        GZ :func:`write` is not implemented yet.
+    """
+    raise NotImplementedError('GZ write is not implemented yet')

etlplus/file/json.py

@@ -0,0 +1,87 @@
+"""
+:mod:`etlplus.file.json` module.
+
+JSON read/write helpers.
+"""
+
+from __future__ import annotations
+
+import json
+from pathlib import Path
+from typing import cast
+
+from ..types import JSONData
+from ..types import JSONDict
+from ..types import JSONList
+from ..utils import count_records
+
+# SECTION: FUNCTIONS ======================================================== #
+
+
+def read(
+    path: Path,
+) -> JSONData:
+    """
+    Load and validate JSON payloads from ``path``.
+
+    Parameters
+    ----------
+    path : Path
+        Path to the JSON file on disk.
+
+    Returns
+    -------
+    JSONData
+        The structured data read from the JSON file.
+
+    Raises
+    ------
+    TypeError
+        If the JSON root is not an object or an array of objects.
+    """
+    with path.open('r', encoding='utf-8') as handle:
+        loaded = json.load(handle)
+
+    if isinstance(loaded, dict):
+        return cast(JSONDict, loaded)
+    if isinstance(loaded, list):
+        if all(isinstance(item, dict) for item in loaded):
+            return cast(JSONList, loaded)
+        raise TypeError(
+            'JSON array must contain only objects (dicts) when loading file',
+        )
+    raise TypeError(
+        'JSON root must be an object or an array of objects when loading file',
+    )
+
+
+def write(
+    path: Path,
+    data: JSONData,
+) -> int:
+    """
+    Write ``data`` as formatted JSON to ``path``.
+
+    Parameters
+    ----------
+    path : Path
+        Path to the JSON file on disk.
+    data : JSONData
+        Data to serialize as JSON.
+
+    Returns
+    -------
+    int
+        The number of records written to the JSON file.
+    """
+    path.parent.mkdir(parents=True, exist_ok=True)
+    with path.open('w', encoding='utf-8') as handle:
+        json.dump(
+            data,
+            handle,
+            indent=2,
+            ensure_ascii=False,
+        )
+        handle.write('\n')
+
+    return count_records(data)

etlplus/file/ndjson.py

@@ -0,0 +1,59 @@
+"""
+:mod:`etlplus.file.ndjson` module.
+
+Stub helpers for NDJSON read/write.
+"""
+
+from __future__ import annotations
+
+from pathlib import Path
+
+from ..types import JSONData
+
+# SECTION: EXPORTS ========================================================== #
+
+
+def read(path: Path) -> JSONData:
+    """
+    Read NDJSON content from ``path``.
+
+    Parameters
+    ----------
+    path : Path
+        Path to the NDJSON file on disk.
+
+    Returns
+    -------
+    JSONData
+        Parsed payload.
+
+    Raises
+    ------
+    NotImplementedError
+        NDJSON :func:`read` is not implemented yet.
+    """
+    raise NotImplementedError('NDJSON read is not implemented yet')
+
+
+def write(path: Path, data: JSONData) -> int:
+    """
+    Write ``data`` to NDJSON at ``path``.
+
+    Parameters
+    ----------
+    path : Path
+        Path to the NDJSON file on disk.
+    data : JSONData
+        Data to write.
+
+    Returns
+    -------
+    int
+        Number of records written.
+
+    Raises
+    ------
+    NotImplementedError
+        NDJSON :func:`write` is not implemented yet.
+    """
+    raise NotImplementedError('NDJSON write is not implemented yet')

etlplus/file/orc.py

@@ -0,0 +1,59 @@
+"""
+:mod:`etlplus.file.orc` module.
+
+Stub helpers for ORC read/write.
+"""
+
+from __future__ import annotations
+
+from pathlib import Path
+
+from ..types import JSONData
+
+# SECTION: EXPORTS ========================================================== #
+
+
+def read(path: Path) -> JSONData:
+    """
+    Read ORC content from ``path``.
+
+    Parameters
+    ----------
+    path : Path
+        Path to the ORC file on disk.
+
+    Returns
+    -------
+    JSONData
+        Parsed payload.
+
+    Raises
+    ------
+    NotImplementedError
+        ORC :func:`read` is not implemented yet.
+    """
+    raise NotImplementedError('ORC read is not implemented yet')
+
+
+def write(path: Path, data: JSONData) -> int:
+    """
+    Write ``data`` to ORC at ``path``.
+
+    Parameters
+    ----------
+    path : Path
+        Path to the ORC file on disk.
+    data : JSONData
+        Data to write.
+
+    Returns
+    -------
+    int
+        Number of records written.
+
+    Raises
+    ------
+    NotImplementedError
+        ORC :func:`write` is not implemented yet.
+    """
+    raise NotImplementedError('ORC write is not implemented yet')

etlplus/file/parquet.py

@@ -0,0 +1,59 @@
+"""
+:mod:`etlplus.file.parquet` module.
+
+Stub helpers for PARQUET read/write.
+"""
+
+from __future__ import annotations
+
+from pathlib import Path
+
+from ..types import JSONData
+
+# SECTION: EXPORTS ========================================================== #
+
+
+def read(path: Path) -> JSONData:
+    """
+    Read PARQUET content from ``path``.
+
+    Parameters
+    ----------
+    path : Path
+        Path to the PARQUET file on disk.
+
+    Returns
+    -------
+    JSONData
+        Parsed payload.
+
+    Raises
+    ------
+    NotImplementedError
+        PARQUET :func:`read` is not implemented yet.
+    """
+    raise NotImplementedError('PARQUET read is not implemented yet')
+
+
+def write(path: Path, data: JSONData) -> int:
+    """
+    Write ``data`` to PARQUET at ``path``.
+
+    Parameters
+    ----------
+    path : Path
+        Path to the PARQUET file on disk.
+    data : JSONData
+        Data to write.
+
+    Returns
+    -------
+    int
+        Number of records written.
+
+    Raises
+    ------
+    NotImplementedError
+        PARQUET :func:`write` is not implemented yet.
+    """
+    raise NotImplementedError('PARQUET write is not implemented yet')

etlplus/file/tsv.py

@@ -0,0 +1,59 @@
+"""
+:mod:`etlplus.file.tsv` module.
+
+Stub helpers for TSV read/write.
+"""
+
+from __future__ import annotations
+
+from pathlib import Path
+
+from ..types import JSONData
+
+# SECTION: EXPORTS ========================================================== #
+
+
+def read(path: Path) -> JSONData:
+    """
+    Read TSV content from ``path``.
+
+    Parameters
+    ----------
+    path : Path
+        Path to the TSV file on disk.
+
+    Returns
+    -------
+    JSONData
+        Parsed payload.
+
+    Raises
+    ------
+    NotImplementedError
+        TSV :func:`read` is not implemented yet.
+    """
+    raise NotImplementedError('TSV read is not implemented yet')
+
+
+def write(path: Path, data: JSONData) -> int:
+    """
+    Write ``data`` to TSV at ``path``.
+
+    Parameters
+    ----------
+    path : Path
+        Path to the TSV file on disk.
+    data : JSONData
+        Data to write.
+
+    Returns
+    -------
+    int
+        Number of records written.
+
+    Raises
+    ------
+    NotImplementedError
+        TSV :func:`write` is not implemented yet.
+    """
+    raise NotImplementedError('TSV write is not implemented yet')

etlplus/file/txt.py

@@ -0,0 +1,59 @@
+"""
+:mod:`etlplus.file.txt` module.
+
+Stub helpers for TXT read/write.
+"""
+
+from __future__ import annotations
+
+from pathlib import Path
+
+from ..types import JSONData
+
+# SECTION: EXPORTS ========================================================== #
+
+
+def read(path: Path) -> JSONData:
+    """
+    Read TXT content from ``path``.
+
+    Parameters
+    ----------
+    path : Path
+        Path to the TXT file on disk.
+
+    Returns
+    -------
+    JSONData
+        Parsed payload.
+
+    Raises
+    ------
+    NotImplementedError
+        TXT :func:`read` is not implemented yet.
+    """
+    raise NotImplementedError('TXT read is not implemented yet')
+
+
+def write(path: Path, data: JSONData) -> int:
+    """
+    Write ``data`` to TXT at ``path``.
+
+    Parameters
+    ----------
+    path : Path
+        Path to the TXT file on disk.
+    data : JSONData
+        Data to write.
+
+    Returns
+    -------
+    int
+        Number of records written.
+
+    Raises
+    ------
+    NotImplementedError
+        TXT :func:`write` is not implemented yet.
+    """
+    raise NotImplementedError('TXT write is not implemented yet')

etlplus/file/xls.py

@@ -0,0 +1,59 @@
+"""
+:mod:`etlplus.file.xls` module.
+
+Stub helpers for XLS read/write.
+"""
+
+from __future__ import annotations
+
+from pathlib import Path
+
+from ..types import JSONData
+
+# SECTION: EXPORTS ========================================================== #
+
+
+def read(path: Path) -> JSONData:
+    """
+    Read XLS content from ``path``.
+
+    Parameters
+    ----------
+    path : Path
+        Path to the XLS file on disk.
+
+    Returns
+    -------
+    JSONData
+        Parsed payload.
+
+    Raises
+    ------
+    NotImplementedError
+        XLS :func:`read` is not implemented yet.
+    """
+    raise NotImplementedError('XLS read is not implemented yet')
+
+
+def write(path: Path, data: JSONData) -> int:
+    """
+    Write ``data`` to XLS at ``path``.
+
+    Parameters
+    ----------
+    path : Path
+        Path to the XLS file on disk.
+    data : JSONData
+        Data to write.
+
+    Returns
+    -------
+    int
+        Number of records written.
+
+    Raises
+    ------
+    NotImplementedError
+        XLS :func:`write` is not implemented yet.
+    """
+    raise NotImplementedError('XLS write is not implemented yet')

etlplus/file/xlsx.py

@@ -0,0 +1,59 @@
+"""
+:mod:`etlplus.file.xlsx` module.
+
+Stub helpers for XLSX read/write.
+"""
+
+from __future__ import annotations
+
+from pathlib import Path
+
+from ..types import JSONData
+
+# SECTION: EXPORTS ========================================================== #
+
+
+def read(path: Path) -> JSONData:
+    """
+    Read XLSX content from ``path``.
+
+    Parameters
+    ----------
+    path : Path
+        Path to the XLSX file on disk.
+
+    Returns
+    -------
+    JSONData
+        Parsed payload.
+
+    Raises
+    ------
+    NotImplementedError
+        XLSX :func:`read` is not implemented yet.
+    """
+    raise NotImplementedError('XLSX read is not implemented yet')
+
+
+def write(path: Path, data: JSONData) -> int:
+    """
+    Write ``data`` to XLSX at ``path``.
+
+    Parameters
+    ----------
+    path : Path
+        Path to the XLSX file on disk.
+    data : JSONData
+        Data to write.
+
+    Returns
+    -------
+    int
+        Number of records written.
+
+    Raises
+    ------
+    NotImplementedError
+        XLSX :func:`write` is not implemented yet.
+    """
+    raise NotImplementedError('XLSX write is not implemented yet')