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

genie_python-25.2.2/.github/workflows/lint-and-test-nightly.yml

@@ -0,0 +1,8 @@
+name: lint-and-test-nightly
+on:
+  schedule:
+    - cron: "0 0 * * *"
+
+jobs:
+  lint-and-test-nightly:
+    uses: ./.github/workflows/lint_and_test.yml

{genie_python-25.2.1.2 → genie_python-25.2.2}/.github/workflows/lint_and_test.yml

@@ -7,13 +7,13 @@ jobs:
     uses: ISISComputingGroup/reusable-workflows/.github/workflows/linters.yml@main
     with:
       compare-branch: origin/main
-      python-ver: '3.11'
+      python-ver: '3.12'
   unit-tests:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
         os: ["ubuntu-latest", "windows-latest"]
-        version: ['3.11']
+        version: ['3.11', '3.12']
       fail-fast: false
     steps:
       - uses: actions/checkout@v4

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

@@ -16,7 +16,7 @@ jobs:
     - name: Set up Python
       uses: actions/setup-python@v5
       with:
-        python-version: "3.11"
+        python-version: "3.12"
     - name: Install pypa/build
       run: >-
         python3 -m

genie_python-25.2.2/PKG-INFO

@@ -0,0 +1,57 @@
+Metadata-Version: 2.4
+Name: genie_python
+Version: 25.2.2
+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>
+License-Expression: BSD-3-Clause
+Project-URL: Homepage, https://github.com/isiscomputinggroup/genie
+Project-URL: Bug Reports, https://github.com/isiscomputinggroup/genie/issues
+Project-URL: Source, https://github.com/isiscomputinggroup/genie
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: CaChannel
+Requires-Dist: graypy
+Requires-Dist: ipython
+Requires-Dist: mysql-connector-python
+Requires-Dist: numpy
+Requires-Dist: p4p
+Requires-Dist: psutil
+Requires-Dist: pylint
+Requires-Dist: pyright
+Requires-Dist: pywin32; platform_system == "Windows"
+Provides-Extra: plot
+Requires-Dist: matplotlib==3.10.1; extra == "plot"
+Requires-Dist: py4j; extra == "plot"
+Requires-Dist: tornado; extra == "plot"
+Provides-Extra: doc
+Requires-Dist: sphinx; extra == "doc"
+Requires-Dist: sphinx_rtd_theme; extra == "doc"
+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"
+Requires-Dist: pytest-cov; extra == "dev"
+Requires-Dist: ruff>=0.6; extra == "dev"
+Dynamic: license-file
+
+# genie_python
+
+Instrument control and scripting library at the ISIS Neutron & Muon source.
+
+---
+
+Documentation: https://isiscomputinggroup.github.io/genie/genie_python
+
+Source: https://github.com/ISISComputingGroup/genie
+
+PyPi: https://pypi.org/project/genie_python/

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

@@ -9,7 +9,8 @@ dynamic = ["version"]
 description = "Instrument control & scripting for the ISIS Neutron & Muon source"
 readme = "README.md"
 requires-python = ">=3.11"
