Home Assistant Unofficial Reference 2024.12.1
config_validation.py File Reference

Go to the source code of this file.

Classes

class  homeassistant.helpers.config_validation._Hass
 
class  homeassistant.helpers.config_validation.multi_select
 
class  homeassistant.helpers.config_validation.MustValidateInExecutor
 
class  homeassistant.helpers.config_validation.UrlProtocolSchema
 

Namespaces

 homeassistant.helpers.config_validation
 

Functions

HomeAssistant|None homeassistant.helpers.config_validation._async_get_hass_or_none ()
 
Any homeassistant.helpers.config_validation._backward_compat_service_schema (Any|None value)
 
list[Any] homeassistant.helpers.config_validation._base_trigger_list_flatten (list[Any] triggers)
 
Any homeassistant.helpers.config_validation._base_trigger_validator (Any value)
 
Any homeassistant.helpers.config_validation._custom_serializer (Any schema, *bool allow_section)
 
Callable[[dict], dict] homeassistant.helpers.config_validation._deprecated_or_removed (str key, str|None replacement_key, Any|None default, bool raise_if_present, bool option_removed)
 
list[str] homeassistant.helpers.config_validation._entity_ids (str|list value, bool allow_uuid)
 
def homeassistant.helpers.config_validation._KT
 
VolSchemaType homeassistant.helpers.config_validation._make_entity_service_schema (dict schema, int extra)
 
Callable[[dict], dict] homeassistant.helpers.config_validation._no_yaml_config_schema (str domain, str issue_base, str translation_key, dict[str, str] translation_placeholders)
 
Any homeassistant.helpers.config_validation._positive_time_period_template_complex (Any value)
 
Callable[_P, _R] homeassistant.helpers.config_validation._R (Callable[_P, _R] validator)
 
_T homeassistant.helpers.config_validation._T (_T value)
 
list[_T]|list[Any] homeassistant.helpers.config_validation._T (_T|None value)
 
list[_T] homeassistant.helpers.config_validation._T (list[_T] value)
 
list[_T] homeassistant.helpers.config_validation._T (list[_T]|_T value)
 
Any homeassistant.helpers.config_validation._trigger_pre_validator (Any|None value)
 
Any homeassistant.helpers.config_validation._validate_in_executor (HomeAssistant hass, Callable[[Any], Any] validator, Any value)
 
Any homeassistant.helpers.config_validation.async_validate (HomeAssistant hass, Callable[[Any], Any] validator, Any value)
 
bool homeassistant.helpers.config_validation.boolean (Any value)
 
str homeassistant.helpers.config_validation.color_hex (Any value)
 
Callable[[dict], dict] homeassistant.helpers.config_validation.config_entry_only_config_schema (str domain)
 
str homeassistant.helpers.config_validation.configuration_url (Any value)
 
Any homeassistant.helpers.config_validation.custom_serializer (Any schema)
 
date_sys homeassistant.helpers.config_validation.date (Any value)
 
datetime_sys homeassistant.helpers.config_validation.datetime (Any value)
 
Callable[[dict], dict] homeassistant.helpers.config_validation.deprecated (str key, str|None replacement_key=None, Any|None default=None, bool|None raise_if_present=False)
 
str homeassistant.helpers.config_validation.determine_script_action (dict[str, Any] action)
 
str homeassistant.helpers.config_validation.domain_key (Any config_key)
 
template_helper.Template homeassistant.helpers.config_validation.dynamic_template (Any|None value)
 
Callable[[dict], dict] homeassistant.helpers.config_validation.empty_config_schema (str domain)
 
list[Any] homeassistant.helpers.config_validation.ensure_list (None value)
 
list homeassistant.helpers.config_validation.ensure_list_csv (Any value)
 
Callable[[str|list], list[str]] homeassistant.helpers.config_validation.entities_domain (str|list[str] domain)
 
Callable[[Any], str] homeassistant.helpers.config_validation.entity_domain (str|list[str] domain)
 
str homeassistant.helpers.config_validation.entity_id (Any value)
 
str homeassistant.helpers.config_validation.entity_id_or_uuid (Any value)
 
list[str] homeassistant.helpers.config_validation.entity_ids (str|list value)
 
