Public Member Functions
None	__init__ (self, HomeAssistant hass, tuple[EventType[Any]\|str,...] event_types, list[str]\|None entity_ids=None, list[str]\|None device_ids=None, str\|None context_id=None, bool timestamp=False, bool include_entity_name=True)

list[dict[str, Any]]	get_events (self, dt start_day, dt end_day)

list[dict[str, str]]	humanify (self, Generator[EventAsRow]\|Sequence[Row]\|Result rows)

bool	limited_select (self)

None	switch_to_live (self)

Public Attributes
	context_augmenter

	context_id

	device_ids

	ent_reg

	entity_ids

	event_types

	hass

	logbook_run

Detailed Description

Stream into logbook format.

Definition at line 104 of file processor.py.

Constructor & Destructor Documentation

◆ init()

None homeassistant.components.logbook.processor.EventProcessor.__init__	(		self,
		HomeAssistant	hass,
		tuple[EventType[Any] \| str, ...]	event_types,
		list[str] \| None	entity_ids = `None`,
		list[str] \| None	device_ids = `None`,
		str \| None	context_id = `None`,
		bool	timestamp = `False`,
		bool	include_entity_name = `True`
	)

Init the event stream.

Definition at line 107 of file processor.py.

Member Function Documentation

◆ get_events()

list[dict[str, Any]] homeassistant.components.logbook.processor.EventProcessor.get_events	(		self,
		dt	start_day,
		dt	end_day
	)

Get events for a period of time.

Definition at line 153 of file processor.py.

◆ humanify()

list[dict[str, str]] homeassistant.components.logbook.processor.EventProcessor.humanify	(		self,
		Generator[EventAsRow] \| Sequence[Row] \| Result	rows
	)

Humanify rows.

Definition at line 187 of file processor.py.

◆ limited_select()

bool homeassistant.components.logbook.processor.EventProcessor.limited_select ( self )

Check if the stream is limited by entities context or device ids.

Definition at line 140 of file processor.py.

◆ switch_to_live()

None homeassistant.components.logbook.processor.EventProcessor.switch_to_live ( self )

Switch to live stream.

Clear caches so we can reduce memory pressure.

Definition at line 144 of file processor.py.

Member Data Documentation

◆ context_augmenter

homeassistant.components.logbook.processor.EventProcessor.context_augmenter

Definition at line 137 of file processor.py.

◆ context_id

homeassistant.components.logbook.processor.EventProcessor.context_id

Definition at line 126 of file processor.py.

◆ device_ids

homeassistant.components.logbook.processor.EventProcessor.device_ids

Definition at line 125 of file processor.py.

◆ ent_reg

homeassistant.components.logbook.processor.EventProcessor.ent_reg

Definition at line 122 of file processor.py.

◆ entity_ids

homeassistant.components.logbook.processor.EventProcessor.entity_ids

Definition at line 124 of file processor.py.

◆ event_types

homeassistant.components.logbook.processor.EventProcessor.event_types

Definition at line 123 of file processor.py.

◆ hass

homeassistant.components.logbook.processor.EventProcessor.hass

Definition at line 121 of file processor.py.

◆ logbook_run

homeassistant.components.logbook.processor.EventProcessor.logbook_run

Definition at line 129 of file processor.py.

The documentation for this class was generated from the following file:

core/homeassistant/components/logbook/processor.py

Home Assistant Unofficial Reference 2024.12.1

Public Member Functions

Public Attributes