Update PropertyDescriptor to ThingProperty in all examples and tests

Author: julianstirling

docs/source/quickstart/counter.py

@@ -1,7 +1,7 @@
 import time
 from labthings_fastapi.thing import Thing
 from labthings_fastapi.decorators import thing_action
-from labthings_fastapi.descriptors import PropertyDescriptor
+from labthings_fastapi.descriptors import ThingProperty
 
 
 class TestThing(Thing):
@@ -24,7 +24,7 @@ def slowly_increase_counter(self) -> None:
             time.sleep(1)
             self.increment_counter()
 
-    counter = PropertyDescriptor(
+    counter = ThingProperty(
         model=int, initial_value=0, readonly=True, description="A pointless counter"
     )
 

examples/counter.py

@@ -1,7 +1,7 @@
 import time
 from labthings_fastapi.thing import Thing
 from labthings_fastapi.decorators import thing_action
-from labthings_fastapi.descriptors import PropertyDescriptor
+from labthings_fastapi.descriptors import ThingProperty
 from labthings_fastapi.server import ThingServer
 
 
@@ -25,7 +25,7 @@ def slowly_increase_counter(self) -> None:
             time.sleep(1)
             self.increment_counter()
 
-    counter = PropertyDescriptor(
+    counter = ThingProperty(
         model=int, initial_value=0, readonly=True, description="A pointless counter"
     )
 

examples/demo_thing_server.py

@@ -4,7 +4,7 @@
 from labthings_fastapi.thing import Thing
 from labthings_fastapi.decorators import thing_action
 from labthings_fastapi.server import ThingServer
-from labthings_fastapi.descriptors import PropertyDescriptor
+from labthings_fastapi.descriptors import ThingProperty
 from pydantic import Field
 from fastapi.responses import HTMLResponse
 
@@ -60,11 +60,11 @@ def slowly_increase_counter(self):
             time.sleep(1)
             self.increment_counter()
 
-    counter = PropertyDescriptor(
+    counter = ThingProperty(
         model=int, initial_value=0, readonly=True, description="A pointless counter"
     )
 
-    foo = PropertyDescriptor(
+    foo = ThingProperty(
         model=str,
         initial_value="Example",
         description="A pointless string for demo purposes.",

examples/opencv_camera_server.py

@@ -3,7 +3,7 @@
 
 from fastapi import FastAPI
 from fastapi.responses import HTMLResponse, StreamingResponse
-from labthings_fastapi.descriptors.property import PropertyDescriptor
+from labthings_fastapi.descriptors.property import ThingProperty
 from labthings_fastapi.thing import Thing
 from labthings_fastapi.decorators import thing_action, thing_property
 from labthings_fastapi.server import ThingServer
@@ -279,7 +279,7 @@ def exposure(self, value):
         with self._cap_lock:
             self._cap.set(cv.CAP_PROP_EXPOSURE, value)
 
-    last_frame_index = PropertyDescriptor(int, initial_value=-1)
+    last_frame_index = ThingProperty(int, initial_value=-1)
 
     mjpeg_stream = MJPEGStreamDescriptor(ringbuffer_size=10)
 

examples/picamera2_camera_server.py

@@ -4,7 +4,7 @@
 
 from pydantic import BaseModel, BeforeValidator
 
-from labthings_fastapi.descriptors.property import PropertyDescriptor
+from labthings_fastapi.descriptors.property import ThingProperty
 from labthings_fastapi.thing import Thing
 from labthings_fastapi.decorators import thing_action, thing_property
 from labthings_fastapi.server import ThingServer
@@ -24,14 +24,12 @@
 logging.basicConfig(level=logging.INFO)
 
 
-class PicameraControl(PropertyDescriptor):
+class PicameraControl(ThingProperty):
     def __init__(
         self, control_name: str, model: type = float, description: Optional[str] = None
     ):
         """A property descriptor controlling a picamera control"""
-        PropertyDescriptor.__init__(
-            self, model, observable=False, description=description
-        )
+        ThingProperty.__init__(self, model, observable=False, description=description)
         self.control_name = control_name
         self._getter
 
@@ -84,20 +82,20 @@ def __init__(self, device_index: int = 0):
         self.device_index = device_index
         self.camera_configs: dict[str, dict] = {}
 
-    stream_resolution = PropertyDescriptor(
+    stream_resolution = ThingProperty(
         tuple[int, int],
         initial_value=(1640, 1232),
         description="Resolution to use for the MJPEG stream",
     )
-    image_resolution = PropertyDescriptor(
+    image_resolution = ThingProperty(
         tuple[int, int],
         initial_value=(3280, 2464),
         description="Resolution to use for still images (by default)",
     )
-    mjpeg_bitrate = PropertyDescriptor(
+    mjpeg_bitrate = ThingProperty(
         int, initial_value=0, description="Bitrate for MJPEG stream (best left at 0)"
     )
-    stream_active = PropertyDescriptor(
+    stream_active = ThingProperty(
         bool,
         initial_value=False,
         description="Whether the MJPEG stream is active",
@@ -116,7 +114,7 @@ def __init__(self, device_index: int = 0):
     exposure_time = PicameraControl(
         "ExposureTime", int, description="The exposure time in microseconds"
     )
-    sensor_modes = PropertyDescriptor(list[SensorMode], readonly=True)
+    sensor_modes = ThingProperty(list[SensorMode], readonly=True)
 
     def __enter__(self):
         self._picamera = picamera2.Picamera2(camera_num=self.device_index)
@@ -219,7 +217,7 @@ def exposure(self) -> float:
     def exposure(self, value):
         raise NotImplementedError()
 
-    last_frame_index = PropertyDescriptor(int, initial_value=-1)
+    last_frame_index = ThingProperty(int, initial_value=-1)
 
     mjpeg_stream = MJPEGStreamDescriptor(ringbuffer_size=10)
 

src/labthings_fastapi/descriptors/property.py

@@ -232,6 +232,7 @@ class ThingSetting(ThingProperty):
 
     The setting otherwise acts just like a normal variable.
     """
+
     @property
     def persistent(self):
         return True

tests/test_action_cancel.py

@@ -8,12 +8,12 @@
 from temp_client import poll_task, task_href
 from labthings_fastapi.thing import Thing
 from labthings_fastapi.decorators import thing_action
-from labthings_fastapi.descriptors import PropertyDescriptor
+from labthings_fastapi.descriptors import ThingProperty
 from labthings_fastapi.dependencies.invocation import CancelHook
 
 
 class ThingOne(Thing):
-    counter = PropertyDescriptor(int, 0, observable=False)
+    counter = ThingProperty(int, 0, observable=False)
 
     @thing_action
     def count_slowly(self, cancel: CancelHook, n: int = 10):

tests/test_action_manager.py

@@ -6,7 +6,7 @@
 import time
 from labthings_fastapi.thing import Thing
 from labthings_fastapi.decorators import thing_action
-from labthings_fastapi.descriptors import PropertyDescriptor
+from labthings_fastapi.descriptors import ThingProperty
 
 
 class TestThing(Thing):
@@ -15,7 +15,7 @@ def increment_counter(self):
         """Increment the counter"""
         self.counter += 1
 
-    counter = PropertyDescriptor(
+    counter = ThingProperty(
         model=int, initial_value=0, readonly=True, description="A pointless counter"
     )
 

tests/test_properties.py

@@ -1,4 +1,4 @@
-from labthings_fastapi.descriptors import PropertyDescriptor
+from labthings_fastapi.descriptors import ThingProperty
 from labthings_fastapi.decorators import thing_property, thing_action
 from labthings_fastapi.thing import Thing
 from fastapi.testclient import TestClient
@@ -9,8 +9,8 @@
 
 
 class TestThing(Thing):
-    boolprop = PropertyDescriptor(bool, False, description="A boolean property")
-    stringprop = PropertyDescriptor(str, "foo", description="A string property")
+    boolprop = ThingProperty(bool, False, description="A boolean property")
+    stringprop = ThingProperty(str, "foo", description="A string property")
 
     _undoc = None
 
@@ -44,7 +44,7 @@ def toggle_boolprop_from_thread(self):
 
 
 def test_instantiation_with_type():
-    prop = PropertyDescriptor(bool, False)
+    prop = ThingProperty(bool, False)
     assert issubclass(prop.model, BaseModel)
 
 
@@ -53,7 +53,7 @@ class MyModel(BaseModel):
         a: int = 1
         b: float = 2.0
 
-    prop = PropertyDescriptor(MyModel, MyModel())
+    prop = ThingProperty(MyModel, MyModel())
     assert prop.model is MyModel
 
 
@@ -65,7 +65,7 @@ def test_property_get_and_set():
         assert after_value.json() == test_str
 
 
-def test_propertydescriptor():
+def test_ThingProperty():
     with TestClient(server.app) as client:
         r = client.get("/thing/boolprop")
         assert r.json() is False

tests/test_thing_lifecycle.py

@@ -1,11 +1,11 @@
-from labthings_fastapi.descriptors import PropertyDescriptor
+from labthings_fastapi.descriptors import ThingProperty
 from labthings_fastapi.thing import Thing
 from fastapi.testclient import TestClient
 from labthings_fastapi.server import ThingServer
 
 
 class TestThing(Thing):
-    alive = PropertyDescriptor(bool, False, description="Is the thing alive?")
+    alive = ThingProperty(bool, False, description="Is the thing alive?")
 
     def __enter__(self):
         print("setting up TestThing from __enter__")