Merge remote-tracking branch 'origin/dev' into dev

Author: ThomasAkam

com/pycboard.py

@@ -5,8 +5,7 @@
 from serial import SerialException
 from array import array
 from .pyboard import Pyboard, PyboardError
-from config.paths import dirs
-from config.gui_settings import VERSION
+from config.settings import VERSION, dirs, get_setting
 
 # ----------------------------------------------------------------------------------------
 #  Helper functions.
@@ -351,7 +350,7 @@ def setup_state_machine(self, sm_name, sm_dir=None, uploaded=False):
         to board. Instantiate state machine object as state_machine on pyboard.'''
         self.reset()
         if sm_dir is None:
-            sm_dir = dirs['tasks']
+            sm_dir = get_setting("folders","tasks")
         sm_path = os.path.join(sm_dir, sm_name + '.py')
         if uploaded:
             self.print('\nResetting task. ', end='')

config/gui_settings.py

@@ -0,0 +1,47 @@
+import os
+import json
+
+VERSION = "1.8"
+
+top_dir = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))  # Top level pyControl folder.
+dirs = {
+    "config": os.path.join(top_dir, "config"),
+    "framework": os.path.join(top_dir, "pyControl"),
+    "devices": os.path.join(top_dir, "devices"),
+    "gui": os.path.join(top_dir, "gui"),
+    "experiments": os.path.join(top_dir, "experiments"),
+}
+
+default_user_settings = {
+    "folders": {
+        "tasks": os.path.join(top_dir, "tasks"),
+        "data": os.path.join(top_dir, "data"),
+    },
+    "plotting": {
+        "update_interval": 10,
+        "event_history_len": 200,
+        "state_history_len": 100,
+        "analog_history_dur": 12,
+    },
+    "GUI": {
+        "ui_font_size": 11,
+        "log_font_size": 9,
+    },
+}
+
+
+def get_setting(setting_type, setting_name=None):
+    """
+    gets a user setting or group of user settings
+    from the user_settings.json or, if that doesn't exist, 
+    the default_user_settings dictionary
+    """
+    json_path = os.path.join(dirs["config"], "user_settings.json")
+    if os.path.exists(json_path):
+        with open(json_path, "r", encoding='utf-8') as f:
+            user_settings = json.loads(f.read())
+    else:
+        user_settings = default_user_settings
+    if setting_name:
+        return user_settings[setting_type][setting_name]
+    return user_settings[setting_type]

config/paths.py

@@ -1,7 +1,7 @@
 # This is an example custom dialog for more advanced users.
 # Complex custom dialogs can be directly coded using the PyQt framework
 
-from pyqtgraph.Qt import QtGui, QtCore
+from pyqtgraph.Qt import QtGui, QtCore, QtWidgets
 from gui.custom_variables_dialog import Slider_var, Spin_var
 
 # Custom Variable dialog

config/settings.py

@@ -7,10 +7,9 @@
 from serial.tools import list_ports
 from pyqtgraph.Qt import QtGui, QtCore, QtWidgets
 
-from config.paths import dirs
-from config.gui_settings import  VERSION, ui_font_size
+from config.settings import VERSION, dirs, get_setting
 from gui.run_task_tab import Run_task_tab
-from gui.dialogs import Board_config_dialog, Keyboard_shortcuts_dialog, Paths_dialog
+from gui.dialogs import Board_config_dialog, Keyboard_shortcuts_dialog, Settings_dialog
 from gui.configure_experiment_tab import Configure_experiment_tab
 from gui.run_experiment_tab import Run_experiment_tab
 from gui.setups_tab import Setups_tab
@@ -37,15 +36,15 @@ def __init__(self,app):
         self.available_tasks_changed = False
         self.available_experiments_changed = False
         self.available_ports_changed = False
+        self.task_directory = get_setting("folders","tasks")
         self.data_dir_changed = False
         self.current_tab_ind = 0 # Which tab is currently selected.
         self.app = app
 
         # Dialogs.
-
         self.config_dialog = Board_config_dialog(parent=self)
         self.shortcuts_dialog = Keyboard_shortcuts_dialog(parent=self)
-        self.paths_dialog = Paths_dialog(parent=self)
+        self.settings_dialog = Settings_dialog(parent=self)
 
         # Widgets.
         self.tab_widget = QtWidgets.QTabWidget(self)
@@ -68,7 +67,6 @@ def __init__(self,app):
         self.tab_widget.currentChanged.connect(self.tab_changed) 
 
         # Timers
-
         self.refresh_timer = QtCore.QTimer() # Timer to regularly call refresh() when not running.
         self.refresh_timer.timeout.connect(self.refresh)
         self.refresh_timer.start(self.refresh_interval)
@@ -93,8 +91,8 @@ def __init__(self,app):
         ## --------Settings menu--------
         settings_menu = main_menu.addMenu('Settings')
         # Folder paths
-        paths_action = QtGui.QAction("&Folder paths", self)
-        paths_action.triggered.connect(self.paths_dialog.exec)
+        paths_action = QtGui.QAction("&Edit settings", self)
+        paths_action.triggered.connect(self.settings_dialog.exec)
         settings_menu.addAction(paths_action)
         # ---------Help menu----------
         help_menu= main_menu.addMenu('Help')
@@ -122,10 +120,10 @@ def __init__(self,app):
         self.show()
 
     def go_to_data(self):
-        QtGui.QDesktopServices.openUrl(QtCore.QUrl.fromLocalFile(dirs['data']))
+        QtGui.QDesktopServices.openUrl(QtCore.QUrl.fromLocalFile(get_setting("folders","data")))
 
     def go_to_tasks(self):
-        QtGui.QDesktopServices.openUrl(QtCore.QUrl.fromLocalFile(dirs['tasks']))
+        QtGui.QDesktopServices.openUrl(QtCore.QUrl.fromLocalFile(get_setting("folders","tasks")))
 
     def view_docs(self):
         QtGui.QDesktopServices.openUrl(QtCore.QUrl("https://pycontrol.readthedocs.io/en/latest/"))
@@ -140,8 +138,11 @@ 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]
+        # this function gets called every second. Normally we would use get_setting("folder","tasks")
+        # but there no need to constantly be rereading the user_settings.json file that isn't changing
+        # so we use this self.task_directory variable that is only updated when a new user settting is saved
+        for (dirpath, dirnames, filenames) in os.walk(self.task_directory):
+            task_files += [os.path.join(dirpath, file).split(self.task_directory)[1][1:-3]
                            for file in filenames if file.endswith('.py')]
         return task_files
 
@@ -150,12 +151,12 @@ def refresh(self):
         # Scan task folder.
         tasks = self.get_task_file_list()
         self.available_tasks_changed = tasks != self.available_tasks
-        if self.available_tasks_changed:    
+        if self.available_tasks_changed:
             self.available_tasks = tasks
         # Scan experiments folder.
         experiments = [t.split('.')[0] for t in os.listdir(dirs['experiments']) if t[-4:] == '.pcx']
         self.available_experiments_changed = experiments != self.available_experiments
-        if self.available_experiments_changed:    
+        if self.available_experiments_changed:
             self.available_experiments = experiments
         # Scan serial ports.
         ports = set([c[0] for c in list_ports.comports()
@@ -196,7 +197,7 @@ def launch_GUI():
     app.setStyle('Fusion')
     app.setWindowIcon(QtGui.QIcon("gui/icons/logo.svg"))
     font = QtGui.QFont()
-    font.setPixelSize(ui_font_size)
+    font.setPixelSize(get_setting("GUI",("ui_font_size")))
     app.setFont(font)
     gui_main = GUI_main(app)
     sys.excepthook = gui_main.excepthook

config/user_variable_dialogs/blinker_gui_from_py.py

@@ -3,7 +3,7 @@
 import json
 from pyqtgraph.Qt import QtGui, QtCore, QtWidgets
 
-from config.paths import dirs
+from config.settings import dirs, get_setting
 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,TaskSelectMenu
 
@@ -54,7 +54,7 @@ def __init__(self, parent=None):
         self.hardware_test_label = QtWidgets.QLabel('Hardware test:')
         self.hardware_test_select = TaskSelectMenu('no hardware test',add_default=True)
         self.data_dir_label = QtWidgets.QLabel('Data directory:')
-        self.data_dir_text = QtWidgets.QLineEdit(dirs['data'])
+        self.data_dir_text = QtWidgets.QLineEdit(get_setting("folders","data"))
         self.data_dir_button = QtWidgets.QPushButton('')
         self.data_dir_button.setIcon(QtGui.QIcon("gui/icons/folder.svg"))
         self.data_dir_button.setFixedWidth(30)
@@ -124,10 +124,10 @@ def __init__(self, parent=None):
 
     def name_edited(self):
         if not self.custom_dir:
-            self.data_dir_text.setText(os.path.join(dirs['data'], self.name_text.text()))
+            self.data_dir_text.setText(os.path.join(get_setting("folders","data"), self.name_text.text()))
 
     def select_data_dir(self):
-        new_path = QtWidgets.QFileDialog.getExistingDirectory(self, 'Select data folder', dirs['data'])
+        new_path = QtWidgets.QFileDialog.getExistingDirectory(self, 'Select data folder', get_setting("folders","data"))
         if new_path:
             self.data_dir_text.setText(new_path)
             self.custom_dir = True
@@ -142,8 +142,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:
-            self.task_select.update_menu(dirs['tasks'])
-            self.hardware_test_select.update_menu(dirs['tasks'])
+            self.task_select.update_menu(get_setting("folders","tasks"))
+            self.hardware_test_select.update_menu(get_setting("folders","tasks"))
             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,7 +157,7 @@ def refresh(self):
             self.save_button.setEnabled(False)
         if self.GUI_main.data_dir_changed:
             if (str(self.name_text.text()) == '') and not self.custom_dir:
-                self.data_dir_text.setText(dirs['data'])
+                self.data_dir_text.setText(get_setting("folders","data"))
 
     def experiment_dict(self, filtered=False):
         '''Return the current state of the experiments tab as a dictionary.'''
@@ -174,7 +174,7 @@ def new_experiment(self, dialog=True):
         if dialog:
             if not self.save_dialog(): return
         self.name_text.setText('')
-        self.data_dir_text.setText(dirs['data'])
+        self.data_dir_text.setText(get_setting("folders","data"))
         self.custom_dir = False
         self.subjects_table.reset()
         self.variables_table.reset()
@@ -605,7 +605,7 @@ def task_changed(self, task):
         '''Remove variables that are not defined in the new task.'''
         pattern = "[\n\r\.]v\.(?P<vname>\w+)\s*\="
         try:
-            with open(os.path.join(dirs['tasks'], task+'.py'), "r") as file:
+            with open(os.path.join(get_setting("folders","tasks"), task+'.py'), "r") as file:
                 file_content = file.read()
         except FileNotFoundError:
             return

gui/GUI_main.py

@@ -2,7 +2,7 @@
 import json
 import re
 from pyqtgraph.Qt import QtGui, QtCore, QtWidgets
-from config.paths import dirs
+from config.settings import dirs, get_setting
 from gui.utility import variable_constants, null_resize, cbox_set_item, cbox_update_options
 
 # input widgets ---------------------------------------------------------------
@@ -571,7 +571,7 @@ def get_vars(self, task):
         """Remove variables that are not defined in the new task."""
         pattern = "[\n\r]v\.(?P<vname>\w+)\s*\="
         try:
-            with open(os.path.join(dirs["tasks"], task + ".py"), "r") as file:
+            with open(os.path.join(get_setting("folders","tasks"), task + ".py"), "r") as file:
                 file_content = file.read()
         except FileNotFoundError:
             return
@@ -603,9 +603,9 @@ def remove_tab(self):
                 self,
                 "Remove tab",
                 f'Are you sure you want to remove "{self.tab_title_edit.text()}"?',
-                QtWidgets.QMessageBox.Yes | QtWidgets.QMessageBox.Cancel,
+                QtWidgets.QMessageBox.StandardButton.Yes | QtWidgets.QMessageBox.StandardButton.Cancel,
             )
-            if reply == QtWidgets.QMessageBox.Yes:
+            if reply == QtWidgets.QMessageBox.StandardButton.Yes:
                 index = self.tabs.currentIndex()
                 table_key = self.tabs.tabText(index)
                 self.tabs.removeTab(index)