1.7.txt 68 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541
  1. ============================================
  2. Django 1.7 release notes - UNDER DEVELOPMENT
  3. ============================================
  4. Welcome to Django 1.7!
  5. These release notes cover the `new features`_, as well as some `backwards
  6. incompatible changes`_ you'll want to be aware of when upgrading from Django
  7. 1.6 or older versions. We've also dropped some features, which are detailed in
  8. :ref:`our deprecation plan <deprecation-removed-in-1.7>`, and we've `begun the
  9. deprecation process for some features`_.
  10. .. _`new features`: `What's new in Django 1.7`_
  11. .. _`backwards incompatible changes`: `Backwards incompatible changes in 1.7`_
  12. .. _`begun the deprecation process for some features`: `Features deprecated in 1.7`_
  13. Python compatibility
  14. ====================
  15. Django 1.7 requires Python 2.7 or above, though we **highly recommend**
  16. the latest minor release. Support for Python 2.6 has been dropped and support
  17. for Python 3.4 has been added.
  18. This change should affect only a small number of Django users, as most
  19. operating-system vendors today are shipping Python 2.7 or newer as their default
  20. version. If you're still using Python 2.6, however, you'll need to stick to
  21. Django 1.6 until you can upgrade your Python version. Per :doc:`our support
  22. policy </internals/release-process>`, Django 1.6 will continue to receive
  23. security support until the release of Django 1.8.
  24. What's new in Django 1.7
  25. ========================
  26. Schema migrations
  27. ~~~~~~~~~~~~~~~~~
  28. Django now has built-in support for schema migrations. It allows models
  29. to be updated, changed, and deleted by creating migration files that represent
  30. the model changes and which can be run on any development, staging or production
  31. database.
  32. Migrations are covered in :doc:`their own documentation</topics/migrations>`,
  33. but a few of the key features are:
  34. * ``syncdb`` has been deprecated and replaced by ``migrate``. Don't worry -
  35. calls to ``syncdb`` will still work as before.
  36. * A new ``makemigrations`` command provides an easy way to autodetect changes
  37. to your models and make migrations for them.
  38. :data:`~django.db.models.signals.pre_syncdb` and
  39. :data:`~django.db.models.signals.post_syncdb` have been replaced by
  40. :data:`~django.db.models.signals.pre_migrate` and
  41. :data:`~django.db.models.signals.post_migrate` respectively. These new
  42. signals have slightly different arguments. Check the documentation for
  43. details.
  44. * The ``allow_syncdb`` method on database routers is now called ``allow_migrate``,
  45. but still performs the same function. Routers with ``allow_syncdb`` methods
  46. will still work, but that method name is deprecated and you should change
  47. it as soon as possible (nothing more than renaming is required).
  48. * ``initial_data`` fixtures are no longer loaded for apps with migrations; if
  49. you want to load initial data for an app, we suggest you do it in a migration.
  50. App-loading refactor
  51. ~~~~~~~~~~~~~~~~~~~~
  52. Historically, Django applications were tightly linked to models. A singleton
  53. known as the "app cache" dealt with both installed applications and models.
  54. The models module was used as an identifier for applications in many APIs.
  55. As the concept of :doc:`Django applications </ref/applications>` matured, this
  56. code showed some shortcomings. It has been refactored into an "app registry"
  57. where models modules no longer have a central role and where it's possible to
  58. attach configuration data to applications.
  59. Improvements thus far include:
  60. * Applications can run code at startup, before Django does anything else, with
  61. the :meth:`~django.apps.AppConfig.ready` method of their configuration.
  62. * Application labels are assigned correctly to models even when they're
  63. defined outside of ``models.py``. You don't have to set
  64. :attr:`~django.db.models.Options.app_label` explicitly any more.
  65. * It is possible to omit ``models.py`` entirely if an application doesn't
  66. have any models.
  67. * Applications can be relabeled with the :attr:`~django.apps.AppConfig.label`
  68. attribute of application configurations, to work around label conflicts.
  69. * The name of applications can be customized in the admin with the
  70. :attr:`~django.apps.AppConfig.verbose_name` of application configurations.
  71. * The admin automatically calls :func:`~django.contrib.admin.autodiscover()`
  72. when Django starts. You can consequently remove this line from your
  73. URLconf.
  74. * Django imports all application configurations and models as soon as it
  75. starts, through a deterministic and straightforward process. This should
  76. make it easier to diagnose import issues such as import loops.
  77. New method on Field subclasses
  78. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  79. To help power both schema migrations and composite keys, the :class:`~django.db.models.Field` API now
  80. has a new required method: ``deconstruct()``.
  81. This method takes no arguments, and returns a tuple of four items:
  82. * ``name``: The field's attribute name on its parent model, or None if it is not part of a model
  83. * ``path``: A dotted, Python path to the class of this field, including the class name.
  84. * ``args``: Positional arguments, as a list
  85. * ``kwargs``: Keyword arguments, as a dict
  86. These four values allow any field to be serialized into a file, as well as
  87. allowing the field to be copied safely, both essential parts of these new features.
  88. This change should not affect you unless you write custom Field subclasses;
  89. if you do, you may need to reimplement the ``deconstruct()`` method if your
  90. subclass changes the method signature of ``__init__`` in any way. If your
  91. field just inherits from a built-in Django field and doesn't override ``__init__``,
  92. no changes are necessary.
  93. If you do need to override ``deconstruct()``, a good place to start is the
  94. built-in Django fields (``django/db/models/fields/__init__.py``) as several
  95. fields, including ``DecimalField`` and ``DateField``, override it and show how
  96. to call the method on the superclass and simply add or remove extra arguments.
  97. This also means that all arguments to fields must themselves be serializable;
  98. to see what we consider serializable, and to find out how to make your own
  99. classes serializable, read the
  100. :ref:`migration serialization documentation <migration-serializing>`.
  101. Calling custom ``QuerySet`` methods from the ``Manager``
  102. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  103. Historically, the recommended way to make reusable model queries was to create
  104. methods on a custom ``Manager`` class. The problem with this approach was that
  105. after the first method call, you'd get back a ``QuerySet`` instance and
  106. couldn't call additional custom manager methods.
  107. Though not documented, it was common to work around this issue by creating a
  108. custom ``QuerySet`` so that custom methods could be chained; but the solution
  109. had a number of drawbacks:
  110. * The custom ``QuerySet`` and its custom methods were lost after the first
  111. call to ``values()`` or ``values_list()``.
  112. * Writing a custom ``Manager`` was still necessary to return the custom
  113. ``QuerySet`` class and all methods that were desired on the ``Manager``
  114. had to be proxied to the ``QuerySet``. The whole process went against
  115. the DRY principle.
  116. The :meth:`QuerySet.as_manager() <django.db.models.query.QuerySet.as_manager>`
  117. class method can now directly :ref:`create Manager with QuerySet methods
  118. <create-manager-with-queryset-methods>`::
  119. class FoodQuerySet(models.QuerySet):
  120. def pizzas(self):
  121. return self.filter(kind='pizza')
  122. def vegetarian(self):
  123. return self.filter(vegetarian=True)
  124. class Food(models.Model):
  125. kind = models.CharField(max_length=50)
  126. vegetarian = models.BooleanField()
  127. objects = FoodQuerySet.as_manager()
  128. Food.objects.pizzas().vegetarian()
  129. Using a custom manager when traversing reverse relations
  130. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  131. It is now possible to :ref:`specify a custom manager
  132. <using-custom-reverse-manager>` when traversing a reverse relationship::
  133. class Blog(models.Model):
  134. pass
  135. class Entry(models.Model):
  136. blog = models.ForeignKey(Blog)
  137. objects = models.Manager() # Default Manager
  138. entries = EntryManager() # Custom Manager
  139. b = Blog.objects.get(id=1)
  140. b.entry_set(manager='entries').all()
  141. New system check framework
  142. ~~~~~~~~~~~~~~~~~~~~~~~~~~
  143. We've added a new :doc:`System check framework </ref/checks>` for
  144. detecting common problems (like invalid models) and providing hints for
  145. resolving those problems. The framework is extensible so you can add your
  146. own checks for your own apps and libraries.
  147. To perform system checks, you use the :djadmin:`check` management command.
  148. This command replaces the older :djadmin:`validate` management command.
  149. New ``Prefetch`` object for advanced ``prefetch_related`` operations.
  150. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  151. The new :class:`~django.db.models.Prefetch` object allows customizing
  152. prefetch operations.
  153. You can specify the ``QuerySet`` used to traverse a given relation
  154. or customize the storage location of prefetch results.
  155. This enables things like filtering prefetched relations, calling
  156. :meth:`~django.db.models.query.QuerySet.select_related()` from a prefetched
  157. relation, or prefetching the same relation multiple times with different
  158. querysets. See :meth:`~django.db.models.query.QuerySet.prefetch_related()`
  159. for more details.
  160. Admin shortcuts support time zones
  161. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  162. The "today" and "now" shortcuts next to date and time input widgets in the
  163. admin are now operating in the :ref:`current time zone
  164. <default-current-time-zone>`. Previously, they used the browser time zone,
  165. which could result in saving the wrong value when it didn't match the current
  166. time zone on the server.
  167. In addition, the widgets now display a help message when the browser and
  168. server time zone are different, to clarify how the value inserted in the field
  169. will be interpreted.
  170. Using database cursors as context managers
  171. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  172. Prior to Python 2.7, database cursors could be used as a context manager. The
  173. specific backend's cursor defined the behavior of the context manager. The
  174. behavior of magic method lookups was changed with Python 2.7 and cursors were
  175. no longer usable as context managers.
  176. Django 1.7 allows a cursor to be used as a context manager that is a shortcut
  177. for the following, instead of backend specific behavior.
  178. .. code-block:: python
  179. c = connection.cursor()
  180. try:
  181. c.execute(...)
  182. finally:
  183. c.close()
  184. Custom lookups
  185. ~~~~~~~~~~~~~~
  186. It is now possible to write custom lookups and transforms for the ORM.
  187. Custom lookups work just like Django's inbuilt lookups (e.g. ``lte``,
  188. ``icontains``) while transforms are a new concept.
  189. The :class:`django.db.models.Lookup` class provides a way to add lookup
  190. operators for model fields. As an example it is possible to add ``day_lte``
  191. operator for ``DateFields``.
  192. The :class:`django.db.models.Transform` class allows transformations of
  193. database values prior to the final lookup. For example it is possible to
  194. write a ``year`` transform that extracts year from the field's value.
  195. Transforms allow for chaining. After the ``year`` transform has been added
  196. to ``DateField`` it is possible to filter on the transformed value, for
  197. example ``qs.filter(author__birthdate__year__lte=1981)``.
  198. For more information about both custom lookups and transforms refer to
  199. :doc:`custom lookups </ref/models/custom-lookups>` documentation.
  200. Minor features
  201. ~~~~~~~~~~~~~~
  202. :mod:`django.contrib.admin`
  203. ^^^^^^^^^^^^^^^^^^^^^^^^^^^
  204. * You can now implement :attr:`~django.contrib.admin.AdminSite.site_header`,
  205. :attr:`~django.contrib.admin.AdminSite.site_title`, and
  206. :attr:`~django.contrib.admin.AdminSite.index_title` attributes on a custom
  207. :class:`~django.contrib.admin.AdminSite` in order to easily change the admin
  208. site's page title and header text. No more needing to override templates!
  209. * Buttons in :mod:`django.contrib.admin` now use the ``border-radius`` CSS
  210. property for rounded corners rather than GIF background images.
  211. * Some admin templates now have ``app-<app_name>`` and ``model-<model_name>``
  212. classes in their ``<body>`` tag to allow customizing the CSS per app or per
  213. model.
  214. * The admin changelist cells now have a ``field-<field_name>`` class in the
  215. HTML to enable style customizations.
  216. * The admin's search fields can now be customized per-request thanks to the new
  217. :meth:`django.contrib.admin.ModelAdmin.get_search_fields` method.
  218. * The :meth:`ModelAdmin.get_fields()
  219. <django.contrib.admin.ModelAdmin.get_fields>` method may be overridden to
  220. customize the value of :attr:`ModelAdmin.fields
  221. <django.contrib.admin.ModelAdmin.fields>`.
  222. * In addition to the existing ``admin.site.register`` syntax, you can use the
  223. new :func:`~django.contrib.admin.register` decorator to register a
  224. :class:`~django.contrib.admin.ModelAdmin`.
  225. * You may specify :meth:`ModelAdmin.list_display_links
  226. <django.contrib.admin.ModelAdmin.list_display_links>` ``= None`` to disable
  227. links on the change list page grid.
  228. * You may now specify :attr:`ModelAdmin.view_on_site
  229. <django.contrib.admin.ModelAdmin.view_on_site>` to control whether or not to
  230. display the "View on site" link.
  231. * You can specify a descending ordering for a :attr:`ModelAdmin.list_display
  232. <django.contrib.admin.ModelAdmin.list_display>` value by prefixing the
  233. ``admin_order_field`` value with a hyphen.
  234. * The :meth:`ModelAdmin.get_changeform_initial_data()
  235. <django.contrib.admin.ModelAdmin.get_changeform_initial_data>` method may be
  236. overridden to define custom behavior for setting initial change form data.
  237. :mod:`django.contrib.auth`
  238. ^^^^^^^^^^^^^^^^^^^^^^^^^^
  239. * Any ``**kwargs`` passed to
  240. :meth:`~django.contrib.auth.models.User.email_user()` are passed to the
  241. underlying :meth:`~django.core.mail.send_mail()` call.
  242. * The :func:`~django.contrib.auth.decorators.permission_required` decorator can
  243. take a list of permissions as well as a single permission.
  244. * You can override the new :meth:`AuthenticationForm.confirm_login_allowed()
  245. <django.contrib.auth.forms.AuthenticationForm.confirm_login_allowed>` method
  246. to more easily customize the login policy.
  247. * :func:`django.contrib.auth.views.password_reset` takes an optional
  248. ``html_email_template_name`` parameter used to send a multipart HTML email
  249. for password resets.
  250. * The :meth:`AbstractBaseUser.get_session_auth_hash()
  251. <django.contrib.auth.models.AbstractBaseUser.get_session_auth_hash>`
  252. method was added and if your :setting:`AUTH_USER_MODEL` inherits from
  253. :class:`~django.contrib.auth.models.AbstractBaseUser`, changing a user's
  254. password now invalidates old sessions if the
  255. :class:`~django.contrib.auth.middleware.SessionAuthenticationMiddleware` is
  256. enabled. See :ref:`session-invalidation-on-password-change` for more details
  257. including upgrade considerations when enabling this new middleware.
  258. :mod:`django.contrib.formtools`
  259. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  260. * Calls to :meth:`WizardView.done()
  261. <django.contrib.formtools.wizard.views.WizardView.done>` now include a
  262. ``form_dict`` to allow easier access to forms by their step name.
  263. :mod:`django.contrib.gis`
  264. ^^^^^^^^^^^^^^^^^^^^^^^^^^
  265. * The default OpenLayers library version included in widgets has been updated
  266. from 2.11 to 2.13.
  267. * Prepared geometries now also support the ``crosses``, ``disjoint``,
  268. ``overlaps``, ``touches`` and ``within`` predicates, if GEOS 3.3 or later is
  269. installed.
  270. :mod:`django.contrib.messages`
  271. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  272. * The backends for :mod:`django.contrib.messages` that use cookies, will now
  273. follow the :setting:`SESSION_COOKIE_SECURE` and
  274. :setting:`SESSION_COOKIE_HTTPONLY` settings.
  275. * The :ref:`messages context processor <message-displaying>` now adds a
  276. dictionary of default levels under the name ``DEFAULT_MESSAGE_LEVELS``.
  277. * :class:`~django.contrib.messages.storage.base.Message` objects now have a
  278. ``level_tag`` attribute that contains the string representation of the
  279. message level.
  280. :mod:`django.contrib.redirects`
  281. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  282. * :class:`~django.contrib.redirects.middleware.RedirectFallbackMiddleware`
  283. has two new attributes
  284. (:attr:`~django.contrib.redirects.middleware.RedirectFallbackMiddleware.response_gone_class`
  285. and
  286. :attr:`~django.contrib.redirects.middleware.RedirectFallbackMiddleware.response_redirect_class`)
  287. that specify the types of :class:`~django.http.HttpResponse` instances the
  288. middleware returns.
  289. :mod:`django.contrib.sessions`
  290. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  291. * The ``"django.contrib.sessions.backends.cached_db"`` session backend now
  292. respects :setting:`SESSION_CACHE_ALIAS`. In previous versions, it always used
  293. the `default` cache.
  294. :mod:`django.contrib.sitemaps`
  295. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  296. * The :mod:`sitemap framework<django.contrib.sitemaps>` now makes use of
  297. :attr:`~django.contrib.sitemaps.Sitemap.lastmod` to set a ``Last-Modified``
  298. header in the response. This makes it possible for the
  299. :class:`~django.middleware.http.ConditionalGetMiddleware` to handle
  300. conditional ``GET`` requests for sitemaps which set ``lastmod``.
  301. :mod:`django.contrib.sites`
  302. ^^^^^^^^^^^^^^^^^^^^^^^^^^^
  303. * The new :class:`django.contrib.sites.middleware.CurrentSiteMiddleware` allows
  304. setting the current site on each request.
  305. :mod:`django.contrib.staticfiles`
  306. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  307. * The :ref:`static files storage classes <staticfiles-storages>` may be
  308. subclassed to override the permissions that collected static files and
  309. directories receive by setting the
  310. :attr:`~django.core.files.storage.FileSystemStorage.file_permissions_mode`
  311. and :attr:`~django.core.files.storage.FileSystemStorage.directory_permissions_mode`
  312. parameters. See :djadmin:`collectstatic` for example usage.
  313. * The :class:`~django.contrib.staticfiles.storage.CachedStaticFilesStorage`
  314. backend gets a sibling class called
  315. :class:`~django.contrib.staticfiles.storage.ManifestStaticFilesStorage`
  316. that doesn't use the cache system at all but instead a JSON file called
  317. ``staticfiles.json`` for storing the mapping between the original file name
  318. (e.g. ``css/styles.css``) and the hashed file name (e.g.
  319. ``css/styles.55e7cbb9ba48.css``. The ``staticfiles.json`` file is created
  320. when running the :djadmin:`collectstatic` management command and should
  321. be a less expensive alternative for remote storages such as Amazon S3.
  322. See the :class:`~django.contrib.staticfiles.storage.ManifestStaticFilesStorage`
  323. docs for more information.
  324. * :djadmin:`findstatic` now accepts verbosity flag level 2, meaning it will
  325. show the relative paths of the directories it searched. See
  326. :djadmin:`findstatic` for example output.
  327. :mod:`django.contrib.syndication`
  328. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  329. * The :class:`~django.utils.feedgenerator.Atom1Feed` syndication feed's
  330. ``updated`` element now utilizes ``updateddate`` instead of ``pubdate``,
  331. allowing the ``published`` element to be included in the feed (which
  332. relies on ``pubdate``).
  333. Cache
  334. ^^^^^
  335. * Access to caches configured in :setting:`CACHES` is now available via
  336. :data:`django.core.cache.caches`. This dict-like object provides a different
  337. instance per thread. It supersedes :func:`django.core.cache.get_cache` which
  338. is now deprecated.
  339. * If you instantiate cache backends directly, be aware that they aren't
  340. thread-safe any more, as :data:`django.core.cache.caches` now yields
  341. different instances per thread.
  342. * Defining the :setting:`TIMEOUT <CACHES-TIMEOUT>` argument of the
  343. :setting:`CACHES` setting as ``None`` will set the cache keys as
  344. "non-expiring" by default. Previously, it was only possible to pass
  345. ``timeout=None` to the cache backend's ``set()`` method.
  346. Cross Site Request Forgery
  347. ^^^^^^^^^^^^^^^^^^^^^^^^^^
  348. * The :setting:`CSRF_COOKIE_AGE` setting facilitates the use of session-based
  349. CSRF cookies.
  350. Email
  351. ^^^^^
  352. * :func:`~django.core.mail.send_mail` now accepts an ``html_message``
  353. parameter for sending a multipart ``text/plain`` and ``text/html`` email.
  354. * The SMTP :class:`~django.core.mail.backends.smtp.EmailBackend` now accepts a
  355. :attr:`~django.core.mail.backends.smtp.EmailBackend.timeout` parameter.
  356. File Storage
  357. ^^^^^^^^^^^^
  358. * File locking on Windows previously depended on the PyWin32 package; if it
  359. wasn't installed, file locking failed silently. That dependency has been
  360. removed, and file locking is now implemented natively on both Windows
  361. and Unix.
  362. File Uploads
  363. ^^^^^^^^^^^^
  364. * The new :attr:`UploadedFile.content_type_extra
  365. <django.core.files.uploadedfile.UploadedFile.content_type_extra>` attribute
  366. contains extra parameters passed to the ``content-type`` header on a file
  367. upload.
  368. * The new :setting:`FILE_UPLOAD_DIRECTORY_PERMISSIONS` setting controls
  369. the file system permissions of directories created during file upload, like
  370. :setting:`FILE_UPLOAD_PERMISSIONS` does for the files themselves.
  371. * The :attr:`FileField.upload_to <django.db.models.FileField.upload_to>`
  372. attribute is now optional. If it is omitted or given ``None`` or an empty
  373. string, a subdirectory won't be used for storing the uploaded files.
  374. Forms
  375. ^^^^^
  376. * The ``<label>`` and ``<input>`` tags rendered by
  377. :class:`~django.forms.RadioSelect` and
  378. :class:`~django.forms.CheckboxSelectMultiple` when looping over the radio
  379. buttons or checkboxes now include ``for`` and ``id`` attributes, respectively.
  380. Each radio button or checkbox includes an ``id_for_label`` attribute to
  381. output the element's ID.
  382. * The ``<textarea>`` tags rendered by :class:`~django.forms.Textarea` now
  383. include a ``maxlength`` attribute if the :class:`~django.db.models.TextField`
  384. model field has a ``max_length``.
  385. * :attr:`Field.choices<django.db.models.Field.choices>` now allows you to
  386. customize the "empty choice" label by including a tuple with an empty string
  387. or ``None`` for the key and the custom label as the value. The default blank
  388. option ``"----------"`` will be omitted in this case.
  389. * :class:`~django.forms.MultiValueField` allows optional subfields by setting
  390. the ``require_all_fields`` argument to ``False``. The ``required`` attribute
  391. for each individual field will be respected, and a new ``incomplete``
  392. validation error will be raised when any required fields are empty.
  393. * The :meth:`~django.forms.Form.clean` method on a form no longer needs to
  394. return ``self.cleaned_data``. If it does return a changed dictionary then
  395. that will still be used.
  396. * After a temporary regression in Django 1.6, it's now possible again to make
  397. :class:`~django.forms.TypedChoiceField` ``coerce`` method return an arbitrary
  398. value.
  399. * :attr:`SelectDateWidget.months
  400. <django.forms.extras.widgets.SelectDateWidget.months>` can be used to
  401. customize the wording of the months displayed in the select widget.
  402. * The ``min_num`` and ``validate_min`` parameters were added to
  403. :func:`~django.forms.formsets.formset_factory` to allow validating
  404. a minimum number of submitted forms.
  405. * The metaclasses used by ``Form`` and ``ModelForm`` have been reworked to
  406. support more inheritance scenarios. The previous limitation that prevented
  407. inheriting from both ``Form`` and ``ModelForm`` simultaneously have been
  408. removed as long as ``ModelForm`` appears first in the MRO.
  409. * It's now possible to opt-out from a ``Form`` field declared in a parent class
  410. by shadowing it with a non-``Field`` value.
  411. * The new :meth:`~django.forms.Form.add_error()` method allows adding errors
  412. to specific form fields.
  413. * The dict-like attribute :attr:`~django.forms.Form.errors` now has two new
  414. methods :meth:`~django.forms.Form.errors.as_data()` and
  415. :meth:`~django.forms.Form.errors.as_json()`. The former returns a ``dict``
  416. that maps fields to their original errors, complete with all metadata
  417. (error code and params), the latter returns the errors serialized as json.
  418. * It's now possible to customize the error messages for ``ModelForm``’s
  419. ``unique``, ``unique_for_date``, and ``unique_together`` constraints.
  420. In order to support ``unique_together`` or any other ``NON_FIELD_ERROR``,
  421. ``ModelForm`` now looks for the ``NON_FIELD_ERROR`` key in the
  422. ``error_messages`` dictionary of the ``ModelForm``’s inner ``Meta`` class.
  423. See :ref:`considerations regarding model's error_messages
  424. <considerations-regarding-model-errormessages>` for more details.
  425. Internationalization
  426. ^^^^^^^^^^^^^^^^^^^^
  427. * The :attr:`django.middleware.locale.LocaleMiddleware.response_redirect_class`
  428. attribute allows you to customize the redirects issued by the middleware.
  429. * The :class:`~django.middleware.locale.LocaleMiddleware` now stores the user's
  430. selected language with the session key ``_language``. This should only be
  431. accessed using the :data:`~django.utils.translation.LANGUAGE_SESSION_KEY`
  432. constant. Previously it was stored with the key ``django_language`` and the
  433. ``LANGUAGE_SESSION_KEY`` constant did not exist, but keys reserved for Django
  434. should start with an underscore. For backwards compatibility ``django_language``
  435. is still read from in 1.7. Sessions will be migrated to the new key
  436. as they are written.
  437. * The :ttag:`blocktrans` now supports a ``trimmed`` option. This
  438. option will remove newline characters from the beginning and the end of the
  439. content of the ``{% blocktrans %}`` tag, replace any whitespace at the
  440. beginning and end of a line and merge all lines into one using a space
  441. character to separate them. This is quite useful for indenting the content of
  442. a ``{% blocktrans %}`` tag without having the indentation characters end up
  443. in the corresponding entry in the PO file, which makes the translation
  444. process easier.
  445. * When you run :djadmin:`makemessages` from the root directory of your project,
  446. any extracted strings will now be automatically distributed to the proper
  447. app or project message file. See :ref:`how-to-create-language-files` for
  448. details.
  449. * The :djadmin:`makemessages` command now always adds the ``--previous``
  450. command line flag to the ``msgmerge`` command, keeping previously translated
  451. strings in po files for fuzzy strings.
  452. * The following settings to adjust the language cookie options were introduced:
  453. :setting:`LANGUAGE_COOKIE_AGE`, :setting:`LANGUAGE_COOKIE_DOMAIN`
  454. and :setting:`LANGUAGE_COOKIE_PATH`.
  455. * Added :ref:`format definitions <format-localization>` for Esperanto.
  456. Management Commands
  457. ^^^^^^^^^^^^^^^^^^^
  458. * The :djadminopt:`--no-color` option for ``django-admin.py`` allows you to
  459. disable the colorization of management command output.
  460. * The new :djadminopt:`--natural-foreign` and :djadminopt:`--natural-primary`
  461. options for :djadmin:`dumpdata`, and the new ``use_natural_foreign_keys`` and
  462. ``use_natural_primary_keys`` arguments for ``serializers.serialize()``, allow
  463. the use of natural primary keys when serializing.
  464. * It is no longer necessary to provide the cache table name or the
  465. :djadminopt:`--database` option for the :djadmin:`createcachetable` command.
  466. Django takes this information from your settings file. If you have configured
  467. multiple caches or multiple databases, all cache tables are created.
  468. * The :djadmin:`runserver` command received several improvements:
  469. * On Linux systems, if pyinotify_ is installed, the development server will
  470. reload immediately when a file is changed. Previously, it polled the
  471. filesystem for changes every second. That caused a small delay before
  472. reloads and reduced battery life on laptops.
  473. .. _pyinotify: https://pypi.python.org/pypi/pyinotify
  474. * In addition, the development server automatically reloads when a
  475. translation file is updated, i.e. after running
  476. :djadmin:`compilemessages`.
  477. * All HTTP requests are logged to the console, including requests for static
  478. files or ``favicon.ico`` that used to be filtered out.
  479. * Management commands can now produce syntax colored output under Windows if
  480. the ANSICON third-party tool is installed and active.
  481. * :djadmin:`collectstatic` command with symlink option is now supported on
  482. Windows NT 6 (Windows Vista and newer).
  483. * :ref:`initial-sql` now works better if the sqlparse_ Python library is
  484. installed.
  485. Note that it's deprecated in favor of the
  486. :class:`~django.db.migrations.operations.RunSQL` operation of migrations,
  487. which benefits from the improved behavior.
  488. .. _sqlparse: https://pypi.python.org/pypi/sqlparse
  489. Models
  490. ^^^^^^
  491. * The :meth:`QuerySet.update_or_create()
  492. <django.db.models.query.QuerySet.update_or_create>` method was added.
  493. * The new :attr:`~django.db.models.Options.default_permissions` model
  494. ``Meta`` option allows you to customize (or disable) creation of the default
  495. add, change, and delete permissions.
  496. * Explicit :class:`~django.db.models.OneToOneField` for
  497. :ref:`multi-table-inheritance` are now discovered in abstract classes.
  498. * Is it now possible to avoid creating a backward relation for
  499. :class:`~django.db.models.OneToOneField` by setting its
  500. :attr:`~django.db.models.ForeignKey.related_name` to
  501. ``'+'`` or ending it with ``'+'``.
  502. * :class:`F expressions <django.db.models.F>` support the power operator
  503. (``**``).
  504. * The ``remove()`` and ``clear()`` methods of the related managers created by
  505. ``ForeignKey`` and ``GenericForeignKey`` now accept the ``bulk`` keyword
  506. argument to control whether or not to perform operations in bulk
  507. (i.e. using ``QuerySet.update()``). Defaults to ``True``.
  508. * It is now possible to use ``None`` as a query value for the :lookup:`iexact`
  509. lookup.
  510. * It is now possible to pass a callable as value for the attribute
  511. :attr:`~django.db.models.ForeignKey.limit_choices_to` when defining a
  512. ``ForeignKey`` or ``ManyToManyField``.
  513. * Calling :meth:`only() <django.db.models.query.QuerySet.only>` and
  514. :meth:`defer() <django.db.models.query.QuerySet.defer>` on the result of
  515. :meth:`QuerySet.values() <django.db.models.query.QuerySet.values>` now raises
  516. an error (before that, it would either result in a database error or
  517. incorrect data).
  518. * You can use a single list for :attr:`~django.db.models.Options.index_together`
  519. (rather than a list of lists) when specifying a single set of fields.
  520. * Custom intermediate models having more than one foreign key to any of the
  521. models participating in a many-to-many relationship are now permitted,
  522. provided you explicitly specify which foreign keys should be used by setting
  523. the new :attr:`ManyToManyField.through_fields <django.db.models.ManyToManyField.through_fields>`
  524. argument.
  525. * Assigning a model instance to a non-relation field will now throw an error.
  526. Previously this used to work if the field accepted integers as input as it
  527. took the primary key.
  528. * Integer fields are now validated against database backend specific min and
  529. max values based on their :meth:`internal_type <django.db.models.Field.get_internal_type>`.
  530. Previously model field validation didn't prevent values out of their associated
  531. column data type range from being saved resulting in an integrity error.
  532. * It is now possible to explicitly :meth:`~django.db.models.query.QuerySet.order_by`
  533. a relation ``_id`` field by using its attribute name.
  534. Signals
  535. ^^^^^^^
  536. * The ``enter`` argument was added to the
  537. :data:`~django.test.signals.setting_changed` signal.
  538. * The model signals can be now be connected to using a ``str`` of the
  539. ``'app_label.ModelName'`` form – just like related fields – to lazily
  540. reference their senders.
  541. Templates
  542. ^^^^^^^^^
  543. * The :meth:`Context.push() <django.template.Context.push>` method now returns
  544. a context manager which automatically calls :meth:`pop()
  545. <django.template.Context.pop>` upon exiting the ``with`` statement.
  546. Additionally, :meth:`push() <django.template.Context.push>` now accepts
  547. parameters that are passed to the ``dict`` constructor used to build the new
  548. context level.
  549. * The new :meth:`Context.flatten() <django.template.Context.flatten>` method
  550. returns a ``Context``'s stack as one flat dictionary.
  551. * ``Context`` objects can now be compared for equality (internally, this
  552. uses :meth:`Context.flatten() <django.template.Context.flatten>` so the
  553. internal structure of each ``Context``'s stack doesn't matter as long as their
  554. flattened version is identical).
  555. * The :ttag:`widthratio` template tag now accepts an "as" parameter to capture
  556. the result in a variable.
  557. * The :ttag:`include` template tag will now also accept anything with a
  558. ``render()`` method (such as a ``Template``) as an argument. String
  559. arguments will be looked up using
  560. :func:`~django.template.loader.get_template` as always.
  561. * It is now possible to :ttag:`include` templates recursively.
  562. * Template objects now have an origin attribute set when
  563. :setting:`TEMPLATE_DEBUG` is ``True``. This allows template origins to be
  564. inspected and logged outside of the ``django.template`` infrastructure.
  565. * ``TypeError`` exceptions are no longer silenced when raised during the
  566. rendering of a template.
  567. * The following functions now accept a ``dirs`` parameter which is a list or
  568. tuple to override :setting:`TEMPLATE_DIRS`:
  569. * :func:`django.template.loader.get_template()`
  570. * :func:`django.template.loader.select_template()`
  571. * :func:`django.shortcuts.render()`
  572. * :func:`django.shortcuts.render_to_response()`
  573. * The :tfilter:`time` filter now accepts timezone-related :ref:`format
  574. specifiers <date-and-time-formatting-specifiers>` ``'e'``, ``'O'`` , ``'T'``
  575. and ``'Z'`` and is able to digest :ref:`time-zone-aware
  576. <naive_vs_aware_datetimes>` ``datetime`` instances performing the expected
  577. rendering.
  578. * The :ttag:`cache` tag will now try to use the cache called
  579. "template_fragments" if it exists and fall back to using the default cache
  580. otherwise. It also now accepts an optional ``using`` keyword argument to
  581. control which cache it uses.
  582. * The new :tfilter:`truncatechars_html` filter truncates a string to be no
  583. longer than the specified number of characters, taking HTML into account.
  584. Requests and Responses
  585. ^^^^^^^^^^^^^^^^^^^^^^
  586. * The new :attr:`HttpRequest.scheme <django.http.HttpRequest.scheme>` attribute
  587. specifies the scheme of the request (``http`` or ``https`` normally).
  588. * The shortcut :func:`redirect() <django.shortcuts.redirect>` now supports
  589. relative URLs.
  590. * The new :class:`~django.http.JsonResponse` subclass of
  591. :class:`~django.http.HttpResponse` helps easily create JSON-encoded responses.
  592. Tests
  593. ^^^^^
  594. * :class:`~django.test.runner.DiscoverRunner` has two new attributes,
  595. :attr:`~django.test.runner.DiscoverRunner.test_suite` and
  596. :attr:`~django.test.runner.DiscoverRunner.test_runner`, which facilitate
  597. overriding the way tests are collected and run.
  598. * The ``fetch_redirect_response`` argument was added to
  599. :meth:`~django.test.SimpleTestCase.assertRedirects`. Since the test
  600. client can't fetch externals URLs, this allows you to use ``assertRedirects``
  601. with redirects that aren't part of your Django app.
  602. * Correct handling of scheme when making comparisons in
  603. :meth:`~django.test.SimpleTestCase.assertRedirects`.
  604. * The ``secure`` argument was added to all the request methods of
  605. :class:`~django.test.Client`. If ``True``, the request will be made
  606. through HTTPS.
  607. * :meth:`~django.test.TransactionTestCase.assertNumQueries` now prints
  608. out the list of executed queries if the assertion fails.
  609. * The ``WSGIRequest`` instance generated by the test handler is now attached to
  610. the :attr:`django.test.Response.wsgi_request` attribute.
  611. * The database settings for testing have been collected into a dictionary
  612. named :setting:`TEST <DATABASE-TEST>`.
  613. Utilities
  614. ^^^^^^^^^
  615. * Improved :func:`~django.utils.html.strip_tags` accuracy (but it still cannot
  616. guarantee an HTML-safe result, as stated in the documentation).
  617. Validators
  618. ^^^^^^^^^^
  619. * :class:`~django.core.validators.RegexValidator` now accepts the optional
  620. :attr:`~django.core.validators.RegexValidator.flags` and
  621. Boolean :attr:`~django.core.validators.RegexValidator.inverse_match` arguments.
  622. The :attr:`~django.core.validators.RegexValidator.inverse_match` attribute
  623. determines if the :exc:`~django.core.exceptions.ValidationError` should
  624. be raised when the regular expression pattern matches (``True``) or does not
  625. match (``False``, by default) the provided ``value``. The
  626. :attr:`~django.core.validators.RegexValidator.flags` attribute sets the flags
  627. used when compiling a regular expression string.
  628. * :class:`~django.core.validators.URLValidator` now accepts an optional
  629. ``schemes`` argument which allows customization of the accepted URI schemes
  630. (instead of the defaults ``http(s)`` and ``ftp(s)``).
  631. * :func:`~django.core.validators.validate_email` now accepts addresses with
  632. IPv6 literals, like ``example@[2001:db8::1]``, as specified in RFC 5321.
  633. Backwards incompatible changes in 1.7
  634. =====================================
  635. .. warning::
  636. In addition to the changes outlined in this section, be sure to review the
  637. :doc:`deprecation plan </internals/deprecation>` for any features that
  638. have been removed. If you haven't updated your code within the
  639. deprecation timeline for a given feature, its removal may appear as a
  640. backwards incompatible change.
  641. allow_syncdb/allow_migrate
  642. ~~~~~~~~~~~~~~~~~~~~~~~~~~
  643. While Django will still look at ``allow_syncdb`` methods even though they
  644. should be renamed to ``allow_migrate``, there is a subtle difference in which
  645. models get passed to these methods.
  646. For apps with migrations, ``allow_migrate`` will now get passed
  647. :ref:`historical models <historical-models>`, which are special versioned models
  648. without custom attributes, methods or managers. Make sure your ``allow_migrate``
  649. methods are only referring to fields or other items in ``model._meta``.
  650. initial_data
  651. ~~~~~~~~~~~~
  652. Apps with migrations will not load ``initial_data`` fixtures when they have
  653. finished migrating. Apps without migrations will continue to load these fixtures
  654. during the phase of ``migrate`` which emulates the old ``syncdb`` behavior,
  655. but any new apps will not have this support.
  656. Instead, you are encouraged to load initial data in migrations if you need it
  657. (using the ``RunPython`` operation and your model classes);
  658. this has the added advantage that your initial data will not need updating
  659. every time you change the schema.
  660. deconstruct() and serializability
  661. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  662. Django now requires all Field classes and all of their constructor arguments
  663. to be serializable. If you modify the constructor signature in your custom
  664. Field in any way, you'll need to implement a deconstruct() method;
  665. we've expanded the custom field documentation with :ref:`instructions
  666. on implementing this method <custom-field-deconstruct-method>`.
  667. The requirement for all field arguments to be
  668. :ref:`serializable <migration-serializing>` means that any custom class
  669. instances being passed into Field constructors - things like custom Storage
  670. subclasses, for instance - need to have a :ref:`deconstruct method defined on
  671. them as well <custom-deconstruct-method>`, though Django provides a handy
  672. class decorator that will work for most applications.
  673. App-loading changes
  674. ~~~~~~~~~~~~~~~~~~~
  675. Start-up sequence
  676. ^^^^^^^^^^^^^^^^^
  677. Django 1.7 loads application configurations and models as soon as it starts.
  678. While this behavior is more straightforward and is believed to be more robust,
  679. regressions cannot be ruled out. See :ref:`applications-troubleshooting` for
  680. solutions to some problems you may encounter.
  681. Standalone scripts
  682. ^^^^^^^^^^^^^^^^^^
  683. If you're using Django in a plain Python script — rather than a management
  684. command — and you rely on the :envvar:`DJANGO_SETTINGS_MODULE` environment
  685. variable, you must now explicitly initialize Django at the beginning of your
  686. script with::
  687. >>> import django
  688. >>> django.setup()
  689. Otherwise, you will hit ``RuntimeError: App registry isn't ready yet.``
  690. App registry consistency
  691. ^^^^^^^^^^^^^^^^^^^^^^^^
  692. It is no longer possible to have multiple installed applications with the same
  693. label. In previous versions of Django, this didn't always work correctly, but
  694. didn't crash outright either.
  695. If you have two apps with the same label, you should create an
  696. :class:`~django.apps.AppConfig` for one of them and override its
  697. :class:`~django.apps.AppConfig.label` there. You should then adjust your code
  698. wherever it references this application or its models with the old label.
  699. It isn't possible to import the same model twice through different paths any
  700. more. As of Django 1.6, this may happen only if you're manually putting a
  701. directory and a subdirectory on :envvar:`PYTHONPATH`. Refer to the section on
  702. the new project layout in the :doc:`1.4 release notes </releases/1.4>` for
  703. migration instructions.
  704. You should make sure that:
  705. * All models are defined in applications that are listed in
  706. :setting:`INSTALLED_APPS` or have an explicit
  707. :attr:`~django.db.models.Options.app_label`.
  708. * Models aren't imported as a side-effect of loading their application.
  709. Specifically, you shouldn't import models in the root module of an
  710. application nor in the module that define its configuration class.
  711. Django will enforce these requirements as of version 1.9, after a deprecation
  712. period.
  713. Subclassing AppCommand
  714. ^^^^^^^^^^^^^^^^^^^^^^
  715. Subclasses of :class:`~django.core.management.AppCommand` must now implement a
  716. :meth:`~django.core.management.AppCommand.handle_app_config` method instead of
  717. ``handle_app()``. This method receives an :class:`~django.apps.AppConfig`
  718. instance instead of a models module.
  719. Introspecting applications
  720. ^^^^^^^^^^^^^^^^^^^^^^^^^^
  721. Since :setting:`INSTALLED_APPS` now supports application configuration classes
  722. in addition to application modules, you should review code that accesses this
  723. setting directly and use the app registry (:attr:`django.apps.apps`) instead.
  724. The app registry has preserved some features of the old app cache. Even though
  725. the app cache was a private API, obsolete methods and arguments will be
  726. removed through a standard deprecation path, with the exception of the
  727. following changes that take effect immediately:
  728. * ``get_model`` raises :exc:`LookupError` instead of returning ``None`` when no
  729. model is found.
  730. * The ``only_installed`` argument of ``get_model`` and ``get_models`` no
  731. longer exists, nor does the ``seed_cache`` argument of ``get_model``.
  732. Management commands and order of :setting:`INSTALLED_APPS`
  733. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  734. When several applications provide management commands with the same name,
  735. Django loads the command from the application that comes first in
  736. :setting:`INSTALLED_APPS`. Previous versions loaded the command from the
  737. application that came last.
  738. This brings discovery of management commands in line with other parts of
  739. Django that rely on the order of :setting:`INSTALLED_APPS`, such as static
  740. files, templates, and translations.
  741. Behavior of ``LocMemCache`` regarding pickle errors
  742. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  743. An inconsistency existed in previous versions of Django regarding how pickle
  744. errors are handled by different cache backends.
  745. ``django.core.cache.backends.locmem.LocMemCache`` used to fail silently when
  746. such an error occurs, which is inconsistent with other backends and leads to
  747. cache-specific errors. This has been fixed in Django 1.7, see
  748. `Ticket #21200`_ for more details.
  749. .. _Ticket #21200: https://code.djangoproject.com/ticket/21200
  750. Cache keys are now generated from the request's absolute URL
  751. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  752. Previous versions of Django generated cache keys using a request's path and
  753. query string but not the scheme or host. If a Django application was serving
  754. multiple subdomains or domains, cache keys could collide. In Django 1.7, cache
  755. keys vary by the absolute URL of the request including scheme, host, path, and
  756. query string. For example, the URL portion of a cache key is now generated from
  757. ``http://www.example.com/path/to/?key=val`` rather than ``/path/to/?key=val``.
  758. The cache keys generated by Django 1.7 will be different from the keys
  759. generated by older versions of Django. After upgrading to Django 1.7, the first
  760. request to any previously cached URL will be a cache miss .
  761. Passing ``None`` to ``Manager.db_manager()``
  762. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  763. In previous versions of Django, it was possible to use
  764. ``db_manager(using=None)`` on a model manager instance to obtain a manager
  765. instance using default routing behavior, overriding any manually specified
  766. database routing. In Django 1.7, a value of ``None`` passed to db_manager will
  767. produce a router that *retains* any manually assigned database routing -- the
  768. manager will *not* be reset. This was necessary to resolve an inconsistency in
  769. the way routing information cascaded over joins. See `Ticket #13724`_ for more
  770. details.
  771. .. _Ticket #13724: https://code.djangoproject.com/ticket/13724
  772. pytz may be required
  773. ~~~~~~~~~~~~~~~~~~~~
  774. If your project handles datetimes before 1970 or after 2037 and Django raises
  775. a :exc:`ValueError` when encountering them, you will have to install pytz_. You
  776. may be affected by this problem if you use Django's time zone-related date
  777. formats or :mod:`django.contrib.syndication`.
  778. .. _pytz: https://pypi.python.org/pypi/pytz/
  779. ``remove()`` and ``clear()`` methods of related managers
  780. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  781. The ``remove()`` and ``clear()`` methods of the related managers created by
  782. ``ForeignKey``, ``GenericForeignKey``, and ``ManyToManyField`` suffered from a
  783. number of issues. Some operations ran multiple data modifying queries without
  784. wrapping them in a transaction, and some operations didn't respect default
  785. filtering when it was present (i.e. when the default manager on the related
  786. model implemented a custom ``get_queryset()``).
  787. Fixing the issues introduced some backward incompatible changes:
  788. - The default implementation of ``remove()`` for ``ForeignKey`` related managers
  789. changed from a series of ``Model.save()`` calls to a single
  790. ``QuerySet.update()`` call. The change means that ``pre_save`` and
  791. ``post_save`` signals aren't sent anymore. You can use the ``bulk=False``
  792. keyword argument to revert to the previous behavior.
  793. - The ``remove()`` and ``clear()`` methods for ``GenericForeignKey`` related
  794. managers now perform bulk delete. The ``Model.delete()`` method isn't called
  795. on each instance anymore. You can use the ``bulk=False`` keyword argument to
  796. revert to the previous behavior.
  797. - The ``remove()`` and ``clear()`` methods for ``ManyToManyField`` related
  798. managers perform nested queries when filtering is involved, which may or
  799. may not be an issue depending on your database and your data itself.
  800. See :ref:`this note <nested-queries-performance>` for more details.
  801. Admin login redirection strategy
  802. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  803. Historically, the Django admin site passed the request from an unauthorized or
  804. unauthenticated user directly to the login view, without HTTP redirection. In
  805. Django 1.7, this behavior changed to conform to a more traditional workflow
  806. where any unauthorized request to an admin page will be redirected (by HTTP
  807. status code 302) to the login page, with the ``next`` parameter set to the
  808. referring path. The user will be redirected there after a successful login.
  809. Note also that the admin login form has been updated to not contain the
  810. ``this_is_the_login_form`` field (now unused) and the ``ValidationError`` code
  811. has been set to the more regular ``invalid_login`` key.
  812. ``select_for_update()`` requires a transaction
  813. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  814. Historically, queries that use
  815. :meth:`~django.db.models.query.QuerySet.select_for_update()` could be
  816. executed in autocommit mode, outside of a transaction. Before Django
  817. 1.6, Django's automatic transactions mode allowed this to be used to
  818. lock records until the next write operation. Django 1.6 introduced
  819. database-level autocommit; since then, execution in such a context
  820. voids the effect of ``select_for_update()``. It is, therefore, assumed
  821. now to be an error and raises an exception.
  822. This change was made because such errors can be caused by including an
  823. app which expects global transactions (e.g. :setting:`ATOMIC_REQUESTS
  824. <DATABASE-ATOMIC_REQUESTS>` set to ``True``), or Django's old autocommit
  825. behavior, in a project which runs without them; and further, such
  826. errors may manifest as data-corruption bugs. It was also made in
  827. Django 1.6.3.
  828. This change may cause test failures if you use ``select_for_update()``
  829. in a test class which is a subclass of
  830. :class:`~django.test.TransactionTestCase` rather than
  831. :class:`~django.test.TestCase`.
  832. Miscellaneous
  833. ~~~~~~~~~~~~~
  834. * The :meth:`django.core.files.uploadhandler.FileUploadHandler.new_file()`
  835. method is now passed an additional ``content_type_extra`` parameter. If you
  836. have a custom :class:`~django.core.files.uploadhandler.FileUploadHandler`
  837. that implements ``new_file()``, be sure it accepts this new parameter.
  838. * :class:`ModelFormSet<django.forms.models.BaseModelFormSet>`\s no longer
  839. delete instances when ``save(commit=False)`` is called. See
  840. :attr:`~django.forms.formsets.BaseFormSet.can_delete` for instructions on how
  841. to manually delete objects from deleted forms.
  842. * Loading empty fixtures emits a ``RuntimeWarning`` rather than raising
  843. :class:`~django.core.management.CommandError`.
  844. * :func:`django.contrib.staticfiles.views.serve` will now raise an
  845. :exc:`~django.http.Http404` exception instead of
  846. :exc:`~django.core.exceptions.ImproperlyConfigured` when :setting:`DEBUG`
  847. is ``False``. This change removes the need to conditionally add the view to
  848. your root URLconf, which in turn makes it safe to reverse by name. It also
  849. removes the ability for visitors to generate spurious HTTP 500 errors by
  850. requesting static files that don't exist or haven't been collected yet.
  851. * The :meth:`django.db.models.Model.__eq__` method is now defined in a
  852. way where instances of a proxy model and its base model are considered
  853. equal when primary keys match. Previously only instances of exact same
  854. class were considered equal on primary key match.
  855. * The :meth:`django.db.models.Model.__eq__` method has changed such that
  856. two ``Model`` instances without primary key values won't be considered
  857. equal (unless they are the same instance).
  858. * The :meth:`django.db.models.Model.__hash__` will now raise ``TypeError``
  859. when called on an instance without a primary key value. This is done to
  860. avoid mutable ``__hash__`` values in containers.
  861. * :class:`~django.db.models.AutoField` columns in SQLite databases will now be
  862. created using the ``AUTOINCREMENT`` option, which guarantees monotonic
  863. increments. This will cause primary key numbering behavior to change on
  864. SQLite, becoming consistent with most other SQL databases. This will only
  865. apply to newly created tables. If you have a database created with an older
  866. version of Django, you will need to migrate it to take advantage of this
  867. feature. For example, you could do the following:
  868. #) Use :djadmin:`dumpdata` to save your data.
  869. #) Rename the existing database file (keep it as a backup).
  870. #) Run :djadmin:`migrate` to create the updated schema.
  871. #) Use :djadmin:`loaddata` to import the fixtures you exported in (1).
  872. * ``django.contrib.auth.models.AbstractUser`` no longer defines a
  873. :meth:`~django.db.models.Model.get_absolute_url()` method. The old definition
  874. returned ``"/users/%s/" % urlquote(self.username)`` which was arbitrary
  875. since applications may or may not define such a url in ``urlpatterns``.
  876. Define a ``get_absolute_url()`` method on your own custom user object or use
  877. :setting:`ABSOLUTE_URL_OVERRIDES` if you want a URL for your user.
  878. * The static asset-serving functionality of the
  879. :class:`django.test.LiveServerTestCase` class has been simplified: Now it's
  880. only able to serve content already present in :setting:`STATIC_ROOT` when
  881. tests are run. The ability to transparently serve all the static assets
  882. (similarly to what one gets with :setting:`DEBUG = True <DEBUG>` at
  883. development-time) has been moved to a new class that lives in the
  884. ``staticfiles`` application (the one actually in charge of such feature):
  885. :class:`django.contrib.staticfiles.testing.StaticLiveServerCase`. In other
  886. words, ``LiveServerTestCase`` itself is less powerful but at the same time
  887. has less magic.
  888. Rationale behind this is removal of dependency of non-contrib code on
  889. contrib applications.
  890. * The old cache URI syntax (e.g. ``"locmem://"``) is no longer supported. It
  891. still worked, even though it was not documented or officially supported. If
  892. you're still using it, please update to the current :setting:`CACHES` syntax.
  893. * The default ordering of ``Form`` fields in case of inheritance has changed to
  894. follow normal Python MRO. Fields are now discovered by iterating through the
  895. MRO in reverse with the topmost class coming last. This only affects you if
  896. you relied on the default field ordering while having fields defined on both
  897. the current class *and* on a parent ``Form``.
  898. * The ``required`` argument of
  899. :class:`~django.forms.extras.widgets.SelectDateWidget` has been removed.
  900. This widget now respects the form field's ``is_required`` attribute like
  901. other widgets.
  902. * ``Widget.is_hidden`` is now a read-only property, getting its value by
  903. introspecting the presence of ``input_type == 'hidden'``.
  904. * :meth:`~django.db.models.query.QuerySet.select_related` now chains in the
  905. same way as other similar calls like ``prefetch_related``. That is,
  906. ``select_related('foo', 'bar')`` is equivalent to
  907. ``select_related('foo').select_related('bar')``. Previously the latter would
  908. have been equivalent to ``select_related('bar')``.
  909. * GeoDjango dropped support for GEOS < 3.1.
  910. * The ``init_connection_state`` method of database backends now executes in
  911. autocommit mode (unless you set :setting:`AUTOCOMMIT <DATABASE-AUTOCOMMIT>`
  912. to ``False``). If you maintain a custom database backend, you should check
  913. that method.
  914. * The ``django.db.backends.BaseDatabaseFeatures.allows_primary_key_0``
  915. attribute has been renamed to ``allows_auto_pk_0`` to better describe it.
  916. It's ``True`` for all database backends included with Django except MySQL
  917. which does allow primary keys with value 0. It only forbids *autoincrement*
  918. primary keys with value 0.
  919. * Shadowing model fields defined in a parent model has been forbidden as this
  920. creates ambiguity in the expected model behavior. In addition, any clashing
  921. fields in the model inheritance hierarchy results in a system check error.
  922. For example, if you use multi-inheritance, you need to define custom primary
  923. key fields on parent models, otherwise the default ``id`` fields will clash.
  924. See :ref:`model-multiple-inheritance-topic` for details.
  925. * ``django.utils.translation.parse_accept_lang_header()`` now returns
  926. lowercase locales, instead of the case as it was provided. As locales should
  927. be treated case-insensitive this allows us to speed up locale detection.
  928. * ``django.utils.translation.get_language_from_path()`` and
  929. ``django.utils.translation.trans_real.get_supported_language_variant()``
  930. now no longer have a ``supported`` argument.
  931. * The ``shortcut`` view in ``django.contrib.contenttypes.views`` now supports
  932. protocol-relative URLs (e.g. ``//example.com``).
  933. * :class:`~django.contrib.contenttypes.fields.GenericRelation` now supports an
  934. optional ``related_query_name`` argument. Setting ``related_query_name`` adds
  935. a relation from the related object back to the content type for filtering,
  936. ordering and other query operations.
  937. * When a model field's :attr:`~django.db.models.Field.validators` contains
  938. a :class:`~django.core.validators.RegexValidator`, the regular expression
  939. must now be passed as a regular expression string. You can no longer use a
  940. pre-compiled regular expression in this case, as it is not serializable.
  941. The :attr:`~django.core.validators.RegexValidator.flags` attribute was added
  942. to :class:`~django.core.validators.RegexValidator` to simplify this change.
  943. * When running tests on PostgreSQL, the :setting:`USER` will need read access
  944. to the built-in ``postgres`` database. This is in lieu of the previous
  945. behavior of connecting to the actual non-test database.
  946. * As part of the :doc:`System check framework </ref/checks>`, :ref:`fields,
  947. models, and model managers <field-checking>` all implement a ``check()``
  948. method that is registered with the check framework. If you have an existing
  949. method called ``check()`` on one of these objects, you will need to rename it.
  950. .. _deprecated-features-1.7:
  951. Features deprecated in 1.7
  952. ==========================
  953. ``django.core.cache.get_cache``
  954. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  955. :func:`django.core.cache.get_cache` has been supplanted by
  956. :data:`django.core.cache.caches`.
  957. ``django.utils.dictconfig``/``django.utils.importlib``
  958. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  959. ``django.utils.dictconfig`` and ``django.utils.importlib`` were copies of
  960. respectively :mod:`logging.config` and :mod:`importlib` provided for Python
  961. versions prior to 2.7. They have been deprecated.
  962. ``django.utils.module_loading.import_by_path``
  963. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  964. The current :meth:`~django.utils.module_loading.import_by_path` function
  965. catches ``AttributeError``, ``ImportError`` and ``ValueError`` exceptions,
  966. and re-raises :exc:`~django.core.exceptions.ImproperlyConfigured`. Such
  967. exception masking makes it needlessly hard to diagnose circular import
  968. problems, because it makes it look like the problem comes from inside Django.
  969. It has been deprecated in favor of
  970. :meth:`~django.utils.module_loading.import_string`.
  971. ``django.utils.tzinfo``
  972. ~~~~~~~~~~~~~~~~~~~~~~~
  973. ``django.utils.tzinfo`` provided two :class:`~datetime.tzinfo` subclasses,
  974. ``LocalTimezone`` and ``FixedOffset``. They've been deprecated in favor of
  975. more correct alternatives provided by :mod:`django.utils.timezone`,
  976. :func:`django.utils.timezone.get_default_timezone` and
  977. :func:`django.utils.timezone.get_fixed_timezone`.
  978. ``django.utils.unittest``
  979. ~~~~~~~~~~~~~~~~~~~~~~~~~
  980. ``django.utils.unittest`` provided uniform access to the ``unittest2`` library
  981. on all Python versions. Since ``unittest2`` became the standard library's
  982. :mod:`unittest` module in Python 2.7, and Django 1.7 drops support for older
  983. Python versions, this module isn't useful anymore. It has been deprecated. Use
  984. :mod:`unittest` instead.
  985. ``django.utils.datastructures.SortedDict``
  986. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  987. As :class:`~collections.OrderedDict` was added to the standard library in
  988. Python 2.7, :class:`~django.utils.datastructures.SortedDict` is no longer
  989. needed and has been deprecated.
  990. Custom SQL location for models package
  991. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  992. Previously, if models were organized in a package (``myapp/models/``) rather
  993. than simply ``myapp/models.py``, Django would look for :ref:`initial SQL data
  994. <initial-sql>` in ``myapp/models/sql/``. This bug has been fixed so that Django
  995. will search ``myapp/sql/`` as documented. After this issue was fixed, migrations
  996. were added which deprecates initial SQL data. Thus, while this change still
  997. exists, the deprecation is irrelevant as the entire feature will be removed in
  998. Django 1.9.
  999. Reorganization of ``django.contrib.sites``
  1000. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  1001. ``django.contrib.sites`` provides reduced functionality when it isn't in
  1002. :setting:`INSTALLED_APPS`. The app-loading refactor adds some constraints in
  1003. that situation. As a consequence, two objects were moved, and the old
  1004. locations are deprecated:
  1005. * :class:`~django.contrib.sites.requests.RequestSite` now lives in
  1006. ``django.contrib.sites.requests``.
  1007. * :func:`~django.contrib.sites.shortcuts.get_current_site` now lives in
  1008. ``django.contrib.sites.shortcuts``.
  1009. ``declared_fieldsets`` attribute on ``ModelAdmin``
  1010. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  1011. ``ModelAdmin.declared_fieldsets`` has been deprecated. Despite being a private
  1012. API, it will go through a regular deprecation path. This attribute was mostly
  1013. used by methods that bypassed ``ModelAdmin.get_fieldsets()`` but this was
  1014. considered a bug and has been addressed.
  1015. Reorganization of ``django.contrib.contenttypes``
  1016. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  1017. Since ``django.contrib.contenttypes.generic`` defined both admin and model
  1018. related objects an import of this module could trigger unexpected side effects.
  1019. As a consequence, its contents were split into :mod:`~django.contrib.contenttypes`
  1020. submodules and the ``django.contrib.contenttypes.generic`` module is deprecated:
  1021. * :class:`~django.contrib.contenttypes.fields.GenericForeignKey` and
  1022. :class:`~django.contrib.contenttypes.fields.GenericRelation` now live in
  1023. :mod:`~django.contrib.contenttypes.fields`.
  1024. * :class:`~django.contrib.contenttypes.forms.BaseGenericInlineFormSet` and
  1025. :func:`~django.contrib.contenttypes.forms.generic_inlineformset_factory` now
  1026. live in :mod:`~django.contrib.contenttypes.forms`.
  1027. * :class:`~django.contrib.contenttypes.admin.GenericInlineModelAdmin`,
  1028. :class:`~django.contrib.contenttypes.admin.GenericStackedInline` and
  1029. :class:`~django.contrib.contenttypes.admin.GenericTabularInline` now live in
  1030. :mod:`~django.contrib.contenttypes.admin`.
  1031. ``syncdb``
  1032. ~~~~~~~~~~
  1033. The :djadmin:`syncdb` command has been deprecated in favor of the new :djadmin:`migrate`
  1034. command. ``migrate`` takes the same arguments as ``syncdb`` used to plus a few
  1035. more, so it's safe to just change the name you're calling and nothing else.
  1036. ``util`` modules renamed to ``utils``
  1037. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  1038. The following instances of ``util.py`` in the Django codebase have been renamed
  1039. to ``utils.py`` in an effort to unify all util and utils references:
  1040. * ``django.contrib.admin.util``
  1041. * ``django.contrib.gis.db.backends.util``
  1042. * ``django.db.backends.util``
  1043. * ``django.forms.util``
  1044. ``get_formsets`` method on ``ModelAdmin``
  1045. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  1046. ``ModelAdmin.get_formsets`` has been deprecated in favor of the new
  1047. :meth:`~django.contrib.admin.ModelAdmin.get_formsets_with_inlines`, in order to
  1048. better handle the case of selecting showing inlines on a ``ModelAdmin``.
  1049. ``IPAddressField``
  1050. ~~~~~~~~~~~~~~~~~~
  1051. The :class:`django.db.models.IPAddressField` and
  1052. :class:`django.forms.IPAddressField` fields have been deprecated in favor of
  1053. :class:`django.db.models.GenericIPAddressField` and
  1054. :class:`django.forms.GenericIPAddressField`.
  1055. ``BaseMemcachedCache._get_memcache_timeout`` method
  1056. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  1057. The ``BaseMemcachedCache._get_memcache_timeout()`` method has been renamed to
  1058. ``get_backend_timeout()``. Despite being a private API, it will go through the
  1059. normal deprecation.
  1060. Natural key serialization options
  1061. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  1062. The ``--natural`` and ``-n`` options for :djadmin:`dumpdata` have been
  1063. deprecated. Use :djadminopt:`--natural-foreign` instead.
  1064. Similarly, the ``use_natural_keys`` argument for ``serializers.serialize()``
  1065. has been deprecated. Use ``use_natural_foreign_keys`` instead.
  1066. Merging of ``POST`` and ``GET`` arguments into ``WSGIRequest.REQUEST``
  1067. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  1068. It was already strongly suggested that you use ``GET`` and ``POST`` instead of
  1069. ``REQUEST``, because the former are more explicit. The property ``REQUEST`` is
  1070. deprecated and will be removed in Django 1.9.
  1071. ``django.utils.datastructures.MergeDict`` class
  1072. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  1073. ``MergeDict`` exists primarily to support merging ``POST`` and ``GET``
  1074. arguments into a ``REQUEST`` property on ``WSGIRequest``. To merge
  1075. dictionaries, use ``dict.update()`` instead. The class ``MergeDict`` is
  1076. deprecated and will be removed in Django 1.9.
  1077. Language codes ``zh-cn``, ``zh-tw`` and ``fy-nl``
  1078. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  1079. The currently used language codes for Simplified Chinese ``zh-cn``,
  1080. Traditional Chinese ``zh-tw`` and (Western) Frysian ``fy-nl`` are deprecated
  1081. and should be replaced by the language codes ``zh-hans``, ``zh-hant`` and
  1082. ``fy`` respectively. If you use these language codes, you should rename the
  1083. locale directories and update your settings to reflect these changes. The
  1084. deprecated language codes will be removed in Django 1.9.
  1085. ``django.utils.functional.memoize`` function
  1086. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  1087. The function ``memoize`` is deprecated and should be replaced by the
  1088. ``functools.lru_cache`` decorator (available from Python 3.2 onwards).
  1089. Django ships a backport of this decorator for older Python versions and it's
  1090. available at ``django.utils.lru_cache.lru_cache``. The deprecated function will
  1091. be removed in Django 1.9.
  1092. Geo Sitemaps
  1093. ~~~~~~~~~~~~
  1094. Google has retired support for the Geo Sitemaps format. Hence Django support
  1095. for Geo Sitemaps is deprecated and will be removed in Django 1.8.
  1096. Passing callable arguments to queryset methods
  1097. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  1098. Callable arguments for querysets were an undocumented feature that was
  1099. unreliable. It's been deprecated and will be removed in Django 1.9.
  1100. Callable arguments were evaluated when a queryset was constructed rather than
  1101. when it was evaluated, thus this feature didn't offer any benefit compared to
  1102. evaluating arguments before passing them to queryset and created confusion that
  1103. the arguments may have been evaluated at query time.
  1104. ``ADMIN_FOR`` setting
  1105. ~~~~~~~~~~~~~~~~~~~~~
  1106. The ``ADMIN_FOR`` feature, part of the admindocs, has been removed. You can
  1107. remove the setting from your configuration at your convenience.
  1108. ``SplitDateTimeWidget`` with ``DateTimeField``
  1109. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  1110. ``SplitDateTimeWidget`` support in :class:`~django.forms.DateTimeField` is
  1111. deprecated, use ``SplitDateTimeWidget`` with
  1112. :class:`~django.forms.SplitDateTimeField` instead.
  1113. ``validate``
  1114. ~~~~~~~~~~~~
  1115. :djadmin:`validate` command is deprecated in favor of :djadmin:`check` command.
  1116. ``django.core.management.BaseCommand``
  1117. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  1118. ``requires_model_validation`` is deprecated in favor of a new
  1119. ``requires_system_checks`` flag. If the latter flag is missing, then the
  1120. value of the former flag is used. Defining both ``requires_system_checks`` and
  1121. ``requires_model_validation`` results in an error.
  1122. The ``check()`` method has replaced the old ``validate()`` method.
  1123. ``ModelAdmin.validator``
  1124. ~~~~~~~~~~~~~~~~~~~~~~~~
  1125. ``ModelAdmin.validator`` is deprecated in favor of new ``checks`` attribute.
  1126. ``django.db.backends.DatabaseValidation.validate_field``
  1127. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  1128. This method is deprecated in favor of a new ``check_field`` method.
  1129. The functionality required by ``check_field()`` is the same as that provided
  1130. by ``validate_field()``, but the output format is different. Third-party database
  1131. backends needing this functionality should modify their backends to provide an
  1132. implementation of ``check_field()``.
  1133. Loading ``ssi`` and ``url`` template tags from ``future`` library
  1134. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  1135. Django 1.3 introduced ``{% load ssi from future %}`` and
  1136. ``{% load url from future %}`` syntax for forward compatibility of the
  1137. :ttag:`ssi` and :ttag:`url` template tags. This syntax is now deprecated and
  1138. will be removed in Django 1.9. You can simply remove the
  1139. ``{% load ... from future %}`` tags.
  1140. ``django.utils.text.javascript_quote``
  1141. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  1142. ``javascript_quote()`` was an undocumented function present in ``django.utils.text``.
  1143. It was used internally in the :ref:`javascript_catalog view <javascript_catalog-view>`
  1144. whose implementation was changed to make use of ``json.dumps()`` instead.
  1145. If you were relying on this function to provide safe output from untrusted
  1146. strings, you should use ``django.utils.html.escapejs`` or the
  1147. :tfilter:`escapejs` template filter.
  1148. If all you need is to generate valid javascript strings, you can simply use
  1149. ``json.dumps()``.
  1150. ``fix_ampersands`` utils method and template filter
  1151. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  1152. The ``django.utils.html.fix_ampersands`` method and the ``fix_ampersands``
  1153. template filter are deprecated, as the escaping of ampersands is already taken care
  1154. of by Django's standard HTML escaping features. Combining this with ``fix_ampersands``
  1155. would either result in double escaping, or, if the output is assumed to be safe,
  1156. a risk of introducing XSS vulnerabilities. Along with ``fix_ampersands``,
  1157. ``django.utils.html.clean_html`` is deprecated, an undocumented function that calls
  1158. ``fix_ampersands``.
  1159. As this is an accelerated deprecation, ``fix_ampersands`` and ``clean_html``
  1160. will be removed in Django 1.8.
  1161. Reorganization of database test settings
  1162. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  1163. All database settings with a `TEST_` prefix have been deprecated in favor of
  1164. entries in a :setting:`TEST <DATABASE-TEST>` dictionary in the database
  1165. settings. The old settings will be supported until Django 1.9.