etlplus 0.11.2__tar.gz → 0.11.9__tar.gz

{etlplus-0.11.2/etlplus.egg-info → etlplus-0.11.9}/PKG-INFO

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

{etlplus-0.11.2 → etlplus-0.11.9}/etlplus/cli/handlers.py

@@ -570,7 +570,7 @@ def transform_handler(
     data = transform(payload, cast(TransformOperations, operations_payload))
 
     if target and target != '-':
-        File.write_file(target, data, file_format=target_format)
+        File(target, file_format=target_format).write(data)
         print(f'Data transformed and saved to {target}')
         return 0
 

{etlplus-0.11.2 → etlplus-0.11.9}/etlplus/database/ddl.py

@@ -203,7 +203,7 @@ def load_table_spec(
         raise ValueError('Spec must be .json, .yml, or .yaml')
 
     try:
-        spec = File.read_file(spec_path)
+        spec = File(spec_path).read()
     except ImportError as e:
         if suffix in {'.yml', '.yaml'}:
             raise RuntimeError(

{etlplus-0.11.2 → etlplus-0.11.9}/etlplus/database/engine.py

@@ -113,7 +113,7 @@ def load_database_url_from_config(
     ValueError
         If no connection string/URL/DSN is found for the specified entry.
     """
-    cfg = File.read_file(Path(path))
+    cfg = File(Path(path)).read()
     if not isinstance(cfg, Mapping):
         raise TypeError('Database config must be a mapping')
 

{etlplus-0.11.2 → etlplus-0.11.9}/etlplus/database/schema.py

@@ -260,7 +260,7 @@ def load_table_specs(
     list[TableSpec]
         A list of TableSpec instances parsed from the YAML file.
     """
-    data = File.read_file(Path(path))
+    data = File(Path(path)).read()
     if not data:
         return []
 

{etlplus-0.11.2 → etlplus-0.11.9}/etlplus/file/__init__.py

@@ -9,7 +9,6 @@ from __future__ import annotations
 from .core import File
 from .enums import CompressionFormat
 from .enums import FileFormat
-from .enums import coerce_file_format
 from .enums import infer_file_format_and_compression
 
 # SECTION: EXPORTS ========================================================== #
@@ -22,6 +21,5 @@ __all__ = [
     'CompressionFormat',
     'FileFormat',
     # Functions
-    'coerce_file_format',
     'infer_file_format_and_compression',
 ]

{etlplus-0.11.2 → etlplus-0.11.9}/etlplus/file/core.py

@@ -11,7 +11,6 @@ from dataclasses import dataclass
 from pathlib import Path
 
 from ..types import JSONData
-from ..types import StrPath
 from . import csv
 from . import json
 from . import xml
@@ -43,7 +42,15 @@ class File:
         Path to the file on disk.
     file_format : FileFormat | None, optional
         Explicit format. If omitted, the format is inferred from the file
-        extension (``.csv``, ``.json``, or ``.xml``).
+        extension (``.csv``, ``.json``, etc.).
+
+    Parameters
+    ----------
+    path : StrPath
+        Path to the file on disk.
+    file_format : FileFormat | str | None, optional
+        Explicit format. If omitted, the format is inferred from the file
+        extension (``.csv``, ``.json``, etc.).
     """
 
     # -- Attributes -- #
@@ -62,16 +69,10 @@ class File:
         extension is unknown, the attribute is left as ``None`` and will be
         validated later by :meth:`_ensure_format`.
         """
-        # Normalize incoming path (allow str in constructor) to Path.
-        if isinstance(self.path, str):
-            self.path = Path(self.path)
-
+        self.path = Path(self.path)
+        self.file_format = self._coerce_format(self.file_format)
         if self.file_format is None:
-            try:
-                self.file_format = self._guess_format()
-            except ValueError:
-                # Leave as None; _ensure_format() will raise on use if needed.
-                pass
+            self.file_format = self._maybe_guess_format()
 
     # -- Internal Instance Methods -- #
 
@@ -84,6 +85,28 @@ class File:
         if not self.path.exists():
             raise FileNotFoundError(f'File not found: {self.path}')
 
+    def _coerce_format(
+        self,
+        file_format: FileFormat | str | None,
+    ) -> FileFormat | None:
+        """
+        Normalize the file format input.
+
+        Parameters
+        ----------
+        file_format : FileFormat | str | None
+            File format specifier. Strings are coerced into
+            :class:`FileFormat`.
+
+        Returns
+        -------
+        FileFormat | None
+            A normalized file format, or ``None`` when unspecified.
+        """
+        if file_format is None or isinstance(file_format, FileFormat):
+            return file_format
+        return FileFormat.coerce(file_format)
+
     def _ensure_format(self) -> FileFormat:
         """
         Resolve the active format, guessing from extension if needed.
@@ -125,7 +148,22 @@ class File:
             f'Cannot infer file format from extension {self.path.suffix!r}',
         )
 
-    # -- Instance Methods (Generic API) -- #
+    def _maybe_guess_format(self) -> FileFormat | None:
+        """
+        Try to infer the format, returning ``None`` if it cannot be inferred.
+
+        Returns
+        -------
+        FileFormat | None
+            The inferred format, or ``None`` if inference fails.
+        """
+        try:
+            return self._guess_format()
+        except ValueError:
+            # Leave as None; _ensure_format() will raise on use if needed.
+            return None
+
+    # -- Instance Methods -- #
 
     def read(self) -> JSONData:
         """
@@ -192,96 +230,3 @@ class File:
             case FileFormat.YAML:
                 return yaml.write(self.path, data)
         raise ValueError(f'Unsupported format: {fmt}')
-
-    # -- Class Methods -- #
-
-    @classmethod
-    def from_path(
-        cls,
-        path: StrPath,
-        *,
-        file_format: FileFormat | str | None = None,
-    ) -> File:
-        """
-        Create a :class:`File` from any path-like and optional format.
-
-        Parameters
-        ----------
-        path : StrPath
-            Path to the file on disk.
-        file_format : FileFormat | str | None, optional
-            Explicit format. If omitted, the format is inferred from the file
-            extension (``.csv``, ``.json``, or ``.xml``).
-
-        Returns
-        -------
-        File
-            The constructed :class:`File` instance.
-        """
-        resolved = Path(path)
-        ff: FileFormat | None
-        if isinstance(file_format, str):
-            ff = FileFormat.coerce(file_format)
-        else:
-            ff = file_format
-
-        return cls(resolved, ff)
-
-    @classmethod
-    def read_file(
-        cls,
-        path: StrPath,
-        file_format: FileFormat | str | None = None,
-    ) -> JSONData:
-        """
-        Read structured data.
-
-        Parameters
-        ----------
-        path : StrPath
-            Path to the file on disk.
-        file_format : FileFormat | str | None, optional
-            Explicit format. If omitted, the format is inferred from the file
-            extension (``.csv``, ``.json``, or ``.xml``).
-
-        Returns
-        -------
-        JSONData
-            The structured data read from the file.
-        """
-        return cls.from_path(path, file_format=file_format).read()
-
-    @classmethod
-    def write_file(
-        cls,
-        path: StrPath,
-        data: JSONData,
-        file_format: FileFormat | str | None = None,
-        *,
-        root_tag: str = xml.DEFAULT_XML_ROOT,
-    ) -> int:
-        """
-        Write structured data and count written records.
-
-        Parameters
-        ----------
-        path : StrPath
-            Path to the file on disk.
-        data : JSONData
-            Data to write to the file.
-        file_format : FileFormat | str | None, optional
-            Explicit format. If omitted, the format is inferred from the file
-            extension (``.csv``, ``.json``, or ``.xml``).
-        root_tag : str, optional
-            Root tag name to use when writing XML files. Defaults to
-            ``'root'``.
-
-        Returns
-        -------
-        int
-            The number of records written to the file.
-        """
-        return cls.from_path(path, file_format=file_format).write(
-            data,
-            root_tag=root_tag,
-        )

{etlplus-0.11.2 → etlplus-0.11.9}/etlplus/file/enums.py

@@ -16,8 +16,6 @@ from ..types import StrStrMap
 __all__ = [
     'CompressionFormat',
     'FileFormat',
-    'coerce_compression_format',
-    'coerce_file_format',
     'infer_file_format_and_compression',
 ]
 
@@ -164,32 +162,6 @@ _COMPRESSION_FILE_FORMATS: set[FileFormat] = {
 # SECTION: FUNCTIONS ======================================================== #
 
 
-# TODO: Deprecate in favor of using the enum methods directly.
-def coerce_compression_format(
-    compression_format: CompressionFormat | str,
-) -> CompressionFormat:
-    """
-    Normalize textual compression format values to :class:`CompressionFormat`.
-
-    This thin wrapper is kept for backward compatibility; prefer
-    :meth:`CompressionFormat.coerce` going forward.
-    """
-    return CompressionFormat.coerce(compression_format)
-
-
-# TODO: Deprecate in favor of using the enum methods directly.
-def coerce_file_format(
-    file_format: FileFormat | str,
-) -> FileFormat:
-    """
-    Normalize textual file format values to :class:`FileFormat`.
-
-    This thin wrapper is kept for backward compatibility; prefer
-    :meth:`FileFormat.coerce` going forward.
-    """
-    return FileFormat.coerce(file_format)
-
-
 # TODO: Convert to a method on FileFormat or CompressionFormat?
 def infer_file_format_and_compression(
     value: object,

{etlplus-0.11.2 → etlplus-0.11.9/etlplus.egg-info}/PKG-INFO

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

{etlplus-0.11.2 → etlplus-0.11.9}/etlplus.egg-info/SOURCES.txt

@@ -114,7 +114,6 @@ tests/integration/test_i_run_profile_rate_limit_defaults.py
 tests/unit/conftest.py
 tests/unit/test_u_enums.py
 tests/unit/test_u_extract.py
-tests/unit/test_u_file.py
 tests/unit/test_u_load.py
 tests/unit/test_u_main.py
 tests/unit/test_u_mixins.py
@@ -151,5 +150,8 @@ tests/unit/database/test_u_database_ddl.py
 tests/unit/database/test_u_database_engine.py
 tests/unit/database/test_u_database_orm.py
 tests/unit/database/test_u_database_schema.py
+tests/unit/file/test_u_file_core.py
+tests/unit/file/test_u_file_enums.py
+tests/unit/file/test_u_file_yaml.py
 tests/unit/validation/test_u_validation_utils.py
 tools/update_demo_snippets.py

{etlplus-0.11.2 → etlplus-0.11.9}/tests/integration/test_i_examples_data_parity.py

@@ -48,8 +48,8 @@ def test_examples_sample_csv_json_parity_integration():
     assert csv_path.exists(), f'Missing CSV fixture: {csv_path}'
     assert json_path.exists(), f'Missing JSON fixture: {json_path}'
 
-    csv_data = File.read_file(csv_path)
-    json_data = File.read_file(json_path)
+    csv_data = File(csv_path).read()
+    json_data = File(json_path).read()
 
     assert isinstance(csv_data, list), 'CSV should load as a list of dicts'
     assert isinstance(json_data, list), 'JSON should load as a list of dicts'

{etlplus-0.11.2 → etlplus-0.11.9}/tests/unit/cli/test_u_cli_handlers.py

@@ -683,15 +683,11 @@ class TestTransformHandler:
         )
         write_calls: dict[str, object] = {}
 
-        def fake_write(
-            path: str,
-            data: object,
-            *,
-            file_format: str | None,
-        ) -> None:
-            write_calls['params'] = (path, data, file_format)
+        def fake_write(self, data, **kwargs):
+            # Only capture path and data; ignore root_tag.
+            write_calls['params'] = (str(self.path), data)
 
-        monkeypatch.setattr(handlers.File, 'write_file', fake_write)
+        monkeypatch.setattr(handlers.File, 'write', fake_write)
 
         assert (
             handlers.transform_handler(
@@ -709,7 +705,6 @@ class TestTransformHandler:
                 'payload': {'source': 'data.json'},
                 'ops': {'select': ['id']},
             },
-            'json',
         )
         assert (
             'Data transformed and saved to out.json' in capsys.readouterr().out

{etlplus-0.11.2 → etlplus-0.11.9}/tests/unit/database/test_u_database_engine.py

@@ -41,7 +41,8 @@ class TestLoadDatabaseUrlFromConfig:
         self,
         monkeypatch: pytest.MonkeyPatch,
     ) -> Callable[[Any], None]:
-        """Return a helper that patches ``File.read_file`` with a payload.
+        """
+        Return a helper that patches :meth:`read` to return a payload.
 
         Parameters
         ----------
@@ -51,14 +52,14 @@ class TestLoadDatabaseUrlFromConfig:
         Returns
         -------
         Callable[[Any], None]
-            Function that patches ``File.read_file`` to return the payload.
+            Function that patches ``File.read`` to return the payload.
         """
 
         def _apply(payload: Any) -> None:
             monkeypatch.setattr(
                 engine_mod.File,
-                'read_file',
-                staticmethod(lambda path: payload),
+                'read',
+                lambda self: payload,
             )
 
         return _apply

{etlplus-0.11.2 → etlplus-0.11.9}/tests/unit/database/test_u_database_schema.py

@@ -76,7 +76,7 @@ class TestLoadTableSpecs:
 
     Notes
     -----
-    Reuses a helper fixture to patch ``File.read_file`` and avoid disk IO.
+    Reuses a helper fixture to patch :meth:`File.read` and avoid disk IO.
     """
 
     @pytest.fixture()
@@ -84,7 +84,9 @@ class TestLoadTableSpecs:
         self,
         monkeypatch: pytest.MonkeyPatch,
     ) -> Callable[[Any], None]:
-        """Return helper that patches ``File.read_file`` to return payload.
+        """
+        Return helper that patches the :meth:`read` instance method to return a
+        payload.
 
         Parameters
         ----------
@@ -98,18 +100,14 @@ class TestLoadTableSpecs:
         """
 
         def _apply(payload: Any) -> None:
-            if callable(payload):
-                monkeypatch.setattr(
-                    schema_mod.File,
-                    'read_file',
-                    staticmethod(payload),
-                )
-            else:
-                monkeypatch.setattr(
-                    schema_mod.File,
-                    'read_file',
-                    staticmethod(lambda path: payload),
-                )
+            # pylint: disable=unused-argument
+            """Apply the patch to :meth:`File.read` to return the payload."""
+
+            def fake_read(self, *args, **kwargs):
+                """Fake :meth:`File.read` method returning the payload."""
+                return payload(self.path) if callable(payload) else payload
+
+            monkeypatch.setattr(schema_mod.File, 'read', fake_read)
 
         return _apply
 

etlplus-0.11.2/tests/unit/test_u_file.py → etlplus-0.11.9/tests/unit/file/test_u_file_core.py

@@ -1,7 +1,7 @@
 """
-:mod:`tests.unit.test_u_file` module.
+:mod:`tests.unit.test_u_file_core` module.
 
-Unit tests for :mod:`etlplus.file`.
+Unit tests for :mod:`etlplus.file.core`.
 
 Notes
 -----
@@ -11,17 +11,13 @@ Notes
 
 from __future__ import annotations
 
-from collections.abc import Generator
 from pathlib import Path
 from typing import cast
 
 import pytest
 
-import etlplus.file.yaml as yaml_module
-from etlplus.file import CompressionFormat
 from etlplus.file import File
 from etlplus.file import FileFormat
-from etlplus.file import infer_file_format_and_compression
 from etlplus.types import JSONDict
 
 # SECTION: HELPERS ========================================================== #
@@ -30,46 +26,6 @@ from etlplus.types import JSONDict
 pytestmark = pytest.mark.unit
 
 
-class _StubYaml:
-    """Minimal PyYAML substitute to avoid optional dependency in tests."""
-
-    def __init__(self) -> None:
-        self.dump_calls: list[dict[str, object]] = []
-
-    def safe_load(
-        self,
-        handle: object,
-    ) -> dict[str, str]:
-        """Stub for PyYAML's ``safe_load`` function."""
-        text = ''
-        if hasattr(handle, 'read'):  # type: ignore[call-arg]
-            text = handle.read()
-        return {'loaded': str(text).strip()}
-
-    def safe_dump(
-        self,
-        data: object,
-        handle: object,
-        **kwargs: object,
-    ) -> None:
-        """Stub for PyYAML's ``safe_dump`` function."""
-        self.dump_calls.append({'data': data, 'kwargs': kwargs})
-        if hasattr(handle, 'write'):
-            handle.write('yaml')  # type: ignore[call-arg]
-
-
-@pytest.fixture(name='yaml_stub')
-def yaml_stub_fixture() -> Generator[_StubYaml]:
-    """Install a stub PyYAML module for YAML tests."""
-    # pylint: disable=protected-access
-
-    stub = _StubYaml()
-    yaml_module._YAML_CACHE.clear()
-    yaml_module._YAML_CACHE['mod'] = stub
-    yield stub
-    yaml_module._YAML_CACHE.clear()
-
-
 # SECTION: TESTS ============================================================ #
 
 
@@ -82,18 +38,18 @@ class TestFile:
     - Exercises JSON detection and defers errors for unknown extensions.
     """
 
-    def test_classmethods_delegate(
+    def test_instance_methods_round_trip(
         self,
         tmp_path: Path,
     ) -> None:
         """
-        Test that ``read_file`` and ``write_file`` round-trip via classmethods.
+        Test :meth:`read` and :meth:`write` round-tripping data.
         """
         path = tmp_path / 'delegated.json'
         data = {'name': 'delegated'}
 
-        File.write_file(path, data, file_format='json')
-        result = File.read_file(path, file_format='json')
+        File(path, file_format=FileFormat.JSON).write(data)
+        result = File(path, file_format=FileFormat.JSON).read()
 
         assert isinstance(result, dict)
         assert result['name'] == 'delegated'
@@ -303,107 +259,3 @@ class TestFile:
         text = path.read_text(encoding='utf-8')
         assert text.startswith('<?xml')
         assert '<records>' in text
-
-
-class TestFileFormat:
-    """Unit test suite for :class:`etlplus.enums.FileFormat`."""
-
-    @pytest.mark.parametrize(
-        'value,expected',
-        [
-            ('JSON', FileFormat.JSON),
-            ('application/xml', FileFormat.XML),
-            ('yml', FileFormat.YAML),
-        ],
-    )
-    def test_aliases(
-        self,
-        value: str,
-        expected: FileFormat,
-    ) -> None:
-        """Test alias coercions."""
-        assert FileFormat.coerce(value) is expected
-
-    def test_coerce(self) -> None:
-        """Test :meth:`coerce`."""
-        assert FileFormat.coerce('csv') is FileFormat.CSV
-
-    def test_invalid_value(self) -> None:
-        """Test that invalid values raise ValueError."""
-        with pytest.raises(ValueError, match='Invalid FileFormat'):
-            FileFormat.coerce('ini')
-
-
-class TestInferFileFormatAndCompression:
-    """Unit test suite for :func:`infer_file_format_and_compression`."""
-
-    @pytest.mark.parametrize(
-        'value,filename,expected_format,expected_compression',
-        [
-            ('data.csv.gz', None, FileFormat.CSV, CompressionFormat.GZ),
-            ('data.jsonl.gz', None, FileFormat.NDJSON, CompressionFormat.GZ),
-            ('data.zip', None, None, CompressionFormat.ZIP),
-            ('application/json; charset=utf-8', None, FileFormat.JSON, None),
-            ('application/gzip', None, None, CompressionFormat.GZ),
-            (
-                'application/octet-stream',
-                'payload.csv.gz',
-                FileFormat.CSV,
-                CompressionFormat.GZ,
-            ),
-            ('application/octet-stream', None, None, None),
-            (FileFormat.GZ, None, None, CompressionFormat.GZ),
-            (CompressionFormat.ZIP, None, None, CompressionFormat.ZIP),
-        ],
-    )
-    def test_infers_format_and_compression(
-        self,
-        value: object,
-        filename: object | None,
-        expected_format: FileFormat | None,
-        expected_compression: CompressionFormat | None,
-    ) -> None:
-        """Test mixed inputs for format and compression inference."""
-        fmt, compression = infer_file_format_and_compression(value, filename)
-        assert fmt is expected_format
-        assert compression is expected_compression
-
-
-@pytest.mark.unit
-class TestYamlSupport:
-    """Unit tests exercising YAML read/write helpers without PyYAML."""
-
-    def test_read_yaml_uses_stub(
-        self,
-        tmp_path: Path,
-        yaml_stub: _StubYaml,
-    ) -> None:
-        """
-        Test reading YAML should invoke stub ``safe_load``.
-        """
-        # pylint: disable=protected-access
-
-        assert yaml_module._YAML_CACHE['mod'] is yaml_stub
-        path = tmp_path / 'data.yaml'
-        path.write_text('name: etl', encoding='utf-8')
-
-        result = File(path, FileFormat.YAML).read()
-
-        assert result == {'loaded': 'name: etl'}
-
-    def test_write_yaml_uses_stub(
-        self,
-        tmp_path: Path,
-        yaml_stub: _StubYaml,
-    ) -> None:
-        """
-        Test writing YAML should invoke stub ``safe_dump``.
-        """
-        path = tmp_path / 'data.yaml'
-        payload = [{'name': 'etl'}]
-
-        written = File(path, FileFormat.YAML).write(payload)
-
-        assert written == 1
-        assert yaml_stub.dump_calls
-        assert yaml_stub.dump_calls[0]['data'] == payload