oups 2025.9.5__tar.gz

oups-2025.9.5/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2025, pierrot
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

oups-2025.9.5/PKG-INFO

@@ -0,0 +1,44 @@
+Metadata-Version: 2.3
+Name: oups
+Version: 2025.9.5
+Summary: Out-of-core pipelines over ordered data: StatefulLoop, stateful ops, and ordered Parquet Store.
+License: Apache-2.0
+Keywords: out-of-core,streaming,stateful,time-series,pandas,parquet,data-engineering
+Author: pierrot
+Requires-Python: >=3.13,<4.0
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.13
+Requires-Dist: cloudpickle (>=3.1.1)
+Requires-Dist: fastparquet (>=2023.10.1)
+Requires-Dist: flufl-lock (>=8.2.0)
+Requires-Dist: joblib (>=1.3.2)
+Requires-Dist: numba (>=0.61.2)
+Requires-Dist: numpy (>=2.0)
+Requires-Dist: pandas (>=2.2.3)
+Requires-Dist: sortedcontainers (>=2.4.0)
+Project-URL: Changelog, https://codeberg.org/pierrot/oups/src/branch/main/CHANGELOG.md
+Project-URL: Documentation, https://codeberg.org/pierrot/oups/src/branch/main/docs
+Project-URL: Homepage, https://codeberg.org/pierrot/oups
+Project-URL: Issues, https://codeberg.org/pierrot/oups/issues
+Project-URL: Source, https://codeberg.org/pierrot/oups
+Description-Content-Type: text/markdown
+
+# Welcome to oups!
+
+## What is oups?
+*oups* stands for Ordered Unified Processing Stack — out-of-core processing for ordered data (batch + live).
+
+*oups* is a Python toolkit for building end-to-end pipelines over ordered data with the same code in offline training and live streaming/batch contexts.
+
+It centers on ``StatefulLoop`` (``loop.bind_function_state``, ``loop.iterate``, ``loop.buffer``), which binds and persists function/object state, orchestrates chunked iteration, and buffers DataFrames under a memory cap with flush-on-limit or last-iteration semantics.
+Complementing the loop, ``stateful_ops`` provides vectorized, chunk-friendly primitives like ``AsofMerger`` for multi-DataFrame as-of joins (with optional windows of previous values) and ``SegmentedAggregator`` (planned) for streamed segmentation and aggregation.
+The ``store`` package manages ordered Parquet datasets via schema-driven keys (``@toplevel``), supports incremental updates (``store[key].write(...)``) and duplicate handling, and offers synchronized iteration across datasets via ``store.iter_intersections(...)`` with optional warm-up (``n_prev``).
+
+Together these pieces enable out-of-core processing with resumability, and deterministic buffering. The design favors explicit, minimal APIs and reproducible results, aligning offline feature generation with online serving.
+
+## Links
+
+- 📖 **[Documentation](https://pierrot.codeberg.page/oups/)** - Guides and API reference
+- 📋 **[Changelog](CHANGELOG.md)** - Release notes and version history
+

oups-2025.9.5/README.md

@@ -0,0 +1,17 @@
+# Welcome to oups!
+
+## What is oups?
+*oups* stands for Ordered Unified Processing Stack — out-of-core processing for ordered data (batch + live).
+
+*oups* is a Python toolkit for building end-to-end pipelines over ordered data with the same code in offline training and live streaming/batch contexts.
+
+It centers on ``StatefulLoop`` (``loop.bind_function_state``, ``loop.iterate``, ``loop.buffer``), which binds and persists function/object state, orchestrates chunked iteration, and buffers DataFrames under a memory cap with flush-on-limit or last-iteration semantics.
+Complementing the loop, ``stateful_ops`` provides vectorized, chunk-friendly primitives like ``AsofMerger`` for multi-DataFrame as-of joins (with optional windows of previous values) and ``SegmentedAggregator`` (planned) for streamed segmentation and aggregation.
+The ``store`` package manages ordered Parquet datasets via schema-driven keys (``@toplevel``), supports incremental updates (``store[key].write(...)``) and duplicate handling, and offers synchronized iteration across datasets via ``store.iter_intersections(...)`` with optional warm-up (``n_prev``).
+
+Together these pieces enable out-of-core processing with resumability, and deterministic buffering. The design favors explicit, minimal APIs and reproducible results, aligning offline feature generation with online serving.
+
+## Links
+
+- 📖 **[Documentation](https://pierrot.codeberg.page/oups/)** - Guides and API reference
+- 📋 **[Changelog](CHANGELOG.md)** - Release notes and version history

oups-2025.9.5/oups/__init__.py

@@ -0,0 +1,40 @@
+#!/usr/bin/env python3
+"""
+Created on Wed Dec  1 18:35:00 2021.
+
+@author: pierrot
+
+"""
+import sys
+
+# Import version dynamically from Poetry
+from importlib.metadata import PackageNotFoundError
+from importlib.metadata import version
+
+
+# Conditional import for stateful_ops to avoid numba issues during documentation builds
+if "sphinx" in sys.modules:
+    # During documentation builds, skip heavy stateful_ops imports
+    AggStream = None
+    by_x_rows = None
+else:
+    from .stateful_ops import AggStream
+    from .stateful_ops import by_x_rows
+
+from .stateful_loop import StatefulLoop
+from .stateful_ops import AsofMerger
+from .store import OrderedParquetDataset
+from .store import Store
+from .store import check_cmidx
+from .store import conform_cmidx
+from .store import is_toplevel
+from .store import sublevel
+from .store import toplevel
+from .store import write
+
+
+try:
+    __version__ = version("oups")
+except PackageNotFoundError:
+    # Package is not installed, likely in development
+    __version__ = "development"

oups-2025.9.5/oups/date_utils.py

@@ -0,0 +1,62 @@
+#!/usr/bin/env python3
+"""
+Created on Sat May 24 18:35:00 2025.
+
+@author: pierrot
+
+"""
+from pandas import Timedelta
+from pandas import Timestamp
+from pandas import date_range
+
+
+def floor_ts(ts: Timestamp, freq: str) -> Timestamp:
+    """
+    Floor a timestamp even if using non-fixed frequency.
+
+    Parameters
+    ----------
+    ts : Timestamp
+        Timestamp to floor.
+    freq : str
+        Frequency string.
+        https://pandas.pydata.org/pandas-docs/stable/user_guide/timeseries.html#timeseries-offset-aliases
+
+
+    Returns
+    -------
+    Timestamp
+        Floored timestamp.
+
+    """
+    try:
+        return ts.floor(freq)
+    except ValueError:
+        return date_range(end=ts.normalize(), periods=1, freq=freq)[0]
+
+
+def ceil_ts(ts: Timestamp, freq: str) -> Timestamp:
+    """
+    Ceil a timestamp even if using non-fixed frequency.
+
+    Parameters
+    ----------
+    ts : Timestamp
+        Timestamp to ceil.
+    freq : str
+        Frequency string.
+        https://pandas.pydata.org/pandas-docs/stable/user_guide/timeseries.html#timeseries-offset-aliases
+
+    Returns
+    -------
+    Timestamp
+        Ceiled timestamp.
+
+    """
+    try:
+        # Can't use 'ceil' from pandas because it does not work on 'D'aily
+        # frequency.
+        # return ts.ceil(freq)
+        return (ts + Timedelta(1, unit=freq)).floor(freq)
+    except ValueError:
+        return date_range(start=floor_ts(ts, freq), periods=2, freq=freq)[1]

oups-2025.9.5/oups/defines.py

@@ -0,0 +1,26 @@
+#!/usr/bin/env python3
+"""
+Created on Wed Dec  1 18:35:00 2021.
+
+@author: pierrot
+
+"""
+# Central key in oups world, used as ID of the column name according which
+# dataframes are ordered.
+KEY_ORDERED_ON = "ordered_on"
+# Other shared keys.
+KEY_FILE_IDS = "file_ids"
+KEY_N_ROWS = "n_rows"
+KEY_ORDERED_ON_MINS = "ordered_on_mins"
+KEY_ORDERED_ON_MAXS = "ordered_on_maxs"
+# A specific key for a function parameter with a three-fold type:
+# - None, meaning no duplicates check,
+# - an empty list, meaning identify duplicate on all columns of the dataframe,
+# - a not empty list of a string, the columns to identify row duplicates.
+KEY_DUPLICATES_ON = "duplicates_on"
+# In a fastparquet `ParquetFile`, oups-specific metadata is stored as value for
+# key `KEY_METADATA_KEY`.
+KEY_OUPS_METADATA = "oups"
+# Parameters for 'write()' function.
+KEY_ROW_GROUP_TARGET_SIZE = "row_group_target_size"
+KEY_MAX_N_OFF_TARGET_RGS = "max_n_off_target_rgs"

oups-2025.9.5/oups/numpy_utils.py

@@ -0,0 +1,114 @@
+#!/usr/bin/env python3
+"""
+Created on Mon Jun 02 18:35:00 2025.
+
+@author: pierrot
+
+"""
+
+from numpy import arange
+from numpy import flip
+from numpy import isnan
+from numpy import maximum
+from numpy import ones
+from numpy import searchsorted
+from numpy import where
+from numpy.typing import NDArray
+
+
+def isnotin_ordered(
+    sorted_array: NDArray,
+    query_elements: NDArray,
+    return_insert_positions: bool = False,
+) -> NDArray | tuple[NDArray, NDArray]:
+    """
+    Check if query elements are not present in a sorted array.
+
+    Parameters
+    ----------
+    sorted_array : NDArray
+        Sorted array in which to search for elements.
+        Must be sorted in ascending order.
+    query_elements : NDArray
+        Array of elements to search for.
+        Must be sorted in ascending order if containing elements which are
+        are larger than the largest element in 'sorted_array'.
+    return_insert_positions : bool, optional
+        If True, also return the insert positions where unfound elements
+        could be inserted into 'sorted_array', maintaining sort order.
+        Default is False.
+
+    Returns
+    -------
+    Union[NDArray, tuple[NDArray, NDArray]]
+        If 'return_insert_positions' is False:
+            Array of booleans with same length as 'query_elements', where
+            True indicates the element is not found in 'sorted_array'.
+        If 'return_insert_positions' is True:
+            Tuple containing:
+            - Array of booleans indicating which query elements are not found,
+            - Array of insert positions for unfound elements (where they could
+              be inserted into 'sorted_array', maintaining sort order)
+
+    Examples
+    --------
+    >>> sorted_arr = np.array([1, 3, 5, 7, 9])
+    >>> queries = np.array([2, 3, 6, 7])
+    >>> isnotin_ordered(sorted_arr, queries)
+    array([True, False, True, False])
+
+    >>> not_found, insert_positions = isnotin_ordered(sorted_arr, queries, return_insert_positions=True)
+    >>> not_found
+    array([True, False, True, False])
+    >>> insert_positions
+    array([1, 3])  # positions where 2 and 6 could be inserted
+
+    """
+    insert_idx = searchsorted(sorted_array, query_elements, side="left")
+    # Check if elements are found: they exist if insert position is valid
+    # and the element at that position matches the query
+    found_max_idx = searchsorted(insert_idx, len(sorted_array))
+    is_not_found = ones(len(query_elements), dtype=bool)
+    is_not_found[:found_max_idx] = sorted_array[insert_idx[:found_max_idx]] != query_elements[:found_max_idx]
+    return (is_not_found, insert_idx[is_not_found]) if return_insert_positions else is_not_found
+
+
+def ffill1d(arr: NDArray) -> NDArray:
+    """
+    Forward fill 1D array in-place.
+
+    Parameters
+    ----------
+    arr : NDArray
+        Array to fill.
+
+    Returns
+    -------
+    None
+
+    Notes
+    -----
+    If first value is nan, it is kept as nan.
+
+    """
+    mask = isnan(arr)
+    idx = where(~mask, arange(mask.size), 0)
+    maximum.accumulate(idx, out=idx)
+    arr[mask] = arr[idx[mask]]
+
+
+def bfill1d(arr: NDArray) -> NDArray:
+    """
+    Backward fill 1D array in-place.
+
+    Parameters
+    ----------
+    arr : NDArray
+        Array to fill.
+
+    Returns
+    -------
+    None
+
+    """
+    ffill1d(flip(arr, 0))

oups-2025.9.5/oups/stateful_loop/__init__.py

@@ -0,0 +1,14 @@
+#!/usr/bin/env python3
+"""
+OUPS Stateful Loop Module.
+
+This module provides the core stateful loop functionality.
+
+"""
+
+from .stateful_loop import StatefulLoop
+
+
+__all__ = [
+    "StatefulLoop",
+]

oups-2025.9.5/oups/stateful_loop/loop_persistence_io.py

@@ -0,0 +1,55 @@
+#!/usr/bin/env python3
+"""
+Created on Wed Jun  1 18:35:00 2025.
+
+Loop persistence I/O helpers for the stateful loop.
+
+"""
+from pathlib import Path
+from typing import Any
+
+from cloudpickle import dump
+from cloudpickle import load
+
+
+KEY_ID = "id"
+KEY_VERSION = "version"
+KEY_STATES = "states"
+PERSISTENCE_ID = "stateful_loop"
+PERSISTENCE_VERSION = 1
+
+
+class LoopPersistenceIO:
+    """
+    Helper for reading and writing the loop persistence file with schema validation.
+
+    Schema: {"id": "stateful_loop", "version": 1, "states": {...}}.
+
+    """
+
+    @staticmethod
+    def load(path: Path) -> dict[str, dict[str, Any]]:
+        """
+        Load and validate states from ``path``.
+        """
+        with open(path, "rb") as f:
+            payload = load(f)
+        if not isinstance(payload, dict):
+            raise ValueError("invalid persistence file format.")
+        if payload[KEY_ID] != PERSISTENCE_ID:
+            raise ValueError("invalid persistence file id.")
+        if payload[KEY_VERSION] != PERSISTENCE_VERSION:
+            raise ValueError("unsupported persistence file version.")
+        states = payload[KEY_STATES]
+        if not isinstance(states, dict):
+            raise ValueError("invalid 'states' content in persistence file.")
+        return states
+
+    @staticmethod
+    def save(path: Path, states: dict[str, dict[str, Any]]) -> None:
+        """
+        Save ``states`` to ``path`` with schema and version.
+        """
+        payload = {KEY_ID: PERSISTENCE_ID, KEY_VERSION: PERSISTENCE_VERSION, KEY_STATES: states}
+        with open(path, "wb") as f:
+            dump(payload, f)