Ticket #24487: 0001-Add-guidance-for-the-disappearance-of-SortedDict.patch

docs/releases/1.7.txt

@@ -1512 +1512 @@
 As :class:`~collections.OrderedDict` was added to the standard library in
 Python 2.7, ``SortedDict`` is no longer needed and has been deprecated.
 
+This means that the two additional methods provided by ``SortedDict``, i.e 
+``insert`` and ``value_for_index``, do not exist anymore.
+
+If you relied on these methods to alter structures like form fields, you 
+should now consider treating these ordered dicts as immutable objects, and 
+override them to change their content.
+
+For example, you might want to override ``MyFormClass.base_fields`` to change 
+the ordering of fields for all ``MyFormClass`` instances ; or similarly, you 
+could override ``self.fields`` from inside ``MyFormClass.__init__``, to change
+the fields for a particular form instance. Example from the django codebase::
+
+    PasswordChangeForm.base_fields = OrderedDict(
+    (k, PasswordChangeForm.base_fields[k])
+    for k in ['old_password', 'new_password1', 'new_password2']
+    )
+
+    
 Custom SQL location for models package
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~