refactor(core): refactored json encoder and decoder.

Author: rsbrost

pyscan/drivers/testing/driver_test_logs/test_instrument_driver_test_log.txt

@@ -1 +1 @@
-Passed with test_instrument_driver version v0.1.0 tested on pyscan version v0.5.1 at 2024-06-18 14:48:00
+Passed with test_instrument_driver version v0.1.0 tested on pyscan version v0.5.3 at 2024-07-05 12:02:04

pyscan/drivers/testing/driver_test_logs/test_voltage_test_log.txt

@@ -1 +1 @@
-Passed with test_voltage version v0.1.0 tested on pyscan version v0.5.1 at 2024-06-18 14:48:00
+Passed with test_voltage version v0.1.0 tested on pyscan version v0.5.3 at 2024-07-05 12:02:04

pyscan/general/__init__.py

@@ -1,6 +1,6 @@
 # objects
 from .item_attribute import ItemAttribute
-from .json_encoder import CustomJSONEncoder
+from .json_encoder import PyscanJSONEncoder
 
 # methods
 from .d_range import drange
@@ -12,4 +12,4 @@
 from .set_difference import set_difference
 from .stack_or_append import stack_or_append
 from .get_pyscan_version import get_pyscan_version
-from .json_decoder import CustomJSONDecoder
+from .json_decoder import PyscanJSONDecoder

pyscan/general/json_decoder.py

@@ -2,7 +2,7 @@
 import json
 
 
-class CustomJSONDecoder(json.JSONDecoder):
+class PyscanJSONDecoder(json.JSONDecoder):
     def __init__(self, *args, **kwargs):
         super().__init__(object_hook=self.item_attribute_object_hook, *args, **kwargs)
 
@@ -21,10 +21,7 @@ def item_attribute_object_hook(self, data):
         ItemAttribute
         '''
         if type(data) is dict:
-            new_data = ItemAttribute()
-
-            for key, value in data.items():
-                new_data[key] = value
+            new_data = ItemAttribute(data)
         else:
             new_data = data
 

pyscan/general/json_encoder.py

@@ -6,7 +6,7 @@
 from pathlib import Path, WindowsPath
 
 
-class CustomJSONEncoder(json.JSONEncoder):
+class PyscanJSONEncoder(json.JSONEncoder):
     """
     A custom JSON encoder subclass that extends json.JSONEncoder to handle additional Python data types
     not supported by the default JSON encoder. This includes handling of custom objects, numpy data types,
@@ -36,23 +36,22 @@ def default(self, obj, debug=False):
         # keys_to_skip = {'logger', 'expt_thread', 'data_path', 'instrument', 'module_id_string', 'spec'}
 
         if type(obj) is type:
-            return f"<class '{obj.__name__}'>"
+            return obj.__name__
         elif isinstance(obj, (InstrumentDriver, ItemAttribute)):
             if debug is True:
                 print(f"obj {obj} was instance of InstrumentDriver and or ItemAttribute.")
             return obj.__dict__
-        elif isinstance(obj, range):
+        elif isinstance(obj, (range, tuple)):
             if debug is True:
-                print(f"obj {obj} was instance of range.")
+                print(f"obj {obj} was instance of {type(obj)}.")
             return list(obj)
         # Handle numpy integers
-        elif isinstance(obj, (np.integer, np.int_, np.intc, np.intp, np.int8, np.int16, np.int32, np.int64,
-                              np.uint8, np.uint16, np.uint32, np.uint64)):
+        elif isinstance(obj, np.integer):
             if debug is True:
                 print(f"Object {obj} is a numpy integer, converting to int.")
             return int(obj)
         # Handle numpy floating values
-        elif isinstance(obj, (np.floating, np.float16, np.float32, np.float64)):
+        elif isinstance(obj, np.floating):
             if debug is True:
                 print(f"Object {obj} is a numpy floating value, converting to float.")
             return float(obj)

pyscan/measurement/abstract_experiment.py

@@ -8,7 +8,7 @@
 from pyscan.general import (ItemAttribute,
                             is_list_type)
 from pyscan.measurement.scans import PropertyScan, RepeatScan
-from pyscan.general.json_encoder import CustomJSONEncoder
+from pyscan.general.json_encoder import PyscanJSONEncoder
 
 
 class AbstractExperiment(ItemAttribute):
@@ -227,8 +227,8 @@ def save_metadata(self):
         save_name = str(save_path.absolute())
 
         with h5py.File(save_name, 'a') as f:
-            f.attrs['runinfo'] = json.dumps(self.runinfo, cls=CustomJSONEncoder)
-            f.attrs['devices'] = json.dumps(self.devices, cls=CustomJSONEncoder)
+            f.attrs['runinfo'] = json.dumps(self.runinfo, cls=PyscanJSONEncoder)
+            f.attrs['devices'] = json.dumps(self.devices, cls=PyscanJSONEncoder)
 
     def start_thread(self):
         '''Starts experiment as a background thread, this works in conjunction with live plot

pyscan/measurement/load_experiment.py

@@ -4,7 +4,7 @@
 import json
 from pathlib import Path
 from pyscan.general import ItemAttribute
-from pyscan.general.json_decoder import CustomJSONDecoder
+from pyscan.general.json_decoder import PyscanJSONDecoder
 
 
 def load_experiment(file_name):
@@ -56,9 +56,9 @@ def load_experiment(file_name):
         expt = ItemAttribute()
 
         f = h5py.File('{}'.format(file_name), 'r')
-        expt.runinfo = json.loads(f.attrs['runinfo'], cls=CustomJSONDecoder)
+        expt.runinfo = json.loads(f.attrs['runinfo'], cls=PyscanJSONDecoder)
 
-        expt.devices = json.loads(f.attrs['devices'], cls=CustomJSONDecoder)
+        expt.devices = json.loads(f.attrs['devices'], cls=PyscanJSONDecoder)
 
         for key, value in f.items():
             expt[key] = (f[key][:]).astype('float64')