interface — Interface

this page is under development — please check back soon

Classes

class eventsourcing.interface.NotificationLogInterface

Bases: abc.ABC

Abstract base class for obtaining serialised sections of a notification log.

abstract get_log_section(section_id: str) → str

Returns a serialised Section from a notification log.

abstract get_notifications(start: int, limit: int, topics: Sequence[str] = ()) → str

Returns a serialised list of Notification objects from a notification log.

class eventsourcing.interface.NotificationLogJSONService(app: eventsourcing.application.TApplication)

Bases: eventsourcing.interface.NotificationLogInterface, Generic[eventsourcing.application.TApplication]

Presents serialised sections of a notification log.

__init__(app: eventsourcing.application.TApplication)

Initialises service with given application.

get_log_section(section_id: str) → str

Returns JSON serialised Section from a notification log.

get_notifications(start: int, limit: int, topics: Sequence[str] = ()) → str

Returns a serialised list of Notification objects from a notification log.

class eventsourcing.interface.NotificationLogJSONClient(interface: eventsourcing.interface.NotificationLogInterface)

Bases: eventsourcing.application.NotificationLog

Presents deserialized sections of a notification log.

__init__(interface: eventsourcing.interface.NotificationLogInterface)

Initialises log with a given interface.

__getitem__(section_id: str) → eventsourcing.application.Section

Returns a Section of Notification objects from the notification log.

select(start: int, limit: int, stop: Optional[int] = None, topics: Sequence[str] = ()) → List[eventsourcing.persistence.Notification]

Returns a selection of Notification objects from the notification log.