- Fixed bug which prevented experiment from running when task or hardware test were in a subdirectory.

- Fixed bug which prevented task file from being copied to data folder if it was in a subdirectory.

- Added more detailed docstring to TaskSelectMenu class (renamed from menuSelect).

- Moved example tasks into 'example' subfolder.

Author: ThomasAkam

com/data_logger.py

@@ -47,7 +47,7 @@ def copy_task_file(self, data_dir, tasks_dir, dir_name='task_files'):
         if not os.path.exists(exp_tasks_dir):
             os.mkdir(exp_tasks_dir)
         task_file_path = os.path.join(tasks_dir, self.sm_info['name']+'.py')
-        task_save_name = self.sm_info['name']+'_{}.py'.format(self.sm_info['task_hash'])
+        task_save_name = os.path.split(self.sm_info['name'])[1] +'_{}.py'.format(self.sm_info['task_hash'])
         if not task_save_name in os.listdir(exp_tasks_dir):
             copyfile(task_file_path, os.path.join(exp_tasks_dir, task_save_name))
 

gui/GUI_main.py

@@ -132,12 +132,13 @@ def view_github(self):
         QtGui.QDesktopServices.openUrl(QtCore.QUrl("https://github.com/pyControl/pyControl"))
 
     def get_task_file_list(self):
-        matches = []
-        for root, dirnames, filenames in os.walk(dirs['tasks']):
-            for filename in filenames:
-                if filename.endswith(('.py')):
-                    matches.append(filename[:-3])
-        return matches
+        '''Return list of .py files in tasks folder and subfolders in format:
+        subdir_1/subdir_2/task_file_name.py'''
+        task_files = []
+        for (dirpath, dirnames, filenames) in os.walk(dirs['tasks']):
+            task_files += [os.path.join(dirpath, file).split(dirs['tasks'])[1][1:-3]
+                           for file in filenames if file.endswith('.py')]
+        return task_files
 
     def refresh(self):
         '''Called regularly when framework not running.'''

gui/configure_experiment_tab.py

@@ -5,7 +5,7 @@
 
 from config.paths import dirs
 from gui.dialogs import invalid_run_experiment_dialog, invalid_save_experiment_dialog,unrun_subjects_dialog
-from gui.utility import TableCheckbox, cbox_update_options, cbox_set_item, null_resize, variable_constants, init_keyboard_shortcuts,menuSelect
+from gui.utility import TableCheckbox, cbox_update_options, cbox_set_item, null_resize, variable_constants, init_keyboard_shortcuts,TaskSelectMenu
 
 # --------------------------------------------------------------------------------
 # Experiments_tab
@@ -46,9 +46,9 @@ def __init__(self, parent=None):
         self.name_label = QtGui.QLabel('Experiment name:')
         self.name_text = QtGui.QLineEdit()
         self.task_label = QtGui.QLabel('Task:')
-        self.task_select = menuSelect(dirs['tasks'],'select task')
+        self.task_select = TaskSelectMenu(dirs['tasks'],'select task')
         self.hardware_test_label = QtGui.QLabel('Hardware test:')
-        self.hardware_test_select = menuSelect(dirs['tasks'],'no hardware test',add_default=True)
+        self.hardware_test_select = TaskSelectMenu(dirs['tasks'],'no hardware test',add_default=True)
         self.data_dir_label = QtGui.QLabel('Data dir:')
         self.data_dir_text = QtGui.QLineEdit(dirs['data'])
         self.data_dir_button = QtGui.QPushButton('')
@@ -153,7 +153,7 @@ def refresh(self):
             if (str(self.name_text.text()) == '') and not self.custom_dir:
                 self.data_dir_text.setText(dirs['data'])
 
