etlplus 0.12.3__py3-none-any.whl → 0.12.12__py3-none-any.whl

etlplus/file/stub.py

@@ -0,0 +1,84 @@
+"""
+: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,
+    format_name: str = 'Stubbed',
+) -> JSONList:
+    """
+    Raises a :class:`NotImplementedError` for stubbed reads.
+
+    Parameters
+    ----------
+    path : Path
+        Path to the stubbed file on disk.
+    format_name : str
+        Human-readable format name.
+
+    Returns
+    -------
+    JSONList
+        The list of dictionaries read from the stubbed file.
+
+    Raises
+    ------
+    NotImplementedError
+        Always, since this is a stub implementation.
+    """
+    _ = path
+    raise NotImplementedError(f'{format_name} read is not implemented yet')
+
+
+def write(
+    path: Path,
+    data: JSONData,
+    format_name: str = 'Stubbed',
+) -> int:
+    """
+    Raises a :class:`NotImplementedError` for stubbed writes.
+
+    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.
+    format_name : str
+        Human-readable format name.
+
+    Returns
+    -------
+    int
+        The number of rows written to the stubbed file.
+
+    Raises
+    ------
+    NotImplementedError
+        Always, since this is a stub implementation.
+    """
+    _ = path
+    _ = data
+    raise NotImplementedError(f'{format_name} write is not implemented yet')

etlplus/file/sylk.py

@@ -0,0 +1,77 @@
+"""
+:mod:`etlplus.file.sylk` module.
+
+Helpers for reading/writing Symbolic Link (SYLK) data files.
+
+Notes
+-----
+- A SYLK file is a text-based file format used to represent spreadsheet
+    data, including cell values, formulas, and formatting.
+- Common cases:
+    - Storing spreadsheet data in a human-readable format.
+    - Exchanging data between different spreadsheet applications.
+- Rule of thumb:
+    - If you need to work with SYLK files, use this module for reading
+        and writing.
+"""
+
+from __future__ import annotations
+
+from pathlib import Path
+
+from ..types import JSONData
+from ..types import JSONList
+from . import stub
+
+# SECTION: EXPORTS ========================================================== #
+
+
+__all__ = [
+    'read',
+    'write',
+]
+
+
+# SECTION: FUNCTIONS ======================================================== #
+
+
+def read(
+    path: Path,
+) -> JSONList:
+    """
+    Read SYLK content from ``path``.
+
+    Parameters
+    ----------
+    path : Path
+        Path to the SYLK file on disk.
+
+    Returns
+    -------
+    JSONList
+        The list of dictionaries read from the SYLK file.
+    """
+    return stub.read(path, format_name='SYLK')
+
+
+def write(
+    path: Path,
+    data: JSONData,
+) -> int:
+    """
+    Write ``data`` to SYLK file at ``path`` and return record count.
+
+    Parameters
+    ----------
+    path : Path
+        Path to the SYLK file on disk.
+    data : JSONData
+        Data to write as SYLK file. Should be a list of dictionaries or a
+        single dictionary.
+
+    Returns
+    -------
+    int
+        The number of rows written to the SYLK file.
+    """
+    return stub.write(path, data, format_name='SYLK')

etlplus/file/tab.py

@@ -0,0 +1,81 @@
+"""
+:mod:`etlplus.file.tab` module.
+
+Helpers for reading/writing "tab"-formatted (TAB) files.
+
+Notes
+-----
+- A TAB file is not necessarily a TSV file when tabs aren’t actually the
+    delimiter that defines the fields, even if the text looks column-aligned.
+- Common cases:
+    - Fixed-width text (FWF) that uses tabs for alignment.
+    - Mixed whitespace (tabs + spaces) as “pretty printing”.
+    - Tabs embedded inside quoted fields (or unescaped tabs in free text).
+    - Header/metadata lines or multi-line records that break TSV assumptions.
+    - Not actually tab-delimited despite the name.
+- Rule of thumb:
+    - If the file is truly tab-delimited, use :mod:`etlplus.file.tsv`.
+    - If the file has fixed-width fields, use :mod:`etlplus.file.fwf`.
+    - Otherwise, use :mod:`etlplus.file.tab` (i.e., this module).
+"""
+
+from __future__ import annotations
+
+from pathlib import Path
+
+from ..types import JSONData
+from ..types import JSONList
+from . import stub
+
+# SECTION: EXPORTS ========================================================== #
+
+
+__all__ = [
+    'read',
+    'write',
+]
+
+
+# SECTION: FUNCTIONS ======================================================== #
+
+
+def read(
+    path: Path,
+) -> JSONList:
+    """
+    Read TAB content from ``path``.
+
+    Parameters
+    ----------
+    path : Path
+        Path to the TAB file on disk.
+
+    Returns
+    -------
+    JSONList
+        The list of dictionaries read from the TAB file.
+    """
+    return stub.read(path, format_name='TAB')
+
+
+def write(
+    path: Path,
+    data: JSONData,
+) -> int:
+    """
+    Write ``data`` to TAB file at ``path`` and return record count.
+
+    Parameters
+    ----------
+    path : Path
+        Path to the TAB file on disk.
+    data : JSONData
+        Data to write as TAB file. Should be a list of dictionaries or a
+        single dictionary.
+
+    Returns
+    -------
+    int
+        The number of rows written to the TAB file.
+    """
+    return stub.write(path, data, format_name='TAB')

etlplus/file/toml.py

@@ -0,0 +1,78 @@
+"""
+:mod:`etlplus.file.toml` module.
+
+Helpers for reading/writing Tom's Obvious Minimal Language (TOML) files.
+
+Notes
+-----
+- A TOML file is a configuration file that uses the TOML syntax.
+- Common cases:
+    - Simple key-value pairs.
+    - Nested tables and arrays.
+    - Data types such as strings, integers, floats, booleans, dates, and
+        arrays.
+- Rule of thumb:
+    - If the file follows the TOML specification, use this module for
+        reading and writing.
+"""
+
+from __future__ import annotations
+
+from pathlib import Path
+
+from ..types import JSONData
+from ..types import JSONList
+from . import stub
+
+# SECTION: EXPORTS ========================================================== #
+
+
+__all__ = [
+    'read',
+    'write',
+]
+
+
+# SECTION: FUNCTIONS ======================================================== #
+
+
+def read(
+    path: Path,
+) -> JSONList:
+    """
+    Read TOML content from ``path``.
+
+    Parameters
+    ----------
+    path : Path
+        Path to the TOML file on disk.
+
+    Returns
+    -------
+    JSONList
+        The list of dictionaries read from the TOML file.
+    """
+    return stub.read(path, format_name='TOML')
+
+
+def write(
+    path: Path,
+    data: JSONData,
+) -> int:
+    """
+    Write ``data`` to TOML at ``path`` and return record count.
+
+    Parameters
+    ----------
+    path : Path
+        Path to the TOML file on disk.
+    data : JSONData
+        Data to write as TOML. Should be a list of dictionaries or a
+        single dictionary.
+
+    Returns
+    -------
+    int
+        The number of rows written to the TOML file.
+    """
+    return stub.write(path, data, format_name='TOML')

etlplus/file/tsv.py

@@ -1,7 +1,20 @@
 """
 :mod:`etlplus.file.tsv` module.
 
