homeassistant.config_entries.ConfigEntriesFlowManager Class Reference

Inheritance diagram for homeassistant.config_entries.ConfigEntriesFlowManager:

Collaboration diagram for homeassistant.config_entries.ConfigEntriesFlowManager:

Public Member Functions
None	__init__ (self, HomeAssistant hass, ConfigEntries config_entries, ConfigType hass_config)
ConfigFlow	async_create_flow (self, str handler_key, *ConfigFlowContext|None context=None, Any data=None)
ConfigFlowResult	async_finish_flow (self, data_entry_flow.FlowHandler[ConfigFlowContext, ConfigFlowResult] flow, ConfigFlowResult result)
bool	async_has_matching_discovery_flow (self, str handler, ConfigFlowContext match_context, Any data)
bool	async_has_matching_flow (self, ConfigFlow flow)
ConfigFlowResult	async_init (self, str handler, *ConfigFlowContext|None context=None, Any data=None)
None	async_post_init (self, data_entry_flow.FlowHandler[ConfigFlowContext, ConfigFlowResult] flow, ConfigFlowResult result)
None	async_shutdown (self)
None	async_wait_import_flow_initialized (self, str handler)
Public Member Functions inherited from homeassistant.data_entry_flow.FlowManager
None	__init__ (self, HomeAssistant hass)
None	async_abort (self, str flow_id)
_FlowResultT	async_configure (self, str flow_id, dict|None user_input=None)
FlowHandler[_FlowContextT, _FlowResultT, _HandlerT]	async_create_flow (self, _HandlerT handler_key, *_FlowContextT|None context=None, dict[str, Any]|None data=None)
_FlowResultT	async_finish_flow (self, FlowHandler[_FlowContextT, _FlowResultT, _HandlerT] flow, _FlowResultT result)
_FlowResultT	async_get (self, str flow_id)
_FlowResultT	async_init (self, _HandlerT handler, *_FlowContextT|None context=None, Any data=None)
None	async_post_init (self, FlowHandler[_FlowContextT, _FlowResultT, _HandlerT] flow, _FlowResultT result)
list[_FlowResultT]	async_progress (self, bool include_uninitialized=False)
list[_FlowResultT]	async_progress_by_handler (self, _HandlerT handler, bool include_uninitialized=False, dict[str, Any]|None match_context=None)
list[_FlowResultT]	async_progress_by_init_data_type (self, type init_data_type, Callable[[Any], bool] matcher, bool include_uninitialized=False)

Public Attributes
	config_entries
Public Attributes inherited from homeassistant.data_entry_flow.FlowManager
	hass

Private Member Functions
None	_async_discovery (self)
bool	_async_has_other_discovery_flows (self, str flow_id)
tuple[ConfigFlow, ConfigFlowResult]	_async_init (self, str flow_id, str handler, ConfigFlowContext context, Any data)
None	_set_pending_import_done (self, ConfigFlow flow)

Private Attributes
	_discovery_debouncer
	_hass_config

Static Private Attributes
	_flow_result

Detailed Description

Manage all the config entry flows that are in progress.

Definition at line 1209 of file config_entries.py.

Constructor & Destructor Documentation

__init__()

None homeassistant.config_entries.ConfigEntriesFlowManager.__init__	(		self,
		HomeAssistant	hass,
		ConfigEntries	config_entries,
		ConfigType	hass_config
	)

Initialize the config entry flow manager.

Definition at line 1216 of file config_entries.py.

Member Function Documentation

_async_discovery()

None homeassistant.config_entries.ConfigEntriesFlowManager._async_discovery (   self )

private

Handle discovery.

Definition at line 1569 of file config_entries.py.

_async_has_other_discovery_flows()

bool homeassistant.config_entries.ConfigEntriesFlowManager._async_has_other_discovery_flows (   self, str  flow_id  )

private

Check if there are any other discovery flows in progress.

