etlplus 0.12.4__py3-none-any.whl → 0.12.5__py3-none-any.whl

etlplus/file/core.py

@@ -19,6 +19,7 @@ from . import json
 from . import ndjson
 from . import orc
 from . import parquet
+from . import stub
 from . import tsv
 from . import txt
 from . import xls
@@ -209,6 +210,8 @@ class File:
                 return orc.read(self.path)
             case FileFormat.PARQUET:
                 return parquet.read(self.path)
+            case FileFormat.STUB:
+                return stub.read(self.path)
             case FileFormat.TSV:
                 return tsv.read(self.path)
             case FileFormat.TXT:
@@ -270,6 +273,8 @@ class File:
                 return orc.write(self.path, data)
             case FileFormat.PARQUET:
                 return parquet.write(self.path, data)
+            case FileFormat.STUB:
+                return stub.write(self.path, data)
             case FileFormat.TSV:
                 return tsv.write(self.path, data)
             case FileFormat.TXT:

etlplus/file/enums.py

@@ -69,6 +69,7 @@ class FileFormat(CoercibleStrEnum):
     NDJSON = 'ndjson'
     ORC = 'orc'
     PARQUET = 'parquet'
+    STUB = 'stub'
     TSV = 'tsv'
     TXT = 'txt'
     XLS = 'xls'
@@ -104,6 +105,7 @@ class FileFormat(CoercibleStrEnum):
             '.orc': 'orc',
             '.parquet': 'parquet',
             '.pq': 'parquet',
+            '.stub': 'stub',
             '.tsv': 'tsv',
             '.txt': 'txt',
             '.xls': 'xls',

etlplus/file/stub.py

@@ -0,0 +1,75 @@
+"""
+:mod:`etlplus.file.stub` module.
+
+Helpers for reading/writing stubbed files.
+"""
+
+from __future__ import annotations
+
+from pathlib import Path
+
+from ..types import JSONData
+from ..types import JSONList
+
+# SECTION: EXPORTS ========================================================== #
+
+
+__all__ = [
+    'read',
+    'write',
+]
+
+
+# SECTION: FUNCTIONS ======================================================== #
+
+
+def read(
+    path: Path,
+) -> JSONList:
+    """
+    Read stubbed content from ``path``.
+
+    Parameters
+    ----------
+    path : Path
+        Path to the stubbed file on disk.
+
+    Returns
+    -------
+    JSONList
+        The list of dictionaries read from the stubbed file.
+
+    Raises
+    ------
+    NotImplementedError
+        Always, since this is a stub implementation.
+    """
+    raise NotImplementedError('Stubbed read is not implemented yet')
+
+
+def write(
+    path: Path,
+    data: JSONData,
+) -> int:
+    """
+    Write ``data`` to stubbed file at ``path`` and return record count.
+
+    Parameters
+    ----------
+    path : Path
+        Path to the stubbed file on disk.
+    data : JSONData
+        Data to write as stubbed file. Should be a list of dictionaries or a
+        single dictionary.
+
+    Returns
+    -------
+    int
+        The number of rows written to the stubbed file.
+
+    Raises
+    ------
+    NotImplementedError
+        Always, since this is a stub implementation.
+    """
+    raise NotImplementedError('Stubbed write is not implemented yet')

{etlplus-0.12.4.dist-info → etlplus-0.12.5.dist-info}/METADATA

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

{etlplus-0.12.4.dist-info → etlplus-0.12.5.dist-info}/RECORD

@@ -60,15 +60,16 @@ etlplus/file/__init__.py,sha256=X03bosSM-uSd6dh3ur0un6_ozFRw2Tm4PE6kVUjtXK8,475
 etlplus/file/_io.py,sha256=kSbe4Bc9J8br7g856IzBvmKIWSSlng8vo66XN9Z2aiw,2917
 etlplus/file/_pandas.py,sha256=6ZqU7QzEMBq7OFl3mfEtotnKunpS3XV_GGRgz7SIHsI,1282
 etlplus/file/avro.py,sha256=JHK95zrwuHHICRe8f20xfKmeWzv1wP0Br5pOnINdLSc,4621
-etlplus/file/core.py,sha256=BkCliUez8SBEgpagxSeDbJixnX9QvD5XQp0dbYOOw0k,8692
+etlplus/file/core.py,sha256=HjxCypAJ7amPKeJdonxPx7DAXxRR59lsK8PF2T516Mk,8874
 etlplus/file/csv.py,sha256=gtEUWJO54veEtgaLB_QnmR8yOpeToq78nrtAPVTTl44,1269
