Merge branch 'remove-contexts' into main

docs/explanations/conventions.rst

@@ -0,0 +1,4 @@
+..
+    Use the file automatically generated by dae-devops.
+    
+.. include:: ../../.dae-devops/docs/conventions.rst

docs/explanations/docs_structure.rst

@@ -0,0 +1,4 @@
+..
+    Use the file automatically generated by dae-devops.
+    
+.. include:: ../../.dae-devops/docs/docs_structure.rst

docs/explanations/index.rst

@@ -0,0 +1,12 @@
+:orphan:
+
+Explanations
+============
+
+Explanation, or discussions, clarify and illuminate a particular topic. They broaden the documentation's coverage of a topic.
+
+.. toctree::
+
+    docs_structure
+    conventions
+    todo

docs/explanations/todo.rst

@@ -0,0 +1,7 @@
+TODO
+=======================================================================
+
+- Remove matplotlib from imports done by mib2hdfConvert package to decrease load time and debug volume.
+- Make sure we can collect and process mib files which are not in a material subdirectory.
+- Add unit tests for the mib_convert task.
+

docs/how-to/developing.rst

@@ -0,0 +1,4 @@
+..
+    Use the file automatically generated by dae-devops.
+    
+.. include:: ../../.dae-devops/docs/developing.rst

docs/how-to/devops.rst

@@ -0,0 +1,4 @@
+..
+    Use the file automatically generated by dae-devops.
+    
+.. include:: ../../.dae-devops/docs/devops.rst

docs/how-to/documenting.rst

@@ -0,0 +1,4 @@
+..
+    Use the file automatically generated by dae-devops.
+    
+.. include:: ../../.dae-devops/docs/documenting.rst

docs/how-to/index.rst

@@ -0,0 +1,16 @@
+:orphan:
+
+How-to Guides
+=============
+
+How-to guides take the reader through the steps required to solve a real-world problem.
+Practical step-by-step guides for the more experienced user.
+
+.. toctree::
+
+    installing
+    developing
+    testing
+    documenting
+    devops
+

docs/how-to/installing.rst

@@ -0,0 +1,6 @@
+..
+    Use the file automatically generated by dae-devops.
+    
+.. include:: ../../.dae-devops/docs/installing.rst
+
+Since this package is just a library, the command line doesn't do anything else besides print the version.

docs/how-to/testing.rst

@@ -0,0 +1,4 @@
+..
+    Use the file automatically generated by dae-devops.
+    
+.. include:: ../../.dae-devops/docs/testing.rst

docs/index.rst

@@ -1,7 +1,14 @@
+dls-servbase
+=======================================================================
 
+Simple HTTP service for database operations.
+
+Agnostic of type of underlying sql client, provides single-writer access to native database and has a predefined database schema for cookies.
 
 .. toctree::
-    :caption: API-caption
-    :hidden:
+    :titlesonly:
 
-    api/index
+    tutorials/index
+    how-to/index
+    explanations/index
+    reference/index

docs/api/command_line.rst → docs/reference/command_line.rst

@@ -7,3 +7,10 @@ dls-servbase
     :module: dls_servbase_lib.__main__
     :func: get_parser
     :prog: dls-servbase
+
+dls_servbase_cli.main
+-----------------------------------------------------------------------
+.. argparse:: 
+    :module: dls_servbase_cli.main
+    :func: get_parser
+    :prog: python -m dls_servbase_cli.main

docs/tutorials/index.rst

@@ -0,0 +1,11 @@
+:orphan:
+
+Tutorials
+=========
+
+Tutorials are lessons that take the reader by the hand through a series of steps to complete a project of some kind. 
+They are what your project needs in order to show a beginner that they can achieve something with it.
+
+.. toctree::
+
+    tbd

docs/tutorials/tbd.rst

@@ -0,0 +1,4 @@
+TBD Tutorial
+=======================================================================
+
+TBD

src/dls_servbase_api/constants.py

@@ -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/datafaces/aiohttp.py

@@ -9,18 +9,17 @@
 logger = logging.getLogger(__name__)
 
 
-# ------------------------------------------------------------------------------------------
-class Aiohttp:
+class Aiohttp(AiohttpClient):
     """
     Object implementing client side API for talking to the dls_servbase_dataface server.
-    Please see doctopic [A01].
     """
 
     # ----------------------------------------------------------------------------------------
-    def __init__(self, specification=None):
-        self.__specification = specification
+    def __init__(self, specification):
 
-        self.__aiohttp_client = AiohttpClient(
+        # We will get an umbrella specification which must contain an aiohttp_specification within it.
+        AiohttpClient.__init__(
+            self,
             specification["type_specific_tbd"]["aiohttp_specification"],
         )
 
@@ -50,11 +49,6 @@ async def update(self, table_name, record, where, subs=None, why=None):
             "update", table_name, record, where, subs=subs, why=why
         )
 
-    # ----------------------------------------------------------------------------------------
-    async def report_health(self):
-        """"""
-        return await self.__send_protocolj("report_health")
-
     # ----------------------------------------------------------------------------------------
     async def set_cookie(self, cookie_dict):
         """ """
@@ -77,7 +71,7 @@ async def update_cookie(self, row):
     async def __send_protocolj(self, function, *args, **kwargs):
         """"""
 
