sardana-nxsrecorder 3.21.1__tar.gz → 3.22.0__tar.gz

{sardana-nxsrecorder-3.21.1 → sardana-nxsrecorder-3.22.0}/ChangeLog

@@ -1,3 +1,7 @@
+2024-06-03 Jan Kotanski <jankotan@gmail.com>
+	* improve support for ScanFile formating wih _%05d and _{ScanID:05d} (#114)
+	* tagged as 3.22.0
+
 2024-05-23 Jan Kotanski <jankotan@gmail.com>
 	* replace deprecated tz.localize() with datetime.replace() (#111)
 	* tagged as 3.21.1

{sardana-nxsrecorder-3.21.1/sardana_nxsrecorder.egg-info → sardana-nxsrecorder-3.22.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: sardana-nxsrecorder
-Version: 3.21.1
+Version: 3.22.0
 Summary: NeXus Sardana Scan Recorder
 Home-page: https://github.com/nexdatas/sardana-nxs-filerecorder/
 Author: Jan Kotanski

{sardana-nxsrecorder-3.21.1 → sardana-nxsrecorder-3.22.0}/man/sardananxsrecorder.1

@@ -1,8 +1,5 @@
 .\" Man page generated from reStructuredText.
 .
-.TH "SARDANANXSRECORDER" "1" "Nov 09, 2022" "3.12" "Sardana NeXus Recorder"
-.SH NAME
-sardananxsrecorder \- sardananxsrecorder Documentation
 .
 .nr rst2man-indent-level 0
 .
@@ -30,6 +27,9 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
 ..
+.TH "SARDANANXSRECORDER" "1" "Jun 03, 2024" "3.22" "Sardana NeXus Recorder"
+.SH NAME
+sardananxsrecorder \- sardananxsrecorder Documentation
 .sp
 \fI\%\fP
 \fI\%\fP
@@ -79,7 +79,7 @@ defining the package location, e.g.
 .sp
 .SS Debian packages
 .sp
-Debian Bookworm, Bullseye, Buster and Ubuntu Lunar, Jammy, Focal packages can be found in the HDRI repository.
+Debian Bookworm, Bullseye, Buster and Ubuntu Lunar, Jammy and Focal packages can be found in the HDRI repository.
 .sp
 To install the debian packages, add the PGP repository key
 .INDENT 0.0
@@ -330,17 +330,25 @@ The NeXus file recorder uses the following sardana environment variables
 .IP \(bu 2
 \fBNXSAppendSciCatDataset\fP \fI(bool)\fP \- append scan name to scicat dataset list file, default: \fBFalse\fP
 .IP \(bu 2
-\fBBeamtimeFilePath\fP \fI(str)\fP \- beamtime file path to search beamtime metadata file, default: \fB"/gpfs/current"\fP
+\fBBeamtimeFilePath\fP \fI(str)\fP \- beamtime file path to search beamtime metadata file, default: \fB\(dq/gpfs/current\(dq\fP
 .IP \(bu 2
-\fBBeamtimeFilePrefix\fP \fI(str)\fP \- beamtime metadata file prefix, default: \fB"beamtime\-metadata\-"\fP
+\fBBeamtimeFilePrefix\fP \fI(str)\fP \- beamtime metadata file prefix, default: \fB\(dqbeamtime\-metadata\-\(dq\fP
 .IP \(bu 2
-\fBBeamtimeFileExt\fP \fI(str)\fP \- beamtime metadata file extension, default: \fB".json"\fP
+\fBBeamtimeFileExt\fP \fI(str)\fP \- beamtime metadata file extension, default: \fB\(dq.json\(dq\fP
 .IP \(bu 2
-\fBSciCatDatasetListFilePrefix\fP \fI(str)\fP \- scicat dataset list file prefix, default: \fB"scicat\-datasets\-"\fP
+\fBSciCatDatasetListFilePrefix\fP \fI(str)\fP \- scicat dataset list file prefix, default: \fB\(dqscicat\-datasets\-\(dq\fP
 .IP \(bu 2
-\fBSciCatDatasetListFileExt\fP \fI(str)\fP \- scicat dataset list file extension, default: \fB".lst"\fP
+\fBSciCatDatasetListFileExt\fP \fI(str)\fP \- scicat dataset list file extension, default: \fB\(dq.lst\(dq\fP
 .IP \(bu 2
 \fBSciCatDatasetListFileLocal\fP \fI(bool)\fP \- add the hostname to the scicat dataset list file extension, default: \fBFalse\fP
+.IP \(bu 2
+\fBSciCatAutoGrouping\fP \fI(bool)\fP \- group all scans with the measurement name set to the base scan filename, default: \fBFalse\fP
+.IP \(bu 2
+\fBMetadataScript\fP \fI(str)\fP \- a python module file name containing \fBmain()\fP  which provides a dictionary with user metadata stored in the INIT mode, default: \fB\(dq\(dq\fP
+.IP \(bu 2
+\fBScicatMeasurements\fP \fI(dict)\fP \- a dictionary of  measurement names indexed by \fBScanDir\fP and  used by \fBscingestor\fP, default: \fB{}\fP
+.IP \(bu 2
+\fBCreateMeasurementFile\fP \fI(bool)\fP \- create a measurement file with its filename releated to \fBScicatMeasurements\fP or \fBScanFile\fP, default: \fBFalse\fP
 .UNINDENT
 .sp
 Contents:
@@ -351,8 +359,8 @@ Contents:
 This is the macro server scan data NeXus recorder module
 .INDENT 0.0
 .TP
-.B class sardananxsrecorder.nxsrecorder.NXS_FileRecorder(filename=None, macro=None, **pars)
-Bases: \fBsardana.macroserver.scan.recorder.storage.BaseFileRecorder\fP
+.B class  sardananxsrecorder.nxsrecorder.NXS_FileRecorder(filename=None, macro=None, **pars)
+Bases: \fI\%BaseFileRecorder\fP
 .sp
 This recorder saves data to a NeXus file making use of NexDaTaS Writer
 .sp
@@ -430,7 +438,7 @@ and records in INIT mode
 .UNINDENT
 .INDENT 7.0
 .TP
-.B formats = {\(aqh5\(aq: \(aq.h5\(aq, \(aqndf\(aq: \(aq.ndf\(aq, \(aqnx\(aq: \(aq.nx\(aq, \(aqnxs\(aq: \(aq.nxs\(aq}
+.B formats  =  {\(aqh5\(aq: \(aq.h5\(aq, \(aqndf\(aq: \(aq.ndf\(aq, \(aqnx\(aq: \(aq.nx\(aq, \(aqnxs\(aq: \(aq.nxs\(aq}
 (\fI\%dict\fP <\fI\%str\fP, \fI\%str\fP > ) recoder format
 .UNINDENT
 .INDENT 7.0
@@ -448,8 +456,8 @@ the output file format
 .UNINDENT
 .INDENT 7.0
 .TP
-.B class numpyEncoder(*, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, sort_keys=False, indent=None, separators=None, default=None)
-Bases: \fBjson.encoder.JSONEncoder\fP
+.B class  numpyEncoder(*, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, sort_keys=False, indent=None, separators=None, default=None)
+Bases: \fBJSONEncoder\fP
 .sp
 numpy json encoder with list
 .sp
@@ -465,7 +473,7 @@ ensure_ascii is false, the output can contain non\-ASCII characters.
 .sp
 If check_circular is true, then lists, dicts, and custom encoded
 objects will be checked for circular references during encoding to
-prevent an infinite recursion (which would cause an OverflowError).
+prevent an infinite recursion (which would cause an RecursionError).
 Otherwise, no such check takes place.
 .sp
 If allow_nan is true, then NaN, Infinity, and \-Infinity will be
@@ -507,11 +515,11 @@ default encoder
 Sardana Scan Recorders
 .INDENT 0.0
 .IP \(bu 2
-genindex
+\fI\%Index\fP
 .IP \(bu 2
-modindex
+\fI\%Module Index\fP
 .IP \(bu 2
-search
+\fI\%Search Page\fP
 .UNINDENT
 .SH AUTHOR
 Author

{sardana-nxsrecorder-3.21.1 → sardana-nxsrecorder-3.22.0/sardana_nxsrecorder.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: sardana-nxsrecorder
-Version: 3.21.1
+Version: 3.22.0
 Summary: NeXus Sardana Scan Recorder
 Home-page: https://github.com/nexdatas/sardana-nxs-filerecorder/
 Author: Jan Kotanski

{sardana-nxsrecorder-3.21.1 → sardana-nxsrecorder-3.22.0}/sardananxsrecorder/__init__.py

@@ -20,4 +20,4 @@
 """ Sardana Scan Recorders """
 
 #: package version
-__version__ = "3.21.1"
+__version__ = "3.22.0"

{sardana-nxsrecorder-3.21.1 → sardana-nxsrecorder-3.22.0}/sardananxsrecorder/nxsrecorder.py

@@ -102,6 +102,8 @@ class NXS_FileRecorder(BaseFileRecorder):
         BaseFileRecorder.__init__(self)
         #: (:obj:`str`) base filename
         self.__base_filename = filename
+        #: (:obj:`str`) raw filename
+        self.__raw_filename = ""
         self.__macro = weakref.ref(macro) if macro else None
         #: (:class:`tango.Database`) tango database
         self.__db = tango.Database()
@@ -164,7 +166,7 @@ class NXS_FileRecorder(BaseFileRecorder):
         appendentry = self.__getConfVar("AppendEntry", True)
         scanID = self.__env["ScanID"] \
             if "ScanID" in self.__env.keys() else -1
-        appendentry = not self.__setFileName(
+        self.__setFileName(
             self.__base_filename, not appendentry, scanID)
 
     def __command(self, server, command, *args):
@@ -339,10 +341,12 @@ class NXS_FileRecorder(BaseFileRecorder):
 
         :param filename: sardana scanfile name
         :type filename: :obj:`str`
-        :param numer: True if append scanID
-        :param numer: :obj:`bool`
+        :param number: True if append scanID
+        :param number: :obj:`bool`
         :param scanID: scanID to append
         :type scanID: :obj:`int`
+        :returns: True if append scanID
+        :rtype: :obj:`bool`
         """
         if scanID is not None and scanID < 0:
             return number
@@ -371,20 +375,30 @@ class NXS_FileRecorder(BaseFileRecorder):
 
         subs = (len([None for _ in list(re.finditer('%', filename))]) == 1)
         # construct the filename, e.g. : /dir/subdir/etcdir/prefix_00123.nxs
-        if subs or number:
-            if scanID is None:
-                serial = self.recordlist.getEnvironValue('serialno')
-            elif scanID >= 0:
-                if isarver >= 304 or isarver == 0:
-                    serial = scanID
-                else:
-                    serial = scanID + 1
+        if scanID is None:
+            serial = self.recordlist.getEnvironValue('serialno')
+        elif scanID >= 0:
+            if isarver >= 304 or isarver == 0:
+                serial = scanID
+            else:
+                serial = scanID + 1
+
         if subs:
             try:
                 #: output file name
                 self.filename = filename % serial
             except Exception:
                 subs = False
+        if not self.__raw_filename:
+            self.__raw_filename = self.__rawfilename(serial)
+        self.debug('Raw Filename: %s' % str(self.__raw_filename))
+        if not subs and self.__raw_filename and \
+           "{ScanID" in self.__raw_filename:
+            try:
+                self.filename = self.__raw_filename.format(ScanID=serial)
+                subs = True
+            except Exception:
+                pass
 
         if not subs:
             if number:
@@ -958,12 +972,11 @@ class NXS_FileRecorder(BaseFileRecorder):
             self.__setNexusDevices()
 
             appendentry = self.__getConfVar("AppendEntry", True)
-
-            appendentry = not self.__setFileName(
+            appendscanid = not self.__setFileName(
                 self.__base_filename, not appendentry)
             envRec = self.recordlist.getEnviron()
             self.__vars["vars"]["serialno"] = ("_%05i" % envRec["serialno"]) \
-                if appendentry else ""
+                if appendscanid else ""
             self.__vars["vars"]["scan_id"] = envRec["serialno"]
             self.__vars["vars"]["scan_title"] = envRec["title"]
             if self.__macro:
@@ -1188,15 +1201,15 @@ class NXS_FileRecorder(BaseFileRecorder):
         """
         result = ""
         fpath = self.filename
-        if fpath.startswith(bmtfpath):
-            try:
+        try:
+            if fpath.startswith(bmtfpath):
                 if os.path.isdir(bmtfpath):
                     btml = [fl for fl in os.listdir(bmtfpath)
                             if (fl.startswith(bmtfprefix)
                                 and fl.endswith(bmtfext))]
                     result = btml[0][len(bmtfprefix):-len(bmtfext)]
-            except Exception:
-                pass
+        except Exception:
+            pass
         return result
 
     def beamtimeid(self):
@@ -1207,11 +1220,62 @@ class NXS_FileRecorder(BaseFileRecorder):
         beamtimeid = self.beamtime_id(bmtfpath, bmtfprefix, bmtfext)
         return beamtimeid or "00000000"
 
+    def __rawfilename(self, serial):
+        """ find scan name
+        """
+        try:
+            scan_file = self.__macro().getEnv('ScanFile')
+        except Exception:
+            scan_file = []
+        try:
+            scan_dir = self.__macro().getEnv('ScanDir')
+        except Exception:
+            scan_dir = "/"
+        if isinstance(scan_file, str):
+            scan_file = [scan_file]
+        bfilename = ""
+
+        for sfile in scan_file:
+            sfile = os.path.join(scan_dir, sfile)
+            try:
+                ffile = sfile.format(ScanID=serial)
+            except KeyError:
+                ffile = sfile
+            if ffile == self.__base_filename:
+                bfilename = sfile
+                break
+        bfilename = bfilename or self.__base_filename
+        return bfilename
+
+    def __scanname(self, serial):
+        """ find scan name
+        """
+        if not self.__raw_filename:
+            self.__raw_filename = self.__rawfilename(serial)
+        bfilename = self.__raw_filename
+        _, bfname = os.path.split(bfilename)
+        if bfname.endswith(".tmp"):
+            bfname = bfname[:-4]
+        sname, fext = os.path.splitext(bfname)
+        scanname = os.path.commonprefix(
+            [sname.format(ScanID=11111111),
+             sname.format(ScanID=99999999)])
+        if '%' in scanname:
+            try:
+                scanname = os.path.commonprefix(
+                    [scanname % 11111111,
+                     scanname % 99999999])
+            except Exception:
+                pass
+        if scanname.endswith("_"):
+            scanname = scanname[:-1]
+        return scanname
+
     def __appendSciCatDataset(self, hostname=None):
         """ append dataset to SciCat ingestion list """
 
+        sid = self.__vars["vars"]["scan_id"]
         fdir, fname = os.path.split(self.filename)
-        _, bfname = os.path.split(self.__base_filename)
         sname, fext = os.path.splitext(fname)
         beamtimeid = self.beamtimeid()
         defprefix = "scicat-datasets-"
@@ -1231,12 +1295,17 @@ class NXS_FileRecorder(BaseFileRecorder):
         variables = self.__getConfVar("ConfigVariables", None, True)
         if isinstance(variables, dict) and "entryname" in variables:
             entryname = variables["entryname"]
-        try:
-            scanname, _ = os.path.splitext(bfname % "")
-        except Exception:
-            scanname, _ = os.path.splitext(bfname)
 
-        if appendentry is True:
+        scanname = self.__scanname(sid)
+        # _, bfname = os.path.split(self.__base_filename)
+        # try:
+        #     scanname, _ = os.path.splitext(bfname % "")
+        # except Exception:
+        #     scanname, _ = os.path.splitext(bfname)
+
+        if appendentry is True and \
+                '%' not in self.__raw_filename and \
+                "{ScanID" not in self.__raw_filename:
             sid = self.__vars["vars"]["scan_id"]
             sname = "%s::/%s_%05i;%s_%05i" % (
                 scanname, entryname, sid, scanname, sid)
@@ -1274,15 +1343,17 @@ class NXS_FileRecorder(BaseFileRecorder):
     def __createMeasurementFile(self):
         """ create measurement file """
 
+        sid = self.__vars["vars"]["scan_id"]
         fdir, fname = os.path.split(self.filename)
-        _, bfname = os.path.split(self.__base_filename)
         sname, fext = os.path.splitext(fname)
         # beamtimeid = self.beamtimeid()
 
-        try:
-            scanname, _ = os.path.splitext(bfname % "")
-        except Exception:
-            scanname, _ = os.path.splitext(bfname)
+        scanname = self.__scanname(sid)
+        # _, bfname = os.path.split(self.__base_filename)
+        # try:
+        #     scanname, _ = os.path.splitext(bfname % "")
+        # except Exception:
+        #     scanname, _ = os.path.splitext(bfname)
 
         try:
             sm = dict(self.__getEnvVar('SciCatMeasurements', {}))
@@ -1295,9 +1366,10 @@ class NXS_FileRecorder(BaseFileRecorder):
         if isinstance(variables, dict) and "entryname" in variables:
             entryname = variables["entryname"]
         if appendentry is True:
-            sid = self.__vars["vars"]["scan_id"]
-            entryname = entryname + ("_%05i" % sid)
-            sname = sname + ("_%05i" % sid)
+            if '%' not in self.__raw_filename and \
+               "{ScanID" not in self.__raw_filename:
+                sname = sname + ("_%05i" % sid)
+                entryname = entryname + ("_%05i" % sid)
 
         mntname = scanname
         if fdir in sm.keys() and sm[fdir]: