Simplify for non-ISIS use

Author: Monarda

p4p_ext/server.py

@@ -0,0 +1,52 @@
+from abc import ABC, abstractmethod
+
+from p4p.server.raw import SharedPV
+
+from p4p_ext.pvrecipe import BasePVRecipe
+
+
+class BaseSimpleServer(ABC):
+    """
+    Creates PVs and manages their lifetimes
+    """
+
+    @abstractmethod
+    def __init__(self, prefix: str = "") -> None:
+        """
+        Initialize the ISIS Server instance.
+
+        :param prefix: The prefix to be added to the PVs (Process Variables) of the server e.g. DEV: Defaults to "".
+        """
+        # the prefix determines the prefix of the PVs to be added to the server e.g. DEV:
+        self.prefix: str = prefix  #: The prefix to be prepended to the PVs generated by this server.
+        self._pvs: dict[str, SharedPV] = {}
+
+    @abstractmethod
+    def add_pv(self, pv_name: str, pv_recipe: BasePVRecipe) -> SharedPV:
+        """
+        Add a PV to the server
+
+        :param pv_name: The name of the PV to be added.
+        :param pv_recipe: The recipe with instructions for creating the PV.
+        :return: The created PV.
+        """
+
+    @abstractmethod
+    def remove_pv(self, pv_name: str) -> None:
+        """
+        Remove a PV from the server
+
+        :param pv_name: The name of the PV to be removed.
+        :raises KeyError: If the PV is not found in the list managed by the server.
+        """
+
+    @property
+    def pvlist(self) -> list[str]:
+        """The PVs managed by the server"""
+        return list(self._pvs.keys())
+
+    def __getitem__(self, pv_name: str) -> SharedPV | None:
+        """Return one of the PVs managed by the server given its name"""
+        if not pv_name.startswith(self.prefix):
+            pv_name = self.prefix + pv_name
+        return self._pvs.get(pv_name)

p4p_ext/thread/server.py

@@ -1,47 +1,36 @@
 """
-ISISServer is used to create PVs and manage their lifetimes
+SimpleServer is used to create PVs and manage their lifetimes
 """
 
 from __future__ import annotations
 
 import logging
 
-from p4p import Value
 from p4p.client.thread import Context
 from p4p.server import Server, StaticProvider
 from p4p.server.thread import SharedPV
 
 from p4p_ext.pvrecipe import BasePVRecipe
+from p4p_ext.server import BaseSimpleServer
 
 logger = logging.getLogger(__name__)
 
 
-class SimpleServer:
+class SimpleServer(BaseSimpleServer):
     """
     Creates PVs and manages their lifetimes
-
-
     """
 
-    def __init__(self, ioc_name: str, section: str, description: str, prefix="") -> None:
+    def __init__(self, prefix: str = "") -> None:
         """
         Initialize the ISIS Server instance.
 
-        :param ioc_name: A PV naming convention compatible name for the IOC (Input/Output Controller).
-        :param section:  The section or group responsible for the server e.g. Controls Software Applications, Diagnostics etc.
-        :param description: A detailed description of the server and what it does.
         :param prefix: The prefix to be added to the PVs (Process Variables) of the server e.g. DEV: Defaults to "".
         """
-        # provide information for IOC stats PVs
-        self.ioc_name: str = ioc_name  #: The name of the IOC (Input/Output Controller).
-        self.section: str = section  #: The section or group responsible for this server, e.g. Synch RF
-        self.description: str = description  #: A description of the purpose of this server.
-        # the prefix determines the prefix of the PVs to be added to the server e.g. DEV:
-        self.prefix: str = prefix  #: The prefix to be prepended to the PVs generated by this server.
+        super().__init__(prefix)
 
         self._provider = StaticProvider()
         self._server: Server | None = None
-        self._pvs: dict[str, SharedPV] = {}
 
         self._running = False
 
