Merge pull request #2567 from rdswift/rename_settings_changed_signal

Add signal when file naming related settings are changed

Author: rdswift

picard/config.py

@@ -12,7 +12,7 @@
 # Copyright (C) 2017 Sophist-UK
 # Copyright (C) 2018 Vishal Choudhary
 # Copyright (C) 2020-2021 Gabriel Ferreira
-# Copyright (C) 2021-2023 Bob Swift
+# Copyright (C) 2021-2024 Bob Swift
 #
 # This program is free software; you can redistribute it and/or
 # modify it under the terms of the GNU General Public License
@@ -136,6 +136,9 @@ class SettingConfigSection(ConfigSection):
     PROFILES_KEY = 'user_profiles'
     SETTINGS_KEY = 'user_profile_settings'
 
+    # Signal emitted when the value of a setting has changed.
+    setting_changed_signal = QtCore.pyqtSignal(str, object, object)
+
     @classmethod
     def init_profile_options(cls):
         ListOption.add_if_missing('profiles', cls.PROFILES_KEY, [])
@@ -190,15 +193,20 @@ def __getitem__(self, name):
         return self.value(name, opt, opt.default)
 
     def __setitem__(self, name, value):
+        old_value = self.__getitem__(name)
         # Don't process settings that are not profile-specific
         if name in profile_groups_all_settings():
             for profile_id, settings in self._get_active_profile_settings():
                 if name in settings:
                     self._save_profile_setting(profile_id, name, value)
+                    if value != old_value:
+                        self.setting_changed_signal.emit(name, old_value, value)
                     return
         key = self.key(name)
         self.__qt_config.setValue(key, value)
         self._memoization[key].dirty = True
+        if value != old_value:
+            self.setting_changed_signal.emit(name, old_value, value)
 
     def _save_profile_setting(self, profile_id, name, value):
         profile_settings = self.__qt_config.profiles[self.SETTINGS_KEY]

test/test_config.py

@@ -446,3 +446,94 @@ def test_var_opt_invalid_value(self):
         # store invalid value in config file directly
         self.config.setValue('setting/var_option', object)
         self.assertEqual(self.config.setting["var_option"], {"a", "b"})
+
+
+class TestPicardConfigSignals(TestPicardConfigCommon):
+
+    def _set_signal_value(self, name: str, old_value: object, new_value: object):
+        self.setting_name = name
+        self.setting_old_value = old_value
+        self.setting_new_value = new_value
+
+    def test_file_naming_signal(self):
+        TextOption('setting', 'option_text', 'abc')
+        BoolOption('setting', 'option_bool', False)
+        IntOption('setting', 'option_int', 1)
+        FloatOption('setting', 'option_float', 1.0)
+        ListOption('setting', 'option_list', [1, 2, 3])
+        Option('setting', 'option_set', {1, 2, 3})
+        Option('setting', 'option_dict', {'a': 1, 'b': 2, 'c': 3})
+
+        self.config.setting.setting_changed_signal.connect(self._set_signal_value)
+
+        # Test text option
+        self.setting_name = ''
+        self.setting_old_value = ''
+        self.setting_new_value = ''
+        self.config.setting['option_text'] = 'def'
+        self.assertEqual(self.setting_name, 'option_text')
+        self.assertEqual(self.setting_old_value, 'abc')
+        self.assertEqual(self.setting_new_value, 'def')
+
+        # Test no signal if set to same value
+        self.setting_name = ''
+        self.setting_old_value = ''
+        self.setting_new_value = ''
+        self.config.setting['option_text'] = 'def'
+        self.assertEqual(self.setting_name, '')
+        self.assertEqual(self.setting_old_value, '')
+        self.assertEqual(self.setting_new_value, '')
+
+        # Test bool option
+        self.setting_name = ''
+        self.setting_old_value = ''
+        self.setting_new_value = ''
+        self.config.setting['option_bool'] = True
+        self.assertEqual(self.setting_name, 'option_bool')
+        self.assertEqual(self.setting_old_value, False)
+        self.assertEqual(self.setting_new_value, True)
+
+        # Test int option
+        self.setting_name = ''
+        self.setting_old_value = ''
+        self.setting_new_value = ''
+        self.config.setting['option_int'] = 2
+        self.assertEqual(self.setting_name, 'option_int')
+        self.assertEqual(self.setting_old_value, 1)
+        self.assertEqual(self.setting_new_value, 2)
+
+        # Test float option
+        self.setting_name = ''
+        self.setting_old_value = ''
+        self.setting_new_value = ''
+        self.config.setting['option_float'] = 2.5
+        self.assertEqual(self.setting_name, 'option_float')
+        self.assertEqual(self.setting_old_value, 1.0)
+        self.assertEqual(self.setting_new_value, 2.5)
+
+        # Test list option
+        self.setting_name = ''
+        self.setting_old_value = ''
+        self.setting_new_value = ''
+        self.config.setting['option_list'] = [3, 2, 1]
+        self.assertEqual(self.setting_name, 'option_list')
+        self.assertEqual(self.setting_old_value, [1, 2, 3])
+        self.assertEqual(self.setting_new_value, [3, 2, 1])
+
+        # Test option (set)
+        self.setting_name = ''
+        self.setting_old_value = ''
+        self.setting_new_value = ''
+        self.config.setting['option_set'] = {4, 5, 6}
+        self.assertEqual(self.setting_name, 'option_set')
+        self.assertEqual(self.setting_old_value, {1, 2, 3})
+        self.assertEqual(self.setting_new_value, {4, 5, 6})
+
+        # Test option (dict)
+        self.setting_name = ''
+        self.setting_old_value = ''
+        self.setting_new_value = ''
+        self.config.setting['option_dict'] = {'a': 3, 'b': 2, 'c': 1}
+        self.assertEqual(self.setting_name, 'option_dict')
+        self.assertEqual(self.setting_old_value, {'a': 1, 'b': 2, 'c': 3})
+        self.assertEqual(self.setting_new_value, {'a': 3, 'b': 2, 'c': 1})