OptionalEventTime
#
Bases: object
Raphtory’s optional EventTime type. Instances of OptionalEventTime may contain an EventTime, or be empty. This is used for functions that may not return data (such as earliest_time and latest_time) because the data is unavailable.
If data is contained, OptionalEventTime instances can be used similarly to EventTime. If empty, time operations (such as .t, .dt, .event_id) will return None. An empty OptionalEventTime is considered smaller than (<) any EventTime or OptionalEventTime with data.
as_tuple
property
#
dt
property
#
Returns the UTC datetime representation of this EventTime's timestamp if an EventTime is contained, or else None.
Returns:
| Type | Description |
|---|---|
datetime | None
|
The UTC datetime. |
Raises:
| Type | Description |
|---|---|
TimeError
|
Returns TimeError on timestamp conversion errors (e.g. out-of-range timestamp). |
event_id
property
#
Returns the event id used to order events within the same timestamp if an EventTime is contained, or else None.
Returns:
| Type | Description |
|---|---|
int | None
|
The event id. |
t
property
#
Returns the timestamp in milliseconds since the Unix epoch if an EventTime is contained, or else None.
Returns:
| Type | Description |
|---|---|
int | None
|
Milliseconds since the Unix epoch. |
__bool__()
#
True if self else False
__eq__(value)
#
Return self==value.
__ge__(value)
#
Return self>=value.
__gt__(value)
#
Return self>value.
__le__(value)
#
Return self<=value.
__lt__(value)
#
Return self<value.
__ne__(value)
#
Return self!=value.
get_event_time()
#
Returns the contained EventTime if it exists, or else None.
Returns:
| Type | Description |
|---|---|
EventTime | None
|
|