homeassistant.helpers.entity_registry.EntityRegistryItems Class Reference

Inheritance diagram for homeassistant.helpers.entity_registry.EntityRegistryItems:

Collaboration diagram for homeassistant.helpers.entity_registry.EntityRegistryItems:

Public Member Functions
None	__init__ (self)
KeysView[str]	get_device_ids (self)
str|None	get_entity_id (self, tuple[str, str, str] key)
list[RegistryEntry]	get_entries_for_area_id (self, str area_id)
list[RegistryEntry]	get_entries_for_config_entry_id (self, str config_entry_id)
list[RegistryEntry]	get_entries_for_device_id (self, str device_id, bool include_disabled_entities=False)
list[RegistryEntry]	get_entries_for_label (self, str label)
RegistryEntry|None	get_entry (self, str key)
Public Member Functions inherited from homeassistant.helpers.registry.BaseRegistryItems
None	__delitem__ (self, str key)
None	__setitem__ (self, str key, _DataT entry)
ValuesView[_DataT]	values (self)
Public Member Functions inherited from homeassistant.helpers.entity_registry.RegistryEntry
dict[str, Any]	as_partial_dict (self)
json_fragment	as_storage_fragment (self)
bool	disabled (self)
bytes|None	display_json_repr (self)
dict[str, Any]	extended_dict (self)
bool	hidden (self)
bytes|None	partial_json_repr (self)
None	write_unavailable_state (self, HomeAssistant hass)

Private Member Functions
None	_index_entry (self, str key, RegistryEntry entry)
None	_unindex_entry (self, str key, RegistryEntry|None replacement_entry=None)

Additional Inherited Members
Public Attributes inherited from homeassistant.helpers.entity_registry.RegistryEntry
	domain
Static Public Attributes inherited from homeassistant.helpers.entity_registry.RegistryEntry
	bool
	converter
	datetime
	default
	dict
	eq
	factory
	False
	init
	int
	None
	ReadOnlyEntityOptionsType
	repr
	str

Detailed Description

Container for entity registry items, maps entity_id -> entry.

Maintains six additional indexes:
- id -> entry
- (domain, platform, unique_id) -> entity_id
- config_entry_id -> dict[key, True]
- device_id -> dict[key, True]
- area_id -> dict[key, True]
- label -> dict[key, True]

Definition at line 549 of file entity_registry.py.

Constructor & Destructor Documentation

__init__()

None homeassistant.helpers.entity_registry.EntityRegistryItems.__init__

(

self

)

Initialize the container.

Definition at line 561 of file entity_registry.py.

Member Function Documentation

_index_entry()

None homeassistant.helpers.entity_registry.EntityRegistryItems._index_entry (   self, str  key, RegistryEntry  entry  )

private

Index an entry.

Definition at line 571 of file entity_registry.py.

_unindex_entry()

None homeassistant.helpers.entity_registry.EntityRegistryItems._unindex_entry (   self, str  key, RegistryEntry | None   replacement_entry = None  )

private

Unindex an entry.

Definition at line 586 of file entity_registry.py.

get_device_ids()

KeysView[str] homeassistant.helpers.entity_registry.EntityRegistryItems.get_device_ids

(

self

)

Return device ids.

Definition at line 603 of file entity_registry.py.

get_entity_id()

str | None homeassistant.helpers.entity_registry.EntityRegistryItems.get_entity_id	(		self,
		tuple[str, str, str]	key
	)

Get entity_id from (domain, platform, unique_id).

Definition at line 607 of file entity_registry.py.

get_entries_for_area_id()

list[RegistryEntry] homeassistant.helpers.entity_registry.EntityRegistryItems.get_entries_for_area_id	(		self,
		str	area_id
	)

Get entries for area.

Definition at line 635 of file entity_registry.py.

get_entries_for_config_entry_id()

list[RegistryEntry] homeassistant.helpers.entity_registry.EntityRegistryItems.get_entries_for_config_entry_id	(		self,
		str	config_entry_id
	)

Get entries for config entry.

Definition at line 626 of file entity_registry.py.

get_entries_for_device_id()

list[RegistryEntry] homeassistant.helpers.entity_registry.EntityRegistryItems.get_entries_for_device_id	(		self,
		str	device_id,
		bool	include_disabled_entities = False
	)

Get entries for device.

Definition at line 615 of file entity_registry.py.

get_entries_for_label()

list[RegistryEntry] homeassistant.helpers.entity_registry.EntityRegistryItems.get_entries_for_label	(		self,
		str	label
	)

Get entries for label.

Definition at line 640 of file entity_registry.py.

get_entry()

RegistryEntry | None homeassistant.helpers.entity_registry.EntityRegistryItems.get_entry	(		self,
		str	key
	)

Get entry from id.

Definition at line 611 of file entity_registry.py.

---

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

• core/homeassistant/helpers/entity_registry.py