feat: support integer, boolean, and string button types (#253)

Author: adubovik

aidial_sdk/chat_completion/form.py

@@ -21,6 +21,9 @@
 _T = TypeVar("_T")
 
 
+_SUPPORTED_BUTTON_TYPES = ["number", "integer", "boolean", "string"]
+
+
 @dataclass
 class Button(Generic[_T]):
     const: _T
@@ -118,17 +121,11 @@ def _handle_buttons_extension(schema: Dict[str, Any]) -> None:
             prop["dial:widget"] = "buttons"
             prop["oneOf"] = button_schemas
 
-            # NOTE: The meta schema of the DIAL forms only supports
-            # 'number' type, so we convert 'integer' to 'number'.
-            # Could be removed once this restriction is lifted.
-            if prop["type"] == "integer":
-                prop["type"] = "number"
-
-            # NOTE: The meta schema of the DIAL forms only supports 'number' type.
-            # Could be removed once this restriction is lifted.
-            if prop["type"] != "number":
+            if prop["type"] not in _SUPPORTED_BUTTON_TYPES:
+                ts = ", ".join(f"{ty!r}" for ty in _SUPPORTED_BUTTON_TYPES)
                 raise ValueError(
-                    f"Button value must be a number. However, field {schema['title']}.{prop_name} has type {prop['type']!r}."
+                    f"Button value must be a one of the following types: {ts}. "
+                    f"However, field {schema['title']}.{prop_name} has type {prop['type']!r}."
                 )
 
 

tests/examples/test_tic_tac_toe.py

@@ -19,7 +19,7 @@ def test_ttt_configuration():
                 "title": "Player",
                 "description": "Select tic-tac-toe player",
                 "enum": [1, 2],
-                "type": "number",
+                "type": "integer",
                 "dial:widget": "buttons",
                 "oneOf": [
                     {

tests/test_form.py

@@ -76,7 +76,7 @@ def test_configuration_optional_button_schema():
         "properties": {
             "int_button_field": {
                 "title": "Int Button Field",
-                "type": "number",
+                "type": "integer",
                 "dial:widget": "buttons",
                 "oneOf": [
                     {
@@ -134,7 +134,7 @@ def test_configuration_one_button_schema():
             "int_button_field": {
                 "title": "Integer Button field",
                 "description": "Pick a button",
-                "type": "number",
+                "type": "integer",
                 "dial:widget": "buttons",
                 "oneOf": [
                     {
@@ -186,6 +186,40 @@ def test_configuration_parsing_success():
     )
 
 
+def test_configuration_string_type_parsing_success():
+    class _Conf(BaseModel, metaclass=FormMetaclass):
+        button_field: str = Field(
+            buttons=[
+                Button(const="10", title="Title1"),
+                Button(const="20", title="Title2"),
+            ],
+        )
+
+    assert _Conf.parse_obj({"button_field": "10"}) == _Conf(button_field="10")
+
+
+def test_configuration_string_type_parsing_fail():
+    class _Conf(BaseModel, metaclass=FormMetaclass):
+        button_field: str = Field(
+            buttons=[
+                Button(const="10", title="Title1"),
+                Button(const="20", title="Title2"),
+            ],
+        )
+
+    with pytest.raises(ValidationError) as e:
+        _Conf.parse_obj({"button_field": "30"})
+
+    assert e.value.errors() == [
+        {
+            "ctx": {"given": "30", "permitted": ("10", "20")},
+            "loc": ("button_field",),
+            "msg": "unexpected value; permitted: '10', '20'",
+            "type": "value_error.const",
+        }
+    ]
+
+
 def test_configuration_parsing_one_button_fail():
     conf = {
         "int_field": 10,
@@ -332,7 +366,7 @@ class Conf(BaseModel):
                     },
                 ],
                 "title": "Buttons Field",
-                "type": "number",
+                "type": "integer",
             },
             "int_field": {
                 "title": "Int Field",
@@ -397,7 +431,7 @@ class Conf(BaseModel):
                     },
                 ],
                 "title": "Buttons Field",
-                "type": "number",
+                "type": "integer",
             },
             "int_field": {
                 "title": "Int Field",
@@ -488,10 +522,12 @@ class Conf(BaseModel):
     assert parsed_conf.buttons_field == 10
 
 
-def test_dynamic_configuration_two_buttons():
+def test_dynamic_configuration_four_buttons():
     class Conf(BaseModel):
         int_button_field: int
         float_button_field: float
+        bool_button_field: bool
+        str_button_field: str
 
     conf = form(
         chat_message_input_disabled=True,
@@ -509,6 +545,20 @@ class Conf(BaseModel):
                 Button(const=40.1, title="Title4"),
             ],
         ),
+        bool_button_field=Field(
+            description="Switch",
+            buttons=[
+                Button(const=True, title="On"),
+                Button(const=False, title="Off"),
+            ],
+        ),
+        str_button_field=Field(
+            description="Flavour",
+            buttons=[
+                Button(const="vanilla", title="Vanilla flavour"),
+                Button(const="chocolate", title="Chocolate flavour"),
+            ],
+        ),
     )(Conf)
 
     actual_schema = conf.schema()
@@ -541,7 +591,7 @@ class Conf(BaseModel):
                     },
                 ],
                 "title": "Int Button Field",
-                "type": "number",
+                "type": "integer",
             },
             "float_button_field": {
                 "dial:widget": "buttons",
@@ -569,35 +619,70 @@ class Conf(BaseModel):
                 "title": "Float Button Field",
                 "type": "number",
             },
+            "bool_button_field": {
+                "dial:widget": "buttons",
+                "description": "Switch",
+                "oneOf": [
+                    {
+                        "const": True,
+                        "dial:widgetOptions": {
+                            "confirmationMessage": None,
+                            "populateText": None,
+                            "submit": False,
+                        },
+                        "title": "On",
+                    },
+                    {
+                        "const": False,
+                        "dial:widgetOptions": {
+                            "confirmationMessage": None,
+                            "populateText": None,
+                            "submit": False,
+                        },
+                        "title": "Off",
+                    },
+                ],
+                "title": "Bool Button Field",
+                "type": "boolean",
+            },
+            "str_button_field": {
+                "dial:widget": "buttons",
+                "description": "Flavour",
+                "oneOf": [
+                    {
+                        "const": "vanilla",
+                        "dial:widgetOptions": {
+                            "confirmationMessage": None,
+                            "populateText": None,
+                            "submit": False,
+                        },
+                        "title": "Vanilla flavour",
+                    },
+                    {
+                        "const": "chocolate",
+                        "dial:widgetOptions": {
+                            "confirmationMessage": None,
+                            "populateText": None,
+                            "submit": False,
+                        },
+                        "title": "Chocolate flavour",
+                    },
+                ],
+                "title": "Str Button Field",
+                "type": "string",
+            },
         },
         "required": [
             "int_button_field",
             "float_button_field",
+            "bool_button_field",
+            "str_button_field",
         ],
         "title": "_Conf",
         "type": "object",
     }
 
 
-def test_configuration_invalid_button_type():
-    with pytest.raises(ValueError) as e:
-
-        class _Conf(BaseModel, metaclass=FormMetaclass):
-            button_field: str = Field(
-                buttons=[
-                    Button(const="10", title="Title1"),
-                    Button(const="20", title="Title2"),
-                ],
-            )
-
-        _Conf.schema()
-
-    assert (
-        str(e.value)
-        == "Button value must be a number. However, field _Conf.button_field has type 'string'."
-    )
-
-
 def test_configuration_missing_buttons():
     with pytest.raises(ValueError) as e: