1.5-beta-1.txt 31 KB

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