deprecation.txt 41 KB

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