Skip to content

Base

EventBase dataclass

Base class for immutable event message objects, using Unix epoch nanoseconds.

Field Type Semantics
ts_event_ns int Time at which the represented fact occurred, as UTC epoch nanoseconds.
ts_created_ns int Time at which the event object was created, as UTC epoch nanoseconds.

If not provided, ts_created_ns is assigned automatically at object creation.

Source code in src/onesecondtrader/events/base.py 
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
@dataclasses.dataclass(kw_only=True, frozen=True, slots=True)
class EventBase:
    """
    Base class for immutable event message objects, using Unix epoch nanoseconds.

    | Field           | Type   | Semantics                                                              |
    |-----------------|--------|------------------------------------------------------------------------|
    | `ts_event_ns`   | `int`  | Time at which the represented fact occurred, as UTC epoch nanoseconds. |
    | `ts_created_ns` | `int`  | Time at which the event object was created, as UTC epoch nanoseconds.  |

    If not provided, `ts_created_ns` is assigned automatically at object creation.
    """

    ts_event_ns: int
    ts_created_ns: int = dataclasses.field(default_factory=time.time_ns)