pytac 0.6.0b1__py3-none-any.whl

pytac/__init__.py

@@ -0,0 +1,47 @@
+import sys
+
+if sys.version_info < (3, 8):
+    from importlib_metadata import version  # noqa
+else:
+    from importlib.metadata import version  # noqa
+
+# PV types.
+SP = "setpoint"
+RB = "readback"
+# Unit systems.
+ENG = "engineering"
+PHYS = "physics"
+# Data Source types.
+SIM = "simulation"
+LIVE = "live"
+# Default argument flag.
+DEFAULT = "default"
+
+from . import (  # isort:skip
+    data_source,
+    device,
+    element,
+    exceptions,
+    lattice,
+    load_csv,
+    units,
+    utils,
+)
+
+"""Ignore isort (flake8 Error 402) as we cannot import these modules at the top of the
+file as the strings above must be set first or the imports will fail.
+"""
+__version__ = version("pytac")
+del version
+
+__all__ = [
+    "__version__",
+    "data_source",
+    "device",
+    "element",
+    "exceptions",
+    "lattice",
+    "load_csv",
+    "units",
+    "utils",
+]

pytac/__main__.py

@@ -0,0 +1,16 @@
+from argparse import ArgumentParser
+
+from . import __version__
+
+__all__ = ["main"]
+
+
+def main(args=None):
+    parser = ArgumentParser()
+    parser.add_argument("-v", "--version", action="version", version=__version__)
+    args = parser.parse_args(args)
+
+
+# test with: python -m pytac
+if __name__ == "__main__":
+    main()

pytac/_version.py

@@ -0,0 +1,4 @@
+# file generated by setuptools_scm
+# don't change, don't track in version control
+__version__ = version = '0.6.0b1'
+__version_tuple__ = version_tuple = (0, 6, 0)

pytac/cothread_cs.py

@@ -0,0 +1,139 @@
+import logging
+
+from cothread.catools import ca_nothing, caget, caput
+
+from pytac.cs import ControlSystem
+from pytac.exceptions import ControlSystemException
+
+
+class CothreadControlSystem(ControlSystem):
+    """A control system using cothread to communicate with EPICS.
+
+    N.B. this is the default control system. It is used to communicate over
+    channel access with the hardware in the ring.
+
+    **Methods:**
+    """
+
+    def __init__(self, timeout=1.0, wait=False):
+        self._timeout = timeout
+        self._wait = wait
+
+    def get_single(self, pv, throw=True):
+        """Get the value of a given PV.
+
+        Args:
+            pv (string): The process variable given as a string. It can be a
+                         readback or a setpoint PV.
+            throw (bool): On failure: if True, raise ControlSystemException; if
+                           False, return None and log a warning.
+
+        Returns:
+            object: the current value of the given PV.
+
+        Raises:
+            ControlSystemException: if it cannot connect to the specified PV.
+        """
+        try:
+            return caget(pv, timeout=self._timeout, throw=True)
+        except ca_nothing:
+            error_msg = f"Cannot connect to {pv}."
+            if throw:
+                raise ControlSystemException(error_msg)
+            else:
+                logging.warning(error_msg)
+                return None
+
+    def get_multiple(self, pvs, throw=True):
+        """Get the value for given PVs.
+
+        Args:
+            pvs (sequence): PVs to get values of.
+            throw (bool): On failure: if True, raise ControlSystemException; if
+                           False, None will be returned for any PV that fails
+                           and a warning will be logged.
+
+        Returns:
+            sequence: the current values of the PVs.
+
+        Raises:
+            ControlSystemException: if it cannot connect to one or more PVs.
+        """
+        results = caget(pvs, timeout=self._timeout, throw=False)
+        return_values = []
+        failures = []
+        for result in results:
+            if isinstance(result, ca_nothing):
+                logging.warning(f"Cannot connect to {result.name}.")
+                if throw:
+                    failures.append(result)
+                else:
+                    return_values.append(None)
+            else:
+                return_values.append(result)
+        if throw and failures:
+            raise ControlSystemException(f"{len(failures)} caget calls failed.")
+        return return_values
+
+    def set_single(self, pv, value, throw=True):
+        """Set the value of a given PV.
+
+        Args:
+            pv (string): PV to set the value of.
+            value (object): The value to set the PV to.
+            throw (bool): On failure: if True, raise ControlSystemException: if
+                           False, log a warning.
+
+        Returns:
+            bool: True for success, False for failure
+
+        Raises:
+            ControlSystemException: if it cannot connect to the specified PV.
+        """
+        try:
+            caput(pv, value, timeout=self._timeout, throw=True, wait=self._wait)
+            return True
+        except ca_nothing:
+            error_msg = f"Cannot connect to {pv}."
+            if throw:
+                raise ControlSystemException(error_msg)
+            else:
+                logging.warning(error_msg)
+                return False
+
+    def set_multiple(self, pvs, values, throw=True):
+        """Set the values for given PVs.
+
+        Args:
+            pvs (sequence): PVs to set the values of.
+            values (sequence): values to set to the PVs.
+            throw (bool): On failure, if True raise ControlSystemException, if
+                           False return a list of True and False values
+                           corresponding to successes and failures and log a
+                           warning for each PV that fails.
+
+        Returns:
+            list(bool): True for success, False for failure; only returned if
+                         throw is false and a failure occurs.
+
+        Raises:
+            ValueError: if the lists of values and PVs are diffent lengths.
+            ControlSystemException: if it cannot connect to one or more PVs.
+        """
+        if len(pvs) != len(values):
+            raise ValueError("Please enter the same number of values as PVs.")
+        status = caput(pvs, values, timeout=self._timeout, throw=False, wait=self._wait)
+        return_values = []
+        failures = []
+        for stat in status:
+            if not stat.ok:
+                return_values.append(False)
+                failures.append(stat)
+                logging.warning(f"Cannot connect to {stat.name}.")
+            else:
+                return_values.append(True)
+        if failures:
+            if throw:
+                raise ControlSystemException(f"{len(failures)} caput calls failed.")
+            else:
+                return return_values

