genie-python 25.2.2__tar.gz → 25.8.0__tar.gz

{genie_python-25.2.2 → genie_python-25.8.0}/.github/workflows/release.yml

@@ -67,7 +67,7 @@ jobs:
         name: python-package-distributions
         path: dist/
     - name: Sign the dists with Sigstore
-      uses: sigstore/gh-action-sigstore-python@v3.0.0
+      uses: sigstore/gh-action-sigstore-python@v3.0.1
       with:
         inputs: >-
           ./dist/*.tar.gz

{genie_python-25.2.2 → genie_python-25.8.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: genie_python
-Version: 25.2.2
+Version: 25.8.0
 Summary: Instrument control & scripting for the ISIS Neutron & Muon source
 Author-email: ISIS Experiment Controls <ISISExperimentControls@stfc.ac.uk>
 Maintainer-email: ISIS Experiment Controls <ISISExperimentControls@stfc.ac.uk>
@@ -36,7 +36,6 @@ Requires-Dist: myst_parser; extra == "doc"
 Requires-Dist: sphinx-autobuild; extra == "doc"
 Provides-Extra: dev
 Requires-Dist: genie_python[doc,plot]; extra == "dev"
-Requires-Dist: mock; extra == "dev"
 Requires-Dist: parameterized; extra == "dev"
 Requires-Dist: pyhamcrest; extra == "dev"
 Requires-Dist: pytest; extra == "dev"

{genie_python-25.2.2 → genie_python-25.8.0}/pyproject.toml

@@ -72,7 +72,6 @@ doc = [
 
 dev = [
   "genie_python[plot,doc]",
-  "mock",
   "parameterized",
   "pyhamcrest",
   "pytest",
@@ -118,6 +117,7 @@ reportUnnecessaryIsInstance = true
 reportUntypedBaseClass = true
 reportUntypedClassDecorator = true
 reportUntypedFunctionDecorator = true
+stubPath = "src/genie_python/typings"
 
 [tool.setuptools_scm]
 version_file = "src/genie_python/_version.py"

{genie_python-25.2.2 → genie_python-25.8.0}/src/genie_python/_version.py

@@ -1,7 +1,14 @@
 # file generated by setuptools-scm
 # don't change, don't track in version control
 
-__all__ = ["__version__", "__version_tuple__", "version", "version_tuple"]
+__all__ = [
+    "__version__",
+    "__version_tuple__",
+    "version",
+    "version_tuple",
+    "__commit_id__",
+    "commit_id",
+]
 
 TYPE_CHECKING = False
 if TYPE_CHECKING:
@@ -9,13 +16,19 @@ if TYPE_CHECKING:
     from typing import Union
 
     VERSION_TUPLE = Tuple[Union[int, str], ...]
+    COMMIT_ID = Union[str, None]
 else:
     VERSION_TUPLE = object
+    COMMIT_ID = object
 
 version: str
 __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
+commit_id: COMMIT_ID
+__commit_id__: COMMIT_ID
 
-__version__ = version = '25.2.2'
-__version_tuple__ = version_tuple = (25, 2, 2)
+__version__ = version = '25.8.0'
+__version_tuple__ = version_tuple = (25, 8, 0)
+
+__commit_id__ = commit_id = 'g1fca963b3'

{genie_python-25.2.2 → genie_python-25.8.0}/src/genie_python/block_names.py

@@ -1,6 +1,7 @@
 import zlib
 from keyword import iskeyword
 from threading import RLock, Timer
+from typing import TYPE_CHECKING, Optional
 
 from .channel_access_exceptions import UnableToConnectToPVException
 from .genie_blockserver import BLOCK_SERVER_PREFIX, PV_BLOCK_NAMES
@@ -9,6 +10,9 @@ from .utilities import dehex_decompress_and_dejson
 
 DELAY_BEFORE_RETRYING_BLOCK_NAMES_PV_ON_FAIL = 30.0
 
+if TYPE_CHECKING:
+    from genie_python.genie import PVValue
+
 
 class BlockNamesManager:
     """
@@ -17,23 +21,24 @@ class BlockNamesManager:
 
     def __init__(
         self,
-        block_names,
-        delay_before_retry_add_monitor=DELAY_BEFORE_RETRYING_BLOCK_NAMES_PV_ON_FAIL,
-    ):
+        block_names: "BlockNames",
+        delay_before_retry_add_monitor: float = DELAY_BEFORE_RETRYING_BLOCK_NAMES_PV_ON_FAIL,
+    ) -> None:
         """
         Constructor.
         :param block_names: the block name instance that this manger is managing
-        :param delay_before_retry_add_monitor: if the block names pv doesn't exist on start the delay before retrying
+        :param delay_before_retry_add_monitor: if the block names pv doesn't exist
+            on start the delay before retrying
         """
         self._block_names = block_names
         self._cancel_monitor_fn = None
         self._delay_before_retry_add_monitor = delay_before_retry_add_monitor
         self._timer = None
-        self._pv_name = None
+        self._pv_name = ""
         # lock used to access _timer or _pv_name
         self.pv_name_lock = RLock()
 
-    def update_prefix(self, pv_prefix):
+    def update_prefix(self, pv_prefix: str) -> None:
         """
         Update the instrument prefix that the manager is using if it has changed
         :param pv_prefix: new pv prefix
@@ -45,44 +50,49 @@ class BlockNamesManager:
                 self._pv_name = new_name
                 if self._timer is None:
                     self._timer = Timer(0, self._add_monitor)
-                    self._timer.setDaemon(True)
+                    self._timer.daemon = True
                     self._timer.start()
 
-    def _add_monitor(self):
+    def _add_monitor(self) -> None:
         """
-        Add a monitor to the block names pv if it is not already monitored, then reschedule task to add monitor. If the
-        pv is monitored don't run.
+        Add a monitor to the block names pv if it is not already monitored,
+        then reschedule task to add monitor. If the pv is monitored don't run.
         """
 
-        # Get PV we should monitor and check whether we need to add new monitor if so cancel old monitor
+        # Get PV we should monitor and check whether we need to add new monitor
+        # if so cancel old monitor
         with self.pv_name_lock:
             self._timer = None
             # not monitoring the correct pv
             if self._cancel_monitor_fn is not None:
                 self._cancel_monitor_fn()
 
-            # Add new monitor if successful then record monitored pv and pull first value, otherwise do nothing
+            # Add new monitor if successful then record monitored pv and pull
+            # first value, otherwise do nothing
             try:
                 self._cancel_monitor_fn = CaChannelWrapper.add_monitor(
                     self._pv_name, self._update_block_names, to_string=True
                 )
                 self._update_block_names(
-                    CaChannelWrapper.get_pv_value(self._pv_name, to_string=True), None, None
+                    CaChannelWrapper.get_pv_value(self._pv_name, to_string=True), "", ""
                 )
             except UnableToConnectToPVException:
-                # Schedule next add monitor if needed; i.e. a old pv-prefix change was slower the the last pv-prefix
+                # Schedule next add monitor if needed; i.e. a old pv-prefix change
+                # was slower the the last pv-prefix
                 # and so we are monitoring the wrong pv.
                 self._timer = Timer(self._delay_before_retry_add_monitor, self._add_monitor)
-                self._timer.setDaemon(True)
+                self._timer.daemon = True
                 self._timer.start()
 
-    def _update_block_names(self, value, _, _1):
+    def _update_block_names(self, value: "PVValue", _: Optional[str], _1: Optional[str]) -> None:
         """
         Update the block names from a pv
         Args:
             :param value: new value of block names pv
-            :param _(CaChannel._ca.AlarmSeverity): severity of any alarm (not used but passed in by monitor)
-            :param _1(CaChannel._ca.AlarmCondition): status of the alarm (not used but passed in by monitor)
+            :param _(CaChannel._ca.AlarmSeverity): severity of any alarm
+                (not used but passed in by monitor)
+            :param _1(CaChannel._ca.AlarmCondition): status of the alarm
+                (not used but passed in by monitor)
         """
         # remove old blocks
         for block_name in list(self._block_names.__dict__.keys()):
@@ -90,6 +100,7 @@ class BlockNamesManager:
 
         # add new block as attributes to class
         try:
+            assert isinstance(value, (str, bytes)), value
             block_names = dehex_decompress_and_dejson(value)
             for name in block_names:
                 attribute_name = name
@@ -103,11 +114,12 @@ class BlockNamesManager:
 
 class BlockNames:
     """
-    Hold names of the current blocks in config. If block is requested which does not appear in the current config
-    block name returned but message printed about it.
+    Hold names of the current blocks in config. If block is requested which
+        does not appear in the current config block name returned but message
+        printed about it.
     """
 
-    def __getattr__(self, attr):
+    def __getattr__(self, attr: str) -> str:
         """
         If an attribute is not set then return name requested
         :param attr: attribute name

genie_python-25.8.0/src/genie_python/channel_access_exceptions.py

@@ -0,0 +1,44 @@
+"""
+Useful and slightly more explicit exceptions that can be thrown.
+In general catch the super class of these.
+"""
+
+
+class UnableToConnectToPVException(IOError):  # noqa N818 Historic name
+    """
+    The system is unable to connect to a PV for some reason.
+    """
+
+    def __init__(self, pv_name: str, err: str) -> None:
+        super(UnableToConnectToPVException, self).__init__(
+            f"Unable to connect to PV {pv_name}: {err}"
+        )
+
+
+class InvalidEnumStringException(KeyError):  # noqa N818 Historic name
+    """
+    The enum string that is trying to be set is not listed in the pv.
+    """
+
+    def __init__(self, pv_name: str, valid_states: str) -> None:
+        super(InvalidEnumStringException, self).__init__(
+            f"Invalid string value entered for {pv_name}. Valid strings are {valid_states}"
+        )
+
+
+class ReadAccessException(IOError):  # noqa N818 Historic name
+    """
+    PV exists but its value is unavailable to read.
+    """
+
+    def __init__(self, pv_name: str) -> None:
+        super(ReadAccessException, self).__init__(f"Read access denied for PV {pv_name}")
+
+
+class WriteAccessException(IOError):  # noqa N818 Historic name
+    """
+    PV was written to but does not allow writes.
+    """
+
+    def __init__(self, pv_name: str) -> None:
+        super(WriteAccessException, self).__init__(f"Write access denied for PV {pv_name}")