etlplus 0.15.0__py3-none-any.whl → 0.16.6__py3-none-any.whl

etlplus/file/dta.py

@@ -27,6 +27,7 @@ from . import stub
 
 
 __all__ = [
+    # Functions
     'read',
     'write',
 ]
@@ -39,7 +40,7 @@ def read(
     path: Path,
 ) -> JSONList:
     """
-    Read DTA content from ``path``.
+    Read DTA content from *path*.
 
     Parameters
     ----------
@@ -59,7 +60,7 @@ def write(
     data: JSONData,
 ) -> int:
     """
-    Write ``data`` to DTA file at ``path`` and return record count.
+    Write *data* to DTA file at *path* and return record count.
 
     Parameters
     ----------

etlplus/file/duckdb.py

@@ -28,6 +28,7 @@ from . import stub
 
 
 __all__ = [
+    # Functions
     'read',
     'write',
 ]
@@ -40,7 +41,7 @@ def read(
     path: Path,
 ) -> JSONList:
     """
-    Read DUCKDB content from ``path``.
+    Read DUCKDB content from *path*.
 
     Parameters
     ----------
@@ -60,7 +61,7 @@ def write(
     data: JSONData,
 ) -> int:
     """
-    Write ``data`` to DUCKDB at ``path`` and return record count.
+    Write *data* to DUCKDB at *path* and return record count.
 
     Parameters
     ----------

etlplus/file/enums.py

@@ -281,7 +281,7 @@ def infer_file_format_and_compression(
         A filename, extension, MIME type, or existing enum member.
     filename : object | None, optional
         A filename to consult for extension-based inference (e.g. when
-        ``value`` is ``application/octet-stream``).
+        *value* is ``application/octet-stream``).
 
     Returns
     -------

etlplus/file/feather.py

@@ -30,6 +30,7 @@ from ._io import normalize_records
 
 
 __all__ = [
+    # Functions
     'read',
     'write',
 ]
@@ -42,7 +43,7 @@ def read(
     path: Path,
 ) -> JSONList:
     """
-    Read Feather content from ``path``.
+    Read Feather content from *path*.
 
     Parameters
     ----------
@@ -75,7 +76,7 @@ def write(
     data: JSONData,
 ) -> int:
     """
-    Write ``data`` to Feather at ``path`` and return record count.
+    Write *data* to Feather at *path* and return record count.
 
     Parameters
     ----------

etlplus/file/fwf.py

@@ -27,6 +27,7 @@ from . import stub
 
 
 __all__ = [
+    # Functions
     'read',
     'write',
 ]
@@ -39,7 +40,7 @@ def read(
     path: Path,
 ) -> JSONList:
     """
-    Read FWF content from ``path``.
+    Read FWF content from *path*.
 
     Parameters
     ----------
@@ -59,7 +60,7 @@ def write(
     data: JSONData,
 ) -> int:
     """
-    Write ``data`` to FWF file at ``path`` and return record count.
+    Write *data* to FWF file at *path* and return record count.
 
     Parameters
     ----------

etlplus/file/gz.py

@@ -19,6 +19,7 @@ from .enums import infer_file_format_and_compression
 
 
 __all__ = [
+    # Functions
     'read',
     'write',
 ]
@@ -65,7 +66,7 @@ def read(
     path: Path,
 ) -> JSONData:
     """
-    Read GZ content from ``path`` and parse the inner payload.
+    Read GZ content from *path* and parse the inner payload.
 
     Parameters
     ----------
@@ -94,7 +95,7 @@ def write(
     data: JSONData,
 ) -> int:
     """
-    Write ``data`` to GZ at ``path`` and return record count.
+    Write *data* to GZ at *path* and return record count.
 
     Parameters
     ----------

etlplus/file/hbs.py

@@ -28,6 +28,7 @@ from . import stub
 
 
 __all__ = [
+    # Functions
     'read',
     'write',
 ]
@@ -40,7 +41,7 @@ def read(
     path: Path,
 ) -> JSONList:
     """
-    Read ZSAV content from ``path``.
+    Read ZSAV content from *path*.
 
     Parameters
     ----------
@@ -60,7 +61,7 @@ def write(
     data: JSONData,
 ) -> int:
     """
