generic_time_series_objects 0.1.1__tar.gz

generic_time_series_objects-0.1.1/.gitignore

@@ -0,0 +1 @@
+/target

generic_time_series_objects-0.1.1/.idea/.gitignore

@@ -0,0 +1,8 @@
+# Default ignored files
+/shelf/
+/workspace.xml
+# Editor-based HTTP Client requests
+/httpRequests/
+# Datasource local storage ignored files
+/dataSources/
+/dataSources.local.xml

generic_time_series_objects-0.1.1/.idea/markdown.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="MarkdownSettings">
+    <option name="showProblemsInCodeBlocks" value="false" />
+  </component>
+</project>

generic_time_series_objects-0.1.1/.idea/misc.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="Black">
+    <option name="sdkName" value="Python 3.13" />
+  </component>
+</project>

generic_time_series_objects-0.1.1/.idea/modules.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectModuleManager">
+    <modules>
+      <module fileurl="file://$PROJECT_DIR$/.idea/rust-time-series-objects.iml" filepath="$PROJECT_DIR$/.idea/rust-time-series-objects.iml" />
+    </modules>
+  </component>
+</project>

generic_time_series_objects-0.1.1/.idea/rust-time-series-objects.iml

@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="EMPTY_MODULE" version="4">
+  <component name="FacetManager">
+    <facet type="Python" name="Python facet">
+      <configuration sdkName="Python 3.13" />
+    </facet>
+  </component>
+  <component name="NewModuleRootManager">
+    <content url="file://$MODULE_DIR$">
+      <sourceFolder url="file://$MODULE_DIR$/src" isTestSource="false" />
+      <excludeFolder url="file://$MODULE_DIR$/target" />
+    </content>
+    <orderEntry type="inheritedJdk" />
+    <orderEntry type="sourceFolder" forTests="false" />
+    <orderEntry type="library" name="Python 3.13 interpreter library" level="application" />
+  </component>
+</module>

generic_time_series_objects-0.1.1/.idea/vcs.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="VcsDirectoryMappings">
+    <mapping directory="" vcs="Git" />
+  </component>
+</project>

generic_time_series_objects-0.1.1/.pypirc

@@ -0,0 +1,3 @@
+[pypi]
+username = __token__
+password = pypi-AgEIcHlwaS5vcmcCJDljM2Q5MmQ4LTNjMTEtNDNmMS1hNWRhLTc0OGQ5NGY4ZTA3MQACKlszLCI3OTVlNTRjMy1hNzZmLTQ0OTEtODA4NS0xMWRmMTM0MzNlMmYiXQAABiCvQEudVPmfG4FJND575iuRP6SEApezPp1WkBfFy11_sA

generic_time_series_objects-0.1.1/Cargo.lock

