Update deprecation popup (#135)

* Update deprecation popup

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* update release notes

* update release notes

* remove suggestion to use deprecated refred version

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

RefRed/configuration/loading_configuration.py

@@ -17,7 +17,9 @@
     PopulateReductionTableFromLConfigDataSet as PopulateReductionTable,
 )
 from RefRed.gui_handling.gui_utility import GuiUtility
-from RefRed.gui_handling.scaling_factor_widgets_handler import ScalingFactorWidgetsHandler
+from RefRed.gui_handling.scaling_factor_widgets_handler import (
+    ScalingFactorWidgetsHandler,
+)
 from RefRed.lconfigdataset import LConfigDataset
 from RefRed.plot.clear_plots import ClearPlots
 from RefRed.status_message_handler import StatusMessageHandler
@@ -26,22 +28,21 @@
 
 
 class LoadingConfiguration(object):
-
     parent = None
     load_config_worked = True
-    filename = ''
+    filename = ""
     dom = None
 
     def __init__(self, parent=None):
         self.parent = parent
-        self.filename = ''
-        StatusMessageHandler(parent=self.parent, message='Loading config ...', is_threaded=False)
+        self.filename = ""
+        StatusMessageHandler(parent=self.parent, message="Loading config ...", is_threaded=False)
 
     def run(self):
         _path = self.parent.path_config
         _filter = "XML (*.xml);; All Files (*.*)"
         filename = ""
-        file_dialog = QFileDialog(self.parent, 'Open Configuration File', _path, _filter)
+        file_dialog = QFileDialog(self.parent, "Open Configuration File", _path, _filter)
         file_dialog.setViewMode(QFileDialog.List)
         if file_dialog.exec_():
             filename = file_dialog.selectedFiles()
@@ -53,13 +54,13 @@ def run(self):
             if self.check_config_file(str(filename)):
                 try:
                     self.loading()
-                    message = 'Done!'
+                    message = "Done!"
                 except:
-                    message = 'Error loading file: aborted'
+                    message = "Error loading file: aborted"
             else:
                 message = "Loading aborted"
         else:
-            message = 'File not found'
+            message = "File not found"
 
         StatusMessageHandler(parent=self.parent, message=message, is_threaded=True)
 
@@ -82,25 +83,26 @@ def check_config_file(self, filename):
         """
         try:
             dom = minidom.parse(filename)
+        # TODO: specify the exception
         except:
             # If we can't parse the file, it's not a valid file
             return False
-        version_tag = dom.getElementsByTagName('version')
+        version_tag = dom.getElementsByTagName("version")
         if len(version_tag) == 0:
-            warning_msg = "The reduction parameters you are about to load are from "
-            warning_msg += "an older version of the reduction.\n\n"
-            warning_msg += "It is NOT advised to mix reduction versions.\n\n"
-            warning_msg += "You should either start refred version 4, or "
-            warning_msg += "reprocess all your data with the new version.\n\n"
-            warning_msg += "Use the following to start version 4:\n\n"
-            warning_msg += "    refred --v4\n\n"
-            warning_msg += "Please consult with your local contact for advise."
+            warning_msg = (
+                "The reduction parameters you are about to load are from "
+                + "an older version of the reduction.\n\n"
+                + "It is NOT advised to mix reduction versions.\n\n"
+                + "If you need to change your reduction parameters,"
+                + "it is recommended to reprocess all your data with the new version.\n\n"
+                + "Please consult with your local contact for advise."
+            )
 
             box = QtWidgets.QMessageBox()
             box.setIcon(QtWidgets.QMessageBox.Critical)
             box.setText(warning_msg)
             box.setWindowTitle("Version warning")
-            box.setStandardButtons(QtWidgets.QMessageBox.Ok | QtWidgets.QMessageBox.Cancel)
+            box.setStandardButtons(QtWidgets.QMessageBox.Ok)
 
             return_value = box.exec()
             if return_value == QtWidgets.QMessageBox.Cancel:
@@ -124,15 +126,15 @@ def display_name_config_file(self):
         o_gui.new_config_file_loaded(config_file_name=self.filename)
 
     def populate_big_table_data_with_lconfig(self):
-        RefLData = self.dom.getElementsByTagName('RefLData')
+        RefLData = self.dom.getElementsByTagName("RefLData")
         big_table_data = TableData(self.parent.REDUCTIONTABLE_MAX_ROWCOUNT)
         for row_index, node in enumerate(RefLData):
             big_table_data.set_reduction_config(row_index, self.getMetadataObject(node))
         self.parent.big_table_data = big_table_data
 
     def populate_main_gui_general_settings(self):
         dom = self.dom
-        RefLData = dom.getElementsByTagName('RefLData')
+        RefLData = dom.getElementsByTagName("RefLData")
 
         # Nothing to set, return early
         if not RefLData:
@@ -142,41 +144,41 @@ def populate_main_gui_general_settings(self):
         #  Assumption: all <RefLData> entries have the same global settings, so the first will suffice
         node_0 = RefLData[0]
 
-        q_step = self.getNodeValue(node_0, 'q_step')
-        if q_step == '':
-            q_step = '0.01'
+        q_step = self.getNodeValue(node_0, "q_step")
+        if q_step == "":
+            q_step = "0.01"
         self.parent.ui.qStep.setText(q_step)
 
-        q_min = self.getNodeValue(node_0, 'q_min')
-        if q_min == '':
-            q_min = '0.005'
+        q_min = self.getNodeValue(node_0, "q_min")
+        if q_min == "":
+            q_min = "0.005"
         _gui_metadata = self.parent.gui_metadata
-        _gui_metadata['q_min'] = q_min
+        _gui_metadata["q_min"] = q_min
         self.parent.gui_metadata = _gui_metadata
 
         # Applying normalization is a general setting for all runs
-        apply_normalization = str2bool(self.getNodeValue(node_0, 'norm_flag'))
+        apply_normalization = str2bool(self.getNodeValue(node_0, "norm_flag"))
         self.parent.ui.useNormalizationFlag.setChecked(apply_normalization)
 
-        angle_offset = self.getNodeValue(node_0, 'angle_offset')
+        angle_offset = self.getNodeValue(node_0, "angle_offset")
         self.parent.ui.angleOffsetValue.setText(angle_offset)
 
-        angle_offset_error = self.getNodeValue(node_0, 'angle_offset_error')
+        angle_offset_error = self.getNodeValue(node_0, "angle_offset_error")
         self.parent.ui.angleOffsetError.setText(angle_offset_error)
 
-        scaling_factor_file = self.getNodeValue(node_0, 'scaling_factor_file')
+        scaling_factor_file = self.getNodeValue(node_0, "scaling_factor_file")
         self.parent.full_scaling_factor_file_name = scaling_factor_file
         short_scaling_factor_file = os.path.basename(scaling_factor_file)
         self.parent.ui.scalingFactorFile.setText(short_scaling_factor_file)
 
         o_scaling_factor_widget = ScalingFactorWidgetsHandler(parent=self.parent)
         o_scaling_factor_widget.fill_incident_medium_list(scaling_factor_file)
         # +1 to make mantid friendly
-        index_selected = int(self.getNodeValue(node_0, 'incident_medium_index_selected')) + 1
+        index_selected = int(self.getNodeValue(node_0, "incident_medium_index_selected")) + 1
         o_scaling_factor_widget.set_index_selected(index_selected)
 
         self.parent.path_ascii = os.path.dirname(scaling_factor_file)
-        scaling_factor_flag = str2bool(self.getNodeValue(node_0, 'scaling_factor_flag'))
+        scaling_factor_flag = str2bool(self.getNodeValue(node_0, "scaling_factor_flag"))
         o_scaling_factor_widget.checkbox(status=scaling_factor_flag)
         o_scaling_factor_widget.set_enabled(status=scaling_factor_flag)
 
@@ -193,94 +195,94 @@ def get_item_boolean(item_name: str, default) -> bool:
 
         iMetadata = LConfigDataset()
 
-        _peak_min = self.getNodeValue(node, 'from_peak_pixels')
-        _peak_max = self.getNodeValue(node, 'to_peak_pixels')
+        _peak_min = self.getNodeValue(node, "from_peak_pixels")
+        _peak_max = self.getNodeValue(node, "to_peak_pixels")
         iMetadata.data_peak = [int(_peak_min), int(_peak_max)]
 
-        _back_min = self.getNodeValue(node, 'back_roi1_from')
-        _back_max = self.getNodeValue(node, 'back_roi1_to')
+        _back_min = self.getNodeValue(node, "back_roi1_from")
+        _back_max = self.getNodeValue(node, "back_roi1_to")
         iMetadata.data_back = [int(_back_min), int(_back_max)]
 
-        _back2_min = self.getNodeValue(node, 'back_roi2_from', default=0)
-        _back2_max = self.getNodeValue(node, 'back_roi2_to', default=0)
+        _back2_min = self.getNodeValue(node, "back_roi2_from", default=0)
+        _back2_max = self.getNodeValue(node, "back_roi2_to", default=0)
         iMetadata.data_back2 = [int(_back2_min), (_back2_max)]
 
-        _low_res_min = self.getNodeValue(node, 'x_min_pixel')
-        _low_res_max = self.getNodeValue(node, 'x_max_pixel')
+        _low_res_min = self.getNodeValue(node, "x_min_pixel")
+        _low_res_max = self.getNodeValue(node, "x_max_pixel")
         iMetadata.data_low_res = [_low_res_min, _low_res_max]
 
         # background settings for reflectivity data
         iMetadata.data_back_flag = get_item_boolean("background_flag", default=True)
         iMetadata.data_two_backgrounds = get_item_boolean("two_backgrounds", default=False)
 
-        _low_res_flag = str2bool(self.getNodeValue(node, 'x_range_flag'))
+        _low_res_flag = str2bool(self.getNodeValue(node, "x_range_flag"))
         iMetadata.data_low_res_flag = _low_res_flag
 
-        _tof_min = self.getNodeValue(node, 'from_tof_range')
-        _tof_max = self.getNodeValue(node, 'to_tof_range')
+        _tof_min = self.getNodeValue(node, "from_tof_range")
+        _tof_max = self.getNodeValue(node, "to_tof_range")
         if float(_tof_min) < 500:  # ms
             _tof_min = str(float(_tof_min) * 1000)
             _tof_max = str(float(_tof_max) * 1000)
         iMetadata.tof_range = [_tof_min, _tof_max]
 
-        _q_min = self.getNodeValue(node, 'from_q_range')
-        _q_max = self.getNodeValue(node, 'to_q_range')
+        _q_min = self.getNodeValue(node, "from_q_range")
+        _q_max = self.getNodeValue(node, "to_q_range")
         iMetadata.q_range = [_q_min, _q_max]
 
-        _lambda_min = self.getNodeValue(node, 'from_lambda_range')
-        _lambda_max = self.getNodeValue(node, 'to_lambda_range')
+        _lambda_min = self.getNodeValue(node, "from_lambda_range")
+        _lambda_max = self.getNodeValue(node, "to_lambda_range")
         iMetadata.lambda_range = [_lambda_min, _lambda_max]
 
-        iMetadata.tof_units = 'micros'
+        iMetadata.tof_units = "micros"
 
-        _data_sets = self.getNodeValue(node, 'data_sets')
-        _data_sets = _data_sets.split(',')
+        _data_sets = self.getNodeValue(node, "data_sets")
+        _data_sets = _data_sets.split(",")
         iMetadata.data_sets = [str(x) for x in _data_sets]
 
-        _tof_auto = str2bool(self.getNodeValue(node, 'tof_range_flag'))
+        _tof_auto = str2bool(self.getNodeValue(node, "tof_range_flag"))
         iMetadata.tof_auto_flag = _tof_auto
 
-        _peak_min = self.getNodeValue(node, 'norm_from_peak_pixels', default=0)
-        _peak_max = self.getNodeValue(node, 'norm_to_peak_pixels', default=0)
+        _peak_min = self.getNodeValue(node, "norm_from_peak_pixels", default=0)
+        _peak_max = self.getNodeValue(node, "norm_to_peak_pixels", default=0)
         iMetadata.norm_peak = [int(_peak_min), int(_peak_max)]
 
-        _back_min = self.getNodeValue(node, 'norm_from_back_pixels', default=0)
-        _back_max = self.getNodeValue(node, 'norm_to_back_pixels', default=0)
+        _back_min = self.getNodeValue(node, "norm_from_back_pixels", default=0)
+        _back_max = self.getNodeValue(node, "norm_to_back_pixels", default=0)
         iMetadata.norm_back = [int(_back_min), int(_back_max)]
 
-        _back2_min = self.getNodeValue(node, 'norm_from_back2_pixels', default=0)
-        _back2_max = self.getNodeValue(node, 'norm_to_back2_pixels', default=0)
+        _back2_min = self.getNodeValue(node, "norm_from_back2_pixels", default=0)
+        _back2_max = self.getNodeValue(node, "norm_to_back2_pixels", default=0)
         iMetadata.norm_back2 = [int(_back2_min), int(_back2_max)]
 
-        _norm_sets = self.getNodeValue(node, 'norm_dataset')
-        _norm_sets = _norm_sets.split(',')
+        _norm_sets = self.getNodeValue(node, "norm_dataset")
+        _norm_sets = _norm_sets.split(",")
         iMetadata.norm_sets = [str(x) for x in _norm_sets]
 
-        _low_res_min = self.getNodeValue(node, 'norm_x_min')
-        _low_res_max = self.getNodeValue(node, 'norm_x_max')
+        _low_res_min = self.getNodeValue(node, "norm_x_min")
+        _low_res_max = self.getNodeValue(node, "norm_x_max")
         iMetadata.norm_low_res = [_low_res_min, _low_res_max]
 
         # background settings for normalization data
         iMetadata.norm_back_flag = get_item_boolean("norm_background_flag", default=True)
         iMetadata.norm_two_backgrounds = get_item_boolean("norm_two_backgrounds", default=False)
 
-        _low_res_flag = str2bool(self.getNodeValue(node, 'norm_x_range_flag'))
+        _low_res_flag = str2bool(self.getNodeValue(node, "norm_x_range_flag"))
         iMetadata.norm_low_res_flag = _low_res_flag
 
         try:
-            _data_full_file_name = self.getNodeValue(node, 'data_full_file_name')
-            _data_full_file_name = _data_full_file_name.split(',')
+            _data_full_file_name = self.getNodeValue(node, "data_full_file_name")
+            _data_full_file_name = _data_full_file_name.split(",")
             _data_full_file_name = [str(x) for x in _data_full_file_name]
         except:
-            _data_full_file_name = ['']
+            _data_full_file_name = [""]
         iMetadata.data_full_file_name = _data_full_file_name
 
         try:
-            _norm_full_file_name = self.getNodeValue(node, 'norm_full_file_name')
-            _norm_full_file_name = _norm_full_file_name.split(',')
+            _norm_full_file_name = self.getNodeValue(node, "norm_full_file_name")
+            _norm_full_file_name = _norm_full_file_name.split(",")
             _norm_full_file_name = [str(x) for x in _norm_full_file_name]
         except:
-            _norm_full_file_name = ['']
+            _norm_full_file_name = [""]
         iMetadata.norm_full_file_name = _norm_full_file_name
 
         return iMetadata

docs/release_notes.rst

@@ -11,6 +11,18 @@ Release Notes
 
 - MR #XYZ: one-liner description
 
+**Of interest to the Developer:**
+
+- MR #XYZ: one-liner description
+
+
+Next
+----
+
+**Of interest to the User**:
+- MR #135: update popup message for v4 deprecation
+
+
 **Of interest to the Developer:**
 
 - MR #126: structure documentation and publish in readthedocs