Added edit config button functionality

* QFileSystemWatcher was used to track if the config file was modified #40

Author: Ezequiel Torres

MLC/GUI/Autogenerated/autogenerated.py

@@ -10,7 +10,7 @@
     <x>0</x>
     <y>0</y>
     <width>961</width>
-    <height>552</height>
+    <height>568</height>
    </rect>
   </property>
   <property name="windowTitle">
@@ -24,7 +24,7 @@
        <enum>QTabWidget::North</enum>
       </property>
       <property name="currentIndex">
-       <number>0</number>
+       <number>2</number>
       </property>
       <widget class="QWidget" name="experiment_tab">
        <property name="layoutDirection">
@@ -591,28 +591,35 @@
              <property name="frameShadow">
               <enum>QFrame::Raised</enum>
              </property>
-             <layout class="QHBoxLayout" name="horizontalLayout_7">
-              <item>
+             <layout class="QGridLayout" name="gridLayout_7">
+              <item row="0" column="0">
                <widget class="QPushButton" name="import_config_button">
                 <property name="text">
                  <string>Import</string>
                 </property>
                </widget>
               </item>
-              <item>
+              <item row="0" column="1">
                <widget class="QPushButton" name="export_config_button">
                 <property name="text">
                  <string>Export</string>
                 </property>
                </widget>
               </item>
-              <item>
+              <item row="1" column="0">
                <widget class="QPushButton" name="save_config_button">
                 <property name="text">
                  <string>Save</string>
                 </property>
                </widget>
               </item>
+              <item row="1" column="1">
+               <widget class="QPushButton" name="edit_config_button">
+                <property name="text">
+                 <string>Edit</string>
+                </property>
+               </widget>
+              </item>
              </layout>
             </widget>
            </item>
@@ -1012,6 +1019,22 @@
     </hint>
    </hints>
   </connection>
+  <connection>
+   <sender>edit_config_button</sender>
+   <signal>clicked()</signal>
+   <receiver>ExperimentWindow</receiver>
+   <slot>on_edit_config_button_clicked()</slot>
+   <hints>
+    <hint type="sourcelabel">
+     <x>702</x>
+     <y>517</y>
+    </hint>
+    <hint type="destinationlabel">
+     <x>480</x>
+     <y>283</y>
+    </hint>
+   </hints>
+  </connection>
  </connections>
  <slots>
   <slot>on_closed_dialog()</slot>
@@ -1035,5 +1058,6 @@
   <slot>on_convergence_button_clicked()</slot>
   <slot>on_genealogy_button_clicked()</slot>
   <slot>on_board_config_button_clicked()</slot>
+  <slot>on_edit_config_button_clicked()</slot>
  </slots>
 </ui>

MLC/GUI/Autogenerated/mlc_qtcreator/experiment.ui

@@ -4,7 +4,7 @@
 import numpy as np
 import sys
 import time
-sys.path.append(os.path.abspath(".") + "/../..")
+# sys.path.append(os.path.abspath(".") + "/../..")
 
 from MLC.Log.log import get_gui_logger
 from MLC.GUI.Autogenerated.autogenerated import Ui_ExperimentWindow
@@ -23,6 +23,7 @@
 from PyQt5.QtCore import pyqtSignal
 from PyQt5.QtCore import Qt
 from PyQt5.QtCore import QUrl
+from PyQt5.QtCore import QFileSystemWatcher
 from PyQt5.QtGui import QDesktopServices
 from PyQt5.QtWidgets import QAbstractItemView
 from PyQt5.QtWidgets import QMainWindow
