homeassistant.helpers.integration_platform Namespace Reference

Classes
class	IntegrationPlatform

Functions
None	_async_integration_platform_component_loaded (HomeAssistant hass, list[IntegrationPlatform] integration_platforms, Event[EventComponentLoaded] event)
None	_async_process_integration_platforms (HomeAssistant hass, str platform_name, set[str] top_level_components, HassJob process_job)
None	_async_process_integration_platforms_for_component (HomeAssistant hass, Integration integration, list[str] platforms_that_exist, dict[str, IntegrationPlatform] integration_platforms_by_name)
str	_format_err (str name, str platform_name, *Any args)
list[asyncio.Future[Awaitable[None]|None]]	_process_integration_platforms (HomeAssistant hass, Integration integration, dict[str, ModuleType] platforms, dict[str, IntegrationPlatform] integration_platforms_by_name)
None	async_process_integration_platforms (HomeAssistant hass, str platform_name, Callable[[HomeAssistant, str, Any], Awaitable[None]|None] process_platform, bool wait_for_platforms=False)

Variables
	_LOGGER = logging.getLogger(__name__)

Detailed Description

Helpers to help with integration platforms.

Function Documentation

_async_integration_platform_component_loaded()

None homeassistant.helpers.integration_platform._async_integration_platform_component_loaded ( HomeAssistant  hass, list[IntegrationPlatform]  integration_platforms, Event[EventComponentLoaded]  event  )

private

Process integration platforms for a component.

Definition at line 42 of file integration_platform.py.

_async_process_integration_platforms()

None homeassistant.helpers.integration_platform._async_process_integration_platforms ( HomeAssistant  hass, str  platform_name, set[str]  top_level_components, HassJob  process_job  )

private

Process integration platforms for a component.

Definition at line 221 of file integration_platform.py.

_async_process_integration_platforms_for_component()

None homeassistant.helpers.integration_platform._async_process_integration_platforms_for_component ( HomeAssistant  hass, Integration  integration, list[str]  platforms_that_exist, dict[str, IntegrationPlatform]  integration_platforms_by_name  )

private

Process integration platforms for a component.

Definition at line 99 of file integration_platform.py.

_format_err()

str homeassistant.helpers.integration_platform._format_err ( str  name, str  platform_name, *Any  args  )

private

Format error message.

Definition at line 151 of file integration_platform.py.

_process_integration_platforms()

list[asyncio.Future[Awaitable[None] | None]] homeassistant.helpers.integration_platform._process_integration_platforms ( HomeAssistant  hass, Integration  integration, dict[str, ModuleType]  platforms, dict[str, IntegrationPlatform]  integration_platforms_by_name  )

private

Process integration platforms for a component.

Only the platforms that are passed in will be processed.

Definition at line 126 of file integration_platform.py.

async_process_integration_platforms()

None homeassistant.helpers.integration_platform.async_process_integration_platforms	(	HomeAssistant	hass,
		str	platform_name,
		Callable[[HomeAssistant, str, Any], Awaitable[None] | None]	process_platform,
		bool	wait_for_platforms = False
	)

Process a specific platform for all current and future loaded integrations.

Definition at line 157 of file integration_platform.py.

Variable Documentation

_LOGGER

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

private

Definition at line 26 of file integration_platform.py.