yera.runtime.models.input_data

Serialized values submitted in response to input requests.

Symbols

class ButtonsInputData — A submitted button selection.
class DatePickerInputData — A submitted calendar date.
class FormInputData — A submitted form object, before validation against its struct.
class SerializedInputData — A serialized value submitted for an input request.
class SliderInputData — A submitted numeric slider value.
class TextInputData — A submitted free-text value.
class TreeSelectorInputData — A submitted collection of tree leaf values.

ButtonsInputData

A submitted button selection.

Fields

payload
type: str (required)
data_type
type: Literal['buttons'] = 'buttons'

DatePickerInputData

A submitted calendar date.

Fields

payload
type: str (required)
data_type
type: Literal['date_picker'] = 'date_picker'

FormInputData

A submitted form object, before validation against its struct.

Fields

payload
type: str (required)
data_type
type: Literal['form'] = 'form'
cancelled
type: bool = False

SerializedInputData

Inherits: BaseModel

A serialized value submitted for an input request.

Fields

payload
type: str (required)

Methods

deserialise — Deserialize the payload into its declared Python value type.

SerializedInputData.deserialise

deserialise() → object

Deserialize the payload into its declared Python value type.

Returns

type: object

The Python value represented by the serialized payload.

Raises

ValueError

If the payload does not represent the declared type.

SliderInputData

A submitted numeric slider value.

Fields

payload
type: str (required)
data_type
type: Literal['slider'] = 'slider'

TextInputData

A submitted free-text value.

Fields

payload
type: str (required)
data_type
type: Literal['text'] = 'text'

TreeSelectorInputData

A submitted collection of tree leaf values.

Fields

payload
type: str (required)
data_type
type: Literal['tree_selector'] = 'tree_selector'
cancelled
type: bool = False