homeassistant.helpers.normalized_name_base_registry Namespace Reference

Classes
class	NormalizedNameBaseRegistryEntry
class	NormalizedNameBaseRegistryItems

Functions
None	__init__ (self)
None	_index_entry (self, str key, _VT entry)
None	_unindex_entry (self, str key, _VT|None replacement_entry=None)
str	generate_id_from_name (self, str name)
_VT|None	get_by_name (self, str name)
str	normalize_name (str name)

Detailed Description

Provide a base class for registries that use a normalized name index.

Function Documentation

__init__()

None homeassistant.helpers.normalized_name_base_registry.__init__

(

self

)

Base container for normalized name registry items, maps key -> entry.

Maintains an additional index:
- normalized name -> entry

Initialize the container.

Definition at line 41 of file normalized_name_base_registry.py.

_index_entry()

None homeassistant.helpers.normalized_name_base_registry._index_entry (   self, str  key, _VT  entry  )

private

Definition at line 59 of file normalized_name_base_registry.py.

_unindex_entry()

None homeassistant.helpers.normalized_name_base_registry._unindex_entry (   self, str  key, _VT | None   replacement_entry = None  )

private

Definition at line 46 of file normalized_name_base_registry.py.

generate_id_from_name()

str homeassistant.helpers.normalized_name_base_registry.generate_id_from_name	(		self,
		str	name
	)

Generate ID from name.

Definition at line 66 of file normalized_name_base_registry.py.

get_by_name()

_VT | None homeassistant.helpers.normalized_name_base_registry.get_by_name	(		self,
		str	name
	)

Get entry by name.

Definition at line 62 of file normalized_name_base_registry.py.

normalize_name()

str homeassistant.helpers.normalized_name_base_registry.normalize_name

(

str

name

)

Normalize a name by removing whitespace and case folding.

Definition at line 27 of file normalized_name_base_registry.py.