deprecation.txt 34 KB

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