1.5.txt 30 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682
  1. ============================================
  2. Django 1.5 release notes - UNDER DEVELOPMENT
  3. ============================================
  4. Welcome to Django 1.5!
  5. These release notes cover the `new features`_, as well
  6. as some `backwards incompatible changes`_ you'll want to be aware of
  7. when upgrading from Django 1.4 or older versions. We've also dropped some
  8. features, which are detailed in :doc:`our deprecation plan
  9. </internals/deprecation>`, and we've `begun the deprecation process for some
  10. features`_.
  11. .. _`new features`: `What's new in Django 1.5`_
  12. .. _`backwards incompatible changes`: `Backwards incompatible changes in 1.5`_
  13. .. _`begun the deprecation process for some features`: `Features deprecated in 1.5`_
  14. Overview
  15. ========
  16. The biggest new feature in Django 1.5 is the `configurable User model`_. Before
  17. Django 1.5, applications that wanted to use Django's auth framework
  18. (:mod:`django.contrib.auth`) were forced to use Django's definition of a "user".
  19. In Django 1.5, you can now swap out the ``User`` model for one that you write
  20. yourself. This could be a simple extension to the existing ``User`` model -- for
  21. example, you could add a Twitter or Facebook ID field -- or you could completely
  22. replace the ``User`` with one totally customized for your site.
  23. Django 1.5 is also the first release with `Python 3 support`_! We're labeling
  24. this support "experimental" because we don't yet consider it production-ready,
  25. but everything's in place for you to start porting your apps to Python 3.
  26. Our next release, Django 1.6, will support Python 3 without reservations.
  27. Other notable new features in Django 1.5 include:
  28. * `Support for saving a subset of model's fields`_ -
  29. :meth:`Model.save() <django.db.models.Model.save()>` now accepts an
  30. ``update_fields`` argument, letting you specify which fields are
  31. written back to the database when you call ``save()``. This can help
  32. in high-concurrency operations, and can improve performance.
  33. * Better `support for streaming responses <#explicit-streaming-responses>`_ via
  34. the new :class:`~django.http.StreamingHttpResponse` response class.
  35. * `GeoDjango`_ now supports PostGIS 2.0.
  36. * ... and more; `see below <#what-s-new-in-django-1-5>`_.
  37. Wherever possible we try to introduce new features in a backwards-compatible
  38. manner per :doc:`our API stability policy </misc/api-stability>`.
  39. However, as with previous releases, Django 1.5 ships with some minor
  40. `backwards incompatible changes`_; people upgrading from previous versions
  41. of Django should read that list carefully.
  42. One deprecated feature worth noting is the shift to "new-style" :ttag:`url` tag.
  43. Prior to Django 1.3, syntax like ``{% url myview %}`` was interpreted
  44. incorrectly (Django considered ``"myview"`` to be a literal name of a view, not
  45. a template variable named ``myview``). Django 1.3 and above introduced the
  46. ``{% load url from future %}`` syntax to bring in the corrected behavior where
  47. ``myview`` was seen as a variable.
  48. The upshot of this is that if you are not using ``{% load url from future %}``
  49. in your templates, you'll need to change tags like ``{% url myview %}`` to
  50. ``{% url "myview" %}``. If you *were* using ``{% load url from future %}`` you
  51. can simply remove that line under Django 1.5
  52. Python compatibility
  53. ====================
  54. Django 1.5 requires Python 2.6.5 or above, though we **highly recommended**
  55. Python 2.7.3 or above. Support for Python 2.5 and below as been dropped.
  56. This change should affect only a small number of Django users, as most
  57. operating-system vendors today are shipping Python 2.6 or newer as their default
  58. version. If you're still using Python 2.5, however, you'll need to stick to
  59. Django 1.4 until you can upgrade your Python version. Per :doc:`our support
  60. policy </internals/release-process>`, Django 1.4 will continue to receive
  61. security support until the release of Django 1.6.
  62. Django 1.5 does not run on a Jython final release, because Jython's latest
  63. release doesn't currently support Python 2.6. However, Jython currently does
  64. offer an alpha release featuring 2.7 support, and Django 1.5 supports that alpha
  65. release.
  66. Python 3 support
  67. ~~~~~~~~~~~~~~~~
  68. Django 1.5 introduces support for Python 3 - specifically, Python
  69. 3.2 and above. This comes in the form of a **single** codebase; you don't
  70. need to install a different version of Django on Python 3. This means that
  71. you can write application targeted for just Python 2, just Python 3, or single
  72. applications that support both platforms.
  73. However, we're labeling this support "experimental" for now: although it's
  74. received extensive testing via our automated test suite, it's received very
  75. little real-world testing. We've done our best to eliminate bugs, but we can't
  76. be sure we covered all possible uses of Django. Further, Django's more than a
  77. web framework; it's an ecosystem of pluggable components. At this point, very
  78. few third-party applications have been ported to Python 3, so it's unlikely
  79. that a real-world application will have all its dependencies satisfied under
  80. Python 3.
  81. Thus, we're recommending that Django 1.5 not be used in production under Python
  82. 3. Instead, use this opportunity to begin :doc:`porting applications to Python 3
  83. </topics/python3>`. If you're an author of a pluggable component, we encourage you
  84. to start porting now.
  85. We plan to offer first-class, production-ready support for Python 3 in our next
  86. release, Django 1.6.
  87. What's new in Django 1.5
  88. ========================
  89. Configurable User model
  90. ~~~~~~~~~~~~~~~~~~~~~~~
  91. In Django 1.5, you can now use your own model as the store for user-related
  92. data. If your project needs a username with more than 30 characters, or if
  93. you want to store user's names in a format other than first name/last name,
  94. or you want to put custom profile information onto your User object, you can
  95. now do so.
  96. If you have a third-party reusable application that references the User model,
  97. you may need to make some changes to the way you reference User instances. You
  98. should also document any specific features of the User model that your
  99. application relies upon.
  100. See the :ref:`documentation on custom User models <auth-custom-user>` for
  101. more details.
  102. Support for saving a subset of model's fields
  103. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  104. The method :meth:`Model.save() <django.db.models.Model.save()>` has a new
  105. keyword argument ``update_fields``. By using this argument it is possible to
  106. save only a select list of model's fields. This can be useful for performance
  107. reasons or when trying to avoid overwriting concurrent changes.
  108. Deferred instances (those loaded by .only() or .defer()) will automatically
  109. save just the loaded fields. If any field is set manually after load, that
  110. field will also get updated on save.
  111. See the :meth:`Model.save() <django.db.models.Model.save()>` documentation for
  112. more details.
  113. Caching of related model instances
  114. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  115. When traversing relations, the ORM will avoid re-fetching objects that were
  116. previously loaded. For example, with the tutorial's models::
  117. >>> first_poll = Poll.objects.all()[0]
  118. >>> first_choice = first_poll.choice_set.all()[0]
  119. >>> first_choice.poll is first_poll
  120. True
  121. In Django 1.5, the third line no longer triggers a new SQL query to fetch
  122. ``first_choice.poll``; it was set by the second line.
  123. For one-to-one relationships, both sides can be cached. For many-to-one
  124. relationships, only the single side of the relationship can be cached. This
  125. is particularly helpful in combination with ``prefetch_related``.
  126. .. _explicit-streaming-responses:
  127. Explicit support for streaming responses
  128. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  129. Before Django 1.5, it was possible to create a streaming response by passing
  130. an iterator to :class:`~django.http.HttpResponse`. But this was unreliable:
  131. any middleware that accessed the :attr:`~django.http.HttpResponse.content`
  132. attribute would consume the iterator prematurely.
  133. You can now explicitly generate a streaming response with the new
  134. :class:`~django.http.StreamingHttpResponse` class. This class exposes a
  135. :class:`~django.http.StreamingHttpResponse.streaming_content` attribute which
  136. is an iterator.
  137. Since :class:`~django.http.StreamingHttpResponse` does not have a ``content``
  138. attribute, middleware that needs access to the response content must test for
  139. streaming responses and behave accordingly. See :ref:`response-middleware` for
  140. more information.
  141. ``{% verbatim %}`` template tag
  142. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  143. To make it easier to deal with javascript templates which collide with Django's
  144. syntax, you can now use the :ttag:`verbatim` block tag to avoid parsing the
  145. tag's content.
  146. Retrieval of ``ContentType`` instances associated with proxy models
  147. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  148. The methods :meth:`ContentTypeManager.get_for_model() <django.contrib.contenttypes.models.ContentTypeManager.get_for_model()>`
  149. and :meth:`ContentTypeManager.get_for_models() <django.contrib.contenttypes.models.ContentTypeManager.get_for_models()>`
  150. have a new keyword argument – respectively ``for_concrete_model`` and ``for_concrete_models``.
  151. By passing ``False`` using this argument it is now possible to retrieve the
  152. :class:`ContentType <django.contrib.contenttypes.models.ContentType>`
  153. associated with proxy models.
  154. New ``view`` variable in class-based views context
  155. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  156. In all :doc:`generic class-based views </topics/class-based-views/index>`
  157. (or any class-based view inheriting from ``ContextMixin``), the context dictionary
  158. contains a ``view`` variable that points to the ``View`` instance.
  159. GeoDjango
  160. ~~~~~~~~~
  161. * :class:`~django.contrib.gis.geos.LineString` and
  162. :class:`~django.contrib.gis.geos.MultiLineString` GEOS objects now support the
  163. :meth:`~django.contrib.gis.geos.GEOSGeometry.interpolate()` and
  164. :meth:`~django.contrib.gis.geos.GEOSGeometry.project()` methods
  165. (so-called linear referencing).
  166. * The wkb and hex properties of `GEOSGeometry` objects preserve the Z dimension.
  167. * Support for PostGIS 2.0 has been added and support for GDAL < 1.5 has been
  168. dropped.
  169. Minor features
  170. ~~~~~~~~~~~~~~
  171. Django 1.5 also includes several smaller improvements worth noting:
  172. * The template engine now interprets ``True``, ``False`` and ``None`` as the
  173. corresponding Python objects.
  174. * :mod:`django.utils.timezone` provides a helper for converting aware
  175. datetimes between time zones. See :func:`~django.utils.timezone.localtime`.
  176. * The generic views support OPTIONS requests.
  177. * Management commands do not raise ``SystemExit`` any more when called by code
  178. from :ref:`call_command <call-command>`. Any exception raised by the command
  179. (mostly :ref:`CommandError <ref-command-exceptions>`) is propagated.
  180. * The dumpdata management command outputs one row at a time, preventing
  181. out-of-memory errors when dumping large datasets.
  182. * In the localflavor for Canada, "pq" was added to the acceptable codes for
  183. Quebec. It's an old abbreviation.
  184. * The :ref:`receiver <connecting-receiver-functions>` decorator is now able to
  185. connect to more than one signal by supplying a list of signals.
  186. * In the admin, you can now filter users by groups which they are members of.
  187. * :meth:`QuerySet.bulk_create()
  188. <django.db.models.query.QuerySet.bulk_create>` now has a batch_size
  189. argument. By default the batch_size is unlimited except for SQLite where
  190. single batch is limited so that 999 parameters per query isn't exceeded.
  191. * The :setting:`LOGIN_URL` and :setting:`LOGIN_REDIRECT_URL` settings now also
  192. accept view function names and
  193. :ref:`named URL patterns <naming-url-patterns>`. This allows you to reduce
  194. configuration duplication. More information can be found in the
  195. :func:`~django.contrib.auth.decorators.login_required` documentation.
  196. * Django now provides a mod_wsgi :doc:`auth handler
  197. </howto/deployment/wsgi/apache-auth>`.
  198. * The :meth:`QuerySet.delete() <django.db.models.query.QuerySet.delete>`
  199. and :meth:`Model.delete() <django.db.models.Model.delete()>` can now take
  200. fast-path in some cases. The fast-path allows for less queries and less
  201. objects fetched into memory. See :meth:`QuerySet.delete()
  202. <django.db.models.query.QuerySet.delete>` for details.
  203. * An instance of :class:`~django.core.urlresolvers.ResolverMatch` is stored on
  204. the request as ``resolver_match``.
  205. * By default, all logging messages reaching the `django` logger when
  206. :setting:`DEBUG` is `True` are sent to the console (unless you redefine the
  207. logger in your :setting:`LOGGING` setting).
  208. * When using :class:`~django.template.RequestContext`, it is now possible to
  209. look up permissions by using ``{% if 'someapp.someperm' in perms %}``
  210. in templates.
  211. * It's not required any more to have ``404.html`` and ``500.html`` templates in
  212. the root templates directory. Django will output some basic error messages for
  213. both situations when those templates are not found. Of course, it's still
  214. recommended as good practice to provide those templates in order to present
  215. pretty error pages to the user.
  216. * :mod:`django.contrib.auth` provides a new signal that is emitted
  217. whenever a user fails to login successfully. See
  218. :data:`~django.contrib.auth.signals.user_login_failed`
  219. * The loaddata management command now supports an `ignorenonexistent` option to
  220. ignore data for fields that no longer exist.
  221. * :meth:`~django.test.SimpleTestCase.assertXMLEqual` and
  222. :meth:`~django.test.SimpleTestCase.assertXMLNotEqual` new assertions allow
  223. you to test equality for XML content at a semantic level, without caring for
  224. syntax differences (spaces, attribute order, etc.).
  225. * RemoteUserMiddleware now forces logout when the REMOTE_USER header
  226. disappears during the same browser session.
  227. * The :ref:`cache-based session backend <cached-sessions-backend>` can store
  228. session data in a non-default cache.
  229. * Multi-column indexes can now be created on models. Read the
  230. :attr:`~django.db.models.Options.index_together` documentation for more
  231. information.
  232. * During Django's logging configuration verbose Deprecation warnings are
  233. enabled and warnings are captured into the logging system. Logged warnings
  234. are routed through the ``console`` logging handler, which by default requires
  235. :setting:`DEBUG` to be True for output to be generated. The result is that
  236. DeprecationWarnings should be printed to the console in development
  237. environments the way they have been in Python versions < 2.7.
  238. * The API for :meth:`django.contrib.admin.ModelAdmin.message_user` method has
  239. been modified to accept additional arguments adding capabilities similar to
  240. :func:`django.contrib.messages.add_message`. This is useful for generating
  241. error messages from admin actions.
  242. Backwards incompatible changes in 1.5
  243. =====================================
  244. .. warning::
  245. In addition to the changes outlined in this section, be sure to review the
  246. :doc:`deprecation plan </internals/deprecation>` for any features that
  247. have been removed. If you haven't updated your code within the
  248. deprecation timeline for a given feature, its removal may appear as a
  249. backwards incompatible change.
  250. Context in year archive class-based views
  251. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  252. For consistency with the other date-based generic views,
  253. :class:`~django.views.generic.dates.YearArchiveView` now passes ``year`` in
  254. the context as a :class:`datetime.date` rather than a string. If you are
  255. using ``{{ year }}`` in your templates, you must replace it with ``{{
  256. year|date:"Y" }}``.
  257. ``next_year`` and ``previous_year`` were also added in the context. They are
  258. calculated according to ``allow_empty`` and ``allow_future``.
  259. Context in year and month archive class-based views
  260. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  261. :class:`~django.views.generic.dates.YearArchiveView` and
  262. :class:`~django.views.generic.dates.MonthArchiveView` were documented to
  263. provide a ``date_list`` sorted in ascending order in the context, like their
  264. function-based predecessors, but it actually was in descending order. In 1.5,
  265. the documented order was restored. You may want to add (or remove) the
  266. ``reversed`` keyword when you're iterating on ``date_list`` in a template::
  267. {% for date in date_list reversed %}
  268. :class:`~django.views.generic.dates.ArchiveIndexView` still provides a
  269. ``date_list`` in descending order.
  270. Context in TemplateView
  271. ~~~~~~~~~~~~~~~~~~~~~~~
  272. For consistency with the design of the other generic views,
  273. :class:`~django.views.generic.base.TemplateView` no longer passes a ``params``
  274. dictionary into the context, instead passing the variables from the URLconf
  275. directly into the context.
  276. Non-form data in HTTP requests
  277. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  278. :attr:`request.POST <django.http.HttpRequest.POST>` will no longer include data
  279. posted via HTTP requests with non form-specific content-types in the header.
  280. In prior versions, data posted with content-types other than
  281. ``multipart/form-data`` or ``application/x-www-form-urlencoded`` would still
  282. end up represented in the :attr:`request.POST <django.http.HttpRequest.POST>`
  283. attribute. Developers wishing to access the raw POST data for these cases,
  284. should use the :attr:`request.body <django.http.HttpRequest.body>` attribute
  285. instead.
  286. OPTIONS, PUT and DELETE requests in the test client
  287. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  288. Unlike GET and POST, these HTTP methods aren't implemented by web browsers.
  289. Rather, they're used in APIs, which transfer data in various formats such as
  290. JSON or XML. Since such requests may contain arbitrary data, Django doesn't
  291. attempt to decode their body.
  292. However, the test client used to build a query string for OPTIONS and DELETE
  293. requests like for GET, and a request body for PUT requests like for POST. This
  294. encoding was arbitrary and inconsistent with Django's behavior when it
  295. receives the requests, so it was removed in Django 1.5.
  296. If you were using the ``data`` parameter in an OPTIONS or a DELETE request,
  297. you must convert it to a query string and append it to the ``path`` parameter.
  298. If you were using the ``data`` parameter in a PUT request without a
  299. ``content_type``, you must encode your data before passing it to the test
  300. client and set the ``content_type`` argument.
  301. .. _simplejson-incompatibilities:
  302. System version of :mod:`simplejson` no longer used
  303. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  304. :ref:`As explained below <simplejson-deprecation>`, Django 1.5 deprecates
  305. :mod:`django.utils.simplejson` in favor of Python 2.6's built-in :mod:`json`
  306. module. In theory, this change is harmless. Unfortunately, because of
  307. incompatibilities between versions of :mod:`simplejson`, it may trigger errors
  308. in some circumstances.
  309. JSON-related features in Django 1.4 always used :mod:`django.utils.simplejson`.
  310. This module was actually:
  311. - A system version of :mod:`simplejson`, if one was available (ie. ``import
  312. simplejson`` works), if it was more recent than Django's built-in copy or it
  313. had the C speedups, or
  314. - The :mod:`json` module from the standard library, if it was available (ie.
  315. Python 2.6 or greater), or
  316. - A built-in copy of version 2.0.7 of :mod:`simplejson`.
  317. In Django 1.5, those features use Python's :mod:`json` module, which is based
  318. on version 2.0.9 of :mod:`simplejson`.
  319. There are no known incompatibilities between Django's copy of version 2.0.7 and
  320. Python's copy of version 2.0.9. However, there are some incompatibilities
  321. between other versions of :mod:`simplejson`:
  322. - While the :mod:`simplejson` API is documented as always returning unicode
  323. strings, the optional C implementation can return a byte string. This was
  324. fixed in Python 2.7.
  325. - :class:`simplejson.JSONEncoder` gained a ``namedtuple_as_object`` keyword
  326. argument in version 2.2.
  327. More information on these incompatibilities is available in `ticket #18023`_.
  328. The net result is that, if you have installed :mod:`simplejson` and your code
  329. uses Django's serialization internals directly -- for instance
  330. :class:`django.core.serializers.json.DjangoJSONEncoder`, the switch from
  331. :mod:`simplejson` to :mod:`json` could break your code. (In general, changes to
  332. internals aren't documented; we're making an exception here.)
  333. At this point, the maintainers of Django believe that using :mod:`json` from
  334. the standard library offers the strongest guarantee of backwards-compatibility.
  335. They recommend to use it from now on.
  336. .. _ticket #18023: https://code.djangoproject.com/ticket/18023#comment:10
  337. String types of hasher method parameters
  338. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  339. If you have written a :ref:`custom password hasher <auth_password_storage>`,
  340. your ``encode()``, ``verify()`` or ``safe_summary()`` methods should accept
  341. Unicode parameters (``password``, ``salt`` or ``encoded``). If any of the
  342. hashing methods need byte strings, you can use the
  343. :func:`~django.utils.encoding.force_bytes` utility to encode the strings.
  344. Validation of previous_page_number and next_page_number
  345. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  346. When using :doc:`object pagination </topics/pagination>`,
  347. the ``previous_page_number()`` and ``next_page_number()`` methods of the
  348. :class:`~django.core.paginator.Page` object did not check if the returned
  349. number was inside the existing page range.
  350. It does check it now and raises an :exc:`InvalidPage` exception when the number
  351. is either too low or too high.
  352. Behavior of autocommit database option on PostgreSQL changed
  353. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  354. PostgreSQL's autocommit option didn't work as advertised previously. It did
  355. work for single transaction block, but after the first block was left the
  356. autocommit behavior was never restored. This bug is now fixed in 1.5. While
  357. this is only a bug fix, it is worth checking your applications behavior if
  358. you are using PostgreSQL together with the autocommit option.
  359. Session not saved on 500 responses
  360. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  361. Django's session middleware will skip saving the session data if the
  362. response's status code is 500.
  363. Email checks on failed admin login
  364. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  365. Prior to Django 1.5, if you attempted to log into the admin interface and
  366. mistakenly used your email address instead of your username, the admin
  367. interface would provide a warning advising that your email address was
  368. not your username. In Django 1.5, the introduction of
  369. :ref:`custom User models <auth-custom-user>` has required the removal of this
  370. warning. This doesn't change the login behavior of the admin site; it only
  371. affects the warning message that is displayed under one particular mode of
  372. login failure.
  373. Changes in tests execution
  374. ~~~~~~~~~~~~~~~~~~~~~~~~~~
  375. Some changes have been introduced in the execution of tests that might be
  376. backward-incompatible for some testing setups:
  377. Database flushing in ``django.test.TransactionTestCase``
  378. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  379. Previously, the test database was truncated *before* each test run in a
  380. :class:`~django.test.TransactionTestCase`.
  381. In order to be able to run unit tests in any order and to make sure they are
  382. always isolated from each other, :class:`~django.test.TransactionTestCase` will
  383. now reset the database *after* each test run instead.
  384. No more implicit DB sequences reset
  385. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  386. :class:`~django.test.TransactionTestCase` tests used to reset primary key
  387. sequences automatically together with the database flushing actions described
  388. above.
  389. This has been changed so no sequences are implicitly reset. This can cause
  390. :class:`~django.test.TransactionTestCase` tests that depend on hard-coded
  391. primary key values to break.
  392. The new :attr:`~django.test.TransactionTestCase.reset_sequences` attribute can
  393. be used to force the old behavior for :class:`~django.test.TransactionTestCase`
  394. that might need it.
  395. Ordering of tests
  396. ^^^^^^^^^^^^^^^^^
  397. In order to make sure all ``TestCase`` code starts with a clean database,
  398. tests are now executed in the following order:
  399. * First, all unittests (including :class:`unittest.TestCase`,
  400. :class:`~django.test.SimpleTestCase`, :class:`~django.test.TestCase` and
  401. :class:`~django.test.TransactionTestCase`) are run with no particular ordering
  402. guaranteed nor enforced among them.
  403. * Then any other tests (e.g. doctests) that may alter the database without
  404. restoring it to its original state are run.
  405. This should not cause any problems unless you have existing doctests which
  406. assume a :class:`~django.test.TransactionTestCase` executed earlier left some
  407. database state behind or unit tests that rely on some form of state being
  408. preserved after the execution of other tests. Such tests are already very
  409. fragile, and must now be changed to be able to run independently.
  410. `cleaned_data` dictionary kept for invalid forms
  411. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  412. The :attr:`~django.forms.Form.cleaned_data` dictionary is now always present
  413. after form validation. When the form doesn't validate, it contains only the
  414. fields that passed validation. You should test the success of the validation
  415. with the :meth:`~django.forms.Form.is_valid()` method and not with the
  416. presence or absence of the :attr:`~django.forms.Form.cleaned_data` attribute
  417. on the form.
  418. Behavior of :djadmin:`syncdb` with multiple databases
  419. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  420. :djadmin:`syncdb` now queries the database routers to determine if content
  421. types (when :mod:`~django.contrib.contenttypes` is enabled) and permissions
  422. (when :mod:`~django.contrib.auth` is enabled) should be created in the target
  423. database. Previously, it created them in the default database, even when
  424. another database was specified with the :djadminopt:`--database` option.
  425. If you use :djadmin:`syncdb` on multiple databases, you should ensure that
  426. your routers allow synchronizing content types and permissions to only one of
  427. them. See the docs on the :ref:`behavior of contrib apps with multiple
  428. databases <contrib_app_multiple_databases>` for more information.
  429. Miscellaneous
  430. ~~~~~~~~~~~~~
  431. * :class:`django.forms.ModelMultipleChoiceField` now returns an empty
  432. ``QuerySet`` as the empty value instead of an empty list.
  433. * :func:`~django.utils.http.int_to_base36` properly raises a :exc:`TypeError`
  434. instead of :exc:`ValueError` for non-integer inputs.
  435. * The ``slugify`` template filter is now available as a standard python
  436. function at :func:`django.utils.text.slugify`. Similarly, ``remove_tags`` is
  437. available at :func:`django.utils.html.remove_tags`.
  438. * Uploaded files are no longer created as executable by default. If you need
  439. them to be executable change :setting:`FILE_UPLOAD_PERMISSIONS` to your
  440. needs. The new default value is `0666` (octal) and the current umask value
  441. is first masked out.
  442. * The :ref:`F() expressions <query-expressions>` supported bitwise operators by
  443. ``&`` and ``|``. These operators are now available using ``.bitand()`` and
  444. ``.bitor()`` instead. The removal of ``&`` and ``|`` was done to be consistent with
  445. :ref:`Q() expressions <complex-lookups-with-q>` and ``QuerySet`` combining where
  446. the operators are used as boolean AND and OR operators.
  447. * The :ttag:`csrf_token` template tag is no longer enclosed in a div. If you need
  448. HTML validation against pre-HTML5 Strict DTDs, you should add a div around it
  449. in your pages.
  450. * The template tags library ``adminmedia``, which only contained the
  451. deprecated template tag ``{% admin_media_prefix %}``, was removed.
  452. Attempting to load it with ``{% load adminmedia %}`` will fail. If your
  453. templates still contain that line you must remove it.
  454. Features deprecated in 1.5
  455. ==========================
  456. .. _simplejson-deprecation:
  457. :setting:`AUTH_PROFILE_MODULE`
  458. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  459. With the introduction of :ref:`custom User models <auth-custom-user>`, there is
  460. no longer any need for a built-in mechanism to store user profile data.
  461. You can still define user profiles models that have a one-to-one relation with
  462. the User model - in fact, for many applications needing to associate data with
  463. a User account, this will be an appropriate design pattern to follow. However,
  464. the :setting:`AUTH_PROFILE_MODULE` setting, and the
  465. :meth:`~django.contrib.auth.models.User.get_profile()` method for accessing
  466. the user profile model, should not be used any longer.
  467. Streaming behavior of :class:`HttpResponse`
  468. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  469. Django 1.5 deprecates the ability to stream a response by passing an iterator
  470. to :class:`~django.http.HttpResponse`. If you rely on this behavior, switch to
  471. :class:`~django.http.StreamingHttpResponse`. See
  472. :ref:`explicit-streaming-responses` above.
  473. In Django 1.7 and above, the iterator will be consumed immediately by
  474. :class:`~django.http.HttpResponse`.
  475. ``django.utils.simplejson``
  476. ~~~~~~~~~~~~~~~~~~~~~~~~~~~
  477. Since Django 1.5 drops support for Python 2.5, we can now rely on the
  478. :mod:`json` module being available in Python's standard library, so we've
  479. removed our own copy of :mod:`simplejson`. You should now import :mod:`json`
  480. instead :mod:`django.utils.simplejson`.
  481. Unfortunately, this change might have unwanted side-effects, because of
  482. incompatibilities between versions of :mod:`simplejson` -- see the
  483. :ref:`backwards-incompatible changes <simplejson-incompatibilities>` section.
  484. If you rely on features added to :mod:`simplejson` after it became Python's
  485. :mod:`json`, you should import :mod:`simplejson` explicitly.
  486. ``django.utils.encoding.StrAndUnicode``
  487. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  488. The :class:`~django.utils.encoding.StrAndUnicode` mix-in has been deprecated.
  489. Define a ``__str__`` method and apply the
  490. :func:`~django.utils.encoding.python_2_unicode_compatible` decorator instead.
  491. ``django.utils.itercompat.product``
  492. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  493. The :func:`~django.utils.itercompat.product` function has been deprecated. Use
  494. the built-in :func:`itertools.product` instead.
  495. ``django.utils.markup``
  496. ~~~~~~~~~~~~~~~~~~~~~~~
  497. The markup contrib module has been deprecated and will follow an accelerated
  498. deprecation schedule. Direct use of python markup libraries or 3rd party tag
  499. libraries is preferred to Django maintaining this functionality in the
  500. framework.
  501. ``cleanup`` management command
  502. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  503. The :djadmin:`cleanup` management command has been deprecated and replaced by
  504. :djadmin:`clearsessions`.
  505. ``daily_cleanup.py`` script
  506. ~~~~~~~~~~~~~~~~~~~~~~~~~~~
  507. The undocumented ``daily_cleanup.py`` script has been deprecated. Use the
  508. :djadmin:`clearsessions` management command instead.
  509. ``depth`` keyword argument in ``select_related``
  510. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  511. The ``depth`` keyword argument in
  512. :meth:`~django.db.models.query.QuerySet.select_related` has been deprecated.
  513. You should use field names instead.