deprecation.txt 30 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780
  1. ===========================
  2. Django Deprecation Timeline
  3. ===========================
  4. This document outlines when various pieces of Django will be removed or altered
  5. in a backward incompatible way, following their deprecation, as per the
  6. :ref:`deprecation policy <internal-release-deprecation-policy>`. More details
  7. about each item can often be found in the release notes of two versions prior.
  8. .. _deprecation-removed-in-2.1:
  9. 2.1
  10. ---
  11. See the :ref:`Django 1.9 release notes<deprecated-features-1.9>` for more
  12. details on these changes.
  13. * The ``weak`` argument to ``django.dispatch.signals.Signal.disconnect()`` will
  14. be removed.
  15. * The ``django.forms.extras`` package will be removed.
  16. * The ``assignment_tag`` helper will be removed.
  17. * The ``host`` argument to ``assertsRedirects`` will be removed. The
  18. compatibility layer which allows absolute URLs to be considered equal to
  19. relative ones when the path is identical will also be removed.
  20. * ``Field.rel`` will be removed.
  21. * ``Field.remote_field.to`` attribute will be removed.
  22. .. _deprecation-removed-in-2.0:
  23. 2.0
  24. ---
  25. See the :ref:`Django 1.8 release notes<deprecated-features-1.8>` for more
  26. details on these changes.
  27. * Support for calling a ``SQLCompiler`` directly as an alias for calling its
  28. ``quote_name_unless_alias`` method will be removed.
  29. * ``cycle`` and ``firstof`` template tags will be removed from the ``future``
  30. template tag library (used during the 1.6/1.7 deprecation period).
  31. * ``django.conf.urls.patterns()`` will be removed.
  32. * Support for the ``prefix`` argument to
  33. ``django.conf.urls.i18n.i18n_patterns()`` will be removed.
  34. * ``SimpleTestCase.urls`` will be removed.
  35. * Using an incorrect count of unpacked values in the ``for`` template tag
  36. will raise an exception rather than fail silently.
  37. * The ability to :func:`~django.core.urlresolvers.reverse` URLs using a dotted
  38. Python path will be removed.
  39. * Support for :py:mod:`optparse` will be dropped for custom management commands
  40. (replaced by :py:mod:`argparse`).
  41. * The class :class:`~django.core.management.NoArgsCommand` will be removed. Use
  42. :class:`~django.core.management.BaseCommand` instead, which takes no arguments
  43. by default.
  44. * ``django.core.context_processors`` module will be removed.
  45. * ``django.db.models.sql.aggregates`` module will be removed.
  46. * ``django.contrib.gis.db.models.sql.aggregates`` module will be removed.
  47. * The following methods and properties of ``django.db.sql.query.Query`` will
  48. be removed:
  49. * Properties: ``aggregates`` and ``aggregate_select``
  50. * Methods: ``add_aggregate``, ``set_aggregate_mask``, and
  51. ``append_aggregate_mask``.
  52. * ``django.template.resolve_variable`` will be removed.
  53. * The following private APIs will be removed from
  54. :class:`django.db.models.options.Options` (``Model._meta``):
  55. * ``get_field_by_name()``
  56. * ``get_all_field_names()``
  57. * ``get_fields_with_model()``
  58. * ``get_concrete_fields_with_model()``
  59. * ``get_m2m_with_model()``
  60. * ``get_all_related_objects()``
  61. * ``get_all_related_objects_with_model()``
  62. * ``get_all_related_many_to_many_objects()``
  63. * ``get_all_related_m2m_objects_with_model()``
  64. * The ``error_message`` argument of ``django.forms.RegexField`` will be removed.
  65. * The ``unordered_list`` filter will no longer support old style lists.
  66. * Support for string ``view`` arguments to ``url()`` will be removed.
  67. * The backward compatible shim to rename ``django.forms.Form._has_changed()``
  68. to ``has_changed()`` will be removed.
  69. * The ``removetags`` template filter will be removed.
  70. * The ``remove_tags()`` and ``strip_entities()`` functions in
  71. ``django.utils.html`` will be removed.
  72. * The ``is_admin_site`` argument to
  73. ``django.contrib.auth.views.password_reset()`` will be removed.
  74. * ``django.db.models.field.subclassing.SubfieldBase`` will be removed.
  75. * ``django.utils.checksums`` will be removed; its functionality is included
  76. in django-localflavor 1.1+.
  77. * The ``original_content_type_id`` attribute on
  78. ``django.contrib.admin.helpers.InlineAdminForm`` will be removed.
  79. * The backwards compatibility shim to allow ``FormMixin.get_form()`` to be
  80. defined with no default value for its ``form_class`` argument will be removed.
  81. * The following settings will be removed:
  82. * ``ALLOWED_INCLUDE_ROOTS``
  83. * ``TEMPLATE_CONTEXT_PROCESSORS``
  84. * ``TEMPLATE_DEBUG``
  85. * ``TEMPLATE_DIRS``
  86. * ``TEMPLATE_LOADERS``
  87. * ``TEMPLATE_STRING_IF_INVALID``
  88. * The backwards compatibility alias ``django.template.loader.BaseLoader`` will
  89. be removed.
  90. * Django template objects returned by
  91. :func:`~django.template.loader.get_template` and
  92. :func:`~django.template.loader.select_template` won't accept a
  93. :class:`~django.template.Context` in their
  94. :meth:`~django.template.backends.base.Template.render()` method anymore.
  95. * :doc:`Template response APIs </ref/template-response>` will enforce the use
  96. of :class:`dict` and backend-dependent template objects instead of
  97. :class:`~django.template.Context` and :class:`~django.template.Template`
  98. respectively.
  99. * The ``current_app`` parameter for the following function and classes will be
  100. removed:
  101. * ``django.shortcuts.render()``
  102. * ``django.template.Context()``
  103. * ``django.template.RequestContext()``
  104. * ``django.template.response.TemplateResponse()``
  105. * The ``dictionary`` and ``context_instance`` parameters for the following
  106. functions will be removed:
  107. * ``django.shortcuts.render()``
  108. * ``django.shortcuts.render_to_response()``
  109. * ``django.template.loader.render_to_string()``
  110. * The ``dirs`` parameter for the following functions will be removed:
  111. * ``django.template.loader.get_template()``
  112. * ``django.template.loader.select_template()``
  113. * ``django.shortcuts.render()``
  114. * ``django.shortcuts.render_to_response()``
  115. * Session verification will be enabled regardless of whether or not
  116. ``'django.contrib.auth.middleware.SessionAuthenticationMiddleware'`` is in
  117. ``MIDDLEWARE_CLASSES``.
  118. * Private attribute ``django.db.models.Field.related`` will be removed.
  119. * The ``--list`` option of the ``migrate`` management command will be removed.
  120. * The ``ssi`` template tag will be removed.
  121. * Support for the ``=`` comparison operator in the ``if`` template tag will be
  122. removed.
  123. * The backwards compatibility shims to allow ``Storage.get_available_name()``
  124. and ``Storage.save()`` to be defined without a ``max_length`` argument will
  125. be removed.
  126. * Support for the legacy ``%(<foo>)s`` syntax in ``ModelFormMixin.success_url``
  127. will be removed.
  128. * ``GeoQuerySet`` aggregate methods ``collect()``, ``extent()``, ``extent3d()``,
  129. ``makeline()``, and ``union()`` will be removed.
  130. * Ability to specify ``ContentType.name`` when creating a content type instance
  131. will be removed.
  132. * Support for the old signature of ``allow_migrate`` will be removed. It changed
  133. from ``allow_migrate(self, db, model)`` to
  134. ``allow_migrate(self, db, app_label, model_name=None, **hints)``.
  135. * Support for the syntax of ``{% cycle %}`` that uses comma-separated arguments
  136. will be removed.
  137. .. _deprecation-removed-in-1.9:
  138. 1.9
  139. ---
  140. See the :ref:`Django 1.7 release notes<deprecated-features-1.7>` for more
  141. details on these changes.
  142. * ``django.utils.dictconfig`` will be removed.
  143. * ``django.utils.importlib`` will be removed.
  144. * ``django.utils.tzinfo`` will be removed.
  145. * ``django.utils.unittest`` will be removed.
  146. * The ``syncdb`` command will be removed.
  147. * ``django.db.models.signals.pre_syncdb`` and
  148. ``django.db.models.signals.post_syncdb`` will be removed.
  149. * ``allow_syncdb`` on database routers will no longer automatically become
  150. ``allow_migrate``.
  151. * The legacy method of syncing apps without migrations will be removed,
  152. and migrations will become compulsory for all apps. This includes automatic
  153. loading of ``initial_data`` fixtures and support for initial SQL data.
  154. * All models will need to be defined inside an installed application or
  155. declare an explicit :attr:`~django.db.models.Options.app_label`.
  156. Furthermore, it won't be possible to import them before their application
  157. is loaded. In particular, it won't be possible to import models inside
  158. the root package of their application.
  159. * The model and form ``IPAddressField`` will be removed. A stub field will
  160. remain for compatibility with historical migrations.
  161. * ``AppCommand.handle_app()`` will no longer be supported.
  162. * ``RequestSite`` and ``get_current_site()`` will no longer be importable from
  163. ``django.contrib.sites.models``.
  164. * FastCGI support via the ``runfcgi`` management command will be
  165. removed. Please deploy your project using WSGI.
  166. * ``django.utils.datastructures.SortedDict`` will be removed. Use
  167. :class:`collections.OrderedDict` from the Python standard library instead.
  168. * ``ModelAdmin.declared_fieldsets`` will be removed.
  169. * Instances of ``util.py`` in the Django codebase have been renamed to
  170. ``utils.py`` in an effort to unify all util and utils references.
  171. The modules that provided backwards compatibility will be removed:
  172. * ``django.contrib.admin.util``
  173. * ``django.contrib.gis.db.backends.util``
  174. * ``django.db.backends.util``
  175. * ``django.forms.util``
  176. * ``ModelAdmin.get_formsets`` will be removed.
  177. * The backward compatibility shim introduced to rename the
  178. ``BaseMemcachedCache._get_memcache_timeout()`` method to
  179. ``get_backend_timeout()`` will be removed.
  180. * The ``--natural`` and ``-n`` options for :djadmin:`dumpdata` will be removed.
  181. Use :djadminopt:`--natural-foreign` instead.
  182. * The ``use_natural_keys`` argument for ``serializers.serialize()`` will be
  183. removed. Use ``use_natural_foreign_keys`` instead.
  184. * Private API ``django.forms.forms.get_declared_fields()`` will be removed.
  185. * The ability to use a ``SplitDateTimeWidget`` with ``DateTimeField`` will be
  186. removed.
  187. * The ``WSGIRequest.REQUEST`` property will be removed.
  188. * The class ``django.utils.datastructures.MergeDict`` will be removed.
  189. * The ``zh-cn`` and ``zh-tw`` language codes will be removed and have been
  190. replaced by the ``zh-hans`` and ``zh-hant`` language code respectively.
  191. * The internal ``django.utils.functional.memoize`` will be removed.
  192. * ``django.core.cache.get_cache`` will be removed. Add suitable entries
  193. to :setting:`CACHES` and use :data:`django.core.cache.caches` instead.
  194. * ``django.db.models.loading`` will be removed.
  195. * Passing callable arguments to querysets will no longer be possible.
  196. * ``BaseCommand.requires_model_validation`` will be removed in favor of
  197. ``requires_system_checks``. Admin validators will be replaced by admin
  198. checks.
  199. * The ``ModelAdmin.validator_class`` and ``default_validator_class`` attributes
  200. will be removed.
  201. * ``ModelAdmin.validate()`` will be removed.
  202. * ``django.db.backends.DatabaseValidation.validate_field`` will be removed in
  203. favor of the ``check_field`` method.
  204. * The ``check`` management command will be removed.
  205. * ``django.utils.module_loading.import_by_path`` will be removed in favor of
  206. ``django.utils.module_loading.import_string``.
  207. * ``ssi`` and ``url`` template tags will be removed from the ``future`` template
  208. tag library (used during the 1.3/1.4 deprecation period).
  209. * ``django.utils.text.javascript_quote`` will be removed.
  210. * Database test settings as independent entries in the database settings,
  211. prefixed by ``TEST_``, will no longer be supported.
  212. * The `cache_choices` option to :class:`~django.forms.ModelChoiceField` and
  213. :class:`~django.forms.ModelMultipleChoiceField` will be removed.
  214. * The default value of the
  215. :attr:`RedirectView.permanent <django.views.generic.base.RedirectView.permanent>`
  216. attribute will change from ``True`` to ``False``.
  217. * ``django.contrib.sitemaps.FlatPageSitemap`` will be removed in favor of
  218. ``django.contrib.flatpages.sitemaps.FlatPageSitemap``.
  219. * Private API ``django.test.utils.TestTemplateLoader`` will be removed.
  220. * The ``django.contrib.contenttypes.generic`` module will be removed.
  221. * Private APIs ``django.db.models.sql.where.WhereNode.make_atom()`` and
  222. ``django.db.models.sql.where.Constraint`` will be removed.
  223. .. _deprecation-removed-in-1.8:
  224. 1.8
  225. ---
  226. See the :ref:`Django 1.6 release notes<deprecated-features-1.6>` for more
  227. details on these changes.
  228. * ``django.contrib.comments`` will be removed.
  229. * The following transaction management APIs will be removed:
  230. - ``TransactionMiddleware``,
  231. - the decorators and context managers ``autocommit``, ``commit_on_success``,
  232. and ``commit_manually``, defined in ``django.db.transaction``,
  233. - the functions ``commit_unless_managed`` and ``rollback_unless_managed``,
  234. also defined in ``django.db.transaction``,
  235. - the ``TRANSACTIONS_MANAGED`` setting.
  236. Upgrade paths are described in the :ref:`transaction management docs
  237. <transactions-upgrading-from-1.5>`.
  238. * The :ttag:`cycle` and :ttag:`firstof` template tags will auto-escape their
  239. arguments. In 1.6 and 1.7, this behavior is provided by the version of these
  240. tags in the ``future`` template tag library.
  241. * The ``SEND_BROKEN_LINK_EMAILS`` setting will be removed. Add the
  242. :class:`django.middleware.common.BrokenLinkEmailsMiddleware` middleware to
  243. your :setting:`MIDDLEWARE_CLASSES` setting instead.
  244. * ``django.middleware.doc.XViewMiddleware`` will be removed. Use
  245. ``django.contrib.admindocs.middleware.XViewMiddleware`` instead.
  246. * ``Model._meta.module_name`` was renamed to ``model_name``.
  247. * Remove the backward compatible shims introduced to rename ``get_query_set``
  248. and similar queryset methods. This affects the following classes:
  249. ``BaseModelAdmin``, ``ChangeList``, ``BaseCommentNode``,
  250. ``GenericForeignKey``, ``Manager``, ``SingleRelatedObjectDescriptor`` and
  251. ``ReverseSingleRelatedObjectDescriptor``.
  252. * Remove the backward compatible shims introduced to rename the attributes
  253. ``ChangeList.root_query_set`` and ``ChangeList.query_set``.
  254. * ``django.views.defaults.shortcut`` will be removed, as part of the
  255. goal of removing all ``django.contrib`` references from the core
  256. Django codebase. Instead use
  257. ``django.contrib.contenttypes.views.shortcut``. ``django.conf.urls.shortcut``
  258. will also be removed.
  259. * Support for the Python Imaging Library (PIL) module will be removed, as it
  260. no longer appears to be actively maintained & does not work on Python 3.
  261. You are advised to install `Pillow`_, which should be used instead.
  262. .. _`Pillow`: https://pypi.python.org/pypi/Pillow
  263. * The following private APIs will be removed:
  264. - ``django.db.backend``
  265. - ``django.db.close_connection()``
  266. - ``django.db.backends.creation.BaseDatabaseCreation.set_autocommit()``
  267. - ``django.db.transaction.is_managed()``
  268. - ``django.db.transaction.managed()``
  269. * ``django.forms.widgets.RadioInput`` will be removed in favor of
  270. ``django.forms.widgets.RadioChoiceInput``.
  271. * The module ``django.test.simple`` and the class
  272. ``django.test.simple.DjangoTestSuiteRunner`` will be removed. Instead use
  273. ``django.test.runner.DiscoverRunner``.
  274. * The module ``django.test._doctest`` will be removed. Instead use the doctest
  275. module from the Python standard library.
  276. * The ``CACHE_MIDDLEWARE_ANONYMOUS_ONLY`` setting will be removed.
  277. * Usage of the hard-coded *Hold down "Control", or "Command" on a Mac, to select
  278. more than one.* string to override or append to user-provided ``help_text`` in
  279. forms for ManyToMany model fields will not be performed by Django anymore
  280. either at the model or forms layer.
  281. * The ``Model._meta.get_(add|change|delete)_permission`` methods will
  282. be removed.
  283. * The session key ``django_language`` will no longer be read for backwards
  284. compatibility.
  285. * Geographic Sitemaps will be removed
  286. (``django.contrib.gis.sitemaps.views.index`` and
  287. ``django.contrib.gis.sitemaps.views.sitemap``).
  288. * ``django.utils.html.fix_ampersands``, the ``fix_ampersands`` template filter and
  289. ``django.utils.html.clean_html`` will be removed following an accelerated deprecation.
  290. .. _deprecation-removed-in-1.7:
  291. 1.7
  292. ---
  293. See the :ref:`Django 1.5 release notes<deprecated-features-1.5>` for more
  294. details on these changes.
  295. * The module ``django.utils.simplejson`` will be removed. The standard library
  296. provides :mod:`json` which should be used instead.
  297. * The function ``django.utils.itercompat.product`` will be removed. The Python
  298. builtin version should be used instead.
  299. * Auto-correction of INSTALLED_APPS and TEMPLATE_DIRS settings when they are
  300. specified as a plain string instead of a tuple will be removed and raise an
  301. exception.
  302. * The ``mimetype`` argument to the ``__init__`` methods of
  303. :class:`~django.http.HttpResponse`,
  304. :class:`~django.template.response.SimpleTemplateResponse`, and
  305. :class:`~django.template.response.TemplateResponse`, will be removed.
  306. ``content_type`` should be used instead. This also applies to the
  307. :func:`~django.shortcuts.render_to_response` shortcut and
  308. the sitemap views, :func:`~django.contrib.sitemaps.views.index` and
  309. :func:`~django.contrib.sitemaps.views.sitemap`.
  310. * When :class:`~django.http.HttpResponse` is instantiated with an iterator,
  311. or when :attr:`~django.http.HttpResponse.content` is set to an iterator,
  312. that iterator will be immediately consumed.
  313. * The ``AUTH_PROFILE_MODULE`` setting, and the ``get_profile()`` method on
  314. the User model, will be removed.
  315. * The ``cleanup`` management command will be removed. It's replaced by
  316. ``clearsessions``.
  317. * The ``daily_cleanup.py`` script will be removed.
  318. * The ``depth`` keyword argument will be removed from
  319. :meth:`~django.db.models.query.QuerySet.select_related`.
  320. * The undocumented ``get_warnings_state()``/``restore_warnings_state()``
  321. functions from :mod:`django.test.utils` and the ``save_warnings_state()``/
  322. ``restore_warnings_state()``
  323. :ref:`django.test.*TestCase <django-testcase-subclasses>` methods are
  324. deprecated. Use the :class:`warnings.catch_warnings` context manager
  325. available starting with Python 2.6 instead.
  326. * The undocumented ``check_for_test_cookie`` method in
  327. :class:`~django.contrib.auth.forms.AuthenticationForm` will be removed
  328. following an accelerated deprecation. Users subclassing this form should
  329. remove calls to this method, and instead ensure that their auth related views
  330. are CSRF protected, which ensures that cookies are enabled.
  331. * The version of :func:`django.contrib.auth.views.password_reset_confirm` that
  332. supports base36 encoded user IDs
  333. (``django.contrib.auth.views.password_reset_confirm_uidb36``) will be
  334. removed. If your site has been running Django 1.6 for more than
  335. :setting:`PASSWORD_RESET_TIMEOUT_DAYS`, this change will have no effect. If
  336. not, then any password reset links generated before you upgrade to Django 1.7
  337. won't work after the upgrade.
  338. * The ``django.utils.encoding.StrAndUnicode`` mix-in will be removed.
  339. Define a ``__str__`` method and apply the
  340. :func:`~django.utils.encoding.python_2_unicode_compatible` decorator instead.
  341. .. _deprecation-removed-in-1.6:
  342. 1.6
  343. ---
  344. See the :ref:`Django 1.4 release notes<deprecated-features-1.4>` for more
  345. details on these changes.
  346. * ``django.contrib.databrowse`` will be removed.
  347. * ``django.contrib.localflavor`` will be removed following an accelerated
  348. deprecation.
  349. * ``django.contrib.markup`` will be removed following an accelerated
  350. deprecation.
  351. * The compatibility modules ``django.utils.copycompat`` and
  352. ``django.utils.hashcompat`` as well as the functions
  353. ``django.utils.itercompat.all`` and ``django.utils.itercompat.any`` will
  354. be removed. The Python builtin versions should be used instead.
  355. * The ``csrf_response_exempt`` and ``csrf_view_exempt`` decorators will
  356. be removed. Since 1.4 ``csrf_response_exempt`` has been a no-op (it
  357. returns the same function), and ``csrf_view_exempt`` has been a
  358. synonym for ``django.views.decorators.csrf.csrf_exempt``, which should
  359. be used to replace it.
  360. * The ``django.core.cache.backends.memcached.CacheClass`` backend
  361. was split into two in Django 1.3 in order to introduce support for
  362. PyLibMC. The historical ``CacheClass`` will be removed in favor of
  363. ``django.core.cache.backends.memcached.MemcachedCache``.
  364. * The UK-prefixed objects of ``django.contrib.localflavor.uk`` will only
  365. be accessible through their GB-prefixed names (GB is the correct
  366. ISO 3166 code for United Kingdom).
  367. * The ``IGNORABLE_404_STARTS`` and ``IGNORABLE_404_ENDS`` settings have been
  368. superseded by :setting:`IGNORABLE_404_URLS` in the 1.4 release. They will be
  369. removed.
  370. * The form wizard has been refactored to use class-based views with pluggable
  371. backends in 1.4. The previous implementation will be removed.
  372. * Legacy ways of calling
  373. :func:`~django.views.decorators.cache.cache_page` will be removed.
  374. * The backward-compatibility shim to automatically add a debug-false
  375. filter to the ``'mail_admins'`` logging handler will be removed. The
  376. :setting:`LOGGING` setting should include this filter explicitly if
  377. it is desired.
  378. * The builtin truncation functions ``django.utils.text.truncate_words()``
  379. and ``django.utils.text.truncate_html_words()`` will be removed in
  380. favor of the ``django.utils.text.Truncator`` class.
  381. * The :class:`~django.contrib.gis.geoip.GeoIP` class was moved to
  382. :mod:`django.contrib.gis.geoip` in 1.4 -- the shortcut in
  383. :mod:`django.contrib.gis.utils` will be removed.
  384. * ``django.conf.urls.defaults`` will be removed. The functions
  385. :func:`~django.conf.urls.include`, :func:`~django.conf.urls.patterns` and
  386. :func:`~django.conf.urls.url` plus :data:`~django.conf.urls.handler404`,
  387. :data:`~django.conf.urls.handler500`, are now available through
  388. :mod:`django.conf.urls` .
  389. * The functions ``setup_environ()`` and ``execute_manager()`` will be removed
  390. from :mod:`django.core.management`. This also means that the old (pre-1.4)
  391. style of :file:`manage.py` file will no longer work.
  392. * Setting the ``is_safe`` and ``needs_autoescape`` flags as attributes of
  393. template filter functions will no longer be supported.
  394. * The attribute ``HttpRequest.raw_post_data`` was renamed to ``HttpRequest.body``
  395. in 1.4. The backward compatibility will be removed --
  396. ``HttpRequest.raw_post_data`` will no longer work.
  397. * The value for the ``post_url_continue`` parameter in
  398. ``ModelAdmin.response_add()`` will have to be either ``None`` (to redirect
  399. to the newly created object's edit page) or a pre-formatted url. String
  400. formats, such as the previous default ``'../%s/'``, will not be accepted any
  401. more.
  402. .. _deprecation-removed-in-1.5:
  403. 1.5
  404. ---
  405. See the :ref:`Django 1.3 release notes<deprecated-features-1.3>` for more
  406. details on these changes.
  407. * Starting Django without a :setting:`SECRET_KEY` will result in an exception
  408. rather than a ``DeprecationWarning``. (This is accelerated from the usual
  409. deprecation path; see the :doc:`Django 1.4 release notes</releases/1.4>`.)
  410. * The ``mod_python`` request handler will be removed. The ``mod_wsgi``
  411. handler should be used instead.
  412. * The ``template`` attribute on ``django.test.client.Response``
  413. objects returned by the :ref:`test client <test-client>` will be removed.
  414. The :attr:`~django.test.Response.templates` attribute should be
  415. used instead.
  416. * The ``django.test.simple.DjangoTestRunner`` will be removed.
  417. Instead use a unittest-native class. The features of the
  418. ``django.test.simple.DjangoTestRunner`` (including fail-fast and
  419. Ctrl-C test termination) can currently be provided by the unittest-native
  420. :class:`~unittest.TextTestRunner`.
  421. * The undocumented function
  422. ``django.contrib.formtools.utils.security_hash`` will be removed,
  423. instead use ``django.contrib.formtools.utils.form_hmac``
  424. * The function-based generic view modules will be removed in favor of their
  425. class-based equivalents, outlined :doc:`here
  426. </topics/class-based-views/index>`.
  427. * The ``django.core.servers.basehttp.AdminMediaHandler`` will be
  428. removed. In its place use
  429. ``django.contrib.staticfiles.handlers.StaticFilesHandler``.
  430. * The template tags library ``adminmedia`` and the template tag ``{%
  431. admin_media_prefix %}`` will be removed in favor of the generic static files
  432. handling. (This is faster than the usual deprecation path; see the
  433. :doc:`Django 1.4 release notes</releases/1.4>`.)
  434. * The :ttag:`url` and :ttag:`ssi` template tags will be
  435. modified so that the first argument to each tag is a template variable, not
  436. an implied string. In 1.4, this behavior is provided by a version of the tag
  437. in the ``future`` template tag library.
  438. * The ``reset`` and ``sqlreset`` management commands will be removed.
  439. * Authentication backends will need to support an inactive user
  440. being passed to all methods dealing with permissions.
  441. The ``supports_inactive_user`` attribute will no longer be checked
  442. and can be removed from custom backends.
  443. * :meth:`~django.contrib.gis.geos.GEOSGeometry.transform` will raise
  444. a :class:`~django.contrib.gis.geos.GEOSException` when called
  445. on a geometry with no SRID value.
  446. * ``django.http.CompatCookie`` will be removed in favor of
  447. ``django.http.SimpleCookie``.
  448. * ``django.core.context_processors.PermWrapper`` and
  449. ``django.core.context_processors.PermLookupDict`` will be removed in
  450. favor of the corresponding
  451. ``django.contrib.auth.context_processors.PermWrapper`` and
  452. ``django.contrib.auth.context_processors.PermLookupDict``, respectively.
  453. * The :setting:`MEDIA_URL` or :setting:`STATIC_URL` settings will be
  454. required to end with a trailing slash to ensure there is a consistent
  455. way to combine paths in templates.
  456. * ``django.db.models.fields.URLField.verify_exists`` will be removed. The
  457. feature was deprecated in 1.3.1 due to intractable security and
  458. performance issues and will follow a slightly accelerated deprecation
  459. timeframe.
  460. * Translations located under the so-called *project path* will be ignored during
  461. the translation building process performed at runtime. The
  462. :setting:`LOCALE_PATHS` setting can be used for the same task by including the
  463. filesystem path to a ``locale`` directory containing non-app-specific
  464. translations in its value.
  465. * The Markup contrib app will no longer support versions of Python-Markdown
  466. library earlier than 2.1. An accelerated timeline was used as this was
  467. a security related deprecation.
  468. * The ``CACHE_BACKEND`` setting will be removed. The cache backend(s) should be
  469. specified in the :setting:`CACHES` setting.
  470. .. _deprecation-removed-in-1.4:
  471. 1.4
  472. ---
  473. See the :ref:`Django 1.2 release notes<deprecated-features-1.2>` for more
  474. details on these changes.
  475. * ``CsrfResponseMiddleware`` and ``CsrfMiddleware`` will be removed. Use
  476. the ``{% csrf_token %}`` template tag inside forms to enable CSRF
  477. protection. ``CsrfViewMiddleware`` remains and is enabled by default.
  478. * The old imports for CSRF functionality (``django.contrib.csrf.*``),
  479. which moved to core in 1.2, will be removed.
  480. * The ``django.contrib.gis.db.backend`` module will be removed in favor
  481. of the specific backends.
  482. * ``SMTPConnection`` will be removed in favor of a generic Email backend API.
  483. * The many to many SQL generation functions on the database backends
  484. will be removed.
  485. * The ability to use the ``DATABASE_*`` family of top-level settings to
  486. define database connections will be removed.
  487. * The ability to use shorthand notation to specify a database backend
  488. (i.e., ``sqlite3`` instead of ``django.db.backends.sqlite3``) will be
  489. removed.
  490. * The ``get_db_prep_save``, ``get_db_prep_value`` and
  491. ``get_db_prep_lookup`` methods will have to support multiple databases.
  492. * The ``Message`` model (in ``django.contrib.auth``), its related
  493. manager in the ``User`` model (``user.message_set``), and the
  494. associated methods (``user.message_set.create()`` and
  495. ``user.get_and_delete_messages()``), will be removed. The
  496. :doc:`messages framework </ref/contrib/messages>` should be used
  497. instead. The related ``messages`` variable returned by the
  498. auth context processor will also be removed. Note that this
  499. means that the admin application will depend on the messages
  500. context processor.
  501. * Authentication backends will need to support the ``obj`` parameter for
  502. permission checking. The ``supports_object_permissions`` attribute
  503. will no longer be checked and can be removed from custom backends.
  504. * Authentication backends will need to support the ``AnonymousUser`` class
  505. being passed to all methods dealing with permissions. The
  506. ``supports_anonymous_user`` variable will no longer be checked and can be
  507. removed from custom backends.
  508. * The ability to specify a callable template loader rather than a
  509. ``Loader`` class will be removed, as will the ``load_template_source``
  510. functions that are included with the built in template loaders for
  511. backwards compatibility.
  512. * ``django.utils.translation.get_date_formats()`` and
  513. ``django.utils.translation.get_partial_date_formats()``. These functions
  514. will be removed; use the locale-aware
  515. ``django.utils.formats.get_format()`` to get the appropriate formats.
  516. * In ``django.forms.fields``, the constants: ``DEFAULT_DATE_INPUT_FORMATS``,
  517. ``DEFAULT_TIME_INPUT_FORMATS`` and
  518. ``DEFAULT_DATETIME_INPUT_FORMATS`` will be removed. Use
  519. ``django.utils.formats.get_format()`` to get the appropriate
  520. formats.
  521. * The ability to use a function-based test runner will be removed,
  522. along with the ``django.test.simple.run_tests()`` test runner.
  523. * The ``views.feed()`` view and ``feeds.Feed`` class in
  524. ``django.contrib.syndication`` will be removed. The class-based view
  525. ``views.Feed`` should be used instead.
  526. * ``django.core.context_processors.auth``. This release will
  527. remove the old method in favor of the new method in
  528. ``django.contrib.auth.context_processors.auth``.
  529. * The ``postgresql`` database backend will be removed, use the
  530. ``postgresql_psycopg2`` backend instead.
  531. * The ``no`` language code will be removed and has been replaced by the
  532. ``nb`` language code.
  533. * Authentication backends will need to define the boolean attribute
  534. ``supports_inactive_user`` until version 1.5 when it will be assumed that
  535. all backends will handle inactive users.
  536. * ``django.db.models.fields.XMLField`` will be removed. This was
  537. deprecated as part of the 1.3 release. An accelerated deprecation
  538. schedule has been used because the field hasn't performed any role
  539. beyond that of a simple ``TextField`` since the removal of ``oldforms``.
  540. All uses of ``XMLField`` can be replaced with ``TextField``.
  541. * The undocumented ``mixin`` parameter to the ``open()`` method of
  542. ``django.core.files.storage.Storage`` (and subclasses) will be removed.
  543. .. _deprecation-removed-in-1.3:
  544. 1.3
  545. ---
  546. See the :ref:`Django 1.1 release notes<deprecated-features-1.1>` for more
  547. details on these changes.
  548. * ``AdminSite.root()``. This method of hooking up the admin URLs will be
  549. removed in favor of including ``admin.site.urls``.
  550. * Authentication backends need to define the boolean attributes
  551. ``supports_object_permissions`` and ``supports_anonymous_user`` until
  552. version 1.4, at which point it will be assumed that all backends will
  553. support these options.