1.11.txt 31 KB

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