Definition at line 1249 of file config_entries.py.

_async_init()

tuple[ConfigFlow, ConfigFlowResult] homeassistant.config_entries.ConfigEntriesFlowManager._async_init (   self, str  flow_id, str  handler, ConfigFlowContext  context, Any  data  )

private

Run the init in a task to allow it to be canceled at shutdown.

Definition at line 1332 of file config_entries.py.

_set_pending_import_done()

None homeassistant.config_entries.ConfigEntriesFlowManager._set_pending_import_done (   self, ConfigFlow  flow  )

private

Set pending import flow as done.

Definition at line 1355 of file config_entries.py.

async_create_flow()

ConfigFlow homeassistant.config_entries.ConfigEntriesFlowManager.async_create_flow	(		self,
		str	handler_key,
		*ConfigFlowContext | None	context = None,
		Any	data = None
	)

Create a flow for specified handler.

Handler key is the domain of the component that we want to set up.

Definition at line 1525 of file config_entries.py.

async_finish_flow()

ConfigFlowResult homeassistant.config_entries.ConfigEntriesFlowManager.async_finish_flow	(		self,
		data_entry_flow.FlowHandler[ConfigFlowContext, ConfigFlowResult]	flow,
		ConfigFlowResult	result
	)

Finish a config flow and add an entry.

This method is called when a flow step returns FlowResultType.ABORT or
FlowResultType.CREATE_ENTRY.

Definition at line 1372 of file config_entries.py.

async_has_matching_discovery_flow()

bool homeassistant.config_entries.ConfigEntriesFlowManager.async_has_matching_discovery_flow	(		self,
		str	handler,
		ConfigFlowContext	match_context,
		Any	data
	)

Check if an existing matching discovery flow is in progress.

A flow with the same handler, context, and data.

If match_context is passed, only return flows with a context that is a
superset of match_context.

Definition at line 1585 of file config_entries.py.

async_has_matching_flow()

bool homeassistant.config_entries.ConfigEntriesFlowManager.async_has_matching_flow	(		self,
		ConfigFlow	flow
	)

Check if an existing matching flow is in progress.

Definition at line 1604 of file config_entries.py.

async_init()

ConfigFlowResult homeassistant.config_entries.ConfigEntriesFlowManager.async_init	(		self,
		str	handler,
		*ConfigFlowContext | None	context = None,
		Any	data = None
	)

Start a configuration flow.

Definition at line 1256 of file config_entries.py.

async_post_init()

None homeassistant.config_entries.ConfigEntriesFlowManager.async_post_init	(		self,
		data_entry_flow.FlowHandler[ConfigFlowContext, ConfigFlowResult]	flow,
		ConfigFlowResult	result
	)

After a flow is initialised trigger new flow notifications.

Definition at line 1546 of file config_entries.py.

async_shutdown()

None homeassistant.config_entries.ConfigEntriesFlowManager.async_shutdown

(

self

)

Cancel any initializing flows.

Definition at line 1365 of file config_entries.py.

async_wait_import_flow_initialized()

None homeassistant.config_entries.ConfigEntriesFlowManager.async_wait_import_flow_initialized	(		self,
		str	handler
	)

Wait till all import flows in progress are initialized.

Definition at line 1241 of file config_entries.py.

Member Data Documentation

_discovery_debouncer

homeassistant.config_entries.ConfigEntriesFlowManager._discovery_debouncer

private

Definition at line 1232 of file config_entries.py.

_flow_result

homeassistant.config_entries.ConfigEntriesFlowManager._flow_result

staticprivate

Definition at line 1214 of file config_entries.py.

_hass_config

homeassistant.config_entries.ConfigEntriesFlowManager._hass_config

private

Definition at line 1225 of file config_entries.py.

config_entries

homeassistant.config_entries.ConfigEntriesFlowManager.config_entries

Definition at line 1224 of file config_entries.py.

---

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

• core/homeassistant/config_entries.py