1.8.txt 53 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289
  1. ============================================
  2. Django 1.8 release notes - UNDER DEVELOPMENT
  3. ============================================
  4. Welcome to Django 1.8!
  5. These release notes cover the `new features`_, as well as some `backwards
  6. incompatible changes`_ you'll want to be aware of when upgrading from Django
  7. 1.6 or older versions. We've also `begun the deprecation process for some
  8. features`_, and some features have reached the end of their deprecation process
  9. and `have been removed`_.
  10. Django 1.8 has been designated as Django's second :ref:`"Long-Term Support"
  11. (LTS) <lts-releases>` release. It will receive security updates for at least
  12. three years after its release. Support for the previous LTS, Django 1.4, will
  13. end 6 months from the release date of Django 1.8.
  14. .. _`new features`: `What's new in Django 1.8`_
  15. .. _`backwards incompatible changes`: `Backwards incompatible changes in 1.8`_
  16. .. _`begun the deprecation process for some features`: `Features deprecated in 1.8`_
  17. .. _`have been removed`: `Features removed in 1.8`_
  18. Python compatibility
  19. ====================
  20. Like Django 1.7, Django 1.8 requires Python 2.7 or above, though we
  21. **highly recommend** the latest minor release.
  22. What's new in Django 1.8
  23. ========================
  24. Security enhancements
  25. ~~~~~~~~~~~~~~~~~~~~~
  26. Several features of the django-secure_ third-party library have been
  27. integrated into Django. :class:`django.middleware.security.SecurityMiddleware`
  28. provides several security enhancements to the request/response cycle. The new
  29. :djadminopt:`--deploy` option of the :djadmin:`check` command allows you to
  30. check your production settings file for ways to increase the security of your
  31. site.
  32. .. _django-secure: https://pypi.python.org/pypi/django-secure
  33. New PostgreSQL specific functionality
  34. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  35. Django now has a module with extensions for PostgreSQL specific features, such
  36. as :class:`~django.contrib.postgres.fields.ArrayField`,
  37. :class:`~django.contrib.postgres.fields.HStoreField`, and :lookup:`unaccent`
  38. lookup. A full breakdown of the features is available :doc:`in the
  39. documentation </ref/contrib/postgres/index>`.
  40. New data types
  41. ~~~~~~~~~~~~~~
  42. * Django now has a :class:`~django.db.models.UUIDField` for storing
  43. universally unique identifiers. There is a corresponding :class:`form field
  44. <django.forms.UUIDField>`. It is stored as the native ``uuid`` data type on
  45. PostgreSQL and as a fixed length character field on other backends.
  46. Query Expressions
  47. ~~~~~~~~~~~~~~~~~
  48. :doc:`Query Expressions </ref/models/expressions>` allow users to create,
  49. customize, and compose complex SQL expressions. This has enabled annotate
  50. to accept expressions other than aggregates. Aggregates are now able to
  51. reference multiple fields, as well as perform arithmetic, similar to ``F()``
  52. objects.
  53. ``TestCase`` data setup
  54. ~~~~~~~~~~~~~~~~~~~~~~~
  55. :class:`~django.test.TestCase` has been refactored to allow for data
  56. initialization at the class level using transactions and savepoints. Database
  57. backends which do not support transactions, like MySQL with the MyISAM storage
  58. engine, will still be able to run these tests but won't benefit from the
  59. improvements. Tests are now run within two nested
  60. :func:`~django.db.transaction.atomic()` blocks: one for the whole class and one
  61. for each test.
  62. * The class method
  63. :meth:`TestCase.setUpTestData() <django.test.TestCase.setUpTestData>` adds
  64. the ability to setup test data at the class level. Using this technique can
  65. speed up the tests as compared to using ``setUp()``.
  66. * Fixture loading within ``TestCase`` is now performed once for the whole
  67. ``TestCase``.
  68. Minor features
  69. ~~~~~~~~~~~~~~
  70. :mod:`django.contrib.admin`
  71. ^^^^^^^^^^^^^^^^^^^^^^^^^^^
  72. * :class:`~django.contrib.admin.ModelAdmin` now has a
  73. :meth:`~django.contrib.admin.ModelAdmin.has_module_permission`
  74. method to allow limiting access to the module on the admin index page.
  75. * :class:`~django.contrib.admin.InlineModelAdmin` now has an attribute
  76. :attr:`~django.contrib.admin.InlineModelAdmin.show_change_link` that
  77. supports showing a link to an inline object's change form.
  78. * Use the new ``django.contrib.admin.RelatedOnlyFieldListFilter`` in
  79. :attr:`ModelAdmin.list_filter <django.contrib.admin.ModelAdmin.list_filter>`
  80. to limit the ``list_filter`` choices to foreign objects which are attached to
  81. those from the ``ModelAdmin``.
  82. * The :meth:`ModelAdmin.delete_view()
  83. <django.contrib.admin.ModelAdmin.delete_view>` displays a summary of objects
  84. to be deleted on the deletion confirmation page.
  85. * The jQuery library embedded in the admin has been upgraded to version 1.11.1.
  86. * You can now specify :attr:`AdminSite.site_url
  87. <django.contrib.admin.AdminSite.site_url>` in order to display a link to the
  88. front-end site.
  89. * You can now specify :attr:`ModelAdmin.show_full_result_count
  90. <django.contrib.admin.ModelAdmin.show_full_result_count>` to control whether
  91. or not the full count of objects should be displayed on a filtered admin page.
  92. * The ``AdminSite.password_change()`` method now has an ``extra_context``
  93. parameter.
  94. :mod:`django.contrib.admindocs`
  95. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  96. * reStructuredText is now parsed in model docstrings.
  97. :mod:`django.contrib.auth`
  98. ^^^^^^^^^^^^^^^^^^^^^^^^^^
  99. * Authorization backends can now raise
  100. :class:`~django.core.exceptions.PermissionDenied` in
  101. :meth:`~django.contrib.auth.models.User.has_perm`
  102. and :meth:`~django.contrib.auth.models.User.has_module_perms`
  103. to short-circuit permission checking.
  104. * :class:`~django.contrib.auth.forms.PasswordResetForm` now
  105. has a method :meth:`~django.contrib.auth.forms.PasswordResetForm.send_email`
  106. that can be overridden to customize the mail to be sent.
  107. * The ``max_length`` of :attr:`Permission.name
  108. <django.contrib.auth.models.Permission.name>` has been increased from 50 to
  109. 255 characters. Please run the database migration.
  110. * :attr:`~django.contrib.auth.models.CustomUser.USERNAME_FIELD` and
  111. :attr:`~django.contrib.auth.models.CustomUser.REQUIRED_FIELDS` now supports
  112. :class:`~django.db.models.ForeignKey`\s.
  113. :mod:`django.contrib.gis`
  114. ^^^^^^^^^^^^^^^^^^^^^^^^^^
  115. * A new :doc:`GeoJSON serializer </ref/contrib/gis/serializers>` is now
  116. available.
  117. * The Spatialite backend now supports ``Collect`` and ``Extent`` aggregates
  118. when the database version is 3.0 or later.
  119. * The PostGIS 2 ``CREATE EXTENSION postgis`` and the Spatialite
  120. ``SELECT InitSpatialMetaData`` initialization commands are now automatically
  121. run by :djadmin:`migrate`.
  122. * Compatibility shims for ``SpatialRefSys`` and ``GeometryColumns`` changed in
  123. Django 1.2 have been removed.
  124. :mod:`django.contrib.messages`
  125. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  126. * ...
  127. :mod:`django.contrib.redirects`
  128. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  129. * ...
  130. :mod:`django.contrib.sessions`
  131. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  132. * Session cookie is now deleted after
  133. :meth:`~django.contrib.sessions.backends.base.SessionBase.flush()` is called.
  134. :mod:`django.contrib.sitemaps`
  135. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  136. * The new :attr:`Sitemap.i18n <django.contrib.sitemaps.Sitemap.i18n>` attribute
  137. allows you to generate a sitemap based on the :setting:`LANGUAGES` setting.
  138. :mod:`django.contrib.sites`
  139. ^^^^^^^^^^^^^^^^^^^^^^^^^^^
  140. * :func:`~django.contrib.sites.shortcuts.get_current_site` will now lookup
  141. the current site based on :meth:`request.get_host()
  142. <django.http.HttpRequest.get_host>` if the :setting:`SITE_ID` setting is not
  143. defined.
  144. * The default :class:`~django.contrib.sites.models.Site` created when running
  145. ``migrate`` now respects the :setting:`SITE_ID` setting (instead of always
  146. using ``pk=1``).
  147. :mod:`django.contrib.staticfiles`
  148. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  149. * ...
  150. :mod:`django.contrib.syndication`
  151. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  152. * ...
  153. Cache
  154. ^^^^^
  155. * The ``incr()`` method of the
  156. ``django.core.cache.backends.locmem.LocMemCache`` backend is now thread-safe.
  157. Cryptography
  158. ^^^^^^^^^^^^
  159. * The ``max_age`` parameter of the
  160. :meth:`django.core.signing.TimestampSigner.unsign` method now also accept a
  161. :py:class:`datetime.timedelta` object.
  162. Database backends
  163. ^^^^^^^^^^^^^^^^^
  164. * The MySQL backend no longer strips microseconds from ``datetime`` values as
  165. MySQL 5.6.4 and up supports fractional seconds depending on the declaration
  166. of the datetime field (when ``DATETIME`` includes fractional precision greater
  167. than 0). New datetime database columns created with Django 1.8 and MySQL 5.6.4
  168. and up will support microseconds. See the :ref:`MySQL database notes
  169. <mysql-fractional-seconds>` for more details.
  170. Email
  171. ^^^^^
  172. * :ref:`Email backends <topic-email-backends>` now support the context manager
  173. protocol for opening and closing connections.
  174. * The SMTP email backend now supports ``keyfile`` and ``certfile``
  175. authentication with the :setting:`EMAIL_SSL_CERTFILE` and
  176. :setting:`EMAIL_SSL_KEYFILE` settings.
  177. * The SMTP :class:`~django.core.mail.backends.smtp.EmailBackend` now supports
  178. setting the ``timeout`` parameter with the :setting:`EMAIL_TIMEOUT` setting.
  179. * :class:`~django.core.mail.EmailMessage` and ``EmailMultiAlternatives`` now
  180. support the ``reply_to`` parameter.
  181. File Storage
  182. ^^^^^^^^^^^^
  183. * ...
  184. File Uploads
  185. ^^^^^^^^^^^^
  186. * ...
  187. Forms
  188. ^^^^^
  189. * Form widgets now render attributes with a value of ``True`` or ``False``
  190. as HTML5 boolean attributes.
  191. * The new :meth:`~django.forms.Form.has_error()` method allows checking
  192. if a specific error has happened.
  193. * If :attr:`~django.forms.Form.required_css_class` is defined on a form, then
  194. the ``<label>`` tags for required fields will have this class present in its
  195. attributes.
  196. * The rendering of non-field errors in unordered lists (``<ul>``) now includes
  197. ``nonfield`` in its list of classes to distinguish them from field-specific
  198. errors.
  199. * :class:`~django.forms.Field` now accepts a
  200. :attr:`~django.forms.Field.label_suffix` argument, which will override the
  201. form's :attr:`~django.forms.Form.label_suffix`. This enables customizing the
  202. suffix on a per-field basis — previously it wasn't possible to override
  203. a form's :attr:`~django.forms.Form.label_suffix` while using shortcuts such
  204. as ``{{ form.as_p }}`` in templates.
  205. * :class:`~django.forms.extras.widgets.SelectDateWidget` now accepts an
  206. :attr:`~django.forms.extras.widgets.SelectDateWidget.empty_label` argument, which will
  207. override the top list choice label when :class:`~django.forms.DateField` is not required.
  208. * After an :class:`~django.forms.ImageField` has been cleaned and validated, the
  209. ``UploadedFile`` object will have an additional ``image`` attribute containing
  210. the Pillow ``Image`` instance used to check if the file was a valid image. It
  211. will also update ``UploadedFile.content_type`` with the image's content type
  212. as determined by Pillow.
  213. * You can now pass a callable that returns an iterable of choices when
  214. instantiating a :class:`~django.forms.ChoiceField`.
  215. Generic Views
  216. ^^^^^^^^^^^^^
  217. * Generic views that use :class:`~django.views.generic.list.MultipleObjectMixin`
  218. may now specify the ordering applied to the
  219. :attr:`~django.views.generic.list.MultipleObjectMixin.queryset` by setting
  220. :attr:`~django.views.generic.list.MultipleObjectMixin.ordering` or overriding
  221. :meth:`~django.views.generic.list.MultipleObjectMixin.get_ordering()`.
  222. * The new :attr:`SingleObjectMixin.query_pk_and_slug
  223. <django.views.generic.detail.SingleObjectMixin.query_pk_and_slug>`
  224. attribute allows changing the behavior of
  225. :meth:`~django.views.generic.detail.SingleObjectMixin.get_object()`
  226. so that it'll perform its lookup using both the primary key and the slug.
  227. * The :meth:`~django.views.generic.edit.FormMixin.get_form()` method doesn't
  228. require a ``form_class`` to be provided anymore. If not provided ``form_class``
  229. defaults to :meth:`~django.views.generic.edit.FormMixin.get_form_class()`.
  230. Internationalization
  231. ^^^^^^^^^^^^^^^^^^^^
  232. * :setting:`FORMAT_MODULE_PATH` can now be a list of strings representing
  233. module paths. This allows importing several format modules from different
  234. reusable apps. It also allows overriding those custom formats in your main
  235. Django project.
  236. Logging
  237. ^^^^^^^
  238. * The :class:`django.utils.log.AdminEmailHandler` class now has a
  239. :meth:`~django.utils.log.AdminEmailHandler.send_mail` method to make it more
  240. subclass friendly.
  241. Management Commands
  242. ^^^^^^^^^^^^^^^^^^^
  243. * :djadmin:`dumpdata` now has the option :djadminopt:`--output` which allows
  244. specifying the file to which the serialized data is written.
  245. * :djadmin:`makemessages` and :djadmin:`compilemessages` now have the option
  246. :djadminopt:`--exclude` which allows exclusion of specific locales from
  247. processing.
  248. * :djadmin:`compilemessages` now has a ``--use-fuzzy`` or ``-f`` option which
  249. includes fuzzy translations into compiled files.
  250. * The :djadminopt:`--ignorenonexistent` option of the :djadmin:`loaddata`
  251. management command now ignores data for models that no longer exist.
  252. * :djadmin:`runserver` now uses daemon threads for faster reloading.
  253. * :djadmin:`inspectdb` now outputs ``Meta.unique_together``. It is also able to
  254. introspect :class:`~django.db.models.AutoField` for MySQL and PostgreSQL
  255. databases.
  256. * When calling management commands from code through :ref:`call_command
  257. <call-command>` and passing options, the option name can match the command
  258. line option name (without the initial dashes) or the final option destination
  259. variable name, but in either case, the resulting option received by the
  260. command is now always the ``dest`` name specified in the command option
  261. definition (as long as the command uses the new :py:mod:`argparse` module).
  262. * The :djadmin:`dbshell` command now supports MySQL's optional SSL certificate
  263. authority setting (``--ssl-ca``).
  264. * The :djadminopt:`--name` option for :djadmin:`makemigrations` allows you to
  265. to give the migration(s) a custom name instead of a generated one.
  266. * The :djadmin:`loaddata` command now prevents repeated fixture loading. If
  267. :setting:`FIXTURE_DIRS` contains duplicates or a default fixture directory
  268. path (``app_name/fixtures``), an exception is raised.
  269. * :djadmin:`makemigrations` now supports an :djadminopt:`--exit` option to
  270. exit with an error code if no migrations are created.
  271. Middleware
  272. ^^^^^^^^^^
  273. * The :attr:`CommonMiddleware.response_redirect_class
  274. <django.middleware.common.CommonMiddleware.response_redirect_class>`
  275. attribute allows you to customize the redirects issued by the middleware.
  276. * A debug message will be logged to the ``django.request`` logger when a
  277. middleware raises a :exc:`~django.core.exceptions.MiddlewareNotUsed` exception
  278. in :setting:`DEBUG` mode.
  279. Migrations
  280. ^^^^^^^^^^
  281. * The :class:`~django.db.migrations.operations.RunSQL` operation can now handle
  282. parameters passed to the SQL statements.
  283. * It is now possible to have migrations (most probably :ref:`data migrations
  284. <data-migrations>`) for applications without models.
  285. * Migrations can now :ref:`serialize model managers
  286. <using-managers-in-migrations>` as part of the model state.
  287. Models
  288. ^^^^^^
  289. * Django now logs at most 9000 queries in ``connections.queries``, in order
  290. to prevent excessive memory usage in long-running processes in debug mode.
  291. * There is now a model ``Meta`` option to define a
  292. :attr:`default related name <django.db.models.Options.default_related_name>`
  293. for all relational fields of a model.
  294. * Pickling models and querysets across different versions of Django isn't
  295. officially supported (it may work, but there's no guarantee). An extra
  296. variable that specifies the current Django version is now added to the
  297. pickled state of models and querysets, and Django raises a ``RuntimeWarning``
  298. when these objects are unpickled in a different version than the one in
  299. which they were pickled.
  300. * Added :meth:`Model.from_db() <django.db.models.Model.from_db()>` which
  301. Django uses whenever objects are loaded using the ORM. The method allows
  302. customizing model loading behavior.
  303. * ``extra(select={...})`` now allows you to escape a literal ``%s`` sequence
  304. using ``%%s``.
  305. * :doc:`Custom Lookups</howto/custom-lookups>` can now be registered using
  306. a decorator pattern.
  307. * The new :attr:`Transform.bilateral <django.db.models.Transform.bilateral>`
  308. attribute allows creating bilateral transformations. These transformations
  309. are applied to both ``lhs`` and ``rhs`` when used in a lookup expression,
  310. providing opportunities for more sophisticated lookups.
  311. * SQL special characters (\, %, _) are now escaped properly when a pattern
  312. lookup (e.g. ``contains``, ``startswith``, etc.) is used with an ``F()``
  313. expression as the right-hand side. In those cases, the escaping is performed
  314. by the database, which can lead to somewhat complex queries involving nested
  315. ``REPLACE`` function calls.
  316. * You can now refresh model instances by using :meth:`Model.refresh_from_db()
  317. <django.db.models.Model.refresh_from_db>`.
  318. * You can now get the set of deferred fields for a model using
  319. :meth:`Model.get_deferred_fields() <django.db.models.Model.get_deferred_fields>`.
  320. Signals
  321. ^^^^^^^
  322. * Exceptions from the ``(receiver, exception)`` tuples returned by
  323. :meth:`Signal.send_robust() <django.dispatch.Signal.send_robust>` now have
  324. their traceback attached as a ``__traceback__`` attribute.
  325. * The ``environ`` argument, which contains the WSGI environment structure from
  326. the request, was added to the :data:`~django.core.signals.request_started`
  327. signal.
  328. System Check Framework
  329. ^^^^^^^^^^^^^^^^^^^^^^
  330. * :attr:`~django.core.checks.register` can now be used as a function.
  331. Templates
  332. ^^^^^^^^^
  333. * :tfilter:`urlize` now supports domain-only links that include characters after
  334. the top-level domain (e.g. ``djangoproject.com/`` and
  335. ``djangoproject.com/download/``).
  336. * :tfilter:`urlize` doesn't treat exclamation marks at the end of a domain or
  337. its query string as part of the URL (the URL in e.g. ``'djangoproject.com!``
  338. is ``djangoproject.com``)
  339. * Added a :class:`locmem.Loader <django.template.loaders.locmem.Loader>`
  340. class that loads Django templates from a Python dictionary.
  341. * The :ttag:`now` tag can now store its output in a context variable with the
  342. usual syntax: ``{% now 'j n Y' as varname %}``.
  343. Requests and Responses
  344. ^^^^^^^^^^^^^^^^^^^^^^
  345. * ``WSGIRequest`` now respects paths starting with ``//``.
  346. * The :meth:`HttpRequest.build_absolute_uri()
  347. <django.http.HttpRequest.build_absolute_uri>` method now handles paths
  348. starting with ``//`` correctly.
  349. * If :setting:`DEBUG` is ``True`` and a request raises a
  350. :exc:`~django.core.exceptions.SuspiciousOperation`, the response will be
  351. rendered with a detailed error page.
  352. * The ``query_string`` argument of :class:`~django.http.QueryDict` is now
  353. optional, defaulting to ``None``, so a blank ``QueryDict`` can now be
  354. instantiated with ``QueryDict()`` instead of ``QueryDict(None)`` or
  355. ``QueryDict('')``.
  356. * The ``GET`` and ``POST`` attributes of an :class:`~django.http.HttpRequest`
  357. object are now :class:`~django.http.QueryDict`\s rather than dictionaries,
  358. and the ``FILES`` attribute is now a ``MultiValueDict``.
  359. This brings this class into line with the documentation and with
  360. ``WSGIRequest``.
  361. * The :attr:`HttpResponse.charset <django.http.HttpResponse.charset>` attribute
  362. was added.
  363. * ``WSGIRequestHandler`` now follows RFC in converting URI to IRI, using
  364. ``uri_to_iri()``.
  365. * The :meth:`HttpRequest.get_full_path()
  366. <django.http.HttpRequest.get_full_path>` method now escapes unsafe characters
  367. from the path portion of a Uniform Resource Identifier (URI) properly.
  368. * :class:`~django.http.HttpResponse` now implements a few additional methods
  369. like :meth:`~django.http.HttpResponse.getvalue` so that instances can be used
  370. as stream objects.
  371. * The new :meth:`HttpResponse.setdefault()
  372. <django.http.HttpResponse.setdefault>` method allows setting a header unless
  373. it has already been set.
  374. Tests
  375. ^^^^^
  376. * The :class:`RequestFactory.trace() <django.test.RequestFactory>`
  377. and :class:`Client.trace() <django.test.Client.trace>` methods were
  378. implemented, allowing you to create ``TRACE`` requests in your tests.
  379. * The ``count`` argument was added to
  380. :meth:`~django.test.SimpleTestCase.assertTemplateUsed`. This allows you to
  381. assert that a template was rendered a specific number of times.
  382. * The new :meth:`~django.test.SimpleTestCase.assertJSONNotEqual` assertion
  383. allows you to test that two JSON fragments are not equal.
  384. * Added options to the :djadmin:`test` command to preserve the test database
  385. (:djadminopt:`--keepdb`) and to run the test cases in reverse order
  386. (:djadminopt:`--reverse`).
  387. * Added the :attr:`~django.test.Response.resolver_match` attribute to test
  388. client responses.
  389. * Added several settings that allow customization of test tablespace parameters
  390. for Oracle: :setting:`DATAFILE`, :setting:`DATAFILE_TMP`,
  391. :setting:`DATAFILE_MAXSIZE` and :setting:`DATAFILE_TMP_MAXSIZE`.
  392. * The :func:`~django.test.override_settings` decorator can now affect the
  393. master router in :setting:`DATABASE_ROUTERS`.
  394. * Added test client support for file uploads with file-like objects.
  395. Validators
  396. ^^^^^^^^^^
  397. * ...
  398. Backwards incompatible changes in 1.8
  399. =====================================
  400. .. warning::
  401. In addition to the changes outlined in this section, be sure to review the
  402. :ref:`deprecation plan <deprecation-removed-in-1.8>` for any features that
  403. have been removed. If you haven't updated your code within the
  404. deprecation timeline for a given feature, its removal may appear as a
  405. backwards incompatible change.
  406. Related object operations are run in a transaction
  407. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  408. Some operations on related objects such as
  409. :meth:`~django.db.models.fields.related.RelatedManager.add()` or
  410. :ref:`direct assignment<direct-assignment>` ran multiple data modifying
  411. queries without wrapping them in transactions. To reduce the risk of data
  412. corruption, all data modifying methods that affect multiple related objects
  413. (i.e. ``add()``, ``remove()``, ``clear()``, and :ref:`direct assignment
  414. <direct-assignment>`) now perform their data modifying queries from within a
  415. transaction, provided your database supports transactions.
  416. This has one backwards incompatible side effect, signal handlers triggered from
  417. these methods are now executed within the method's transaction and any
  418. exception in a signal handler will prevent the whole operation.
  419. Assigning unsaved objects to relations raises an error
  420. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  421. Assigning unsaved objects to a :class:`~django.db.models.ForeignKey`,
  422. :class:`~django.contrib.contenttypes.fields.GenericForeignKey`, and
  423. :class:`~django.db.models.OneToOneField` now raises a :exc:`ValueError`.
  424. Previously, the assignment of an unsaved object would be silently ignored.
  425. For example::
  426. >>> book = Book.objects.create(name="Django")
  427. >>> book.author = Author(name="John")
  428. >>> book.author.save()
  429. >>> book.save()
  430. >>> Book.objects.get(name="Django")
  431. >>> book.author
  432. >>>
  433. Now, an error will be raised to prevent data loss::
  434. >>> book.author = Author(name="john")
  435. Traceback (most recent call last):
  436. ...
  437. ValueError: Cannot assign "<Author: John>": "Author" instance isn't saved in the database.
  438. Management commands that only accept positional arguments
  439. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  440. If you have written a custom management command that only accepts positional
  441. arguments and you didn't specify the
  442. :attr:`~django.core.management.BaseCommand.args` command variable, you might
  443. get an error like ``Error: unrecognized arguments: ...``, as variable parsing
  444. is now based on :py:mod:`argparse` which doesn't implicitly accept positional
  445. arguments. You can make your command backwards compatible by simply setting the
  446. :attr:`~django.core.management.BaseCommand.args` class variable. However, if
  447. you don't have to keep compatibility with older Django versions, it's better to
  448. implement the new :meth:`~django.core.management.BaseCommand.add_arguments`
  449. method as described in :doc:`/howto/custom-management-commands`.
  450. Custom test management command arguments through test runner
  451. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  452. The method to add custom arguments to the `test` management command through the
  453. test runner has changed. Previously, you could provide an `option_list` class
  454. variable on the test runner to add more arguments (à la :py:mod:`optparse`).
  455. Now to implement the same behavior, you have to create an
  456. ``add_arguments(cls, parser)`` class method on the test runner and call
  457. ``parser.add_argument`` to add any custom arguments, as parser is now an
  458. :py:class:`argparse.ArgumentParser` instance.
  459. Model check ensures auto-generated column names are within limits specified by database
  460. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  461. A field name that's longer than the column name length supported by a database
  462. can create problems. For example, with MySQL you'll get an exception trying to
  463. create the column, and with PostgreSQL the column name is truncated by the
  464. database (you may see a warning in the PostgreSQL logs).
  465. A model check has been introduced to better alert users to this scenario before
  466. the actual creation of database tables.
  467. If you have an existing model where this check seems to be a false positive,
  468. for example on PostgreSQL where the name was already being truncated, simply
  469. use :attr:`~django.db.models.Field.db_column` to specify the name that's being
  470. used.
  471. The check also applies to the columns generated in an implicit
  472. ``ManyToManyField.through`` model. If you run into an issue there, use
  473. :attr:`~django.db.models.ManyToManyField.through` to create an explicit model
  474. and then specify :attr:`~django.db.models.Field.db_column` on its column(s)
  475. as needed.
  476. Query relation lookups now check object types
  477. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  478. Querying for model lookups now checks if the object passed is of correct type
  479. and raises a :exc:`ValueError` if not. Previously, Django didn't care if the
  480. object was of correct type; it just used the object's related field attribute
  481. (e.g. ``id``) for the lookup. Now, an error is raised to prevent incorrect
  482. lookups::
  483. >>> book = Book.objects.create(name="Django")
  484. >>> book = Book.objects.filter(author=book)
  485. Traceback (most recent call last):
  486. ...
  487. ValueError: Cannot query "<Book: Django>": Must be "Author" instance.
  488. Default ``EmailField.max_length`` increased to 254
  489. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  490. The old default 75 character ``max_length`` was not capable of storing all
  491. possible RFC3696/5321-compliant email addresses. In order to store all
  492. possible valid email addresses, the ``max_length`` has been increased to 254
  493. characters. You will need to generate and apply database migrations for your
  494. affected models (or add ``max_length=75`` if you wish to keep the length on
  495. your current fields). A migration for
  496. :attr:`django.contrib.auth.models.User.email` is included.
  497. Support for PostgreSQL versions older than 9.0
  498. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  499. The end of upstream support periods was reached in July 2014 for PostgreSQL 8.4.
  500. As a consequence, Django 1.8 sets 9.0 as the minimum PostgreSQL version it
  501. officially supports.
  502. This also includes dropping support for PostGIS 1.3 and 1.4 as these versions
  503. are not supported on versions of PostgreSQL later than 8.4.
  504. Django also now requires the use of Psycopg2 version 2.0.9 or higher.
  505. Support for MySQL versions older than 5.5
  506. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  507. The end of upstream support periods was reached in January 2012 for MySQL 5.0
  508. and December 2013 for MySQL 5.1. As a consequence, Django 1.8 sets 5.5 as the
  509. minimum MySQL version it officially supports.
  510. Support for Oracle versions older than 11.1
  511. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  512. The end of upstream support periods was reached in July 2010 for Oracle 9.2,
  513. January 2012 for Oracle 10.1, and July 2013 for Oracle 10.2. As a consequence,
  514. Django 1.8 sets 11.1 as the minimum Oracle version it officially supports.
  515. Specific privileges used instead of roles for tests on Oracle
  516. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  517. Earlier versions of Django granted the CONNECT and RESOURCE roles to the test
  518. user on Oracle. These roles have been deprecated, so Django 1.8 uses the
  519. specific underlying privileges instead. This changes the privileges required
  520. of the main user for running tests (unless the project is configured to avoid
  521. creating a test user). The exact privileges required now are detailed in
  522. :ref:`Oracle notes <oracle-notes>`.
  523. ``AbstractUser.last_login`` allows null values
  524. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  525. The :attr:`AbstractUser.last_login <django.contrib.auth.models.User.last_login>`
  526. field now allows null values. Previously, it defaulted to the time when the user
  527. was created which was misleading if the user never logged in. Please run the
  528. database migration. If your custom user inherits from ``AbstractUser`` and you
  529. wish to set ``last_login`` to ``NULL`` for users who haven't logged in, you can
  530. run this query::
  531. from django.db import models
  532. from django.contrib.auth import get_user_model
  533. from django.contrib.auth.models import AbstractBaseUser
  534. UserModel = get_user_model()
  535. if issubclass(UserModel, AbstractBaseUser):
  536. UserModel._default_manager.filter(
  537. last_login=models.F('date_joined')
  538. ).update(last_login=None)
  539. :mod:`django.contrib.gis`
  540. ~~~~~~~~~~~~~~~~~~~~~~~~~
  541. * Support for GEOS 3.1 and GDAL 1.6 has been dropped.
  542. * Support for SpatiaLite < 2.4 has been dropped.
  543. * GIS-specific lookups have been refactored to use the
  544. :class:`django.db.models.Lookup` API.
  545. * The default ``str`` representation of
  546. :class:`~django.contrib.gis.geos.GEOSGeometry` objects has been changed from
  547. WKT to EWKT format (including the SRID). As this representation is used in
  548. the serialization framework, that means that ``dumpdata`` output will now
  549. contain the SRID value of geometry objects.
  550. Priority of context processors for ``TemplateResponse`` brought in line with ``render``
  551. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  552. The :class:`~django.template.response.TemplateResponse` constructor is designed to be a
  553. drop-in replacement for the :func:`~django.shortcuts.render` function. However,
  554. it had a slight incompatibility, in that for ``TemplateResponse``, context data
  555. from the passed in context dictionary could be shadowed by context data returned
  556. from context processors, whereas for ``render`` it was the other way
  557. around. This was a bug, and the behavior of ``render`` is more appropriate,
  558. since it allows the globally defined context processors to be overridden locally
  559. in the view. If you were relying on the fact context data in a
  560. ``TemplateResponse`` could be overridden using a context processor, you will
  561. need to change your code.
  562. Overriding ``setUpClass`` / ``tearDownClass`` in test cases
  563. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  564. The decorators :func:`~django.test.override_settings` and
  565. :func:`~django.test.modify_settings` now act at the class level when used as
  566. class decorators. As a consequence, when overriding ``setUpClass()`` or
  567. ``tearDownClass()``, the ``super`` implementation should always be called.
  568. Removal of ``django.contrib.formtools``
  569. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  570. The formtools contrib app has been moved into a separate package.
  571. ``django.contrib.formtools`` itself has been removed. The docs provide
  572. :ref:`migration instructions <formtools-how-to-migrate>`.
  573. The new package is available `on Github`_ and on PyPI.
  574. .. _on GitHub: https://github.com/django/django-formtools/
  575. Database connection reloading between tests
  576. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  577. Django previously closed database connections between each test within a
  578. ``TestCase``. This is no longer the case as Django now wraps the whole
  579. ``TestCase`` within a transaction. If some of your tests relied on the old
  580. behavior, you should have them inherit from ``TransactionTestCase`` instead.
  581. Miscellaneous
  582. ~~~~~~~~~~~~~
  583. * ``connections.queries`` is now a read-only attribute.
  584. * Database connections are considered equal only if they're the same object.
  585. They aren't hashable any more.
  586. * :class:`~django.middleware.gzip.GZipMiddleware` used to disable compression
  587. for some content types when the request is from Internet Explorer, in order
  588. to work around a bug in IE6 and earlier. This behavior could affect
  589. performance on IE7 and later. It was removed.
  590. * ``URLField.to_python`` no longer adds a trailing slash to pathless URLs.
  591. * The :tfilter:`length` template filter now returns ``0`` for an undefined
  592. variable, rather than an empty string.
  593. * ``ForeignKey.default_error_message['invalid']`` has been changed from
  594. ``'%(model)s instance with pk %(pk)r does not exist.'`` to
  595. ``'%(model)s instance with %(field)s %(value)r does not exist.'`` If you are
  596. using this message in your own code, please update the list of interpolated
  597. parameters. Internally, Django will continue to provide the
  598. ``pk`` parameter in ``params`` for backwards compatibility.
  599. * ``UserCreationForm.errors_messages['duplicate_username']`` is no longer used.
  600. If you wish to customize that error message, :ref:`override it on the form
  601. <modelforms-overriding-default-fields>` using the ``'unique'`` key in
  602. ``Meta.errors_messages['username']`` or, if you have a custom form field for
  603. ``'username'``, using the the ``'unique'`` key in its
  604. :attr:`~django.forms.Field.error_messages` argument.
  605. * ``AdminSite`` no longer takes an ``app_name`` argument and its ``app_name``
  606. attribute has been removed. The application name is always ``admin`` (as
  607. opposed to the instance name which you can still customize using
  608. ``AdminSite(name="...")``.
  609. * Internal changes were made to the :class:`~django.forms.ClearableFileInput`
  610. widget to allow more customization. The undocumented ``url_markup_template``
  611. attribute was removed in favor of ``template_with_initial``.
  612. * For consistency with other major vendors, the ``en_GB`` locale now has Monday
  613. as the first day of the week.
  614. * Seconds have been removed from any locales that had them in ``TIME_FORMAT``,
  615. ``DATETIME_FORMAT``, or ``SHORT_DATETIME_FORMAT``.
  616. * The default max size of the Oracle test tablespace has increased from 300M
  617. (or 200M, before 1.7.2) to 500M.
  618. * :func:`~django.core.urlresolvers.reverse` and
  619. :func:`~django.core.urlresolvers.reverse_lazy` now return Unicode strings
  620. instead of byte strings.
  621. * The ``CacheClass`` shim has been removed from all cache backends.
  622. These aliases were provided for backwards compatibility with Django 1.3.
  623. If you are still using them, please update your project to use the real
  624. class name found in the :setting:`BACKEND <CACHES-BACKEND>` key of the
  625. :setting:`CACHES` setting.
  626. * By default, :ref:`call_command <call-command>` now always skips the check
  627. framework (unless you pass it ``skip_checks=False``).
  628. * When iterating over lines, :class:`~django.core.files.File` now uses
  629. `universal newlines`_. The following are recognized as ending a line: the
  630. Unix end-of-line convention ``'\n'``, the Windows convention ``'\r\n'``, and
  631. the old Macintosh convention ``'\r'``.
  632. .. _universal newlines: http://www.python.org/dev/peps/pep-0278
  633. * The Memcached cache backends ``MemcachedCache`` and ``PyLibMCCache`` will
  634. delete a key if ``set()`` fails. This is necessary to ensure the ``cache_db``
  635. session store always fetches the most current session data.
  636. * Private API ``django.template.compile_string`` was removed.
  637. * Private APIs ``override_template_loaders`` and ``override_with_test_loader``
  638. in ``django.test.utils`` were removed. Override ``TEMPLATE_LOADERS`` with
  639. ``override_settings`` instead.
  640. * Warnings from the MySQL database backend are no longer converted to
  641. exceptions when :setting:`DEBUG` is ``True``.
  642. * :class:`~django.http.HttpRequest` now has a simplified ``repr`` (e.g.
  643. ``<WSGIRequest: GET '/somepath/'>``). This won't change the behavior of
  644. the :class:`~django.views.debug.SafeExceptionReporterFilter` class.
  645. * Class-based views that use :class:`~django.views.generic.edit.ModelFormMixin`
  646. will raise an :exc:`~django.core.exceptions.ImproperlyConfigured` exception
  647. when both the ``fields`` and ``form_class`` attributes are specified.
  648. Previously, ``fields`` was silently ignored.
  649. * When following redirects, the test client now raises
  650. :exc:`~django.test.client.RedirectCycleError` if it detects a loop or hits a
  651. maximum redirect limit (rather than passing silently).
  652. * Translatable strings set as the ``default`` parameter of the field are cast
  653. to concrete strings later, so the return type of ``Field.get_default()`` is
  654. different in some cases. There is no change to default values which are the
  655. result of a callable.
  656. .. _deprecated-features-1.8:
  657. Features deprecated in 1.8
  658. ==========================
  659. Loading ``cycle`` and ``firstof`` template tags from ``future`` library
  660. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  661. Django 1.6 introduced ``{% load cycle from future %}`` and
  662. ``{% load firstof from future %}`` syntax for forward compatibility of the
  663. :ttag:`cycle` and :ttag:`firstof` template tags. This syntax is now deprecated
  664. and will be removed in Django 2.0. You can simply remove the
  665. ``{% load ... from future %}`` tags.
  666. ``django.conf.urls.patterns()``
  667. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  668. In the olden days of Django, it was encouraged to reference views as strings
  669. in ``urlpatterns``::
  670. urlpatterns = patterns('',
  671. url('^$', 'myapp.views.myview'),
  672. )
  673. and Django would magically import ``myapp.views.myview`` internally and turn
  674. the string into a real function reference. In order to reduce repetition when
  675. referencing many views from the same module, the ``patterns()`` function takes
  676. a required initial ``prefix`` argument which is prepended to all
  677. views-as-strings in that set of ``urlpatterns``::
  678. urlpatterns = patterns('myapp.views',
  679. url('^$', 'myview'),
  680. url('^other/$', 'otherview'),
  681. )
  682. In the modern era, we have updated the tutorial to instead recommend importing
  683. your views module and referencing your view functions (or classes) directly.
  684. This has a number of advantages, all deriving from the fact that we are using
  685. normal Python in place of "Django String Magic": the errors when you mistype a
  686. view name are less obscure, IDEs can help with autocompletion of view names,
  687. etc.
  688. So these days, the above use of the ``prefix`` arg is much more likely to be
  689. written (and is better written) as::
  690. from myapp import views
  691. urlpatterns = patterns('',
  692. url('^$', views.myview),
  693. url('^other/$', views.otherview),
  694. )
  695. Thus ``patterns()`` serves little purpose and is a burden when teaching new users
  696. (answering the newbie's question "why do I need this empty string as the first
  697. argument to ``patterns()``?"). For these reasons, we are deprecating it.
  698. Updating your code is as simple as ensuring that ``urlpatterns`` is a list of
  699. :func:`django.conf.urls.url` instances. For example::
  700. from django.conf.urls import url
  701. from myapp import views
  702. urlpatterns = [
  703. url('^$', views.myview),
  704. url('^other/$', views.otherview),
  705. ]
  706. Passing a string as ``view`` to :func:`~django.conf.urls.url`
  707. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  708. Related to the previous item, referencing views as strings in the ``url()``
  709. function is deprecated. Pass the callable view as described in the previous
  710. section instead.
  711. ``django.test.SimpleTestCase.urls``
  712. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  713. The attribute :attr:`SimpleTestCase.urls <django.test.SimpleTestCase.urls>`
  714. for specifying URLconf configuration in tests has been deprecated and will be
  715. removed in Django 2.0. Use :func:`@override_settings(ROOT_URLCONF=...)
  716. <django.test.override_settings>` instead.
  717. ``prefix`` argument to :func:`~django.conf.urls.i18n.i18n_patterns`
  718. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  719. Related to the previous item, the ``prefix`` argument to
  720. :func:`django.conf.urls.i18n.i18n_patterns` has been deprecated. Simply pass a
  721. list of :func:`django.conf.urls.url` instances instead.
  722. Using an incorrect count of unpacked values in the :ttag:`for` template tag
  723. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  724. Using an incorrect count of unpacked values in :ttag:`for` tag will raise an
  725. exception rather than fail silently in Django 2.0.
  726. Passing a dotted path to :func:`~django.core.urlresolvers.reverse()` and :ttag:`url`
  727. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  728. Reversing URLs by Python path is an expensive operation as it causes the
  729. path being reversed to be imported. This behavior has also resulted in a
  730. `security issue`_. Use :ref:`named URL patterns <naming-url-patterns>`
  731. for reversing instead.
  732. If you are using :mod:`django.contrib.sitemaps`, add the ``name`` argument to
  733. the ``url`` that references :func:`django.contrib.sitemaps.views.sitemap`::
  734. from django.contrib.sitemaps.views import sitemap
  735. url(r'^sitemap\.xml$', sitemap, {'sitemaps': sitemaps},
  736. name='django.contrib.sitemaps.views.sitemap')
  737. to ensure compatibility when reversing by Python path is removed in Django 2.0.
  738. Similarly for GIS sitemaps, add ``name='django.contrib.gis.sitemaps.views.kml'``
  739. or ``name='django.contrib.gis.sitemaps.views.kmz'``.
  740. .. _security issue: https://www.djangoproject.com/weblog/2014/apr/21/security/#s-issue-unexpected-code-execution-using-reverse
  741. Aggregate methods and modules
  742. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  743. The ``django.db.models.sql.aggregates`` and
  744. ``django.contrib.gis.db.models.sql.aggregates`` modules (both private API), have
  745. been deprecated as ``django.db.models.aggregates`` and
  746. ``django.contrib.gis.db.models.aggregates`` are now also responsible
  747. for SQL generation. The old modules will be removed in Django 2.0.
  748. If you were using the old modules, see :doc:`Query Expressions
  749. </ref/models/expressions>` for instructions on rewriting custom aggregates
  750. using the new stable API.
  751. The following methods and properties of ``django.db.models.sql.query.Query``
  752. have also been deprecated and the backwards compatibility shims will be removed
  753. in Django 2.0:
  754. * ``Query.aggregates``, replaced by ``annotations``.
  755. * ``Query.aggregate_select``, replaced by ``annotation_select``.
  756. * ``Query.add_aggregate()``, replaced by ``add_annotation()``.
  757. * ``Query.set_aggregate_mask()``, replaced by ``set_annotation_mask()``.
  758. * ``Query.append_aggregate_mask()``, replaced by ``append_annotation_mask()``.
  759. Extending management command arguments through ``Command.option_list``
  760. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  761. Management commands now use :py:mod:`argparse` instead of :py:mod:`optparse` to
  762. parse command-line arguments passed to commands. This also means that the way
  763. to add custom arguments to commands has changed: instead of extending the
  764. ``option_list`` class list, you should now override the
  765. :meth:`~django.core.management.BaseCommand.add_arguments` method and add
  766. arguments through ``argparse.add_argument()``. See
  767. :ref:`this example <custom-commands-options>` for more details.
  768. ``django.core.management.NoArgsCommand``
  769. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  770. The class :class:`~django.core.management.NoArgsCommand` is now deprecated and
  771. will be removed in Django 2.0. Use :class:`~django.core.management.BaseCommand`
  772. instead, which takes no arguments by default.
  773. ``cache_choices`` option of ``ModelChoiceField`` and ``ModelMultipleChoiceField``
  774. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  775. :class:`~django.forms.ModelChoiceField` and
  776. :class:`~django.forms.ModelMultipleChoiceField` took an undocumented, untested
  777. option ``cache_choices``. This cached querysets between multiple renderings of
  778. the same ``Form`` object. This option is subject to an accelerated deprecation
  779. and will be removed in Django 1.9.
  780. ``django.template.resolve_variable()``
  781. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  782. The function has been informally marked as "Deprecated" for some time. Replace
  783. ``resolve_variable(path, context)`` with
  784. ``django.template.Variable(path).resolve(context)``.
  785. ``django.contrib.webdesign``
  786. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  787. It provided the :ttag:`lorem` template tag which is now included in the
  788. built-in tags. Simply remove ``'django.contrib.webdesign'`` from
  789. :setting:`INSTALLED_APPS` and ``{% load webdesign %}`` from your templates.
  790. ``error_message`` argument to ``django.forms.RegexField``
  791. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  792. It provided backwards compatibility for pre-1.0 code, but its functionality is
  793. redundant. Use ``Field.error_messages['invalid']`` instead.
  794. Old :tfilter:`unordered_list` syntax
  795. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  796. An older (pre-1.0), more restrictive and verbose input format for the
  797. :tfilter:`unordered_list` template filter has been deprecated::
  798. ``['States', [['Kansas', [['Lawrence', []], ['Topeka', []]]], ['Illinois', []]]]``
  799. Using the new syntax, this becomes::
  800. ``['States', ['Kansas', ['Lawrence', 'Topeka'], 'Illinois']]``
  801. ``django.forms.Field._has_changed()``
  802. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  803. Rename this method to :meth:`~django.forms.Field.has_changed` by removing the
  804. leading underscore. The old name will still work until Django 2.0.
  805. ``django.utils.html.remove_tags()`` and ``removetags`` template filter
  806. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  807. ``django.utils.html.remove_tags()`` as well as the template filter
  808. ``removetags`` have been deprecated as they cannot guarantee safe output. Their
  809. existence is likely to lead to their use in security-sensitive contexts where
  810. they are not actually safe.
  811. The unused and undocumented ``django.utils.html.strip_entities()`` function has
  812. also been deprecated.
  813. ``is_admin_site`` argument to ``django.contrib.auth.views.password_reset()``
  814. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  815. It's a legacy option that should no longer be necessary.
  816. ``SubfieldBase``
  817. ~~~~~~~~~~~~~~~~
  818. ``django.db.models.fields.subclassing.SubfieldBase`` has been deprecated and
  819. will be removed in Django 2.0. Historically, it was used to handle fields where
  820. type conversion was needed when loading from the database, but it was not used
  821. in ``.values()`` calls or in aggregates. It has been replaced with
  822. :meth:`~django.db.models.Field.from_db_value`. Note that the new approach does
  823. not call the :meth:`~django.db.models.Field.to_python` method on assignment
  824. as was the case with ``SubfieldBase``.
  825. ``django.utils.checksums``
  826. ~~~~~~~~~~~~~~~~~~~~~~~~~~
  827. The ``django.utils.checksums`` module has been deprecated and will be removed
  828. in Django 2.0. The functionality it provided (validating checksum using the
  829. Luhn algorithm) was undocumented and not used in Django. The module has been
  830. moved to the `django-localflavor`_ package (version 1.1+).
  831. .. _django-localflavor: https://pypi.python.org/pypi/django-localflavor
  832. ``django.contrib.admin.helpers.InlineAdminForm.original_content_type_id``
  833. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  834. The ``original_content_type_id`` attribute on ``InlineAdminForm`` has been
  835. deprecated and will be removed in Django 2.0. Historically, it was used
  836. to construct the "view on site" URL. This URL is now accessible using the
  837. ``absolute_url`` attribute of the form.
  838. ``django.views.generic.edit.FormMixin.get_form()``’s ``form_class`` argument
  839. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  840. ``FormMixin`` subclasses that override the ``get_form()`` method should make
  841. sure to provide a default value for the ``form_class`` argument since it's
  842. now optional.
  843. ``dirs`` argument of template-finding functions
  844. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  845. The following functions will no longer accept a ``dirs`` parameter to override
  846. :setting:`TEMPLATE_DIRS` in Django 2.0:
  847. * :func:`django.template.loader.get_template()`
  848. * :func:`django.template.loader.select_template()`
  849. * :func:`django.shortcuts.render()`
  850. * :func:`django.shortcuts.render_to_response()`
  851. The parameter didn't work consistently across different template loaders and
  852. didn't work for included templates.
  853. ``django.template.loader.BaseLoader``
  854. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  855. ``django.template.loader.BaseLoader`` was renamed to
  856. ``django.template.loaders.base.Loader``. If you've written a custom template
  857. loader that inherits ``BaseLoader``, you must inherit ``Loader`` instead.
  858. ``django.test.utils.TestTemplateLoader``
  859. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  860. Private API ``django.test.utils.TestTemplateLoader`` is deprecated in favor of
  861. ``django.template.loaders.locmem.Loader``.
  862. ``qn`` replaced by ``compiler``
  863. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  864. In previous Django versions, various internal ORM methods (mostly ``as_sql``
  865. methods) accepted a ``qn`` (for "quote name") argument, which was a reference
  866. to a function that quoted identifiers for sending to the database. In Django
  867. 1.8, that argument has been renamed to ``compiler`` and is now a full
  868. ``SQLCompiler`` instance. For backwards-compatibility, calling a
  869. ``SQLCompiler`` instance performs the same name-quoting that the ``qn``
  870. function used to. However, this backwards-compatibility shim is immediately
  871. deprecated: you should rename your ``qn`` arguments to ``compiler``, and call
  872. ``compiler.quote_name_unless_alias(...)`` where you previously called
  873. ``qn(...)``.
  874. Default value of ``RedirectView.permanent``
  875. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  876. The default value of the
  877. :attr:`RedirectView.permanent <django.views.generic.base.RedirectView.permanent>`
  878. attribute will change from ``True`` to ``False`` in Django 1.9.
  879. Using ``AuthenticationMiddleware`` without ``SessionAuthenticationMiddleware``
  880. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  881. :class:`django.contrib.auth.middleware.SessionAuthenticationMiddleware` was
  882. added in Django 1.7. In Django 1.7.2, its functionality was moved to
  883. ``auth.get_user()`` and, for backwards compatibility, enabled only if
  884. ``'django.contrib.auth.middleware.SessionAuthenticationMiddleware'`` appears in
  885. :setting:`MIDDLEWARE_CLASSES`.
  886. In Django 2.0, session verification will be enabled regardless of whether or not
  887. ``SessionAuthenticationMiddleware`` is enabled (at which point
  888. ``SessionAuthenticationMiddleware`` will have no significance). You can add it
  889. to your ``MIDDLEWARE_CLASSES`` sometime before then to opt-in. Please read the
  890. :ref:`upgrade considerations <session-invalidation-on-password-change>` first.
  891. ``django.contrib.sitemaps.FlatPageSitemap``
  892. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  893. ``django.contrib.sitemaps.FlatPageSitemap`` has moved to
  894. ``django.contrib.flatpages.sitemaps.FlatPageSitemap``. The old import location
  895. is deprecated and will be removed in Django 1.9.
  896. .. removed-features-1.8:
  897. Features removed in 1.8
  898. =======================
  899. These features have reached the end of their deprecation cycle and so have been
  900. removed in Django 1.8 (please see the :ref:`deprecation timeline
  901. <deprecation-removed-in-1.8>` for more details):
  902. * ``django.contrib.comments`` is removed.
  903. * The following transaction management APIs are removed:
  904. - ``TransactionMiddleware``
  905. - the decorators and context managers ``autocommit``, ``commit_on_success``,
  906. and ``commit_manually``, defined in ``django.db.transaction``
  907. - the functions ``commit_unless_managed`` and ``rollback_unless_managed``,
  908. also defined in ``django.db.transaction``
  909. - the ``TRANSACTIONS_MANAGED`` setting
  910. * The :ttag:`cycle` and :ttag:`firstof` template tags auto-escape their
  911. arguments.
  912. * The ``SEND_BROKEN_LINK_EMAILS`` setting is removed.
  913. * ``django.middleware.doc.XViewMiddleware`` is removed.
  914. * The ``Model._meta.module_name`` alias is removed.
  915. * The backward compatible shims introduced to rename ``get_query_set``
  916. and similar queryset methods are removed. This affects the following classes:
  917. ``BaseModelAdmin``, ``ChangeList``, ``BaseCommentNode``,
  918. ``GenericForeignKey``, ``Manager``, ``SingleRelatedObjectDescriptor`` and
  919. ``ReverseSingleRelatedObjectDescriptor``.
  920. * The backward compatible shims introduced to rename the attributes
  921. ``ChangeList.root_query_set`` and ``ChangeList.query_set`` are removed.
  922. * ``django.views.defaults.shortcut`` and ``django.conf.urls.shortcut`` are
  923. removed.
  924. * Support for the Python Imaging Library (PIL) module is removed.
  925. * The following private APIs are removed:
  926. - ``django.db.backend``
  927. - ``django.db.close_connection()``
  928. - ``django.db.backends.creation.BaseDatabaseCreation.set_autocommit()``
  929. - ``django.db.transaction.is_managed()``
  930. - ``django.db.transaction.managed()``
  931. * ``django.forms.widgets.RadioInput`` is removed.
  932. * The module ``django.test.simple`` and the class
  933. ``django.test.simple.DjangoTestSuiteRunner`` are removed.
  934. * The module ``django.test._doctest`` is removed.
  935. * The ``CACHE_MIDDLEWARE_ANONYMOUS_ONLY`` setting is removed.
  936. * Usage of the hard-coded *Hold down "Control", or "Command" on a Mac, to select
  937. more than one.* string to override or append to user-provided ``help_text`` in
  938. forms for ``ManyToMany`` model fields is not be performed by Django anymore
  939. either at the model or forms layer.
  940. * The ``Model._meta.get_(add|change|delete)_permission`` methods are removed.
  941. * The session key ``django_language`` is no longer read for backwards
  942. compatibility.
  943. * Geographic Sitemaps are removed
  944. (``django.contrib.gis.sitemaps.views.index`` and
  945. ``django.contrib.gis.sitemaps.views.sitemap``).
  946. * ``django.utils.html.fix_ampersands``, the ``fix_ampersands`` template filter,
  947. and ``django.utils.html.clean_html`` are removed.