Added "action" key to action objects

Author: Joel Collins

src/labthings/actions/pool.py

@@ -15,29 +15,29 @@ def __init__(self, maxlen: int = 100):
     def add(self, thread: ActionThread):
         """
 
-        :param thread: ActionThread: 
+        :param thread: ActionThread:
 
         """
         self.threads.append(thread)
 
     def start(self, thread: ActionThread):
         """
 
-        :param thread: ActionThread: 
+        :param thread: ActionThread:
 
         """
         self.add(thread)
         thread.start()
 
-    def spawn(self, function, *args, **kwargs):
+    def spawn(self, action: str, function, *args, **kwargs):
         """
 
-        :param function: 
-        :param *args: 
-        :param **kwargs: 
+        :param function:
+        :param *args:
+        :param **kwargs:
 
         """
-        thread = ActionThread(target=function, args=args, kwargs=kwargs)
+        thread = ActionThread(action, target=function, args=args, kwargs=kwargs)
         self.start(thread)
         return thread
 
@@ -90,7 +90,7 @@ def get(self, task_id):
     def discard_id(self, task_id):
         """
 
-        :param task_id: 
+        :param task_id:
 
         """
         marked_for_discard = set()
@@ -122,7 +122,7 @@ def join(self):
 
 def current_action():
     """Return the ActionThread instance in which the caller is currently running.
-    
+
     If this function is called from outside an ActionThread, it will return None.
 
 
@@ -137,7 +137,7 @@ def current_action():
 
 def update_action_progress(progress: int):
     """Update the progress of the ActionThread in which the caller is currently running.
-    
+
     If this function is called from outside an ActionThread, it will do nothing.
 
     :param progress: int: Action progress, in percent (0-100)
@@ -151,7 +151,7 @@ def update_action_progress(progress: int):
 
 def update_action_data(data: dict):
     """Update the data of the ActionThread in which the caller is currently running.
-    
+
     If this function is called from outside an ActionThread, it will do nothing.
 
     :param data: dict: Action data dictionary

src/labthings/actions/thread.py

@@ -24,6 +24,7 @@ class ActionThread(threading.Thread):
 
     def __init__(
         self,
+        action,
         target=None,
         name=None,
         args=None,
@@ -46,6 +47,9 @@ def __init__(
         args = args or ()
         kwargs = kwargs or {}
 
+        # Action resource corresponding to this action object
+        self.action = action
+
         # A UUID for the ActionThread (not the same as the threading.Thread ident)
         self._ID = uuid.uuid4()  # Task ID
 

src/labthings/labthing.py

@@ -26,7 +26,7 @@
 )
 from .representations import DEFAULT_REPRESENTATIONS
 from .td import ThingDescription
-from .utilities import camel_to_snake, clean_url_string
+from .utilities import snake_to_camel, clean_url_string
 from .views import ActionView, PropertyView, EventView
 
 # from apispec.ext.marshmallow import MarshmallowPlugin
@@ -376,7 +376,7 @@ def add_view(self, view, *urls, endpoint=None, **kwargs):
             labthing.add_view(Foo, '/foo', endpoint="foo")
             labthing.add_view(FooSpecial, '/special/foo', endpoint="foo")
         """
-        endpoint = endpoint or camel_to_snake(view.__name__)
+        endpoint = endpoint or snake_to_camel(view.__name__)
 
         logging.debug(f"{endpoint}: {type(view)} @ {urls}")
 
@@ -410,7 +410,7 @@ def decorator(cls):
         return decorator
 
     def _register_view(self, app, view, *urls, endpoint=None, **kwargs):
-        endpoint = endpoint or camel_to_snake(view.__name__)
+        endpoint = endpoint or view.__name__
         self.endpoints.add(endpoint)
         resource_class_args = kwargs.pop("resource_class_args", ())
         resource_class_kwargs = kwargs.pop("resource_class_kwargs", {})

src/labthings/schema.py

@@ -64,6 +64,7 @@ def dump(self, value):
         """
         return self.serialize(value)
 
+
 class LogRecordSchema(Schema):
     name = fields.String()
     message = fields.String()
@@ -85,6 +86,7 @@ def preprocess(self, data, **kwargs):
 class ActionSchema(Schema):
     """ """
 
+    action = fields.String()
     _ID = fields.String(data_key="id")
     _status = fields.String(
         data_key="status",
@@ -95,7 +97,7 @@ class ActionSchema(Schema):
     _request_time = fields.DateTime(data_key="timeRequested")
     _end_time = fields.DateTime(data_key="timeCompleted")
     log = fields.List(fields.Nested(LogRecordSchema()))
-    
+
     input = fields.Raw()
     output = fields.Raw()
 

src/labthings/td.py

@@ -2,7 +2,7 @@
 
 from .find import current_labthing
 from .json.schemas import rule_to_params, rule_to_path, schema_to_json
-from .utilities import ResourceURL, get_docstring, snake_to_camel
+from .utilities import ResourceURL, get_docstring
 from .views import View
 from .schema import build_action_schema
 
@@ -269,8 +269,7 @@ def property(self, rules: list, view: View):
 
         """
         endpoint = getattr(view, "endpoint", None) or getattr(rules[0], "endpoint")
