1.9.txt 58 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415
  1. ============================================
  2. Django 1.9 release notes - UNDER DEVELOPMENT
  3. ============================================
  4. Welcome to Django 1.9!
  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.8 or older versions. We've :ref:`dropped some features<removed-features-1.9>`
  8. that have reached the end of their deprecation cycle, and we've `begun the
  9. deprecation process for some features`_.
  10. .. _`new features`: `What's new in Django 1.9`_
  11. .. _`backwards incompatible changes`: `Backwards incompatible changes in 1.9`_
  12. .. _`dropped some features`: `Features removed in 1.9`_
  13. .. _`begun the deprecation process for some features`: `Features deprecated in 1.9`_
  14. Python compatibility
  15. ====================
  16. Django 1.9 requires Python 2.7, 3.4, or 3.5. We **highly recommend** and only
  17. officially support the latest release of each series.
  18. Since Django 1.8, we've dropped support for Python 3.2 and 3.3, and added
  19. support for Python 3.5.
  20. What's new in Django 1.9
  21. ========================
  22. Performing actions after a transaction commit
  23. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  24. The new :func:`~django.db.transaction.on_commit` hook allows performing actions
  25. after a database transaction is successfully committed. This is useful for
  26. tasks such as sending notification emails, creating queued tasks, or
  27. invalidating caches.
  28. This functionality from the `django-transaction-hooks`_ package has been
  29. integrated into Django.
  30. .. _django-transaction-hooks: https://pypi.python.org/pypi/django-transaction-hooks
  31. Password validation
  32. ~~~~~~~~~~~~~~~~~~~
  33. Django now offers password validation to help prevent the usage of weak
  34. passwords by users. The validation is integrated in the included password
  35. change and reset forms and is simple to integrate in any other code.
  36. Validation is performed by one or more validators, configured in the new
  37. :setting:`AUTH_PASSWORD_VALIDATORS` setting.
  38. Four validators are included in Django, which can enforce a minimum length,
  39. compare the password to the user's attributes like their name, ensure
  40. passwords aren't entirely numeric, or check against an included list of common
  41. passwords. You can combine multiple validators, and some validators have
  42. custom configuration options. For example, you can choose to provide a custom
  43. list of common passwords. Each validator provides a help text to explain its
  44. requirements to the user.
  45. By default, no validation is performed and all passwords are accepted, so if
  46. you don't set :setting:`AUTH_PASSWORD_VALIDATORS`, you will not see any
  47. change. In new projects created with the default :djadmin:`startproject`
  48. template, a simple set of validators is enabled. To enable basic validation in
  49. the included auth forms for your project, you could set, for example::
  50. AUTH_PASSWORD_VALIDATORS = [
  51. {
  52. 'NAME': 'django.contrib.auth.password_validation.UserAttributeSimilarityValidator',
  53. },
  54. {
  55. 'NAME': 'django.contrib.auth.password_validation.MinimumLengthValidator',
  56. },
  57. {
  58. 'NAME': 'django.contrib.auth.password_validation.CommonPasswordValidator',
  59. },
  60. {
  61. 'NAME': 'django.contrib.auth.password_validation.NumericPasswordValidator',
  62. },
  63. ]
  64. See :ref:`password-validation` for more details.
  65. Permission mixins for class-based views
  66. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  67. Django now ships with the mixins
  68. :class:`~django.contrib.auth.mixins.AccessMixin`,
  69. :class:`~django.contrib.auth.mixins.LoginRequiredMixin`,
  70. :class:`~django.contrib.auth.mixins.PermissionRequiredMixin`, and
  71. :class:`~django.contrib.auth.mixins.UserPassesTestMixin` to provide the
  72. functionality of the ``django.contrib.auth.decorators`` for class-based views.
  73. These mixins have been taken from, or are at least inspired by, the
  74. `django-braces`_ project.
  75. There are a few differences between Django's and django-braces' implementation,
  76. though:
  77. * The :attr:`~django.contrib.auth.mixins.AccessMixin.raise_exception` attribute
  78. can only be ``True`` or ``False``. Custom exceptions or callables are not
  79. supported.
  80. * The :meth:`~django.contrib.auth.mixins.AccessMixin.handle_no_permission`
  81. method does not take a ``request`` argument. The current request is available
  82. in ``self.request``.
  83. * The custom ``test_func()`` of :class:`~django.contrib.auth.mixins.UserPassesTestMixin`
  84. does not take a ``user`` argument. The current user is available in
  85. ``self.request.user``.
  86. * The :attr:`permission_required <django.contrib.auth.mixins.PermissionRequiredMixin>`
  87. attribute supports a string (defining one permission) or a list/tuple of
  88. strings (defining multiple permissions) that need to be fulfilled to grant
  89. access.
  90. * The new :attr:`~django.contrib.auth.mixins.AccessMixin.permission_denied_message`
  91. attribute allows passing a message to the ``PermissionDenied`` exception.
  92. .. _django-braces: http://django-braces.readthedocs.org/en/latest/index.html
  93. New styling for ``contrib.admin``
  94. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  95. The admin sports a modern, flat design with new SVG icons which look perfect
  96. on HiDPI screens. It still provides a fully-functional experience to `YUI's
  97. A-grade`_ browsers. Older browser may experience varying levels of graceful
  98. degradation.
  99. .. _YUI's A-grade: https://github.com/yui/yui3/wiki/Graded-Browser-Support
  100. Running tests in parallel
  101. ~~~~~~~~~~~~~~~~~~~~~~~~~
  102. The :djadmin:`test` command now supports a :djadminopt:`--parallel` option to
  103. run a project's tests in multiple processes in parallel.
  104. Each process gets its own database. You must ensure that different test cases
  105. don't access the same resources. For instance, test cases that touch the
  106. filesystem should create a temporary directory for their own use.
  107. This option is enabled by default for Django's own test suite provided:
  108. - the OS supports it (all but Windows)
  109. - the database backend supports it (all the built-in backends but Oracle)
  110. Minor features
  111. ~~~~~~~~~~~~~~
  112. :mod:`django.contrib.admin`
  113. ^^^^^^^^^^^^^^^^^^^^^^^^^^^
  114. * Admin views now have ``model_admin`` or ``admin_site`` attributes.
  115. * The URL of the admin change view has been changed (was at
  116. ``/admin/<app>/<model>/<pk>/`` by default and is now at
  117. ``/admin/<app>/<model>/<pk>/change/``). This should not affect your
  118. application unless you have hardcoded admin URLs. In that case, replace those
  119. links by :ref:`reversing admin URLs <admin-reverse-urls>` instead. Note that
  120. the old URL still redirects to the new one for backwards compatibility, but
  121. it may be removed in a future version.
  122. * :meth:`ModelAdmin.get_list_select_related()
  123. <django.contrib.admin.ModelAdmin.get_list_select_related>` was added to allow
  124. changing the ``select_related()`` values used in the admin's changelist query
  125. based on the request.
  126. * The ``available_apps`` context variable, which lists the available
  127. applications for the current user, has been added to the
  128. :meth:`AdminSite.each_context() <django.contrib.admin.AdminSite.each_context>`
  129. method.
  130. * :attr:`AdminSite.empty_value_display
  131. <django.contrib.admin.AdminSite.empty_value_display>` and
  132. :attr:`ModelAdmin.empty_value_display
  133. <django.contrib.admin.ModelAdmin.empty_value_display>` were added to override
  134. the display of empty values in admin change list. You can also customize the
  135. value for each field.
  136. * Added jQuery events :ref:`when an inline form is added or removed
  137. <admin-javascript-inline-form-events>` on the change form page.
  138. * The time picker widget includes a '6 p.m' option for consistency of having
  139. predefined options every 6 hours.
  140. * JavaScript slug generation now supports Romanian characters.
  141. :mod:`django.contrib.admindocs`
  142. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  143. * The model section of the ``admindocs`` now also describes methods that take
  144. arguments, rather than ignoring them.
  145. :mod:`django.contrib.auth`
  146. ^^^^^^^^^^^^^^^^^^^^^^^^^^
  147. * The default iteration count for the PBKDF2 password hasher has been increased
  148. by 20%. This backwards compatible change will not affect users who have
  149. subclassed ``django.contrib.auth.hashers.PBKDF2PasswordHasher`` to change the
  150. default value.
  151. * The ``BCryptSHA256PasswordHasher`` will now update passwords if its
  152. ``rounds`` attribute is changed.
  153. * ``AbstractBaseUser`` and ``BaseUserManager`` were moved to a new
  154. ``django.contrib.auth.base_user`` module so that they can be imported without
  155. including ``django.contrib.auth`` in :setting:`INSTALLED_APPS` (doing so
  156. raised a deprecation warning in older versions and is no longer supported in
  157. Django 1.9).
  158. * The permission argument of
  159. :func:`~django.contrib.auth.decorators.permission_required()` accepts all
  160. kinds of iterables, not only list and tuples.
  161. * The new :class:`~django.contrib.auth.middleware.PersistentRemoteUserMiddleware`
  162. makes it possible to use ``REMOTE_USER`` for setups where the header is only
  163. populated on login pages instead of every request in the session.
  164. * The :func:`~django.contrib.auth.views.password_reset` view accepts an
  165. ``extra_email_context`` parameter.
  166. :mod:`django.contrib.contenttypes`
  167. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  168. * It's now possible to use
  169. :attr:`~django.db.models.Options.order_with_respect_to` with a
  170. ``GenericForeignKey``.
  171. :mod:`django.contrib.gis`
  172. ^^^^^^^^^^^^^^^^^^^^^^^^^^
  173. * All ``GeoQuerySet`` methods have been deprecated and replaced by
  174. :doc:`equivalent database functions </ref/contrib/gis/functions>`. As soon
  175. as the legacy methods have been replaced in your code, you should even be
  176. able to remove the special ``GeoManager`` from your GIS-enabled classes.
  177. * The GDAL interface now supports instantiating file-based and in-memory
  178. :ref:`GDALRaster objects <raster-data-source-objects>` from raw data.
  179. Setters for raster properties such as projection or pixel values have
  180. been added.
  181. * For PostGIS users, the new :class:`~django.contrib.gis.db.models.RasterField`
  182. allows :ref:`storing GDALRaster objects <creating-and-saving-raster-models>`.
  183. It supports automatic spatial index creation and reprojection when saving a
  184. model. It does not yet support spatial querying.
  185. * The new :meth:`GDALRaster.warp() <django.contrib.gis.gdal.GDALRaster.warp>`
  186. method allows warping a raster by specifying target raster properties such as
  187. origin, width, height, or pixel size (amongst others).
  188. * The new :meth:`GDALRaster.transform()
  189. <django.contrib.gis.gdal.GDALRaster.transform>` method allows transforming a
  190. raster into a different spatial reference system by specifying a target
  191. ``srid``.
  192. * The new :class:`~django.contrib.gis.geoip2.GeoIP2` class allows using
  193. MaxMind's GeoLite2 databases which includes support for IPv6 addresses.
  194. :mod:`django.contrib.postgres`
  195. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  196. * Added support for the :lookup:`rangefield.contained_by` lookup for some built
  197. in fields which correspond to the range fields.
  198. * Added :class:`~django.contrib.postgres.fields.JSONField`.
  199. * Added :doc:`/ref/contrib/postgres/aggregates`.
  200. * Fixed serialization of
  201. :class:`~django.contrib.postgres.fields.DateRangeField` and
  202. :class:`~django.contrib.postgres.fields.DateTimeRangeField`.
  203. * Added the :class:`~django.contrib.postgres.functions.TransactionNow` database
  204. function.
  205. :mod:`django.contrib.sessions`
  206. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  207. * The session model and ``SessionStore`` classes for the ``db`` and
  208. ``cached_db`` backends are refactored to allow a custom database session
  209. backend to build upon them. See
  210. :ref:`extending-database-backed-session-engines` for more details.
  211. :mod:`django.contrib.sites`
  212. ^^^^^^^^^^^^^^^^^^^^^^^^^^^
  213. * :func:`~django.contrib.sites.shortcuts.get_current_site` now handles the case
  214. where ``request.get_host()`` returns ``domain:port``, e.g.
  215. ``example.com:80``. If the lookup fails because the host does not match a
  216. record in the database and the host has a port, the port is stripped and the
  217. lookup is retried with the domain part only.
  218. :mod:`django.contrib.syndication`
  219. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  220. * Support for multiple enclosures per feed item has been added. If multiple
  221. enclosures are defined on a RSS feed, an exception is raised as RSS feeds,
  222. unlike Atom feeds, do not support multiple enclosures per feed item.
  223. Cache
  224. ^^^^^
  225. * ``django.core.cache.backends.base.BaseCache`` now has a ``get_or_set()``
  226. method.
  227. * :func:`django.views.decorators.cache.never_cache` now sends more persuasive
  228. headers (added ``no-cache, no-store, must-revalidate`` to ``Cache-Control``)
  229. to better prevent caching.
  230. CSRF
  231. ^^^^
  232. * The request header's name used for CSRF authentication can be customized
  233. with :setting:`CSRF_HEADER_NAME`.
  234. * The CSRF referer header is now validated against the
  235. :setting:`CSRF_COOKIE_DOMAIN` setting if set. See :ref:`how-csrf-works` for
  236. details.
  237. * The new :setting:`CSRF_TRUSTED_ORIGINS` setting provides a way to allow
  238. cross-origin unsafe requests (e.g. ``POST``) over HTTPS.
  239. Database backends
  240. ^^^^^^^^^^^^^^^^^
  241. * The PostgreSQL backend (``django.db.backends.postgresql_psycopg2``) is also
  242. available as ``django.db.backends.postgresql``. The old name will continue to
  243. be available for backwards compatibility.
  244. File Storage
  245. ^^^^^^^^^^^^
  246. * :meth:`Storage.get_valid_name()
  247. <django.core.files.storage.Storage.get_valid_name>` is now called when
  248. the :attr:`~django.db.models.FileField.upload_to` is a callable.
  249. * :class:`~django.core.files.File` now has the ``seekable()`` method when using
  250. Python 3.
  251. Forms
  252. ^^^^^
  253. * :class:`~django.forms.ModelForm` accepts the new ``Meta`` option
  254. ``field_classes`` to customize the type of the fields. See
  255. :ref:`modelforms-overriding-default-fields` for details.
  256. * You can now specify the order in which form fields are rendered with the
  257. :attr:`~django.forms.Form.field_order` attribute, the ``field_order``
  258. constructor argument , or the :meth:`~django.forms.Form.order_fields` method.
  259. * A form prefix can be specified inside a form class, not only when
  260. instantiating a form. See :ref:`form-prefix` for details.
  261. * You can now :ref:`specify keyword arguments <custom-formset-form-kwargs>`
  262. that you want to pass to the constructor of forms in a formset.
  263. * :class:`~django.forms.SlugField` now accepts an
  264. :attr:`~django.forms.SlugField.allow_unicode` argument to allow Unicode
  265. characters in slugs.
  266. * :class:`~django.forms.CharField` now accepts a
  267. :attr:`~django.forms.CharField.strip` argument to strip input data of leading
  268. and trailing whitespace. As this defaults to ``True`` this is different
  269. behavior from previous releases.
  270. * Form fields now support the :attr:`~django.forms.Field.disabled` argument,
  271. allowing the field widget to be displayed disabled by browsers.
  272. * It's now possible to customize bound fields by overriding a field's
  273. :meth:`~django.forms.Field.get_bound_field()` method.
  274. Generic Views
  275. ^^^^^^^^^^^^^
  276. * Class-based views generated using ``as_view()`` now have ``view_class``
  277. and ``view_initkwargs`` attributes.
  278. * :func:`~django.utils.decorators.method_decorator` can now be used with a list
  279. or tuple of decorators. It can also be used to :ref:`decorate classes instead
  280. of methods <decorating-class-based-views>`.
  281. Internationalization
  282. ^^^^^^^^^^^^^^^^^^^^
  283. * The :func:`django.views.i18n.set_language` view now properly redirects to
  284. :ref:`translated URLs <url-internationalization>`, when available.
  285. * The :func:`django.views.i18n.javascript_catalog` view now works correctly
  286. if used multiple times with different configurations on the same page.
  287. * The :func:`django.utils.timezone.make_aware` function gained an ``is_dst``
  288. argument to help resolve ambiguous times during DST transitions.
  289. * You can now use locale variants supported by gettext. These are usually used
  290. for languages which can be written in different scripts, for example Latin
  291. and Cyrillic (e.g. ``be@latin``).
  292. * Added the :func:`django.views.i18n.json_catalog` view to help build a custom
  293. client-side i18n library upon Django translations. It returns a JSON object
  294. containing a translations catalog, formatting settings, and a plural rule.
  295. * Added the ``name_translated`` attribute to the object returned by the
  296. :ttag:`get_language_info` template tag. Also added a corresponding template
  297. filter: :tfilter:`language_name_translated`.
  298. * You can now run :djadmin:`compilemessages` from the root directory of your
  299. project and it will find all the app message files that were created by
  300. :djadmin:`makemessages`.
  301. * :djadmin:`makemessages` now calls xgettext once per locale directory rather
  302. than once per translatable file. This speeds up localization builds.
  303. * :ttag:`blocktrans` supports assigning its output to a variable using
  304. ``asvar``.
  305. Management Commands
  306. ^^^^^^^^^^^^^^^^^^^
  307. * The new :djadmin:`sendtestemail` command lets you send a test email to
  308. easily confirm that email sending through Django is working.
  309. * To increase the readability of the SQL code generated by
  310. :djadmin:`sqlmigrate`, the SQL code generated for each migration operation is
  311. preceded by the operation's description.
  312. * The :djadmin:`dumpdata` command output is now deterministically ordered.
  313. Moreover, when the ``--ouput`` option is specified, it also shows a progress
  314. bar in the terminal.
  315. * The :djadmin:`createcachetable` command now has a ``--dry-run`` flag to
  316. print out the SQL rather than execute it.
  317. * The :djadmin:`startapp` command creates an ``apps.py`` file.
  318. * When using the PostgreSQL backend, the :djadmin:`dbshell` command can connect
  319. to the database using the password from your settings file (instead of
  320. requiring it to be manually entered).
  321. * The ``django`` package may be run as a script, i.e. ``python -m django``,
  322. which will behave the same as ``django-admin``.
  323. * Management commands that have the ``--noinput`` option now also take
  324. ``--no-input`` as an alias for that option.
  325. Migrations
  326. ^^^^^^^^^^
  327. * Initial migrations are now marked with an :attr:`initial = True
  328. <django.db.migrations.Migration.initial>` class attribute which allows
  329. :djadminopt:`migrate --fake-initial <--fake-initial>` to more easily detect
  330. initial migrations.
  331. * Added support for serialization of ``functools.partial`` objects.
  332. * When supplying ``None`` as a value in :setting:`MIGRATION_MODULES`, Django
  333. will consider the app an app without migrations.
  334. * When applying migrations, the "Rendering model states" step that's displayed
  335. when running migrate with verbosity 2 or higher now computes only the states
  336. for the migrations that have already been applied. The model states for
  337. migrations being applied are generated on demand, drastically reducing the
  338. amount of required memory.
  339. However, this improvement is not available when unapplying migrations and
  340. therefore still requires the precomputation and storage of the intermediate
  341. migration states.
  342. This improvement also requires that Django no longer supports mixed migration
  343. plans. Mixed plans consist of a list of migrations where some are being
  344. applied and others are being unapplied. This was never officially supported
  345. and never had a public API that supports this behavior.
  346. * The :djadmin:`squashmigrations` command now supports specifying the starting
  347. migration from which migrations will be squashed.
  348. Models
  349. ^^^^^^
  350. * :meth:`QuerySet.bulk_create() <django.db.models.query.QuerySet.bulk_create>`
  351. now works on proxy models.
  352. * Database configuration gained a :setting:`TIME_ZONE <DATABASE-TIME_ZONE>`
  353. option for interacting with databases that store datetimes in local time and
  354. don't support time zones when :setting:`USE_TZ` is ``True``.
  355. * Added the :meth:`RelatedManager.set()
  356. <django.db.models.fields.related.RelatedManager.set()>` method to the related
  357. managers created by ``ForeignKey``, ``GenericForeignKey``, and
  358. ``ManyToManyField``.
  359. * The :meth:`~django.db.models.fields.related.RelatedManager.add` method on
  360. a reverse foreign key now has a ``bulk`` parameter to allow executing one
  361. query regardless of the number of objects being added rather than one query
  362. per object.
  363. * Added the ``keep_parents`` parameter to :meth:`Model.delete()
  364. <django.db.models.Model.delete>` to allow deleting only a child's data in a
  365. model that uses multi-table inheritance.
  366. * :meth:`Model.delete() <django.db.models.Model.delete>`
  367. and :meth:`QuerySet.delete() <django.db.models.query.QuerySet.delete>` return
  368. the number of objects deleted.
  369. * Added a system check to prevent defining both ``Meta.ordering`` and
  370. ``order_with_respect_to`` on the same model.
  371. * :lookup:`Date and time <year>` lookups can be chained with other lookups
  372. (such as :lookup:`exact`, :lookup:`gt`, :lookup:`lt`, etc.). For example:
  373. ``Entry.objects.filter(pub_date__month__gt=6)``.
  374. * Time lookups (hour, minute, second) are now supported by
  375. :class:`~django.db.models.TimeField` for all database backends. Support for
  376. backends other than SQLite was added but undocumented in Django 1.7.
  377. * You can specify the ``output_field`` parameter of the
  378. :class:`~django.db.models.Avg` aggregate in order to aggregate over
  379. non-numeric columns, such as ``DurationField``.
  380. * Added the :lookup:`date` lookup to :class:`~django.db.models.DateTimeField`
  381. to allow querying the field by only the date portion.
  382. * Added the :class:`~django.db.models.functions.Greatest` and
  383. :class:`~django.db.models.functions.Least` database functions.
  384. * Added the :class:`~django.db.models.functions.Now` database function, which
  385. returns the current date and time.
  386. * :class:`~django.db.models.Transform` is now a subclass of
  387. :ref:`Func() <func-expressions>` which allows ``Transform``\s to be used on
  388. the right hand side of an expression, just like regular ``Func``\s. This
  389. allows registering some database functions like
  390. :class:`~django.db.models.functions.Length`,
  391. :class:`~django.db.models.functions.Lower`, and
  392. :class:`~django.db.models.functions.Upper` as transforms.
  393. * :class:`~django.db.models.SlugField` now accepts an
  394. :attr:`~django.db.models.SlugField.allow_unicode` argument to allow Unicode
  395. characters in slugs.
  396. * Added support for referencing annotations in ``QuerySet.distinct()``.
  397. * ``connection.queries`` shows queries with substituted parameters on SQLite.
  398. * Added a new model field check that makes sure
  399. :attr:`~django.db.models.Field.default` is a valid value.
  400. * :doc:`Query expressions </ref/models/expressions>` can now be used when
  401. creating new model instances using ``save()``, ``create()``, and
  402. ``bulk_create()``.
  403. Requests and Responses
  404. ^^^^^^^^^^^^^^^^^^^^^^
  405. * Unless :attr:`HttpResponse.reason_phrase
  406. <django.http.HttpResponse.reason_phrase>` is explicitly set, it now is
  407. determined by the current value of :attr:`HttpResponse.status_code
  408. <django.http.HttpResponse.status_code>`. Modifying the value of
  409. ``status_code`` outside of the constructor will also modify the value of
  410. ``reason_phrase``.
  411. * The debug view now shows details of chained exceptions on Python 3.
  412. * The default 40x error views now accept a second positional parameter, the
  413. exception that triggered the view.
  414. * View error handlers now support
  415. :class:`~django.template.response.TemplateResponse`, commonly used with
  416. class-based views.
  417. * Exceptions raised by the ``render()`` method are now passed to the
  418. ``process_exception()`` method of each middleware.
  419. * Request middleware can now set :attr:`HttpRequest.urlconf
  420. <django.http.HttpRequest.urlconf>` to ``None`` to revert any changes made
  421. by previous middleware and return to using the :setting:`ROOT_URLCONF`.
  422. * The :setting:`DISALLOWED_USER_AGENTS` check in
  423. :class:`~django.middleware.common.CommonMiddleware` now raises a
  424. :class:`~django.core.exceptions.PermissionDenied` exception as opposed to
  425. returning an :class:`~django.http.HttpResponseForbidden` so that
  426. :data:`~django.conf.urls.handler403` is invoked.
  427. * Added :meth:`HttpRequest.get_port() <django.http.HttpRequest.get_port>` to
  428. fetch the originating port of the request.
  429. * Added the ``json_dumps_params`` parameter to
  430. :class:`~django.http.JsonResponse` to allow passing keyword arguments to the
  431. ``json.dumps()`` call used to generate the response.
  432. * The :class:`~django.middleware.common.BrokenLinkEmailsMiddleware` now
  433. ignores 404s when the referer is equal to the requested URL. To circumvent
  434. the empty referer check already implemented, some Web bots set the referer to
  435. the requested URL.
  436. Templates
  437. ^^^^^^^^^
  438. * Template tags created with the :meth:`~django.template.Library.simple_tag`
  439. helper can now store results in a template variable by using the ``as``
  440. argument.
  441. * Added a :meth:`Context.setdefault() <django.template.Context.setdefault>`
  442. method.
  443. * The :ref:`django.template <django-template-logger>` logger was added and
  444. includes the following messages:
  445. * A ``DEBUG`` level message for missing context variables.
  446. * A ``WARNING`` level message for uncaught exceptions raised
  447. during the rendering of an ``{% include %}`` when debug mode is off
  448. (helpful since ``{% include %}`` silences the exception and returns an
  449. empty string).
  450. * The :ttag:`firstof` template tag supports storing the output in a variable
  451. using 'as'.
  452. * :meth:`Context.update() <django.template.Context.update>` can now be used as
  453. a context manager.
  454. * Django template loaders can now extend templates recursively.
  455. * The debug page template postmortem now include output from each engine that
  456. is installed.
  457. * :ref:`Debug page integration <template-debug-integration>` for custom
  458. template engines was added.
  459. * The :class:`~django.template.backends.django.DjangoTemplates` backend gained
  460. the ability to register libraries and builtins explicitly through the
  461. template :setting:`OPTIONS <TEMPLATES-OPTIONS>`.
  462. * The ``timesince`` and ``timeuntil`` filters were improved to deal with leap
  463. years when given large time spans.
  464. * The ``include`` tag now caches parsed templates objects during template
  465. rendering, speeding up reuse in places such as for loops.
  466. Tests
  467. ^^^^^
  468. * Added the :meth:`json() <django.test.Response.json>` method to test client
  469. responses to give access to the response body as JSON.
  470. * Added the :meth:`~django.test.Client.force_login()` method to the test
  471. client. Use this method to simulate the effect of a user logging into the
  472. site while skipping the authentication and verification steps of
  473. :meth:`~django.test.Client.login()`.
  474. URLs
  475. ^^^^
  476. * Regular expression lookaround assertions are now allowed in URL patterns.
  477. * The application namespace can now be set using an ``app_name`` attribute
  478. on the included module or object. It can also be set by passing a 2-tuple
  479. of (<list of patterns>, <application namespace>) as the first argument to
  480. :func:`~django.conf.urls.include`.
  481. * System checks have been added for common URL pattern mistakes.
  482. Validators
  483. ^^^^^^^^^^
  484. * Added :func:`django.core.validators.int_list_validator` to generate
  485. validators of strings containing integers separated with a custom character.
  486. * :class:`~django.core.validators.EmailValidator` now limits the length of
  487. domain name labels to 63 characters per :rfc:`1034`.
  488. * Added :func:`~django.core.validators.validate_unicode_slug` to validate slugs
  489. that may contain Unicode characters.
  490. Backwards incompatible changes in 1.9
  491. =====================================
  492. .. warning::
  493. In addition to the changes outlined in this section, be sure to review the
  494. :ref:`removed-features-1.9` for the features that have reached the end of
  495. their deprecation cycle and therefore been removed. If you haven't updated
  496. your code within the deprecation timeline for a given feature, its removal
  497. may appear as a backwards incompatible change.
  498. Database backend API
  499. ~~~~~~~~~~~~~~~~~~~~
  500. * A couple of new tests rely on the ability of the backend to introspect column
  501. defaults (returning the result as ``Field.default``). You can set the
  502. ``can_introspect_default`` database feature to ``False`` if your backend
  503. doesn't implement this. You may want to review the implementation on the
  504. backends that Django includes for reference (:ticket:`24245`).
  505. * Registering a global adapter or converter at the level of the DB-API module
  506. to handle time zone information of :class:`~datetime.datetime` values passed
  507. as query parameters or returned as query results on databases that don't
  508. support time zones is discouraged. It can conflict with other libraries.
  509. The recommended way to add a time zone to :class:`~datetime.datetime` values
  510. fetched from the database is to register a converter for ``DateTimeField``
  511. in ``DatabaseOperations.get_db_converters()``.
  512. The ``needs_datetime_string_cast`` database feature was removed. Database
  513. backends that set it must register a converter instead, as explained above.
  514. * The ``DatabaseOperations.value_to_db_<type>()`` methods were renamed to
  515. ``adapt_<type>field_value()`` to mirror the ``convert_<type>field_value()``
  516. methods.
  517. * To use the new ``date`` lookup, third-party database backends may need to
  518. implement the ``DatabaseOperations.datetime_cast_date_sql()`` method.
  519. * The ``DatabaseOperations.time_extract_sql()`` method was added. It calls the
  520. existing ``date_extract_sql()`` method. This method is overridden by the
  521. SQLite backend to add time lookups (hour, minute, second) to
  522. :class:`~django.db.models.TimeField`, and may be needed by third-party
  523. database backends.
  524. * The ``DatabaseOperations.datetime_cast_sql()`` method (not to be confused
  525. with ``DatabaseOperations.datetime_cast_date_sql()`` mentioned above)
  526. has been removed. This method served to format dates on Oracle long
  527. before 1.0, but hasn't been overridden by any core backend in years
  528. and hasn't been called anywhere in Django's code or tests.
  529. * In order to support test parallelization, you must implement the
  530. ``DatabaseCreation._clone_test_db()`` method and set
  531. ``DatabaseFeatures.can_clone_databases = True``. You may have to adjust
  532. ``DatabaseCreation.get_test_db_clone_settings()``.
  533. Default settings that were tuples are now lists
  534. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  535. The default settings in ``django.conf.global_settings`` were a combination of
  536. lists and tuples. All settings that were formerly tuples are now lists.
  537. ``is_usable`` attribute on template loaders is removed
  538. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  539. Django template loaders previously required an ``is_usable`` attribute to be
  540. defined. If a loader was configured in the template settings and this attribute
  541. was ``False``, the loader would be silently ignored. In practice, this was only
  542. used by the egg loader to detect if setuptools was installed. The ``is_usable``
  543. attribute is now removed and the egg loader instead fails at runtime if
  544. setuptools is not installed.
  545. Related set direct assignment
  546. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  547. :ref:`Direct assignment <direct-assignment>` of related objects in the ORM used
  548. to perform a ``clear()`` followed by a call to ``add()``. This caused
  549. needlessly large data changes and prevented using the
  550. :data:`~django.db.models.signals.m2m_changed` signal to track individual
  551. changes in many-to-many relations.
  552. Direct assignment now relies on the the new
  553. :meth:`~django.db.models.fields.related.RelatedManager.set` method on related
  554. managers which by default only processes changes between the existing related
  555. set and the one that's newly assigned. The previous behavior can be restored by
  556. replacing direct assignment by a call to ``set()`` with the keyword argument
  557. ``clear=True``.
  558. ``ModelForm``, and therefore ``ModelAdmin``, internally rely on direct
  559. assignment for many-to-many relations and as a consequence now use the new
  560. behavior.
  561. Filesystem-based template loaders catch more specific exceptions
  562. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  563. When using the :class:`filesystem.Loader <django.template.loaders.filesystem.Loader>`
  564. or :class:`app_directories.Loader <django.template.loaders.app_directories.Loader>`
  565. template loaders, earlier versions of Django raised a
  566. :exc:`~django.template.TemplateDoesNotExist` error if a template source existed
  567. but was unreadable. This could happen under many circumstances, such as if
  568. Django didn't have permissions to open the file, or if the template source was
  569. a directory. Now, Django only silences the exception if the template source
  570. does not exist. All other situations result in the original ``IOError`` being
  571. raised.
  572. HTTP redirects no longer forced to absolute URIs
  573. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  574. Relative redirects are no longer converted to absolute URIs. :rfc:`2616`
  575. required the ``Location`` header in redirect responses to be an absolute URI,
  576. but it has been superseded by :rfc:`7231` which allows relative URIs in
  577. ``Location``, recognizing the actual practice of user agents, almost all of
  578. which support them.
  579. Consequently, the expected URLs passed to ``assertRedirects`` should generally
  580. no longer include the scheme and domain part of the URLs. For example,
  581. ``self.assertRedirects(response, 'http://testserver/some-url/')`` should be
  582. replaced by ``self.assertRedirects(response, '/some-url/')`` (unless the
  583. redirection specifically contained an absolute URL, of course).
  584. Dropped support for PostgreSQL 9.0
  585. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  586. Upstream support for PostgreSQL 9.0 ended in September 2015. As a consequence,
  587. Django 1.9 sets 9.1 as the minimum PostgreSQL version it officially supports.
  588. Dropped support for Oracle 11.1
  589. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  590. Upstream support for Oracle 11.1 ended in August 2015. As a consequence, Django
  591. 1.9 sets 11.2 as the minimum Oracle version it officially supports.
  592. Bulk behavior of ``add()`` method of related managers
  593. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  594. To improve performance, the ``add()`` methods of the related managers created
  595. by ``ForeignKey`` and ``GenericForeignKey`` changed from a series of
  596. ``Model.save()`` calls to a single ``QuerySet.update()`` call. The change means
  597. that ``pre_save`` and ``post_save`` signals aren't sent anymore. You can use
  598. the ``bulk=False`` keyword argument to revert to the previous behavior.
  599. Template ``LoaderOrigin`` and ``StringOrigin`` are removed
  600. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  601. In previous versions of Django, when a template engine was initialized with
  602. debug as ``True``, an instance of ``django.template.loader.LoaderOrigin`` or
  603. ``django.template.base.StringOrigin`` was set as the origin attribute on the
  604. template object. These classes have been combined into
  605. :class:`~django.template.base.Origin` and is now always set regardless of the
  606. engine debug setting.
  607. .. _default-logging-changes-19:
  608. Changes to the default logging configuration
  609. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  610. To make it easier to write custom logging configurations, Django's default
  611. logging configuration no longer defines 'django.request' and 'django.security'
  612. loggers. Instead, it defines a single 'django' logger with two handlers:
  613. * 'console': filtered at the ``INFO`` level and only active if ``DEBUG=True``.
  614. * 'mail_admins': filtered at the ``ERROR`` level and only active if
  615. ``DEBUG=False``.
  616. If you aren't overriding Django's default logging, you should see minimal
  617. changes in behavior, but you might see some new logging to the ``runserver``
  618. console, for example.
  619. If you are overriding Django's default logging, you should check to see how
  620. your configuration merges with the new defaults.
  621. ``HttpRequest`` details in error reporting
  622. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  623. It was redundant to display the full details of the
  624. :class:`~django.http.HttpRequest` each time it appeared as a stack frame
  625. variable in the HTML version of the debug page and error email. Thus, the HTTP
  626. request will now display the same standard representation as other variables
  627. (``repr(request)``). As a result, the method
  628. ``ExceptionReporterFilter.get_request_repr()`` was removed.
  629. The contents of the text version of the email were modified to provide a
  630. traceback of the same structure as in the case of AJAX requests. The traceback
  631. details are rendered by the ``ExceptionReporter.get_traceback_text()`` method.
  632. Removal of time zone aware global adapters and converters for datetimes
  633. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  634. Django no longer registers global adapters and converters for managing time
  635. zone information on :class:`~datetime.datetime` values sent to the database as
  636. query parameters or read from the database in query results. This change
  637. affects projects that meet all the following conditions:
  638. * The :setting:`USE_TZ` setting is ``True``.
  639. * The database is SQLite, MySQL, Oracle, or a third-party database that
  640. doesn't support time zones. In doubt, you can check the value of
  641. ``connection.features.supports_timezones``.
  642. * The code queries the database outside of the ORM, typically with
  643. ``cursor.execute(sql, params)``.
  644. If you're passing aware :class:`~datetime.datetime` parameters to such
  645. queries, you should turn them into naive datetimes in UTC::
  646. from django.utils import timezone
  647. param = timezone.make_naive(param, timezone.utc)
  648. If you fail to do so, the conversion will be performed as in earlier versions
  649. (with a deprecation warning) up until Django 1.11. Django 2.0 won't perform any
  650. conversion, which may result in data corruption.
  651. If you're reading :class:`~datetime.datetime` values from the results, they
  652. will be naive instead of aware. You can compensate as follows::
  653. from django.utils import timezone
  654. value = timezone.make_aware(value, timezone.utc)
  655. You don't need any of this if you're querying the database through the ORM,
  656. even if you're using :meth:`raw() <django.db.models.query.QuerySet.raw>`
  657. queries. The ORM takes care of managing time zone information.
  658. Template tag modules are imported when templates are configured
  659. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  660. The :class:`~django.template.backends.django.DjangoTemplates` backend now
  661. performs discovery on installed template tag modules when instantiated. This
  662. update enables libraries to be provided explicitly via the ``'libraries'``
  663. key of :setting:`OPTIONS <TEMPLATES-OPTIONS>` when defining a
  664. :class:`~django.template.backends.django.DjangoTemplates` backend. Import
  665. or syntax errors in template tag modules now fail early at instantiation time
  666. rather than when a template with a :ttag:`{% load %}<load>` tag is first
  667. compiled.
  668. ``django.template.base.add_to_builtins()`` is removed
  669. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  670. Although it was a private API, projects commonly used ``add_to_builtins()`` to
  671. make template tags and filters available without using the
  672. :ttag:`{% load %}<load>` tag. This API has been formalized. Projects should now
  673. define built-in libraries via the ``'builtins'`` key of :setting:`OPTIONS
  674. <TEMPLATES-OPTIONS>` when defining a
  675. :class:`~django.template.backends.django.DjangoTemplates` backend.
  676. .. _simple-tag-conditional-escape-fix:
  677. ``simple_tag`` now wraps tag output in ``conditional_escape``
  678. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  679. In general, template tags do not autoescape their contents, and this behavior is
  680. :ref:`documented <tags-auto-escaping>`. For tags like
  681. :class:`~django.template.Library.inclusion_tag`, this is not a problem because
  682. the included template will perform autoescaping. For
  683. :class:`~django.template.Library.assignment_tag`, the output will be escaped
  684. when it is used as a variable in the template.
  685. For the intended use cases of :class:`~django.template.Library.simple_tag`,
  686. however, it is very easy to end up with incorrect HTML and possibly an XSS
  687. exploit. For example::
  688. @register.simple_tag(takes_context=True)
  689. def greeting(context):
  690. return "Hello {0}!".format(context['request'].user.first_name)
  691. In older versions of Django, this will be an XSS issue because
  692. ``user.first_name`` is not escaped.
  693. In Django 1.9, this is fixed: if the template context has ``autoescape=True``
  694. set (the default), then ``simple_tag`` will wrap the output of the tag function
  695. with :func:`~django.utils.html.conditional_escape`.
  696. To fix your ``simple_tag``\s, it is best to apply the following practices:
  697. * Any code that generates HTML should use either the template system or
  698. :func:`~django.utils.html.format_html`.
  699. * If the output of a ``simple_tag`` needs escaping, use
  700. :func:`~django.utils.html.escape` or
  701. :func:`~django.utils.html.conditional_escape`.
  702. * If you are absolutely certain that you are outputting HTML from a trusted
  703. source (e.g. a CMS field that stores HTML entered by admins), you can mark it
  704. as such using :func:`~django.utils.safestring.mark_safe`.
  705. Tags that follow these rules will be correct and safe whether they are run on
  706. Django 1.9+ or earlier.
  707. ``Paginator.page_range``
  708. ~~~~~~~~~~~~~~~~~~~~~~~~
  709. :attr:`Paginator.page_range <django.core.paginator.Paginator.page_range>` is
  710. now an iterator instead of a list.
  711. In versions of Django previous to 1.8, ``Paginator.page_range`` returned a
  712. ``list`` in Python 2 and a ``range`` in Python 3. Django 1.8 consistently
  713. returned a list, but an iterator is more efficient.
  714. Existing code that depends on ``list`` specific features, such as indexing,
  715. can be ported by converting the iterator into a ``list`` using ``list()``.
  716. Implicit ``QuerySet`` ``__in`` lookup removed
  717. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  718. In earlier versions, queries such as::
  719. Model.objects.filter(related_id=RelatedModel.objects.all())
  720. would implicitly convert to::
  721. Model.objects.filter(related_id__in=RelatedModel.objects.all())
  722. resulting in SQL like ``"related_id IN (SELECT id FROM ...)"``.
  723. This implicit ``__in`` no longer happens so the "IN" SQL is now "=", and if the
  724. subquery returns multiple results, at least some databases will throw an error.
  725. .. _admin-browser-support-19:
  726. ``contrib.admin`` browser support
  727. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  728. The admin no longer supports Internet Explorer 8 and below, as these browsers
  729. have reached end-of-life.
  730. CSS and images to support Internet Explorer 6 and 7 have been removed. PNG and
  731. GIF icons have been replaced with SVG icons, which are not supported by
  732. Internet Explorer 8 and earlier.
  733. The jQuery library embedded in the admin has been upgraded from version 1.11.2
  734. to 2.1.4. jQuery 2.x has the same API as jQuery 1.x, but does not support
  735. Internet Explorer 6, 7, or 8, allowing for better performance and a smaller
  736. file size. If you need to support IE8 and must also use the latest version of
  737. Django, you can override the admin's copy of jQuery with your own by creating
  738. a Django application with this structure::
  739. app/static/admin/js/vendor/
  740. jquery.js
  741. jquery.min.js
  742. Miscellaneous
  743. ~~~~~~~~~~~~~
  744. * The jQuery static files in ``contrib.admin`` have been moved into a
  745. ``vendor/jquery`` subdirectory.
  746. * The text displayed for null columns in the admin changelist ``list_display``
  747. cells has changed from ``(None)`` (or its translated equivalent) to ``-`` (a
  748. dash).
  749. * ``django.http.responses.REASON_PHRASES`` and
  750. ``django.core.handlers.wsgi.STATUS_CODE_TEXT`` have been removed. Use
  751. Python's stdlib instead: :data:`http.client.responses` for Python 3 and
  752. `httplib.responses`_ for Python 2.
  753. .. _`httplib.responses`: https://docs.python.org/2/library/httplib.html#httplib.responses
  754. * ``ValuesQuerySet`` and ``ValuesListQuerySet`` have been removed.
  755. * The ``admin/base.html`` template no longer sets
  756. ``window.__admin_media_prefix__`` or ``window.__admin_utc_offset__``. Image
  757. references in JavaScript that used that value to construct absolute URLs have
  758. been moved to CSS for easier customization. The UTC offset is stored on a
  759. data attribute of the ``<body>`` tag.
  760. * ``CommaSeparatedIntegerField`` validation has been refined to forbid values
  761. like ``','``, ``',1'``, and ``'1,,2'``.
  762. * Form initialization was moved from the :meth:`ProcessFormView.get()
  763. <django.views.generic.edit.ProcessFormView.get>` method to the new
  764. :meth:`FormMixin.get_context_data()
  765. <django.views.generic.edit.FormMixin.get_context_data>` method. This may be
  766. backwards incompatible if you have overridden the ``get_context_data()``
  767. method without calling ``super()``.
  768. * Support for PostGIS 1.5 has been dropped.
  769. * The ``django.contrib.sites.models.Site.domain`` field was changed to be
  770. :attr:`~django.db.models.Field.unique`.
  771. * In order to enforce test isolation, database queries are not allowed
  772. by default in :class:`~django.test.SimpleTestCase` tests anymore. You
  773. can disable this behavior by setting the
  774. :attr:`~django.test.SimpleTestCase.allow_database_queries` class attribute
  775. to ``True`` on your test class.
  776. * :attr:`ResolverMatch.app_name
  777. <django.core.urlresolvers.ResolverMatch.app_name>` was changed to contain
  778. the full namespace path in the case of nested namespaces. For consistency
  779. with :attr:`ResolverMatch.namespace
  780. <django.core.urlresolvers.ResolverMatch.namespace>`, the empty value is now
  781. an empty string instead of ``None``.
  782. * For security hardening, session keys must be at least 8 characters.
  783. * Private function ``django.utils.functional.total_ordering()`` has been
  784. removed. It contained a workaround for a ``functools.total_ordering()`` bug
  785. in Python versions older than 2.7.3.
  786. * XML serialization (either through :djadmin:`dumpdata` or the syndication
  787. framework) used to output any characters it received. Now if the content to
  788. be serialized contains any control characters not allowed in the XML 1.0
  789. standard, the serialization will fail with a :exc:`ValueError`.
  790. * :class:`~django.forms.CharField` now strips input of leading and trailing
  791. whitespace by default. This can be disabled by setting the new
  792. :attr:`~django.forms.CharField.strip` argument to ``False``.
  793. * Template text that is translated and uses two or more consecutive percent
  794. signs, e.g. ``"%%"``, may have a new `msgid` after ``makemessages`` is run
  795. (most likely the translation will be marked fuzzy). The new ``msgid`` will be
  796. marked ``"#, python-format"``.
  797. * If neither :attr:`request.current_app <django.http.HttpRequest.current_app>`
  798. nor :class:`Context.current_app <django.template.Context>` are set, the
  799. :ttag:`url` template tag will now use the namespace of the current request.
  800. Set ``request.current_app`` to ``None`` if you don't want to use a namespace
  801. hint.
  802. * The :setting:`SILENCED_SYSTEM_CHECKS` setting now silences messages of all
  803. levels. Previously, messages of ``ERROR`` level or higher were printed to the
  804. console.
  805. * The ``FlatPage.enable_comments`` field is removed from the ``FlatPageAdmin``
  806. as it's unused by the application. If your project or a third-party app makes
  807. use of it, :ref:`create a custom ModelAdmin <flatpages-admin>` to add it back.
  808. * The return value of
  809. :meth:`~django.test.runner.DiscoverRunner.setup_databases` and the first
  810. argument of :meth:`~django.test.runner.DiscoverRunner.teardown_databases`
  811. changed. They used to be ``(old_names, mirrors)`` tuples. Now they're just
  812. the first item, ``old_names``.
  813. * By default :class:`~django.test.LiveServerTestCase` attempts to find an
  814. available port in the 8081-8179 range instead of just trying port 8081.
  815. * The system checks for :class:`~django.contrib.admin.ModelAdmin` now check
  816. instances rather than classes.
  817. * The private API to apply mixed migration plans has been dropped for
  818. performance reasons. Mixed plans consist of a list of migrations where some
  819. are being applied and others are being unapplied.
  820. .. _deprecated-features-1.9:
  821. Features deprecated in 1.9
  822. ==========================
  823. ``assignment_tag()``
  824. ~~~~~~~~~~~~~~~~~~~~
  825. Django 1.4 added the ``assignment_tag`` helper to ease the creation of
  826. template tags that store results in a template variable. The
  827. :meth:`~django.template.Library.simple_tag` helper has gained this same
  828. ability, making the ``assignment_tag`` obsolete. Tags that use
  829. ``assignment_tag`` should be updated to use ``simple_tag``.
  830. ``{% cycle %}`` syntax with comma-separated arguments
  831. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  832. The :ttag:`cycle` tag supports an inferior old syntax from previous Django
  833. versions:
  834. .. code-block:: html+django
  835. {% cycle row1,row2,row3 %}
  836. Its parsing caused bugs with the current syntax, so support for the old syntax
  837. will be removed in Django 1.10 following an accelerated deprecation.
  838. ``ForeignKey`` and ``OneToOneField`` ``on_delete`` argument
  839. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  840. In order to increase awareness about cascading model deletion, the
  841. ``on_delete`` argument of ``ForeignKey`` and ``OneToOneField`` will be required
  842. in Django 2.0.
  843. Update models and existing migrations to explicitly set the argument. Since the
  844. default is ``models.CASCADE``, add ``on_delete=models.CASCADE`` to all
  845. ``ForeignKey`` and ``OneToOneField``\s that don't use a different option. You
  846. can also pass it as the second positional argument if you don't care about
  847. compatibility with older versions of Django.
  848. ``Field.rel`` changes
  849. ~~~~~~~~~~~~~~~~~~~~~
  850. ``Field.rel`` and its methods and attributes have changed to match the related
  851. fields API. The ``Field.rel`` attribute is renamed to ``remote_field`` and many
  852. of its methods and attributes are either changed or renamed.
  853. The aim of these changes is to provide a documented API for relation fields.
  854. ``GeoManager`` and ``GeoQuerySet`` custom methods
  855. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  856. All custom ``GeoQuerySet`` methods (``area()``, ``distance()``, ``gml()``, ...)
  857. have been replaced by equivalent geographic expressions in annotations (see in
  858. new features). Hence the need to set a custom ``GeoManager`` to GIS-enabled
  859. models is now obsolete. As soon as your code doesn't call any of the deprecated
  860. methods, you can simply remove the ``objects = GeoManager()`` lines from your
  861. models.
  862. Template loader APIs have changed
  863. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  864. Django template loaders have been updated to allow recursive template
  865. extending. This change necessitated a new template loader API. The old
  866. ``load_template()`` and ``load_template_sources()`` methods are now deprecated.
  867. Details about the new API can be found :ref:`in the template loader
  868. documentation <custom-template-loaders>`.
  869. Passing a 3-tuple or an ``app_name`` to :func:`~django.conf.urls.include()`
  870. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  871. The instance namespace part of passing a tuple as the first argument has been
  872. replaced by passing the ``namespace`` argument to ``include()``. The
  873. ``app_name`` argument to ``include()`` has been replaced by passing a 2-tuple,
  874. or passing an object or module with an ``app_name`` attribute.
  875. If the ``app_name`` is set in this new way, the ``namespace`` argument is no
  876. longer required. It will default to the value of ``app_name``.
  877. This change also means that the old way of including an ``AdminSite`` instance
  878. is deprecated. Instead, pass ``admin.site.urls`` directly to
  879. :func:`~django.conf.urls.url()`:
  880. .. snippet::
  881. :filename: urls.py
  882. from django.conf.urls import url
  883. from django.contrib import admin
  884. urlpatterns = [
  885. url(r'^admin/', admin.site.urls),
  886. ]
  887. URL application namespace required if setting an instance namespace
  888. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  889. In the past, an instance namespace without an application namespace
  890. would serve the same purpose as the application namespace, but it was
  891. impossible to reverse the patterns if there was an application namespace
  892. with the same name. Includes that specify an instance namespace require that
  893. the included URLconf sets an application namespace.
  894. ``current_app`` parameter to ``contrib.auth`` views
  895. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  896. All views in ``django.contrib.auth.views`` have the following structure::
  897. def view(request, ..., current_app=None, ...):
  898. ...
  899. if current_app is not None:
  900. request.current_app = current_app
  901. return TemplateResponse(request, template_name, context)
  902. As of Django 1.8, ``current_app`` is set on the ``request`` object. For
  903. consistency, these views will require the caller to set ``current_app`` on the
  904. ``request`` instead of passing it in a separate argument.
  905. ``django.contrib.gis.geoip``
  906. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  907. The :mod:`django.contrib.gis.geoip2` module supersedes
  908. ``django.contrib.gis.geoip``. The new module provides a similar API except that
  909. it doesn't provide the legacy GeoIP-Python API compatibility methods.
  910. Miscellaneous
  911. ~~~~~~~~~~~~~
  912. * The ``weak`` argument to ``django.dispatch.signals.Signal.disconnect()`` has
  913. been deprecated as it has no effect.
  914. * The ``check_aggregate_support()`` method of
  915. ``django.db.backends.base.BaseDatabaseOperations`` has been deprecated and
  916. will be removed in Django 2.0. The more general ``check_expression_support()``
  917. should be used instead.
  918. * ``django.forms.extras`` is deprecated. You can find
  919. :class:`~django.forms.SelectDateWidget` in ``django.forms.widgets``
  920. (or simply ``django.forms``) instead.
  921. * Private API ``django.db.models.fields.add_lazy_relation()`` is deprecated.
  922. * The ``django.contrib.auth.tests.utils.skipIfCustomUser()`` decorator is
  923. deprecated. With the test discovery changes in Django 1.6, the tests for
  924. ``django.contrib`` apps are no longer run as part of the user's project.
  925. Therefore, the ``@skipIfCustomUser`` decorator is no longer needed to
  926. decorate tests in ``django.contrib.auth``.
  927. * If you customized some :ref:`error handlers <error-views>`, the view
  928. signatures with only one request parameter are deprecated. The views should
  929. now also accept a second ``exception`` positional parameter.
  930. * The ``django.utils.feedgenerator.Atom1Feed.mime_type`` and
  931. ``django.utils.feedgenerator.RssFeed.mime_type`` attributes are deprecated in
  932. favor of ``content_type``.
  933. * :class:`~django.core.signing.Signer` now issues a warning if an invalid
  934. separator is used. This will become an exception in Django 1.10.
  935. * ``django.db.models.Field._get_val_from_obj()`` is deprecated in favor of
  936. ``Field.value_from_object()``.
  937. * ``django.template.loaders.eggs.Loader`` is deprecated as distributing
  938. applications as eggs is not recommended.
  939. * The ``callable_obj`` keyword argument to
  940. ``SimpleTestCase.assertRaisesMessage()`` is deprecated. Pass the callable as
  941. a positional argument instead.
  942. * The ``allow_tags`` attribute on methods of ``ModelAdmin`` has been
  943. deprecated. Use :func:`~django.utils.html.format_html`,
  944. :func:`~django.utils.html.format_html_join`, or
  945. :func:`~django.utils.safestring.mark_safe` when constructing the method's
  946. return value instead.
  947. * The ``enclosure`` keyword argument to ``SyndicationFeed.add_item()`` is
  948. deprecated. Use the new ``enclosures`` argument which accepts a list of
  949. ``Enclosure`` objects instead of a single one.
  950. .. _removed-features-1.9:
  951. Features removed in 1.9
  952. =======================
  953. These features have reached the end of their deprecation cycle and so have been
  954. removed in Django 1.9 (please see the :ref:`deprecation timeline
  955. <deprecation-removed-in-1.9>` for more details):
  956. * ``django.utils.dictconfig`` is removed.
  957. * ``django.utils.importlib`` is removed.
  958. * ``django.utils.tzinfo`` is removed.
  959. * ``django.utils.unittest`` is removed.
  960. * The ``syncdb`` command is removed.
  961. * ``django.db.models.signals.pre_syncdb`` and
  962. ``django.db.models.signals.post_syncdb`` is removed.
  963. * Support for ``allow_syncdb`` on database routers is removed.
  964. * Automatic syncing of apps without migrations is removed. Migrations are
  965. compulsory for all apps unless you pass the :djadminopt:`--run-syncdb`
  966. option to ``migrate``.
  967. * Support for automatic loading of ``initial_data`` fixtures and initial SQL
  968. data is removed.
  969. * All models need to be defined inside an installed application or declare an
  970. explicit :attr:`~django.db.models.Options.app_label`. Furthermore, it isn't
  971. possible to import them before their application is loaded. In particular, it
  972. isn't possible to import models inside the root package of an application.
  973. * The model and form ``IPAddressField`` is removed. A stub field remains for
  974. compatibility with historical migrations.
  975. * ``AppCommand.handle_app()`` is no longer be supported.
  976. * ``RequestSite`` and ``get_current_site()`` are no longer importable from
  977. ``django.contrib.sites.models``.
  978. * FastCGI support via the ``runfcgi`` management command is removed.
  979. * ``django.utils.datastructures.SortedDict`` is removed.
  980. * ``ModelAdmin.declared_fieldsets`` is removed.
  981. * The ``util`` modules that provided backwards compatibility are removed:
  982. * ``django.contrib.admin.util``
  983. * ``django.contrib.gis.db.backends.util``
  984. * ``django.db.backends.util``
  985. * ``django.forms.util``
  986. * ``ModelAdmin.get_formsets`` is removed.
  987. * The backward compatible shims introduced to rename the
  988. ``BaseMemcachedCache._get_memcache_timeout()`` method to
  989. ``get_backend_timeout()`` is removed.
  990. * The ``--natural`` and ``-n`` options for :djadmin:`dumpdata` are removed.
  991. * The ``use_natural_keys`` argument for ``serializers.serialize()`` is removed.
  992. * Private API ``django.forms.forms.get_declared_fields()`` is removed.
  993. * The ability to use a ``SplitDateTimeWidget`` with ``DateTimeField`` is
  994. removed.
  995. * The ``WSGIRequest.REQUEST`` property is removed.
  996. * The class ``django.utils.datastructures.MergeDict`` is removed.
  997. * The ``zh-cn`` and ``zh-tw`` language codes are removed.
  998. * The internal ``django.utils.functional.memoize()`` is removed.
  999. * ``django.core.cache.get_cache`` is removed.
  1000. * ``django.db.models.loading`` is removed.
  1001. * Passing callable arguments to querysets is no longer possible.
  1002. * ``BaseCommand.requires_model_validation`` is removed in favor of
  1003. ``requires_system_checks``. Admin validators is replaced by admin checks.
  1004. * The ``ModelAdmin.validator_class`` and ``default_validator_class`` attributes
  1005. are removed.
  1006. * ``ModelAdmin.validate()`` is removed.
  1007. * ``django.db.backends.DatabaseValidation.validate_field`` is removed in
  1008. favor of the ``check_field`` method.
  1009. * The ``validate`` management command is removed.
  1010. * ``django.utils.module_loading.import_by_path`` is removed in favor of
  1011. ``django.utils.module_loading.import_string``.
  1012. * ``ssi`` and ``url`` template tags are removed from the ``future`` template
  1013. tag library.
  1014. * ``django.utils.text.javascript_quote()`` is removed.
  1015. * Database test settings as independent entries in the database settings,
  1016. prefixed by ``TEST_``, are no longer supported.
  1017. * The `cache_choices` option to :class:`~django.forms.ModelChoiceField` and
  1018. :class:`~django.forms.ModelMultipleChoiceField` is removed.
  1019. * The default value of the
  1020. :attr:`RedirectView.permanent <django.views.generic.base.RedirectView.permanent>`
  1021. attribute has changed from ``True`` to ``False``.
  1022. * ``django.contrib.sitemaps.FlatPageSitemap`` is removed in favor of
  1023. ``django.contrib.flatpages.sitemaps.FlatPageSitemap``.
  1024. * Private API ``django.test.utils.TestTemplateLoader`` is removed.
  1025. * The ``django.contrib.contenttypes.generic`` module is removed.