mxcubecore 1.329.0__py3-none-any.whl → 1.330.0__py3-none-any.whl

mxcubecore/HardwareObjects/ESRF/ESRFXRFSpectrum.py

@@ -38,12 +38,13 @@ __copyright__ = """ Copyright © by the MXCuBE collaboration """
 __license__ = "LGPLv3+"
 
 import logging
-import os.path
 from ast import literal_eval
+from pathlib import Path
+from shutil import copy2
 from unittest.mock import MagicMock
 from warnings import warn
 
-import numpy
+import numpy as np
 from PyMca5.PyMca import (
     ClassMcaTheory,
     ConfigDict,
@@ -62,7 +63,7 @@ class ESRFXRFSpectrum(AbstractXRFSpectrum):
     def __init__(self, name):
         super().__init__(name)
         self.cfgfile = None
-        self.config_fit = None
+        self.config = None
         self.ctrl_hwobj = None
         self.mcafit = None
         self.default_erange = None
@@ -73,15 +74,16 @@ class ESRFXRFSpectrum(AbstractXRFSpectrum):
         super().init()
         self.ctrl_hwobj = self.get_object_by_role("controller")
         self.cfgfile = self.get_property(
-            "cfgfile", "/users/blissadm/local/beamline_configuration/misc/15keV.cfg"
+            "cfgfile",
+            "/users/blissadm/local/beamline_configuration/misc/15keV.cfg",
         )
-        self.config_fit = ConfigDict.ConfigDict()
+        self.config = ConfigDict.ConfigDict()
         self.mcafit = ClassMcaTheory.McaTheory(self.cfgfile)
         self.default_erange = literal_eval(
-            self.get_property("default_energy_range", "[2.0, 15.0]")
+            self.get_property("default_energy_range", "[2.0, 15.0]"),
         )
         self.cfg_energies = literal_eval(
-            self.get_property("cfg_energies", "[7, 9, 12, 15]")
+            self.get_property("cfg_energies", "[7, 9, 12, 15]"),
         )
 
     def _doSpectrum(self, ctime, filename):
@@ -92,14 +94,18 @@ class ESRFXRFSpectrum(AbstractXRFSpectrum):
         )
         return self._execute_spectrum(ctime, filename)
 
-    def _execute_spectrum(self, integration_time=None, filename=None):
+    def _execute_spectrum(
+        self,
+        integration_time: float | None = None,
+        filename: str | None = None,
+    ) -> bool:
         """Local XRF spectrum sequence.
 
         Args:
-            integration_time (float): MCA integration time [s].
-            filename (str): Data file (full path).
+            integration_time: MCA integration time [s].
+            filename: Data file (full path).
         Returns:
-            (bool): Procedure executed correctly (True) or error (False)
+            Procedure executed correctly (True) or error (False)
         """
         filename = filename or self.spectrum_info_dict["filename"]
         integration_time = integration_time or self.default_integration_time
@@ -124,13 +130,13 @@ class ESRFXRFSpectrum(AbstractXRFSpectrum):
 
     # Next methods are for fitting the data with pymca
 
-    def mcafit_configuration(self, config=None):
+    def mcafit_configuration(self, config: dict | None = None):
         """Configure the fitting parameters. The procedure is time consuming.
            It is only executed if the last configuration file is not the same.
 
         Args:
-            config(dict): Configuration dictionary, containing among others the
-                          configuration file name.
+            config: Configuration dictionary, containing among others the
+                    configuration file name.
         """
         change = False
         if not config or "file" not in config:
@@ -141,33 +147,36 @@ class ESRFXRFSpectrum(AbstractXRFSpectrum):
         if self.cfgfile != cfgfile:
             self.cfgfile = cfgfile
             change = True
-        self.config_fit.read(self.cfgfile)
-        if "concentrations" not in self.config_fit:
-            self.config_fit["concentrations"] = {}
+        self.config.read(self.cfgfile)
+        if "concentrations" not in self.config:
+            self.config["concentrations"] = {}
             change = True
-        if "attenuators" not in self.config_fit:
-            self.config_fit["attenuators"] = {
-                "Matrix": [1, "Water", 1.0, 0.01, 45.0, 45.0]
-            }
+        if "attenuators" not in self.config:
+            self.config["attenuators"] = {"Matrix": [1, "Water", 1.0, 0.01, 45.0, 45.0]}
             change = True
         if "flux" in config:
-            self.config_fit["concentrations"]["flux"] = float(config["flux"])
+            self.config["concentrations"]["flux"] = float(config["flux"])
             change = True
         if "time" in config:
-            self.config_fit["concentrations"]["time"] = float(config["time"])
+            self.config["concentrations"]["time"] = float(config["time"])
             change = True
 
         if change:
-            self.mcafit.configure(self.config_fit)
-
-    def spectrum_analyse(self, data=None, calib=None, config=None):
+            self.mcafit.configure(self.config)
+
+    def spectrum_analyse(
+        self,
+        data: list | None = None,
+        calib: list | None = None,
+        config: dict | None = None,
+    ) -> bool:
         """Execute the fitting. Write the fitted data files to the archive
         directory.
 
         Args:
-            data (list): The raw data.
-            calib (list): The mca calibration.
-            config (dict): The configuration dictionary.
+            data: The raw data.
+            calib: The mca calibration.
+            config: The configuration dictionary.
         """
 
         if not config:
@@ -177,9 +186,9 @@ class ESRFXRFSpectrum(AbstractXRFSpectrum):
                 "bsX": self.spectrum_info_dict["beamSizeHorizontal"],
                 "bsY": self.spectrum_info_dict["beamSizeVertical"],
                 "legend": self.spectrum_info_dict["annotatedPymcaXfeSpectrum"],
-                "htmldir": os.path.split(
-                    self.spectrum_info_dict["annotatedPymcaXfeSpectrum"]
-                )[0],
+                "htmldir": Path(
+                    self.spectrum_info_dict["annotatedPymcaXfeSpectrum"],
+                ).parent,
             }
 
         self.mcafit_configuration(config)
@@ -191,15 +200,15 @@ class ESRFXRFSpectrum(AbstractXRFSpectrum):
 
         try:
             if data[0].size == 2:
-                xdata = numpy.array(data[:, 0]) * 1.0
-                ydata = numpy.array(data[:, 1])
+                xdata = np.array(data[:, 0]) * 1.0
+                ydata = np.array(data[:, 1])
             else:
                 xdata = data[0] * 1.0
                 ydata = data[1]
 
             try:
-                xmin = self.config_fit["fit"]["xmin"]
-                xmax = self.config_fit["fit"]["xmax"]
+                xmin = self.config["fit"]["xmin"]
+                xmax = self.config["fit"]["xmax"]
             except KeyError:
                 xmin = data[0][0]
                 xmax = data[0][-1]
@@ -211,19 +220,26 @@ class ESRFXRFSpectrum(AbstractXRFSpectrum):
             if fitresult:
                 fitresult = {"fitresult": fitresult[0], "result": fitresult[1]}
 
-                # write the csv file to pyarch
+                # create the gallery directory
+                new_dir = Path(self.spectrum_info_dict["filename"]).parent / "gallery"
+                if not self.create_directory(new_dir):
+                    self.update_state(self.STATES.FAULT)
+                    return False
+
+                # write the csv file to pyarch and gallery
                 csvname = self.spectrum_info_dict["fittedDataFileFullPath"]
                 self._write_csv_file(fitresult["result"], csvname)
+                copy2(csvname, new_dir / Path(csvname).name)
 
                 # write html report to pyarch
-                fname = os.path.basename(self.spectrum_info_dict["filename"])
+                fname = Path(self.spectrum_info_dict["filename"]).name
                 outfile = fname.split(".")[0]
-                outdir = os.path.dirname(
-                    self.spectrum_info_dict["annotatedPymcaXfeSpectrum"]
-                )
+                outdir = Path(
+                    self.spectrum_info_dict["annotatedPymcaXfeSpectrum"],
+                ).parent
 
                 _kw = {
-                    "outdir": outdir,
+                    "outdir": str(outdir),
                     "outfile": outfile,
                     "fitresult": fitresult,
                     "plotdict": {"logy": False},
@@ -232,6 +248,13 @@ class ESRFXRFSpectrum(AbstractXRFSpectrum):
                 report = QtMcaAdvancedFitReport.QtMcaAdvancedFitReport(**_kw)
                 text = report.getText()
                 report.writeReport(text=text)
+
+                # copy png file to galery
+                copy2(
+                    self.spectrum_info_dict["jpegScanFileFullPath"],
+                    new_dir,
+                )
+
                 return True
             return False
         except Exception as exp:
@@ -241,17 +264,17 @@ class ESRFXRFSpectrum(AbstractXRFSpectrum):
             self.spectrum_command_failed()
             return False
 
-    def _write_csv_file(self, fitresult, fname=None):
+    def _write_csv_file(self, fitresult: dict, fname: str | None = None):
         """Write fitted data to a csv file.
 
         Args:
-            fitresult(dict): Data as dictionary.
+            fitresult: Data as dictionary.
         Kwargs:
-            fname (str): Filename to write to (full path).
+            fname: Filename to write to (full path).
         """
         fname = fname or self.spectrum_info_dict["fittedDataFileFullPath"]
-        if os.path.exists(fname):
-            os.remove(fname)
+        if Path(fname).exists():
+            Path(fname).unlink()
 
         # get the significant peaks
         peaks_dict = {}
@@ -283,7 +306,7 @@ class ESRFXRFSpectrum(AbstractXRFSpectrum):
             header += delimiter + f'"{key}"'
 
         # logging.getLogger("user_level_log").info("Writing %s" % fname)
-        with open(fname, "w") as csv_fd:
+        with Path(fname).open("w") as csv_fd:
             csv_fd.write(header)
             csv_fd.write("\n")
             for i in range(fitresult["xdata"].size):
@@ -301,23 +324,21 @@ class ESRFXRFSpectrum(AbstractXRFSpectrum):
                         fitresult["continuum"][i],
                         delimiter,
                         fitresult["pileup"][i],
-                    )
+                    ),
                 )
                 for val in peaks_dict.values():
                     csv_fd.write(f"{delimiter}{val[i]:.7g}")
 
                 csv_fd.write("\n")
 
-    def _get_cfgfile(self, energy):
+    def _get_cfgfile(self, energy: float) -> str:
         """Get the correct configuration file.
 
         Args:
             energy(float): The energy to choose which configuration file.
         """
         self.cfg_energies.sort()
