generic_time_series_objects 0.2.2

Generic Time Series Objects for Python

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 bindings, and compiled using maturin. Tests are written in python (with pytest).

[!NOTE]

Rust code is compiled using maturin develop --uv (or maturin develop --uv --release).
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.
Arguments

• self (TimeSeriesObject): The object itself.

Output/Exceptions

• (TimeSeriesObject): Returns the created object.

Example:

from generic_time_series_objects import TimeSeriesObject

obj = TimeSeriesObject()

__repr__

Representation of the object.
Arguments

• self (TimeSeriesObject): The object itself.

Output/Exceptions

• (str): Returns a string with the object name and a list of timestamps.

Example:

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.
Arguments

• self (TimeSeriesObject): The object itself.

Output/Exceptions

• (int): Number of data points inserted into the object.

Example:

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.
Arguments

• self (TimeSeriesObject): The object itself.

Output/Exceptions

• (bool): False if there are no data points, otherwise True.

Example:

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.
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:

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.
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:

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.
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:

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.
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:

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.
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:

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).
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:

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.
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:

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.
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:

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'])]