innov
/
django1
1
0
Fork 0
Code Issues Pull Requests 1 Projects Releases Wiki Activity

[1.5.x] Added some doc links for django.contrib.messages 

Backport of b6178fa24b from master
This commit is contained in:
Tim Graham 2013-08-14 12:57:55 -04:00
parent f24ae3373b
commit 3a829bf75a
1 changed files with 7 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
docs/ref/contrib/messages.txt
View File

@ -54,20 +54,21 @@ Storage backends
The messages framework can use different backends to store temporary messages. The messages framework can use different backends to store temporary messages.
Django provides three built-in storage classes: Django provides three built-in storage classes in
:mod:`django.contrib.messages`:
.. class:: django.contrib.messages.storage.session.SessionStorage .. class:: storage.session.SessionStorage
This class stores all messages inside of the request's session. Therefore This class stores all messages inside of the request's session. Therefore
it requires Django's ``contrib.sessions`` application. it requires Django's ``contrib.sessions`` application.
.. class:: django.contrib.messages.storage.cookie.CookieStorage .. class:: storage.cookie.CookieStorage
This class stores the message data in a cookie (signed with a secret hash This class stores the message data in a cookie (signed with a secret hash
to prevent manipulation) to persist notifications across requests. Old to prevent manipulation) to persist notifications across requests. Old
messages are dropped if the cookie data size would exceed 2048 bytes. messages are dropped if the cookie data size would exceed 2048 bytes.
.. class:: django.contrib.messages.storage.fallback.FallbackStorage .. class:: storage.fallback.FallbackStorage
This class first uses ``CookieStorage``, and falls back to using This class first uses ``CookieStorage``, and falls back to using
``SessionStorage`` for the messages that could not fit in a single cookie. ``SessionStorage`` for the messages that could not fit in a single cookie.
@ -83,6 +84,8 @@ for example::
MESSAGE_STORAGE = 'django.contrib.messages.storage.cookie.CookieStorage' MESSAGE_STORAGE = 'django.contrib.messages.storage.cookie.CookieStorage'
.. class:: storage.base.BaseStorage
To write your own storage class, subclass the ``BaseStorage`` class in To write your own storage class, subclass the ``BaseStorage`` class in
``django.contrib.messages.storage.base`` and implement the ``_get`` and ``django.contrib.messages.storage.base`` and implement the ``_get`` and
``_store`` methods. ``_store`` methods.