-    Write ``data`` to HBS file at ``path`` and return record count.
+    Write *data* to HBS file at *path* and return record count.
 
     Parameters
     ----------

etlplus/file/hdf5.py

@@ -28,6 +28,7 @@ from . import stub
 
 
 __all__ = [
+    # Functions
     'read',
     'write',
 ]
@@ -40,7 +41,7 @@ def read(
     path: Path,
 ) -> JSONList:
     """
-    Read HDF5 content from ``path``.
+    Read HDF5 content from *path*.
 
     Parameters
     ----------
@@ -60,7 +61,7 @@ def write(
     data: JSONData,
 ) -> int:
     """
-    Write ``data`` to HDF5 file at ``path`` and return record count.
+    Write *data* to HDF5 file at *path* and return record count.
 
     Parameters
     ----------

etlplus/file/ini.py

@@ -29,6 +29,7 @@ from . import stub
 
 
 __all__ = [
+    # Functions
     'read',
     'write',
 ]
@@ -41,7 +42,7 @@ def read(
     path: Path,
 ) -> JSONList:
     """
-    Read INI content from ``path``.
+    Read INI content from *path*.
 
     Parameters
     ----------
@@ -61,7 +62,7 @@ def write(
     data: JSONData,
 ) -> int:
     """
-    Write ``data`` to INI at ``path`` and return record count.
+    Write *data* to INI at *path* and return record count.
 
     Parameters
     ----------

etlplus/file/ion.py

@@ -28,6 +28,7 @@ from . import stub
 
 
 __all__ = [
+    # Functions
     'read',
     'write',
 ]
@@ -40,7 +41,7 @@ def read(
     path: Path,
 ) -> JSONList:
     """
-    Read ION content from ``path``.
+    Read ION content from *path*.
 
     Parameters
     ----------
@@ -60,7 +61,7 @@ def write(
     data: JSONData,
 ) -> int:
     """
-    Write ``data`` to ION at ``path`` and return record count.
+    Write *data* to ION at *path* and return record count.
 
     Parameters
     ----------

etlplus/file/jinja2.py

@@ -28,6 +28,7 @@ from . import stub
 
 
 __all__ = [
+    # Functions
     'read',
     'write',
 ]
@@ -40,7 +41,7 @@ def read(
     path: Path,
 ) -> JSONList:
     """
-    Read JINJA2 content from ``path``.
+    Read JINJA2 content from *path*.
 
     Parameters
     ----------
@@ -60,7 +61,7 @@ def write(
     data: JSONData,
 ) -> int:
     """
-    Write ``data`` to JINJA2 file at ``path`` and return record count.
+    Write *data* to JINJA2 file at *path* and return record count.
 
     Parameters
     ----------

etlplus/file/json.py

@@ -20,17 +20,16 @@ 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
+from ._io import coerce_record_payload
 
 # SECTION: EXPORTS ========================================================== #
 
 
 __all__ = [
+    # Functions
     'read',
     'write',
 ]
@@ -43,7 +42,7 @@ def read(
     path: Path,
 ) -> JSONData:
     """
-    Read JSON content from ``path``.
+    Read JSON content from *path*.
 
     Validates that the JSON root is a dict or a list of dicts.
 
@@ -65,17 +64,7 @@ def read(
     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',
-    )
+    return coerce_record_payload(loaded, format_name='JSON')
 
 
 def write(
@@ -83,7 +72,7 @@ def write(
     data: JSONData,
 ) -> int:
     """
-    Write ``data`` as formatted JSON to ``path``.
+    Write *data* as formatted JSON to *path*.
 
     Parameters
     ----------

etlplus/file/log.py

@@ -28,6 +28,7 @@ from . import stub
 
 
 __all__ = [
+    # Functions
     'read',
     'write',
 ]
@@ -40,7 +41,7 @@ def read(
     path: Path,
 ) -> JSONList:
     """
-    Read LOG content from ``path``.
+    Read LOG content from *path*.
 
     Parameters
     ----------
@@ -60,7 +61,7 @@ def write(
     data: JSONData,
 ) -> int:
     """
-    Write ``data`` to LOG at ``path`` and return record count.
+    Write *data* to LOG at *path* and return record count.
 
     Parameters
     ----------