-etlplus/file/enums.py,sha256=rwrbwj6PejG0c5v6jzcsmeNu9cSqDyWB1foIuM5UyJo,6648
+etlplus/file/enums.py,sha256=PKS-vkyYhS7YOXBTPLjy_PNhB8BOXDwZG5hMK8UMqwQ,6695
 etlplus/file/feather.py,sha256=WYZBn2f_Z7KDZZJ1eX0RS-934MnYIMydD0p2Oo30do4,2182
 etlplus/file/gz.py,sha256=NKsvIV7TIWn8USbvuZmRH9hr6OrXh4TzTfDykHD41Kk,2631
 etlplus/file/json.py,sha256=_KAXb4rZ1C8xnaV10IkihuFh1lhbWvajFOlMrBCNVjQ,2099
 etlplus/file/ndjson.py,sha256=gT-kgcqCUUSxtm2j-JMejoh65jk-njMvFwxKCquLZw0,2393
 etlplus/file/orc.py,sha256=GUrq9rgXCLBJ0i8Jd0Xsl4DzldDBg0FDxYhytb4OgxQ,2139
 etlplus/file/parquet.py,sha256=Tp2bi_PAIUdkzc25nArJp7beuUaudw5NdciV6IFHsdQ,2281
+etlplus/file/stub.py,sha256=N5k7uQk78sD5KfgayNJ2plmSn3GGRT31B5WRzH8_ZFw,1485
 etlplus/file/tsv.py,sha256=NiqF84Ck8e_DinaiO8yKRR6fVUTnUhpThzo4E1QUD8k,1271
 etlplus/file/txt.py,sha256=BStC7crpkGT4qddEeAD1_1mi_2-vQSXLj2DI-ddPFQE,2206
 etlplus/file/xls.py,sha256=83BbBJGxHAdbKH8Imz1l4mOgQT34uo-tyujp2WONRY4,1771
@@ -83,9 +84,9 @@ etlplus/templates/view.sql.j2,sha256=Iy8DHfhq5yyvrUKDxqp_aHIEXY4Tm6j4wT7YDEFWAhk
 etlplus/validation/README.md,sha256=qusyiyJu2DsaK80jlwfXVZ0iDgeuTPOX2EL3a_fcFiw,1401
 etlplus/validation/__init__.py,sha256=Pe5Xg1_EA4uiNZGYu5WTF3j7odjmyxnAJ8rcioaplSQ,1254
 etlplus/validation/utils.py,sha256=Mtqg449VIke0ziy_wd2r6yrwJzQkA1iulZC87FzXMjo,10201
-etlplus-0.12.4.dist-info/licenses/LICENSE,sha256=MuNO63i6kWmgnV2pbP2SLqP54mk1BGmu7CmbtxMmT-U,1069
-etlplus-0.12.4.dist-info/METADATA,sha256=FS-Se52lzyRJ2yAlzaIjAeyJ9GBJIN36nRr-wZRCLtM,22878
-etlplus-0.12.4.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-etlplus-0.12.4.dist-info/entry_points.txt,sha256=6w-2-jzuPa55spzK34h-UKh2JTEShh38adFRONNP9QE,45
-etlplus-0.12.4.dist-info/top_level.txt,sha256=aWWF-udn_sLGuHTM6W6MLh99ArS9ROkUWO8Mi8y1_2U,8
-etlplus-0.12.4.dist-info/RECORD,,
+etlplus-0.12.5.dist-info/licenses/LICENSE,sha256=MuNO63i6kWmgnV2pbP2SLqP54mk1BGmu7CmbtxMmT-U,1069
+etlplus-0.12.5.dist-info/METADATA,sha256=Iz6dewUKxGPdY5QY2FqK82PPcq8IV_2MyM6rzZhfdIA,22878
+etlplus-0.12.5.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+etlplus-0.12.5.dist-info/entry_points.txt,sha256=6w-2-jzuPa55spzK34h-UKh2JTEShh38adFRONNP9QE,45
+etlplus-0.12.5.dist-info/top_level.txt,sha256=aWWF-udn_sLGuHTM6W6MLh99ArS9ROkUWO8Mi8y1_2U,8
+etlplus-0.12.5.dist-info/RECORD,,