bec-server 2.5.0__tar.gz → 2.7.0__tar.gz

{bec_server-2.5.0 → bec_server-2.7.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: bec-server
-Version: 2.5.0
+Version: 2.7.0
 Summary: BEC server
 Project-URL: Bug Tracker, https://gitlab.psi.ch/bec/bec/issues
 Project-URL: Homepage, https://gitlab.psi.ch/bec/bec
@@ -22,7 +22,6 @@ Requires-Dist: pydantic
 Requires-Dist: python-dotenv
 Requires-Dist: pyyaml
 Requires-Dist: rich
-Requires-Dist: xmltodict
 Provides-Extra: dev
 Requires-Dist: black; extra == 'dev'
 Requires-Dist: coverage; extra == 'dev'

{bec_server-2.5.0 → bec_server-2.7.0}/bec_server/bec_server_utils/subprocess_launch.py

@@ -11,14 +11,7 @@ def subprocess_start(bec_path: str, config_path: str, services: dict):
         cwd = os.path.abspath(os.path.join(service_path, ".."))
         if config_path:
             processes.append(
-                subprocess.Popen(
-                    (
-                        service_config["command"],
-                        "--config",
-                        config_path,
-                    ),
-                    cwd=cwd,
-                )
+                subprocess.Popen((service_config["command"], "--config", config_path), cwd=cwd)
             )
         else:
             processes.append(subprocess.Popen((service_config["command"],), cwd=cwd))

{bec_server-2.5.0 → bec_server-2.7.0}/bec_server/device_server/devices/devicemanager.py

@@ -13,7 +13,6 @@ from functools import reduce
 
 import numpy as np
 import ophyd
-import ophyd.sim as ops
 import ophyd_devices as opd
 from ophyd.ophydobj import OphydObject
 from ophyd.signal import EpicsSignalBase
@@ -27,16 +26,11 @@ from bec_lib import (
     MessageEndpoints,
     bec_logger,
     messages,
+    plugin_helper,
 )
 from bec_server.device_server.devices.config_update_handler import ConfigUpdateHandler
 from bec_server.device_server.devices.device_serializer import get_device_info
 
-try:
-    from bec_plugins import devices as plugin_devices
-except ImportError:
-    plugin_devices = None
-
-
 logger = bec_logger.logger
 
 
@@ -118,30 +112,8 @@ class DeviceManagerDS(DeviceManagerBase):
 
     @staticmethod
     def _get_device_class(dev_type: str) -> type:
-        """
-        Return the class object from 'dev_type' string in the form '[module:][submodule:]class_name'
-        The class is looked after in ophyd devices[.module][.submodule] first, if it is not
-        present plugin_devices, ophyd, ophyd_devices.sim are searched too
-
-        Args:
-            dev_type (str): device type string
-
-        Returns:
-            type: class object
-        """
-        submodule, _, class_name = dev_type.rpartition(":")
-        if submodule:
-            submodule = f".{submodule.replace(':', '.')}"
-        for parent_module in (opd, plugin_devices, ophyd, ops):
-            try:
-                module = __import__(f"{parent_module.__name__}{submodule}", fromlist=[""])
-            except ModuleNotFoundError:
-                continue
-            else:
-                break
-        else:
-            raise TypeError(f"Unknown device class {dev_type}")
-        return getattr(module, class_name)
+        """Get the device class from the device type"""
+        return plugin_helper.get_plugin_class(dev_type, [opd, ophyd])
 
     def _load_session(self, *_args, **_kwargs):
         delayed_init = []

bec_server-2.7.0/bec_server/device_server/tests/utils.py

@@ -0,0 +1,55 @@
+from bec_lib.devicemanager import DeviceContainer
+from bec_lib.tests.utils import ConnectorMock
+
+
+# pylint: disable=missing-function-docstring
+# pylint: disable=protected-access
+class DeviceMock:
+    def __init__(self, name: str, value=None):
+        self.name = name
+        self.read_buffer = {self.name: {"value": value}} if value is not None else None
+        self._config = {"deviceConfig": {"limits": [-50, 50]}, "userParameter": None}
+        self._read_only = False
+        self._enabled = True
+
+    def read(self):
+        return self.read_buffer
+
+    def readback(self):
+        return self.read_buffer
+
+    @property
+    def obj(self):
+        return self
+
+    @property
+    def limits(self):
+        return self._config["deviceConfig"]["limits"]
+
+    @property
+    def read_only(self) -> bool:
+        return self._read_only
+
+    @read_only.setter
+    def read_only(self, val: bool):
+        self._read_only = val
+
+    @property
+    def enabled(self) -> bool:
+        return self._enabled
+
+    @enabled.setter
+    def enabled(self, val: bool):
+        self._enabled = val
+
+    @property
+    def user_parameter(self):
+        return self._config["userParameter"]
+
+
+class DMMock:
+    devices = DeviceContainer()
+    connector = ConnectorMock()
+
+    def add_device(self, name, value=None):
+        self.devices[name] = DeviceMock(name, value=value)

{bec_server-2.5.0 → bec_server-2.7.0}/bec_server/file_writer/__init__.py

@@ -1,3 +1,3 @@
 from .cli.launch import main
-from .file_writer import NexusFileWriter, NeXusFileXMLWriter
+from .file_writer import NexusFileWriter
 from .file_writer_manager import FileWriterManager

{bec_server-2.5.0 → bec_server-2.7.0}/bec_server/file_writer/cli/launch.py

@@ -23,9 +23,6 @@ def main():
     config = ServiceConfig(config_path)
 
     file_writer_manager = file_writer.FileWriterManager(config, RedisConnector)
-    file_writer_manager.file_writer.configure(
-        layout_file=os.path.abspath("./layout_cSAXS_NXsas.xml")
-    )
     try:
         event = threading.Event()
         logger.success("Started FileWriter")

{bec_server-2.5.0 → bec_server-2.7.0}/bec_server/file_writer/file_writer.py

@@ -8,11 +8,10 @@ import traceback
 import typing
 
 import h5py
-import xmltodict
 
-import bec_server.file_writer_plugins as fwp
-from bec_lib import MessageEndpoints, bec_logger, messages
+from bec_lib import MessageEndpoints, bec_logger, messages, plugin_helper
 
+from .default_writer import NeXus_format as default_NeXus_format
 from .merged_dicts import merge_dicts
 
 logger = bec_logger.logger
@@ -49,107 +48,6 @@ class FileWriter(abc.ABC):
         return device_storage
 
 
-class XMLWriter:
-    @staticmethod
-    def get_type(type_string: str):
-        if type_string == "float":
-            return float
-        if type_string == "string":
-            return str
-        if type_string == "int":
-            return int
-        raise NeXusLayoutError(f"Unsupported data type {type_string}.")
-
-    def get_value(self, value, entry, source, data_type):
-        if source == "constant":
-            if data_type:
-                return self.get_type(data_type)(value)
-            return value
-        return entry
-
-    def add_group(self, container, val):
-        name = val.pop("@name")
-        group = container.create_group(name)
-        self.add_content(group, val)
-
-    def add_dataset(self, container, val):
-        name = val.pop("@name")
-        source = val.pop("@source")
-        value = val.pop("@value", None)
-        data_type = val.pop("@type", None)
-        entry = val.pop("@entry", None)
-
-        data = self.get_value(value=value, entry=entry, source=source, data_type=data_type)
-        if data is None:
-            return
-        dataset = container.create_dataset(name, data=data)
-        self.add_content(dataset, val)
-        return
-
-    def add_attribute(self, container, val):
-        name = val.pop("@name")
-        source = val.pop("@source")
-        value = val.pop("@value", None)
-        data_type = val.pop("@type", None)
-        entry = val.pop("@entry", None)
-
-        data = self.get_value(value=value, entry=entry, source=source, data_type=data_type)
-        setattr(container.attrs, name, data)
-
-    def add_hardlink(self, container, val):
-        pass
-
-    def add_softlink(self, container, val):
-        pass
-
-    def add_content(self, container, layout):
-        for key, values in layout.items():
-            if not isinstance(values, list):
-                values = [values]
-            for val in values:
-                if key == "group":
-                    self.add_group(container, val)
-                elif key == "hdf5_layout":
-                    self.add_base_entry(container, val)
-                elif key == "attribute":
-                    self.add_attribute(container, val)
-                elif key == "dataset":
-                    self.add_dataset(container, val)
-                elif key == "hardlink":
-                    self.add_hardlink(container, val)
-                elif key == "softlink":
-                    self.add_softlink(container, val)
-                else:
-                    pass
-                    # raise NeXusLayoutError()
-
-    def add_base_entry(self, container, val):
-        self.add_group(container, val["group"])
-
-
-class NeXusFileXMLWriter(FileWriter, XMLWriter):
-    def configure(self, layout_file, **kwargs):
-        self.layout_file = layout_file
-        with open(self.layout_file, "br") as f:
-            self.layout = xmltodict.parse(f)
-
-    def get_value(self, value, entry, source, data_type):
-        if source == "constant":
-            if data_type:
-                return self.get_type(data_type)(value)
-            return value
-        if source == "bec":
-            return self.data.get(entry)
-        return entry
-
-    def write(self, file_path: str, data):
-        print(f"writing file to {file_path}")
-        self.data = self._create_device_data_storage(data)
-
-        with h5py.File(file_path, "w") as file:
-            self.add_content(file, self.layout)
-
-
 class HDF5Storage:
     """
     The HDF5Storage class is a container used by the HDF5 writer plugins to store data in the correct NeXus format.
@@ -310,7 +208,16 @@ class NexusFileWriter(FileWriter):
             ).isoformat()
         if data.end_time is not None:
             device_storage["end_time"] = datetime.datetime.fromtimestamp(data.end_time).isoformat()
-        writer_format = getattr(fwp, self.file_writer_manager.file_writer_config.get("plugin"))
+
+        requested_plugin = self.file_writer_manager.file_writer_config.get("plugin")
+        if requested_plugin == "default_NeXus_format":
+            writer_format = default_NeXus_format
+        else:
+            plugins = plugin_helper.get_file_writer_plugins()
+            if requested_plugin not in plugins:
+                logger.error(f"Plugin {requested_plugin} not found. Using default plugin.")
+                writer_format = default_NeXus_format
+
         for file_ref in data.file_references.values():
             rel_path = os.path.relpath(file_ref["path"], os.path.dirname(file_path))
             file_ref["path"] = rel_path

bec_server-2.7.0/bec_server/file_writer_plugins/__init__.py

@@ -0,0 +1 @@
+from .cSAXS import NeXus_format as cSAXS_NeXus_format

{bec_server-2.5.0 → bec_server-2.7.0}/bec_server/scan_server/scan_guard.py

@@ -26,9 +26,7 @@ class ScanGuard:
         self.connector = self.parent.connector
 
         self.connector.register(
-            MessageEndpoints.scan_queue_request(),
-            cb=self._scan_queue_request_callback,
-            parent=self,
+            MessageEndpoints.scan_queue_request(), cb=self._scan_queue_request_callback, parent=self
         )
 
         self.connector.register(
@@ -127,9 +125,7 @@ class ScanGuard:
         """
         sqrr = MessageEndpoints.scan_queue_request_response()
         rrm = messages.RequestResponseMessage(
-            accepted=scan_status.accepted,
-            message=scan_status.message,
-            metadata=metadata,
+            accepted=scan_status.accepted, message=scan_status.message, metadata=metadata
         )
         self.device_manager.connector.send(sqrr, rrm)
 

{bec_server-2.5.0 → bec_server-2.7.0}/bec_server/scan_server/scan_manager.py

@@ -1,11 +1,6 @@
-import glob
-import importlib
-import importlib.util
 import inspect
-import os
-from pathlib import Path
 
-from bec_lib import MessageEndpoints, bec_logger
+from bec_lib import MessageEndpoints, bec_logger, plugin_helper
 from bec_lib.messages import AvailableResourceMessage
 from bec_lib.signature_serializer import signature_to_dict
 
@@ -15,7 +10,6 @@ logger = bec_logger.logger
 
 
 class ScanManager:
-    DEFAULT_PLUGIN_PATH = Path(os.path.dirname(os.path.abspath(__file__)) + "/../../").resolve()
 
     def __init__(self, *, parent):
         """
@@ -31,30 +25,17 @@ class ScanManager:
 
     def load_plugins(self):
         """load scan plugins"""
-        plugin_path = os.environ.get("BEC_PLUGIN_PATH")
-        if not plugin_path:
-            logger.info("BEC_PLUGIN_PATH not set. Using default plugin path.")
-            plugin_path = self.DEFAULT_PLUGIN_PATH
-        else:
-            logger.info(f"Using plugin path {plugin_path}")
-        plugin_path = os.path.join(plugin_path, "scan_server/scan_plugins")
-        files = glob.glob(os.path.join(plugin_path, "*.py"))
-        for file in files:
-            if file.endswith("__init__.py"):
+        plugins = plugin_helper.get_scan_plugins()
+        if not plugins:
+            return
+        for name, cls in plugins.items():
+            if not issubclass(cls, ScanServerScans.RequestBase):
+                logger.error(
+                    f"Plugin {name} is not a valid scan plugin as it does not inherit from RequestBase. Skipping."
+                )
                 continue
-            module_spec = importlib.util.spec_from_file_location("scan_plugins", file)
-            plugin_module = importlib.util.module_from_spec(module_spec)
-            module_spec.loader.exec_module(plugin_module)
-            module_members = inspect.getmembers(plugin_module)
-            for name, cls in module_members:
-                if not inspect.isclass(cls):
-                    continue
-                # ignore imported classes
-                if cls.__module__ != "scan_plugins":
-                    continue
-                if issubclass(cls, ScanServerScans.RequestBase):
-                    self._plugins[name] = cls
-                    logger.info(f"Loading scan plugin {name}")
+            self._plugins[name] = cls
+            logger.info(f"Loading scan plugin {name}")
 
     def update_available_scans(self):
         """load all scans and plugin scans"""

bec_server-2.7.0/bec_server/scan_server/scan_plugins/__init__.py

@@ -0,0 +1 @@
+from .otf_scan import OTFScan

bec_server-2.7.0/bec_server/scan_server/tests/fixtures.py

@@ -0,0 +1,14 @@
+import pytest
+
+from bec_lib.logger import bec_logger
+from bec_lib.tests.fixtures import dm_with_devices
+from bec_server.scan_server.tests.utils import ScanServerMock
+
+
+# pylint: disable=missing-function-docstring
+# pylint: disable=protected-access
+@pytest.fixture
+def scan_server_mock(dm_with_devices):
+    server = ScanServerMock(dm_with_devices)
+    yield server
+    bec_logger.logger.remove()

{bec_server-2.5.0/tests/tests_scan_server → bec_server-2.7.0/bec_server/scan_server/tests}/utils.py

@@ -1,8 +1,4 @@
-import pytest
-
 from bec_lib import ServiceConfig
-from bec_lib.devicemanager import DeviceContainer
-from bec_lib.logger import bec_logger
 from bec_lib.messages import BECStatus
 from bec_lib.tests.utils import ConnectorMock
 from bec_server.scan_server.scan_server import ScanServer
@@ -12,13 +8,6 @@ from bec_server.scan_server.scan_worker import InstructionQueueStatus
 # pylint: disable=protected-access
 
 
-@pytest.fixture
-def scan_server_mock(dm_with_devices):
-    server = ScanServerMock(dm_with_devices, dm_with_devices.connector)
-    yield server
-    bec_logger.logger.remove()
-
-
 class WorkerMock:
     def __init__(self) -> None:
         self.scan_id = None
@@ -30,7 +19,7 @@ class WorkerMock:
 
 
 class ScanServerMock(ScanServer):
-    def __init__(self, device_manager, connector) -> None:
+    def __init__(self, device_manager) -> None:
         self.device_manager = device_manager
         super().__init__(
             ServiceConfig(redis={"host": "dummy", "port": 6379}), connector_cls=ConnectorMock
@@ -69,50 +58,3 @@ class ScanServerMock(ScanServer):
     @dataset_number.setter
     def dataset_number(self, val: int):
         pass
-
-
-class DeviceMock:
-    def __init__(self, name: str):
-        self.name = name
-        self.read_buffer = None
-        self._config = {"deviceConfig": {"limits": [-50, 50]}, "userParameter": None}
-        self._read_only = False
-        self._enabled = True
-
-    def read(self):
-        return self.read_buffer
-
-    def readback(self):
-        return self.read_buffer
-
-    @property
-    def limits(self):
-        return self._config["deviceConfig"]["limits"]
-
-    @property
-    def read_only(self) -> bool:
-        return self._read_only
-
-    @read_only.setter
-    def read_only(self, val: bool):
-        self._read_only = val
-
-    @property
-    def enabled(self) -> bool:
-        return self._enabled
-
-    @enabled.setter
-    def enabled(self, val: bool):
-        self._enabled = val
-
-    @property
-    def user_parameter(self):
-        return self._config["userParameter"]
-
-
-class DMMock:
-    devices = DeviceContainer()
-    connector = ConnectorMock()
-
-    def add_device(self, name):
-        self.devices[name] = DeviceMock(name)

{bec_server-2.5.0 → bec_server-2.7.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "bec-server"
-version = "2.5.0"
+version = "2.7.0"
 description = "BEC server"
 requires-python = ">=3.10"
 classifiers = [
@@ -27,7 +27,6 @@ dependencies = [
     "pyyaml",
     "python-dotenv",
     "rich",
-    "xmltodict",
 ]
 
 [project.optional-dependencies]

{bec_server-2.5.0 → bec_server-2.7.0}/tests/tests_file_writer/test_file_writer.py

@@ -9,7 +9,7 @@ from test_file_writer_manager import file_writer_manager_mock
 
 from bec_lib.tests.fixtures import dm_with_devices
 from bec_server import file_writer
-from bec_server.file_writer import NexusFileWriter, NeXusFileXMLWriter
+from bec_server.file_writer import NexusFileWriter
 from bec_server.file_writer.file_writer import HDF5Storage
 from bec_server.file_writer.file_writer_manager import ScanStorage
 from bec_server.file_writer_plugins.cSAXS import NeXus_format as cSAXS_Nexus_format

{bec_server-2.5.0 → bec_server-2.7.0}/tests/tests_scan_server/test_scan_guard.py

@@ -1,11 +1,11 @@
 from unittest import mock
 
 import pytest
-from utils import scan_server_mock
 
 from bec_lib import MessageEndpoints, messages
 from bec_lib.redis_connector import MessageObject
 from bec_server.scan_server.scan_guard import ScanGuard, ScanRejection, ScanStatus
+from bec_server.scan_server.tests.fixtures import scan_server_mock
 
 
 @pytest.fixture

{bec_server-2.5.0 → bec_server-2.7.0}/tests/tests_scan_server/test_scan_server_queue.py

@@ -2,7 +2,6 @@ import uuid
 from unittest import mock
 
 import pytest
-from utils import scan_server_mock
 
 from bec_lib import Alarms, MessageEndpoints, messages
 from bec_lib.redis_connector import MessageObject
@@ -17,6 +16,7 @@ from bec_server.scan_server.scan_queue import (
     ScanQueueStatus,
 )
 from bec_server.scan_server.scan_worker import ScanWorker
+from bec_server.scan_server.tests.fixtures import scan_server_mock
 
 # pylint: disable=missing-function-docstring
 # pylint: disable=protected-access

{bec_server-2.5.0 → bec_server-2.7.0}/tests/tests_scan_server/test_scan_worker.py

@@ -3,7 +3,6 @@ import uuid
 from unittest import mock
 
 import pytest
-from utils import scan_server_mock
 
 from bec_lib import MessageEndpoints, messages
 from bec_lib.tests.utils import ConnectorMock
@@ -18,6 +17,7 @@ from bec_server.scan_server.scan_queue import (
     ScanQueue,
 )
 from bec_server.scan_server.scan_worker import ScanWorker
+from bec_server.scan_server.tests.fixtures import scan_server_mock
 
 
 @pytest.fixture