Home Assistant Unofficial Reference 2024.12.1
homeassistant.helpers.registry.BaseRegistryItems Class Reference
Inheritance diagram for homeassistant.helpers.registry.BaseRegistryItems:
[legend]
Collaboration diagram for homeassistant.helpers.registry.BaseRegistryItems:
[legend]

Public Member Functions

None __delitem__ (self, str key)
 
None __setitem__ (self, str key, _DataT entry)
 
ValuesView[_DataT] values (self)
 

Private Member Functions

None _index_entry (self, str key, _DataT entry)
 
None _unindex_entry (self, str key, _DataT|None replacement_entry=None)
 
None _unindex_entry_value (self, str key, str value, RegistryIndexType index)
 

Detailed Description

Base class for registry items.

Definition at line 21 of file registry.py.

Member Function Documentation

◆ __delitem__()

None homeassistant.helpers.registry.BaseRegistryItems.__delitem__ (   self,
str  key 
)
Remove an item.

Definition at line 60 of file registry.py.

◆ __setitem__()

None homeassistant.helpers.registry.BaseRegistryItems.__setitem__ (   self,
str  key,
_DataT  entry 
)
Add an item.

Definition at line 38 of file registry.py.

◆ _index_entry()

None homeassistant.helpers.registry.BaseRegistryItems._index_entry (   self,
str  key,
_DataT  entry 
)
private
Index an entry.

Definition at line 31 of file registry.py.

◆ _unindex_entry()

None homeassistant.helpers.registry.BaseRegistryItems._unindex_entry (   self,
str  key,
_DataT | None   replacement_entry = None 
)
private
Unindex an entry.

Definition at line 35 of file registry.py.

◆ _unindex_entry_value()

None homeassistant.helpers.registry.BaseRegistryItems._unindex_entry_value (   self,
str  key,
str  value,
RegistryIndexType   index 
)
private
Unindex an entry value.

key is the entry key
value is the value to unindex such as config_entry_id or device_id.
index is the index to unindex from.

Definition at line 46 of file registry.py.

◆ values()

ValuesView[_DataT] homeassistant.helpers.registry.BaseRegistryItems.values (   self)
Base class for registry items.
Return the underlying values to avoid __iter__ overhead.

Definition at line 26 of file registry.py.


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