prefect.events.clients

Functions

http_to_ws

http_to_ws(url: str) -> str

events_in_socket_from_api_url

events_in_socket_from_api_url(url: str) -> str

events_out_socket_from_api_url

events_out_socket_from_api_url(url: str) -> str

get_events_client

get_events_client(reconnection_attempts: int = 10, checkpoint_every: int = 700) -> 'EventsClient'

get_events_subscriber

get_events_subscriber(filter: Optional['EventFilter'] = None, reconnection_attempts: int = 10) -> 'PrefectEventSubscriber'

Classes

EventsClient

The abstract interface for all Prefect Events clients

Methods:

client_name

client_name(self) -> str

NullEventsClient

A Prefect Events client implementation that does nothing

AssertingEventsClient

A Prefect Events client that records all events sent to it for inspection during tests.

Methods:

reset

reset(cls) -> None

Reset all captured instances and their events. For use between tests

pop_events

pop_events(self) -> List[Event]

PrefectEventsClient

A Prefect Events client that streams events to a Prefect server

AssertingPassthroughEventsClient

A Prefect Events client that BOTH records all events sent to it for inspection during tests AND sends them to a Prefect server.

Methods:

reset

reset(cls) -> None

pop_events

pop_events(self) -> list[Event]

PrefectCloudEventsClient

A Prefect Events client that streams events to a Prefect Cloud Workspace

PrefectEventSubscriber

Subscribes to a Prefect event stream, yielding events as they occur.

Example:

from prefect.events.clients import PrefectEventSubscriber from prefect.events.filters import EventFilter, EventNameFilter

filter = EventFilter(event=EventNameFilter(prefix=[“prefect.flow-run.”]))

async with PrefectEventSubscriber(filter=filter) as subscriber: async for event in subscriber: print(event.occurred, event.resource.id, event.event)

Methods:

client_name

client_name(self) -> str

PrefectCloudEventSubscriber

PrefectCloudAccountEventSubscriber