homeassistant.config_entries.ConfigEntryItems Class Reference

Inheritance diagram for homeassistant.config_entries.ConfigEntryItems:

Collaboration diagram for homeassistant.config_entries.ConfigEntryItems:

Public Member Functions
None	__delitem__ (self, str entry_id)
None	__init__ (self, HomeAssistant hass)
None	__setitem__ (self, str entry_id, ConfigEntry entry)
None	check_unique_id (self, ConfigEntry entry)
list[ConfigEntry]	get_entries_for_domain (self, str domain)
ConfigEntry|None	get_entry_by_domain_and_unique_id (self, str domain, str unique_id)
None	update_unique_id (self, ConfigEntry entry, str|None new_unique_id)
ValuesView[ConfigEntry]	values (self)
Public Member Functions inherited from homeassistant.config_entries.ConfigEntry
None	__init__ (self, *datetime|None created_at=None, Mapping[str, Any] data, ConfigEntryDisabler|None disabled_by=None, MappingProxyType[str, tuple[DiscoveryKey,...]] discovery_keys, str domain, str|None entry_id=None, int minor_version, datetime|None modified_at=None, Mapping[str, Any]|None options, bool|None pref_disable_new_entities=None, bool|None pref_disable_polling=None, str source, ConfigEntryState state=ConfigEntryState.NOT_LOADED, str title, str|None unique_id, int version)
str	__repr__ (self)
None	__setattr__ (self, str key, Any value)
CALLBACK_TYPE	add_update_listener (self, UpdateListenerType listener)
dict[str, Any]	as_dict (self)
json_fragment	as_json_fragment (self)
json_fragment	as_storage_fragment (self)
None	async_cancel_retry_setup (self)
Generator[ConfigFlowResult]	async_get_active_flows (self, HomeAssistant hass, set[str] sources)
bool	async_migrate (self, HomeAssistant hass)
None	async_on_unload (self, Callable[[], Coroutine[Any, Any, None]|None] func)
None	async_remove (self, HomeAssistant hass)
None	async_setup (self, HomeAssistant hass, *loader.Integration|None integration=None)
None	async_setup_locked (self, HomeAssistant hass, loader.Integration|None integration=None)
None	async_shutdown (self)
None	async_start_reauth (self, HomeAssistant hass, ConfigFlowContext|None context=None, dict[str, Any]|None data=None)
bool	async_unload (self, HomeAssistant hass, *loader.Integration|None integration=None)
None	clear_state_cache (self)
None	clear_storage_cache (self)
bool	supports_options (self)
bool	supports_reconfigure (self)

Private Member Functions
None	_index_entry (self, ConfigEntry entry)
None	_unindex_entry (self, str entry_id)

Private Attributes
	_hass

Additional Inherited Members
Public Attributes inherited from homeassistant.config_entries.ConfigEntry
	domain
	minor_version
	source
	state
	supports_remove_device
	supports_unload
	version
Static Public Attributes inherited from homeassistant.config_entries.ConfigEntry
	default

Detailed Description

Container for config items, maps config_entry_id -> entry.

Maintains two additional indexes:
- domain -> list[ConfigEntry]
- domain -> unique_id -> ConfigEntry

Definition at line 1614 of file config_entries.py.

Constructor & Destructor Documentation

__init__()

None homeassistant.config_entries.ConfigEntryItems.__init__	(		self,
		HomeAssistant	hass
	)

Initialize the container.

Definition at line 1622 of file config_entries.py.

Member Function Documentation

__delitem__()

None homeassistant.config_entries.ConfigEntryItems.__delitem__	(		self,
		str	entry_id
	)

Remove an item.

Definition at line 1704 of file config_entries.py.

__setitem__()

None homeassistant.config_entries.ConfigEntryItems.__setitem__	(		self,
		str	entry_id,
		ConfigEntry	entry
	)

Add an item.

Definition at line 1633 of file config_entries.py.

_index_entry()

None homeassistant.config_entries.ConfigEntryItems._index_entry (   self, ConfigEntry  entry  )

private

Index an entry.

Definition at line 1681 of file config_entries.py.

_unindex_entry()

None homeassistant.config_entries.ConfigEntryItems._unindex_entry (   self, str  entry_id  )

private

Unindex an entry.

Definition at line 1690 of file config_entries.py.

check_unique_id()

None homeassistant.config_entries.ConfigEntryItems.check_unique_id	(		self,
		ConfigEntry	entry
	)

Check config entry unique id.

For a string unique id (this is the correct case): return
For a hashable non string unique id: log warning
For a non-hashable unique id: raise error

Definition at line 1645 of file config_entries.py.

get_entries_for_domain()

list[ConfigEntry] homeassistant.config_entries.ConfigEntryItems.get_entries_for_domain	(		self,
		str	domain
	)

Get entries for a domain.

Definition at line 1722 of file config_entries.py.

get_entry_by_domain_and_unique_id()

ConfigEntry | None homeassistant.config_entries.ConfigEntryItems.get_entry_by_domain_and_unique_id	(		self,
		str	domain,
		str	unique_id
	)

Get entry by domain and unique id.

Definition at line 1726 of file config_entries.py.

update_unique_id()

None homeassistant.config_entries.ConfigEntryItems.update_unique_id	(		self,
		ConfigEntry	entry,
		str | None	new_unique_id
	)

Update unique id for an entry.

This method mutates the entry with the new unique id and updates the indexes.

Definition at line 1709 of file config_entries.py.

values()

ValuesView[ConfigEntry] homeassistant.config_entries.ConfigEntryItems.values

(

self

)

Return the underlying values to avoid __iter__ overhead.

Definition at line 1629 of file config_entries.py.

Member Data Documentation

_hass

homeassistant.config_entries.ConfigEntryItems._hass

private

Definition at line 1625 of file config_entries.py.

---

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

• core/homeassistant/config_entries.py