etlplus/file/mat.py

@@ -28,6 +28,7 @@ from . import stub
 
 
 __all__ = [
+    # Functions
     'read',
     'write',
 ]
@@ -40,7 +41,7 @@ def read(
     path: Path,
 ) -> JSONList:
     """
-    Read MAT content from ``path``.
+    Read MAT content from *path*.
 
     Parameters
     ----------
@@ -60,7 +61,7 @@ def write(
     data: JSONData,
 ) -> int:
     """
-    Write ``data`` to MAT file at ``path`` and return record count.
+    Write *data* to MAT file at *path* and return record count.
 
     Parameters
     ----------

etlplus/file/mdb.py

@@ -28,6 +28,7 @@ from . import stub
 
 
 __all__ = [
+    # Functions
     'read',
     'write',
 ]
@@ -40,7 +41,7 @@ def read(
     path: Path,
 ) -> JSONList:
     """
-    Read CSV content from ``path``.
+    Read CSV content from *path*.
 
     Parameters
     ----------
@@ -60,7 +61,7 @@ def write(
     data: JSONData,
 ) -> int:
     """
-    Write ``data`` to CSV at ``path`` and return record count.
+    Write *data* to CSV at *path* and return record count.
 
     Parameters
     ----------

etlplus/file/msgpack.py

@@ -28,6 +28,7 @@ from . import stub
 
 
 __all__ = [
+    # Functions
     'read',
     'write',
 ]
@@ -40,7 +41,7 @@ def read(
     path: Path,
 ) -> JSONList:
     """
-    Read MsgPack content from ``path``.
+    Read MsgPack content from *path*.
 
     Parameters
     ----------
@@ -60,7 +61,7 @@ def write(
     data: JSONData,
 ) -> int:
     """
-    Write ``data`` to MsgPack at ``path`` and return record count.
+    Write *data* to MsgPack at *path* and return record count.
 
     Parameters
     ----------

etlplus/file/mustache.py

@@ -28,6 +28,7 @@ from . import stub
 
 
 __all__ = [
+    # Functions
     'read',
     'write',
 ]
@@ -40,7 +41,7 @@ def read(
     path: Path,
 ) -> JSONList:
     """
-    Read MUSTACHE content from ``path``.
+    Read MUSTACHE content from *path*.
 
     Parameters
     ----------
@@ -60,7 +61,7 @@ def write(
     data: JSONData,
 ) -> int:
     """
-    Write ``data`` to MUSTACHE file at ``path`` and return record count.
+    Write *data* to MUSTACHE file at *path* and return record count.
 
     Parameters
     ----------

etlplus/file/nc.py

@@ -28,6 +28,7 @@ from . import stub
 
 
 __all__ = [
+    # Functions
     'read',
     'write',
 ]
@@ -40,7 +41,7 @@ def read(
     path: Path,
 ) -> JSONList:
     """
-    Read NC content from ``path``.
+    Read NC content from *path*.
 
     Parameters
     ----------
@@ -60,7 +61,7 @@ def write(
     data: JSONData,
 ) -> int:
     """
-    Write ``data`` to NC file at ``path`` and return record count.
+    Write *data* to NC file at *path* and return record count.
 
     Parameters
     ----------

etlplus/file/ndjson.py

@@ -31,6 +31,7 @@ from ._io import normalize_records
 
 
 __all__ = [
+    # Functions
     'read',
     'write',
 ]
@@ -43,7 +44,7 @@ def read(
     path: Path,
 ) -> JSONList:
     """
-    Read NDJSON content from ``path``.
+    Read NDJSON content from *path*.
 
     Parameters
     ----------
@@ -80,7 +81,7 @@ def write(
     data: JSONData,
 ) -> int:
     """
-    Write ``data`` to NDJSON at ``path``.
+    Write *data* to NDJSON at *path*.
 
     Parameters
     ----------

etlplus/file/numbers.py

@@ -25,6 +25,7 @@ from . import stub
 
 
 __all__ = [
+    # Functions
     'read',
     'write',
 ]
