fiftyone.core.session.events

Session events.

Copyright 2017-2023, Voxel51, Inc.

voxel51.com

Classes:

AppInitializer(dataset, NoneType] = None, …)
CaptureNotebookCell(subscription, src, width)	Capture notebook cell screenshot event
CloseSession()	Close session event
DeactivateNotebookCell()	Deactivate notebook cell event
Event()	Base server event
ListenPayload(initializer, events, subscription)	A an initialization payload for an event listener request
Ping()	Ping (builtin) event
ReactivateNotebookCell(subscription)	Reactivate notebook cell event
Screenshot(bytes, max_width)
StateUpdate(state[, refresh])	State update event

Functions:

add_screenshot(event)
dict_factory(data)
get_screenshot(subscription[, pop])

class fiftyone.core.session.events.Event

Bases: object

Base server event

Methods:

from_data(event_name, data)
from_data_async(event_name, data)
get_event_name()

classmethod get_event_name() → str

static from_data(event_name: str, data: Union[str, dict]) → Union[fiftyone.core.session.events.CaptureNotebookCell, fiftyone.core.session.events.CloseSession, fiftyone.core.session.events.DeactivateNotebookCell, fiftyone.core.session.events.ReactivateNotebookCell, fiftyone.core.session.events.StateUpdate]

async static from_data_async(event_name: str, data: Union[str, dict]) → Union[fiftyone.core.session.events.CaptureNotebookCell, fiftyone.core.session.events.CloseSession, fiftyone.core.session.events.DeactivateNotebookCell, fiftyone.core.session.events.ReactivateNotebookCell, fiftyone.core.session.events.StateUpdate]

class fiftyone.core.session.events.CaptureNotebookCell(subscription: str, src: str, width: int)

Bases: fiftyone.core.session.events.Event

Capture notebook cell screenshot event

Methods:

from_data(event_name, data)
from_data_async(event_name, data)
get_event_name()

Attributes:

fiftyone.core.session.events.CaptureNotebookCell.src
fiftyone.core.session.events.CaptureNotebookCell.subscription
fiftyone.core.session.events.CaptureNotebookCell.width

subscription: str = None

src: str = None

width: int = None

static from_data(event_name: str, data: Union[str, dict]) → Union[fiftyone.core.session.events.CaptureNotebookCell, fiftyone.core.session.events.CloseSession, fiftyone.core.session.events.DeactivateNotebookCell, fiftyone.core.session.events.ReactivateNotebookCell, fiftyone.core.session.events.StateUpdate]

async static from_data_async(event_name: str, data: Union[str, dict]) → Union[fiftyone.core.session.events.CaptureNotebookCell, fiftyone.core.session.events.CloseSession, fiftyone.core.session.events.DeactivateNotebookCell, fiftyone.core.session.events.ReactivateNotebookCell, fiftyone.core.session.events.StateUpdate]

classmethod get_event_name() → str

class fiftyone.core.session.events.CloseSession

Bases: fiftyone.core.session.events.Event

Close session event

Methods:

from_data(event_name, data)
from_data_async(event_name, data)
get_event_name()

static from_data(event_name: str, data: Union[str, dict]) → Union[fiftyone.core.session.events.CaptureNotebookCell, fiftyone.core.session.events.CloseSession, fiftyone.core.session.events.DeactivateNotebookCell, fiftyone.core.session.events.ReactivateNotebookCell, fiftyone.core.session.events.StateUpdate]

async static from_data_async(event_name: str, data: Union[str, dict]) → Union[fiftyone.core.session.events.CaptureNotebookCell, fiftyone.core.session.events.CloseSession, fiftyone.core.session.events.DeactivateNotebookCell, fiftyone.core.session.events.ReactivateNotebookCell, fiftyone.core.session.events.StateUpdate]

classmethod get_event_name() → str

class fiftyone.core.session.events.DeactivateNotebookCell

Bases: fiftyone.core.session.events.Event

Deactivate notebook cell event

Methods:

from_data(event_name, data)
from_data_async(event_name, data)
get_event_name()

static from_data(event_name: str, data: Union[str, dict]) → Union[fiftyone.core.session.events.CaptureNotebookCell, fiftyone.core.session.events.CloseSession, fiftyone.core.session.events.DeactivateNotebookCell, fiftyone.core.session.events.ReactivateNotebookCell, fiftyone.core.session.events.StateUpdate]

async static from_data_async(event_name: str, data: Union[str, dict]) → Union[fiftyone.core.session.events.CaptureNotebookCell, fiftyone.core.session.events.CloseSession, fiftyone.core.session.events.DeactivateNotebookCell, fiftyone.core.session.events.ReactivateNotebookCell, fiftyone.core.session.events.StateUpdate]

classmethod get_event_name() → str

