Propagate read-only metadata to the Thing Description.

Author: rwb27

src/labthings_fastapi/properties.py

@@ -460,6 +460,8 @@ def property_affordance(
             title=self.title,
             forms=forms,
             description=self.description,
+            readOnly=self.readonly,
+            writeOnly=False,  # write-only properties are not yet supported
         )
         # We merge the data schema with the property affordance (which subclasses the
         # DataSchema model) with the affordance second so its values take priority.

tests/test_property.py

@@ -27,6 +27,7 @@
 from labthings_fastapi.base_descriptor import DescriptorAddedToClassTwiceError
 from labthings_fastapi.exceptions import MissingTypeError, NotConnectedToServerError
 import labthings_fastapi as lt
+from labthings_fastapi.testing import create_thing_without_server
 from .utilities import raises_or_is_caused_by
 
 
@@ -298,3 +299,49 @@ def prop(self) -> bool:
         Example.prop.add_to_fastapi(mocker.Mock(), example)
     with pytest.raises(NotConnectedToServerError):
         Example.prop.property_affordance(example, None)
+
+
+def test_readonly_metadata():
+    """Check read-only data propagates to the Thing Description."""
+
+    class Example(lt.Thing):
+        prop: int = lt.property(default=0)
+        ro_property: int = lt.property(default=0, readonly=True)
+
+        @lt.property
+        def ro_functional_property(self) -> int:
+            """This property should be read-only as there's no setter."""
+            return 42
+
+        @lt.property
+        def ro_functional_property_with_setter(self) -> int:
+            return 42
+
+        @ro_functional_property_with_setter.setter
+        def _set_ro_functional_property_with_setter(self, val: int) -> None:
+            pass
+
+        ro_functional_property_with_setter.readonly = True
+
+        @lt.property
+        def funcprop(self) -> int:
+            return 42
+
+        @funcprop.setter
+        def _set_funcprop(self, val: int) -> None:
+            pass
+
+    example = create_thing_without_server(Example)
+
+    td = example.thing_description()
+
+    # Check read-write properties are not read-only
+    for name in ["prop", "funcprop"]:
+        assert td.properties[name].readOnly is False
+
+    for name in [
+        "ro_property",
+        "ro_functional_property",
+        "ro_functional_property_with_setter",
+    ]:
+        assert td.properties[name].readOnly is True