Add the preference model instance to the parameters of the preference_updated signal's.

Author: yohan-omniwork

docs/react_to_updates.rst

@@ -20,15 +20,15 @@ of the signal, which are:
 * ``name`` - the name of the changed preference
 * ``old_value`` - the value of the preference before changing
 * ``new_value`` - the value assigned to the preference after the change
-
+* ``instance`` - the preference Model instance
 An example that just prints a message that the preference was changed is
 below.
 
 .. code-block:: python
 
     # yourapp/util.py
 
-    def notify_on_preference_update(sender, section, name, old_value, new_value, **kwargs):
+    def notify_on_preference_update(sender, section, name, old_value, new_value, instance, **kwargs):
         print("Preference {} in section {} changed from {} to {}".format(
             name, section, old, new))
 

dynamic_preferences/managers.py

@@ -173,6 +173,7 @@ def update_db_pref(self, section, name, value):
                 name=name,
                 old_value=old_value,
                 new_value=value,
+                instance=db_pref
             )
         except self.model.DoesNotExist:
             return self.create_db_pref(section, name, value)

tests/test_preferences.py

@@ -192,6 +192,8 @@ class P(StringPreference):
 def test_preferences_manager_signal(db):
     global_preferences = global_preferences_registry.manager()
     global_preferences["no_section"] = False
+    pref = global_preferences.get_db_pref(name="no_section", section=None)
+
     receiver = MagicMock()
     preference_updated.connect(receiver)
     global_preferences["no_section"] = True
@@ -203,4 +205,5 @@ def test_preferences_manager_signal(db):
         "name": "no_section",
         "old_value": False,
         "new_value": True,
+        "instance": pref
     }.items() <= call_args.items()