deprecation.txt 34 KB

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