pytac/cs.py

@@ -0,0 +1,77 @@
+"""Class representing an abstract control system."""
+
+
+class ControlSystem(object):
+    """Abstract base class representing a control system.
+
+    A specialised implementation of this class would be used to communicate
+    over channel access with the hardware in the ring.
+
+    **Methods:**
+    """
+
+    def get_single(self, pv, throw):
+        """Get the value of a given PV.
+
+        Args:
+            pv (string): PV to get the value of.
+                         readback or a setpoint PV.
+            throw (bool): On failure: if True, raise ControlSystemException; if
+                           False, return None and log a warning.
+
+        Returns:
+            object: the current value of the given PV.
+
+        Raises:
+            ControlSystemException: if it cannot connect to the specified PVs.
+        """
+        raise NotImplementedError()
+
+    def get_multiple(self, pvs, throw):
+        """Get the value for given PVs.
+
+        Args:
+            pvs (sequence): PVs to get values of.
+            throw (bool): On failure: if True, raise ControlSystemException; if
+                           False, None will be returned for any PV that fails
+                           and a warning will be logged.
+
+        Returns:
+            list(object): the current values of the PVs.
+
+        Raises:
+            ControlSystemException: if it cannot connect to the specified PV.
+        """
+        raise NotImplementedError()
+
+    def set_single(self, pv, value, throw):
+        """Set the value of a given PV.
+
+        Args:
+            pv (string): The PV to set the value of.
+            value (object): The value to set the PV to.
+            throw (bool): On failure: if True, raise ControlSystemException: if
+                           False, log a warning.
+
+        Raises:
+            ControlSystemException: if it cannot connect to the specified PV.
+        """
+        raise NotImplementedError()
+
+    def set_multiple(self, pvs, values, throw):
+        """Set the values for given PVs.
+
+        Args:
+            pvs (sequence): PVs to set the values of.
+            values (sequence): values to set no the PVs.
+            throw (bool): On failure, if True raise ControlSystemException, if
+                           False return a list of True and False values
+                           corresponding to successes and failures and log a
+                           warning for each PV that fails.
+
+        Raises:
+            ValueError: if the PVs or values are not passed in as sequences
+                        or if they have different lengths
+            ControlSystemException: if it cannot connect to one or more PVs.
+        """
+        raise NotImplementedError()