homeassistant.components.scrape.config_flow Namespace Reference

Classes
class	ScrapeConfigFlowHandler

Functions
dict[str, Any]	get_edit_sensor_suggested_values (SchemaCommonFlowHandler handler)
vol.Schema	get_remove_sensor_schema (SchemaCommonFlowHandler handler)
vol.Schema	get_select_sensor_schema (SchemaCommonFlowHandler handler)
dict[str, Any]	validate_remove_sensor (SchemaCommonFlowHandler handler, dict[str, Any] user_input)
dict[str, Any]	validate_rest_setup (SchemaCommonFlowHandler handler, dict[str, Any] user_input)
dict[str, Any]	validate_select_sensor (SchemaCommonFlowHandler handler, dict[str, Any] user_input)
dict[str, Any]	validate_sensor_edit (SchemaCommonFlowHandler handler, dict[str, Any] user_input)
dict[str, Any]	validate_sensor_setup (SchemaCommonFlowHandler handler, dict[str, Any] user_input)

Variables
dictionary	CONFIG_FLOW
	DATA_SCHEMA_EDIT_SENSOR = vol.Schema(SENSOR_SETUP)
	DATA_SCHEMA_RESOURCE = vol.Schema(RESOURCE_SETUP)
	DATA_SCHEMA_SENSOR
dictionary	OPTIONS_FLOW
dictionary	RESOURCE_SETUP
dictionary	SENSOR_SETUP

Detailed Description

Adds config flow for Scrape integration.

Function Documentation

get_edit_sensor_suggested_values()

dict[str, Any] homeassistant.components.scrape.config_flow.get_edit_sensor_suggested_values

(

SchemaCommonFlowHandler

handler

)

Return suggested values for sensor editing.

Definition at line 192 of file config_flow.py.

get_remove_sensor_schema()

vol.Schema homeassistant.components.scrape.config_flow.get_remove_sensor_schema

(

SchemaCommonFlowHandler

handler

)

Return schema for sensor removal.

Definition at line 218 of file config_flow.py.

get_select_sensor_schema()

vol.Schema homeassistant.components.scrape.config_flow.get_select_sensor_schema

(

SchemaCommonFlowHandler

handler

)

Return schema for selecting a sensor.

Definition at line 178 of file config_flow.py.

validate_remove_sensor()

dict[str, Any] homeassistant.components.scrape.config_flow.validate_remove_sensor	(	SchemaCommonFlowHandler	handler,
		dict[str, Any]	user_input
	)

Validate remove sensor.

Definition at line 232 of file config_flow.py.

validate_rest_setup()

dict[str, Any] homeassistant.components.scrape.config_flow.validate_rest_setup	(	SchemaCommonFlowHandler	handler,
		dict[str, Any]	user_input
	)

Validate rest setup.

Definition at line 140 of file config_flow.py.

validate_select_sensor()

dict[str, Any] homeassistant.components.scrape.config_flow.validate_select_sensor	(	SchemaCommonFlowHandler	handler,
		dict[str, Any]	user_input
	)

Store sensor index in flow state.

Definition at line 170 of file config_flow.py.

validate_sensor_edit()

dict[str, Any] homeassistant.components.scrape.config_flow.validate_sensor_edit	(	SchemaCommonFlowHandler	handler,
		dict[str, Any]	user_input
	)

Update edited sensor.

Definition at line 200 of file config_flow.py.

validate_sensor_setup()

dict[str, Any] homeassistant.components.scrape.config_flow.validate_sensor_setup	(	SchemaCommonFlowHandler	handler,
		dict[str, Any]	user_input
	)

Validate sensor input.

Definition at line 156 of file config_flow.py.

Variable Documentation

CONFIG_FLOW

dictionary homeassistant.components.scrape.config_flow.CONFIG_FLOW

Initial value:

=  {
    "user": SchemaFlowFormStep(
        schema=DATA_SCHEMA_RESOURCE,
        next_step="sensor",
        validate_user_input=validate_rest_setup,
    ),
    "sensor": SchemaFlowFormStep(
        schema=DATA_SCHEMA_SENSOR,
        validate_user_input=validate_sensor_setup,
    ),
}