-license = {file = "LICENSE"}
+license = "BSD-3-Clause"
+license-files = ["LICENSE"]
 
 authors = [
   {name = "ISIS Experiment Controls", email = "ISISExperimentControls@stfc.ac.uk" }
@@ -21,8 +22,8 @@ maintainers = [
 classifiers = [
   "Development Status :: 5 - Production/Stable",
   "Intended Audience :: Developers",
-  "License :: OSI Approved :: BSD License",
   "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
 ]
 
 dependencies = [
@@ -55,7 +56,7 @@ dependencies = [
 # - It depends on a couple of heavyweight libs (py4j and tornado) that aren't necessary otherwise
 plot = [
   # When updating, check plotting works in GUI. Must keep pinned to a specific, tested version.
-  "matplotlib==3.9.2",
+  "matplotlib==3.10.1",
   # Python <-> Java communication, to spawn matplotlib plots in GUI
   "py4j",
   # Tornado webserver used by custom backend

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

@@ -1,8 +1,13 @@
-# file generated by setuptools_scm
+# file generated by setuptools-scm
 # don't change, don't track in version control
+
+__all__ = ["__version__", "__version_tuple__", "version", "version_tuple"]
+
 TYPE_CHECKING = False
 if TYPE_CHECKING:
-    from typing import Tuple, Union
+    from typing import Tuple
+    from typing import Union
+
     VERSION_TUPLE = Tuple[Union[int, str], ...]
 else:
     VERSION_TUPLE = object
@@ -12,5 +17,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '25.2.1.2'
-__version_tuple__ = version_tuple = (25, 2, 1, 2)
+__version__ = version = '25.2.2'
+__version_tuple__ = version_tuple = (25, 2, 2)

{genie_python-25.2.1.2 → genie_python-25.2.2}/src/genie_python/genie.py

@@ -1,7 +1,8 @@
 from __future__ import absolute_import, print_function
 
 import datetime
-import imp
+import importlib
+import importlib.util
 import os
 import re
 import sys
@@ -14,7 +15,6 @@ import numpy.typing as npt
 
 from genie_python.genie_api_setup import __api as _genie_api
 
-os.environ["EPICS_CA_MAX_ARRAY_BYTES"] = "20000000"
 os.environ["FROM_IBEX"] = str(False)
 
 # for user import this functionality so they can do g.adv and g.sim
@@ -24,7 +24,7 @@ import genie_python.genie_simulate as sim  # noqa F401
 import genie_python.genie_toggle_settings as toggle  # noqa F401
 
 # Import required for g.my_pv_prefix
-from genie_python.genie_api_setup import (
+from genie_python.genie_api_setup import (  # noqa E402
     get_user_script_dir,
     helparglist,
     log_command_and_handle_exception,
@@ -32,27 +32,29 @@ from genie_python.genie_api_setup import (
     set_user_script_dir,
     usercommand,
 )
-from genie_python.genie_script_checker import ScriptChecker
-from genie_python.genie_toggle_settings import ToggleSettings
-from genie_python.utilities import (
+from genie_python.genie_script_checker import ScriptChecker  # noqa E402
+from genie_python.genie_toggle_settings import ToggleSettings  # noqa E402
+from genie_python.utilities import (  # noqa E402
     EnvironmentDetails,
     check_lowlimit_against_highlimit,
     get_correct_filepath_existing,
     get_correct_path,
 )
-from genie_python.version import VERSION
+from genie_python.version import VERSION  # noqa E402
 
 PVBaseValue = bool | int | float | str
 PVValue = PVBaseValue | list[PVBaseValue] | npt.NDArray | None
 
 print("\ngenie_python version " + VERSION)
 
-SUPPORTED_PYTHON_VERSION = (3, 11, 9)
-if sys.version_info[0:3] != SUPPORTED_PYTHON_VERSION[0:3]:
+MIN_SUPPORTED_PYTHON_VERSION = (3, 11, 0)
+MAX_SUPPORTED_PYTHON_VERSION = (3, 12, 999)
+
+if not (MIN_SUPPORTED_PYTHON_VERSION <= sys.version_info[0:3] <= MAX_SUPPORTED_PYTHON_VERSION):
     message = (
-        "WARNING: genie_python only guarantees support for "
-        "Python version {0[0]}.{0[1]}.{0[2]}, you are running {1}".format(
-            SUPPORTED_PYTHON_VERSION, sys.version
+        "WARNING: genie_python only supports "
+        "python versions {0[0]}.{0[1]}.{0[2]} to {1[0]}.{1[1]}.{1[2]}, you are running {2}".format(
+            MIN_SUPPORTED_PYTHON_VERSION, MAX_SUPPORTED_PYTHON_VERSION, sys.version
         )
     )
     print(message, file=sys.stderr)
@@ -1460,14 +1462,16 @@ def __load_module(name: str, directory: str) -> types.ModuleType:
     """
     This will reload the module if it has already been loaded.
     """
-    fpath = None
-    try:
-        fpath, pathname, description = imp.find_module(name, [directory])
-        return imp.load_module(name, fpath, pathname, description)
-    finally:
-        # Since we may exit via an exception, close fpath explicitly.
-        if fpath is not None:
-            fpath.close()
+    spec = importlib.util.find_spec(name, directory)
+    if spec is None:
+        raise ValueError(f"Cannot find spec for module {name} in {directory}")
+    module = importlib.util.module_from_spec(spec)
+    sys.modules[name] = module
+    loader = spec.loader
+    if loader is None:
+        raise ValueError("Module spec has no loader")
+    loader.exec_module(module)
+    return module
 
 
 @log_command_and_handle_exception

{genie_python-25.2.1.2 → genie_python-25.2.2}/src/genie_python/genie_cachannel_wrapper.py

@@ -19,6 +19,7 @@ try:
         AlarmSeverity,
         dbf_type_to_DBR_STS,
         dbf_type_to_DBR_TIME,
+        dbf_type_to_text,
     )
 except ImportError:
     # Note: caffi dynamically added to dependencies by CaChannel if not using built backend.
@@ -27,6 +28,7 @@ except ImportError:
         AlarmSeverity,
         dbf_type_to_DBR_STS,
         dbf_type_to_DBR_TIME,
+        dbf_type_to_text,
     )
 
 if TYPE_CHECKING:
@@ -252,8 +254,10 @@ class CaChannelWrapper(object):
                 chan = pv_map[name]
             else:
                 chan = CaChannel(name)
-                # noinspection PyTypeChecker
-                CaChannelWrapper.installHandlers(chan)
+                # do not install handlers if server
+                if os.getenv("EPICS_CAS_INTF_ADDR_LIST") is None:
+                    # noinspection PyTypeChecker
+                    CaChannelWrapper.installHandlers(chan)
                 chan.setTimeout(timeout)
                 # Try to connect - throws if cannot
                 CaChannelWrapper.connect_to_pv(chan)
@@ -549,3 +553,19 @@ class CaChannelWrapper(object):
 
         if not event.is_set():
             raise UnableToConnectToPVException(chan.name(), "Pend event timeout")
+
+    @staticmethod
+    def dbf_type_to_string(typ: int) -> str:
+        """
+        Return DB field type as text
+
+        Args:
+            typ: DB field type as integer
+
+        Returns: DB field type as string
+            Valid values:
+            DBF_STRING, DBF_CHAR, DBF_UCHAR, DBF_SHORT, DBF_USHORT, DBF_LONG,
+            DBF_ULONG, DBF_INT64, DBF_UINT64, DBF_FLOAT, DBF_DOUBLE, DBF_ENUM,
+            DBF_MENU, DBF_DEVICE, DBF_INLINK, DBF_OUTLINK, DBF_FWDLINK, DBF_NOACCESS
+        """
+        return dbf_type_to_text(typ)

{genie_python-25.2.1.2 → genie_python-25.2.2}/src/genie_python/genie_dae.py

@@ -458,9 +458,7 @@ class Dae(object):
             prepost: run pre and post commands [optional]
         """
         if self.get_run_state() == "ENDING" and not immediate:
-            print(
-                "Please specify the 'immediate=True' flag to end a run " "while in the ENDING state"
-            )
+            print("Please specify the 'immediate=True' flag to end a run while in the ENDING state")
             return
 
         run_number = self.get_run_number()
@@ -601,8 +599,7 @@ class Dae(object):
         """
         if self.get_run_state() == "PAUSING" and not immediate:
             print(
-                "Please specify the 'immediate=True' flag "
-                "to pause a run while in the PAUSING state"
+                "Please specify the 'immediate=True' flag to pause a run while in the PAUSING state"
             )
             return
 

{genie_python-25.2.1.2 → genie_python-25.2.2}/src/genie_python/genie_epics_api.py

@@ -4,6 +4,7 @@ import contextlib
 import os
 import re
 import sys
+import typing
 import urllib.parse
 import urllib.request
 from builtins import str
@@ -560,7 +561,7 @@ class API(object):
         for name, value in temp:
             self.set_block_value(name, value)
 
-    def get_block_units(self, block_name: str) -> str:
+    def get_block_units(self, block_name: str) -> str | None:
         """
         Get the physical measurement units associated with a block name.
 
@@ -572,6 +573,7 @@ class API(object):
         -------
         units of the block
         """
+
         pv_name = self.get_pv_from_block(block_name)
         if "." in pv_name:
             # Remove any headers
@@ -588,7 +590,13 @@ class API(object):
                 )
             )
 
-        return Wrapper.get_pv_value(unit_name)
+        field_type = Wrapper.dbf_type_to_string(Wrapper.get_chan(pv_name).field_type())
+
+        if field_type in ["DBF_STRING", "DBF_CHAR", "DBF_UCHAR", "DBF_ENUM"]:
+            return None
+        # Only return block units if PV field type is _not_ STRING, CHAR, UCHAR or ENUM
+        # as they're unlikely to have .EGU fields
+        return typing.cast(str | None, Wrapper.get_pv_value(unit_name))
 
     def _get_pars(
         self, pv_prefix_identifier: str, get_names_from_blockserver: Callable[[], list[str]]

genie_python-25.2.2/src/genie_python.egg-info/PKG-INFO

@@ -0,0 +1,57 @@
+Metadata-Version: 2.4
+Name: genie_python
+Version: 25.2.2
+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>
+License-Expression: BSD-3-Clause
+Project-URL: Homepage, https://github.com/isiscomputinggroup/genie
+Project-URL: Bug Reports, https://github.com/isiscomputinggroup/genie/issues
+Project-URL: Source, https://github.com/isiscomputinggroup/genie
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: CaChannel
+Requires-Dist: graypy
+Requires-Dist: ipython
+Requires-Dist: mysql-connector-python
+Requires-Dist: numpy
+Requires-Dist: p4p
+Requires-Dist: psutil
+Requires-Dist: pylint
+Requires-Dist: pyright
+Requires-Dist: pywin32; platform_system == "Windows"
+Provides-Extra: plot
+Requires-Dist: matplotlib==3.10.1; extra == "plot"
+Requires-Dist: py4j; extra == "plot"
+Requires-Dist: tornado; extra == "plot"
+Provides-Extra: doc
+Requires-Dist: sphinx; extra == "doc"
+Requires-Dist: sphinx_rtd_theme; extra == "doc"
+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"
+Requires-Dist: pytest-cov; extra == "dev"
+Requires-Dist: ruff>=0.6; extra == "dev"
+Dynamic: license-file
+
+# genie_python
+
+Instrument control and scripting library at the ISIS Neutron & Muon source.
+
+---
+
+Documentation: https://isiscomputinggroup.github.io/genie/genie_python
+
+Source: https://github.com/ISISComputingGroup/genie
+
+PyPi: https://pypi.org/project/genie_python/

{genie_python-25.2.1.2 → genie_python-25.2.2}/src/genie_python.egg-info/SOURCES.txt

@@ -8,6 +8,7 @@ ruff.toml
 .github/PULL_REQUEST_TEMPLATE.md
 .github/dependabot.yml
 .github/workflows/documentation.yml
+.github/workflows/lint-and-test-nightly.yml
 .github/workflows/lint_and_test.yml
 .github/workflows/release.yml
 doc/conf.py

{genie_python-25.2.1.2 → genie_python-25.2.2}/src/genie_python.egg-info/requires.txt

@@ -27,6 +27,6 @@ myst_parser
 sphinx-autobuild
 
 [plot]
-matplotlib==3.9.2
+matplotlib==3.10.1
 py4j
 tornado

{genie_python-25.2.1.2 → genie_python-25.2.2}/tests/test_genie_dae.py

@@ -285,7 +285,7 @@ class TestGenieDAE(unittest.TestCase):
     ):
         self.dae.in_change = False
 
-        self.assertRaisesRegexp(ValueError, "Change has already finished", self.dae.change_finish)
+        self.assertRaisesRegex(ValueError, "Change has already finished", self.dae.change_finish)
 
     def test_GIVEN_in_transition_WHEN_change_finish_called_THEN_value_error_with_correct_message_thrown(
         self,
@@ -293,10 +293,9 @@ class TestGenieDAE(unittest.TestCase):
         self.dae.in_change = True
         self.dae.in_transition = MagicMock(return_value=True)
 
-        self.assertRaisesRegexp(
+        self.assertRaisesRegex(
             ValueError,
-            "Another DAE change operation is currently in progress - values will be "
-            "inconsistent",
+            "Another DAE change operation is currently in progress - values will be inconsistent",
             self.dae.change_finish,
         )
 
@@ -306,7 +305,7 @@ class TestGenieDAE(unittest.TestCase):
         self.dae.in_change = True
         self.dae.get_run_state = MagicMock(return_value="RUNNING")
 
-        self.assertRaisesRegexp(
+        self.assertRaisesRegex(
             ValueError,
             "Instrument must be in SETUP when changing settings!",
             self.dae.change_finish,

{genie_python-25.2.1.2 → genie_python-25.2.2}/tests/test_genie_epics_api.py

@@ -23,6 +23,7 @@ from mock import MagicMock, patch
 from parameterized import parameterized
 
 from genie_python.channel_access_exceptions import UnableToConnectToPVException
+from genie_python.genie_cachannel_wrapper import CaChannelWrapper as Wrapper
 from genie_python.genie_epics_api import API
 
 
@@ -419,7 +420,9 @@ class TestPvMethods(unittest.TestCase):
                 raise
 
     @patch("genie_python.genie_epics_api.Wrapper")
-    def test_GIVEN_mock_pv_WHEN_get_local_pv_value_THEN_pv_is_returned(self, pv_wrapper_mock):
+    def test_GIVEN_mock_pv_WHEN_get_local_pv_value_THEN_pv_is_returned(
+        self, pv_wrapper_mock: MagicMock
+    ):
         expected_value = 10
         pv_wrapper_mock.pv_exists.return_value = True
         pv_wrapper_mock.get_pv_value.return_value = expected_value
@@ -433,7 +436,7 @@ class TestPvMethods(unittest.TestCase):
 
     @patch("genie_python.genie_epics_api.Wrapper")
     def test_GIVEN_mock_pv_WHEN_get_value_of_local_pv_with_local_prefix_on_start_THEN_pv_is_returned_and_pv_asked_for_has_only_one_prefix(
-        self, pv_wrapper_mock
+        self, pv_wrapper_mock: MagicMock
     ):
         expected_value = 10
         pv_wrapper_mock.pv_exists.return_value = True
@@ -447,7 +450,9 @@ class TestPvMethods(unittest.TestCase):
         pv_wrapper_mock.get_pv_value.assert_called_with(expected_pv_name, False, use_numpy=None)
 
     @patch("genie_python.genie_epics_api.Wrapper")
-    def test_GIVEN_mock_pv_WHEN_get_global_pv_value_THEN_pv_is_returned(self, pv_wrapper_mock):
+    def test_GIVEN_mock_pv_WHEN_get_global_pv_value_THEN_pv_is_returned(
+        self, pv_wrapper_mock: MagicMock
+    ):
         expected_value = 10
         pv_wrapper_mock.pv_exists.return_value = True
         pv_wrapper_mock.get_pv_value.return_value = expected_value
@@ -460,7 +465,7 @@ class TestPvMethods(unittest.TestCase):
 
     @patch("genie_python.genie_epics_api.Wrapper")
     def test_GIVEN_mock_pv_WHEN_get_pv_value_but_pv_does_not_exist_THEN_exception(
-        self, pv_wrapper_mock
+        self, pv_wrapper_mock: MagicMock
     ):
         pv_wrapper_mock.pv_exists.return_value = False
 
@@ -470,7 +475,7 @@ class TestPvMethods(unittest.TestCase):
 
     @patch("genie_python.genie_epics_api.Wrapper")
     def test_GIVEN_mock_pv_WHEN_get_pv_value_but_wrapper_exception_THEN_exception_thrown(
-        self, pv_wrapper_mock
+        self, pv_wrapper_mock: MagicMock
     ):
         pv_wrapper_mock.get_pv_value.side_effect = ValueError()
 
@@ -483,7 +488,7 @@ class TestPvMethods(unittest.TestCase):
 
     @patch("genie_python.genie_epics_api.Wrapper")
     def test_GIVEN_mock_pv_WHEN_get_pv_value_wrapper_exception_on_first_trial_and_ok_on_second_THEN_value_returned(
-        self, pv_wrapper_mock
+        self, pv_wrapper_mock: MagicMock
     ):
         expected_value = 10
         pv_wrapper_mock.pv_exists.return_value = True
@@ -502,7 +507,7 @@ class TestPvMethods(unittest.TestCase):
 
     @patch("genie_python.genie_epics_api.Wrapper")
     def test_GIVEN_mock_pv_WHEN_get_pv_value_raises_exception_except_on_last_trial_THEN_value_returned(
-        self, pv_wrapper_mock
+        self, pv_wrapper_mock: MagicMock
     ):
         expected_value = 10
         pv_wrapper_mock.pv_exists.return_value = True
@@ -525,7 +530,7 @@ class TestPvMethods(unittest.TestCase):
         )
 
     @patch("genie_python.genie_epics_api.Wrapper")
-    def test_GIVEN_mock_pv_WHEN_set_local_pv_value_THEN_pv_is_set(self, pv_wrapper_mock):
+    def test_GIVEN_mock_pv_WHEN_set_local_pv_value_THEN_pv_is_set(self, pv_wrapper_mock: MagicMock):
         expected_value = 10
         pv_name = "PV"
         expected_pv_name = "{}{}".format(self.instrument_prefix, pv_name)
@@ -538,7 +543,7 @@ class TestPvMethods(unittest.TestCase):
 
     @patch("genie_python.genie_epics_api.Wrapper")
     def test_GIVEN_mock_pv_WHEN_set_local_pv_value_with_inst_prefix_THEN_pv_is_set_pv_does_not_have_extra_prefix(
-        self, pv_wrapper_mock
+        self, pv_wrapper_mock: MagicMock
     ):
         expected_value = 10
         pv_name = "PV"
@@ -551,7 +556,9 @@ class TestPvMethods(unittest.TestCase):
         )
 
     @patch("genie_python.genie_epics_api.Wrapper")
-    def test_GIVEN_mock_pv_WHEN_set_global_pv_value_THEN_pv_is_set(self, pv_wrapper_mock):
+    def test_GIVEN_mock_pv_WHEN_set_global_pv_value_THEN_pv_is_set(
+        self, pv_wrapper_mock: MagicMock
+    ):
         expected_value = 10
         expected_pv_name = "PV"
 
@@ -563,7 +570,7 @@ class TestPvMethods(unittest.TestCase):
 
     @patch("genie_python.genie_epics_api.Wrapper")
     def test_GIVEN_mock_pv_WHEN_set_local_pv_value_but_wrapper_exceptions_THEN_exception_thrown(
-        self, pv_wrapper_mock
+        self, pv_wrapper_mock: MagicMock
     ):
         pv_wrapper_mock.set_pv_value.side_effect = ValueError()
         expected_value = 10
@@ -584,7 +591,7 @@ class TestPvMethods(unittest.TestCase):
 
     @patch("genie_python.genie_epics_api.Wrapper")
     def test_GIVEN_mock_pv_WHEN_set_local_pv_value_but_wrapper_exception_on_first_trial_and_ok_on_second_THEN_pv_value_set(
-        self, pv_wrapper_mock
+        self, pv_wrapper_mock: MagicMock
     ):
         expected_value = 10
         pv_name = "PV"
@@ -605,7 +612,7 @@ class TestPvMethods(unittest.TestCase):
 
     @patch("genie_python.genie_epics_api.Wrapper")
     def test_GIVEN_mock_pv_WHEN_set_local_pv_value_raises_exception_except_on_last_trial_THEN_pv_value_set_called_attempt_times(
-        self, pv_wrapper_mock
+        self, pv_wrapper_mock: MagicMock
     ):
         expected_value = 10
         pv_name = "PV"
@@ -631,7 +638,7 @@ class TestPvMethods(unittest.TestCase):
 
     @patch("genie_python.genie_epics_api.Wrapper")
     def test_GIVEN_block_pointing_at_field_WHEN_get_block_units_THEN_units_field_is_called(
-        self, pv_wrapper_mock
+        self, pv_wrapper_mock: MagicMock
     ):
         # Mock get_pv_from_block to return something with .SOMETHING on the end
         self.api.get_pv_from_block = MagicMock(return_value="PVNAME.SOMETHING")
@@ -645,7 +652,7 @@ class TestPvMethods(unittest.TestCase):
 
     @patch("genie_python.genie_epics_api.Wrapper")
     def test_GIVEN_block_already_pointing_at_unit_field_WHEN_get_block_units_THEN_units_field_is_called(
-        self, pv_wrapper_mock
+        self, pv_wrapper_mock: MagicMock
     ):
         # Mock get_pv_from_block to return something with .EGU at the end
         self.api.get_pv_from_block = MagicMock(return_value="PVNAME.EGU")
@@ -659,7 +666,7 @@ class TestPvMethods(unittest.TestCase):
 
     @patch("genie_python.genie_epics_api.Wrapper")
     def test_GIVEN_block_not_pointing_at_field_WHEN_get_block_units_THEN_units_field_is_called(
-        self, pv_wrapper_mock
+        self, pv_wrapper_mock: MagicMock
     ):
         # Mock get_pv_from_block to return something without .SOMETHING at the end
         self.api.get_pv_from_block = MagicMock(return_value="PVNAME")
@@ -673,7 +680,7 @@ class TestPvMethods(unittest.TestCase):
 
     @patch("genie_python.genie_epics_api.Wrapper")
     def test_GIVEN_block_not_found_WHEN_get_block_units_THEN_exception_is_raised(
-        self, pv_wrapper_mock
+        self, pv_wrapper_mock: MagicMock
     ):
         # Mock get_pv_from_block to return something without .SOMETHING at the end
         self.api.get_pv_from_block = MagicMock(return_value="PVNAME")
@@ -687,7 +694,7 @@ class TestPvMethods(unittest.TestCase):
 
     @patch("genie_python.genie_epics_api.Wrapper")
     def test_GIVEN_pv_not_found_WHEN_get_block_units_THEN_exception_is_raised(
-        self, pv_wrapper_mock
+        self, pv_wrapper_mock: MagicMock
     ):
         # Mock get_pv_from_block to return something without .SOMETHING at the end
         self.api.get_pv_from_block = MagicMock(return_value="PVNAME")
@@ -705,6 +712,33 @@ class TestPvMethods(unittest.TestCase):
             raises(UnableToConnectToPVException),
         )
 
+    # Test that when units of char-type PV (STRING, CHAR, UCHAR, ENUM) requested, None is returned
+    # (as these PVs don't usually have .EGU fields).
+    @parameterized.expand(
+        [
+            "DBF_STRING",
+            "DBF_CHAR",
+            "DBF_UCHAR",
+            "DBF_ENUM",
+        ]
+    )
+    @patch("genie_python.genie_epics_api.Wrapper")
+    def test_GIVEN_chartype_pv_WHEN_get_block_units_called_THEN_None_returned(
+        self, field_type: str, pv_wrapper_mock: MagicMock
+    ):
+        # Mock get_pv_from_block to return something with .SOMETHING on the end
+        self.api.get_pv_from_block = MagicMock(return_value="PVNAME.SOMETHING")
+
+        # Mock return value for DBF type (integer) to string from genie api
+        pv_wrapper_mock.dbf_type_to_string.return_value = field_type
+
+        # Call get_block_units
+        self.api.get_block_names = MagicMock(return_value=["TEST"])
+        test_units = self.api.get_block_units("TEST")
+
+        # Assert that returned units value is None
+        self.assertEqual(test_units, None)
+
 
 class TestSetBlockMethod(unittest.TestCase):
     @patch("genie_python.genie_epics_api.GetExperimentData")
@@ -719,7 +753,7 @@ class TestSetBlockMethod(unittest.TestCase):
 
     @patch("genie_python.genie_epics_api.Wrapper")
     def test_WHEN_set_block_value_called_with_wait_THEN_setpoint_set_and_wait_for_called(
-        self, pv_wrapper
+        self, pv_wrapper: Wrapper
     ):
         self.api.waitfor = MagicMock()
 
@@ -731,7 +765,7 @@ class TestSetBlockMethod(unittest.TestCase):
 
     @patch("genie_python.genie_epics_api.Wrapper")
     def test_WHEN_set_block_value_called_with_wait_and_high_low_THEN_wait_for_called_with_high_low(
-        self, pv_wrapper
+        self, pv_wrapper: Wrapper
     ):
         self.api.waitfor = MagicMock()
         block_name, set_point = "TEST_BLOCK", 10
@@ -746,7 +780,7 @@ class TestSetBlockMethod(unittest.TestCase):
 
     @patch("genie_python.genie_epics_api.Wrapper")
     def test_WHEN_set_block_value_called_with_wait_and_high_low_incorrect_order_THEN_wait_for_called_with_high_low_correct_order(
-        self, pv_wrapper
+        self, pv_wrapper: Wrapper
     ):
         self.api.waitfor = MagicMock()
         block_name, set_point = "TEST_BLOCK", 10
@@ -761,7 +795,7 @@ class TestSetBlockMethod(unittest.TestCase):
 
     @patch("genie_python.genie_epics_api.Wrapper")
     def test_WHEN_set_block_value_called_with_wait_and_high_low_THEN_wait_for_called_with_high_low_correct_order(
-        self, pv_wrapper
+        self, pv_wrapper: Wrapper
     ):
         self.api.waitfor = MagicMock()
         block_name, set_point = "TEST_BLOCK", 10
@@ -784,7 +818,14 @@ class TestSetBlockMethod(unittest.TestCase):
     @patch("genie_python.genie_epics_api.Wrapper")
     @patch("genie_python.genie_epics_api.print")
     def test_WHEN_set_block_value_called_with_wait_and_various_odd_high_lows_THEN_message_printed(
-        self, _, low, high, val, should_warn, mock_print, pv_wrapper
+        self,
+        _,
+        low: int,
+        high: int,
+        val: int,
+        should_warn: bool,
+        mock_print: MagicMock,
+        pv_wrapper: Wrapper,
     ):
         self.api.waitfor = MagicMock()
         block_name, set_point = "TEST_BLOCK", 10

genie_python-25.2.1.2/PKG-INFO

@@ -1,84 +0,0 @@
-Metadata-Version: 2.2
-Name: genie_python
-Version: 25.2.1.2
-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>
-License: BSD 3-Clause License
-        
-        Copyright (c) 2024, ISIS Experiment Controls Computing
-        
-        Redistribution and use in source and binary forms, with or without
-        modification, are permitted provided that the following conditions are met:
-        
-        1. Redistributions of source code must retain the above copyright notice, this
-           list of conditions and the following disclaimer.
-        
-        2. Redistributions in binary form must reproduce the above copyright notice,
-           this list of conditions and the following disclaimer in the documentation
-           and/or other materials provided with the distribution.
-        
-        3. Neither the name of the copyright holder nor the names of its
-           contributors may be used to endorse or promote products derived from
-           this software without specific prior written permission.
-        
-        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
-        AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
-        FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
-        DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
-        SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
-        CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
-        OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-        
-Project-URL: Homepage, https://github.com/isiscomputinggroup/genie
-Project-URL: Bug Reports, https://github.com/isiscomputinggroup/genie/issues
-Project-URL: Source, https://github.com/isiscomputinggroup/genie
-Classifier: Development Status :: 5 - Production/Stable
-Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: BSD License
-Classifier: Programming Language :: Python :: 3.11
-Requires-Python: >=3.11
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: CaChannel
-Requires-Dist: graypy
-Requires-Dist: ipython
-Requires-Dist: mysql-connector-python
-Requires-Dist: numpy
-Requires-Dist: p4p
-Requires-Dist: psutil
-Requires-Dist: pylint
-Requires-Dist: pyright
-Requires-Dist: pywin32; platform_system == "Windows"
-Provides-Extra: plot
-Requires-Dist: matplotlib==3.9.2; extra == "plot"
-Requires-Dist: py4j; extra == "plot"
-Requires-Dist: tornado; extra == "plot"
-Provides-Extra: doc
-Requires-Dist: sphinx; extra == "doc"
-Requires-Dist: sphinx_rtd_theme; extra == "doc"
-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"
-Requires-Dist: pytest-cov; extra == "dev"
-Requires-Dist: ruff>=0.6; extra == "dev"
-
-# genie_python
-
-Instrument control and scripting library at the ISIS Neutron & Muon source.
-
----
-
-Documentation: https://isiscomputinggroup.github.io/genie/genie_python
-
-Source: https://github.com/ISISComputingGroup/genie
-
-PyPi: https://pypi.org/project/genie_python/

genie_python-25.2.1.2/src/genie_python.egg-info/PKG-INFO

@@ -1,84 +0,0 @@
-Metadata-Version: 2.2
-Name: genie_python
-Version: 25.2.1.2
-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>
-License: BSD 3-Clause License
-        
-        Copyright (c) 2024, ISIS Experiment Controls Computing
-        
-        Redistribution and use in source and binary forms, with or without
-        modification, are permitted provided that the following conditions are met:
-        
-        1. Redistributions of source code must retain the above copyright notice, this
-           list of conditions and the following disclaimer.
-        
-        2. Redistributions in binary form must reproduce the above copyright notice,
-           this list of conditions and the following disclaimer in the documentation
-           and/or other materials provided with the distribution.
-        
-        3. Neither the name of the copyright holder nor the names of its
-           contributors may be used to endorse or promote products derived from
-           this software without specific prior written permission.
-        
-        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
-        AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
-        FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
-        DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
-        SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
-        CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
-        OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-        
-Project-URL: Homepage, https://github.com/isiscomputinggroup/genie
-Project-URL: Bug Reports, https://github.com/isiscomputinggroup/genie/issues
-Project-URL: Source, https://github.com/isiscomputinggroup/genie
-Classifier: Development Status :: 5 - Production/Stable
-Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: BSD License
-Classifier: Programming Language :: Python :: 3.11
-Requires-Python: >=3.11
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: CaChannel
-Requires-Dist: graypy
-Requires-Dist: ipython
-Requires-Dist: mysql-connector-python
-Requires-Dist: numpy
-Requires-Dist: p4p
-Requires-Dist: psutil
-Requires-Dist: pylint
-Requires-Dist: pyright
-Requires-Dist: pywin32; platform_system == "Windows"
-Provides-Extra: plot
-Requires-Dist: matplotlib==3.9.2; extra == "plot"
-Requires-Dist: py4j; extra == "plot"
-Requires-Dist: tornado; extra == "plot"
-Provides-Extra: doc
-Requires-Dist: sphinx; extra == "doc"
-Requires-Dist: sphinx_rtd_theme; extra == "doc"
-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"
-Requires-Dist: pytest-cov; extra == "dev"
-Requires-Dist: ruff>=0.6; extra == "dev"
-
-# genie_python
-
-Instrument control and scripting library at the ISIS Neutron & Muon source.
-
----
-
-Documentation: https://isiscomputinggroup.github.io/genie/genie_python
-
-Source: https://github.com/ISISComputingGroup/genie
-
-PyPi: https://pypi.org/project/genie_python/