tweaks docs and cleans up

Author: David Erb

${output_directory}/dls_servbase_dataface.sqlite

@@ -1,2 +1,8 @@
 class Keywords:
     ENABLE_COOKIES = "dls_servbase_api::keywords::enable_cookies"
+
+
+# ----------------------------------------------------------------------------------------
+class ClassTypes:
+    AIOHTTP = "dls_servbase_lib.datafaces.aiohttp"
+    NORMSQL = "dls_servbase_lib.datafaces.normsql"

src/dls_servbase_api/constants.py

@@ -10,6 +10,9 @@
 # Basic things.
 from dls_utilpack.thing import Thing
 
+# Class types.
+from dls_servbase_api.constants import ClassTypes
+
 # Dataface protocolj things.
 from dls_servbase_api.datafaces.constants import Commands, Keywords
 
@@ -22,7 +25,7 @@
 
 logger = logging.getLogger(__name__)
 
-thing_type = "dls_servbase_lib.datafaces.aiohttp"
+thing_type = ClassTypes.AIOHTTP
 
 
 # ------------------------------------------------------------------------------------------

src/dls_servbase_lib/datafaces/aiohttp.py

@@ -1,9 +1,13 @@
 # Use standard logging in this module.
 import logging
+from typing import Any, Dict, Type
 
 # Class managing list of things.
 from dls_utilpack.things import Things
 
+# Class types.
+from dls_servbase_api.constants import ClassTypes
+
 # Exceptions.
 from dls_servbase_api.exceptions import NotFound
 
@@ -15,16 +19,34 @@
 
 class Datafaces(Things):
     """
-    List of available dls_servbase_datafaces.
+    Factory for creating instances of dls_servbase_dataface.
+
+    Since it is based on Things, it also can maintain a list of named instances.
+
+    There are currently two class types which implement dls_servbase_dataface:
+        AIOHTTP - This is a networked service with an HTTP protocol.
+        NORMSQL - This is implement directly on a sqlite/mysql/postgres database.
     """
 
     # ----------------------------------------------------------------------------------------
     def __init__(self, name=None):
+        """
+        Args:
+            name (_type_, optional): Name of this list used in debug messages. Defaults to None.
+        """
         Things.__init__(self, name)
 
     # ----------------------------------------------------------------------------------------
-    def build_object(self, specification):
-        """"""
+    def build_object(self, specification: Dict) -> Any:
+        """
+        Build an object whose type is contained in the specification as a string.
+
+        Args:
+            specification (Dict): Specification, must contain at least the keyword "type".
+
+        Returns:
+            The dls_servbase_dataface instance.
+        """
 
         dls_servbase_dataface_class = self.lookup_class(specification["type"])
 
@@ -39,15 +61,20 @@ def build_object(self, specification):
         return dls_servbase_dataface_object
 
     # ----------------------------------------------------------------------------------------
-    def lookup_class(self, class_type):
-        """"""
+    def lookup_class(self, class_type: str) -> Type:
+        """
+        From the given class type string, return a class corresponding to the type.
+
+        Returns:
+            A class which can be instantiated.
+        """
 
-        if class_type == "dls_servbase_lib.datafaces.aiohttp":
+        if class_type == ClassTypes.AIOHTTP:
             from dls_servbase_lib.datafaces.aiohttp import Aiohttp
 
             return Aiohttp
 
-        elif class_type == "dls_servbase_lib.datafaces.normsql":
+        elif class_type == ClassTypes.NORMSQL:
             from dls_servbase_lib.datafaces.normsql import Normsql
 
             return Normsql

src/dls_servbase_lib/datafaces/datafaces.py

@@ -6,12 +6,14 @@
 # Base class for generic things.
 from dls_utilpack.thing import Thing
 
+# Class types.
+from dls_servbase_api.constants import ClassTypes
 from dls_servbase_api.databases.constants import Tablenames
 from dls_servbase_api.databases.database_definition import DatabaseDefinition
 
 logger = logging.getLogger(__name__)
 
-thing_type = "dls_servbase_lib.datafaces.normsql"
+thing_type = ClassTypes.NORMSQL
 
 
 class Normsql(Thing):

src/dls_servbase_lib/datafaces/normsql.py

@@ -9,34 +9,6 @@
 
 # ----------------------------------------------------------------------------------------
 class BaseTester:
-    """
-    This is a base class for simplest tests.
-    """
-
-    def main(self, constants, output_directory):
-        """
-        This is the main program which calls the test using asyncio.
-        """
-
-        multiprocessing.current_process().name = "main"
-
-        failure_message = None
-        try:
-            # Run main test in asyncio event loop.
-            asyncio.run(self._main_coroutine(constants, output_directory))
-
-        except Exception as exception:
-            logger.exception(
-                "unexpected exception in the test method", exc_info=exception
-            )
-            failure_message = str(exception)
-
-        if failure_message is not None:
-            pytest.fail(failure_message)
-
-
-# ----------------------------------------------------------------------------------------
-class BaseTester2:
     """
     Provide asyncio loop and error checking over *Tester classes.
     """

tests/base.py

@@ -5,7 +5,7 @@
 
 from dls_servbase_api.databases.constants import CookieFieldnames, Tablenames
 from dls_servbase_api.databases.database_definition import DatabaseDefinition
-from tests.base_tester import BaseTester2
+from tests.base_tester import BaseTester
 
 logger = logging.getLogger(__name__)
 
@@ -61,7 +61,7 @@ def test(self, constants, logging_setup, output_directory):
 
 
 # ----------------------------------------------------------------------------------------
-class DatabaseTester(BaseTester2):
+class DatabaseTester(BaseTester):
     """
     Test direct SQL access to the database.
     """