summaryrefslogtreecommitdiff
path: root/docs/api
diff options
context:
space:
mode:
authorChris McDonough <chrism@plope.com>2010-10-28 22:40:16 -0400
committerChris McDonough <chrism@plope.com>2010-10-28 22:40:16 -0400
commit04ebd572a92f6681209c70c42192775c63cd16cd (patch)
treecc4d492b9b8eba207d3fd8309846d16495f52423 /docs/api
parent96820957ac659d51d79b1b30c296f98c086ee878 (diff)
downloadpyramid-04ebd572a92f6681209c70c42192775c63cd16cd.tar.gz
pyramid-04ebd572a92f6681209c70c42192775c63cd16cd.tar.bz2
pyramid-04ebd572a92f6681209c70c42192775c63cd16cd.zip
sessioning docs
Diffstat (limited to 'docs/api')
-rw-r--r--docs/api/interfaces.rst4
-rw-r--r--docs/api/request.rst8
-rw-r--r--docs/api/session.rst9
3 files changed, 21 insertions, 0 deletions
diff --git a/docs/api/interfaces.rst b/docs/api/interfaces.rst
index 7193fd11b..2bf55474e 100644
--- a/docs/api/interfaces.rst
+++ b/docs/api/interfaces.rst
@@ -25,3 +25,7 @@ Other Interfaces
.. autointerface:: IRoutePregenerator
+ .. autointerface:: ISession
+
+ .. autointerface:: ISessionFactory
+
diff --git a/docs/api/request.rst b/docs/api/request.rst
index e53028b0f..9e851ba8d 100644
--- a/docs/api/request.rst
+++ b/docs/api/request.rst
@@ -85,3 +85,11 @@
of ``request.exception`` will be ``None`` within response and
finished callbacks.
+ .. attribute:: session
+
+ If a :term:`session factory` has been configured, this attribute
+ will represent the current user's :term:`session` object. If a
+ session factory *has not* been configured, requesting the
+ ``request.session`` attribute will cause a
+ :class:`pyramid.exceptions.ConfigurationError` to be raised.
+
diff --git a/docs/api/session.rst b/docs/api/session.rst
new file mode 100644
index 000000000..daed9fc33
--- /dev/null
+++ b/docs/api/session.rst
@@ -0,0 +1,9 @@
+.. _session_module:
+
+:mod:`pyramid.session`
+---------------------------
+
+.. automodule:: pyramid.session
+
+ .. autofunction:: InsecureCookieSessionFactoryConfig
+