-        key = snake_to_camel(endpoint)
-        self.properties[key] = self.view_to_thing_property(rules, view)
+        self.properties[endpoint] = self.view_to_thing_property(rules, view)
 
     def action(self, rules: list, view: View):
         """Add a view representing an Action.
@@ -288,8 +287,7 @@ def action(self, rules: list, view: View):
                 but it does not have a POST method."
             )
         endpoint = getattr(view, "endpoint", None) or getattr(rules[0], "endpoint")
-        key = snake_to_camel(endpoint)
-        self.actions[key] = self.view_to_thing_action(rules, view)
+        self.actions[endpoint] = self.view_to_thing_action(rules, view)
 
     def event(self, rules: list, view: View):
         """Add a view representing an event queue.
@@ -299,5 +297,4 @@ def event(self, rules: list, view: View):
 
         """
         endpoint = getattr(view, "endpoint", None) or getattr(rules[0], "endpoint")
-        key = snake_to_camel(endpoint)
-        self.events[key] = self.view_to_thing_event(rules, view)
+        self.events[endpoint] = self.view_to_thing_event(rules, view)

src/labthings/views/__init__.py

@@ -174,7 +174,7 @@ def dispatch_request(self, *args, **kwargs):
             current_labthing().actions if current_labthing() else self._emergency_pool
         )
         # Make a task out of the views `post` method
-        task = pool.spawn(meth, *args, **kwargs)
+        task = pool.spawn(self.endpoint, meth, *args, **kwargs)
         # Optionally override the threads default_stop_timeout
         if self.default_stop_timeout is not None:
             task.default_stop_timeout = self.default_stop_timeout

tests/test_default_views.py

@@ -23,7 +23,7 @@ def test_actions_list(thing_client):
     def task_func():
         pass
 
-    task_obj = current_labthing().actions.spawn(task_func)
+    task_obj = current_labthing().actions.spawn("task_func", task_func)
 
     with thing_client as c:
         response = c.get("/actions").json
@@ -35,7 +35,7 @@ def test_action_representation(thing_client):
     def task_func():
         pass
 
-    task_obj = current_labthing().actions.spawn(task_func)
+    task_obj = current_labthing().actions.spawn("task_func", task_func)
     task_id = str(task_obj.id)
 
     with thing_client as c:
@@ -53,7 +53,7 @@ def task_func():
         while not current_action().stopping:
             time.sleep(0)
 
-    task_obj = current_labthing().actions.spawn(task_func)
+    task_obj = current_labthing().actions.spawn("task_func", task_func)
     task_id = str(task_obj.id)
 
     # Wait for task to start
@@ -73,7 +73,7 @@ def task_func():
         while True:
             time.sleep(0)
 
-    task_obj = current_labthing().actions.spawn(task_func)
+    task_obj = current_labthing().actions.spawn("task_func", task_func)
     task_id = str(task_obj.id)
 
     # Wait for task to start

tests/test_tasks_pool.py

@@ -7,7 +7,7 @@ def test_spawn_without_context(task_pool):
     def task_func():
         pass
 
-    task_obj = task_pool.spawn(task_func)
+    task_obj = task_pool.spawn("task_func", task_func)
     assert isinstance(task_obj, threading.Thread)
 
 
@@ -16,15 +16,15 @@ def task_func():
         pass
 
     with app_ctx.test_request_context():
-        task_obj = task_pool.spawn(task_func)
+        task_obj = task_pool.spawn("task_func", task_func)
         assert isinstance(task_obj, threading.Thread)
 
 
 def test_update_task_data(task_pool):
     def task_func():
         actions.update_action_data({"key": "value"})
 
-    task_obj = task_pool.spawn(task_func)
+    task_obj = task_pool.spawn("task_func", task_func)
     task_obj.join()
     assert task_obj.data == {"key": "value"}
 
@@ -38,7 +38,7 @@ def test_update_task_progress(task_pool):
     def task_func():
         actions.update_action_progress(100)
 
-    task_obj = task_pool.spawn(task_func)
+    task_obj = task_pool.spawn("task_func", task_func)
     task_obj.join()
     assert task_obj.progress == 100
 
@@ -65,7 +65,7 @@ def test_discard_id(task_pool):
     def task_func():
         pass
 
-    task_obj = task_pool.spawn(task_func)
+    task_obj = task_pool.spawn("task_func", task_func)
     assert str(task_obj.id) in task_pool.to_dict()
     task_obj.join()
 
@@ -80,7 +80,7 @@ def task_func():
         pass
 
     # Make sure at least 1 actions is around
-    task_pool.spawn(task_func)
+    task_pool.spawn("task_func", task_func)
 
     # Wait for all actions to finish
     task_pool.join()