chore: now forcing legacy naming conventions to fail. Note: this could cause issues with trying to load and rerun old experiments. The use of loops should now be replaced with scans, the use of sweep with experiment, and the use of metasweep with abstractexperiment.

Author: rsbrost

pyscan/measurement/abstract_experiment.py

@@ -294,6 +294,7 @@ class MetaSweep(AbstractExperiment):
     Present for backwards compatibility. Renamed to :class:`.AbstractExperiment`.
     '''
 
-    warning_msg = ("Use of legacy nomenclature detected but no longer supported, use at your own risk!\n"
+    warning_msg = ("Use of legacy nomenclature detected but no longer supported.\n"
                    + "You entered MetaSweep, use AbstractExperiment instead.")
-    print(f"\033[93m*** WARNING! ***: {warning_msg} \033[0m")
+    raise DeprecationWarning(f"\033[93m*** WARNING! ***: {warning_msg} \033[0m")
+    assert False, f"\033[93m*** WARNING! ***: {warning_msg} \033[0m"

pyscan/measurement/experiment.py

@@ -272,6 +272,7 @@ class Sweep(Experiment):
     Present for backwards compatibility. Renamed to :class:`.Experiment`.
     '''
 
-    warning_msg = ("Use of legacy nomenclature detected but no longer supported, use at your own risk!\n"
+    warning_msg = ("Use of legacy nomenclature detected but no longer supported.\n"
                    + "You entered Sweep, use Experiment instead.")
-    print(f"\033[93m*** WARNING! ***: {warning_msg} \033[0m")
+    raise DeprecationWarning(f"\033[93m*** WARNING! ***: {warning_msg} \033[0m")
+    assert False, f"\033[93m*** WARNING! ***: {warning_msg} \033[0m"

pyscan/measurement/run_info.py

@@ -195,7 +195,9 @@ def has_average_scan(self):
 
         return self._has_average_scan
 
-    # These property's are strictly for backwards compatibility with old pyscan naming convention.
+    ####################### LEGACY SECTION ########################
+    # This section is set up to alert users who try to use legacy nomenclature
+    # of the updated naming convention that they must use instead.
     @property
     def loop0(self):
         legacy_warning()
@@ -265,6 +267,7 @@ def drop(array, index):
 
 
 def legacy_warning():
-    warning_msg = ("Use of legacy nomenclature detected but no longer supported, use at your own risk!\n"
+    warning_msg = ("Use of legacy nomenclature detected but no longer supported.\n"
                    + "You entered 'loop', use 'scan' instead.")
-    print(f"\033[93m*** WARNING! ***: {warning_msg} \033[0m")
+    raise DeprecationWarning(f"\033[93m*** WARNING! ***: {warning_msg} \033[0m")
+    assert False, f"\033[93m*** WARNING! ***: {warning_msg} \033[0m"

test/legacy/test_legacy.py

@@ -1,10 +1,21 @@
 import pyscan as ps
+import pytest
 
 
 def test_legacy():
+    '''
+    Ensure that legacy naming convention fails.
+    '''
     devices = ps.ItemAttribute()
     runinfo = ps.RunInfo()
-    sweep = ps.Sweep(runinfo, devices)
-
-    err_msg = "Legacy nomenclature failed. Sweep not initialized as Experiment or MetaSweep not as Abstract Experiment."
-    assert isinstance(sweep, ps.Experiment), err_msg
+    with pytest.raises(Exception):
+        runinfo.loop0 = ps.PropertyScan({'v1': ps.drange(0, 0.1, 0.1)}, 'voltage')
+    with pytest.raises(Exception):
+        runinfo.loop1 = ps.PropertyScan({'v1': ps.drange(0, 0.1, 0.1)}, 'voltage')
+    with pytest.raises(Exception):
+        runinfo.loop2 = ps.PropertyScan({'v1': ps.drange(0, 0.1, 0.1)}, 'voltage')
+    with pytest.raises(Exception):
+        runinfo.loop3 = ps.PropertyScan({'v1': ps.drange(0, 0.1, 0.1)}, 'voltage')
+    with pytest.raises(Exception):
+        sweep = ps.Sweep(runinfo, devices)
+        assert isinstance(sweep, ps.Experiment)