deprecation.txt 35 KB

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