Merge pull request #11 from alustig3/task-menus

Task selection menu

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

@@ -131,10 +131,19 @@ def view_forum(self):
     def view_github(self):
         QtGui.QDesktopServices.openUrl(QtCore.QUrl("https://github.com/pyControl/pyControl"))
 
+    def get_task_file_list(self):
+        '''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.'''
         # Scan task folder.
-        tasks = [t.split('.')[0] for t in os.listdir(dirs['tasks']) if t[-3:] == '.py']
+        tasks = self.get_task_file_list()
         self.available_tasks_changed = tasks != self.available_tasks
         if self.available_tasks_changed:    
             self.available_tasks = tasks

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
+from gui.utility import TableCheckbox, cbox_update_options, cbox_set_item, null_resize, variable_constants, init_keyboard_shortcuts,TaskSelectMenu
 
 # --------------------------------------------------------------------------------
 # Experiments_tab
@@ -46,11 +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 = QtGui.QComboBox()
-        self.task_select.setFixedWidth(150)
+        self.task_select = TaskSelectMenu(dirs['tasks'],'select task')
         self.hardware_test_label = QtGui.QLabel('Hardware test:')
-        self.hardware_test_select = QtGui.QComboBox()
-        self.hardware_test_select.setFixedWidth(150)
+        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('')
@@ -87,19 +85,17 @@ def __init__(self, parent=None):
         self.variables_groupbox = QtGui.QGroupBox('Variables')
         self.variablesbox_layout = QtGui.QHBoxLayout(self.variables_groupbox)
         self.variables_table = VariablesTable(self)
+        self.task_select.set_callback(self.variables_table.task_changed)
         self.variablesbox_layout.addWidget(self.variables_table)
 
         # Initialise widgets
         self.experiment_select.addItems(['select experiment'])
-        self.task_select.addItems(['select task'])
-        self.hardware_test_select.addItems(['no hardware test'])
 
         # Connect signals.
         self.name_text.textChanged.connect(self.name_edited)
         self.data_dir_text.textEdited.connect(lambda: setattr(self, 'custom_dir', True))
         self.data_dir_button.clicked.connect(self.select_data_dir)
         self.experiment_select.activated[str].connect(self.experiment_changed)
-        self.task_select.activated[str].connect(self.variables_table.task_changed)
         self.new_button.clicked.connect(lambda: self.new_experiment(dialog=True))
         self.delete_button.clicked.connect(self.delete_experiment)
         self.save_button.clicked.connect(self.save_experiment)
@@ -140,8 +136,8 @@ def experiment_changed(self, experiment_name):
     def refresh(self):
         '''Called periodically when not running to update available task, ports, experiments.'''
         if self.GUI_main.available_tasks_changed:
-            cbox_update_options(self.task_select, self.GUI_main.available_tasks)
-            cbox_update_options(self.hardware_test_select, ['no hardware test'] + self.GUI_main.available_tasks)
+            self.task_select.update_menu()
+            self.hardware_test_select.update_menu()
             self.GUI_main.available_tasks_changed = False
         if self.GUI_main.available_experiments_changed:
             cbox_update_options(self.experiment_select, self.GUI_main.available_experiments)
@@ -157,11 +153,11 @@ 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.currentText()),
-                'hardware_test': str(self.hardware_test_select.currentText()),
+                'task': str(self.task_select.text()),
+                'hardware_test': str(self.hardware_test_select.text()),
                 'data_dir': self.data_dir_text.text(),
                 'subjects': self.subjects_table.subjects_dict(filtered),
                 'variables': self.variables_table.variables_list(),
@@ -177,8 +173,8 @@ def new_experiment(self, dialog=True):
         self.subjects_table.reset()
         self.variables_table.reset()
         cbox_set_item(self.experiment_select, 'select experiment', insert=True)
-        cbox_set_item(self.task_select, 'select task', insert=True)
-        cbox_set_item(self.hardware_test_select, 'no hardware test', insert=True)
+        self.task_select.setText('select task')
+        self.hardware_test_select.setText('no hardware test')
         self.subset_warning_checkbox.setChecked(True)
         self.saved_exp_dict = self.experiment_dict()
         self.saved_exp_path = None
@@ -238,8 +234,14 @@ def load_experiment(self, experiment_name):
         with open(exp_path,'r') as exp_file:
             experiment = json.loads(exp_file.read())
         self.name_text.setText(experiment['name'])
-        cbox_set_item(self.task_select, experiment['task'])
-        cbox_set_item(self.hardware_test_select, experiment['hardware_test'])
+        if experiment['task'] in self.GUI_main.available_tasks:
+            self.task_select.setText(experiment['task'])
+        else:
+            self.task_select.setText('select task')
+        if experiment['hardware_test'] in self.GUI_main.available_tasks:
+            self.hardware_test_select.setText(experiment['hardware_test'])
+        else:
+            self.hardware_test_select.setText('no hardware test')
         cbox_set_item(self.experiment_select, experiment['name'])
         self.subset_warning_checkbox.setChecked(experiment['subset_warning'])
         self.variables_table.task_changed(experiment['task'])
