homeassistant.helpers.dispatcher Namespace Reference

Functions
None	_Ts (_DispatcherDataType[*_Ts] dispatchers, SignalType[*_Ts]|str signal, Callable[[*_Ts], Any]|Callable[..., Any] target)
None	_Ts (HomeAssistant hass, SignalType[*_Ts] signal, **_Ts args)
Callable[[], None]	_Ts (HomeAssistant hass, SignalType[*_Ts] signal, Callable[[*_Ts], Any] target)
Callable[[], None]	_Ts (HomeAssistant hass, SignalType[*_Ts] signal, Callable[[*_Ts], None] target)
None	_Ts (HomeAssistant hass, SignalType[*_Ts]|str signal, **_Ts args)
Callable[[], None]	_Ts (HomeAssistant hass, SignalType[*_Ts]|str signal, Callable[[*_Ts], Any]|Callable[..., Any] target)
HassJob[..., Coroutine[Any, Any, None]|None]	_Ts (SignalType[*_Ts]|str signal, Callable[[*_Ts], Any]|Callable[..., Any] target)
str	_Ts (SignalType[*_Ts]|str signal, Callable[[*_Ts], Any]|Callable[..., Any] target, *Any args)
Callable[[], None]	async_dispatcher_connect (HomeAssistant hass, str signal, Callable[..., Any] target)
None	async_dispatcher_send (HomeAssistant hass, str signal, *Any args)
Callable[[], None]	dispatcher_connect (HomeAssistant hass, str signal, Callable[..., None] target)
None	dispatcher_send (HomeAssistant hass, str signal, *Any args)

Variables
	_LOGGER = logging.getLogger(__name__)
string	DATA_DISPATCHER = "dispatcher"

Detailed Description

Helpers for Home Assistant dispatcher & internal component/platform.

Function Documentation

_Ts() [1/8]

None homeassistant.helpers.dispatcher._Ts ( _DispatcherDataType[*_Ts]  dispatchers, SignalType[*_Ts] | str  signal, Callable[[*_Ts], Any] | Callable[..., Any]  target  )

private

Remove signal listener.

Definition at line 71 of file dispatcher.py.

_Ts() [2/8]

None homeassistant.helpers.dispatcher._Ts ( HomeAssistant  hass, SignalType  signal[*_Ts], **_Ts  args  )

private

Send signal and data.

Definition at line 130 of file dispatcher.py.

_Ts() [3/8]

Callable[[], None] homeassistant.helpers.dispatcher._Ts ( HomeAssistant  hass, SignalType[*_Ts]  signal, Callable[[*_Ts], Any]   target  )

private

Definition at line 93 of file dispatcher.py.

_Ts() [4/8]

Callable[[], None] homeassistant.helpers.dispatcher._Ts ( HomeAssistant  hass, SignalType  signal[*_Ts], Callable  [[*_Ts], None]  target  )

private

Connect a callable function to a signal.

Definition at line 40 of file dispatcher.py.

_Ts() [5/8]

None homeassistant.helpers.dispatcher._Ts ( HomeAssistant  hass, SignalType[*_Ts] | str  signal, **_Ts   args  )

private

Send signal and data.

This method must be run in the event loop.

Send signal and data.

This method is intended to only be used by core internally
and should not be considered a stable API. We will make
breaking changes to this function in the future and it
should not be used in integrations.

This method must be run in the event loop.

Definition at line 198 of file dispatcher.py.

_Ts() [6/8]

Callable[[], None] homeassistant.helpers.dispatcher._Ts ( HomeAssistant  hass, SignalType[*_Ts] | str  signal, Callable[[*_Ts], Any] | Callable[..., Any]  target  )

private

Connect a callable function to a signal.

This method must be run in the event loop.

Definition at line 108 of file dispatcher.py.

_Ts() [7/8]

HassJob[..., Coroutine[Any, Any, None] | None] homeassistant.helpers.dispatcher._Ts ( SignalType[*_Ts] | str  signal, Callable[[*_Ts], Any] | Callable[..., Any]   target  )

private

Generate a HassJob for a signal and target.

Definition at line 162 of file dispatcher.py.

_Ts() [8/8]

str homeassistant.helpers.dispatcher._Ts ( SignalType[*_Ts] | str  signal, Callable[[*_Ts], Any] | Callable[..., Any]  target, *Any  args  )

private

Format error message.

Definition at line 148 of file dispatcher.py.

async_dispatcher_connect()

Callable[[], None] homeassistant.helpers.dispatcher.async_dispatcher_connect	(	HomeAssistant	hass,
		str	signal,
		Callable[..., Any]	target
	)

Definition at line 101 of file dispatcher.py.

async_dispatcher_send()

None homeassistant.helpers.dispatcher.async_dispatcher_send	(	HomeAssistant	hass,
		str	signal,
		*Any	args
	)

Definition at line 193 of file dispatcher.py.

dispatcher_connect()

Callable[[], None] homeassistant.helpers.dispatcher.dispatcher_connect	(	HomeAssistant	hass,
		str	signal,
		Callable[..., None]	target
	)

Definition at line 47 of file dispatcher.py.

dispatcher_send()

None homeassistant.helpers.dispatcher.dispatcher_send	(	HomeAssistant	hass,
		str	signal,
		*Any	args
	)

Definition at line 137 of file dispatcher.py.

Variable Documentation

_LOGGER

homeassistant.helpers.dispatcher._LOGGER = logging.getLogger(__name__)

private

Definition at line 25 of file dispatcher.py.

DATA_DISPATCHER

string homeassistant.helpers.dispatcher.DATA_DISPATCHER = "dispatcher"

Definition at line 26 of file dispatcher.py.