etlplus 0.14.3__py3-none-any.whl → 0.16.0__py3-none-any.whl

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
     ----------

etlplus/file/proto.py

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

etlplus/file/psv.py

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

etlplus/file/rda.py

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

etlplus/file/rds.py

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

etlplus/file/sas7bdat.py

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

etlplus/file/sav.py

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

etlplus/file/sqlite.py

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

etlplus/file/stub.py

@@ -15,6 +15,7 @@ from ..types import JSONList
 
 
 __all__ = [
+    # Functions
     'read',
     'write',
 ]

etlplus/file/sylk.py

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

etlplus/file/tab.py

@@ -31,6 +31,7 @@ from . import stub
 
 
 __all__ = [
+    # Functions
     'read',
     'write',
 ]
@@ -43,7 +44,7 @@ def read(
     path: Path,
 ) -> JSONList:
     """
-    Read TAB content from ``path``.
+    Read TAB content from *path*.
 
     Parameters
     ----------
@@ -63,7 +64,7 @@ def write(
     data: JSONData,
 ) -> int:
     """
-    Write ``data`` to TAB file at ``path`` and return record count.
+    Write *data* to TAB file at *path* and return record count.
 
     Parameters
     ----------

etlplus/file/toml.py

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

etlplus/file/tsv.py

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

etlplus/file/txt.py

@@ -27,6 +27,7 @@ from ._io import normalize_records
 
 
 __all__ = [
+    # Functions
     'read',
     'write',
 ]
@@ -39,7 +40,7 @@ def read(
     path: Path,
 ) -> JSONList:
     """
-    Read TXT content from ``path``.
+    Read TXT content from *path*.
 
     Parameters
     ----------
@@ -66,7 +67,7 @@ def write(
     data: JSONData,
 ) -> int:
     """
-    Write ``data`` to TXT at ``path`` and return record count.
+    Write *data* to TXT at *path* and return record count.
 
     Parameters
     ----------
@@ -83,7 +84,7 @@ def write(
     Raises
     ------
     TypeError
-        If any item in ``data`` is not a dictionary or if any dictionary
+        If any item in *data* is not a dictionary or if any dictionary
         does not contain a ``'text'`` key.
     """
     rows = normalize_records(data, 'TXT')

etlplus/file/vm.py

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

etlplus/file/wks.py

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

etlplus/file/xls.py

@@ -17,6 +17,7 @@ from ._imports import get_pandas
 
 
 __all__ = [
+    # Functions
     'read',
     'write',
 ]
@@ -29,7 +30,7 @@ def read(
     path: Path,
 ) -> JSONList:
     """
-    Read XLS content from ``path``.
+    Read XLS content from *path*.
 
     Parameters
     ----------
@@ -62,7 +63,7 @@ def write(
     data: JSONData,
 ) -> int:
     """
-    Write ``data`` to XLS at ``path`` and return record count.
+    Write *data* to XLS at *path* and return record count.
 
     Notes
     -----

etlplus/file/xlsm.py

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

etlplus/file/xlsx.py

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

etlplus/file/xml.py

@@ -29,6 +29,7 @@ from ..utils import count_records
 
 
 __all__ = [
+    # Functions
     'read',
     'write',
 ]
@@ -137,7 +138,7 @@ def read(
     path: Path,
 ) -> JSONDict:
     """
-    Read XML content from ``path``.
+    Read XML content from *path*.
 
     Parameters
     ----------
@@ -155,9 +156,14 @@ def read(
     return {root.tag: _element_to_dict(root)}
 
 
-def write(path: Path, data: JSONData, *, root_tag: str) -> int:
+def write(
+    path: Path,
+    data: JSONData,
+    *,
+    root_tag: str,
+) -> int:
     """
-    Write ``data`` to XML at ``path`` and return record count.
+    Write *data* to XML at *path* and return record count.
 
     Parameters
     ----------

etlplus/file/xpt.py

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