@@ -254,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
+from gui.utility import init_keyboard_shortcuts,TaskSelectMenu
 
 # Run_task_gui ------------------------------------------------------------------------
 
@@ -105,7 +105,8 @@ def __init__(self, parent=None):
         self.task_groupbox = QtGui.QGroupBox('Task')
 
         self.task_label = QtGui.QLabel('Task:')
-        self.task_select = QtGui.QComboBox()
+        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"))
         self.variables_button = QtGui.QPushButton('Variables')
@@ -118,7 +119,6 @@ def __init__(self, parent=None):
         self.taskgroup_layout.addWidget(self.variables_button)
         self.task_groupbox.setLayout(self.taskgroup_layout)
 
-        self.task_select.currentTextChanged.connect(self.task_changed)
         self.upload_button.clicked.connect(self.setup_task)        
 
         # Session groupbox.
@@ -175,7 +175,7 @@ def __init__(self, parent=None):
         # Keyboard Shortcuts
 
         shortcut_dict = {
-                        't' : lambda: self.task_select.showPopup(),
+                        't' : lambda: self.task_select.showMenu(),
                         'u' : lambda: self.setup_task(),
                         'Space' : (lambda: self.stop_task() if self.running 
                             else self.start_task() if self.uploaded else None)
@@ -219,8 +219,7 @@ def refresh(self):
             else: # No setups available to connect to.
                     self.connect_button.setEnabled(False)
         if self.GUI_main.available_tasks_changed:
-            self.task_select.clear()
-            self.task_select.addItems(sorted(self.GUI_main.available_tasks))
+            self.task_select.update_menu()
         if self.GUI_main.data_dir_changed and not self.custom_dir:
             self.data_dir_text.setText(dirs['data'])
         if self.task:
@@ -287,15 +286,17 @@ def disconnect(self):
         self.task_changed()
         self.connected = False
 
-    def task_changed(self):
+    def task_changed(self,task=None):
         self.uploaded = False
         self.upload_button.setText('Upload')
         self.upload_button.setIcon(QtGui.QIcon("gui/icons/circle-arrow-up.svg"))
         self.start_button.setEnabled(False)
 
     def setup_task(self):
+        task = self.task_select.text()
+        if task == 'select task':
+            return
         try:
-            task = self.task_select.currentText()
             if self.uploaded:
                 self.status_text.setText('Resetting task..')
             else:

gui/utility.py

@@ -1,4 +1,5 @@
 from pyqtgraph.Qt import QtGui, QtCore, QtWidgets
+import os
 
 # --------------------------------------------------------------------------------
 # GUI utility functions, classes, variables.
@@ -291,3 +292,61 @@ def dropEvent(self, event):
          '''
         self.dragDropedPos = event.pos()
         QtWidgets.QTabBar.dropEvent(self, event)
+
+# ----------------------------------------------------------------------------------
+# 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
+        self.add_default = add_default
+        self.default_text = initial_text
+        super().__init__(initial_text)
+
+    def set_callback(self,callback_fxn):
+        self.callback = callback_fxn
+
+    def create_action(self,text):
+        def fxn():
+            if self.text() != text:
+                self.callback(text)
+                self.setText(text)
+        return fxn
+    
+    def update_menu(self):
+        self.menu.clear()
+        if self.add_default:
+            self.menu.addAction(self.default_text,self.create_action(self.default_text))
+            self.menu.addSeparator() 
+        previous_menu = self.menu
+        current_menu = self.menu
+        for dirName, subdirList, fileList in os.walk(self.menu_root):
+            subfolder = dirName.split(self.menu_root)[1][1:]
+            if subfolder:
+                if any(".py" in filename for filename in fileList): # only add submenu if there are .py files inside
+                    sub_menu = current_menu.addMenu(subfolder.split(os.path.sep)[-1])
+                    for filename in fileList:
+                        if filename.endswith('.py'):
+                            menuItem = filename[:-3]
+                            sub_menu.addAction(menuItem,self.create_action(os.path.join(subfolder,menuItem)))
+                    if subdirList: # continue down to next level
+                        previous_menu = current_menu
+                        current_menu = sub_menu
+                    else: # return up to previous level
+                        current_menu = previous_menu
+            else: # list top level files
+                for filename in fileList:
+                    if filename.endswith('.py'):
+                        menuItem = filename[:-3]
+                        self.menu.addAction(menuItem,self.create_action(menuItem))
+        self.setMenu(self.menu)