Use PUT for writing properties in built views

Author: jtc42

src/labthings/server/view/builder.py

@@ -19,21 +19,22 @@ def property_of(
     name: str = None,
     readonly=False,
     description=None,
+    _legacy=False,  # Old structure where POST is used to write property
 ):
 
     # Create a class name
     if not name:
         name = type(property_object).__name__ + f"_{property_name}"
 
     # Create inner functions
-    def _get(self):
+    def _read(self):
         return getattr(property_object, property_name)
 
-    def _post(self, args):
+    def _write(self, args):
         setattr(property_object, property_name, args)
         return getattr(property_object, property_name)
 
-    def _put(self, args):
+    def _update(self, args):
         getattr(property_object, property_name).update(args)
         return getattr(property_object, property_name)
 
@@ -44,17 +45,23 @@ def _put(self, args):
         {
             "property_object": property_object,
             "property_name": property_name,
-            "get": _get,
+            "get": _read,
         },
     )
 
     # Override read-write capabilities
     if not readonly:
-        generated_class.post = _post
-        generated_class.methods.add("POST")
-        # Enable PUT requests for dictionaries
+        # Enable update PUT requests for dictionaries
         if type(getattr(property_object, property_name)) is dict:
-            generated_class.put = _put
+            generated_class.put = _update
+            generated_class.methods.add("PUT")
+        # If legacy mode, use POST to write property
+        elif _legacy:
+            generated_class.post = _write
+            generated_class.methods.add("POST")
+        # Normally, use PUT to write property
+        else:
+            generated_class.put = _write
             generated_class.methods.add("PUT")
 
     # Add decorators for arguments etc

tests/test_server_view_builder.py

@@ -9,7 +9,7 @@ def test_property_of(app, client):
 
     with client as c:
         assert c.get("/").data == b'"propertyValue"\n'
-        assert c.post("/", data=b"newPropertyValue").data == b'"newPropertyValue"\n'
+        assert c.put("/", data=b"newPropertyValue").data == b'"newPropertyValue"\n'
         assert c.get("/").data == b'"newPropertyValue"\n'
 
 
@@ -37,9 +37,6 @@ def test_property_of_dict(app, client):
             "property_name": "newPropertyValue",
             "property_name_2": "propertyValue2",
         }
-        assert c.post("/", json={"property_name": "newPropertyValue"}).json == {
-            "property_name": "newPropertyValue"
-        }
 
 
 def test_property_of_readonly():