etlplus 0.15.4__tar.gz → 0.15.5__tar.gz

{etlplus-0.15.4/etlplus.egg-info → etlplus-0.15.5}/PKG-INFO

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

{etlplus-0.15.4 → etlplus-0.15.5}/etlplus/api/auth.py

@@ -136,7 +136,7 @@ def _truncate(
     limit: int = MAX_LOG_BODY,
 ) -> str:
     """
-    Return ``text`` shortened to ``limit`` characters for logging.
+    Return *text* shortened to *limit* characters for logging.
 
     Parameters
     ----------

{etlplus-0.15.4 → etlplus-0.15.5}/etlplus/api/config.py

@@ -68,7 +68,7 @@ def _effective_service_defaults(
     fallback_headers: dict[str, str],
 ) -> tuple[str, dict[str, str]]:
     """
-    Return ``(base_url, headers)`` using ``profiles`` when present.
+    Return ``(base_url, headers)`` using *profiles* when present.
 
     Parameters
     ----------
@@ -87,7 +87,7 @@ def _effective_service_defaults(
     Raises
     ------
     TypeError
-        If no profiles are defined and ``fallback_base`` is not a string.
+        If no profiles are defined and *fallback_base* is not a string.
     """
     if profiles:
         name = 'default' if 'default' in profiles else next(iter(profiles))

{etlplus-0.15.4 → etlplus-0.15.5}/etlplus/api/endpoint_client.py

@@ -759,8 +759,8 @@ class EndpointClient:
         Raises
         ------
         KeyError
-            If ``endpoint_key`` is unknown or a required placeholder in the
-            path has no corresponding entry in ``path_parameters``.
+            If *endpoint_key* is unknown or a required placeholder in the path
+            has no corresponding entry in *path_parameters*.
         ValueError
             If the path template is invalid.
 
@@ -836,7 +836,7 @@ class EndpointClient:
         """
         Sleep for the specified seconds if positive.
 
-        The optional ``sleeper`` is useful for tests (e.g., pass
+        The optional *sleeper* is useful for tests (e.g., pass
         ``lambda s: None``). Defaults to using time.sleep when not provided.
 
         Parameters
@@ -870,7 +870,7 @@ class EndpointClient:
         rate_limit : RateLimitConfigMap | None
             Client-wide rate limit configuration.
         overrides : RateLimitOverrides, optional
-            Per-call overrides that take precedence over ``rate_limit``.
+            Per-call overrides that take precedence over *rate_limit*.
 
         Returns
         -------

{etlplus-0.15.4 → etlplus-0.15.5}/etlplus/api/pagination/config.py

@@ -398,7 +398,7 @@ class PaginationConfig(BoundsWarningsMixin):
         Returns
         -------
         Self | None
-            Parsed pagination configuration, or ``None`` if ``obj`` isn't a
+            Parsed pagination configuration, or ``None`` if *obj* isn't a
             mapping.
 
         Notes

{etlplus-0.15.4 → etlplus-0.15.5}/etlplus/api/pagination/paginator.py

@@ -66,14 +66,14 @@ def _resolve_path(
     path: str | None,
 ) -> Any:
     """
-    Resolve dotted ``path`` within ``obj`` or return ``_MISSING``.
+    Resolve dotted *path* within *obj* or return ``_MISSING``.
 
     Parameters
     ----------
     obj : Any
         JSON payload from an API response.
     path : str | None
-        Dotted path to the target value within ``obj``.
+        Dotted path to the target value within *obj*.
 
     Returns
     -------
@@ -665,7 +665,7 @@ class Paginator:
         records_path : str | None
             Optional dotted path to the records within the payload.
         fallback_path : str | None
-            Secondary dotted path consulted when ``records_path`` resolves to
+            Secondary dotted path consulted when *records_path* resolves to
             ``None`` or an empty list.
 
         Returns
@@ -675,9 +675,8 @@ class Paginator:
 
         Notes
         -----
-        Supports dotted path extraction via ``records_path`` and handles
-        lists, mappings, and scalars by coercing non-dict items into
-        ``{"value": x}``.
+        Supports dotted path extraction via *records_path* and handles lists,
+        mappings, and scalars by coercing non-dict items into ``{"value": x}``.
         """
         resolver = partial(_resolve_path, x)
         data = resolver(records_path)
@@ -729,7 +728,7 @@ class Paginator:
         Returns
         -------
         PaginationType | None
-            Detected pagination type, or ``default`` if not found.
+            Detected pagination type, or *default* if not found.
         """
         if not config:
             return default

{etlplus-0.15.4 → etlplus-0.15.5}/etlplus/api/rate_limiting/config.py

@@ -84,14 +84,14 @@ def _merge_rate_limit(
     overrides: RateLimitOverrides = None,
 ) -> dict[str, Any]:
     """
-    Merge ``rate_limit`` and ``overrides`` honoring override precedence.
+    Merge *rate_limit* and *overrides* honoring override precedence.
 
     Parameters
     ----------
     rate_limit : StrAnyMap | None
         Base rate-limit configuration.
     overrides : RateLimitOverrides, optional
-        Override configuration with precedence over ``rate_limit``.
+        Override configuration with precedence over *rate_limit*.
 
     Returns
     -------
@@ -274,7 +274,7 @@ class RateLimitConfig(BoundsWarningsMixin):
         rate_limit : StrAnyMap | RateLimitConfig | None, optional
             Base rate-limit configuration to normalize.
         overrides : RateLimitOverrides, optional
-            Override values that take precedence over ``rate_limit``.
+            Override values that take precedence over *rate_limit*.
 
         Returns
         -------
@@ -330,7 +330,7 @@ class RateLimitConfig(BoundsWarningsMixin):
         Returns
         -------
         Self | None
-            Parsed instance, or ``None`` if ``obj`` isn't a mapping.
+            Parsed instance, or ``None`` if *obj* isn't a mapping.
         """
         if obj is None:
             return None

{etlplus-0.15.4 → etlplus-0.15.5}/etlplus/api/rate_limiting/rate_limiter.py

@@ -235,7 +235,7 @@ class RateLimiter:
             Base rate-limit configuration. May contain ``"sleep_seconds"`` or
             ``"max_per_sec"``.
         overrides : RateLimitOverrides, optional
-            Optional overrides with the same keys as ``rate_limit``.
+            Optional overrides with the same keys as *rate_limit*.
 
         Returns
         -------

{etlplus-0.15.4 → etlplus-0.15.5}/etlplus/api/retry_manager.py

@@ -278,7 +278,7 @@ class RetryManager:
         **kwargs: Any,
     ) -> JSONData:
         """
-        Execute ``func`` with exponential-backoff retries.
+        Execute *func* with exponential-backoff retries.
 
         Parameters
         ----------
@@ -287,7 +287,7 @@ class RetryManager:
         url : str
             URL for the API request.
         **kwargs : Any
-            Additional keyword arguments to pass to ``func``
+            Additional keyword arguments to pass to *func*
 
         Returns
         -------

{etlplus-0.15.4 → etlplus-0.15.5}/etlplus/api/transport.py

@@ -309,7 +309,7 @@ def build_session_with_adapters(
     adapters_cfg: Sequence[HTTPAdapterMountConfig],
 ) -> requests.Session:
     """
-    Mount adapters described by ``adapters_cfg`` onto a new session.
+    Mount adapters described by *adapters_cfg* onto a new session.
 
     Ignores invalid adapter configurations so that a usable session is always
     returned.

{etlplus-0.15.4 → etlplus-0.15.5}/etlplus/api/types.py

@@ -61,10 +61,12 @@ _UNSET = object()
 
 class ApiConfigMap(TypedDict, total=False):
     """
-    Top-level API config shape parsed by ApiConfig.from_obj.
+    Top-level API config shape parsed by
+    :meth:`etlplus.api.config.ApiConfig.from_obj`.
 
-    Either provide a ``base_url`` with optional ``headers`` and ``endpoints``,
-    or provide ``profiles`` with at least one profile having a ``base_url``.
+    Either provide a :attr:`base_url` with optional :attr:`headers` and
+    :attr:`endpoints`, or provide :attr:`profiles` with at least one profile
+    having a :attr:`base_url`.
 
     See Also
     --------
@@ -79,11 +81,14 @@ class ApiConfigMap(TypedDict, total=False):
 
 class ApiProfileConfigMap(TypedDict, total=False):
     """
-    Shape accepted for a profile entry under ApiConfigMap.profiles.
+    Shape accepted for a profile entry under
+    :meth:`etlplus.api.config.ApiConfig.from_obj`.
 
     Notes
     -----
-    ``base_url`` is required at runtime when profiles are provided.
+    - :attr:`base_url` is required at runtime when :attr:`profiles` key/value
+        pairs are provided.
+    - :meth:`etlplus.api.config.ApiProfileConfig.from_obj` parses this mapping.
 
     See Also
     --------
@@ -103,7 +108,12 @@ class ApiProfileDefaultsMap(TypedDict, total=False):
 
     Notes
     -----
-    Runtime expects header values to be str; typing remains permissive.
+    - Runtime expects header values to be ``str``; typing remains permissive.
+    - :meth:`etlplus.api.config.ApiProfileConfig.from_obj` consumes this block.
+    - :meth:`etlplus.api.pagination.PaginationConfig.from_obj` parses
+        :attr:`pagination`.
+    - :meth:`etlplus.api.rate_limiting.RateLimitConfig.from_obj` parses
+        :attr:`rate_limit`.
 
     See Also
     --------
@@ -113,15 +123,15 @@ class ApiProfileDefaultsMap(TypedDict, total=False):
     """
 
     headers: StrAnyMap
-    pagination: Any
-    rate_limit: Any
+    pagination: StrAnyMap  # PaginationConfigMap | StrAnyMap
+    rate_limit: StrAnyMap  # RateLimitConfigMap | StrAnyMap
 
 
 class EndpointMap(TypedDict, total=False):
     """
-    Shape accepted by EndpointConfig.from_obj.
+    Shape accepted by :meth:`etlplus.api.config.EndpointConfig.from_obj`.
 
-    One of ``path`` or ``url`` should be provided.
+    One of :attr:`path` or :attr:`url` should be provided.
 
     See Also
     --------
@@ -134,8 +144,8 @@ class EndpointMap(TypedDict, total=False):
     path_params: StrAnyMap
     query_params: StrAnyMap
     body: Any
-    pagination: Any
-    rate_limit: Any
+    pagination: StrAnyMap  # PaginationConfigMap | StrAnyMap
+    rate_limit: StrAnyMap  # RateLimitConfigMap | StrAnyMap
 
 
 # SECTION: DATA CLASSES ===================================================== #

{etlplus-0.15.4 → etlplus-0.15.5}/etlplus/api/utils.py

@@ -172,7 +172,7 @@ def _coalesce(
     *args: Any,
 ) -> Any | None:
     """
-    Return the first non-``None`` value from ``args``.
+    Return the first non-``None`` value from *args*.
 
     Parameters
     ----------

{etlplus-0.15.4 → etlplus-0.15.5}/etlplus/cli/handlers.py

@@ -505,7 +505,7 @@ def run_handler(
         Name of the job to run. If not provided, runs the entire pipeline.
         Default is ``None``.
     pipeline : str | None, optional
-        Alias for ``job``. Default is ``None``.
+        Alias for *job*. Default is ``None``.
     pretty : bool, optional
         Whether to pretty-print output. Default is ``True``.
 

{etlplus-0.15.4 → etlplus-0.15.5}/etlplus/cli/io.py

@@ -71,7 +71,7 @@ def emit_or_write(
     success_message: str,
 ) -> None:
     """
-    Emit JSON or persist to disk based on ``output_path``.
+    Emit JSON or persist to disk based on *output_path*.
 
     Parameters
     ----------
@@ -122,7 +122,7 @@ def materialize_file_payload(
     format_explicit: bool,
 ) -> JSONData | object:
     """
-    Return structured payloads when ``source`` references a file.
+    Return structured payloads when *source* references a file.
 
     Parameters
     ----------

{etlplus-0.15.4 → etlplus-0.15.5}/etlplus/cli/main.py

@@ -44,7 +44,7 @@ def _emit_context_help(
     Returns
     -------
     bool
-        ``True`` when help was emitted, ``False`` when ``ctx`` was ``None``.
+        ``True`` when help was emitted, ``False`` when *ctx* was ``None``.
     """
     if ctx is None:
         return False

{etlplus-0.15.4 → etlplus-0.15.5}/etlplus/database/ddl.py

@@ -233,7 +233,7 @@ def render_table_sql(
     template : TemplateKey | None, optional
         Template key to use (default: 'ddl').
     template_path : str | None, optional
-        Path to a custom template file (overrides ``template``).
+        Path to a custom template file (overrides *template*).
 
     Returns
     -------
@@ -264,7 +264,7 @@ def render_tables(
     template : TemplateKey | None, optional
         Template key to use (default: 'ddl').
     template_path : str | None, optional
-        Path to a custom template file (overrides ``template``).
+        Path to a custom template file (overrides *template*).
 
     Returns
     -------

{etlplus-0.15.4 → etlplus-0.15.5}/etlplus/database/engine.py

@@ -87,7 +87,7 @@ def load_database_url_from_config(
     Extract a database URL/DSN from a YAML/JSON config file.
 
     The loader is schema-tolerant: it looks for a top-level "databases" map
-    and then for a named entry (``name``). Each entry may contain either a
+    and then for a named entry (*name*). Each entry may contain either a
     ``connection_string``/``url``/``dsn`` or a nested ``default`` block with
     those fields.
 

{etlplus-0.15.4 → etlplus-0.15.5}/etlplus/enums.py

@@ -76,7 +76,7 @@ class CoercibleStrEnum(enum.StrEnum):
     @classmethod
     def coerce(cls, value: Self | str | object) -> Self:
         """
-        Convert an enum member or string-like input to a member of ``cls``.
+        Convert an enum member or string-like input to a member of *cls*.
 
         Parameters
         ----------

{etlplus-0.15.4 → etlplus-0.15.5}/etlplus/file/_imports.py

@@ -12,6 +12,7 @@ from typing import Any
 # SECTION: INTERNAL CONSTANTS =============================================== #
 
 
+# Optional Python module support (lazy-loaded to avoid hard dependency)
 _MODULE_CACHE: dict[str, Any] = {}
 
 

{etlplus-0.15.4 → etlplus-0.15.5}/etlplus/file/_io.py

@@ -24,7 +24,7 @@ def coerce_record_payload(
     format_name: str,
 ) -> JSONData:
     """
-    Validate that ``payload`` is an object or list of objects.
+    Validate that *payload* is an object or list of objects.
 
     Parameters
     ----------
@@ -36,7 +36,7 @@ def coerce_record_payload(
     Returns
     -------
     JSONData
-        ``payload`` when it is a dict or a list of dicts.
+        *payload* when it is a dict or a list of dicts.
 
     Raises
     ------
@@ -89,9 +89,13 @@ def normalize_records(
     return [cast(JSONDict, data)]
 
 
-def read_delimited(path: Path, *, delimiter: str) -> JSONList:
+def read_delimited(
+    path: Path,
+    *,
+    delimiter: str,
+) -> JSONList:
     """
-    Read delimited content from ``path``.
+    Read delimited content from *path*.
 
     Parameters
     ----------
@@ -118,9 +122,14 @@ def read_delimited(path: Path, *, delimiter: str) -> JSONList:
     return rows
 
 
-def write_delimited(path: Path, data: JSONData, *, delimiter: str) -> int:
+def write_delimited(
+    path: Path,
+    data: JSONData,
+    *,
+    delimiter: str,
+) -> int:
     """
-    Write ``data`` to a delimited file and return record count.
+    Write *data* to a delimited file and return record count.
 
     Parameters
     ----------

{etlplus-0.15.4 → etlplus-0.15.5}/etlplus/file/accdb.py

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

{etlplus-0.15.4 → etlplus-0.15.5}/etlplus/file/arrow.py

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

{etlplus-0.15.4 → etlplus-0.15.5}/etlplus/file/avro.py

@@ -33,6 +33,7 @@ from ._io import normalize_records
 
 
 __all__ = [
+    # Functions
     'read',
     'write',
 ]
@@ -124,7 +125,7 @@ def read(
     path: Path,
 ) -> JSONList:
     """
-    Read AVRO content from ``path``.
+    Read AVRO content from *path*.
 
     Parameters
     ----------
@@ -147,7 +148,7 @@ def write(
     data: JSONData,
 ) -> int:
     """
-    Write ``data`` to AVRO at ``path`` and return record count.
+    Write *data* to AVRO at *path* and return record count.
 
     Parameters
     ----------

{etlplus-0.15.4 → etlplus-0.15.5}/etlplus/file/bson.py

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

{etlplus-0.15.4 → etlplus-0.15.5}/etlplus/file/cbor.py

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

{etlplus-0.15.4 → etlplus-0.15.5}/etlplus/file/cfg.py

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

{etlplus-0.15.4 → etlplus-0.15.5}/etlplus/file/conf.py

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