@@ -37,7 +38,7 @@ def read(
     path: Path,
 ) -> JSONList:
     """
-    Read NUMBERS content from ``path``.
+    Read NUMBERS content from *path*.
 
     Parameters
     ----------
@@ -57,7 +58,7 @@ def write(
     data: JSONData,
 ) -> int:
     """
-    Write ``data`` to NUMBERS file at ``path`` and return record count.
+    Write *data* to NUMBERS file at *path* and return record count.
 
     Parameters
     ----------

etlplus/file/ods.py

@@ -29,6 +29,7 @@ from . import stub
 
 
 __all__ = [
+    # Functions
     'read',
     'write',
 ]
@@ -41,7 +42,7 @@ def read(
     path: Path,
 ) -> JSONList:
     """
-    Read ODS content from ``path``.
+    Read ODS content from *path*.
 
     Parameters
     ----------
@@ -61,7 +62,7 @@ def write(
     data: JSONData,
 ) -> int:
     """
-    Write ``data`` to ODS file at ``path`` and return record count.
+    Write *data* to ODS file at *path* and return record count.
 
     Parameters
     ----------

etlplus/file/orc.py

@@ -30,6 +30,7 @@ from ._io import normalize_records
 
 
 __all__ = [
+    # Functions
     'read',
     'write',
 ]
@@ -42,7 +43,7 @@ def read(
     path: Path,
 ) -> JSONList:
     """
-    Read ORC content from ``path``.
+    Read ORC content from *path*.
 
     Parameters
     ----------
@@ -75,7 +76,7 @@ def write(
     data: JSONData,
 ) -> int:
     """
-    Write ``data`` to ORC at ``path`` and return record count.
+    Write *data* to ORC at *path* and return record count.
 
     Parameters
     ----------

etlplus/file/parquet.py

@@ -30,6 +30,7 @@ from ._io import normalize_records
 
 
 __all__ = [
+    # Functions
     'read',
     'write',
 ]
@@ -42,7 +43,7 @@ def read(
     path: Path,
 ) -> JSONList:
     """
-    Read Parquet content from ``path``.
+    Read Parquet content from *path*.
 
     Parameters
     ----------
@@ -76,7 +77,7 @@ def write(
     data: JSONData,
 ) -> int:
     """
-    Write ``data`` to Parquet at ``path`` and return record count.
+    Write *data* to Parquet at *path* and return record count.
 
     Parameters
     ----------

etlplus/file/pb.py

@@ -28,6 +28,7 @@ from . import stub
 
 
 __all__ = [
+    # Functions
     'read',
     'write',
 ]
@@ -40,7 +41,7 @@ def read(
     path: Path,
 ) -> JSONList:
     """
-    Read PB content from ``path``.
+    Read PB content from *path*.
 
     Parameters
     ----------
@@ -60,7 +61,7 @@ def write(
     data: JSONData,
 ) -> int:
     """
-    Write ``data`` to PB at ``path`` and return record count.
+    Write *data* to PB at *path* and return record count.
 
     Parameters
     ----------

etlplus/file/pbf.py

@@ -27,6 +27,7 @@ from . import stub
 
 
 __all__ = [
+    # Functions
     'read',
     'write',
 ]
@@ -39,7 +40,7 @@ def read(
     path: Path,
 ) -> JSONList:
     """
-    Read PBF content from ``path``.
+    Read PBF content from *path*.
 
     Parameters
     ----------
@@ -59,7 +60,7 @@ def write(
     data: JSONData,
 ) -> int:
     """
-    Write ``data`` to PBF at ``path`` and return record count.
+    Write *data* to PBF at *path* and return record count.
 
     Parameters
     ----------

etlplus/file/properties.py

@@ -28,6 +28,7 @@ from . import stub
 
 
 __all__ = [
+    # Functions
     'read',
     'write',
 ]
@@ -40,7 +41,7 @@ def read(
     path: Path,
 ) -> JSONList:
     """
-    Read PROPERTIES content from ``path``.
+    Read PROPERTIES content from *path*.
 
     Parameters
     ----------
@@ -60,7 +61,7 @@ def write(
     data: JSONData,
 ) -> int:
     """
-    Write ``data`` to PROPERTIES at ``path`` and return record count.
+    Write *data* to PROPERTIES at *path* and return record count.
 
     Parameters
     ----------