homeassistant.helpers.reload Namespace Reference

Functions
None	_async_reconfig_platform (EntityPlatform platform, list[dict[str, Any]] platform_configs)
None	_async_setup_platform (HomeAssistant hass, str integration_domain, str platform_domain, list[dict[str, Any]] platform_configs)
None	_resetup_platform (HomeAssistant hass, str integration_domain, str platform_domain, ConfigType unprocessed_config)
EntityPlatform|None	async_get_platform_without_config_entry (HomeAssistant hass, str integration_name, str integration_platform_name)
ConfigType|None	async_integration_yaml_config (HomeAssistant hass, str integration_name)
ConfigType|None	async_integration_yaml_config (HomeAssistant hass, str integration_name, *bool raise_on_failure=False)
ConfigType|None	async_integration_yaml_config (HomeAssistant hass, str integration_name, *Literal[False] raise_on_failure)
ConfigType	async_integration_yaml_config (HomeAssistant hass, str integration_name, *Literal[True] raise_on_failure)
None	async_reload_integration_platforms (HomeAssistant hass, str integration_domain, Iterable[str] platform_domains)
None	async_setup_reload_service (HomeAssistant hass, str domain, Iterable[str] platforms)
None	setup_reload_service (HomeAssistant hass, str domain, Iterable[str] platforms)

Variables
	_LOGGER = logging.getLogger(__name__)
string	PLATFORM_RESET_LOCK = "lock_async_reset_platform_{}"

Detailed Description

Class to reload platforms.

Function Documentation

_async_reconfig_platform()

None homeassistant.helpers.reload._async_reconfig_platform ( EntityPlatform  platform, list[dict[str, Any]]   platform_configs  )

private

Reconfigure an already loaded platform.

Definition at line 130 of file reload.py.

_async_setup_platform()

None homeassistant.helpers.reload._async_setup_platform ( HomeAssistant  hass, str  integration_domain, str  platform_domain, list[dict[str, Any]]  platform_configs  )

private

Platform for the first time when new configuration is added.

Definition at line 109 of file reload.py.

_resetup_platform()

None homeassistant.helpers.reload._resetup_platform ( HomeAssistant  hass, str  integration_domain, str  platform_domain, ConfigType  unprocessed_config  )

private

Resetup a platform.

Definition at line 54 of file reload.py.

async_get_platform_without_config_entry()

EntityPlatform | None homeassistant.helpers.reload.async_get_platform_without_config_entry	(	HomeAssistant	hass,
		str	integration_name,
		str	integration_platform_name
	)

Find an existing platform that is not a config entry.

Definition at line 175 of file reload.py.

async_integration_yaml_config() [1/4]

ConfigType | None homeassistant.helpers.reload.async_integration_yaml_config	(	HomeAssistant	hass,
		str	integration_name
	)

Definition at line 140 of file reload.py.

async_integration_yaml_config() [2/4]

ConfigType | None homeassistant.helpers.reload.async_integration_yaml_config	(	HomeAssistant	hass,
		str	integration_name,
		*bool	raise_on_failure = False
	)

Fetch the latest yaml configuration for an integration.

Definition at line 163 of file reload.py.

async_integration_yaml_config() [3/4]

ConfigType | None homeassistant.helpers.reload.async_integration_yaml_config	(	HomeAssistant	hass,
		str	integration_name,
		*Literal[False]	raise_on_failure
	)

Definition at line 155 of file reload.py.

async_integration_yaml_config() [4/4]

ConfigType homeassistant.helpers.reload.async_integration_yaml_config	(	HomeAssistant	hass,
		str	integration_name,
		*Literal[True]	raise_on_failure
	)

Definition at line 146 of file reload.py.

async_reload_integration_platforms()

None homeassistant.helpers.reload.async_reload_integration_platforms	(	HomeAssistant	hass,
		str	integration_domain,
		Iterable[str]	platform_domains
	)

Reload an integration's platforms.

The platform must support being re-setup.

This functionality is only intended to be used for integrations that process
Home Assistant data and make this available to other integrations.

Examples are template, stats, derivative, utility meter.

Definition at line 28 of file reload.py.

async_setup_reload_service()

None homeassistant.helpers.reload.async_setup_reload_service	(	HomeAssistant	hass,
		str	domain,
		Iterable[str]	platforms
	)

Create the reload service for the domain.

Definition at line 189 of file reload.py.

setup_reload_service()

None homeassistant.helpers.reload.setup_reload_service	(	HomeAssistant	hass,
		str	domain,
		Iterable[str]	platforms
	)

Sync version of async_setup_reload_service.

Definition at line 204 of file reload.py.

Variable Documentation

_LOGGER

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

private

Definition at line 23 of file reload.py.

PLATFORM_RESET_LOCK

string homeassistant.helpers.reload.PLATFORM_RESET_LOCK = "lock_async_reset_platform_{}"

Definition at line 25 of file reload.py.