deprecation.txt 52 KB

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