homeassistant.data_entry_flow Namespace Reference

Classes
class	AbortFlow
class	BaseServiceInfo
class	FlowContext
class	FlowError
class	FlowHandler
class	FlowManager
class	FlowResult
class	FlowResultType
class	InvalidData
class	section
class	SectionConfig
class	UnknownFlow
class	UnknownHandler
class	UnknownStep

Functions
None	_map_error_to_schema_errors (dict[str, Any] schema_errors, vol.Invalid error, vol.Schema data_schema)

Variables
	__all__ = all_with_deprecated_constants(globals())
	__dir__
	__getattr__ = partial(check_if_deprecated_constant, module_globals=globals())
	_DEPRECATED_RESULT_TYPE_ABORT = DeprecatedConstantEnum(FlowResultType.ABORT, "2025.1")
	_DEPRECATED_RESULT_TYPE_CREATE_ENTRY
	_DEPRECATED_RESULT_TYPE_EXTERNAL_STEP
	_DEPRECATED_RESULT_TYPE_EXTERNAL_STEP_DONE
	_DEPRECATED_RESULT_TYPE_FORM = DeprecatedConstantEnum(FlowResultType.FORM, "2025.1")
	_DEPRECATED_RESULT_TYPE_MENU = DeprecatedConstantEnum(FlowResultType.MENU, "2025.1")
	_DEPRECATED_RESULT_TYPE_SHOW_PROGRESS
	_DEPRECATED_RESULT_TYPE_SHOW_PROGRESS_DONE
	_FlowContextT = TypeVar("_FlowContextT", bound="FlowContext", default="FlowContext")
	_FlowResultT
	_HandlerT = TypeVar("_HandlerT", default=str)
	_LOGGER = logging.getLogger(__name__)
string	EVENT_DATA_ENTRY_FLOW_PROGRESSED = "data_entry_flow_progressed"
dictionary	FLOW_NOT_COMPLETE_STEPS
dictionary	STEP_ID_OPTIONAL_STEPS

Detailed Description

Classes to help gather user submissions.

Function Documentation

_map_error_to_schema_errors()

None homeassistant.data_entry_flow._map_error_to_schema_errors ( dict[str, Any]  schema_errors, vol.Invalid  error, vol.Schema  data_schema  )

private

Map an error to the correct position in the schema_errors.

Raises ValueError if the error path could not be found in the schema.
Limitation: Nested schemas are not supported and a ValueError will be raised.

Definition at line 179 of file data_entry_flow.py.

Variable Documentation

__all__

homeassistant.data_entry_flow.__all__ = all_with_deprecated_constants(globals())

private

Definition at line 939 of file data_entry_flow.py.

__dir__

homeassistant.data_entry_flow.__dir__

private

Initial value:

=  partial(
    dir_with_deprecated_constants, module_globals_keys=[*globals().keys()]
)

Definition at line 936 of file data_entry_flow.py.

__getattr__

homeassistant.data_entry_flow.__getattr__ = partial(check_if_deprecated_constant, module_globals=globals())

private

Definition at line 935 of file data_entry_flow.py.

_DEPRECATED_RESULT_TYPE_ABORT

homeassistant.data_entry_flow._DEPRECATED_RESULT_TYPE_ABORT = DeprecatedConstantEnum(FlowResultType.ABORT, "2025.1")

private

Definition at line 54 of file data_entry_flow.py.

_DEPRECATED_RESULT_TYPE_CREATE_ENTRY

homeassistant.data_entry_flow._DEPRECATED_RESULT_TYPE_CREATE_ENTRY

private

Initial value:

=  DeprecatedConstantEnum(
    FlowResultType.CREATE_ENTRY, "2025.1"
)

Definition at line 51 of file data_entry_flow.py.

_DEPRECATED_RESULT_TYPE_EXTERNAL_STEP

homeassistant.data_entry_flow._DEPRECATED_RESULT_TYPE_EXTERNAL_STEP

private