@@ -122,35 +111,3 @@ def remove_pv(self, pv_name: str) -> None:
             # from the live system
             self._provider.remove(pv_name)
         logger.debug("Removed %s from server", pv_name)
-
-    @property
-    def pvlist(self) -> list[str]:
-        """The PVs managed by the server"""
-        return list(self._pvs.keys())
-
-    def __getitem__(self, pv_name: str) -> SharedPV | None:
-        """Return one of the PVs managed by the server given its name"""
-        if not pv_name.startswith(self.prefix):
-            pv_name = self.prefix + pv_name
-        return self._pvs.get(pv_name)
-
-    def get_pv_value(self, pv_name: str) -> Value:
-        """
-        Get the value of a PV using SharedPV.current() if the PV is on this server
-        or Context.get() if it is not.
-        """
-        if pv_name in self.pvlist:
-            logger.debug("Getting value using SharedPV for pv %s", pv_name)
-            shared_pv = self._pvs.get(pv_name, None)
-            if shared_pv:
-                return shared_pv.current()
-
-        logger.debug("Doing Context.get() for pv %s", pv_name)
-        return self._ctxt.get(pv_name)  # type: ignore
-
-    def put_pv_value(self, pv_name: str, value: Value):
-        """
-        Put the value to a PV using the server Context member self._ctxt
-        """
-        logger.debug("Trying putting value %r to pv %s", value, pv_name)
-        self._ctxt.put(pv_name, value)

tests/unit/thread/test_servers.py

@@ -12,14 +12,8 @@
 
 def test_server_instantiation():
     server = SimpleServer(
-        ioc_name="TESTIOC",
-        section="controls testing",
-        description="server for unit tests",
         prefix="DEV:",
     )
-    assert server.ioc_name == "TESTIOC"
-    assert server.section == "controls testing"
-    assert server.description == "server for unit tests"
     assert server.prefix == "DEV:"
 
     # before we explicitly call `start()`, the server shouldn't exist
@@ -35,9 +29,6 @@ def test_server_instantiation():
 )
 def test_server_retrieve_pvs(mock_recipe, pv_name):
     server = SimpleServer(
-        ioc_name="TESTIOC",
-        section="controls testing",
-        description="server for unit tests",
         prefix="DEV:",
     )
     server.add_pv(pv_name, mock_recipe)
@@ -52,9 +43,6 @@ def test_server_retrieve_pvs(mock_recipe, pv_name):
 @patch("p4p_ext.thread.server.SimpleServer", autospec=True)
 def test_server_start(server, provider, caplog, mock_isispv):
     test_server = SimpleServer(
-        ioc_name="TESTIOC",
-        section="controls testing",
-        description="server for unit tests",
         prefix="DEV:",
     )
 
@@ -77,9 +65,6 @@ def test_server_start(server, provider, caplog, mock_isispv):
 @patch("p4p_ext.pvrecipe.PVScalarRecipe", autospec=True)
 def test_server_add_pv(recipe, server, provider, caplog):
     test_server = SimpleServer(
-        ioc_name="TESTIOC",
-        section="controls testing",
-        description="server for unit tests",
         prefix="DEV:",
     )
 
@@ -99,9 +84,6 @@ def test_server_add_pv(recipe, server, provider, caplog):
 @patch("p4p_ext.thread.server.SimpleServer", autospec=True)
 def test_server_stop(server, provider, caplog, mock_isispv):
     test_server = SimpleServer(
-        ioc_name="TESTIOC",
-        section="controls testing",
-        description="server for unit tests",
         prefix="DEV:",
     )
 
@@ -123,9 +105,6 @@ def test_server_stop(server, provider, caplog, mock_isispv):
 @patch("p4p_ext.pvrecipe.PVScalarRecipe", autospec=True)
 def test_server_remove_pv(recipe, server, provider, caplog, mock_isispv):
     test_server = SimpleServer(
-        ioc_name="TESTIOC",
-        section="controls testing",
-        description="server for unit tests",
         prefix="DEV:",
     )