list[str] homeassistant.helpers.config_validation.entity_ids_or_uuids (str|list value)
 
vol.All homeassistant.helpers.config_validation.enum (type[Enum] enumClass)
 
Any homeassistant.helpers.config_validation.expand_condition_shorthand (Any|None value)
 
str homeassistant.helpers.config_validation.fake_uuid4_hex (Any value)
 
Callable[[dict], dict] homeassistant.helpers.config_validation.has_at_least_one_key (*Any keys)
 
Callable[[dict], dict] homeassistant.helpers.config_validation.has_at_most_one_key (*Any keys)
 
str homeassistant.helpers.config_validation.icon (Any value)
 
bool homeassistant.helpers.config_validation.is_entity_service_schema (VolSchemaType validator)
 
re.Pattern[Any] homeassistant.helpers.config_validation.is_regex (Any value)
 
str homeassistant.helpers.config_validation.isdevice (Any value)
 
str homeassistant.helpers.config_validation.isdir (Any value)
 
str homeassistant.helpers.config_validation.isfile (Any value)
 
Callable[[Any], dict[Hashable, Any]] homeassistant.helpers.config_validation.key_value_schemas (str key, dict[Hashable, VolSchemaType|Callable[[Any], dict[str, Any]]] value_schemas, VolSchemaType|None default_schema=None, str|None default_description=None)
 
VolSchemaType homeassistant.helpers.config_validation.make_entity_service_schema (dict|None schema, *int extra=vol.PREVENT_EXTRA)
 
Callable[[Any], str] homeassistant.helpers.config_validation.matches_regex (str regex)
 
str homeassistant.helpers.config_validation.path (Any value)
 
Callable[[dict], dict] homeassistant.helpers.config_validation.platform_only_config_schema (str domain)
 
timedelta homeassistant.helpers.config_validation.positive_timedelta (timedelta value)
 
Callable[[dict], dict] homeassistant.helpers.config_validation.removed (str key, Any|None default=None, bool|None raise_if_present=True)
 
Callable homeassistant.helpers.config_validation.schema_with_slug_keys (dict|Callable value_schema, *Callable[[Any], str] slug_validator=slug)
 
dict homeassistant.helpers.config_validation.script_action (Any value)
 
str homeassistant.helpers.config_validation.service (Any value)
 
str homeassistant.helpers.config_validation.slug (Any value)
 
str homeassistant.helpers.config_validation.slugify (Any value)
 
object homeassistant.helpers.config_validation.socket_timeout (Any|None value)
 
dict[str, Any] homeassistant.helpers.config_validation.STATE_CONDITION_SCHEMA (Any value)
 
str homeassistant.helpers.config_validation.string (Any value)
 
str homeassistant.helpers.config_validation.string_with_no_html (Any value)
 
UnitOfTemperature homeassistant.helpers.config_validation.temperature_unit (Any value)
 
template_helper.Template homeassistant.helpers.config_validation.template (Any|None value)
 
Any homeassistant.helpers.config_validation.template_complex (Any value)
 
time_sys homeassistant.helpers.config_validation.time (Any value)
 
timedelta homeassistant.helpers.config_validation.time_period_seconds (float|str value)
 
timedelta homeassistant.helpers.config_validation.time_period_str (str value)
 
str homeassistant.helpers.config_validation.time_zone (str value)
 
str homeassistant.helpers.config_validation.url (Any value, frozenset[UrlProtocolSchema] _schema_list=EXTERNAL_URL_PROTOCOL_SCHEMA_LIST)
 
str homeassistant.helpers.config_validation.url_no_path (Any value)
 
str homeassistant.helpers.config_validation.uuid4_hex (Any value)
 
str homeassistant.helpers.config_validation.whitespace (Any value)
 
str homeassistant.helpers.config_validation.x10_address (str value)
 

