homeassistant.helpers.label_registry.LabelRegistry Class Reference

Inheritance diagram for homeassistant.helpers.label_registry.LabelRegistry:

Collaboration diagram for homeassistant.helpers.label_registry.LabelRegistry:

Public Member Functions
None	__init__ (self, HomeAssistant hass)
LabelEntry	async_create (self, str name, *str|None color=None, str|None icon=None, str|None description=None)
None	async_delete (self, str label_id)
LabelEntry|None	async_get_label (self, str label_id)
LabelEntry|None	async_get_label_by_name (self, str name)
Iterable[LabelEntry]	async_list_labels (self)
None	async_load (self)
LabelEntry	async_update (self, str label_id, *str|None|UndefinedType color=UNDEFINED, str|None|UndefinedType description=UNDEFINED, str|None|UndefinedType icon=UNDEFINED, str|UndefinedType name=UNDEFINED)

Public Attributes
	hass
	labels

Private Member Functions
LabelRegistryStoreData	_data_to_save (self)
str	_generate_id (self, str name)

Private Attributes
	_label_data
	_store

Detailed Description

Class to hold a registry of labels.

Definition at line 95 of file label_registry.py.

Constructor & Destructor Documentation

__init__()

None homeassistant.helpers.label_registry.LabelRegistry.__init__	(		self,
		HomeAssistant	hass
	)

Initialize the label registry.

Definition at line 101 of file label_registry.py.

Member Function Documentation

_data_to_save()

LabelRegistryStoreData homeassistant.helpers.label_registry.LabelRegistry._data_to_save (   self )

private

Return data of label registry to store in a file.

Definition at line 248 of file label_registry.py.

_generate_id()

str homeassistant.helpers.label_registry.LabelRegistry._generate_id (   self, str  name  )

private

Generate label ID.

Definition at line 131 of file label_registry.py.

async_create()

LabelEntry homeassistant.helpers.label_registry.LabelRegistry.async_create	(		self,
		str	name,
		*str | None	color = None,
		str | None	icon = None,
		str | None	description = None
	)

Create a new label.

Definition at line 136 of file label_registry.py.

async_delete()

None homeassistant.helpers.label_registry.LabelRegistry.async_delete	(		self,
		str	label_id
	)

Delete label.

Definition at line 170 of file label_registry.py.

async_get_label()

LabelEntry | None homeassistant.helpers.label_registry.LabelRegistry.async_get_label	(		self,
		str	label_id
	)

Get label by ID.

We retrieve the LabelEntry from the underlying dict to avoid
the overhead of the UserDict __getitem__.

Definition at line 113 of file label_registry.py.

async_get_label_by_name()

LabelEntry | None homeassistant.helpers.label_registry.LabelRegistry.async_get_label_by_name	(		self,
		str	name
	)

Get label by name.

Definition at line 122 of file label_registry.py.

async_list_labels()

Iterable[LabelEntry] homeassistant.helpers.label_registry.LabelRegistry.async_list_labels

(

self

)

Get all labels.

Definition at line 127 of file label_registry.py.

async_load()

None homeassistant.helpers.label_registry.LabelRegistry.async_load

(

self

)

Load the label registry.

Definition at line 227 of file label_registry.py.

async_update()

LabelEntry homeassistant.helpers.label_registry.LabelRegistry.async_update	(		self,
		str	label_id,
		*str | None | UndefinedType	color = UNDEFINED,
		str | None | UndefinedType	description = UNDEFINED,
		str | None | UndefinedType	icon = UNDEFINED,
		str | UndefinedType	name = UNDEFINED
	)

Update name of label.

Definition at line 184 of file label_registry.py.

Member Data Documentation

_label_data

homeassistant.helpers.label_registry.LabelRegistry._label_data

private

Definition at line 245 of file label_registry.py.

_store

homeassistant.helpers.label_registry.LabelRegistry._store

private

Definition at line 104 of file label_registry.py.

hass

homeassistant.helpers.label_registry.LabelRegistry.hass

Definition at line 103 of file label_registry.py.

labels

homeassistant.helpers.label_registry.LabelRegistry.labels

Definition at line 244 of file label_registry.py.

---

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

• core/homeassistant/helpers/label_registry.py