deprecation.txt 32 KB

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