Variables

 homeassistant.helpers.config_validation._base_trigger_validator_schema
 
 homeassistant.helpers.config_validation._COLOR_HEX
 
 homeassistant.helpers.config_validation._FAKE_UUID_4_HEX
 
 homeassistant.helpers.config_validation._HAS_ENTITY_SERVICE_FIELD
 
 homeassistant.helpers.config_validation._hass
 
 homeassistant.helpers.config_validation._parallel_sequence_action
 
 homeassistant.helpers.config_validation._SCRIPT_CHOOSE_SCHEMA
 
 homeassistant.helpers.config_validation._SCRIPT_DELAY_SCHEMA
 
 homeassistant.helpers.config_validation._SCRIPT_IF_SCHEMA
 
 homeassistant.helpers.config_validation._SCRIPT_PARALLEL_SCHEMA
 
 homeassistant.helpers.config_validation._SCRIPT_REPEAT_SCHEMA
 
 homeassistant.helpers.config_validation._SCRIPT_SCENE_SCHEMA
 
 homeassistant.helpers.config_validation._SCRIPT_SEQUENCE_SCHEMA
 
 homeassistant.helpers.config_validation._SCRIPT_SET_CONVERSATION_RESPONSE_SCHEMA
 
 homeassistant.helpers.config_validation._SCRIPT_SET_SCHEMA
 
 homeassistant.helpers.config_validation._SCRIPT_STOP_SCHEMA
 
 homeassistant.helpers.config_validation._SCRIPT_WAIT_FOR_TRIGGER_SCHEMA
 
 homeassistant.helpers.config_validation._SCRIPT_WAIT_TEMPLATE_SCHEMA
 
 homeassistant.helpers.config_validation._TIME_PERIOD_DICT_KEYS
 
 homeassistant.helpers.config_validation.ACTIONS_MAP
 
 homeassistant.helpers.config_validation.ACTIONS_SET
 
 homeassistant.helpers.config_validation.ACTIVE_CURRENCIES
 
 homeassistant.helpers.config_validation.AND_CONDITION_SCHEMA
 
 homeassistant.helpers.config_validation.AND_CONDITION_SHORTHAND_SCHEMA
 
 homeassistant.helpers.config_validation.BASE_ENTITY_SCHEMA
 
 homeassistant.helpers.config_validation.byte
 
 homeassistant.helpers.config_validation.comp_entity_ids
 
 homeassistant.helpers.config_validation.comp_entity_ids_or_uuids
 
 homeassistant.helpers.config_validation.CONDITION_SHORTHAND_SCHEMA
 
 homeassistant.helpers.config_validation.CONDITIONS_SCHEMA
 
 homeassistant.helpers.config_validation.CONF_MATCH
 
 homeassistant.helpers.config_validation.CONFIGURATION_URL_PROTOCOL_SCHEMA_LIST
 
 homeassistant.helpers.config_validation.COUNTRIES
 
 homeassistant.helpers.config_validation.country
 
 homeassistant.helpers.config_validation.currency
 
 homeassistant.helpers.config_validation.default
 
 homeassistant.helpers.config_validation.DEVICE_ACTION_BASE_SCHEMA
 
 homeassistant.helpers.config_validation.DEVICE_ACTION_SCHEMA
 
 homeassistant.helpers.config_validation.DEVICE_CONDITION_BASE_SCHEMA
 
 homeassistant.helpers.config_validation.DEVICE_CONDITION_SCHEMA
 
 homeassistant.helpers.config_validation.dynamic_template_condition_action
 
 homeassistant.helpers.config_validation.EVENT_SCHEMA
 
 homeassistant.helpers.config_validation.EXTERNAL_URL_PROTOCOL_SCHEMA_LIST
 
 homeassistant.helpers.config_validation.extra
 
 homeassistant.helpers.config_validation.gps
 
 homeassistant.helpers.config_validation.HISTORIC_CURRENCIES
 
 homeassistant.helpers.config_validation.historic_currency
 
 homeassistant.helpers.config_validation.language
 
 homeassistant.helpers.config_validation.LANGUAGES
 
 homeassistant.helpers.config_validation.latitude
 
 homeassistant.helpers.config_validation.longitude
 
 homeassistant.helpers.config_validation.max
 
 homeassistant.helpers.config_validation.min
 
 homeassistant.helpers.config_validation.msg
 
 homeassistant.helpers.config_validation.NOT_CONDITION_SCHEMA
 
 homeassistant.helpers.config_validation.NOT_CONDITION_SHORTHAND_SCHEMA
 
 homeassistant.helpers.config_validation.NUMERIC_STATE_CONDITION_SCHEMA
 
 homeassistant.helpers.config_validation.NUMERIC_STATE_THRESHOLD_SCHEMA
 
 homeassistant.helpers.config_validation.OR_CONDITION_SCHEMA
 
 homeassistant.helpers.config_validation.OR_CONDITION_SHORTHAND_SCHEMA
 
 homeassistant.helpers.config_validation.PLATFORM_SCHEMA
 
 homeassistant.helpers.config_validation.PLATFORM_SCHEMA_BASE
 
 homeassistant.helpers.config_validation.port
 
 homeassistant.helpers.config_validation.positive_float
 
 homeassistant.helpers.config_validation.positive_int
 
 homeassistant.helpers.config_validation.positive_time_period
 
 homeassistant.helpers.config_validation.positive_time_period_dict
 
 homeassistant.helpers.config_validation.positive_time_period_template
 
 homeassistant.helpers.config_validation.Schema
 
 homeassistant.helpers.config_validation.SCRIPT_ACTION_ACTIVATE_SCENE
 
 homeassistant.helpers.config_validation.SCRIPT_ACTION_CALL_SERVICE
 
 homeassistant.helpers.config_validation.SCRIPT_ACTION_CHECK_CONDITION
 
 homeassistant.helpers.config_validation.SCRIPT_ACTION_CHOOSE
 
 homeassistant.helpers.config_validation.SCRIPT_ACTION_DELAY
 
 homeassistant.helpers.config_validation.SCRIPT_ACTION_DEVICE_AUTOMATION
 
 homeassistant.helpers.config_validation.SCRIPT_ACTION_FIRE_EVENT
 
 homeassistant.helpers.config_validation.SCRIPT_ACTION_IF
 
 homeassistant.helpers.config_validation.SCRIPT_ACTION_PARALLEL
 
 homeassistant.helpers.config_validation.SCRIPT_ACTION_REPEAT
 
 homeassistant.helpers.config_validation.SCRIPT_ACTION_SEQUENCE
 
 homeassistant.helpers.config_validation.SCRIPT_ACTION_SET_CONVERSATION_RESPONSE
 
 homeassistant.helpers.config_validation.SCRIPT_ACTION_STOP
 
 homeassistant.helpers.config_validation.SCRIPT_ACTION_VARIABLES
 
 homeassistant.helpers.config_validation.SCRIPT_ACTION_WAIT_FOR_TRIGGER
 
 homeassistant.helpers.config_validation.SCRIPT_ACTION_WAIT_TEMPLATE
 
 homeassistant.helpers.config_validation.SCRIPT_CONVERSATION_RESPONSE_SCHEMA
 
 homeassistant.helpers.config_validation.SCRIPT_SCHEMA
 
 homeassistant.helpers.config_validation.SCRIPT_VARIABLES_SCHEMA
 
 homeassistant.helpers.config_validation.SERVICE_SCHEMA
 
 homeassistant.helpers.config_validation.small_float
 
 homeassistant.helpers.config_validation.STATE_CONDITION_ATTRIBUTE_SCHEMA
 
 homeassistant.helpers.config_validation.STATE_CONDITION_BASE_SCHEMA
 
 homeassistant.helpers.config_validation.STATE_CONDITION_STATE_SCHEMA
 
 homeassistant.helpers.config_validation.SUN_CONDITION_SCHEMA
 
 homeassistant.helpers.config_validation.sun_event
 
 homeassistant.helpers.config_validation.TARGET_SERVICE_FIELDS
 
 homeassistant.helpers.config_validation.TEMPLATE_CONDITION_SCHEMA
 
 homeassistant.helpers.config_validation.TIME_CONDITION_SCHEMA
 
 homeassistant.helpers.config_validation.time_period
 
 homeassistant.helpers.config_validation.time_period_dict
 
 homeassistant.helpers.config_validation.TIME_PERIOD_ERROR
 
 homeassistant.helpers.config_validation.TRIGGER_BASE_SCHEMA
 
 homeassistant.helpers.config_validation.TRIGGER_CONDITION_SCHEMA
 
 homeassistant.helpers.config_validation.TRIGGER_SCHEMA
 
 homeassistant.helpers.config_validation.VolDictType
 
 homeassistant.helpers.config_validation.weekdays
 
 homeassistant.helpers.config_validation.ZONE_CONDITION_SCHEMA