-Helpers for reading/writing TSV files.
+Helpers for reading/writing Tab-Separated Values (TSV) files.
+
+Notes
+-----
+- A TSV file is a plain text file that uses the tab character (``\t``) to
+    separate values.
+- Common cases:
+    - Each line in the file represents a single record.
+    - The first line often contains headers that define the column names.
+    - Values may be enclosed in quotes, especially if they contain tabs
+        or special characters.
+- Rule of thumb:
+    - If the file follows the TSV specification, use this module for
+        reading and writing.
 """
 
 from __future__ import annotations

etlplus/file/txt.py

@@ -1,18 +1,27 @@
 """
 :mod:`etlplus.file.txt` module.
 
-Helpers for reading/writing text files.
+Helpers for reading/writing text (TXT) files.
+
+Notes
+-----
+- A TXT file is a plain text file that contains unformatted text.
+- Common cases:
+    - Each line in the file represents a single piece of text.
+    - Lines may vary in length and content.
+- Rule of thumb:
+    - If the file is a simple text file without specific formatting
+        requirements, use this module for reading and writing.
 """
 
 from __future__ import annotations
 
 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 normalize_records
 
 # SECTION: EXPORTS ========================================================== #
 
@@ -77,13 +86,7 @@ def write(
         If any item in ``data`` is not a dictionary or if any dictionary
         does not contain a ``'text'`` key.
     """
