1.11.txt 26 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709
  1. =============================================
  2. Django 1.11 release notes - UNDER DEVELOPMENT
  3. =============================================
  4. Welcome to Django 1.11!
  5. These release notes cover the :ref:`new features <whats-new-1.11>`, as well as
  6. some :ref:`backwards incompatible changes <backwards-incompatible-1.11>` you'll
  7. want to be aware of when upgrading from Django 1.10 or older versions. We've
  8. :ref:`begun the deprecation process for some features
  9. <deprecated-features-1.11>`.
  10. See the :doc:`/howto/upgrade-version` guide if you're updating an existing
  11. project.
  12. Django 1.11 is designated as a :term:`long-term support release`. It will
  13. receive security updates for at least three years after its release. Support
  14. for the previous LTS, Django 1.8, will end in April 2018.
  15. Python compatibility
  16. ====================
  17. Like Django 1.10, Django 1.11 requires Python 2.7, 3.4, or 3.5. We **highly
  18. recommend** and only officially support the latest release of each series.
  19. The Django 1.11.x series is the last to support Python 2. The next major
  20. release, Django 2.0, will only support Python 3.5+.
  21. Deprecating warnings are no longer loud by default
  22. ==================================================
  23. Unlike older versions of Django, Django's own deprecation warnings are no
  24. longer displayed by default. This is consistent with Python's default behavior.
  25. This change allows third-party apps to support both Django 1.11 LTS and Django
  26. 1.8 LTS without having to add code to avoid deprecation warnings.
  27. Following the release of Django 2.0, we suggest that third-party app authors
  28. drop support for all versions of Django prior to 1.11. At that time, you should
  29. be able run your package's tests using ``python -Wd`` so that deprecation
  30. warnings do appear. After making the deprecation warning fixes, your app should
  31. be compatible with Django 2.0.
  32. .. _whats-new-1.11:
  33. What's new in Django 1.11
  34. =========================
  35. Class-based model indexes
  36. -------------------------
  37. The new :mod:`django.db.models.indexes` module contains classes which ease
  38. creating database indexes. Indexes are added to models using the
  39. :attr:`Meta.indexes <django.db.models.Options.indexes>` option.
  40. The :class:`~django.db.models.Index` class creates a b-tree index, as if you
  41. used :attr:`~django.db.models.Field.db_index` on the model field or
  42. :attr:`~django.db.models.Options.index_together` on the model ``Meta`` class.
  43. It can be subclassed to support different index types, such as
  44. :class:`~django.contrib.postgres.indexes.GinIndex`. It also allows defining the
  45. order (ASC/DESC) for the columns of the index.
  46. Minor features
  47. --------------
  48. :mod:`django.contrib.admin`
  49. ~~~~~~~~~~~~~~~~~~~~~~~~~~~
  50. * :attr:`.ModelAdmin.date_hierarchy` can now reference fields across relations.
  51. * The new :meth:`ModelAdmin.get_exclude()
  52. <django.contrib.admin.ModelAdmin.get_exclude>` hook allows specifying the
  53. exclude fields based on the request or model instance.
  54. :mod:`django.contrib.admindocs`
  55. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  56. * ...
  57. :mod:`django.contrib.auth`
  58. ~~~~~~~~~~~~~~~~~~~~~~~~~~
  59. * The default iteration count for the PBKDF2 password hasher is increased by
  60. 20%.
  61. * The :class:`~django.contrib.auth.views.LoginView` and
  62. :class:`~django.contrib.auth.views.LogoutView` class-based views supersede the
  63. deprecated ``login()`` and ``logout()`` function-based views.
  64. * The :class:`~django.contrib.auth.views.PasswordChangeView`,
  65. :class:`~django.contrib.auth.views.PasswordChangeDoneView`,
  66. :class:`~django.contrib.auth.views.PasswordResetView`,
  67. :class:`~django.contrib.auth.views.PasswordResetDoneView`,
  68. :class:`~django.contrib.auth.views.PasswordResetConfirmView`, and
  69. :class:`~django.contrib.auth.views.PasswordResetCompleteView` class-based
  70. views supersede the deprecated ``password_change()``,
  71. ``password_change_done()``, ``password_reset()``, ``password_reset_done()``,
  72. ``password_reset_confirm()``, and ``password_reset_complete()`` function-based
  73. views.
  74. * The new ``post_reset_login`` attribute for
  75. :class:`~django.contrib.auth.views.PasswordResetConfirmView` allows
  76. automatically logging in a user after a successful password reset.
  77. * :func:`~django.contrib.auth.update_session_auth_hash` now rotates the session
  78. key to allow a password change to invalidate stolen session cookies.
  79. * The new ``success_url_allowed_hosts`` attribute for
  80. :class:`~django.contrib.auth.views.LoginView` and
  81. :class:`~django.contrib.auth.views.LogoutView` allows specifying a set of
  82. hosts that are safe for redirecting after login and logout.
  83. * Added password validators ``help_text`` to
  84. :class:`~django.contrib.auth.forms.UserCreationForm`.
  85. * The ``HttpRequest`` is now passed to :func:`~django.contrib.auth.authenticate`
  86. which in turn passes it to the authentication backend if it accepts a
  87. ``request`` argument.
  88. * The :func:`~django.contrib.auth.signals.user_login_failed` signal now
  89. receives a ``request`` argument.
  90. * :class:`~django.contrib.auth.forms.PasswordResetForm` supports custom user
  91. models that use an email field named something other than ``'email'``.
  92. Set :attr:`CustomUser.EMAIL_FIELD
  93. <django.contrib.auth.models.CustomUser.EMAIL_FIELD>` to the name of the field.
  94. * :func:`~django.contrib.auth.get_user_model` can now be called at import time,
  95. even in modules that define models.
  96. :mod:`django.contrib.contenttypes`
  97. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  98. * When stale content types are detected in the
  99. :djadmin:`remove_stale_contenttypes` command, there's now a list of related
  100. objects such as ``auth.Permission``\s that will also be deleted. Previously,
  101. only the content types were listed (and this prompt was after ``migrate``
  102. rather than in a separate command).
  103. :mod:`django.contrib.gis`
  104. ~~~~~~~~~~~~~~~~~~~~~~~~~
  105. * The new :meth:`.GEOSGeometry.from_gml` and :meth:`.OGRGeometry.from_gml`
  106. methods allow creating geometries from GML.
  107. * Added support for the :lookup:`dwithin` lookup on SpatiaLite.
  108. * The OpenLayers-based form widgets now use ``OpenLayers.js`` from
  109. ``https://cdnjs.cloudflare.com`` which is more suitable for production use
  110. than the the old ``http://openlayers.org`` source.
  111. * PostGIS migrations can now change field dimensions.
  112. * Added the ability to pass the `size`, `shape`, and `offset` parameter when
  113. creating :class:`~django.contrib.gis.gdal.GDALRaster` objects.
  114. * Added SpatiaLite support for the
  115. :class:`~django.contrib.gis.db.models.functions.IsValid` function,
  116. :class:`~django.contrib.gis.db.models.functions.MakeValid` function, and
  117. :lookup:`isvalid` lookup.
  118. :mod:`django.contrib.messages`
  119. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  120. * ...
  121. :mod:`django.contrib.postgres`
  122. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  123. * The new ``distinct`` argument for
  124. :class:`~django.contrib.postgres.aggregates.StringAgg` determines if
  125. concatenated values will be distinct.
  126. * The new :class:`~django.contrib.postgres.indexes.GinIndex` class allows
  127. creating gin indexes in the database.
  128. * :class:`~django.contrib.postgres.fields.JSONField` accepts a new ``encoder``
  129. parameter to specify a custom class to encode data types not supported by the
  130. standard encoder.
  131. * The new :class:`~django.contrib.postgres.fields.CITextField` and
  132. :class:`~django.contrib.postgres.operations.CITextExtension` migration
  133. operation allow using PostgreSQL's ``citext`` extension for case-insensitive
  134. lookups.
  135. * The new :class:`~django.contrib.postgres.aggregates.JsonAgg` allows
  136. aggregating values as a JSON array.
  137. :mod:`django.contrib.redirects`
  138. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  139. * ...
  140. :mod:`django.contrib.sessions`
  141. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  142. * ...
  143. :mod:`django.contrib.sitemaps`
  144. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  145. * ...
  146. :mod:`django.contrib.sites`
  147. ~~~~~~~~~~~~~~~~~~~~~~~~~~~
  148. * ...
  149. :mod:`django.contrib.staticfiles`
  150. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  151. * ...
  152. :mod:`django.contrib.syndication`
  153. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  154. * ...
  155. Cache
  156. ~~~~~
  157. * Memcached backends now pass the contents of :setting:`OPTIONS <CACHES-OPTIONS>`
  158. as keyword arguments to the client constructors, allowing for more advanced
  159. control of client behavior. See the :ref:`cache arguments <cache_arguments>`
  160. documentation for examples.
  161. * Memcached backends now allow defining multiple servers as a comma-delimited
  162. string in :setting:`LOCATION <CACHES-LOCATION>`, for convenience with
  163. third-party services that use such strings in environment variables.
  164. CSRF
  165. ~~~~
  166. * ...
  167. Database backends
  168. ~~~~~~~~~~~~~~~~~
  169. * Added the ``skip_locked`` argument to :meth:`.QuerySet.select_for_update()`
  170. on PostgreSQL 9.5+ and Oracle to execute queries with
  171. ``FOR UPDATE SKIP LOCKED``.
  172. * Added the :setting:`TEST['TEMPLATE'] <TEST_TEMPLATE>` setting to let
  173. PostgreSQL users specify a template for creating the test database.
  174. Email
  175. ~~~~~
  176. * Added the :setting:`EMAIL_USE_LOCALTIME` setting to allow sending SMTP date
  177. headers in the local time zone rather than in UTC.
  178. * ``EmailMessage.attach()`` and ``attach_file()`` now fall back to MIME type
  179. ``application/octet-stream`` when binary content that can't be decoded as
  180. UTF-8 is specified for a ``text/*`` attachment.
  181. File Storage
  182. ~~~~~~~~~~~~
  183. * To make it wrappable by :class:`io.TextIOWrapper`,
  184. :class:`~django.core.files.File` now has the ``readable()``, ``writable()``,
  185. and ``seekable()`` methods.
  186. File Uploads
  187. ~~~~~~~~~~~~
  188. * ...
  189. Forms
  190. ~~~~~
  191. * The new :attr:`CharField.empty_value <django.forms.CharField.empty_value>`
  192. attribute allows specifying the Python value to use to represent "empty".
  193. * The new :meth:`Form.get_initial_for_field()
  194. <django.forms.Form.get_initial_for_field>` method returns initial data for a
  195. form field.
  196. Generic Views
  197. ~~~~~~~~~~~~~
  198. * ...
  199. Internationalization
  200. ~~~~~~~~~~~~~~~~~~~~
  201. * Number formatting and the :setting:`NUMBER_GROUPING` setting support
  202. non-uniform digit grouping.
  203. Management Commands
  204. ~~~~~~~~~~~~~~~~~~~
  205. * The new :option:`loaddata --exclude` option allows excluding models and apps
  206. while loading data from fixtures.
  207. * The new :option:`diffsettings --default` option allows specifying a settings
  208. module other than Django's default settings to compare against.
  209. Migrations
  210. ~~~~~~~~~~
  211. * Added support for serialization of ``uuid.UUID`` objects.
  212. Models
  213. ~~~~~~
  214. * Added support for callable values in the ``defaults`` argument of
  215. :meth:`QuerySet.update_or_create()
  216. <django.db.models.query.QuerySet.update_or_create>` and
  217. :meth:`~django.db.models.query.QuerySet.get_or_create`.
  218. * :class:`~django.db.models.ImageField` now has a default
  219. :data:`~django.core.validators.validate_image_file_extension` validator.
  220. * Added support for time truncation to
  221. :class:`~django.db.models.functions.datetime.Trunc` functions.
  222. * Added the :class:`~django.db.models.functions.datetime.ExtractWeek` function
  223. to extract the week from :class:`~django.db.models.DateField` and
  224. :class:`~django.db.models.DateTimeField` and exposed it through the
  225. :lookup:`week` lookup.
  226. * Added the :class:`~django.db.models.functions.datetime.TruncTime` function
  227. to truncate :class:`~django.db.models.DateTimeField` to its time component
  228. and exposed it through the :lookup:`time` lookup.
  229. * Added support for expressions in :meth:`.QuerySet.values` and
  230. :meth:`~.QuerySet.values_list`.
  231. * Added support for query expressions on lookups that take multiple arguments,
  232. such as ``range``.
  233. * You can now use the ``unique=True`` option with
  234. :class:`~django.db.models.FileField`.
  235. Requests and Responses
  236. ~~~~~~~~~~~~~~~~~~~~~~
  237. * Added :meth:`QueryDict.fromkeys() <django.http.QueryDict.fromkeys>`.
  238. * :class:`~django.middleware.common.CommonMiddleware` now sets the
  239. ``Content-Length`` response header for non-streaming responses.
  240. * Added the :setting:`SECURE_HSTS_PRELOAD` setting to allow appending the
  241. ``preload`` directive to the ``Strict-Transport-Security`` header.
  242. * :class:`~django.middleware.http.ConditionalGetMiddleware` now adds the
  243. ``ETag`` header to responses.
  244. Serialization
  245. ~~~~~~~~~~~~~
  246. * The new ``django.core.serializers.base.Serializer.stream_class`` attribute
  247. allows subclasses to customize the default stream.
  248. * The encoder used by the :ref:`JSON serializer <serialization-formats-json>`
  249. can now be customized by passing a ``cls`` keyword argument to the
  250. ``serializers.serialize()`` function.
  251. * :class:`~django.core.serializers.json.DjangoJSONEncoder` now serializes
  252. :class:`~datetime.timedelta` objects (used by
  253. :class:`~django.db.models.DurationField`).
  254. Signals
  255. ~~~~~~~
  256. * ...
  257. Templates
  258. ~~~~~~~~~
  259. * :meth:`~django.utils.safestring.mark_safe` can now be used as a decorator.
  260. * The :class:`~django.template.backends.jinja2.Jinja2` template backend now
  261. supports context processors by setting the ``'context_processors'`` option in
  262. :setting:`OPTIONS <TEMPLATES-OPTIONS>`.
  263. * The :ttag:`regroup` tag now returns ``namedtuple``\s instead of dictionaries
  264. so you can unpack the group object directly in a loop, e.g.
  265. ``{% for grouper, list in regrouped %}``.
  266. * Added a :ttag:`resetcycle` template tag to allow resetting the sequence of
  267. the :ttag:`cycle` template tag.
  268. Tests
  269. ~~~~~
  270. * Added :meth:`.DiscoverRunner.get_test_runner_kwargs` to allow customizing the
  271. keyword arguments passed to the test runner.
  272. * Added the :option:`test --debug-mode` option to help troubleshoot test
  273. failures by setting the :setting:`DEBUG` setting to ``True``.
  274. * The new :func:`django.test.utils.setup_databases` (moved from
  275. ``django.test.runner``) and :func:`~django.test.utils.teardown_databases`
  276. functions make it easier to build custom test runners.
  277. * Added support for :meth:`python:unittest.TestCase.subTest`’s when using the
  278. :option:`test --parallel` option.
  279. URLs
  280. ~~~~
  281. * ...
  282. Validators
  283. ~~~~~~~~~~
  284. * Added :class:`~django.core.validators.FileExtensionValidator` to validate
  285. file extensions and
  286. :data:`~django.core.validators.validate_image_file_extension` to validate
  287. image files.
  288. .. _backwards-incompatible-1.11:
  289. Backwards incompatible changes in 1.11
  290. ======================================
  291. :mod:`django.contrib.gis`
  292. -------------------------
  293. * To simplify the codebase and because it's easier to install than when
  294. ``contrib.gis`` was first released, :ref:`gdalbuild` is now a required
  295. dependency for GeoDjango. In older versions, it's only required for SQLite.
  296. * ``contrib.gis.maps`` is removed as it interfaces with a retired version of
  297. the Google Maps API and seems to be unmaintained. If you're using it, `let
  298. us know <https://code.djangoproject.com/ticket/14284>`_.
  299. * The ``GEOSGeometry`` equality operator now also compares SRID.
  300. Database backend API
  301. --------------------
  302. * The ``DatabaseOperations.time_trunc_sql()`` method is added to support
  303. ``TimeField`` truncation. It accepts a ``lookup_type`` and ``field_name``
  304. arguments and returns the appropriate SQL to truncate the given time field
  305. ``field_name`` to a time object with only the given specificity. The
  306. ``lookup_type`` argument can be either ``'hour'``, ``'minute'``, or
  307. ``'second'``.
  308. * The ``DatabaseOperations.datetime_cast_time_sql()`` method is added to
  309. support the :lookup:`time` lookup. It accepts a ``field_name`` and ``tzname``
  310. arguments and returns the SQL necessary to cast a datetime value to time value.
  311. * To enable ``FOR UPDATE SKIP LOCKED`` support, set
  312. ``DatabaseFeatures.has_select_for_update_skip_locked = True``.
  313. * The new ``DatabaseFeatures.supports_index_column_ordering`` attribute
  314. specifies if a database allows defining ordering for columns in indexes. The
  315. default value is ``True`` and the ``DatabaseIntrospection.get_constraints()``
  316. method should include an ``'orders'`` key in each of the returned
  317. dictionaries with a list of ``'ASC'`` and/or ``'DESC'`` values corresponding
  318. to the the ordering of each column in the index.
  319. * :djadmin:`inspectdb` no longer calls ``DatabaseIntrospection.get_indexes()``
  320. which is deprecated. Custom database backends should ensure all types of
  321. indexes are returned by ``DatabaseIntrospection.get_constraints()``.
  322. Dropped support for PostgreSQL 9.2 and PostGIS 2.0
  323. --------------------------------------------------
  324. Upstream support for PostgreSQL 9.2 ends in September 2017. As a consequence,
  325. Django 1.11 sets PostgreSQL 9.3 as the minimum version it officially supports.
  326. Support for PostGIS 2.0 is also removed as PostgreSQL 9.2 is the last version
  327. to support it.
  328. ``LiveServerTestCase`` binds to port zero
  329. -----------------------------------------
  330. Rather than taking a port range and iterating to find a free port,
  331. ``LiveServerTestCase`` binds to port zero and relies on the operating system
  332. to assign a free port. The ``DJANGO_LIVE_TEST_SERVER_ADDRESS`` environment
  333. variable is no longer used, and as it's also no longer used, the
  334. ``manage.py test --liveserver`` option is removed.
  335. Protection against insecure redirects in :mod:`django.contrib.auth` and ``i18n`` views
  336. --------------------------------------------------------------------------------------
  337. ``LoginView``, ``LogoutView`` (and the deprecated function-based equivalents),
  338. and :func:`~django.views.i18n.set_language` protect users from being redirected
  339. to non-HTTPS ``next`` URLs when the app is running over HTTPS.
  340. ``QuerySet.get_or_create()`` and ``update_or_create()`` validate arguments
  341. --------------------------------------------------------------------------
  342. To prevent typos from passing silently,
  343. :meth:`~django.db.models.query.QuerySet.get_or_create` and
  344. :meth:`~django.db.models.query.QuerySet.update_or_create` check that their
  345. arguments are model fields. This should be backwards-incompatible only in the
  346. fact that it might expose a bug in your project.
  347. ``pytz`` is a required dependency and support for ``settings.TIME_ZONE = None`` is removed
  348. ------------------------------------------------------------------------------------------
  349. To simplify Django's timezone handling, ``pytz`` is now a required dependency.
  350. It's automatically installed along with Django.
  351. Support for ``settings.TIME_ZONE = None`` is removed as the behavior isn't
  352. commonly used and is questionably useful. If you want to automatically detect
  353. the timezone based on the system timezone, you can use `tzlocal
  354. <https://pypi.python.org/pypi/tzlocal>`_::
  355. from tzlocal import get_localzone
  356. TIME_ZONE = get_localzone().zone
  357. This works similar to ``settings.TIME_ZONE = None`` except that it also sets
  358. ``os.environ['TZ']``. `Let us know
  359. <https://groups.google.com/d/topic/django-developers/OAV3FChfuPM/discussion>`__
  360. if there's a use case where you find you can't adapt your code to set a
  361. ``TIME_ZONE``.
  362. HTML changes in admin templates
  363. -------------------------------
  364. ``<p class="help">`` is replaced with a ``<div>`` tag to allow including lists
  365. inside help text.
  366. Read-only fields are wrapped in ``<div class="readonly">...</div>`` instead of
  367. ``<p>...</p>`` to allow any kind of HTML as the field's content.
  368. Miscellaneous
  369. -------------
  370. * If no items in the feed have a ``pubdate`` or ``updateddate`` attribute,
  371. :meth:`SyndicationFeed.latest_post_date()
  372. <django.utils.feedgenerator.SyndicationFeed.latest_post_date>` now returns
  373. the current UTC date/time, instead of a datetime without any timezone
  374. information.
  375. * Support for SpatiaLite < 4.0 is dropped.
  376. * Support for GDAL 1.7 and 1.8 is dropped.
  377. * CSRF failures are logged to the ``django.security.csrf`` logger instead of
  378. ``django.request``.
  379. * :setting:`ALLOWED_HOSTS` validation is no longer disabled when running tests.
  380. If your application includes tests with custom host names, you must include
  381. those host names in :setting:`ALLOWED_HOSTS`. See
  382. :ref:`topics-testing-advanced-multiple-hosts`.
  383. * Using a foreign key's id (e.g. ``'field_id'``) in ``ModelAdmin.list_display``
  384. displays the related object's ID. Remove the ``_id`` suffix if you want the
  385. old behavior of the string representation of the object.
  386. * In model forms, :class:`~django.db.models.CharField` with ``null=True`` now
  387. saves ``NULL`` for blank values instead of empty strings.
  388. * On Oracle, :meth:`Model.validate_unique()
  389. <django.db.models.Model.validate_unique>` no longer checks empty strings for
  390. uniqueness as the database interprets the value as ``NULL``.
  391. * If you subclass :class:`.AbstractUser` and override ``clean()``, be sure it
  392. calls ``super()``. :meth:`.BaseUserManager.normalize_email` is called in a
  393. new :meth:`.AbstractUser.clean` method so that normalization is applied in
  394. cases like model form validation.
  395. * ``EmailField`` and ``URLField`` no longer accept the ``strip`` keyword
  396. argument. Remove it because it doesn't have an effect in older versions of
  397. Django as these fields alway strip whitespace.
  398. * The ``checked`` and ``selected`` attribute rendered by form widgets now uses
  399. HTML5 boolean syntax rather than XHTML's ``checked='checked'`` and
  400. ``selected='selected'``.
  401. * :meth:`RelatedManager.add()
  402. <django.db.models.fields.related.RelatedManager.add>`,
  403. :meth:`~django.db.models.fields.related.RelatedManager.remove`,
  404. :meth:`~django.db.models.fields.related.RelatedManager.clear`, and
  405. :meth:`~django.db.models.fields.related.RelatedManager.set` now
  406. clear the ``prefetch_related()`` cache.
  407. * To prevent possible loss of saved settings,
  408. :func:`~django.test.utils.setup_test_environment` now raises an exception if
  409. called a second time before calling
  410. :func:`~django.test.utils.teardown_test_environment`.
  411. * The undocumented ``DateTimeAwareJSONEncoder`` alias for
  412. :class:`~django.core.serializers.json.DjangoJSONEncoder` (renamed in Django
  413. 1.0) is removed.
  414. * The :class:`cached template loader <django.template.loaders.cached.Loader>`
  415. is now enabled if :setting:`DEBUG` is ``False`` and
  416. :setting:`OPTIONS['loaders'] <TEMPLATES-OPTIONS>` isn't specified. This could
  417. be backwards-incompatible if you have some :ref:`template tags that aren't
  418. thread safe <template_tag_thread_safety>`.
  419. * The prompt for stale content type deletion no longer occurs after running the
  420. ``migrate`` command. Use the new :djadmin:`remove_stale_contenttypes` command
  421. instead.
  422. * The admin's widget for ``IntegerField`` uses ``type="number"`` rather than
  423. ``type="text"``.
  424. * Conditional HTTP headers are now parsed and compared according to the
  425. :rfc:`7232` Conditional Requests specification rather than the older
  426. :rfc:`2616`.
  427. * :func:`~django.utils.cache.patch_response_headers` no longer adds a
  428. ``Last-Modified`` header. According to the :rfc:`7234#section-4.2.2`, this
  429. header is useless alongside other caching headers that provide an explicit
  430. expiration time, e.g. ``Expires`` or ``Cache-Control``.
  431. :class:`~django.middleware.cache.UpdateCacheMiddleware` and
  432. :func:`~django.utils.cache.add_never_cache_headers` call
  433. ``patch_response_headers()`` and therefore are also affected by this change.
  434. * In the admin templates, ``<p class="help">`` is replaced with a ``<div>`` tag
  435. to allow including lists inside help text.
  436. * :class:`~django.middleware.http.ConditionalGetMiddleware` no longer sets the
  437. ``Date`` header as Web servers set that header. It also no longer sets the
  438. ``Content-Length`` header as this is now done by
  439. :class:`~django.middleware.common.CommonMiddleware`.
  440. * :meth:`~django.apps.AppConfig.get_model` and
  441. :meth:`~django.apps.AppConfig.get_models` now raise
  442. :exc:`~django.core.exceptions.AppRegistryNotReady` if they're called before
  443. models of all applications have been loaded. Previously they only required
  444. the target application's models to be loaded and thus could return models
  445. without all their relations set up. If you need the old behavior of
  446. ``get_model()``, set the ``require_ready`` argument to ``False``.
  447. * The unused ``BaseCommand.can_import_settings`` attribute is removed.
  448. .. _deprecated-features-1.11:
  449. Features deprecated in 1.11
  450. ===========================
  451. ``models.permalink()`` decorator
  452. --------------------------------
  453. Use :func:`django.urls.reverse` instead. For example::
  454. from django.db import models
  455. class MyModel(models.Model):
  456. ...
  457. @models.permalink
  458. def url(self):
  459. return ('guitarist_detail', [self.slug])
  460. becomes::
  461. from django.db import models
  462. from django.urls import reverse
  463. class MyModel(models.Model):
  464. ...
  465. def url(self):
  466. return reverse('guitarist_detail', args=[self.slug])
  467. Miscellaneous
  468. -------------
  469. * ``contrib.auth``’s ``login()`` and ``logout()`` function-based views are
  470. deprecated in favor of new class-based views
  471. :class:`~django.contrib.auth.views.LoginView` and
  472. :class:`~django.contrib.auth.views.LogoutView`.
  473. * The unused ``extra_context`` parameter of
  474. ``contrib.auth.views.logout_then_login()`` is deprecated.
  475. * ``contrib.auth``’s ``password_change()``, ``password_change_done()``,
  476. ``password_reset()``, ``password_reset_done()``, ``password_reset_confirm()``,
  477. and ``password_reset_complete()`` function-based views are deprecated in favor
  478. of new class-based views
  479. :class:`~django.contrib.auth.views.PasswordChangeView`,
  480. :class:`~django.contrib.auth.views.PasswordChangeDoneView`,
  481. :class:`~django.contrib.auth.views.PasswordResetView`,
  482. :class:`~django.contrib.auth.views.PasswordResetDoneView`,
  483. :class:`~django.contrib.auth.views.PasswordResetConfirmView`, and
  484. :class:`~django.contrib.auth.views.PasswordResetCompleteView`.
  485. * ``django.test.runner.setup_databases()`` is moved to
  486. :func:`django.test.utils.setup_databases`. The old location is deprecated.
  487. * ``django.utils.translation.string_concat()`` is deprecated in
  488. favor of :func:`django.utils.text.format_lazy`. ``string_concat(*strings)``
  489. can be replaced by ``format_lazy('{}' * len(strings), *strings)``.
  490. * For the ``PyLibMCCache`` cache backend, passing ``pylibmc`` behavior settings
  491. as top-level attributes of ``OPTIONS`` is deprecated. Set them under a
  492. ``behaviors`` key within ``OPTIONS`` instead.
  493. * The ``host`` parameter of ``django.utils.http.is_safe_url()`` is deprecated
  494. in favor of the new ``allowed_hosts`` parameter.
  495. * Silencing exceptions raised while rendering the
  496. :ttag:`{% include %} <include>` template tag is deprecated as the behavior is
  497. often more confusing than helpful. In Django 2.1, the exception will be
  498. raised.
  499. * ``DatabaseIntrospection.get_indexes()`` is deprecated in favor of
  500. ``DatabaseIntrospection.get_constraints()``.
  501. * :func:`~django.contrib.auth.authenticate` now passes a ``request`` argument
  502. to the ``authenticate()`` method of authentication backends. Support for
  503. methods that don't accept ``request`` will be removed in Django 2.1.
  504. * The ``USE_ETAGS`` setting is deprecated in favor of
  505. :class:`~django.middleware.http.ConditionalGetMiddleware` which now adds the
  506. ``ETag`` header to responses regardless of the setting. ``CommonMiddleware``
  507. and ``django.utils.cache.patch_response_headers()`` will no longer set ETags
  508. when the deprecation ends.