-
-        cfg_path = os.path.split(self.cfgfile)[0]
         for egy in self.cfg_energies:
             if egy > energy:
-                return os.path.join(cfg_path, f"{str(egy)}keV.cfg")
-        return self.cfgfile
+                return str(Path(self.cfgfile).parent / f"{egy}keV.cfg")
+        return str(self.cfgfile)

mxcubecore/HardwareObjects/ESRFLIMS.py

@@ -24,7 +24,7 @@ class ESRFLIMS(AbstractLims):
         self.ispyb = self.get_object_by_role("ispyb")
 
         self.is_local_host = False
-        self.active_lims = self.drac.get_lims_name()
+        self.active_lims = self.drac.get_lims_name()[0]
 
     def get_lims_name(self) -> List[Lims]:
         return self.drac.get_lims_name() + self.ispyb.get_lims_name()
@@ -225,8 +225,8 @@ class ESRFLIMS(AbstractLims):
     def allow_session(self, session: Session):
         return self.drac.allow_session(session)
 
-    def get_session_by_id(self, id: str):
-        return self.drac.get_session_by_id(id)
+    def get_session_by_id(self, sid: str):
+        return self.drac.get_session_by_id(sid)
 
     def get_user_name(self):
         return self.drac.get_user_name()
@@ -252,11 +252,13 @@ class ESRFLIMS(AbstractLims):
 
     def store_energy_scan(self, energyscan_dict):
         energyscan_dict["sessionId"] = self.ispyb.get_session_id()
-        return self.ispyb.store_energy_scan(energyscan_dict)
+        self.drac.store_energy_scan(energyscan_dict)
+        return self.ispyb.store_energy_scan(self._clean_sample_id(energyscan_dict))
 
     def store_xfe_spectrum(self, xfespectrum_dict):
         xfespectrum_dict["sessionId"] = self.ispyb.get_session_id()
-        return self.ispyb.store_xfe_spectrum(xfespectrum_dict)
+        self.drac.store_xfe_spectrum(xfespectrum_dict)
+        return self.ispyb.store_xfe_spectrum(self._clean_sample_id(xfespectrum_dict))
 
     def store_workflow(self, *args, **kwargs):
         pass

mxcubecore/HardwareObjects/ICATLIMS.py

@@ -1,9 +1,9 @@
 import json
 import logging
-import pathlib
 import shutil
 from collections import defaultdict
 from datetime import datetime, timedelta
+from pathlib import Path
 from typing import List, Optional
 from zoneinfo import ZoneInfo
 
@@ -82,7 +82,8 @@ class ICATLIMS(AbstractLims):
         sessions = self.to_sessions(self.__get_all_investigations())
 
         if len(sessions) == 0:
-            raise Exception("No sessions available for user %s" % (user_name))
+            msg = f"No sessions available for user {user_name}"
+            raise RuntimeError(msg)
 
         logger.debug("Successfully retrieved %s sessions" % (len(sessions)))
 
@@ -101,7 +102,7 @@ class ICATLIMS(AbstractLims):
                     break
 
             if not session_found:
-                raise Exception(
+                raise RuntimeError(
                     "Current session in-use (with id %s) not avaialble to user %s"
                     % (self.session_manager.active_session.session_id, user_name)
                 )
@@ -291,13 +292,13 @@ class ICATLIMS(AbstractLims):
         # id to the sample sheet declared in the user portal
         sample_sheet_id = tracking_sample.get("sampleId")
         # identifier that points to the sample tracking
-        trackingSampleId = tracking_sample.get("_id")
+        tracking_sample_id = tracking_sample.get("_id")
 
         logger.debug(
-            "[ICATClient] Sample ids sample_id=%s sample_sheet_id=%s trackingSampleId=%s",
+            "[ICATClient] Sample ids sample_id=%s sample_sheet_id=%s tracking_sample_id=%s",
             sample_id,
             sample_sheet_id,
-            trackingSampleId,
+            tracking_sample_id,
         )
 
         sample_location = tracking_sample.get("sampleContainerPosition")
@@ -352,7 +353,7 @@ class ICATLIMS(AbstractLims):
                                     processing_plan, downloads
                                 )
                             except RuntimeError:
-                                logger.error(
+                                logger.exception(
                                     "Failed __add_download_path_to_processing_plan"
                                 )
 
@@ -369,7 +370,7 @@ class ICATLIMS(AbstractLims):
             "sampleName": sample_name,
             "sampleId": sample_id,
             "sample_sheet_id": sample_sheet_id,
-            "trackingSampleId": trackingSampleId,
+            "trackingSampleId": tracking_sample_id,
             "proteinAcronym": protein_acronym,
             "sampleLocation": sample_location,
             "containerCode": puck_name,
@@ -410,11 +411,13 @@ class ICATLIMS(AbstractLims):
         pass
 
     @property
-    def only_staff_session_selection(self):
-        return bool(self.get_property("only_staff_session_selection", default=False))
+    def only_staff_session_selection(self) -> bool:
+        return bool(
+            self.get_property("only_staff_session_selection", default_value=False)
+        )
 
     def store_robot_action(self, proposal_id: str):
-        raise Exception("Not implemented")
+        raise NotImplementedError
 
     @property
     def filter(self):
@@ -452,11 +455,11 @@ class ICATLIMS(AbstractLims):
     def after_offset_days(self):
         return self.get_property("after_offset_days", "1")
 
-    def _string_to_format_date(self, date: str, format: str) -> str:
+    def _string_to_format_date(self, date: str, fmt: str) -> str:
         if date is not None:
             date_time = self._tz_aware_fromisoformat(date)
             if date_time is not None:
-                return date_time.strftime(format)
+                return date_time.strftime(fmt)
         return ""
 
     def _string_to_date(self, date: str) -> str:
@@ -468,7 +471,7 @@ class ICATLIMS(AbstractLims):
     def _tz_aware_fromisoformat(self, date: str) -> datetime:
         try:
             return datetime.fromisoformat(date).astimezone()
-        except Exception:
+        except (TypeError, ValueError):
             return None
 
     def set_active_session_by_id(self, session_id: str) -> Session:
@@ -483,7 +486,7 @@ class ICATLIMS(AbstractLims):
 
         if len(sessions) == 0:
             logger.warning("Session list is empty. No session candidates")
-            raise Exception("No sessions available")
+            raise RuntimeError("No sessions available")
 
         if len(sessions) == 1:
             self.session_manager.active_session = sessions[0]
@@ -495,7 +498,7 @@ class ICATLIMS(AbstractLims):
 
         session_list = [obj for obj in sessions if obj.session_id == session_id]
         if len(session_list) != 1:
-            raise Exception(
+            raise RuntimeError(
                 "Session not found in the local list of sessions. session_id="
                 + session_id
             )
@@ -507,19 +510,19 @@ class ICATLIMS(AbstractLims):
         logger.debug("allow_session investigationId=%s", session.session_id)
         self.icatClient.reschedule_investigation(session.session_id)
 
-    def get_session_by_id(self, id: str):
+    def get_session_by_id(self, sid: str):
         logger.debug(
             "get_session_by_id investigationId=%s investigations=%s",
-            id,
+            sid,
             str(len(self.investigations)),
         )
-        investigation_list = list(filter(lambda p: p["id"] == id, self.investigations))
+        investigation_list = list(filter(lambda p: p["id"] == sid, self.investigations))
         if len(investigation_list) == 1:
             self.investigation = investigation_list[0]
             return self.__to_session(investigation_list[0])
         logger.warn(
             "No investigation found. get_session_by_id investigationId=%s investigations=%s",
-            id,
+            sid,
             str(len(self.investigations)),
         )
         return None
@@ -802,11 +805,11 @@ class ICATLIMS(AbstractLims):
             try:
                 if cell is not None and puck is not None:
                     position = int(cell * 3) + int(puck)
-            except Exception as e:
-                logger.exception(e)
+            except Exception:
+                logger.exception()
             return position, sample_position
-        except Exception as e:
-            logger.exception(e)
+        except Exception:
+            logger.exception()
 
     def store_beamline_setup(self, session_id: str, bl_config_dict: dict):
         pass
@@ -817,8 +820,76 @@ class ICATLIMS(AbstractLims):
     def store_energy_scan(self, energyscan_dict: dict):
         pass
 
-    def store_xfe_spectrum(self, xfespectrum_dict: dict):
-        pass
+    def store_xfe_spectrum(self, collection_parameters: dict):
+        status = {"xfeFluorescenceSpectrumId": -1}
+        try:
+            try:
+                beamline = self._get_scheduled_beamline()
+                msg = f"Dataset Beamline={beamline} "
+                msg += f"Current Beamline={HWR.beamline.session.beamline_name}"
+                logging.getLogger("HWR").info(msg)
+            except Exception:
+                logging.getLogger("HWR").exception(
+                    "Failed to get _get_scheduled_beamline",
+                )
+            _session = HWR.beamline.session
+            proposal = f"{_session.proposal_code}{_session.proposal_number}"
+
+            try:
+                dt_aware = datetime.strptime(
+                    collection_parameters.get("startTime"),
+                    "%Y-%m-%d %H:%M:%S",
+                ).replace(tzinfo=ZoneInfo("Europe/Paris"))
+                dt_aware_end = datetime.strptime(
+                    collection_parameters.get("endTime"),
+                    "%Y-%m-%d %H:%M:%S",
+                ).replace(tzinfo=ZoneInfo("Europe/Paris"))
+
+                start_time = dt_aware.isoformat(timespec="microseconds")
+                end_time = dt_aware_end.isoformat(timespec="microseconds")
+            except TypeError:
+                logging.getLogger("HWR").exception("Failed to parse start and end time")
+
+            directory = Path(collection_parameters["filename"]).parent
+
+            msg = f"SampleId is: {collection_parameters.get('blSampleId')}"
+            logging.getLogger("HWR").debug(msg)
+            try:
+                sample = HWR.beamline.lims.find_sample_by_sample_id(
+                    collection_parameters.get("blSampleId")
+                )
+                sample_name = sample["sampleName"]
+            except (AttributeError, TypeError):
+                sample_name = "unknown"
+                msg = f"Sample not found {collection_parameters.get('blSampleId')}"
+                logging.getLogger("HWR").debug(msg)
+
+            metadata = {
+                "sampleId": collection_parameters.get("blSampleId"),
+                "MX_beamSizeAtSampleX": collection_parameters.get("beamSizeHorizontal"),
+                "MX_beamSizeAtSampleY": collection_parameters.get("beamSizeVertical"),
+                "MX_directory": str(directory),
+                "MX_exposureTime": collection_parameters.get("exposureTime"),
+                "MX_flux": collection_parameters.get("flux"),
+                "scanType": "xrf",
+                "MX_transmission": collection_parameters.get("beamTransmission"),
+                "Sample_name": sample_name,
+                "InstrumentMonochromator_energy": collection_parameters.get("energy"),
+                "startDate": start_time,
+                "endDate": end_time,
+            }
+
+            self.icatClient.store_dataset(
+                beamline=beamline,
+                proposal=proposal,
+                dataset=str(directory.name),
+                path=str(directory),
+                metadata=metadata,
+            )
+        except Exception:
+            logging.getLogger("ispyb_client").exception()
+
+        return status
 
     def store_workflow(self, workflow_dict: dict):
         pass
@@ -871,7 +942,7 @@ class ICATLIMS(AbstractLims):
             else:
                 logger.exception("HTTP error for sample %s", sample_id)
 
-        except requests.exceptions.RequestException as e:
+        except requests.exceptions.RequestException:
             logger.exception("Request error for sample %s", sample_id)
         return None
 
@@ -883,15 +954,15 @@ class ICATLIMS(AbstractLims):
 
         Parameters:
             sample (str): Sample identifier.
-            output_folder (str): Directory where files will be saved.
+            output_folder (str): Directory where storefiles will be saved.
 
         Returns:
             dict: A dictionary containing the paths of the downloaded files.
         """
         downloaded_files: List[Download] = []
         for resource in resources:
-            resource_folder = pathlib.Path(output_folder) / sample_name
-            resource_folder = pathlib.Path(resource_folder) / (
+            resource_folder = Path(output_folder) / sample_name
+            resource_folder = Path(resource_folder) / (
                 resource.groupName if resource.groupName else ""
             )
             resource_folder.mkdir(
@@ -931,7 +1002,7 @@ class ICATLIMS(AbstractLims):
 
         try:
             fileinfo = collection_parameters["fileinfo"]
-            directory = pathlib.Path(fileinfo["directory"])
+            directory = Path(fileinfo["directory"])
             dataset_name = directory.name
             # Determine the scan type
             if dataset_name.endswith("mesh"):
@@ -1086,7 +1157,7 @@ class ICATLIMS(AbstractLims):
             except RuntimeError:
                 logger.warning("Failed to get MX_axis_end")
 
-            icat_metadata_path = pathlib.Path(directory) / "metadata.json"
+            icat_metadata_path = Path(directory) / "metadata.json"
             with open(icat_metadata_path, "w") as f:
                 # We add the processing and experiment plan only in the metadata.json
                 # it will not work thought pyicat-plus
@@ -1107,7 +1178,7 @@ class ICATLIMS(AbstractLims):
                 for snapshot_index in range(1, 5):
                     key = f"xtalSnapshotFullPath{snapshot_index}"
                     if key in collection_parameters:
-                        snapshot_path = pathlib.Path(collection_parameters[key])
+                        snapshot_path = Path(collection_parameters[key])
                         if snapshot_path.exists():
                             logger.debug(
                                 f"Copying snapshot index {snapshot_index} to gallery"
@@ -1167,4 +1238,3 @@ class ICATLIMS(AbstractLims):
         :param sample_dict: A dictionary with the properties for the entry.
         :type sample_dict: dict
         """
-        pass

mxcubecore/HardwareObjects/abstract/AbstractXRFSpectrum.py

@@ -22,8 +22,8 @@
 
 import abc
 import logging
-import os
 import time
+from pathlib import Path
 
 import gevent
 
@@ -73,29 +73,31 @@ class AbstractXRFSpectrum(HardwareObject):
 
     def start_spectrum(
         self,
-        integration_time=None,
-        data_dir=None,
-        prefix=None,
-        archive_dir=None,
-        session_id=None,
-        blsample_id=None,
-        cpos=None,
+        integration_time: float | None = None,
+        data_dir: str | None = None,
+        prefix: str | None = None,
+        archive_dir: str | None = None,
+        session_id: int | None = None,
+        blsample_id: int | None = None,
+        cpos: dict | None = None,
     ):
         """Start the procedure. Called by the queue_model.
 
         Args:
-            integration_time (float): Inregration time [s].
-            data_dir (str): Directory to save the data (full path).
-            archive_dir (str): Directory to save the archive data (full path).
-            prefix (str): File prefix
-            session_id (int): Session ID number (from ISpyB)
-            blsample_id (int): Sample ID number (from ISpyB)
+            integration_time: Inregration time [s].
+            data_dir: Directory to save the data (full path).
+            archive_dir: Directory to save the archive data (full path).
+            prefix: File prefix
+            session_id: Session ID number (from ISpyB)
+            blsample_id: Sample ID number (from ISpyB)
+            cpos: The centred position motors and their values.
         """
         self.cpos = cpos
         self.spectrum_info_dict = {"sessionId": session_id, "blSampleId": blsample_id}
         integration_time = integration_time or self.default_integration_time
         self.spectrum_info_dict["exposureTime"] = integration_time
         self.spectrum_info_dict["filename"] = ""
+
         # Create the data and the archive directory (if needed) and files
         if data_dir:
             if not self.create_directory(data_dir):
@@ -125,12 +127,16 @@ class AbstractXRFSpectrum(HardwareObject):
         )
         return True
 
-    def execute_spectrum(self, integration_time=None, filename=None):
+    def execute_spectrum(
+        self,
+        integration_time: float | None = None,
+        filename: str | None = None,
+    ):
         """Do the acquisition.
 
         Args:
-            integration_time (float): MCA integration time [s].
-            filename (str): Data file (full path).
+            integration_time: MCA integration time [s].
+            filename: Data file (full path).
         Raises:
             RuntimeError: Cannot acquire data.
         """
@@ -149,23 +155,27 @@ class AbstractXRFSpectrum(HardwareObject):
             self.update_state(self.STATES.FAULT)
 
     @abc.abstractmethod
-    def _execute_spectrum(self, integration_time=None, filename=None):
+    def _execute_spectrum(
+        self,
+        integration_time: float | None = None,
+        filename: str | None = None,
+    ) -> bool:
         """Specific XRF acquisition procedure"""
         return True
 
-    def create_directory(self, directory):
+    def create_directory(self, directory: str) -> bool:
         """Create a directory, if needed.
         Args:
-            directory (str): Directory to save the data (full path).
+            directory: Directory to save the data (full path).
         Returns:
-           (bool): Tue if directory created or already exists, False if error.
+           ``True`` if directory created or already exists, ``False`` if error.
         """
-        if not os.path.isdir(directory):
+        if not Path(directory).is_dir():
             msg = f"XRFSpectrum: directory creating {directory}"
             try:
-                if not os.path.exists(directory):
+                if not Path(directory).exists():
                     logging.getLogger("user_level_log").debug(msg)
-                    os.makedirs(directory)
+                    Path(directory).mkdir(parents=True)
                 return True
             except OSError as err:
                 msg += f": {err}"
@@ -175,7 +185,7 @@ class AbstractXRFSpectrum(HardwareObject):
                 return False
         return True
 
-    def get_filename(self, directory, prefix):
+    def get_filename(self, directory: str, prefix: str) -> str:
         """Create file template.
         Args:
             directory(str): directory name (full path)
@@ -183,19 +193,16 @@ class AbstractXRFSpectrum(HardwareObject):
             (str): File template
         """
         _pattern = f"{prefix}_{time.strftime('%d_%b_%Y')}_%02d_xrf"
-        filename_pattern = os.path.join(directory, _pattern)
-        filename = filename_pattern % 1
-        # fileprefix = _pattern % 1
+        filename = Path(directory) / (_pattern % 1)
 
         i = 2
-        while os.path.isfile(filename):
-            filename = filename_pattern % i
-            # fileprefix = _pattern % i
-            i = i + 1
+        while Path(filename).is_file():
+            filename = Path(directory) / (_pattern % i)
+            i += 1
 
-        return filename
+        return str(filename)
 
-    def spectrum_status_change(self, status_msg):
+    def spectrum_status_change(self, status_msg: str):
         """Emit the signal xrfSpectrumStatusChanged with appropriate message.
         Args:
             status_msg(str): Message to send.
@@ -224,7 +231,8 @@ class AbstractXRFSpectrum(HardwareObject):
 
     def spectrum_analyse(self):
         """Get the spectrum data. Do analysis and save fitted data.
-        The method has to be implemented as specific for each site.
+        The method has to be implemented as specific for each site, but
+        is only optional.
         """
 
     def spectrum_command_aborted(self):

mxcubecore/queue_entry/xrf_spectrum.py

@@ -43,12 +43,12 @@ class XrfSpectrumQueueEntry(BaseQueueEntry):
         super().__init__(view, data_model)
         self._failed = False
 
-    def __getstate__(self):
+    def __getstate__(self) -> dict:
         d = dict(self.__dict__)
         d["xrf_spectrum_task"] = None
         return d
 
-    def __setstate__(self, d):
+    def __setstate__(self, d: dict):
         self.__dict__.update(d)
 
     def execute(self):
@@ -67,7 +67,7 @@ class XrfSpectrumQueueEntry(BaseQueueEntry):
                 archive_dir=xrf_spectrum.path_template.get_archive_directory(),
                 prefix=f"{path_template.get_prefix()}_{path_template.run_number}",
                 session_id=HWR.beamline.session.session_id,
-                blsample_id=xrf_spectrum._node_id,
+                blsample_id=xrf_spectrum.sample.lims_id,
                 cpos=xrf_spectrum.centred_position,
             )
             HWR.beamline.xrf_spectrum._ready_event.wait()
@@ -108,10 +108,10 @@ class XrfSpectrumQueueEntry(BaseQueueEntry):
         self.get_view().set_checkable(False)
         super().post_execute()
 
-    def xrf_spectrum_status_changed(self, msg):
+    def xrf_spectrum_status_changed(self, msg: str):
         """xrfSpectrumStatusChanged handler.
         Args:
-            msg (str): Message when xrfSpectrumStatusChanged emitted.
+            msg: Message when ``xrfSpectrumStatusChanged`` emitted.
         """
         logging.getLogger("user_level_log").info(msg)
 
@@ -136,5 +136,5 @@ class XrfSpectrumQueueEntry(BaseQueueEntry):
             logging.getLogger("user_level_log").error("XRF spectrum failed.")
             raise QueueExecutionException("XRF spectrum failed", self)
 
-    def get_type_str(self):
+    def get_type_str(self) -> str:
         return "XRF spectrum"

{mxcubecore-1.329.0.dist-info → mxcubecore-1.330.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: mxcubecore
-Version: 1.329.0
+Version: 1.330.0
 Summary: Core libraries for the MXCuBE application
 License: LGPL-3.0-or-later
 Keywords: mxcube,mxcube3,mxcubecore

{mxcubecore-1.329.0.dist-info → mxcubecore-1.330.0.dist-info}/RECORD

@@ -149,7 +149,7 @@ mxcubecore/HardwareObjects/ESRF/ESRFPhotonFlux.py,sha256=QIjglmsilHkeLUZXLqR6Ykm
 mxcubecore/HardwareObjects/ESRF/ESRFSC3.py,sha256=Mw2Lj_0w7TapaCesDxhRWSAY1PRG4DJCoLWgYdP_qV4,9545
 mxcubecore/HardwareObjects/ESRF/ESRFSession.py,sha256=iIcJUM0cVlwJdqNZo-L7IY_S2KYHQXPQPupbv4JoAkk,4323
 mxcubecore/HardwareObjects/ESRF/ESRFSmallXrayCentring.py,sha256=YJFMtb3VxHchxTWi_pqrEz3ML1YunoYLkAseDZqF1JA,3617
-mxcubecore/HardwareObjects/ESRF/ESRFXRFSpectrum.py,sha256=SiacpwXNhep6TlGExLdixZjMHUgMJBcJvl8Xpwd0DwI,11603
+mxcubecore/HardwareObjects/ESRF/ESRFXRFSpectrum.py,sha256=KS6DicwZQPHLK6rFR6F5pkvjEDsSPYFsPISWe0o-83A,12212
 mxcubecore/HardwareObjects/ESRF/ID231EnergyScan.py,sha256=f6Loqqgl5E64-xACuK-6nF2sH9ftpwa7e1It0C1e-s4,1144
 mxcubecore/HardwareObjects/ESRF/ID232BeamDefiner.py,sha256=jnHe7HgEDbV69PegYCdxv-85jWHHWYhEae9WinNE3HY,5073
 mxcubecore/HardwareObjects/ESRF/ID29EnergyScan.py,sha256=9Nscojz8KonwWZltpIcRwH06RC2AtZKZGu-oEbMqLLg,2778
@@ -174,7 +174,7 @@ mxcubecore/HardwareObjects/ESRF/queue_entry/ssx_laser_hare_collection.py,sha256=
 mxcubecore/HardwareObjects/ESRF/queue_entry/ssx_laser_injector_collection.py,sha256=6nz9gsoJWA2Douuw00-y4pkH_DCwJ4jzIH7xpXVKKas,4417
 mxcubecore/HardwareObjects/ESRF/queue_entry/ssx_line_scan_collection.py,sha256=iy-ozL1GTl8Hv8hM0qvhlBCQVWrku2SNzC3R6rVzC-U,5404
 mxcubecore/HardwareObjects/ESRF/queue_entry/test_collection.py,sha256=DbZkkHdsAnjEhEuA8Y9SF2di-TEewKG-kFLHCYIm9Kk,2571
-mxcubecore/HardwareObjects/ESRFLIMS.py,sha256=PiWVMjDNhmnVEldisfcio9iBodDUKz7QmbpR9Bd0_XM,9679
+mxcubecore/HardwareObjects/ESRFLIMS.py,sha256=pZzy4yC_QZytWFSGTzsR5zxkBoj8WkIgUWwRlhXPp2s,9838
 mxcubecore/HardwareObjects/EdnaWorkflow.py,sha256=zuNVFWXHcnKRZPRnY3yjW__yRjnl_FWR_OrFLF2qESc,8741
 mxcubecore/HardwareObjects/Energy.py,sha256=iZyLDPPrmx38SlpeP7V82DY32AT2NovuslONB5aYGPU,6496
 mxcubecore/HardwareObjects/ExporterMotor.py,sha256=661WJnSs56b95H-H5BV-3SSpLe_ak2VGj1sAvNzY3D4,8666
@@ -197,7 +197,7 @@ mxcubecore/HardwareObjects/GrobMotor.py,sha256=wbk7x0J2YeEeEoNdhNj7k4jN4nPBTAnHG
 mxcubecore/HardwareObjects/GrobSampleChanger.py,sha256=LMetcL45fWrwP4C8rtENrEDNydelLpJ77SD1JC5C3go,8113
 mxcubecore/HardwareObjects/Harvester.py,sha256=kmPE_-6HXwP89xa_TJZ079vvwsbSVzvtPlAKBc7XE_k,26519
 mxcubecore/HardwareObjects/HarvesterMaintenance.py,sha256=76745tEMHBlJKBISkloiKz9yWVwehclHRDs3rNaq0qE,9400
-mxcubecore/HardwareObjects/ICATLIMS.py,sha256=KV13c0JnuzHywz-f59sP-jADxwQCHk1j1TwB-Vl0KOg,47905
+mxcubecore/HardwareObjects/ICATLIMS.py,sha256=Jdzs6KWQDvlzqauuIOeeaEkgS9Vs11zDqLJDgxv3sS4,51016
 mxcubecore/HardwareObjects/ISARAMaint.py,sha256=RSHx_eTZoFQTy1Ix98GkMQh9Nz1W0sk5PTGqOtBwcT4,8549
 mxcubecore/HardwareObjects/LNLS/EPICSActuator.py,sha256=L5vhJnLjx0cawBeAQbTtZ39nVIHp30hqKCBfIaIKRds,2601
 mxcubecore/HardwareObjects/LNLS/EPICSMotor.py,sha256=lRTc1t32rJKNTIcnKCECrqo2m9BhlYvLq9NWg4Y0w0Q,3576
@@ -364,7 +364,7 @@ mxcubecore/HardwareObjects/abstract/AbstractShutter.py,sha256=8YQqnli9zzy42e3vLZ
 mxcubecore/HardwareObjects/abstract/AbstractSlits.py,sha256=u3WRuGYPJP_xoxJ_Qt6K5IlBCmYzq6t3VFN8frtG5AM,3834
 mxcubecore/HardwareObjects/abstract/AbstractTransmission.py,sha256=5BdJz16kYM13lvnKeGNG-i7qIhH7Lrz1csWk-rnhaB0,1405
 mxcubecore/HardwareObjects/abstract/AbstractVideoDevice.py,sha256=8FIwnoFOQegZPdpBXpG-u3JrRr9j7yMF5m8DpwnqjME,14785
-mxcubecore/HardwareObjects/abstract/AbstractXRFSpectrum.py,sha256=T8opsFDpzdeqCifiZwbno_WBxcPbVpCb3sH1391_w_Y,8972
+mxcubecore/HardwareObjects/abstract/AbstractXRFSpectrum.py,sha256=VIUpuKHbWqiFCKWTNwPm9doMqMEsxfcBSCuj1W5Ilog,9192
 mxcubecore/HardwareObjects/abstract/AbstractXrayCentring.py,sha256=jVO3VjuRKyzTk_ZAsSkjA7e-sauDc5IAf-Bd98yUwAY,3513
 mxcubecore/HardwareObjects/abstract/ISPyBAbstractLims.py,sha256=LqU0ehzl-lvAV5p4auvaIYDSnbLFn1tZwtN7R76CJIE,9011
 mxcubecore/HardwareObjects/abstract/ISPyBDataAdapter.py,sha256=1Uk3ZDty1kth-hI4UdwpBxyjtxNxuhzCHyYZMwWFn8g,27319
@@ -459,14 +459,14 @@ mxcubecore/queue_entry/sample_centring.py,sha256=zV9pMwR4L8q6lnpFZgATlORcWR545T7
 mxcubecore/queue_entry/test_collection.py,sha256=KidatI31KJ11FGrBNxG9SOvDEdLYaoCaE4VKmPDSuPs,2725
 mxcubecore/queue_entry/xray_centering.py,sha256=01-TX9bsArMHxUJ3L58Vh-ShpkcHfUjIsHQO7AtCT7M,4145
 mxcubecore/queue_entry/xray_centering2.py,sha256=P--C2mg04GVazLgwMHSX9CxM7jfbeVoMMhYfn1PHbow,2971
-mxcubecore/queue_entry/xrf_spectrum.py,sha256=YQAqPMU_OsSF0NyH-cf41gjgIquc8YrdZkv0k3QjIMU,5263
+mxcubecore/queue_entry/xrf_spectrum.py,sha256=cfIQacnvMNjSYhxKAvpLcoUxYvForJcpXxw3CmwzVy8,5293
 mxcubecore/saferef.py,sha256=lbUbzojjg1XM6gKtGKug48CD_LeuQXpZ7R3r1fMjCKw,7164
 mxcubecore/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 mxcubecore/utils/conversion.py,sha256=G1bk2Mi2ZwGbZa5pEeiFaKWxhSVXVGqu1L9_SioyUOk,4513
 mxcubecore/utils/qt_import.py,sha256=hQkBVZLUDZtktX7DSyoH88GAK_mK9Ghlsj4k9pFJeAQ,14415
 mxcubecore/utils/units.py,sha256=2D1QlTwe8eSs2UYRm4VVxSTosZZHeM-Pfw9KlcLbDAg,1251
-mxcubecore-1.329.0.dist-info/COPYING,sha256=46mU2C5kSwOnkqkw9XQAJlhBL2JAf1_uCD8lVcXyMRg,7652
-mxcubecore-1.329.0.dist-info/COPYING.LESSER,sha256=46mU2C5kSwOnkqkw9XQAJlhBL2JAf1_uCD8lVcXyMRg,7652
-mxcubecore-1.329.0.dist-info/METADATA,sha256=MoICRSYLbO_OipGGj-LXCd9DvSa8uqdfJqWlIeEQgXo,4262
-mxcubecore-1.329.0.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
-mxcubecore-1.329.0.dist-info/RECORD,,
+mxcubecore-1.330.0.dist-info/COPYING,sha256=46mU2C5kSwOnkqkw9XQAJlhBL2JAf1_uCD8lVcXyMRg,7652
+mxcubecore-1.330.0.dist-info/COPYING.LESSER,sha256=46mU2C5kSwOnkqkw9XQAJlhBL2JAf1_uCD8lVcXyMRg,7652
+mxcubecore-1.330.0.dist-info/METADATA,sha256=nAxkGPkZ-KEPDq2Tny80vULusJGyXvIpj3pN5klb22M,4262
+mxcubecore-1.330.0.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
+mxcubecore-1.330.0.dist-info/RECORD,,