1.8.txt 48 KB

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