summaryrefslogtreecommitdiff
path: root/docs/narr/sessions.rst
diff options
context:
space:
mode:
authorChris McDonough <chrism@plope.com>2011-07-20 06:10:38 -0400
committerChris McDonough <chrism@plope.com>2011-07-20 06:10:38 -0400
commit6ce1e0cf1a141767ee0aca70786c15dd993347c5 (patch)
treeed279497d354709b63d0fdc2c1e71cb88c424df7 /docs/narr/sessions.rst
parent9dfd3436711d6ef5f4a759f43acca859a9391c26 (diff)
downloadpyramid-6ce1e0cf1a141767ee0aca70786c15dd993347c5.tar.gz
pyramid-6ce1e0cf1a141767ee0aca70786c15dd993347c5.tar.bz2
pyramid-6ce1e0cf1a141767ee0aca70786c15dd993347c5.zip
add more index markers
Diffstat (limited to 'docs/narr/sessions.rst')
-rw-r--r--docs/narr/sessions.rst24
1 files changed, 23 insertions, 1 deletions
diff --git a/docs/narr/sessions.rst b/docs/narr/sessions.rst
index 365ee395b..6ff9e3dea 100644
--- a/docs/narr/sessions.rst
+++ b/docs/narr/sessions.rst
@@ -15,6 +15,9 @@ implementations :app:`Pyramid` provides out of the box, how to store and
retrieve data from sessions, and two session-specific features: flash
messages, and cross-site request forgery attack prevention.
+.. index::
+ single: session factory (default)
+
.. _using_the_default_session_factory:
Using The Default Session Factory
@@ -65,6 +68,9 @@ application by using the ``session_factory`` argument to the
the server) for anything but the most basic of applications where "session
security doesn't matter".
+.. index::
+ single: session object
+
Using a Session Object
----------------------
@@ -137,6 +143,7 @@ Some gotchas:
.. index::
single: pyramid_beaker
single: Beaker
+ single: session factory (alternates)
.. _using_alternate_session_factories:
@@ -153,7 +160,7 @@ based sessions, and encrypted cookie-based sessions. See
``pyramid_beaker``.
.. index::
- single: session factory
+ single: session factory (custom)
Creating Your Own Session Factory
---------------------------------
@@ -184,6 +191,9 @@ log messages for single-time display without having direct access to an HTML
template. The user interface consists of a number of methods of the
:term:`session` object.
+.. index::
+ single: session.flash
+
Using the ``session.flash`` Method
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -222,6 +232,9 @@ The ``allow_duplicate`` argument defaults to ``True``. If this is
``False``, and you attempt to add a message value which is already
present in the queue, it will not be added.
+.. index::
+ single: session.pop_flash
+
Using the ``session.pop_flash`` Method
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -255,6 +268,9 @@ been popped.
>>> request.session.pop_flash()
[]
+.. index::
+ single: session.peek_flash
+
Using the ``session.peek_flash`` Method
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -298,6 +314,9 @@ post. To use CSRF token support, you must enable a :term:`session factory`
as described in :ref:`using_the_default_session_factory` or
:ref:`using_alternate_session_factories`.
+.. index::
+ single: session.get_csrf_token
+
Using the ``session.get_csrf_token`` Method
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -330,6 +349,9 @@ input field named ``csrf_token``:
if token != request.POST['csrf_token']:
raise ValueError('CSRF token did not match')
+.. index::
+ single: session.new_csrf_token
+
Using the ``session.new_csrf_token`` Method
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~