1.11.txt 31 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808
  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. Migrations
  233. ~~~~~~~~~~
  234. * Added support for serialization of ``uuid.UUID`` objects.
  235. Models
  236. ~~~~~~
  237. * Added support for callable values in the ``defaults`` argument of
  238. :meth:`QuerySet.update_or_create()
  239. <django.db.models.query.QuerySet.update_or_create>` and
  240. :meth:`~django.db.models.query.QuerySet.get_or_create`.
  241. * :class:`~django.db.models.ImageField` now has a default
  242. :data:`~django.core.validators.validate_image_file_extension` validator.
  243. * Added support for time truncation to
  244. :class:`~django.db.models.functions.datetime.Trunc` functions.
  245. * Added the :class:`~django.db.models.functions.datetime.ExtractWeek` function
  246. to extract the week from :class:`~django.db.models.DateField` and
  247. :class:`~django.db.models.DateTimeField` and exposed it through the
  248. :lookup:`week` lookup.
  249. * Added the :class:`~django.db.models.functions.datetime.TruncTime` function
  250. to truncate :class:`~django.db.models.DateTimeField` to its time component
  251. and exposed it through the :lookup:`time` lookup.
  252. * Added support for expressions in :meth:`.QuerySet.values` and
  253. :meth:`~.QuerySet.values_list`.
  254. * Added support for query expressions on lookups that take multiple arguments,
  255. such as ``range``.
  256. * You can now use the ``unique=True`` option with
  257. :class:`~django.db.models.FileField`.
  258. * Added the ``nulls_first`` and ``nulls_last`` parameters to
  259. :class:`Expression.asc() <django.db.models.Expression.asc>` and
  260. :meth:`~django.db.models.Expression.desc` to control
  261. the ordering of null values.
  262. * The new ``F`` expression ``bitleftshift()`` and ``bitrightshift()`` methods
  263. allow :ref:`bitwise shift operations <using-f-expressions-in-filters>`.
  264. Requests and Responses
  265. ~~~~~~~~~~~~~~~~~~~~~~
  266. * Added :meth:`QueryDict.fromkeys() <django.http.QueryDict.fromkeys>`.
  267. * :class:`~django.middleware.common.CommonMiddleware` now sets the
  268. ``Content-Length`` response header for non-streaming responses.
  269. * Added the :setting:`SECURE_HSTS_PRELOAD` setting to allow appending the
  270. ``preload`` directive to the ``Strict-Transport-Security`` header.
  271. * :class:`~django.middleware.http.ConditionalGetMiddleware` now adds the
  272. ``ETag`` header to responses.
  273. Serialization
  274. ~~~~~~~~~~~~~
  275. * The new ``django.core.serializers.base.Serializer.stream_class`` attribute
  276. allows subclasses to customize the default stream.
  277. * The encoder used by the :ref:`JSON serializer <serialization-formats-json>`
  278. can now be customized by passing a ``cls`` keyword argument to the
  279. ``serializers.serialize()`` function.
  280. * :class:`~django.core.serializers.json.DjangoJSONEncoder` now serializes
  281. :class:`~datetime.timedelta` objects (used by
  282. :class:`~django.db.models.DurationField`).
  283. Signals
  284. ~~~~~~~
  285. * ...
  286. Templates
  287. ~~~~~~~~~
  288. * :meth:`~django.utils.safestring.mark_safe` can now be used as a decorator.
  289. * The :class:`~django.template.backends.jinja2.Jinja2` template backend now
  290. supports context processors by setting the ``'context_processors'`` option in
  291. :setting:`OPTIONS <TEMPLATES-OPTIONS>`.
  292. * The :ttag:`regroup` tag now returns ``namedtuple``\s instead of dictionaries
  293. so you can unpack the group object directly in a loop, e.g.
  294. ``{% for grouper, list in regrouped %}``.
  295. * Added a :ttag:`resetcycle` template tag to allow resetting the sequence of
  296. the :ttag:`cycle` template tag.
  297. * You can now specify specific directories for a particular
  298. :class:`filesystem.Loader <django.template.loaders.filesystem.Loader>`.
  299. Tests
  300. ~~~~~
  301. * Added :meth:`.DiscoverRunner.get_test_runner_kwargs` to allow customizing the
  302. keyword arguments passed to the test runner.
  303. * Added the :option:`test --debug-mode` option to help troubleshoot test
  304. failures by setting the :setting:`DEBUG` setting to ``True``.
  305. * The new :func:`django.test.utils.setup_databases` (moved from
  306. ``django.test.runner``) and :func:`~django.test.utils.teardown_databases`
  307. functions make it easier to build custom test runners.
  308. * Added support for :meth:`python:unittest.TestCase.subTest`’s when using the
  309. :option:`test --parallel` option.
  310. * ``DiscoverRunner`` now runs the system checks at the start of a test run.
  311. Override the :meth:`.DiscoverRunner.run_checks` method if you want to disable
  312. that.
  313. URLs
  314. ~~~~
  315. * ...
  316. Validators
  317. ~~~~~~~~~~
  318. * Added :class:`~django.core.validators.FileExtensionValidator` to validate
  319. file extensions and
  320. :data:`~django.core.validators.validate_image_file_extension` to validate
  321. image files.
  322. .. _backwards-incompatible-1.11:
  323. Backwards incompatible changes in 1.11
  324. ======================================
  325. :mod:`django.contrib.gis`
  326. -------------------------
  327. * To simplify the codebase and because it's easier to install than when
  328. ``contrib.gis`` was first released, :ref:`gdalbuild` is now a required
  329. dependency for GeoDjango. In older versions, it's only required for SQLite.
  330. * ``contrib.gis.maps`` is removed as it interfaces with a retired version of
  331. the Google Maps API and seems to be unmaintained. If you're using it, `let
  332. us know <https://code.djangoproject.com/ticket/14284>`_.
  333. * The ``GEOSGeometry`` equality operator now also compares SRID.
  334. * The OpenLayers-based form widgets now use OpenLayers 3, and the
  335. ``gis/openlayers.html`` and ``gis/openlayers-osm.html`` templates have been
  336. updated. Check your project if you subclass these widgets or extend the
  337. templates.
  338. Database backend API
  339. --------------------
  340. * The ``DatabaseOperations.time_trunc_sql()`` method is added to support
  341. ``TimeField`` truncation. It accepts a ``lookup_type`` and ``field_name``
  342. arguments and returns the appropriate SQL to truncate the given time field
  343. ``field_name`` to a time object with only the given specificity. The
  344. ``lookup_type`` argument can be either ``'hour'``, ``'minute'``, or
  345. ``'second'``.
  346. * The ``DatabaseOperations.datetime_cast_time_sql()`` method is added to
  347. support the :lookup:`time` lookup. It accepts a ``field_name`` and ``tzname``
  348. arguments and returns the SQL necessary to cast a datetime value to time value.
  349. * To enable ``FOR UPDATE SKIP LOCKED`` support, set
  350. ``DatabaseFeatures.has_select_for_update_skip_locked = True``.
  351. * The new ``DatabaseFeatures.supports_index_column_ordering`` attribute
  352. specifies if a database allows defining ordering for columns in indexes. The
  353. default value is ``True`` and the ``DatabaseIntrospection.get_constraints()``
  354. method should include an ``'orders'`` key in each of the returned
  355. dictionaries with a list of ``'ASC'`` and/or ``'DESC'`` values corresponding
  356. to the the ordering of each column in the index.
  357. * :djadmin:`inspectdb` no longer calls ``DatabaseIntrospection.get_indexes()``
  358. which is deprecated. Custom database backends should ensure all types of
  359. indexes are returned by ``DatabaseIntrospection.get_constraints()``.
  360. * Renamed the ``ignores_quoted_identifier_case`` feature to
  361. ``ignores_table_name_case`` to more accurately reflect how it is used.
  362. Dropped support for PostgreSQL 9.2 and PostGIS 2.0
  363. --------------------------------------------------
  364. Upstream support for PostgreSQL 9.2 ends in September 2017. As a consequence,
  365. Django 1.11 sets PostgreSQL 9.3 as the minimum version it officially supports.
  366. Support for PostGIS 2.0 is also removed as PostgreSQL 9.2 is the last version
  367. to support it.
  368. ``LiveServerTestCase`` binds to port zero
  369. -----------------------------------------
  370. Rather than taking a port range and iterating to find a free port,
  371. ``LiveServerTestCase`` binds to port zero and relies on the operating system
  372. to assign a free port. The ``DJANGO_LIVE_TEST_SERVER_ADDRESS`` environment
  373. variable is no longer used, and as it's also no longer used, the
  374. ``manage.py test --liveserver`` option is removed.
  375. Protection against insecure redirects in :mod:`django.contrib.auth` and ``i18n`` views
  376. --------------------------------------------------------------------------------------
  377. ``LoginView``, ``LogoutView`` (and the deprecated function-based equivalents),
  378. and :func:`~django.views.i18n.set_language` protect users from being redirected
  379. to non-HTTPS ``next`` URLs when the app is running over HTTPS.
  380. ``QuerySet.get_or_create()`` and ``update_or_create()`` validate arguments
  381. --------------------------------------------------------------------------
  382. To prevent typos from passing silently,
  383. :meth:`~django.db.models.query.QuerySet.get_or_create` and
  384. :meth:`~django.db.models.query.QuerySet.update_or_create` check that their
  385. arguments are model fields. This should be backwards-incompatible only in the
  386. fact that it might expose a bug in your project.
  387. ``pytz`` is a required dependency and support for ``settings.TIME_ZONE = None`` is removed
  388. ------------------------------------------------------------------------------------------
  389. To simplify Django's timezone handling, ``pytz`` is now a required dependency.
  390. It's automatically installed along with Django.
  391. Support for ``settings.TIME_ZONE = None`` is removed as the behavior isn't
  392. commonly used and is questionably useful. If you want to automatically detect
  393. the timezone based on the system timezone, you can use `tzlocal
  394. <https://pypi.python.org/pypi/tzlocal>`_::
  395. from tzlocal import get_localzone
  396. TIME_ZONE = get_localzone().zone
  397. This works similar to ``settings.TIME_ZONE = None`` except that it also sets
  398. ``os.environ['TZ']``. `Let us know
  399. <https://groups.google.com/d/topic/django-developers/OAV3FChfuPM/discussion>`__
  400. if there's a use case where you find you can't adapt your code to set a
  401. ``TIME_ZONE``.
  402. HTML changes in admin templates
  403. -------------------------------
  404. ``<p class="help">`` is replaced with a ``<div>`` tag to allow including lists
  405. inside help text.
  406. Read-only fields are wrapped in ``<div class="readonly">...</div>`` instead of
  407. ``<p>...</p>`` to allow any kind of HTML as the field's content.
  408. .. _template-widget-incompatibilities-1-11:
  409. Changes due to the introduction of template-based widget rendering
  410. ------------------------------------------------------------------
  411. Some undocumented classes in ``django.forms.widgets`` are removed:
  412. * ``SubWidget``
  413. * ``RendererMixin``, ``ChoiceFieldRenderer``, ``RadioFieldRenderer``,
  414. ``CheckboxFieldRenderer``
  415. * ``ChoiceInput``, ``RadioChoiceInput``, ``CheckboxChoiceInput``
  416. The ``Widget.format_output()`` method is removed. Use a custom widget template
  417. instead.
  418. ``django.Template.render()`` prohibits non-dict context
  419. -------------------------------------------------------
  420. For compatibility with multiple template engines, ``django.Template.render()``
  421. must receive a dictionary of context rather than ``Context`` or
  422. ``RequestContext``. If you were passing either of the two classes, pass a
  423. dictionary instead -- doing so is backwards-compatible with older versions of
  424. Django.
  425. Miscellaneous
  426. -------------
  427. * If no items in the feed have a ``pubdate`` or ``updateddate`` attribute,
  428. :meth:`SyndicationFeed.latest_post_date()
  429. <django.utils.feedgenerator.SyndicationFeed.latest_post_date>` now returns
  430. the current UTC date/time, instead of a datetime without any timezone
  431. information.
  432. * Support for SpatiaLite < 4.0 is dropped.
  433. * Support for GDAL 1.7 and 1.8 is dropped.
  434. * CSRF failures are logged to the ``django.security.csrf`` logger instead of
  435. ``django.request``.
  436. * :setting:`ALLOWED_HOSTS` validation is no longer disabled when running tests.
  437. If your application includes tests with custom host names, you must include
  438. those host names in :setting:`ALLOWED_HOSTS`. See
  439. :ref:`topics-testing-advanced-multiple-hosts`.
  440. * Using a foreign key's id (e.g. ``'field_id'``) in ``ModelAdmin.list_display``
  441. displays the related object's ID. Remove the ``_id`` suffix if you want the
  442. old behavior of the string representation of the object.
  443. * In model forms, :class:`~django.db.models.CharField` with ``null=True`` now
  444. saves ``NULL`` for blank values instead of empty strings.
  445. * On Oracle, :meth:`Model.validate_unique()
  446. <django.db.models.Model.validate_unique>` no longer checks empty strings for
  447. uniqueness as the database interprets the value as ``NULL``.
  448. * If you subclass :class:`.AbstractUser` and override ``clean()``, be sure it
  449. calls ``super()``. :meth:`.BaseUserManager.normalize_email` is called in a
  450. new :meth:`.AbstractUser.clean` method so that normalization is applied in
  451. cases like model form validation.
  452. * ``EmailField`` and ``URLField`` no longer accept the ``strip`` keyword
  453. argument. Remove it because it doesn't have an effect in older versions of
  454. Django as these fields alway strip whitespace.
  455. * The ``checked`` and ``selected`` attribute rendered by form widgets now uses
  456. HTML5 boolean syntax rather than XHTML's ``checked='checked'`` and
  457. ``selected='selected'``.
  458. * :meth:`RelatedManager.add()
  459. <django.db.models.fields.related.RelatedManager.add>`,
  460. :meth:`~django.db.models.fields.related.RelatedManager.remove`,
  461. :meth:`~django.db.models.fields.related.RelatedManager.clear`, and
  462. :meth:`~django.db.models.fields.related.RelatedManager.set` now
  463. clear the ``prefetch_related()`` cache.
  464. * To prevent possible loss of saved settings,
  465. :func:`~django.test.utils.setup_test_environment` now raises an exception if
  466. called a second time before calling
  467. :func:`~django.test.utils.teardown_test_environment`.
  468. * The undocumented ``DateTimeAwareJSONEncoder`` alias for
  469. :class:`~django.core.serializers.json.DjangoJSONEncoder` (renamed in Django
  470. 1.0) is removed.
  471. * The :class:`cached template loader <django.template.loaders.cached.Loader>`
  472. is now enabled if :setting:`DEBUG` is ``False`` and
  473. :setting:`OPTIONS['loaders'] <TEMPLATES-OPTIONS>` isn't specified. This could
  474. be backwards-incompatible if you have some :ref:`template tags that aren't
  475. thread safe <template_tag_thread_safety>`.
  476. * The prompt for stale content type deletion no longer occurs after running the
  477. ``migrate`` command. Use the new :djadmin:`remove_stale_contenttypes` command
  478. instead.
  479. * The admin's widget for ``IntegerField`` uses ``type="number"`` rather than
  480. ``type="text"``.
  481. * Conditional HTTP headers are now parsed and compared according to the
  482. :rfc:`7232` Conditional Requests specification rather than the older
  483. :rfc:`2616`.
  484. * :func:`~django.utils.cache.patch_response_headers` no longer adds a
  485. ``Last-Modified`` header. According to the :rfc:`7234#section-4.2.2`, this
  486. header is useless alongside other caching headers that provide an explicit
  487. expiration time, e.g. ``Expires`` or ``Cache-Control``.
  488. :class:`~django.middleware.cache.UpdateCacheMiddleware` and
  489. :func:`~django.utils.cache.add_never_cache_headers` call
  490. ``patch_response_headers()`` and therefore are also affected by this change.
  491. * In the admin templates, ``<p class="help">`` is replaced with a ``<div>`` tag
  492. to allow including lists inside help text.
  493. * :class:`~django.middleware.http.ConditionalGetMiddleware` no longer sets the
  494. ``Date`` header as Web servers set that header. It also no longer sets the
  495. ``Content-Length`` header as this is now done by
  496. :class:`~django.middleware.common.CommonMiddleware`.
  497. * :meth:`~django.apps.AppConfig.get_model` and
  498. :meth:`~django.apps.AppConfig.get_models` now raise
  499. :exc:`~django.core.exceptions.AppRegistryNotReady` if they're called before
  500. models of all applications have been loaded. Previously they only required
  501. the target application's models to be loaded and thus could return models
  502. without all their relations set up. If you need the old behavior of
  503. ``get_model()``, set the ``require_ready`` argument to ``False``.
  504. * The unused ``BaseCommand.can_import_settings`` attribute is removed.
  505. * The undocumented ``django.utils.functional.lazy_property`` is removed.
  506. * For consistency with non-multipart requests, ``MultiPartParser.parse()`` now
  507. leaves ``request.POST`` immutable. If you're modifying that ``QueryDict``,
  508. you must now first copy it, e.g. ``request.POST.copy()``.
  509. * Support for ``cx_Oracle`` < 5.2 is removed.
  510. .. _deprecated-features-1.11:
  511. Features deprecated in 1.11
  512. ===========================
  513. ``models.permalink()`` decorator
  514. --------------------------------
  515. Use :func:`django.urls.reverse` instead. For example::
  516. from django.db import models
  517. class MyModel(models.Model):
  518. ...
  519. @models.permalink
  520. def url(self):
  521. return ('guitarist_detail', [self.slug])
  522. becomes::
  523. from django.db import models
  524. from django.urls import reverse
  525. class MyModel(models.Model):
  526. ...
  527. def url(self):
  528. return reverse('guitarist_detail', args=[self.slug])
  529. Miscellaneous
  530. -------------
  531. * ``contrib.auth``’s ``login()`` and ``logout()`` function-based views are
  532. deprecated in favor of new class-based views
  533. :class:`~django.contrib.auth.views.LoginView` and
  534. :class:`~django.contrib.auth.views.LogoutView`.
  535. * The unused ``extra_context`` parameter of
  536. ``contrib.auth.views.logout_then_login()`` is deprecated.
  537. * ``contrib.auth``’s ``password_change()``, ``password_change_done()``,
  538. ``password_reset()``, ``password_reset_done()``, ``password_reset_confirm()``,
  539. and ``password_reset_complete()`` function-based views are deprecated in favor
  540. of new class-based views
  541. :class:`~django.contrib.auth.views.PasswordChangeView`,
  542. :class:`~django.contrib.auth.views.PasswordChangeDoneView`,
  543. :class:`~django.contrib.auth.views.PasswordResetView`,
  544. :class:`~django.contrib.auth.views.PasswordResetDoneView`,
  545. :class:`~django.contrib.auth.views.PasswordResetConfirmView`, and
  546. :class:`~django.contrib.auth.views.PasswordResetCompleteView`.
  547. * ``django.test.runner.setup_databases()`` is moved to
  548. :func:`django.test.utils.setup_databases`. The old location is deprecated.
  549. * ``django.utils.translation.string_concat()`` is deprecated in
  550. favor of :func:`django.utils.text.format_lazy`. ``string_concat(*strings)``
  551. can be replaced by ``format_lazy('{}' * len(strings), *strings)``.
  552. * For the ``PyLibMCCache`` cache backend, passing ``pylibmc`` behavior settings
  553. as top-level attributes of ``OPTIONS`` is deprecated. Set them under a
  554. ``behaviors`` key within ``OPTIONS`` instead.
  555. * The ``host`` parameter of ``django.utils.http.is_safe_url()`` is deprecated
  556. in favor of the new ``allowed_hosts`` parameter.
  557. * Silencing exceptions raised while rendering the
  558. :ttag:`{% include %} <include>` template tag is deprecated as the behavior is
  559. often more confusing than helpful. In Django 2.1, the exception will be
  560. raised.
  561. * ``DatabaseIntrospection.get_indexes()`` is deprecated in favor of
  562. ``DatabaseIntrospection.get_constraints()``.
  563. * :func:`~django.contrib.auth.authenticate` now passes a ``request`` argument
  564. to the ``authenticate()`` method of authentication backends. Support for
  565. methods that don't accept ``request`` will be removed in Django 2.1.
  566. * The ``USE_ETAGS`` setting is deprecated in favor of
  567. :class:`~django.middleware.http.ConditionalGetMiddleware` which now adds the
  568. ``ETag`` header to responses regardless of the setting. ``CommonMiddleware``
  569. and ``django.utils.cache.patch_response_headers()`` will no longer set ETags
  570. when the deprecation ends.
  571. * ``Model._meta.has_auto_field`` is deprecated in favor of checking if
  572. ``Model._meta.auto_field is not None``.
  573. * Using regular expression groups with ``iLmsu#`` in ``url()`` is deprecated.
  574. The only group that's useful is ``(?i)`` for case-insensitive URLs, however,
  575. case-insensitive URLs aren't a good practice because they create multiple
  576. entries for search engines, for example. An alternative solution could be to
  577. create a :data:`~django.conf.urls.handler404` that looks for uppercase
  578. characters in the URL and redirects to a lowercase equivalent.
  579. * The ``renderer`` argument is added to the :meth:`Widget.render()
  580. <django.forms.Widget.render>` method. Methods that don't accept that argument
  581. will work through a deprecation period.