homeassistant.components.config.view Namespace Reference

Classes
class	BaseEditConfigView
class	EditIdBasedConfigView
class	EditKeyBasedConfigView

Functions
None	__init__ (self, str component, str config_type, str path, Callable[[Any], str] key_schema, *Callable[[str, str], Coroutine[Any, Any, None]]|None post_write_hook=None, Callable[[dict[str, Any]], Any]|None data_schema=None, Callable[[HomeAssistant, str, dict[str, Any]], Coroutine[Any, Any, dict[str, Any]|None],]|None data_validator=None)
dict[str, Any]|None	_delete_value (self, HomeAssistant hass, _DataT data, str config_key)
_DataT	_empty_config (self)
dict[str, Any]|None	_get_value (self, HomeAssistant hass, _DataT data, str config_key)
JSON_TYPE|None	_read (str path)
None	_write (str path, dict|list data)
None	_write_value (self, HomeAssistant hass, _DataT data, str config_key, dict[str, Any] new_value)
web.Response	delete (self, web.Request request, str config_key)
web.Response	get (self, web.Request request, str config_key)
web.Response	post (self, web.Request request, str config_key)
_DataT	read_config (self, HomeAssistant hass)

Variables
	data_schema
	data_validator
	key_schema
	mutation_lock
	name
	path
	post_write_hook
	url

Detailed Description

Component to configure Home Assistant via an API.

Function Documentation

__init__()

None homeassistant.components.config.view.__init__	(		self,
		str	component,
		str	config_type,
		str	path,
		Callable[[Any], str]	key_schema,
		*Callable[[str, str], Coroutine[Any, Any, None]] | None	post_write_hook = None,
		Callable[[dict[str, Any]], Any] | None	data_schema = None,
		Callable[ [HomeAssistant, str, dict[str, Any]], Coroutine[Any, Any, dict[str, Any] | None], ] | None	data_validator = None
	)

Configure a Group endpoint.

Initialize a config view.

Definition at line 30 of file view.py.

_delete_value()

dict[str, Any] | None homeassistant.components.config.view._delete_value (   self, HomeAssistant  hass, _DataT  data, str   config_key  )

private

Delete value.

Definition at line 81 of file view.py.

_empty_config()

_DataT homeassistant.components.config.view._empty_config (   self )

private

Empty config if file not found.

Definition at line 61 of file view.py.

_get_value()

dict[str, Any] | None homeassistant.components.config.view._get_value (   self, HomeAssistant  hass, _DataT  data, str   config_key  )

private

Get value.

Definition at line 65 of file view.py.

_read()

JSON_TYPE | None homeassistant.components.config.view._read ( str  path )

private

Read YAML helper.

Definition at line 238 of file view.py.

_write()

None homeassistant.components.config.view._write ( str  path, dict | list  data  )

private

Write YAML helper.

Definition at line 246 of file view.py.

_write_value()

None homeassistant.components.config.view._write_value (   self, HomeAssistant  hass, _DataT  data, str  config_key, dict[str, Any]  new_value  )

private

Set value.

Definition at line 71 of file view.py.

delete()

web.Response homeassistant.components.config.view.delete	(		self,
		web.Request	request,
		str	config_key
	)

Remove an entry.

Definition at line 144 of file view.py.

get()

web.Response homeassistant.components.config.view.get	(		self,
		web.Request	request,
		str	config_key
	)

Fetch device specific config.

Definition at line 88 of file view.py.

post()

web.Response homeassistant.components.config.view.post	(		self,
		web.Request	request,
		str	config_key
	)

Validate config and return results.

Definition at line 101 of file view.py.

read_config()

_DataT homeassistant.components.config.view.read_config	(		self,
		HomeAssistant	hass
	)

Read the config.

Definition at line 163 of file view.py.

Variable Documentation

data_schema

homeassistant.components.config.view.data_schema

Definition at line 50 of file view.py.

data_validator

homeassistant.components.config.view.data_validator

Definition at line 52 of file view.py.

key_schema

homeassistant.components.config.view.key_schema

Definition at line 49 of file view.py.

mutation_lock

homeassistant.components.config.view.mutation_lock

Definition at line 53 of file view.py.

name

homeassistant.components.config.view.name

Definition at line 47 of file view.py.

path

homeassistant.components.config.view.path

Definition at line 48 of file view.py.

post_write_hook

homeassistant.components.config.view.post_write_hook

Definition at line 51 of file view.py.

url

homeassistant.components.config.view.url

Definition at line 46 of file view.py.