-        return await self.__aiohttp_client.client_protocolj(
+        return await self.client_protocolj(
             {
                 Keywords.COMMAND: Commands.EXECUTE,
                 Keywords.PAYLOAD: {
@@ -89,14 +83,6 @@ async def __send_protocolj(self, function, *args, **kwargs):
         )
 
     # ----------------------------------------------------------------------------------------
-    async def close_client_session(self):
-        """"""
-
-        if self.__aiohttp_client is not None:
-            await self.__aiohttp_client.close_client_session()
-
-    # ----------------------------------------------------------------------------------------
-    async def client_report_health(self):
+    async def report_health(self):
         """"""
-
-        return await self.__aiohttp_client.client_report_health()
+        return await self.__send_protocolj("report_health")

src/dls_servbase_api/datafaces/context.py

@@ -1,5 +1,8 @@
 import logging
 
+# Base class.
+from dls_utilpack.client_context_base import ClientContextBase
+
 # Things created in the context.
 from dls_servbase_api.datafaces.datafaces import (
     Datafaces,
@@ -9,48 +12,39 @@
 logger = logging.getLogger(__name__)
 
 
-class Context:
+class Context(ClientContextBase):
     """
     Client context for a dls_servbase_dataface object.
     On entering, it creates the object according to the specification (a dict).
     On exiting, it closes client connection.
 
-    The aenter and aexit methods are exposed for use by an enclosing context.
+    The aenter and aexit methods are exposed for use by an enclosing context and the base class.
     """
 
     # ----------------------------------------------------------------------------------------
     def __init__(self, specification):
-        self.__specification = specification
-        self.__dls_servbase_dataface = None
-
-    # ----------------------------------------------------------------------------------------
-    async def __aenter__(self):
-        """ """
-
-        await self.aenter()
-
-    # ----------------------------------------------------------------------------------------
-    async def __aexit__(self, type, value, traceback):
-        """ """
-
-        await self.aexit()
+        ClientContextBase.__init__(self, specification)
 
     # ----------------------------------------------------------------------------------------
     async def aenter(self):
         """ """
 
         # Build the object according to the specification.
-        self.__dls_servbase_dataface = Datafaces().build_object(self.__specification)
+        self.interface = Datafaces().build_object(self.specification)
 
         # If there is more than one dataface, the last one defined will be the default.
-        dls_servbase_datafaces_set_default(self.__dls_servbase_dataface)
+        dls_servbase_datafaces_set_default(self.interface)
+
+        # Open client session to the service or direct connection.
+        await self.interface.open_client_session()
 
     # ----------------------------------------------------------------------------------------
     async def aexit(self):
         """ """
 
-        if self.__dls_servbase_dataface is not None:
-            await self.__dls_servbase_dataface.close_client_session()
+        if self.interface is not None:
+            # Close client session to the service or direct connection.
+            await self.interface.close_client_session()
 
             # Clear the global variable.  Important between pytests.
             dls_servbase_datafaces_set_default(None)

src/dls_servbase_api/guis/aiohttp.py

@@ -0,0 +1,23 @@
+import logging
+
+# Class for an aiohttp client.
+from dls_servbase_api.aiohttp_client import AiohttpClient
+
+logger = logging.getLogger(__name__)
+
+
+# ------------------------------------------------------------------------------------------
+class Aiohttp(AiohttpClient):
+    """
+    Object implementing client side API for talking to the dls_servbase_gui server.
+    Please see doctopic [A01].
+    """
+
+    # ----------------------------------------------------------------------------------------
+    def __init__(self, specification):
+
+        # We will get an umbrella specification which must contain an aiohttp_specification within it.
+        AiohttpClient.__init__(
+            self,
+            specification["type_specific_tbd"]["aiohttp_specification"],
+        )

src/dls_servbase_api/guis/constants.py

@@ -0,0 +1,11 @@
+class Keywords:
+    COMMAND = "dls_servbase_guis::keywords::command"
+    PAYLOAD = "dls_servbase_guis::keywords::payload"
+
+
+class Commands:
+    EXECUTE = "dls_servbase_guis::commands::execute"
+
+
+class Types:
+    AIOHTTP = "dls_servbase_lib.guis.aiohttp"

src/dls_servbase_api/guis/context.py

@@ -0,0 +1,43 @@
+import logging
+
+# Base class.
+from dls_utilpack.client_context_base import ClientContextBase
+
+# Things created in the context.
+from dls_servbase_api.guis.guis import Guis, dls_servbase_guis_set_default
+
+logger = logging.getLogger(__name__)
+
+
+class Context(ClientContextBase):
+    """
+    Client context for a dls_servbase_gui object.
+    On entering, it creates the object according to the specification (a dict).
+    On exiting, it closes client connection.
+
+    The aenter and aexit methods are exposed for use by an enclosing context and the base class.
+    """
+
+    # ----------------------------------------------------------------------------------------
+    def __init__(self, specification):
+        ClientContextBase.__init__(self, specification)
+
+    # ----------------------------------------------------------------------------------------
+    async def aenter(self):
+        """ """
+
+        # Build the object according to the specification.
+        self.interface = Guis().build_object(self.specification)
+
+        # If there is more than one gui, the last one defined will be the default.
+        dls_servbase_guis_set_default(self.interface)
+
+    # ----------------------------------------------------------------------------------------
+    async def aexit(self):
+        """ """
+
+        if self.interface is not None:
+            await self.interface.close_client_session()
+
+            # Clear the global variable.  Important between pytests.
+            dls_servbase_guis_set_default(None)