aces.types module¶

This module contains types defined by this package.

These are all simple types using named tuples so can be safely ignored by downstream users provided data fields are passed in the correct order.

class aces.types.TemporalWindowBounds(left_inclusive: bool, window_size: timedelta, right_inclusive: bool, offset: timedelta | None = None)[source]¶

Bases: object

Named tuple to represent temporal window bounds.

left_inclusive¶

The start of the window, inclusive.

Type:¶: bool

window_size¶

The size of the window.

Type:¶: datetime.timedelta

right_inclusive¶

The end of the window, inclusive.

Type:¶: bool

offset¶

The offset from the start of the window to the end of the window.

Type:¶: datetime.timedelta | None

Example

>>> bounds = TemporalWindowBounds(
...     left_inclusive=True,
...     window_size=timedelta(days=1),
...     right_inclusive=False,
...     offset=timedelta(hours=1)
... )
>>> bounds
TemporalWindowBounds(left_inclusive=True,
                     window_size=datetime.timedelta(days=1),
                     right_inclusive=False,
                     offset=datetime.timedelta(seconds=3600))
>>> left_inclusive, window_size, right_inclusive, offset = bounds
>>> bounds.left_inclusive
True
>>> window_size
datetime.timedelta(days=1)
>>> right_inclusive
False
>>> offset
datetime.timedelta(seconds=3600)

left_inclusive : bool¶

offset : timedelta | None = None¶

property polars_gp_rolling_kwargs : dict[str, str | datetime.timedelta]¶

Return the parameters for a group_by rolling operation in Polars.

Examples

>>> TemporalWindowBounds(
...     left_inclusive=True,
...     window_size=timedelta(days=1),
...     right_inclusive=True,
...     offset=None
... ).polars_gp_rolling_kwargs
{'period': datetime.timedelta(days=1),
 'offset': datetime.timedelta(0),
 'closed': 'both'}
>>> TemporalWindowBounds(
...     left_inclusive=True,
...     window_size=timedelta(days=1),
...     right_inclusive=True,
...     offset=timedelta(hours=1)
... ).polars_gp_rolling_kwargs
{'period': datetime.timedelta(days=1),
 'offset': datetime.timedelta(seconds=3600),
 'closed': 'both'}
>>> TemporalWindowBounds(
...     left_inclusive=False,
...     window_size=timedelta(days=2),
...     right_inclusive=False,
...     offset=timedelta(minutes=1)
... ).polars_gp_rolling_kwargs
{'period': datetime.timedelta(days=2),
 'offset': datetime.timedelta(seconds=60),
 'closed': 'none'}
>>> TemporalWindowBounds(
...     left_inclusive=True,
...     window_size=timedelta(days=2),
...     right_inclusive=False,
...     offset=timedelta(minutes=1)
... ).polars_gp_rolling_kwargs
{'period': datetime.timedelta(days=2),
 'offset': datetime.timedelta(seconds=60),
 'closed': 'left'}
>>> TemporalWindowBounds(
...     left_inclusive=False,
...     window_size=timedelta(days=2),
...     right_inclusive=True,
...     offset=timedelta(minutes=1)
... ).polars_gp_rolling_kwargs
{'period': datetime.timedelta(days=2),
 'offset': datetime.timedelta(seconds=60),
 'closed': 'right'}

right_inclusive : bool¶

window_size : timedelta¶

class aces.types.ToEventWindowBounds(left_inclusive: bool, end_event: str, right_inclusive: bool, offset: timedelta | None = None)[source]¶