New data file format review (#83)

- Fixed broken custom variable dialogs. fix was needed because state_machine.py no longer returns a string repr() of the value, but instead returns the value itself

- print variables at run start

- fixed bug where changing experiment configurations between sessions would cause the 2nd session to freeze

- remove file-type setting in gui,  data logger hardcoded to use tsv

Author: alustig3

config/user_variable_dialogs/blinker_gui_from_py.py

@@ -58,8 +58,8 @@ def __init__(self, parent, grid_layout, board, init_vars):
         row += 1
 
         # radio buttons
-        red_is_enabled = eval(init_vars["red_enabled"])
-        green_is_enabled = eval(init_vars["green_enabled"])
+        red_is_enabled = init_vars["red_enabled"]
+        green_is_enabled = init_vars["green_enabled"]
         self.both_radio = QtWidgets.QRadioButton()
         self.both_lbl = QtWidgets.QLabel("🔴Both🟢")
         self.red_radio = QtWidgets.QRadioButton()

gui/configure_experiment_tab.py

@@ -64,20 +64,15 @@ def __init__(self, parent=None):
         data_dir_button = QtWidgets.QPushButton('')
         data_dir_button.setIcon(QtGui.QIcon("gui/icons/folder.svg"))
         data_dir_button.setFixedWidth(30)
-        filetype_label = QtWidgets.QLabel('File type')
-        self.filetype_select =  QtWidgets.QComboBox()
-        self.filetype_select.addItems(["tsv", "txt"])
 
         self.experiment_parameters_layout = QtWidgets.QGridLayout()
         self.experiment_parameters_layout.addWidget(task_label,0,0,QtCore.Qt.AlignmentFlag.AlignCenter)
         self.experiment_parameters_layout.addWidget(hardware_test_label,0,1,QtCore.Qt.AlignmentFlag.AlignCenter)
         self.experiment_parameters_layout.addWidget(data_dir_label,0,2,1,2,QtCore.Qt.AlignmentFlag.AlignCenter)
-        self.experiment_parameters_layout.addWidget(filetype_label,0,4,QtCore.Qt.AlignmentFlag.AlignCenter)
         self.experiment_parameters_layout.addWidget(self.task_select,1,0)
         self.experiment_parameters_layout.addWidget(self.hardware_test_select,1,1)
         self.experiment_parameters_layout.addWidget(self.data_dir_text,1,2)
         self.experiment_parameters_layout.addWidget(data_dir_button,1,3)
-        self.experiment_parameters_layout.addWidget(self.filetype_select,1,4)
 
         expbox_Vlayout = QtWidgets.QVBoxLayout(self.experiment_groupbox)
         expbox_Vlayout.addLayout(experiment_actions_layout)
@@ -174,7 +169,6 @@ def experiment_dict(self, filtered=False):
                 'task': str(self.task_select.text()),
                 'hardware_test': str(self.hardware_test_select.text()),
                 'data_dir': self.data_dir_text.text(),
-                'file_type': self.filetype_select.currentText(),
                 'subjects': self.subjects_table.subjects_dict(filtered),
                 'variables': self.variables_table.variables_list(),
                 'subset_warning':self.subset_warning_checkbox.isChecked()}
@@ -289,10 +283,6 @@ def load_experiment(self, experiment_name):
             subjects_dict = {subject: {'run':True, 'setup':setup}
                 for setup, subject in experiment['subjects'].items()}
             self.subjects_table.set_from_dict(subjects_dict)
-        if 'file_type' in experiment.keys(): # Experiment file created with GUI version >= 1.9.
-            self.filetype_select.setCurrentText(experiment['file_type'])
-        else:
-            self.filetype_select.setCurrentText('txt')
         self.variables_table.task_changed(experiment['task'])
         self.data_dir_text.setText(experiment['data_dir'])
         self.variables_table.set_from_list(experiment['variables'])

gui/custom_variables_dialog.py

@@ -23,7 +23,7 @@ def __init__(self, init_var_dict, label, spin_min, spin_max, step, varname):
             self.spn = QtWidgets.QSpinBox()
 
         self.spn.setRange(spin_min, spin_max)
-        self.spn.setValue(eval(init_var_dict[varname]))
+        self.spn.setValue(init_var_dict[varname])
         self.spn.setSingleStep(step)
         self.spn.setAlignment(center)
         self.spn.setMinimumWidth(spin_width)
@@ -77,7 +77,7 @@ def reload(self):
         """Reload value from sm_info.  sm_info is updated when variables are output
         during framework run due to get/set."""
         self.value_text_colour("black")
-        self.spn.setValue(eval(str(self.board.sm_info["variables"][self.varname])))
+        self.spn.setValue(self.board.sm_info["variables"][self.varname])
         QtCore.QTimer.singleShot(1000, self.value_text_colour)
 
     def setVisible(self, makeVisible):
@@ -111,7 +111,7 @@ def __init__(self, init_var_dict, label, varname, text_width=80):
         self.line_edit.setAlignment(center)
         self.line_edit.setMinimumWidth(text_width)
         self.line_edit.setMaximumWidth(text_width)
-        self.line_edit.setText(init_var_dict[varname])
+        self.line_edit.setText(str(init_var_dict[varname]))
         self.line_edit.textChanged.connect(lambda x: self.value_text_colour("black"))
         self.line_edit.returnPressed.connect(self.set)
         self.value_text_colour("gray")
@@ -186,7 +186,7 @@ def __init__(self, init_var_dict, label, varname):
         self.label = QtWidgets.QLabel(label)
         self.label.setAlignment(QtCore.Qt.AlignmentFlag.AlignRight | QtCore.Qt.AlignmentFlag.AlignVCenter)
         self.checkbox = QtWidgets.QCheckBox()
-        self.checkbox.setChecked(eval(init_var_dict[varname]))
+        self.checkbox.setChecked(init_var_dict[varname])
         self.checkbox.clicked.connect(self.set)
 
     def setBoard(self, board):
@@ -264,7 +264,7 @@ def __init__(self, init_var_dict, label, slide_min, slide_max, step, varname):
         self.slider.setTickPosition(QtWidgets.QSlider.TickPosition.TicksBelow)
         self.slider.setInterval(step)
         self.slider.setRange(slide_min, slide_max)
-        self.slider.setValue(eval(init_var_dict[varname]))
+        self.slider.setValue(init_var_dict[varname])
 
         self.suffix = ""
         self.label = QtWidgets.QLabel(label)

gui/dialogs.py

@@ -458,7 +458,7 @@ def select_path(self):
             self.show_edit()
 
     def show_edit(self):
-        if self.path_text.text() != self.path:
+        if self.get() != self.path:
             if self.edited is False:
                 self.edited = True
                 self.name_label.setStyleSheet("color:red;")