-    rows: JSONList
-    if isinstance(data, list):
-        if not all(isinstance(item, dict) for item in data):
-            raise TypeError('TXT payloads must contain only objects (dicts)')
-        rows = cast(JSONList, data)
-    else:
-        rows = [cast(JSONDict, data)]
+    rows = normalize_records(data, 'TXT')
 
     if not rows:
         return 0

etlplus/file/vm.py

@@ -0,0 +1,78 @@
+"""
+:mod:`etlplus.file.vm` module.
+
+Helpers for reading/writing Apache Velocity (VM) template files.
+
+Notes
+-----
+- A VM file is a text file used for generating HTML or other text formats
+    by combining templates with data.
+- Common cases:
+    - HTML templates.
+    - Email templates.
+    - Configuration files.
+- Rule of thumb:
+    - If you need to work with Apache Velocity template files, use this module
+        for reading and writing.
+"""
+
+from __future__ import annotations
+
+from pathlib import Path
+
+from ..types import JSONData
+from ..types import JSONList
+from . import stub
+
+# SECTION: EXPORTS ========================================================== #
+
+
+__all__ = [
+    'read',
+    'write',
+]
+
+
+# SECTION: FUNCTIONS ======================================================== #
+
+
+def read(
+    path: Path,
+) -> JSONList:
+    """
+    Read VM content from ``path``.
+
+    Parameters
+    ----------
+    path : Path
+        Path to the VM file on disk.
+
+    Returns
+    -------
+    JSONList
+        The list of dictionaries read from the VM file.
+    """
+    return stub.read(path, format_name='VM')
+
+
+def write(
+    path: Path,
+    data: JSONData,
+) -> int:
+    """
+    Write ``data`` to VM file at ``path`` and return record count.
+
+    Parameters
+    ----------
+    path : Path
+        Path to the VM file on disk.
+    data : JSONData
+        Data to write as VM file. Should be a list of dictionaries or a single
+        dictionary.
+
+    Returns
+    -------
+    int
+        The number of rows written to the VM file.
+    """
+    return stub.write(path, data, format_name='VM')

etlplus/file/wks.py

@@ -0,0 +1,77 @@
+"""
+:mod:`etlplus.file.wks` module.
+
+Helpers for reading/writing Lotus 1-2-3 (WKS) spreadsheet files.
+
+Notes
+-----
+- A WKS file is a spreadsheet file created using the Lotus 1-2-3 format.
+- Common cases:
+    - Reading data from legacy Lotus 1-2-3 spreadsheets.
+    - Writing data to Lotus 1-2-3 format for compatibility.
+    - Converting WKS files to more modern formats.
+- Rule of thumb:
+    - If you need to work with Lotus 1-2-3 spreadsheet files, use this module
+        for reading and writing.
+"""
+
+from __future__ import annotations
+
+from pathlib import Path
+
+from ..types import JSONData
+from ..types import JSONList
+from . import stub
+
+# SECTION: EXPORTS ========================================================== #
+
+
+__all__ = [
+    'read',
+    'write',
+]
+
+
+# SECTION: FUNCTIONS ======================================================== #
+
+
+def read(
+    path: Path,
+) -> JSONList:
+    """
+    Read WKS content from ``path``.
+
+    Parameters
+    ----------
+    path : Path
+        Path to the WKS file on disk.
+
+    Returns
+    -------
+    JSONList
+        The list of dictionaries read from the WKS file.
+    """
+    return stub.read(path, format_name='WKS')
+
+
+def write(
+    path: Path,
+    data: JSONData,
+) -> int:
+    """
+    Write ``data`` to WKS file at ``path`` and return record count.
+
+    Parameters
+    ----------
+    path : Path
+        Path to the WKS file on disk.
+    data : JSONData
+        Data to write as WKS file. Should be a list of dictionaries or a
+        single dictionary.
+
+    Returns
+    -------
+    int
+        The number of rows written to the WKS file.
+    """
+    return stub.write(path, data, format_name='WKS')

