Removed current_task_stopped function

Author: Joel Collins

examples/simple_thing.py

@@ -1,19 +1,12 @@
 #!/usr/bin/env python
-from labthings import monkey
-
-monkey.patch_all()
-
 import random
 import math
 import time
 import logging
 import atexit
 
-from labthings.server.quick import create_app
-from labthings.server import semantics
-from labthings.server.view import ActionView, PropertyView
-from labthings.server.find import find_component
-from labthings.server import fields
+from labthings.server.quick import create_app, semantics, find_component, fields
+from labthings.views import ActionView, PropertyView
 
 
 """

src/labthings/__init__.py

@@ -21,7 +21,6 @@
 
 # Task management functions
 from .tasks import current_task
-from .tasks import current_task_stopped
 from .tasks import update_task_progress
 from .tasks import update_task_data
 from .tasks import TaskKillException

src/labthings/labthing.py

@@ -378,14 +378,14 @@ def add_view(self, view, *urls, endpoint=None, **kwargs):
 
         :param view: View class
         :type resource: class:`labthings.views.View`
-        :param *urls: one or more url routes to match for the resource, standard
+        :param urls: one or more url routes to match for the resource, standard
                     flask routing rules apply.  Any url variables will be
                     passed to the resource method as args.
-        :type *urls: str
+        :type urls: str
         :param endpoint: endpoint name (defaults to :meth:`Resource.__name__`
             Can be used to reference this route in :class:`fields.Url` fields
         :type endpoint: str
-        :param **kwargs: kwargs to be forwarded to the constructor
+        :param kwargs: kwargs to be forwarded to the constructor
             of the view.
 
         Additional keyword arguments not specified above will be passed as-is
@@ -407,11 +407,20 @@ def add_view(self, view, *urls, endpoint=None, **kwargs):
         self.views.append((view, urls, endpoint, kwargs))
 
     def view(self, *urls, **kwargs):
-        """
+        """Wraps a :class:`labthings.View` class, adding it to the LabThing. 
+        Parameters are the same as :meth:`~labthings.LabThing.add_view`.
+
+        Example::
+
+            app = Flask(__name__)
+            labthing = labthings.LabThing(app)
 
-        :param *urls: 
-        :param **kwargs: 
+            @labthing.view('/properties/my_property')
+            class Foo(labthings.views.PropertyView):
+                schema = labthings.fields.String()
 
+                def get(self):
+                    return 'Hello, World!'
         """
 
         def decorator(cls):
@@ -494,7 +503,7 @@ def url_for(self, view, **values):
         Works like :func:`flask.url_for`.
 
         :param view: 
-        :param **values: 
+        :param values: 
 
         """
         if isinstance(view, str):
@@ -532,7 +541,7 @@ def build_property(
         :param property_object: object: 
         :param property_name: str: 
         :param urls: list:  (Default value = None)
-        :param **kwargs: 
+        :param kwargs: 
 
         """
         if urls is None:
@@ -547,7 +556,7 @@ def build_action(
         :param action_object: object: 
         :param action_name: str: 
         :param urls: list:  (Default value = None)
-        :param **kwargs: 
+        :param kwargs: 
 
         """
         if urls is None:

src/labthings/tasks/__init__.py

@@ -1,6 +1,5 @@
 __all__ = [
     "current_task",
-    "current_task_stopped",
     "update_task_progress",
     "update_task_data",
     "TaskKillException",
@@ -9,7 +8,6 @@
 
 from .pool import (
     current_task,
-    current_task_stopped,
     update_task_progress,
     update_task_data,
 )

src/labthings/tasks/pool.py

@@ -8,6 +8,7 @@
 # TODO: Handle discarding old tasks. Action views now use deques
 class Pool:
     """ """
+
     def __init__(self):
         self.threads = set()
 
@@ -131,21 +132,6 @@ def current_task():
     return current_task_thread
 
 
-def current_task_stopped():
-    """Return True if the current task is stoppable and flagged to be stopped
-    
-    If this function is called from outside a Task thread, it will return None.
-
-
-    :returns: bool -- Is the current task scheduled to be stopped
-
-    """
-    current_task_thread = threading.current_thread()
-    if not isinstance(current_task_thread, TaskThread):
-        return None
-    return current_task_thread.stopped
-
-
 def update_task_progress(progress: int):
     """Update the progress of the Task in which the caller is currently running.