Initial value:

=  DeprecatedConstantEnum(
    FlowResultType.EXTERNAL_STEP, "2025.1"
)

Definition at line 55 of file data_entry_flow.py.

_DEPRECATED_RESULT_TYPE_EXTERNAL_STEP_DONE

homeassistant.data_entry_flow._DEPRECATED_RESULT_TYPE_EXTERNAL_STEP_DONE

private

Initial value:

=  DeprecatedConstantEnum(
    FlowResultType.EXTERNAL_STEP_DONE, "2025.1"
)

Definition at line 58 of file data_entry_flow.py.

_DEPRECATED_RESULT_TYPE_FORM

homeassistant.data_entry_flow._DEPRECATED_RESULT_TYPE_FORM = DeprecatedConstantEnum(FlowResultType.FORM, "2025.1")

private

Definition at line 50 of file data_entry_flow.py.

_DEPRECATED_RESULT_TYPE_MENU

homeassistant.data_entry_flow._DEPRECATED_RESULT_TYPE_MENU = DeprecatedConstantEnum(FlowResultType.MENU, "2025.1")

private

Definition at line 67 of file data_entry_flow.py.

_DEPRECATED_RESULT_TYPE_SHOW_PROGRESS

homeassistant.data_entry_flow._DEPRECATED_RESULT_TYPE_SHOW_PROGRESS

private

Initial value:

=  DeprecatedConstantEnum(
    FlowResultType.SHOW_PROGRESS, "2025.1"
)

Definition at line 61 of file data_entry_flow.py.

_DEPRECATED_RESULT_TYPE_SHOW_PROGRESS_DONE

homeassistant.data_entry_flow._DEPRECATED_RESULT_TYPE_SHOW_PROGRESS_DONE

private

Initial value:

=  DeprecatedConstantEnum(
    FlowResultType.SHOW_PROGRESS_DONE, "2025.1"
)

Definition at line 64 of file data_entry_flow.py.

_FlowContextT

homeassistant.data_entry_flow._FlowContextT = TypeVar("_FlowContextT", bound="FlowContext", default="FlowContext")

private

Definition at line 90 of file data_entry_flow.py.

_FlowResultT

homeassistant.data_entry_flow._FlowResultT

private

Initial value:

=  TypeVar(
    "_FlowResultT", bound="FlowResult[Any, Any]", default="FlowResult"
)

Definition at line 91 of file data_entry_flow.py.

_HandlerT

homeassistant.data_entry_flow._HandlerT = TypeVar("_HandlerT", default=str)

private

Definition at line 94 of file data_entry_flow.py.

_LOGGER

homeassistant.data_entry_flow._LOGGER = logging.getLogger(__name__)

private

Definition at line 33 of file data_entry_flow.py.

EVENT_DATA_ENTRY_FLOW_PROGRESSED

string homeassistant.data_entry_flow.EVENT_DATA_ENTRY_FLOW_PROGRESSED = "data_entry_flow_progressed"

Definition at line 70 of file data_entry_flow.py.

FLOW_NOT_COMPLETE_STEPS

dictionary homeassistant.data_entry_flow.FLOW_NOT_COMPLETE_STEPS

Initial value:

=  {
    FlowResultType.FORM,
    FlowResultType.EXTERNAL_STEP,
    FlowResultType.EXTERNAL_STEP_DONE,
    FlowResultType.SHOW_PROGRESS,
    FlowResultType.SHOW_PROGRESS_DONE,
    FlowResultType.MENU,
}

Definition at line 72 of file data_entry_flow.py.

STEP_ID_OPTIONAL_STEPS

dictionary homeassistant.data_entry_flow.STEP_ID_OPTIONAL_STEPS

Initial value:

=  {
    FlowResultType.EXTERNAL_STEP,
    FlowResultType.FORM,
    FlowResultType.MENU,
    FlowResultType.SHOW_PROGRESS,
}

Definition at line 82 of file data_entry_flow.py.