Switched all docstrings to common format

Author: Joel Collins

docs/api_reference/index.rst

@@ -1,14 +1,5 @@
 API Reference
 =============
 
-LabThing
---------
-
-.. autoclass:: labthings.LabThing
-   :members:
-
-Module
-------
-
 .. automodule:: labthings
    :members:

src/labthings/apispec/apispec.py

@@ -12,13 +12,16 @@
 def rule_to_apispec_path(rule: Rule, view, apispec: APISpec):
     """Generate APISpec Path arguments from a flask Rule and View
 
-    Args:
-        rule (Rule): Flask Rule for path
-        view: View class
-        apispec (APISpec): APISpec object to generate arguments for
+    :param rule: Flask Rule for path
+    :type rule: Rule
+    :param view: View class
+    :param apispec: APISpec object to generate arguments for
+    :type apispec: APISpec
+    :param rule: Rule: 
+    :param apispec: APISpec: 
+    :returns: APISpec `path` funtion argument dictionary
+    :rtype: dict
 
-    Returns:
-        dict: APISpec `path` funtion argument dictionary
     """
 
     params = {

src/labthings/apispec/converter.py

@@ -2,13 +2,26 @@
 
 
 class ExtendedOpenAPIConverter(OpenAPIConverter):
+    """ """
     field_mapping = OpenAPIConverter.field_mapping
 
     def init_attribute_functions(self, *args, **kwargs):
+        """
+
+        :param *args: 
+        :param **kwargs: 
+
+        """
         OpenAPIConverter.init_attribute_functions(self, *args, **kwargs)
         self.attribute_functions.append(self.jsonschema_type_mapping)
 
     def jsonschema_type_mapping(self, field, **kwargs):
+        """
+
+        :param field: 
+        :param **kwargs: 
+
+        """
         ret = {}
         if hasattr(field, "_jsonschema_type_mapping"):
             schema = field._jsonschema_type_mapping()

src/labthings/apispec/plugins.py

@@ -3,4 +3,5 @@
 
 
 class MarshmallowPlugin(_MarshmallowPlugin):
+    """ """
     Converter = ExtendedOpenAPIConverter

src/labthings/apispec/utilities.py

@@ -8,12 +8,15 @@
 
 
 def convert_to_schema_or_json(schema, spec: APISpec):
-    """
-    Ensure that a given schema is either a real Marshmallow schema,
+    """Ensure that a given schema is either a real Marshmallow schema,
     or is a dictionary describing the schema inline.
-
+    
     Marshmallow schemas are left as they are so that the APISpec module
     can add them to the "schemas" list in our APISpec documentation.
+
+    :param schema: 
+    :param spec: APISpec: 
+
     """
     # Don't process Nones
     if not schema:
@@ -35,9 +38,12 @@ def convert_to_schema_or_json(schema, spec: APISpec):
 
 
 def map_to_properties(schema, spec: APISpec):
-    """
-    Recursively convert any dictionary-like map of Marshmallow fields
+    """Recursively convert any dictionary-like map of Marshmallow fields
     into a dictionary describing it's JSON schema
+
+    :param schema: 
+    :param spec: APISpec: 
+
     """
 
     d = {}
@@ -53,7 +59,12 @@ def map_to_properties(schema, spec: APISpec):
 
 
 def field_to_property(field, spec: APISpec):
-    """Convert a single Marshmallow field into a JSON schema of that field"""
+    """Convert a single Marshmallow field into a JSON schema of that field
+
+    :param field: 
+    :param spec: APISpec: 
+
+    """
     marshmallow_plugin = next(
         plugin for plugin in spec.plugins if isinstance(plugin, MarshmallowPlugin)
     )
@@ -68,11 +79,14 @@ def field_to_property(field, spec: APISpec):
 
 
 def schema_to_json(schema, spec: APISpec):
-    """
-    Convert any Marshmallow schema stright to a fully expanded JSON schema.
+    """Convert any Marshmallow schema stright to a fully expanded JSON schema.
     This should not be used when generating APISpec documentation,
     otherwise schemas wont be listed in the "schemas" list.
     This is used, for example, in the Thing Description.
+
+    :param schema: 
+    :param spec: APISpec: 
+
     """
 
     if isinstance(schema, Schema):
@@ -89,10 +103,13 @@ def schema_to_json(schema, spec: APISpec):
 
 
 def recursive_expand_refs(schema_dict, spec: APISpec):
-    """
-    Traverse `schema_dict` expanding out all schema $ref values where possible.
-
+    """Traverse `schema_dict` expanding out all schema $ref values where possible.
+    
     Used when generating Thing Descriptions, so each attribute contains full schemas.
+
+    :param schema_dict: 
+    :param spec: APISpec: 
+
     """
     if isinstance(schema_dict, Mapping):
         if "$ref" in schema_dict:
@@ -106,10 +123,13 @@ def recursive_expand_refs(schema_dict, spec: APISpec):
 
 
 def expand_refs(schema_dict, spec: APISpec):
-    """
-    Expand out all schema $ref values where possible.
-
+    """Expand out all schema $ref values where possible.
+    
     Uses the $ref value to look up a particular schema in spec schemas
+
+    :param schema_dict: 
+    :param spec: APISpec: 
+
     """
     if "$ref" not in schema_dict:
         return schema_dict

src/labthings/default_views/actions.py

@@ -9,27 +9,29 @@
 
 
 class ActionQueue(View):
-    """
-    List of all actions from the session
-    """
+    """List of all actions from the session"""
 
     def get(self):
+        """ """
         return ActionSchema(many=True).dump(current_labthing().actions.threads)
 
 
 class ActionView(View):
-    """
-    Manage a particular action.
-
+    """Manage a particular action.
+    
     GET will safely return the current action progress.
     DELETE will cancel the action, if pending or running.
+
+
     """
 
     def get(self, task_id):
-        """
-        Show status of a session task
-
+        """Show status of a session task
+        
         Includes progress and intermediate data.
+
+        :param task_id: 
+
         """
         task_dict = current_labthing().actions.to_dict()
 
@@ -42,10 +44,13 @@ def get(self, task_id):
 
     @use_args({"timeout": fields.Int(missing=5)})
     def delete(self, args, task_id):
-        """
-        Terminate a running task.
-
+        """Terminate a running task.
+        
         If the task is finished, deletes its entry.
+
+        :param args: 
+        :param task_id: 
+
         """
         timeout = args.get("timeout", 5)
         task_dict = current_labthing().actions.to_dict()

src/labthings/default_views/docs/__init__.py

@@ -16,6 +16,7 @@ class SwaggerUIView(View):
     """Swagger UI documentation"""
 
     def get(self):
+        """ """
         return make_response(render_template("swagger-ui.html"))
 
 

src/labthings/default_views/extensions.py

@@ -10,10 +10,11 @@ class ExtensionList(View):
     tags = ["extensions"]
 
     def get(self):
-        """
-        List enabled extensions.
-
+        """List enabled extensions.
+        
         Returns a list of Extension representations, including basic documentation.
         Describes server methods, web views, and other relevant Lab Things metadata.
+
+
         """
         return ExtensionSchema(many=True).dump(registered_extensions().values() or [])

src/labthings/default_views/root.py

@@ -6,4 +6,5 @@ class RootView(View):
     """W3C Thing Description"""
 
     def get(self):
+        """ """
         return current_labthing().thing_description.to_dict()

src/labthings/default_views/sockets.py

@@ -8,6 +8,11 @@
 
 
 def socket_handler(ws):
+    """
+
+    :param ws: 
+
+    """
     # Create a socket subscriber
     wssub = SocketSubscriber(ws)
     current_labthing().subscribers.add(wssub)
@@ -26,6 +31,11 @@ def socket_handler(ws):
 
 
 def process_socket_message(message: str):
+    """
+
+    :param message: str: 
+
+    """
     if message:
         if message in STATIC_SOCKET_RESPONSES:
             return STATIC_SOCKET_RESPONSES.get(message)