bec/ophyd_devices
0
0
Fork 0
mirror of https://github.com/bec-project/ophyd_devices.git synced 2025-05-28 23:50:42 +02:00
Code Issues Packages Projects Releases Wiki Activity

fix: fix sim camera complete call, improve typhints for psi device base

Browse Source
This commit is contained in:
appel_c 2025-03-06 12:52:47 +01:00
parent 7baba53c35
commit 8cdcfe7a44
2 changed files with 25 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

45
ophyd_devices/interfaces/base_classes/psi_device_base.py
View File

@ -1,10 +1,10 @@
""" """
Consider using the bec_device_base name for the base class. Base class for all PSI ophyd device integration to ensure consistent configuration
I will use this name instead here to simplify comparisons between the two approaches
""" """
from __future__ import annotations from __future__ import annotations
from bec_lib.devicemanager import ScanInfo
from ophyd import Device, DeviceStatus, Staged, StatusBase from ophyd import Device, DeviceStatus, Staged, StatusBase
from ophyd_devices.tests.utils import get_mock_scan_info from ophyd_devices.tests.utils import get_mock_scan_info
@ -29,7 +29,7 @@ class PSIDeviceBase(Device):
SUB_DEVICE_MONITOR_2D = "device_monitor_2d" SUB_DEVICE_MONITOR_2D = "device_monitor_2d"
_default_sub = SUB_VALUE _default_sub = SUB_VALUE
def __init__(self, name: str, scan_info=None, **kwargs): def __init__(self, name: str, scan_info: ScanInfo | None = None, **kwargs): # type: ignore
""" """
Initialize the PSI Device Base class. Initialize the PSI Device Base class.
@ -73,37 +73,37 @@ class PSIDeviceBase(Device):
# Wrapper around Device class methods # # Wrapper around Device class methods #
######################################## ########################################
def stage(self) -> list[object] | StatusBase: def stage(self) -> list[object] | DeviceStatus | StatusBase: # type: ignore
"""Stage the device.""" """Stage the device."""
if self.staged != Staged.no: if self.staged != Staged.no:
return super().stage() return super().stage()
self.stopped = False self.stopped = False
super_staged = super().stage() super_staged = super().stage()
status = self.on_stage() # pylint: disable=assignment-from-no-return status = self.on_stage() # pylint: disable=assignment-from-no-return
if isinstance(status, StatusBase): if isinstance(status, DeviceStatus):
return status return status
return super_staged return super_staged
def unstage(self) -> list[object] | StatusBase: def unstage(self) -> list[object] | DeviceStatus | StatusBase: # type: ignore
"""Unstage the device.""" """Unstage the device."""
super_unstage = super().unstage() super_unstage = super().unstage()
status = self.on_unstage() # pylint: disable=assignment-from-no-return status = self.on_unstage() # pylint: disable=assignment-from-no-return
if isinstance(status, StatusBase): if isinstance(status, DeviceStatus):
return status return status
return super_unstage return super_unstage
def pre_scan(self) -> StatusBase | None: def pre_scan(self) -> DeviceStatus | StatusBase | None:
"""Pre-scan function.""" """Pre-scan function."""
status = self.on_pre_scan() # pylint: disable=assignment-from-no-return status = self.on_pre_scan() # pylint: disable=assignment-from-no-return
return status return status
def trigger(self) -> DeviceStatus: def trigger(self) -> DeviceStatus | StatusBase:
"""Trigger the device.""" """Trigger the device."""
super_trigger = super().trigger() super_trigger = super().trigger()
status = self.on_trigger() # pylint: disable=assignment-from-no-return status = self.on_trigger() # pylint: disable=assignment-from-no-return
return status if status else super_trigger return status if status else super_trigger
def complete(self) -> DeviceStatus: def complete(self) -> DeviceStatus | StatusBase:
"""Complete the device.""" """Complete the device."""
status = self.on_complete() # pylint: disable=assignment-from-no-return status = self.on_complete() # pylint: disable=assignment-from-no-return
if isinstance(status, StatusBase): if isinstance(status, StatusBase):
@ -112,7 +112,7 @@ class PSIDeviceBase(Device):
status.set_finished() status.set_finished()
return status return status
def kickoff(self) -> DeviceStatus: def kickoff(self) -> DeviceStatus | StatusBase:
"""Kickoff the device.""" """Kickoff the device."""
status = self.on_kickoff() # pylint: disable=assignment-from-no-return status = self.on_kickoff() # pylint: disable=assignment-from-no-return
if isinstance(status, StatusBase): if isinstance(status, StatusBase):
@ -121,12 +121,11 @@ class PSIDeviceBase(Device):
status.set_finished() status.set_finished()
return status return status
# pylint: disable=arguments-differ def stop(self, *, success: bool = False) -> None:
def stop(self, success: bool = False) -> None:
"""Stop the device. """Stop the device.
Args: Args:
success (bool): True if the device was stopped successfully. success (bool): True if the action was successful, False otherwise.
""" """
self.on_stop() self.on_stop()
super().stop(success=success) super().stop(success=success)
@ -140,8 +139,8 @@ class PSIDeviceBase(Device):
""" """
Called when the device is initialized. Called when the device is initialized.
No siganls are connected at this point, No signals are connected at this point. If you like to
thus should not be set here but in on_connected instead. set default values on signals, please use on_connected instead.
""" """
def on_connected(self) -> None: def on_connected(self) -> None:
@ -150,26 +149,26 @@ class PSIDeviceBase(Device):
Default values for signals should be set here. Default values for signals should be set here.
""" """
def on_stage(self) -> DeviceStatus | None: def on_stage(self) -> DeviceStatus | StatusBase | None:
""" """
Called while staging the device. Called while staging the device.
Information about the upcoming scan can be accessed from the scan_info object. Information about the upcoming scan can be accessed from the scan_info (self.scan_info.msg) object.
""" """
def on_unstage(self) -> DeviceStatus | None: def on_unstage(self) -> DeviceStatus | StatusBase | None:
"""Called while unstaging the device.""" """Called while unstaging the device."""
def on_pre_scan(self) -> DeviceStatus | None: def on_pre_scan(self) -> DeviceStatus | StatusBase | None:
"""Called right before the scan starts on all devices automatically.""" """Called right before the scan starts on all devices automatically."""
def on_trigger(self) -> DeviceStatus | None: def on_trigger(self) -> DeviceStatus | StatusBase | None:
"""Called when the device is triggered.""" """Called when the device is triggered."""
def on_complete(self) -> DeviceStatus | None: def on_complete(self) -> DeviceStatus | StatusBase | None:
"""Called to inquire if a device has completed a scans.""" """Called to inquire if a device has completed a scans."""
def on_kickoff(self) -> DeviceStatus | None: def on_kickoff(self) -> DeviceStatus | StatusBase | None:
"""Called to kickoff a device for a fly scan. Has to be called explicitly.""" """Called to kickoff a device for a fly scan. Has to be called explicitly."""
def on_stop(self) -> None: def on_stop(self) -> None:

5
ophyd_devices/sim/sim_camera.py
View File

@ -131,10 +131,11 @@ class SimCamera(PSIDeviceBase, SimCameraControl):
def on_complete(self) -> StatusBase: def on_complete(self) -> StatusBase:
"""Complete the motion of the simulated device.""" """Complete the motion of the simulated device."""
if not self.write_to_disk.get():
return None
def complete_cam(): def complete_cam():
"""Complete the camera acquisition.""" """Complete the camera acquisition."""
if self.write_to_disk.get():
self.h5_writer.on_complete()
self._run_subs( self._run_subs(
sub_type=self.SUB_FILE_EVENT, sub_type=self.SUB_FILE_EVENT,
file_path=self.file_path, file_path=self.file_path,