Definition at line 263 of file config_flow.py.

DATA_SCHEMA_EDIT_SENSOR

homeassistant.components.scrape.config_flow.DATA_SCHEMA_EDIT_SENSOR = vol.Schema(SENSOR_SETUP)

Definition at line 255 of file config_flow.py.

DATA_SCHEMA_RESOURCE

homeassistant.components.scrape.config_flow.DATA_SCHEMA_RESOURCE = vol.Schema(RESOURCE_SETUP)

Definition at line 254 of file config_flow.py.

DATA_SCHEMA_SENSOR

homeassistant.components.scrape.config_flow.DATA_SCHEMA_SENSOR

Initial value:

=  vol.Schema(
    {
        vol.Optional(CONF_NAME, default=DEFAULT_NAME): TextSelector(),
        **SENSOR_SETUP,
    }
)

Definition at line 256 of file config_flow.py.

OPTIONS_FLOW

dictionary homeassistant.components.scrape.config_flow.OPTIONS_FLOW

Initial value:

=  {
    "init": SchemaFlowMenuStep(
        ["resource", "add_sensor", "select_edit_sensor", "remove_sensor"]
    ),
    "resource": SchemaFlowFormStep(
        DATA_SCHEMA_RESOURCE,
        validate_user_input=validate_rest_setup,
    ),
    "add_sensor": SchemaFlowFormStep(
        DATA_SCHEMA_SENSOR,
        suggested_values=None,
        validate_user_input=validate_sensor_setup,
    ),
    "select_edit_sensor": SchemaFlowFormStep(
        get_select_sensor_schema,
        suggested_values=None,
        validate_user_input=validate_select_sensor,
        next_step="edit_sensor",
    ),
    "edit_sensor": SchemaFlowFormStep(
        DATA_SCHEMA_EDIT_SENSOR,
        suggested_values=get_edit_sensor_suggested_values,
        validate_user_input=validate_sensor_edit,
    ),
    "remove_sensor": SchemaFlowFormStep(
        get_remove_sensor_schema,
        suggested_values=None,
        validate_user_input=validate_remove_sensor,
    ),
}

Definition at line 274 of file config_flow.py.

RESOURCE_SETUP

dictionary homeassistant.components.scrape.config_flow.RESOURCE_SETUP

Initial value:

=  {
    vol.Required(CONF_RESOURCE): TextSelector(
        TextSelectorConfig(type=TextSelectorType.URL)
    ),
    vol.Optional(CONF_METHOD, default=DEFAULT_METHOD): SelectSelector(
        SelectSelectorConfig(options=METHODS, mode=SelectSelectorMode.DROPDOWN)
    ),
    vol.Optional(CONF_PAYLOAD): ObjectSelector(),
    vol.Optional(CONF_AUTHENTICATION): SelectSelector(
        SelectSelectorConfig(
            options=[HTTP_BASIC_AUTHENTICATION, HTTP_DIGEST_AUTHENTICATION],
            mode=SelectSelectorMode.DROPDOWN,
        )
    ),
    vol.Optional(CONF_USERNAME): TextSelector(),
    vol.Optional(CONF_PASSWORD): TextSelector(
        TextSelectorConfig(type=TextSelectorType.PASSWORD)
    ),
    vol.Optional(CONF_HEADERS): ObjectSelector(),
    vol.Optional(CONF_VERIFY_SSL, default=DEFAULT_VERIFY_SSL): BooleanSelector(),
    vol.Optional(CONF_TIMEOUT, default=DEFAULT_TIMEOUT): NumberSelector(
        NumberSelectorConfig(min=0, step=1, mode=NumberSelectorMode.BOX)
    ),
    vol.Optional(CONF_ENCODING, default=DEFAULT_ENCODING): TextSelector(),
}

Definition at line 76 of file config_flow.py.

SENSOR_SETUP

dictionary homeassistant.components.scrape.config_flow.SENSOR_SETUP

Definition at line 102 of file config_flow.py.