fixes #128, adds spec2nexus dependence

Author: prjemian

apstools/filewriters.py

@@ -528,8 +528,13 @@ def newfile(self, filename=None, scan_id=None, RE=None):
         self.clear()
         filename = filename or self.make_default_filename()
         if os.path.exists(filename):
-            # raise ValueError(f"file {filename} exists")
-            _z = 2  # TODO: examine the file per issue #128
+            from spec2nexus.spec import SpecDataFile
+            sdf = SpecDataFile(filename)
+            scan_list = sdf.getScanNumbers()
+            l = len(scan_list)
+            m = max(map(float, scan_list))
+            highest = int(max(l, m) + 0.9999)     # solves issue #128
+            scan_id = max(scan_id or 0, highest)
         self.spec_filename = filename
         self.spec_epoch = int(time.time())  # ! no roundup here!!!
         self.spec_host = socket.gethostname() or 'localhost'
@@ -542,7 +547,8 @@ def newfile(self, filename=None, scan_id=None, RE=None):
             # False means do not modify it
             scan_id = {True: SCAN_ID_RESET_VALUE, False: None}[scan_id]
         if scan_id is not None and RE is not None:
-            # RE is an instance of bluesky.run_engine.RunEngine (or duck type for testing)
+            # RE is an instance of bluesky.run_engine.RunEngine
+            # (or duck type for testing)
             RE.md["scan_id"] = scan_id
             self.scan_id = scan_id
         return self.spec_filename

conda-recipe/meta.yaml

@@ -43,6 +43,7 @@ requirements:
     - pyRestTable
     - pandas
     - xlrd
+    - spec2nexus
 
 test:
   imports:

requirements.txt

@@ -5,3 +5,4 @@ ophyd
 pandas
 pyRestTable
 xlrd
+spec2nexus

tests/__main__.py

@@ -13,9 +13,11 @@
 def suite(*args, **kw):
 
     import test_simple
+    import test_filewriter
     # import test_excel
     test_list = [
         test_simple,
+        test_filewriter,
         # test_excel
         ]
 

tests/test_filewriter.py

@@ -159,23 +159,27 @@ class my_RunEngine:
         specwriter.scan_id = -5  # an unusual value for testing only
         RE.md["scan_id"] = -10   # an unusual value for testing only
         specwriter.newfile(filename=testfile, scan_id=None, RE=RE)
-        self.assertEqual(specwriter.scan_id, -5, "scan_id unchanged")
-        self.assertEqual(RE.md["scan_id"], -10, "RE.md['scan_id'] unchanged")
+        self.assertEqual(specwriter.scan_id, 108, "scan_id unchanged")
+        self.assertEqual(RE.md["scan_id"], 108, "RE.md['scan_id'] unchanged")
 
+        specwriter.scan_id = -5  # an unusual value for testing only
+        RE.md["scan_id"] = -10   # an unusual value for testing only
         specwriter.newfile(filename=testfile, scan_id=False, RE=RE)
-        self.assertEqual(specwriter.scan_id, -5, "scan_id unchanged")
-        self.assertEqual(RE.md["scan_id"], -10, "RE.md['scan_id'] unchanged")
+        self.assertEqual(specwriter.scan_id, 108, "scan_id unchanged")
+        self.assertEqual(RE.md["scan_id"], 108, "RE.md['scan_id'] unchanged")
 
+        specwriter.scan_id = -5  # an unusual value for testing only
+        RE.md["scan_id"] = -10   # an unusual value for testing only
         specwriter.newfile(filename=testfile, scan_id=True, RE=RE)
-        self.assertEqual(specwriter.scan_id, SCAN_ID_RESET_VALUE, "scan_id reset")
-        self.assertEqual(RE.md["scan_id"], SCAN_ID_RESET_VALUE, "RE.md['scan_id'] reset")
+        self.assertEqual(specwriter.scan_id, 108, "scan_id reset")
+        self.assertEqual(RE.md["scan_id"], 108, "RE.md['scan_id'] reset")
 
-        for n in (0, 108, 110):
+        for n, s in {'0': 108, '108': 108, '110': 110}.items():
             specwriter.scan_id = -5  # an unusual value for testing only
             RE.md["scan_id"] = -10   # an unusual value for testing only
-            specwriter.newfile(filename=testfile, scan_id=n, RE=RE)
-            self.assertEqual(specwriter.scan_id, n, f"scan_id set to {n}")
-            self.assertEqual(RE.md["scan_id"], n, f"RE.md['scan_id'] set to {n}")
+            specwriter.newfile(filename=testfile, scan_id=int(n), RE=RE)
+            self.assertEqual(specwriter.scan_id, s, f"scan_id set to {n}, actually {s}")
+            self.assertEqual(RE.md["scan_id"], s, f"RE.md['scan_id'] set to {n}, actually {s}")
 
     def test__rebuild_scan_command(self):
         from apstools.filewriters import _rebuild_scan_command