@@ -0,0 +1,172 @@
+# This file is automatically @generated by Cargo.
+# It is not intended for manual editing.
+version = 4
+
+[[package]]
+name = "autocfg"
+version = "1.5.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "c08606f8c3cbf4ce6ec8e28fb0014a2c086708fe954eaa885384a6165172e7e8"
+
+[[package]]
+name = "generic_time_series_objects"
+version = "0.1.0"
+dependencies = [
+ "pyo3",
+]
+
+[[package]]
+name = "heck"
+version = "0.5.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "2304e00983f87ffb38b55b444b5e3b60a884b5d30c0fca7d82fe33449bbe55ea"
+
+[[package]]
+name = "indoc"
+version = "2.0.7"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "79cf5c93f93228cf8efb3ba362535fb11199ac548a09ce117c9b1adc3030d706"
+dependencies = [
+ "rustversion",
+]
+
+[[package]]
+name = "libc"
+version = "0.2.177"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "2874a2af47a2325c2001a6e6fad9b16a53b802102b528163885171cf92b15976"
+
+[[package]]
+name = "memoffset"
+version = "0.9.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "488016bfae457b036d996092f6cb448677611ce4449e970ceaf42695203f218a"
+dependencies = [
+ "autocfg",
+]
+
+[[package]]
+name = "once_cell"
+version = "1.21.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "42f5e15c9953c5e4ccceeb2e7382a716482c34515315f7b03532b8b4e8393d2d"
+
+[[package]]
+name = "portable-atomic"
+version = "1.11.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "f84267b20a16ea918e43c6a88433c2d54fa145c92a811b5b047ccbe153674483"
+
+[[package]]
+name = "proc-macro2"
+version = "1.0.103"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "5ee95bc4ef87b8d5ba32e8b7714ccc834865276eab0aed5c9958d00ec45f49e8"
+dependencies = [
+ "unicode-ident",
+]
+
+[[package]]
+name = "pyo3"
+version = "0.27.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "ab53c047fcd1a1d2a8820fe84f05d6be69e9526be40cb03b73f86b6b03e6d87d"
+dependencies = [
+ "indoc",
+ "libc",
+ "memoffset",
+ "once_cell",
+ "portable-atomic",
+ "pyo3-build-config",
+ "pyo3-ffi",
+ "pyo3-macros",
+ "unindent",
+]
+
+[[package]]
+name = "pyo3-build-config"
+version = "0.27.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "b455933107de8642b4487ed26d912c2d899dec6114884214a0b3bb3be9261ea6"
+dependencies = [
+ "target-lexicon",
+]
+
+[[package]]
+name = "pyo3-ffi"
+version = "0.27.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "1c85c9cbfaddf651b1221594209aed57e9e5cff63c4d11d1feead529b872a089"
+dependencies = [
+ "libc",
+ "pyo3-build-config",
+]
+
+[[package]]
+name = "pyo3-macros"
+version = "0.27.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "0a5b10c9bf9888125d917fb4d2ca2d25c8df94c7ab5a52e13313a07e050a3b02"
+dependencies = [
+ "proc-macro2",
+ "pyo3-macros-backend",
+ "quote",
+ "syn",
+]
+
+[[package]]
+name = "pyo3-macros-backend"
+version = "0.27.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "03b51720d314836e53327f5871d4c0cfb4fb37cc2c4a11cc71907a86342c40f9"
+dependencies = [
+ "heck",
+ "proc-macro2",
+ "pyo3-build-config",
+ "quote",
+ "syn",
+]
+
+[[package]]
+name = "quote"
+version = "1.0.41"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "ce25767e7b499d1b604768e7cde645d14cc8584231ea6b295e9c9eb22c02e1d1"
+dependencies = [
+ "proc-macro2",
+]
+
+[[package]]
+name = "rustversion"
+version = "1.0.22"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "b39cdef0fa800fc44525c84ccb54a029961a8215f9619753635a9c0d2538d46d"
+
+[[package]]
+name = "syn"
+version = "2.0.108"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "da58917d35242480a05c2897064da0a80589a2a0476c9a3f2fdc83b53502e917"
+dependencies = [
+ "proc-macro2",
+ "quote",
+ "unicode-ident",
+]
+
+[[package]]
+name = "target-lexicon"
+version = "0.13.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "df7f62577c25e07834649fc3b39fafdc597c0a3527dc1c60129201ccfcbaa50c"
+
+[[package]]
+name = "unicode-ident"
+version = "1.0.20"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "462eeb75aeb73aea900253ce739c8e18a67423fadf006037cd3ff27e82748a06"
+
+[[package]]
+name = "unindent"
+version = "0.2.4"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "7264e107f553ccae879d21fbea1d6724ac785e8c3bfc762137959b5802826ef3"

generic_time_series_objects-0.1.1/Cargo.toml

@@ -0,0 +1,15 @@
+[package]
+name = "generic_time_series_objects"
+version = "0.1.0"
+edition = "2024"
+readme = "README.md"
+
+[lib]
+name = "generic_time_series_objects"
+crate-type = ["cdylib"]
+
+[dependencies]
+
+[dependencies.pyo3]
+version = "0.27.0"
+features = ["abi3-py38"]

generic_time_series_objects-0.1.1/PKG-INFO

@@ -0,0 +1,6 @@
+Metadata-Version: 2.4
+Name: generic_time_series_objects
+Version: 0.1.1
+Requires-Dist: pytest>=8.4.2
+Summary: Generic Time Series Objects for Python
+Requires-Python: >=3.13

generic_time_series_objects-0.1.1/README.md

@@ -0,0 +1,257 @@
+# [Generic Time Series Objects](https://pypi.org/project/generic-time-series-objects/)
+Store Python objects in a time series to capture evolving data over time. Built to be highly
+generic and capable of storing any python class, even custom, against a timestamp (integer) 
+value. This project is built in rust, with [pyo3](https://github.com/PyO3/pyo3) bindings, and 
+compiled using [maturin](https://github.com/PyO3/maturin). Tests are written in python 
+(with pytest).
+
+> [!NOTE]
+>
+> Rust code is compiled using `maturin develop --uv` (or `maturin develop --uv --release`). <br>
+> Test cases are then run using `pytest .\python\test_ts.py`.
+
+> [!IMPORTANT]
+> 
+> Work in progress:
+> - [ ] Time Series Data BaseClass to manage methods as timeseries that can change through time.
+> - [ ] Add further tests to `test_ts.py`
+> - [ ] Proper set up of `test_ts_data_class.py`
+> - [ ] Migrate the Time Series Data BaseClass into `lib.rs`
+
+## TimeSeriesObject Interface
+Methods to interact with the TimeSeriesObject Class.
+### Dunder Methods
+#### __new\_\_
+Creates the object with no arguments. <br>
+_Arguments_
+*  **`self`** (`TimeSeriesObject`): The object itself.
+
+_Output/Exceptions_
+*  (`TimeSeriesObject`): Returns the created object.
+
+_Example:_
+```python
+from generic_time_series_objects import TimeSeriesObject
+
+obj = TimeSeriesObject()
+```
+#### __repr\_\_
+Representation of the object. <br>
+_Arguments_
+*  **`self`** (`TimeSeriesObject`): The object itself.
+
+_Output/Exceptions_
+*  (`str`): Returns a string with the object name and a list of timestamps.
+
+_Example:_
+```python
+from generic_time_series_objects import TimeSeriesObject
+
+obj = TimeSeriesObject()
+print(obj)  # prints "TimeSeriesObject(timestamps=[])"
+```
+#### __len\_\_
+Returns the number of data points currently stored in the time series object. <br>
+_Arguments_
+*  **`self`** (`TimeSeriesObject`): The object itself.
+
+_Output/Exceptions_
+* (`int`): Number of data points inserted into the object.
+
+_Example:_
+```python
+from generic_time_series_objects import TimeSeriesObject
+
+obj = TimeSeriesObject()
+print(len(obj))  # prints 0
+```
+#### __bool\_\_
+Returns a boolean for if the object contains data points or not. <br>
+_Arguments_
+*  **`self`** (`TimeSeriesObject`): The object itself.
+
+_Output/Exceptions_
+*  (`bool`): False if there are no data points, otherwise True.
+
+_Example:_
+```python
+from generic_time_series_objects import TimeSeriesObject
+
+obj = TimeSeriesObject()
+print(bool(obj))  # prints False
+```
+### Mutating Data
+Methods return None for success and raises Exception if failed to perform operation.
+#### insert
+Inserts a Python object at a given timestamp. <br>
+_Arguments_
+*  **`self`** (`TimeSeriesObject`): The object itself.
+*  **`ts`** (`int`): Timestamp of the data point.
+*  **`value`** (`Any`): The Python object to be stored.
+*  **`overwrite`** (`bool`): Defaults to `False`. Determines what to do if a provided timestamp already exists, if 
+`overwrite=False`, raises Exception otherwise overwrites the existing data point.
+
+_Output/Exceptions_
+*  (`None`): Successfully inserted data point at timestamp.
+* **`ValueError`** (`Exception`): Timestamp provided already has existing data point and overwrite is set to False.
+
+_Example:_
+```python
+from generic_time_series_objects import TimeSeriesObject
+
+obj = TimeSeriesObject()
+obj.insert(1, {1, 2, 3})  # overwrite defaults to False
+# obj.insert(1, {1, 2, 3})  # !raises ValueError
+obj.insert(1, {1, 2, 3}, overwrite=True)
+```
+#### update
+Updates the point at a given timestamp. <br>
+_Arguments_
+*  **`self`** (`TimeSeriesObject`): The object itself.
+*  **`ts`** (`int`): Timestamp of the point we want to update.
+*  **`value`** (`Any`): The Python object we want to update with.
+
+_Output/Exceptions_
+*  (`None`): Successfully inserted Python object at timestamp.
+*  **`ValueError`** (`Exception`): TimeSeriesObject is empty and could not update.
+*  **`IndexError`** (`Exception`): Provided timestamp does not exist within TimeSeriesObject.
+
+_Example:_
+```python
+from generic_time_series_objects import TimeSeriesObject
+
+obj = TimeSeriesObject()
+# obj.update(2, {1, 2, 3, 4})  # !raises ValueError
+obj.insert(1, {1, 2, 3})
+obj.update(1, {1, 2, 3, 4})
+# obj.update(2, {1, 2, 3, 4})  # !raises IndexError
+```
+#### delete
+Deletes the data point at a given timestamp. <br>
+_Arguments_
+*  **`self`** (`TimeSeriesObject`): The object itself.
+*  **`ts`** (`int`): Timestamp of the point we want to delete.
+
+_Output/Exceptions_
+*  (`None`): Successfully deleted data point.
+*  **`ValueError`** (`Exception`): TimeSeriesObject is empty and could not delete.
+*  **`IndexError`** (`Exception`): Provided timestamp does not exist within TimeSeriesObject.
+
+_Example:_
+```python
+from generic_time_series_objects import TimeSeriesObject
+
+obj = TimeSeriesObject()
+# obj.delete(2)  # !raises ValueError
+obj.insert(1, {1, 2, 3})
+# obj.delete(2)  # !raises IndexError
+obj.delete(1)
+```
+### Retrieving Data Points
+Methods return a tuple of the timestamp and Python object for success and None if nothing is found.
+#### point
+Fetches the data point on or before a certain timestamp.<br>
+_Arguments_
+*  **`self`** (`TimeSeriesObject`): The object itself.
+*  **`ts`** (`int`): Timestamp on or before the time we want to retrieve data for.
+
+_Output/Exceptions_
+*  (`tuple[int, Any]`): The data point, as a tuple of timestamp and Python object, that was retrieved.
+*  **`None`** (`NoneType`): Nothing was found, in this case timestamp provided was before the minimum timestamp in the 
+TimeSeriesObject.
+
+_Example:_
+```python
+from generic_time_series_objects import TimeSeriesObject
+
+obj = TimeSeriesObject()
+obj.insert(2, {1, 2, 3})
+obj.insert(10, {1, 2, 3, 4})
+print(obj.point(10))  # prints {1, 2, 3, 4}
+print(obj.point(5))  # prints {1, 2, 3}
+print(obj.point(1))  # prints None
+```
+#### point_on
+Fetches the data point exactly on a certain timestamp.<br>
+_Arguments_
+*  **`self`** (`TimeSeriesObject`): The object itself.
+*  **`ts`** (`int`): Timestamp exactly equal to the time we want to retrieve data for.
+
+_Output/Exceptions_
+*  (`tuple[int, Any]`): The data point, as a tuple of timestamp and Python object, that was retrieved.
+*  **`None`** (`NoneType`): Nothing was found at provided timestamp.
+
+_Example:_
+```python
+from generic_time_series_objects import TimeSeriesObject
+
+obj = TimeSeriesObject()
+obj.insert(2, {1, 2, 3})
+obj.insert(10, {1, 2, 3, 4})
+print(obj.point_on(10))  # prints {1, 2, 3, 4}
+print(obj.point_on(5))  # prints None
+print(obj.point_on(2))  # prints {1, 2, 3}
+```
+
+#### points_between
+Fetches all data points between the two provided timestamps, inclusive of start and exclusive of end [start_ts, end_ts).
+<br>
+_Arguments_
+*  **`self`** (`TimeSeriesObject`): The object itself.
+*  **`start_ts`** (`int`): Start timestamp to filter for, inclusive.
+*  **`end_ts`** (`int`): End timestamp to filter for, exclusive.
+
+_Output/Exceptions_
+*  (`list[tuple[int, Any]]`): List of points between the starting and ending timestamp.
+
+_Example:_
+```python
+from generic_time_series_objects import TimeSeriesObject
+
+obj = TimeSeriesObject()
+obj.insert(2, {1})
+obj.insert(5, {1, 2})
+obj.insert(10, {1, 2, 3})
+print(obj.points_between(1, 100))  # prints [(2, {1}), (5, {1, 2}), (10, {1, 2, 3})]
+print(obj.points_between(1, 10))  # prints [(2, {1}), (5, {1, 2})]
+print(obj.points_between(1, 1))  # prints []
+
+```
+### Transforming Data Type
+Methods return the data type named in the method as the outer return type.
+#### as_dict
+Transforms all data points in the TimeSeriesObject to a mapping between the timestamp and the Python object.<br>
+_Arguments_
+*  **`self`** (`TimeSeriesObject`): The object itself.
+
+_Output/Exceptions_
+*  (`dict[int, Any]`): All data points in the form of a dictionary mapping timestamp to Python 
+object.
+
+_Example:_
+```python
+from generic_time_series_objects import TimeSeriesObject
+
+obj = TimeSeriesObject()
+print(obj.as_dict())  # prints {}
+obj.insert(1, ['hello'])  
+print(obj.as_dict())  # prints {1: ['hello']}
+```
+#### as_list
+Transforms all data points in the TimeSeriesObject to a list of tuples containing the timestamp and the Python object.<br>
+_Arguments_
+*  **`self`** (`TimeSeriesObject`): The object itself.
+
+_Output/Exceptions_
+*  (`list[tuple[int, Any]]`): All data points in the form of a list of tuples with each tuple 
+containing a timestamp and the Python object.
+
+_Example:_
+```python
+from generic_time_series_objects import TimeSeriesObject
+
+obj = TimeSeriesObject()
+print(obj.as_list())  # prints []
+obj.insert(1, ['hello'])  
+print(obj.as_list())  # prints [(1, ['hello'])]
+```

generic_time_series_objects-0.1.1/pyproject.toml

@@ -0,0 +1,16 @@
+[project]
+name = "generic_time_series_objects"
+version = "0.1.1"
+description = "Generic Time Series Objects for Python"
+requires-python = ">=3.13"
+dependencies = [
+    "pytest>=8.4.2",
+]
+
+[build-system]
+requires = ["maturin>=1.0,<2.0"]
+build-backend = "maturin"
+
+[tool.maturin]
+features = ["pyo3/extension-module"]
+python-source = "python"

generic_time_series_objects-0.1.1/python/generic_time_series_objects/__init__.py

@@ -0,0 +1,17 @@
+from .generic_time_series_objects import TimeSeriesObject
+from .time_series_data_baseclass import TimeSeriesDataBaseclass, time_series_data
+
+
+classes = [
+    "TimeSeriesObject",
+    "TimeSeriesDataBaseclass",
+]
+
+decorators = [
+    "time_series_data",
+]
+
+__all__ = [
+    *classes,
+    *decorators,
+]

generic_time_series_objects-0.1.1/python/generic_time_series_objects/test.py

@@ -0,0 +1,8 @@
+from generic_time_series_objects import time_series_data
+
+
+@time_series_data
+def test_func1(a):
+    return a + 1
+
+print(test_func1(3))

generic_time_series_objects-0.1.1/python/generic_time_series_objects/time_series_data_baseclass.py

@@ -0,0 +1,49 @@
+import datetime
+from abc import ABC
+from functools import wraps
+from typing import Any, Callable
+
+from generic_time_series_objects import TimeSeriesObject
+
+
+TS_DATA_FLAG = 'is_time_series_data'
+
+
+class TimeSeriesDataBaseclass(ABC):
+    def __init__(self):
+        self.timestamp: int = -1
+        self.data: dict[str, TimeSeriesObject] = {}
+        ts_data_flag = TS_DATA_FLAG
+        for method_name in dir(self):
+            method = getattr(self, method_name)
+            if not getattr(method, ts_data_flag, False):
+               continue
+            self.data[method_name] = TimeSeriesObject()
+
+    def set_date(self, new_date: datetime.datetime) -> None:
+        self.timestamp = int(new_date.timestamp())
+
+    def reset_data(self) -> None:
+        self.timestamp = -1
+
+    def update(self, new_data: dict[str, Any], overwrite: bool=False) -> None:
+        if self.timestamp == -1:
+            raise ValueError("`set_date` before attempting to `update`")
+        for method_name, data_point in new_data.items():
+            self.data[method_name].insert(self.timestamp, data_point, overwrite)
+
+
+def time_series_data(fn: Callable) -> Callable:
+    fn.is_time_series_data = True
+    @wraps(fn)
+    def wrapper(self, *args, **kwargs) -> Any:
+        if self.timestamp == -1:
+            return fn(self, *args, **kwargs)
+
+        data_point = self.data[fn.__name__].point(self.timestamp)
+        if not data_point:
+            return fn(self, *args, **kwargs)
+
+        return data_point[1]
+
+    return wrapper

generic_time_series_objects-0.1.1/python/test_ts.py

@@ -0,0 +1,131 @@
+import pytest
+
+from generic_time_series_objects import TimeSeriesObject
+
+
+TEST_INIT_POINTS = [
+    [1, 2, 3, 4, 5, 10],
+    [-1.0, -7.5, -100.1, -50, -1000],
+    [3, -1, -50.5, "X", ["OOPS"], {1, 2, 3, 4}, {"TEST": "TEST1"}, lambda x: x, ("1", True), None],
+    range(1, 1_000_000),
+]
+
+TEST_POINT_DATA = [
+    ([1, 5, 10, 15], [10, 20, 30, 40]),
+]
+
+
+@pytest.mark.parametrize("test_points", TEST_INIT_POINTS)
+def test_initialise_ts_object(test_points: list):
+    obj = TimeSeriesObject()
+    assert obj is not None
+    for i, val in enumerate(test_points):
+        obj.insert(i, val)
+
+    for i, val in enumerate(test_points):
+        point_time, point_value = obj.point(i)
+        assert point_time == i
+        assert point_value == val
+    assert len(obj) == len(test_points)
+
+    assert obj.as_dict() == {i: val for i, val in enumerate(test_points)}
+    assert obj.as_list() == [(i, val) for i, val in enumerate(test_points)]
+    with pytest.raises(AttributeError):
+        obj.get_insertion_index(3)
+    with pytest.raises(AttributeError):
+        obj.is_empty()
+
+
+def test_empty_object():
+    obj = TimeSeriesObject()
+    assert obj is not None
+    assert obj.as_dict() == {}
+    assert obj.as_list() == []
+    assert obj.point(0) is None
+    assert obj.points_between(0, 1) == []
+    with pytest.raises(ValueError):
+        obj.update(100, None)
+    with pytest.raises(ValueError):
+        obj.delete(100)
+
+
+@pytest.mark.parametrize(("test_ts", "test_points"), TEST_POINT_DATA)
+def test_ts_object_point(test_ts: list, test_points: list):
+    obj = TimeSeriesObject()
+    for ts, val in zip(test_ts, test_points):
+        obj.insert(ts, val)
+
+    loop_test_ts = test_ts.copy()
+    loop_test_points = test_points.copy()
+    for i in range(0, max(test_ts)+1):
+        if i < test_ts[0]:
+            assert obj.point(i) is None
+            continue
+        point_time, point_value = obj.point(i)
+        if i == loop_test_ts[1]:
+            loop_test_ts = loop_test_ts[1:]
+            loop_test_points = loop_test_points[1:]
+        assert point_time >= loop_test_ts[0]
+        assert point_value == loop_test_points[0]
+
+    assert obj.point(100000) == (test_ts[-1], test_points[-1])
+
+
+@pytest.mark.parametrize(("test_ts", "test_points"), TEST_POINT_DATA)
+def test_ts_object_point_on(test_ts: list, test_points: list):
+    obj = TimeSeriesObject()
+    for ts, val in zip(test_ts, test_points):
+        obj.insert(ts, val)
+
+    for i in range(0, max(test_ts)+1):
+        if i not in test_ts:
+            assert obj.point_on(i) is None
+            continue
+        point_time, point_value = obj.point_on(i)
+        assert point_time in test_ts
+        assert point_value in test_points
+
+    assert obj.point_on(100000) is None
+
+
+@pytest.mark.parametrize(("test_ts", "test_points"), TEST_POINT_DATA)
+def test_ts_points_between(test_ts: list, test_points: list):
+    obj = TimeSeriesObject()
+    for ts, val in zip(test_ts, test_points):
+        obj.insert(ts, val)
+    assert [x for _, x in obj.points_between(0, 1_000_000)] == [10, 20, 30, 40]
+    assert [x for _, x in obj.points_between(1, 16)] == [10, 20, 30, 40]
+    assert [x for _, x in obj.points_between(1, 15)] == [10, 20, 30]
+    assert [x for _, x in obj.points_between(1, 14)] == [10, 20, 30]
+    assert [x for _, x in obj.points_between(2, 12)] == [20, 30]
+    assert [x for _, x in obj.points_between(2, 11)] == [20, 30]
+    assert [x for _, x in obj.points_between(1, 10)] == [10, 20]
+    assert [x for _, x in obj.points_between(0, 0)] == []
+
+
+@pytest.mark.parametrize(("test_ts", "test_points"), TEST_POINT_DATA)
+def test_update_delete_from_object(test_ts: list, test_points: list):
+    obj = TimeSeriesObject()
+    for ts, val in zip(test_ts, test_points):
+        obj.insert(ts, val)
+    # cannot add same thing twice
+    with pytest.raises(ValueError):
+        obj.insert(test_ts[0], test_points[0])
+
+    obj.insert(test_ts[0], test_points[0], overwrite=True)
+
+    # check index must exist for update
+    with pytest.raises(IndexError):
+        obj.update(0, None)
+
+    obj.update(test_ts[0], None)
+
+    # check can delete
+    with pytest.raises(IndexError):
+        obj.delete(0)
+
+    for ts in test_ts:
+        obj.delete(ts)
+
+    with pytest.raises(ValueError):
+        obj.delete(test_ts[0])

generic_time_series_objects-0.1.1/python/test_ts_data_class.py

@@ -0,0 +1,43 @@
+# import pytest
+import datetime
+
+from generic_time_series_objects import TimeSeriesDataBaseclass, time_series_data
+
+
+class TestClass(TimeSeriesDataBaseclass):
+
+    def __init__(self, a, b, c):
+        super().__init__()
+        self.a = a
+        self.b = b
+        self.c = c
+
+    @time_series_data
+    def A(self):
+        return self.a
+
+    @time_series_data
+    def B(self):
+        return self.b
+
+    @time_series_data
+    def C(self):
+        return self.c
+
+    @time_series_data
+    def D(self):
+        return 1
+
+    def E(self):
+        return 0
+
+test_obj = TestClass(2, 3, 4)
+print(test_obj.A(), test_obj.B(), test_obj.C(), test_obj.D())
+test_obj.set_date(datetime.datetime(2025, 12, 13))
+test_obj.update({"A": 9, "B": 99, "C": 999})
+print(test_obj.A(), test_obj.B(), test_obj.C(), test_obj.D())
+test_obj.reset_data()
+print(test_obj.A(), test_obj.B(), test_obj.C(), test_obj.D())
+test_obj.set_date(datetime.datetime(2025, 12, 14))
+print(test_obj.A(), test_obj.B(), test_obj.C(), test_obj.D())
+print(test_obj.data)

generic_time_series_objects-0.1.1/src/lib.rs

@@ -0,0 +1,168 @@
+use std::collections::HashMap;
+
+use pyo3::exceptions::{PyValueError, PyIndexError};
+use pyo3::prelude::*;
+
+
+#[pyclass]
+struct TimeSeriesObject {
+    timestamps: Vec<i32>,
+    values: Vec<Py<PyAny>>,
+}
+
+
+impl TimeSeriesObject {
+    fn get_insertion_index(&self, ts: i32) -> usize {
+        self.timestamps.binary_search(&ts).unwrap_or_else(|idx| idx)
+    }
+
+    fn is_empty(&self) -> bool {
+        self.timestamps.is_empty()
+    }
+}
+
+
+#[pymethods]
+impl TimeSeriesObject {
+
+    #[new]
+    fn new() -> Self {
+        TimeSeriesObject {timestamps: Vec::new(), values: Vec::new()}
+    }
+
+    fn __len__(&self) -> usize {
+        self.timestamps.len()
+    }
+
+    fn __repr__(&self) -> String {
+        let timestamps = &self.timestamps;
+        format!("TimeSeriesObject(timestamps={timestamps:?})")
+    }
+
+    fn __bool__(&self) -> bool {
+        !self.is_empty()
+    }
+
+    #[pyo3(signature = (ts, value, overwrite = false))]
+    fn insert(&mut self, ts: i32, value: Py<PyAny>, overwrite: bool) -> PyResult<()> {
+        if self.is_empty() || (ts > self.timestamps[self.timestamps.len()-1]) {
+            self.timestamps.push(ts);
+            self.values.push(value);
+            return Ok(())
+        }
+        let idx = self.get_insertion_index(ts);
+
+        let current_ts_at_idx = self.timestamps[idx];
+
+        if (current_ts_at_idx == ts) & overwrite{
+            self.values[idx] = value;
+            return Ok(())
+        }
+
+        if (current_ts_at_idx == ts) & !overwrite{
+            return Err(PyValueError::new_err("Timestamp already exists in TimeSeriesObject, set overwrite=True to overwrite this value"))
+        }
+
+        self.timestamps.insert(idx, ts);
+        self.values.insert(idx, value);
+        Ok(())
+    }
+
+    fn delete(&mut self, ts: i32) -> PyResult<()> {
+        if self.is_empty() {
+            return Err(PyValueError::new_err("TimeSeriesObject is empty"))
+        }
+        let delete_idx = self.get_insertion_index(ts);
+        if self.timestamps[delete_idx] != ts {
+            return Err(PyIndexError::new_err("Timestamp does not exist in TimeSeriesObject"))
+        }
+        self.timestamps.remove(delete_idx);
+        self.values.remove(delete_idx);
+        Ok(())
+    }
+
+    fn update(&mut self, ts: i32, value: Py<PyAny>) -> PyResult<()> {
+        if self.is_empty() {
+            return Err(PyValueError::new_err("TimeSeriesObject is empty"))
+        }
+        let update_idx = self.get_insertion_index(ts);
+        if self.timestamps[update_idx] != ts {
+            return Err(PyIndexError::new_err("Timestamp does not exist in TimeSeriesObject"))
+        }
+        self.values[update_idx] = value;
+        Ok(())
+    }
+
+    fn point(&self, ts: i32) -> Option<(&i32, &Py<PyAny>)> {
+        if self.is_empty() {
+            return None
+        }
+
+        let idx = self.get_insertion_index(ts);
+        if idx == 0 && self.timestamps[idx] == ts {
+            return Some((&self.timestamps[idx], &self.values[idx]))
+        }
+        if idx == 0 && self.timestamps[idx] != ts{
+            return None
+        }
+
+        if (idx == self.__len__()) || self.timestamps[idx] != ts {
+            Some((&self.timestamps[idx-1], &self.values[idx-1]))
+        } else if self.timestamps[idx] == ts{
+            Some((&self.timestamps[idx], &self.values[idx]))
+        } else {
+            None
+        }
+    }
+
+    fn point_on(&self, ts: i32) -> Option<(&i32, &Py<PyAny>)> {
+        if self.is_empty() {
+            return None
+        }
+        let idx = self.get_insertion_index(ts);
+        if (idx != self.__len__()) && self.timestamps[idx] == ts {
+            Some((&self.timestamps[idx], &self.values[idx]))
+        } else {
+            None
+        }
+    }
+
+    fn points_between(&self, start_ts: i32, end_ts: i32) -> Vec<(&i32,&Py<PyAny>)> {
+        let start_idx = self.get_insertion_index(start_ts);
+        let end_idx = self.get_insertion_index(end_ts);
+        let mut return_vec = Vec::new();
+        for idx in start_idx..end_idx {
+            let point_ts = &self.timestamps[idx];
+            let value_ts = &self.values[idx];
+            return_vec.push((point_ts, value_ts))
+        }
+        return_vec
+    }
+
+    fn as_dict(&self) -> HashMap<&i32, &Py<PyAny>> {
+        let mut return_dict = HashMap::new();
+        for idx in 0..self.__len__() {
+            let point_ts = &self.timestamps[idx];
+            let value_ts = &self.values[idx];
+            return_dict.insert(point_ts, value_ts);
+        }
+        return_dict
+    }
+
+    fn as_list(&self) -> Vec<(&i32, &Py<PyAny>)> {
+        let mut return_list = Vec::new();
+        for idx in 0..self.__len__() {
+            let point_ts = &self.timestamps[idx];
+            let value_ts = &self.values[idx];
+            return_list.push((point_ts, value_ts));
+        }
+        return_list
+    }
+}
+
+
+#[pymodule]
+fn generic_time_series_objects(m: &Bound<'_, PyModule>) -> PyResult<()> {
+    m.add_class::<TimeSeriesObject>()?;
+    Ok(())
+}

generic_time_series_objects-0.1.1/uv.lock

@@ -0,0 +1,75 @@
+version = 1
+revision = 2
+requires-python = ">=3.13"
+
+[[package]]
+name = "colorama"
+version = "0.4.6"
+source = { registry = "https://pypi.org/simple" }
+sdist = { url = "https://files.pythonhosted.org/packages/d8/53/6f443c9a4a8358a93a6792e2acffb9d9d5cb0a5cfd8802644b7b1c9a02e4/colorama-0.4.6.tar.gz", hash = "sha256:08695f5cb7ed6e0531a20572697297273c47b8cae5a63ffc6d6ed5c201be6e44", size = 27697, upload-time = "2022-10-25T02:36:22.414Z" }
+wheels = [
+    { url = "https://files.pythonhosted.org/packages/d1/d6/3965ed04c63042e047cb6a3e6ed1a63a35087b6a609aa3a15ed8ac56c221/colorama-0.4.6-py2.py3-none-any.whl", hash = "sha256:4f1d9991f5acc0ca119f9d443620b77f9d6b33703e51011c16baf57afb285fc6", size = 25335, upload-time = "2022-10-25T02:36:20.889Z" },
+]
+
+[[package]]
+name = "generic-time-series-objects"
+version = "0.1.1"
+source = { editable = "." }
+dependencies = [
+    { name = "pytest" },
+]
+
+[package.metadata]
+requires-dist = [{ name = "pytest", specifier = ">=8.4.2" }]
+
+[[package]]
+name = "iniconfig"
+version = "2.3.0"
+source = { registry = "https://pypi.org/simple" }
+sdist = { url = "https://files.pythonhosted.org/packages/72/34/14ca021ce8e5dfedc35312d08ba8bf51fdd999c576889fc2c24cb97f4f10/iniconfig-2.3.0.tar.gz", hash = "sha256:c76315c77db068650d49c5b56314774a7804df16fee4402c1f19d6d15d8c4730", size = 20503, upload-time = "2025-10-18T21:55:43.219Z" }
+wheels = [
+    { url = "https://files.pythonhosted.org/packages/cb/b1/3846dd7f199d53cb17f49cba7e651e9ce294d8497c8c150530ed11865bb8/iniconfig-2.3.0-py3-none-any.whl", hash = "sha256:f631c04d2c48c52b84d0d0549c99ff3859c98df65b3101406327ecc7d53fbf12", size = 7484, upload-time = "2025-10-18T21:55:41.639Z" },
+]
+
+[[package]]
+name = "packaging"
+version = "25.0"
+source = { registry = "https://pypi.org/simple" }
+sdist = { url = "https://files.pythonhosted.org/packages/a1/d4/1fc4078c65507b51b96ca8f8c3ba19e6a61c8253c72794544580a7b6c24d/packaging-25.0.tar.gz", hash = "sha256:d443872c98d677bf60f6a1f2f8c1cb748e8fe762d2bf9d3148b5599295b0fc4f", size = 165727, upload-time = "2025-04-19T11:48:59.673Z" }
+wheels = [
+    { url = "https://files.pythonhosted.org/packages/20/12/38679034af332785aac8774540895e234f4d07f7545804097de4b666afd8/packaging-25.0-py3-none-any.whl", hash = "sha256:29572ef2b1f17581046b3a2227d5c611fb25ec70ca1ba8554b24b0e69331a484", size = 66469, upload-time = "2025-04-19T11:48:57.875Z" },
+]
+
+[[package]]
+name = "pluggy"
+version = "1.6.0"
+source = { registry = "https://pypi.org/simple" }
+sdist = { url = "https://files.pythonhosted.org/packages/f9/e2/3e91f31a7d2b083fe6ef3fa267035b518369d9511ffab804f839851d2779/pluggy-1.6.0.tar.gz", hash = "sha256:7dcc130b76258d33b90f61b658791dede3486c3e6bfb003ee5c9bfb396dd22f3", size = 69412, upload-time = "2025-05-15T12:30:07.975Z" }
+wheels = [
+    { url = "https://files.pythonhosted.org/packages/54/20/4d324d65cc6d9205fabedc306948156824eb9f0ee1633355a8f7ec5c66bf/pluggy-1.6.0-py3-none-any.whl", hash = "sha256:e920276dd6813095e9377c0bc5566d94c932c33b27a3e3945d8389c374dd4746", size = 20538, upload-time = "2025-05-15T12:30:06.134Z" },
+]
+
+[[package]]
+name = "pygments"
+version = "2.19.2"
+source = { registry = "https://pypi.org/simple" }
+sdist = { url = "https://files.pythonhosted.org/packages/b0/77/a5b8c569bf593b0140bde72ea885a803b82086995367bf2037de0159d924/pygments-2.19.2.tar.gz", hash = "sha256:636cb2477cec7f8952536970bc533bc43743542f70392ae026374600add5b887", size = 4968631, upload-time = "2025-06-21T13:39:12.283Z" }
+wheels = [
+    { url = "https://files.pythonhosted.org/packages/c7/21/705964c7812476f378728bdf590ca4b771ec72385c533964653c68e86bdc/pygments-2.19.2-py3-none-any.whl", hash = "sha256:86540386c03d588bb81d44bc3928634ff26449851e99741617ecb9037ee5ec0b", size = 1225217, upload-time = "2025-06-21T13:39:07.939Z" },
+]
+
+[[package]]
+name = "pytest"
+version = "8.4.2"
+source = { registry = "https://pypi.org/simple" }
+dependencies = [
+    { name = "colorama", marker = "sys_platform == 'win32'" },
+    { name = "iniconfig" },
+    { name = "packaging" },
+    { name = "pluggy" },
+    { name = "pygments" },
+]
+sdist = { url = "https://files.pythonhosted.org/packages/a3/5c/00a0e072241553e1a7496d638deababa67c5058571567b92a7eaa258397c/pytest-8.4.2.tar.gz", hash = "sha256:86c0d0b93306b961d58d62a4db4879f27fe25513d4b969df351abdddb3c30e01", size = 1519618, upload-time = "2025-09-04T14:34:22.711Z" }
+wheels = [
+    { url = "https://files.pythonhosted.org/packages/a8/a4/20da314d277121d6534b3a980b29035dcd51e6744bd79075a6ce8fa4eb8d/pytest-8.4.2-py3-none-any.whl", hash = "sha256:872f880de3fc3a5bdc88a11b39c9710c3497a547cfa9320bc3c5e62fbf272e79", size = 365750, upload-time = "2025-09-04T14:34:20.226Z" },
+]