@@ -515,7 +515,7 @@ def show_edit(self):
         also keeps a running tally of how many settings have been edited
         and enables/disables the "Save settings" button accordingly
         """
-        if self.spn.value() != self.start_value:
+        if self.get() != self.start_value:
             if self.edited is False:
                 self.edited = True
                 self.label.setStyleSheet("color:red;")

gui/plotting.py

@@ -315,6 +315,7 @@ def close_experiment(self):
             subject_plot.setParent(None)
             subject_plot.deleteLater()
         self.subject_tabs.closeDetachedTabs()
+        self.subject_plots.clear()
         self.close()
 
     def update(self):

gui/run_experiment_tab.py

@@ -405,7 +405,7 @@ def setup_task(self):
     def make_variables_dialog(self):
         '''Configure variables dialog and ready subjectbox to start experiment. '''
         if 'custom_variables_dialog' in self.board.sm_info['variables']: # Task uses custon variables dialog
-            custom_variables_name = eval(self.board.sm_info['variables']['custom_variables_dialog'])
+            custom_variables_name = self.board.sm_info['variables']['custom_variables_dialog']
             potential_dialog = Custom_variables_dialog(self,custom_variables_name, is_experiment=True)
             if potential_dialog.custom_gui == "json_gui":
                 self.variables_dialog = potential_dialog
@@ -440,7 +440,7 @@ def start_task(self):
         self.start_time = datetime.now()
         ex = self.run_exp_tab.experiment
         self.print_to_log('\nStarting experiment.\n')
-        self.data_logger.open_data_file(ex['data_dir'], ex['name'], self.setup_name, self.subject, ex['file_type'], datetime.now())
+        self.data_logger.open_data_file(ex['data_dir'], ex['name'], self.setup_name, self.subject, "tsv", datetime.now())
         if self.subject_variables: # Write variables set pre run to data file.
             var_dict  = {v_name: eval(v_value) for v_name, v_value, pv in self.variables_set_pre_run}
             self.data_logger.write_to_file([Datatuple(type='V',time=0, ID='set', data=json.dumps(var_dict))])

gui/run_task_tab.py

@@ -82,18 +82,13 @@ def __init__(self, parent=None):
         data_dir_button.setFixedWidth(30)
         subject_label = QtWidgets.QLabel("Subject ID:")
         self.subject_text = QtWidgets.QLineEdit()
-        filetype_label = QtWidgets.QLabel("File type:")
-        self.filetype_select =  QtWidgets.QComboBox()
-        self.filetype_select.addItems(["tsv", "txt"])
 
         filegroup_layout = QtWidgets.QGridLayout()
         filegroup_layout.addWidget(data_dir_label, 0, 0)
-        filegroup_layout.addWidget(self.data_dir_text, 0, 1, 1, 2)
-        filegroup_layout.addWidget(data_dir_button, 0, 3)
+        filegroup_layout.addWidget(self.data_dir_text, 0, 1)
+        filegroup_layout.addWidget(data_dir_button, 0, 2)
         filegroup_layout.addWidget(subject_label, 1, 0)
         filegroup_layout.addWidget(self.subject_text, 1, 1)
-        filegroup_layout.addWidget(filetype_label, 1, 2)
-        filegroup_layout.addWidget(self.filetype_select, 1, 3)
         self.file_groupbox.setLayout(filegroup_layout)
 
         self.data_dir_text.textChanged.connect(self.test_data_path)
@@ -323,7 +318,7 @@ def setup_task(self):
             self.variables_dialog = Variables_dialog(self, self.board)
             self.using_json_gui = False
             if "custom_variables_dialog" in self.board.sm_info["variables"]:
-                custom_variables_name = eval(self.board.sm_info["variables"]["custom_variables_dialog"])
+                custom_variables_name = self.board.sm_info["variables"]["custom_variables_dialog"]
                 potential_dialog = Custom_variables_dialog(self, custom_variables_name)
                 if potential_dialog.custom_gui == "json_gui":
                     self.variables_dialog = potential_dialog
@@ -370,8 +365,7 @@ def start_task(self):
                     return
             subject_ID = self.subject_text.text()
             setup_ID =  self.board_select.currentText()
-            file_type = self.filetype_select.currentText()
-            self.data_logger.open_data_file(self.data_dir, "run_task", setup_ID, subject_ID, file_type)
+            self.data_logger.open_data_file(self.data_dir, "run_task", setup_ID, subject_ID, "tsv")
             self.data_logger.copy_task_file(self.data_dir, self.GUI_main.task_directory, "run_task-task_files")
         self.fresh_task = False
         self.running = True

pyControl/hardware.py

@@ -3,7 +3,7 @@
 from . import timer
 from . import framework as fw
 from . import state_machine as sm
-from .utility import randint, warning
+from .utility import randint, warning, print_variables
 
 # Ring buffer -----------------------------------------------------------------
 
@@ -69,6 +69,7 @@ def run_start():
     # Called at start of each framework run.
     interrupt_queue.reset()
     stream_data_queue.reset()
+    print_variables()
     for IO_object in IO_dict.values():
         IO_object._run_start()