diff options
| author | Curtis Maloney <curtis@tinbrain.net> | 2013-08-03 15:41:15 +1000 |
|---|---|---|
| committer | Tim Graham <timograham@gmail.com> | 2013-08-04 07:09:39 -0400 |
| commit | 07876cf02b6db453ca0397c29c225668872fa96d (patch) | |
| tree | 2a27c0e5e6ea67e8736547b42e29c9f43af5433e /docs | |
| parent | b278f7478d37d3620e5addf7cc2070bc38c10871 (diff) | |
Deprecated SortedDict (replaced with collections.OrderedDict)
Thanks Loic Bistuer for the review.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/internals/deprecation.txt | 3 | ||||
| -rw-r--r-- | docs/ref/models/querysets.txt | 7 | ||||
| -rw-r--r-- | docs/ref/utils.txt | 4 | ||||
| -rw-r--r-- | docs/releases/1.7.txt | 7 |
4 files changed, 17 insertions, 4 deletions
diff --git a/docs/internals/deprecation.txt b/docs/internals/deprecation.txt index 3d6cd48b00..9b0dbf8ffa 100644 --- a/docs/internals/deprecation.txt +++ b/docs/internals/deprecation.txt @@ -423,6 +423,9 @@ these changes. * FastCGI support via the ``runfcgi`` management command will be removed. Please deploy your project using WSGI. +* ``django.utils.datastructures.SortedDict`` will be removed. Use + :class:`collections.OrderedDict` from the Python standard library instead. + 2.0 --- diff --git a/docs/ref/models/querysets.txt b/docs/ref/models/querysets.txt index 95dad202fa..c29ac987a6 100644 --- a/docs/ref/models/querysets.txt +++ b/docs/ref/models/querysets.txt @@ -977,14 +977,13 @@ of the arguments is required, but you should use at least one of them. ``select_params`` parameter. Since ``select_params`` is a sequence and the ``select`` attribute is a dictionary, some care is required so that the parameters are matched up correctly with the extra select pieces. - In this situation, you should use a - :class:`django.utils.datastructures.SortedDict` for the ``select`` - value, not just a normal Python dictionary. + In this situation, you should use a :class:`collections.OrderedDict` for + the ``select`` value, not just a normal Python dictionary. This will work, for example:: Blog.objects.extra( - select=SortedDict([('a', '%s'), ('b', '%s')]), + select=OrderedDict([('a', '%s'), ('b', '%s')]), select_params=('one', 'two')) The only thing to be careful about when using select parameters in diff --git a/docs/ref/utils.txt b/docs/ref/utils.txt index 6b614e0c83..599797bedb 100644 --- a/docs/ref/utils.txt +++ b/docs/ref/utils.txt @@ -105,6 +105,10 @@ to distinguish caches by the ``Accept-language`` header. .. class:: SortedDict +.. deprecated:: 1.7 + ``SortedDict`` is deprecated and will be removed in Django 1.9. Use + :class:`collections.OrderedDict` instead. + The :class:`django.utils.datastructures.SortedDict` class is a dictionary that keeps its keys in the order in which they're inserted. diff --git a/docs/releases/1.7.txt b/docs/releases/1.7.txt index d21cb45428..91b932aff1 100644 --- a/docs/releases/1.7.txt +++ b/docs/releases/1.7.txt @@ -167,6 +167,13 @@ on all Python versions. Since ``unittest2`` became the standard library's Python versions, this module isn't useful anymore. It has been deprecated. Use :mod:`unittest` instead. +``django.utils.datastructures.SortedDict`` +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +As :class:`~collections.OrderedDict` was added to the standard library in +Python 2.7, :class:`~django.utils.datastructures.SortedDict` is no longer +needed and has been deprecated. + Custom SQL location for models package ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
