finchan.event

Event implentation

Event

class finchan.event.Event(env, name, dt=None, expire=0, event_id=None, **kwargs)[source]

Event class

Parameters:
  • name – name of the event
  • dt – occur datetime
  • expire – expire in second
  • event_id – id of the event
  • **kwargs – special kwargs for the event, can get by kwargs attribute

can compare less/greater than with other event object by time, equal by event id.

id

ID of the event

name

Name of the event

timestamp

Occur time of the event, in POSIX timestamp format

expire

expire expire in seconds after event occur time (timestamp attribute), 0 is no expire.

kwargs

Parameters of the event, a dict

SysEvents:

class finchan.event.SysEvents[source]

system defined events

enum of events that finchan system generate/reserved:

  • SYSTEM_STARTED = ‘system_event.system_started’
  • SYSTEM_EXITING = ‘system_event.system_will_exit’