etlplus/file/xls.py

@@ -11,7 +11,7 @@ from typing import cast
 
 from ..types import JSONData
 from ..types import JSONList
-from ._pandas import get_pandas
+from ._imports import get_pandas
 
 # SECTION: EXPORTS ========================================================== #
 

etlplus/file/xlsm.py

@@ -0,0 +1,79 @@
+"""
+:mod:`etlplus.file.xlsm` module.
+
+Helpers for reading/writing Microsoft Excel Macro-Enabled (XLSM) spreadsheet
+files.
+
+Notes
+-----
+- An XLSM file is a spreadsheet file created using the Microsoft Excel Macro-
+    Enabled (Open XML) format.
+- Common cases:
+    - Reading data from Excel Macro-Enabled spreadsheets.
+    - Writing data to Excel Macro-Enabled format for compatibility.
+    - Converting XLSM files to more modern formats.
+- Rule of thumb:
+    - If you need to work with Excel Macro-Enabled spreadsheet files, use this
+        module for reading and writing.
+"""
+
+from __future__ import annotations
+
+from pathlib import Path
+
+from ..types import JSONData
+from ..types import JSONList
+from . import stub
+
+# SECTION: EXPORTS ========================================================== #
+
+
+__all__ = [
+    'read',
+    'write',
+]
+
+
+# SECTION: FUNCTIONS ======================================================== #
+
+
+def read(
+    path: Path,
+) -> JSONList:
+    """
+    Read XLSM content from ``path``.
+
+    Parameters
+    ----------
+    path : Path
+        Path to the XLSM file on disk.
+
+    Returns
+    -------
+    JSONList
+        The list of dictionaries read from the XLSM file.
+    """
+    return stub.read(path, format_name='XLSM')
+
+
+def write(
+    path: Path,
+    data: JSONData,
+) -> int:
+    """
+    Write ``data`` to XLSM file at ``path`` and return record count.
+
+    Parameters
+    ----------
+    path : Path
+        Path to the XLSM file on disk.
+    data : JSONData
+        Data to write as XLSM file. Should be a list of dictionaries or a
+        single dictionary.
+
+    Returns
+    -------
+    int
+        The number of rows written to the XLSM file.
+    """
+    return stub.write(path, data, format_name='XLSM')

etlplus/file/xlsx.py

@@ -11,8 +11,8 @@ from typing import cast
 
 from ..types import JSONData
 from ..types import JSONList
+from ._imports import get_pandas
 from ._io import normalize_records
-from ._pandas import get_pandas
 
 # SECTION: EXPORTS ========================================================== #
 

etlplus/file/xml.py

@@ -1,7 +1,18 @@
 """
 :mod:`etlplus.file.xml` module.
 
-Helpers for reading/writing XML files.
+Helpers for reading/writing Extensible Markup Language (XML) files.
+
+Notes
+-----
+- An XML file is a markup language file that uses tags to define elements.
+- Common cases:
+    - Configuration files.
+    - Data interchange between systems.
+    - Document formatting.
+- Rule of thumb:
+    - If the file follows the XML specification, use this module for
+        reading and writing.
 """
 
 from __future__ import annotations