deprecation.txt 36 KB

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