deprecation.txt 32 KB

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