2.0.txt 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531
  1. ============================================
  2. Django 2.0 release notes - UNDER DEVELOPMENT
  3. ============================================
  4. Welcome to Django 2.0!
  5. These release notes cover the :ref:`new features <whats-new-2.0>`, as well as
  6. some :ref:`backwards incompatible changes <backwards-incompatible-2.0>` you'll
  7. want to be aware of when upgrading from Django 1.11 or earlier. We've
  8. :ref:`dropped some features<removed-features-2.0>` that have reached the end of
  9. their deprecation cycle, and we've :ref:`begun the deprecation process for some
  10. features <deprecated-features-2.0>`.
  11. See the :doc:`/howto/upgrade-version` guide if you're updating an existing
  12. project.
  13. Python compatibility
  14. ====================
  15. Django 2.0 supports Python 3.5+. Since Django 1.11, support for Python 2.7 and
  16. 3.4 is removed. We **highly recommend** and only officially support the latest
  17. release of each series.
  18. Third-party library support for older version of Django
  19. =======================================================
  20. Following the release of Django 2.0, we suggest that third-party app authors
  21. drop support for all versions of Django prior to 1.11. At that time, you should
  22. be able run your package's tests using ``python -Wd`` so that deprecation
  23. warnings do appear. After making the deprecation warning fixes, your app should
  24. be compatible with Django 2.0.
  25. .. _whats-new-2.0:
  26. What's new in Django 2.0
  27. ========================
  28. Minor features
  29. --------------
  30. :mod:`django.contrib.admin`
  31. ~~~~~~~~~~~~~~~~~~~~~~~~~~~
  32. * ...
  33. :mod:`django.contrib.admindocs`
  34. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  35. * ...
  36. :mod:`django.contrib.auth`
  37. ~~~~~~~~~~~~~~~~~~~~~~~~~~
  38. * The default iteration count for the PBKDF2 password hasher is increased from
  39. 36,000 to 100,000.
  40. :mod:`django.contrib.contenttypes`
  41. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  42. * ...
  43. :mod:`django.contrib.gis`
  44. ~~~~~~~~~~~~~~~~~~~~~~~~~
  45. * Added MySQL support for the
  46. :class:`~django.contrib.gis.db.models.functions.AsGeoJSON` function,
  47. :class:`~django.contrib.gis.db.models.functions.GeoHash` function,
  48. :class:`~django.contrib.gis.db.models.functions.IsValid` function, and
  49. :lookup:`isvalid` lookup.
  50. * Added the :class:`~django.contrib.gis.db.models.functions.Azimuth` and
  51. :class:`~django.contrib.gis.db.models.functions.LineLocatePoint` functions,
  52. supported on PostGIS and SpatiaLite.
  53. * Any :class:`~django.contrib.gis.geos.GEOSGeometry` imported from GeoJSON now
  54. has its SRID set.
  55. * Added the :attr:`.OSMWidget.default_zoom` attribute to customize the map's
  56. default zoom level.
  57. :mod:`django.contrib.messages`
  58. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  59. * ...
  60. :mod:`django.contrib.postgres`
  61. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  62. * The new ``distinct`` argument for
  63. :class:`~django.contrib.postgres.aggregates.ArrayAgg` determines if
  64. concatenated values will be distinct.
  65. * The new :class:`~django.contrib.postgres.functions.RandomUUID` database
  66. function returns a version 4 UUID. It requires use of PostgreSQL's
  67. ``pgcrypto`` extension which can be activated using the new
  68. :class:`~django.contrib.postgres.operations.CryptoExtension` migration
  69. operation.
  70. :mod:`django.contrib.redirects`
  71. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  72. * ...
  73. :mod:`django.contrib.sessions`
  74. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  75. * ...
  76. :mod:`django.contrib.sitemaps`
  77. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  78. * Added the ``protocol`` keyword argument to the
  79. :class:`~django.contrib.sitemaps.GenericSitemap` constructor.
  80. :mod:`django.contrib.sites`
  81. ~~~~~~~~~~~~~~~~~~~~~~~~~~~
  82. * ...
  83. :mod:`django.contrib.staticfiles`
  84. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  85. * ...
  86. :mod:`django.contrib.syndication`
  87. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  88. * ...
  89. Cache
  90. ~~~~~
  91. * ...
  92. CSRF
  93. ~~~~
  94. * ...
  95. Database backends
  96. ~~~~~~~~~~~~~~~~~
  97. * ...
  98. Email
  99. ~~~~~
  100. * ...
  101. File Storage
  102. ~~~~~~~~~~~~
  103. * ...
  104. File Uploads
  105. ~~~~~~~~~~~~
  106. * ...
  107. Forms
  108. ~~~~~
  109. * The new ``date_attrs`` and ``time_attrs`` arguments for
  110. :class:`~django.forms.SplitDateTimeWidget` and
  111. :class:`~django.forms.SplitHiddenDateTimeWidget` allow specifying different
  112. HTML attributes for the ``DateInput`` and ``TimeInput`` (or hidden)
  113. subwidgets.
  114. Generic Views
  115. ~~~~~~~~~~~~~
  116. * ...
  117. Internationalization
  118. ~~~~~~~~~~~~~~~~~~~~
  119. * ...
  120. Management Commands
  121. ~~~~~~~~~~~~~~~~~~~
  122. * :djadmin:`inspectdb` now translates MySQL's unsigned integer columns to
  123. ``PositiveIntegerField`` or ``PositiveSmallIntegerField``.
  124. Migrations
  125. ~~~~~~~~~~
  126. * ...
  127. Models
  128. ~~~~~~
  129. * The new :class:`~django.db.models.functions.StrIndex` database function
  130. finds the starting index of a string inside another string.
  131. Requests and Responses
  132. ~~~~~~~~~~~~~~~~~~~~~~
  133. * The :djadmin:`runserver` Web server supports HTTP 1.1.
  134. Serialization
  135. ~~~~~~~~~~~~~
  136. * ...
  137. Signals
  138. ~~~~~~~
  139. * ...
  140. Templates
  141. ~~~~~~~~~
  142. * To increase the usefulness of :meth:`.Engine.get_default` in third-party
  143. apps, it now returns the first engine if multiple ``DjangoTemplates`` engines
  144. are configured in ``TEMPLATES`` rather than raising ``ImproperlyConfigured``.
  145. * Custom template tags may now accept keyword-only arguments.
  146. Tests
  147. ~~~~~
  148. * Added threading support to :class:`~django.test.LiveServerTestCase`.
  149. URLs
  150. ~~~~
  151. * ...
  152. Validators
  153. ~~~~~~~~~~
  154. * ...
  155. .. _backwards-incompatible-2.0:
  156. Backwards incompatible changes in 2.0
  157. =====================================
  158. Removed support for bytestrings in some places
  159. ----------------------------------------------
  160. To support native Python 2 strings, older Django versions had to accept both
  161. bytestrings and unicode strings. Now that Python 2 support is dropped,
  162. bytestrings should only be encountered around input/output boundaries (handling
  163. of binary fields or HTTP streams, for example). You might have to update your
  164. code to limit bytestring usage to a minimum, as Django no longer accepts
  165. bytestrings in certain code paths.
  166. Database backend API
  167. --------------------
  168. * The ``DatabaseOperations.datetime_cast_date_sql()``,
  169. ``datetime_cast_time_sql()``, ``datetime_trunc_sql()``, and
  170. ``datetime_extract_sql()`` methods now return only the SQL to perform the
  171. operation instead of SQL and a list of parameters.
  172. Dropped support for Oracle 11.2
  173. -------------------------------
  174. The end of upstream support for Oracle 11.2 is Dec. 2020. Django 1.11 will be
  175. supported until April 2020 which almost reaches this date. Django 2.0
  176. officially supports Oracle 12.1+.
  177. Default MySQL isolation level is read committed
  178. -----------------------------------------------
  179. MySQL's default isolation level, repeatable read, may cause data loss in
  180. typical Django usage. To prevent that and for consistency with other databases,
  181. the default isolation level is now read committed. You can use the
  182. :setting:`DATABASES` setting to :ref:`use a different isolation level
  183. <mysql-isolation-level>`, if needed.
  184. :attr:`AbstractUser.last_name <django.contrib.auth.models.User.last_name>` ``max_length`` increased to 150
  185. ----------------------------------------------------------------------------------------------------------
  186. A migration for :attr:`django.contrib.auth.models.User.last_name` is included.
  187. If you have a custom user model inheriting from ``AbstractUser``, you'll need
  188. to generate and apply a database migration for your user model.
  189. If you want to preserve the 30 character limit for last names, use a custom
  190. form::
  191. from django.contrib.auth.forms import UserChangeForm
  192. class MyUserChangeForm(UserChangeForm):
  193. last_name = forms.CharField(max_length=30, required=False)
  194. If you wish to keep this restriction in the admin when editing users, set
  195. ``UserAdmin.form`` to use this form::
  196. from django.contrib.auth.admin import UserAdmin
  197. from django.contrib.auth.models import User
  198. class MyUserAdmin(UserAdmin):
  199. form = MyUserChangeForm
  200. admin.site.unregister(User)
  201. admin.site.register(User, MyUserAdmin)
  202. Miscellaneous
  203. -------------
  204. * The ``SessionAuthenticationMiddleware`` class is removed. It provided no
  205. functionality since session authentication is unconditionally enabled in
  206. Django 1.10.
  207. * The default HTTP error handlers (``handler404``, etc.) are now callables
  208. instead of dotted Python path strings. Django favors callable references
  209. since they provide better performance and debugging experience.
  210. * :class:`~django.views.generic.base.RedirectView` no longer silences
  211. ``NoReverseMatch`` if the ``pattern_name`` doesn't exist.
  212. * When :setting:`USE_L10N` is off, :class:`~django.forms.FloatField` and
  213. :class:`~django.forms.DecimalField` now respect :setting:`DECIMAL_SEPARATOR`
  214. and :setting:`THOUSAND_SEPARATOR` during validation. For example, with the
  215. settings::
  216. USE_L10N = False
  217. USE_THOUSAND_SEPARATOR = True
  218. DECIMAL_SEPARATOR = ','
  219. THOUSAND_SEPARATOR = '.'
  220. an input of ``"1.345"`` is now converted to ``1345`` instead of ``1.345``.
  221. * Subclasses of :class:`~django.contrib.auth.models.AbstractBaseUser` are no
  222. longer required to implement ``get_short_name()`` and ``get_full_name()``.
  223. (The base implementations that raise ``NotImplementedError`` are removed.)
  224. ``django.contrib.admin`` uses these methods if implemented but doesn't
  225. require them. Third-party apps that use these methods may want to adopt a
  226. similar approach.
  227. * The ``FIRST_DAY_OF_WEEK`` and ``NUMBER_GROUPING`` format settings are now
  228. kept as integers in JavaScript and JSON i18n view outputs.
  229. .. _deprecated-features-2.0:
  230. Features deprecated in 2.0
  231. ==========================
  232. Miscellaneous
  233. -------------
  234. * The ``django.db.backends.postgresql_psycopg2`` module is deprecated in favor
  235. of ``django.db.backends.postgresql``. It's been an alias since Django 1.9.
  236. This only affects code that imports from the module directly. The
  237. ``DATABASES`` setting can still use
  238. ``'django.db.backends.postgresql_psycopg2'``, though you can simplify that by
  239. using the ``'django.db.backends.postgresql'`` name added in Django 1.9.
  240. * ``django.shortcuts.render_to_response()`` is deprecated in favor of
  241. :func:`django.shortcuts.render`. ``render()`` takes the same arguments
  242. except that is also requires a ``request``.
  243. * The ``DEFAULT_CONTENT_TYPE`` setting is deprecated. It doesn't interact well
  244. well with third-party apps and is obsolete since HTML5 has mostly superseded
  245. XHTML.
  246. * ``HttpRequest.xreadlines()`` is deprecated in favor of iterating over the
  247. request.
  248. .. _removed-features-2.0:
  249. Features removed in 2.0
  250. =======================
  251. These features have reached the end of their deprecation cycle and are removed
  252. in Django 2.0. See :ref:`deprecated-features-1.9` and
  253. :ref:`deprecated-features-1.10` for details, including how to remove usage of
  254. these features.
  255. * The ``weak`` argument to ``django.dispatch.signals.Signal.disconnect()`` is
  256. removed.
  257. * ``django.db.backends.base.BaseDatabaseOperations.check_aggregate_support()``
  258. is removed.
  259. * The ``django.forms.extras`` package is removed.
  260. * The ``assignment_tag`` helper is removed.
  261. * The ``host`` argument to ``SimpleTestCase.assertsRedirects()`` is removed.
  262. The compatibility layer which allows absolute URLs to be considered equal to
  263. relative ones when the path is identical is also removed.
  264. * ``Field.rel`` and ``Field.remote_field.to`` are removed.
  265. * The ``on_delete`` argument for ``ForeignKey`` and ``OneToOneField`` are now
  266. required.
  267. * ``django.db.models.fields.add_lazy_relation()`` is removed.
  268. * When time zone support is enabled, database backends that don't support time
  269. zones no longer convert aware datetimes to naive values in UTC anymore when
  270. such values are passed as parameters to SQL queries executed outside of the
  271. ORM, e.g. with ``cursor.execute()``.
  272. * ``django.contrib.auth.tests.utils.skipIfCustomUser()`` is removed.
  273. * The ``GeoManager`` and ``GeoQuerySet`` classes are removed.
  274. * The ``django.contrib.gis.geoip`` module is removed.
  275. * The ``supports_recursion`` check for template loaders is removed from:
  276. * ``django.template.engine.Engine.find_template()``
  277. * ``django.template.loader_tags.ExtendsNode.find_template()``
  278. * ``django.template.loaders.base.Loader.supports_recursion()``
  279. * ``django.template.loaders.cached.Loader.supports_recursion()``
  280. * The ``load_template`` and ``load_template_sources`` template loader methods
  281. are removed.
  282. * The ``template_dirs`` argument for template loaders is removed:
  283. * ``django.template.loaders.base.Loader.get_template()``
  284. * ``django.template.loaders.cached.Loader.cache_key()``
  285. * ``django.template.loaders.cached.Loader.get_template()``
  286. * ``django.template.loaders.cached.Loader.get_template_sources()``
  287. * ``django.template.loaders.filesystem.Loader.get_template_sources()``
  288. * ``django.template.loaders.base.Loader.__call__()`` is removed.
  289. * Support for custom error views that don't accept an ``exception`` parameter
  290. is removed.
  291. * The ``mime_type`` attribute of ``django.utils.feedgenerator.Atom1Feed`` and
  292. ``django.utils.feedgenerator.RssFeed`` is removed.
  293. * The ``app_name`` argument to ``include()`` is removed.
  294. * Support for passing a 3-tuple (including ``admin.site.urls``) as the first
  295. argument to ``include()`` is removed.
  296. * Support for setting a URL instance namespace without an application namespace
  297. is removed.
  298. * ``Field._get_val_from_obj()`` is removed.
  299. * ``django.template.loaders.eggs.Loader`` is removed.
  300. * The ``current_app`` parameter to the ``contrib.auth`` function-based views is
  301. removed.
  302. * The ``callable_obj`` keyword argument to
  303. ``SimpleTestCase.assertRaisesMessage()`` is removed.
  304. * Support for the ``allow_tags`` attribute on ``ModelAdmin`` methods is
  305. removed.
  306. * The ``enclosure`` keyword argument to ``SyndicationFeed.add_item()`` is
  307. removed.
  308. * The ``django.template.loader.LoaderOrigin`` and
  309. ``django.template.base.StringOrigin`` aliases for
  310. ``django.template.base.Origin`` are removed.
  311. * The ``makemigrations --exit`` option is removed.
  312. * Support for direct assignment to a reverse foreign key or many-to-many
  313. relation is removed.
  314. * The ``get_srid()`` and ``set_srid()`` methods of
  315. ``django.contrib.gis.geos.GEOSGeometry`` are removed.
  316. * The ``get_x()``, ``set_x()``, ``get_y()``, ``set_y()``, ``get_z()``, and
  317. ``set_z()`` methods of ``django.contrib.gis.geos.Point`` are removed.
  318. * The ``get_coords()`` and ``set_coords()`` methods of
  319. ``django.contrib.gis.geos.Point`` are removed.
  320. * The ``cascaded_union`` property of ``django.contrib.gis.geos.MultiPolygon``
  321. is removed.
  322. * ``django.utils.functional.allow_lazy()`` is removed.
  323. * The ``shell --plain`` option is removed.
  324. * The ``django.core.urlresolvers`` module is removed.
  325. * ``CommaSeparatedIntegerField`` is removed, except for support in historical
  326. migrations.
  327. * The template ``Context.has_key()`` method is removed.
  328. * Support for the ``django.core.files.storage.Storage.accessed_time()``,
  329. ``created_time()``, and ``modified_time()`` methods is removed.
  330. * Support for query lookups using the model name when
  331. ``Meta.default_related_name`` is set is removed.
  332. * The MySQL ``__search`` lookup is removed.
  333. * The shim for supporting custom related manager classes without a
  334. ``_apply_rel_filters()`` method is removed.
  335. * Using ``User.is_authenticated()`` and ``User.is_anonymous()`` as methods
  336. rather than properties is no longer supported.
  337. * The ``Model._meta.virtual_fields`` attribute is removed.
  338. * The keyword arguments ``virtual_only`` in ``Field.contribute_to_class()`` and
  339. ``virtual`` in ``Model._meta.add_field()`` are removed.
  340. * The ``javascript_catalog()`` and ``json_catalog()`` views are removed.
  341. * ``django.contrib.gis.utils.precision_wkt()`` is removed.
  342. * In multi-table inheritance, implicit promotion of a ``OneToOneField`` to a
  343. ``parent_link`` is removed.
  344. * Support for ``Widget._format_value()`` is removed.
  345. * ``FileField`` methods ``get_directory_name()`` and ``get_filename()`` are
  346. removed.
  347. * The ``mark_for_escaping()`` function and the classes it uses: ``EscapeData``,
  348. ``EscapeBytes``, ``EscapeText``, ``EscapeString``, and ``EscapeUnicode`` are
  349. removed.
  350. * The ``escape`` filter now uses ``django.utils.html.conditional_escape()``.
  351. * ``Manager.use_for_related_fields`` is removed.
  352. * Model ``Manager`` inheritance follows MRO inheritance rules. The requirement
  353. to use ``Meta.manager_inheritance_from_future`` to opt-in to the behavior is
  354. removed.
  355. * Support for old-style middleware using ``settings.MIDDLEWARE_CLASSES`` is
  356. removed.