-    def experiment_dict(self,filtered = False):
+    def experiment_dict(self, filtered=False):
         '''Return the current state of the experiments tab as a dictionary.'''
         return {'name': self.name_text.text(),
                 'task': str(self.task_select.text()),
@@ -256,7 +256,6 @@ def run_experiment(self):
         '''Check that the experiment is valid. Prompt user to save experiment if
         it is new or has been edited. Then run experiment.'''
         experiment = self.experiment_dict(filtered=True)
-
         if not experiment['name']:
             invalid_run_experiment_dialog(self, 'Experiment must have a name.')
             return

gui/run_task_tab.py

@@ -12,7 +12,7 @@
 
 from gui.dialogs import Variables_dialog
 from gui.plotting import Task_plot
-from gui.utility import init_keyboard_shortcuts,menuSelect
+from gui.utility import init_keyboard_shortcuts,TaskSelectMenu
 
 # Run_task_gui ------------------------------------------------------------------------
 
@@ -105,7 +105,7 @@ def __init__(self, parent=None):
         self.task_groupbox = QtGui.QGroupBox('Task')
 
         self.task_label = QtGui.QLabel('Task:')
-        self.task_select = menuSelect(dirs['tasks'],'select task')
+        self.task_select = TaskSelectMenu(dirs['tasks'],'select task')
         self.task_select.set_callback(self.task_changed)
         self.upload_button = QtGui.QPushButton('Upload')
         self.upload_button.setIcon(QtGui.QIcon("gui/icons/circle-arrow-up.svg"))
@@ -293,35 +293,36 @@ def task_changed(self,task=None):
         self.start_button.setEnabled(False)
 
     def setup_task(self):
+        task = self.task_select.text()
+        if task == 'select task':
+            return
         try:
-            task = self.task_select.text()
-            if task != 'select task':
-                if self.uploaded:
-                    self.status_text.setText('Resetting task..')
-                else:
-                    self.status_text.setText('Uploading..')
-                    self.task_hash = _djb2_file(os.path.join(dirs['tasks'], task + '.py'))
-                self.start_button.setEnabled(False)
-                self.variables_button.setEnabled(False)
-                self.repaint()
-                self.board.setup_state_machine(task, uploaded=self.uploaded)
-                if self.variables_dialog:
-                    self.variables_button.clicked.disconnect()
-                    self.variables_dialog.deleteLater()
-                self.variables_dialog = Variables_dialog(self, self.board)
-                self.variables_button.clicked.connect(self.variables_dialog.exec_)
-                self.variables_button.setEnabled(True)
-                self.task_plot.set_state_machine(self.board.sm_info)
-                self.file_groupbox.setEnabled(True)
-                self.session_groupbox.setEnabled(True)
-                self.start_button.setEnabled(True)
-                self.stop_button.setEnabled(False)
-                self.status_text.setText('Uploaded : ' + task)
-                self.task = task
-                self.fresh_task = True
-                self.uploaded = True
-                self.upload_button.setText('Reset')
-                self.upload_button.setIcon(QtGui.QIcon("gui/icons/refresh.svg"))
+            if self.uploaded:
+                self.status_text.setText('Resetting task..')
+            else:
+                self.status_text.setText('Uploading..')
+                self.task_hash = _djb2_file(os.path.join(dirs['tasks'], task + '.py'))
+            self.start_button.setEnabled(False)
+            self.variables_button.setEnabled(False)
+            self.repaint()
+            self.board.setup_state_machine(task, uploaded=self.uploaded)
+            if self.variables_dialog:
+                self.variables_button.clicked.disconnect()
+                self.variables_dialog.deleteLater()
+            self.variables_dialog = Variables_dialog(self, self.board)
+            self.variables_button.clicked.connect(self.variables_dialog.exec_)
+            self.variables_button.setEnabled(True)
+            self.task_plot.set_state_machine(self.board.sm_info)
+            self.file_groupbox.setEnabled(True)
+            self.session_groupbox.setEnabled(True)
+            self.start_button.setEnabled(True)
+            self.stop_button.setEnabled(False)
+            self.status_text.setText('Uploaded : ' + task)
+            self.task = task
+            self.fresh_task = True
+            self.uploaded = True
+            self.upload_button.setText('Reset')
+            self.upload_button.setIcon(QtGui.QIcon("gui/icons/refresh.svg"))
         except PyboardError:
             self.status_text.setText('Error setting up state machine.')
 

gui/utility.py

@@ -293,9 +293,19 @@ def dropEvent(self, event):
         self.dragDropedPos = event.pos()
         QtWidgets.QTabBar.dropEvent(self, event)
 
-class menuSelect(QtGui.QPushButton):
-    # https://stackoverflow.com/questions/35924235/how-to-create-combobox-with-combobox-inside-using-pyqt
-    def __init__(self,root_folder,initial_text,add_default = False):
+# ----------------------------------------------------------------------------------
+# TaskSelectMenu
+# ----------------------------------------------------------------------------------
+
+class TaskSelectMenu(QtGui.QPushButton):
+    '''Nested menu used to select tasks. The menu items are the names of
+    any .py files in root_folder and it's sub-directories.  Items are 
+    nested in the menu according to the sub-directory structure. 
+    initial_text is shown before anything is selected, and if add_default
+    is True, initial_text is included as a menu option.
+    Adapted from: https://stackoverflow.com/questions/35924235
+    '''
+    def __init__(self, root_folder, initial_text, add_default=False):
         self.callback = lambda task: None
         self.menu = QtGui.QMenu()
         self.menu_root = root_folder

tasks/all_states_example.py renamed to tasks/example/all_states_example.py

@@ -1,84 +1,84 @@
-# Example of how the all_states function can be used to make things happen in parallel
-# with the state set of a task.  The states cycle the red, green and yellow LEDs on
-# when the usr pushbutton on the pyboard is pressed.  In parallel the blue LED is 
-# flashed on and off using the all_states function and timer events.
-
-# Does not require any hardware except a micropython board.
-
-from pyControl.utility import *
-from devices import *
-
-# Define hardware (normally done in seperate hardware definition file).
-
-pyboard_button = Digital_input('X17', falling_event='button_press', pull='up')  # USR button on pyboard.
-
-blue_LED   = Digital_output('B4')
-red_LED    = Digital_output('A13')
-green_LED  = Digital_output('A14')
-yellow_LED = Digital_output('A15')
-
-# States and events.
-  
-states= ['red_on',
-         'green_on',
-         'yellow_on']
-
-events = ['button_press',
-          'blue_on',
-          'blue_off']
-
-initial_state = 'red_on'
-
-# Run start behaviour.
-
-def run_start():
-    # Turn on blue LED and set timer to turn it off in 1 second.
-    blue_LED.on()
-    set_timer('blue_off', 1*second, output_event=True)
-
-# State behaviour functions.
-
-def red_on(event):
-    # Red LED on, button press transitions to green_on state.
-    if event == 'entry':
-        red_LED.on()
-    elif event == 'exit':
-        red_LED.off()
-    elif event == 'button_press':
-        goto_state('green_on')
-
-def green_on(event):
-    # Green LED on, button press transitions to yellow_on state.
-    if event == 'entry':
-        green_LED.on()
-    elif event == 'exit':
-        green_LED.off()
-    elif event == 'button_press':
-        goto_state('yellow_on')
-
-def yellow_on(event):
-    # Yellow LED on, button press transitions to red_on state.
-    if event == 'entry':
-        yellow_LED.on()
-    elif event == 'exit':
-        yellow_LED.off()
-    elif event == 'button_press':
-        goto_state('red_on')
-
-# State independent behaviour.
-
-def all_states(event):
-    # Turn blue LED on and off when the corrsponding timer trigger, set timer for next blue on/off.
-    if event == 'blue_on':
-        blue_LED.on()
-        set_timer('blue_off', 1*second, output_event=True)
-    elif event == 'blue_off':
-        blue_LED.off()
-        set_timer('blue_on' , 1*second, output_event=True)
-
-# Run end behaviour.
-
-def run_end():
-    # Turn off LEDs at end of run.
-    for LED in [blue_LED, red_LED, green_LED, yellow_LED]:
+# Example of how the all_states function can be used to make things happen in parallel
+# with the state set of a task.  The states cycle the red, green and yellow LEDs on
+# when the usr pushbutton on the pyboard is pressed.  In parallel the blue LED is 
+# flashed on and off using the all_states function and timer events.
+
+# Does not require any hardware except a micropython board.
+
+from pyControl.utility import *
+from devices import *
+
+# Define hardware (normally done in seperate hardware definition file).
+
+pyboard_button = Digital_input('X17', falling_event='button_press', pull='up')  # USR button on pyboard.
+
+blue_LED   = Digital_output('B4')
+red_LED    = Digital_output('A13')
+green_LED  = Digital_output('A14')
+yellow_LED = Digital_output('A15')
+
+# States and events.
+  
+states= ['red_on',
+         'green_on',
+         'yellow_on']
+
+events = ['button_press',
+          'blue_on',
+          'blue_off']
+
+initial_state = 'red_on'
+
+# Run start behaviour.
+
+def run_start():
+    # Turn on blue LED and set timer to turn it off in 1 second.
+    blue_LED.on()
+    set_timer('blue_off', 1*second, output_event=True)
+
+# State behaviour functions.
+
+def red_on(event):
+    # Red LED on, button press transitions to green_on state.
+    if event == 'entry':
+        red_LED.on()
+    elif event == 'exit':
+        red_LED.off()
+    elif event == 'button_press':
+        goto_state('green_on')
+
+def green_on(event):
+    # Green LED on, button press transitions to yellow_on state.
+    if event == 'entry':
+        green_LED.on()
+    elif event == 'exit':
+        green_LED.off()
+    elif event == 'button_press':
+        goto_state('yellow_on')
+
+def yellow_on(event):
+    # Yellow LED on, button press transitions to red_on state.
+    if event == 'entry':
+        yellow_LED.on()
+    elif event == 'exit':
+        yellow_LED.off()
+    elif event == 'button_press':
+        goto_state('red_on')
+
+# State independent behaviour.
+
+def all_states(event):
+    # Turn blue LED on and off when the corrsponding timer trigger, set timer for next blue on/off.
+    if event == 'blue_on':
+        blue_LED.on()
+        set_timer('blue_off', 1*second, output_event=True)
+    elif event == 'blue_off':
+        blue_LED.off()
+        set_timer('blue_on' , 1*second, output_event=True)
+
+# Run end behaviour.
+
+def run_end():
+    # Turn off LEDs at end of run.
+    for LED in [blue_LED, red_LED, green_LED, yellow_LED]:
         LED.off()