class fiftyone.core.session.events.ReactivateNotebookCell(subscription: str)

Bases: fiftyone.core.session.events.Event

Reactivate notebook cell event

Methods:

from_data(event_name, data)
from_data_async(event_name, data)
get_event_name()

Attributes:

fiftyone.core.session.events.ReactivateNotebookCell.subscription

subscription: str = None

static from_data(event_name: str, data: Union[str, dict]) → Union[fiftyone.core.session.events.CaptureNotebookCell, fiftyone.core.session.events.CloseSession, fiftyone.core.session.events.DeactivateNotebookCell, fiftyone.core.session.events.ReactivateNotebookCell, fiftyone.core.session.events.StateUpdate]

async static from_data_async(event_name: str, data: Union[str, dict]) → Union[fiftyone.core.session.events.CaptureNotebookCell, fiftyone.core.session.events.CloseSession, fiftyone.core.session.events.DeactivateNotebookCell, fiftyone.core.session.events.ReactivateNotebookCell, fiftyone.core.session.events.StateUpdate]

classmethod get_event_name() → str

class fiftyone.core.session.events.StateUpdate(state: fiftyone.core.state.StateDescription, refresh: bool = False)

Bases: fiftyone.core.session.events.Event

State update event

Methods:

from_data(event_name, data)
from_data_async(event_name, data)
get_event_name()

Attributes:

refresh
fiftyone.core.session.events.StateUpdate.state

state: fos.StateDescription = None

refresh: bool = False

static from_data(event_name: str, data: Union[str, dict]) → Union[fiftyone.core.session.events.CaptureNotebookCell, fiftyone.core.session.events.CloseSession, fiftyone.core.session.events.DeactivateNotebookCell, fiftyone.core.session.events.ReactivateNotebookCell, fiftyone.core.session.events.StateUpdate]

async static from_data_async(event_name: str, data: Union[str, dict]) → Union[fiftyone.core.session.events.CaptureNotebookCell, fiftyone.core.session.events.CloseSession, fiftyone.core.session.events.DeactivateNotebookCell, fiftyone.core.session.events.ReactivateNotebookCell, fiftyone.core.session.events.StateUpdate]

classmethod get_event_name() → str

class fiftyone.core.session.events.Ping

Bases: fiftyone.core.session.events.Event

Ping (builtin) event

Methods:

from_data(event_name, data)
from_data_async(event_name, data)
get_event_name()

static from_data(event_name: str, data: Union[str, dict]) → Union[fiftyone.core.session.events.CaptureNotebookCell, fiftyone.core.session.events.CloseSession, fiftyone.core.session.events.DeactivateNotebookCell, fiftyone.core.session.events.ReactivateNotebookCell, fiftyone.core.session.events.StateUpdate]

async static from_data_async(event_name: str, data: Union[str, dict]) → Union[fiftyone.core.session.events.CaptureNotebookCell, fiftyone.core.session.events.CloseSession, fiftyone.core.session.events.DeactivateNotebookCell, fiftyone.core.session.events.ReactivateNotebookCell, fiftyone.core.session.events.StateUpdate]

classmethod get_event_name() → str

class fiftyone.core.session.events.AppInitializer(dataset: Union[str, NoneType] = None, view: Union[str, NoneType] = None)

Bases: object

Attributes:

dataset
view

dataset: Optional[str] = None

view: Optional[str] = None

class fiftyone.core.session.events.ListenPayload(initializer: Union[fiftyone.core.session.events.AppInitializer, None, fiftyone.core.state.StateDescription], events: List[str], subscription: str, polling: Optional[bool] = False)

Bases: object

A an initialization payload for an event listener request

Attributes:

fiftyone.core.session.events.ListenPayload.events
fiftyone.core.session.events.ListenPayload.initializer
polling
fiftyone.core.session.events.ListenPayload.subscription

Methods:

from_dict(d)

initializer: t.Union[AppInitializer, None, fos.StateDescription] = None

events: t.List[str] = None

subscription: str = None

polling: Optional[bool] = False

async classmethod from_dict(d: dict) → fiftyone.core.session.events.ListenPayload

fiftyone.core.session.events.dict_factory(data: List[Tuple[str, Any]]) → Dict[str, Any]

class fiftyone.core.session.events.Screenshot(bytes: bytes, max_width: int)

Bases: object

Attributes:

fiftyone.core.session.events.Screenshot.bytes
fiftyone.core.session.events.Screenshot.max_width

bytes: bytes = None

max_width: int = None

fiftyone.core.session.events.add_screenshot(event: fiftyone.core.session.events.CaptureNotebookCell) → None

fiftyone.core.session.events.get_screenshot(subscription: str, pop=False) → fiftyone.core.session.events.Screenshot