@@ -73,6 +74,16 @@ def __init__(self, mlc_local,
         # Signal to be emitted when the experiment is closed
         self._experiment_closed_signal = experiment_closed_signal
 
+        # Watch changes in the experiment config file
+        self._file_watcher = QFileSystemWatcher()
+        conf_path_list = [self._mlc_local.get_working_dir(),
+                          self._experiment_name,
+                          self._experiment_name + ".conf"]
+        # Use the splat operator to dearrange the list
+        self._experiment_conf_path = os.path.join(*conf_path_list)
+        self._file_watcher.addPath(self._experiment_conf_path)
+        self._file_watcher.fileChanged.connect(self._reload_experiment_config)
+
         # Experiment in progress chart configuration
         self._chart_conf = ChartConfiguration(self._autogenerated_object)
         indivs_per_gen = Config.get_instance().getint("POPULATION", "size")
@@ -204,7 +215,12 @@ def on_dimension_check_clicked(self):
     def on_save_config_button_clicked(self):
         logger.debug('[EXPERIMENT {0}] [SAVE_CONFIG_BUTTON_CLICKED] - Executing on_save_config_button_clicked function'
                      .format(self._experiment_name))
+
+        # Remove the config file from the Qt File watcher momentarily
+        # to avoid rendering unnecesary warnings
+        self._file_watcher.removePath(self._experiment_conf_path)
         self._persist_experiment_config()
+        self._file_watcher.addPath(self._experiment_conf_path)
 
     def on_tab_changed(self, tab_index):
         logger.debug('[EXPERIMENT {0}] [TAB_CHANGED] - Executing on_tab_changed function'
@@ -313,6 +329,12 @@ def on_board_config_button_clicked(self):
         board_config_window = BoardConfigurationWindow(parent=self)
         board_config_window.show()
 
+    def on_edit_config_button_clicked(self):
+        logger.debug('[EXPERIMENT {0}] [EDIT_CONFIG_BUTTON] - '
+                     'Executing on_edit_config_button_clicked function'
+                     .format(self._experiment_name))
+        QDesktopServices.openUrl(QUrl(self._experiment_conf_path))
+
     def _config_table_edited(self, left, right):
         config_table = self._autogenerated_object.config_table
         table_model = config_table.model()
@@ -472,15 +494,23 @@ def _update_experiment_info(self):
         number_of_gens = experiment_info["generations"]
         if number_of_gens == 0:
             from_gen_combo.addItems([str(1)])
-            to_gen_combo.addItems([str(x) for x in xrange(2, ExperimentWindow.MAX_GENERATIONS)])
+            to_gen_combo.addItems([str(x) for x in xrange(2, ExperimentWindow.MAX_GENERATIONS + 1)])
         else:
             from_gen_combo.addItems([str(x) for x in xrange(1, number_of_gens + 1)])
-            to_gen_combo.addItems([str(x) for x in xrange(2, ExperimentWindow.MAX_GENERATIONS)])
+            to_gen_combo.addItems([str(x) for x in xrange(2, ExperimentWindow.MAX_GENERATIONS + 1)])
 
             # Set the from gen combo to the last generation evaluated
             index = from_gen_combo.findText(str(number_of_gens), Qt.MatchFixedString)
             from_gen_combo.setCurrentIndex(index)
 
+            # set the to_gen_combo to the lest generation evaluated + 1
+            to_gen_index = number_of_gens + 1
+            if number_of_gens == ExperimentWindow.MAX_GENERATIONS:
+                to_gen_index = ExperimentWindow.MAX_GENERATIONS
+
+            index = to_gen_combo.findText(str(to_gen_index), Qt.MatchFixedString)
+            to_gen_combo.setCurrentIndex(index)
+
         # Fill the db_view
         gen_count_group = self._autogenerated_object.gen_count_group
         if number_of_gens != 0:
@@ -557,6 +587,23 @@ def _update_individuals_figure(self):
             # Add the Indiv Canvas
             chart_layout.addWidget(indiv_canvas)
 
+    def _reload_experiment_config(self, some_string):
+        logger.debug('[EXPERIMENT {0}] [EXPERIMENT_CONF_FILE_CHANGED] - '
+                     'Executing _experiment_conf_file_changed function'
+                     .format(self._experiment_name))
+
+        self._mlc_local.reload_experiment_configuration(self._experiment_name)
+        self._load_experiment_config()
+
+        QMessageBox.warning(self, "Experiment Config Changed", "The Experiment config file "
+                                  "has changed. The configuration will be reloaded. "
+                                  "The changes made will be discarded")
+        logger.info('[EXPERIMENT {0}] [RELOAD_CONFIG] - Config file has changed. Configuration will be reloaded')
+        self._autogenerated_object.save_config_button.setDisabled(True)
+        # FIXME: Dunno why?, but I have to add the config file to the
+        # watcher in order to work again the next time
+        self._file_watcher.addPath(self._experiment_conf_path)
+
     def _persist_experiment_config(self):
         try:
             self._mlc_local.set_experiment_configuration(self._experiment_name, self._experiment_config)
@@ -579,7 +626,9 @@ def _ask_if_experiment_config_must_be_saved(self):
                                             QMessageBox.Yes | QMessageBox.No,
                                             QMessageBox.Yes)
             if response == QMessageBox.Yes:
+                self._file_watcher.removePath(self._experiment_conf_path)
                 self._persist_experiment_config()
+                self._file_watcher.addPath(self._experiment_conf_path)
             else:
                 self._load_experiment_config()
 

MLC/GUI/Experiment/ExperimentWindow.py

@@ -18,6 +18,7 @@
 
 logger = get_gui_logger()
 
+
 class Experiment:
     # FIXME: one simulation at a time
     __last_simulation = None
@@ -48,6 +49,15 @@ def get_simulation(self):
     def get_configuration(self):
         return Config.to_dictionary(self._configuration)
 
+    def reload_configuration(self):
+        """
+        Load again the experiment configuration, reading the config file from disk
+        """
+        self._configuration = ConfigParser.ConfigParser()
+        self._configuration.read(self._config_file)
+        Config.get_instance().read(self._config_file)
+        return Config.to_dictionary(self._configuration)
+
     def set_configuration(self, new_configuration):
         self._configuration = Config.from_dictionary(new_configuration, config_type=ConfigParser.ConfigParser)
         self._configuration.write(open(self._config_file, "wt"))

MLC/api/Experiment.py

@@ -74,6 +74,12 @@ def get_experiment_configuration(self, experiment_name):
 
         return self._open_experiments[experiment_name].get_configuration()
 
+    def reload_experiment_configuration(self, experiment_name):
+        if experiment_name not in self._open_experiments:
+            raise ClosedExperimentException("get_experiment_configuration", experiment_name)
+
+        return self._open_experiments[experiment_name].reload_configuration()
+
     def open_experiment(self, experiment_name):
         if experiment_name not in self._experiments:
             raise ExperimentNotExistException(experiment_name)

MLC/api/MLCLocal.py

@@ -108,6 +108,14 @@ def get_experiment_configuration(self, experiment_name):
         """
         raise NotImplementedError("MLC::get_experiment_configuration not implemented")
 
+    def reload_experiment_configuration(self, experiment_name):
+        """
+            Load again the experiment configuration.
+            :param experiment_name:
+            :return: experiment configuration.
+        """
+        raise NotImplementedError("MLC::reload_experiment_configuration not implemented")
+
     def set_experiment_configuration_parameter(self, experiment_name, param_section, param_name, value):
         """
             Set a specific parameter value in the experiment configuration.