From 89dc4659eedfe75bada6d131722fbb00f1bbc49f Mon Sep 17 00:00:00 2001 From: Michael Merickel Date: Thu, 27 Feb 2014 16:23:56 -0500 Subject: improve timeout docs --- pyramid/session.py | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-) diff --git a/pyramid/session.py b/pyramid/session.py index 3a045b91b..9fe2add60 100644 --- a/pyramid/session.py +++ b/pyramid/session.py @@ -192,14 +192,17 @@ def BaseCookieSessionFactory( ``timeout`` A number of seconds of inactivity before a session times out. If - ``None`` then the cookie never expires. Default: 1200. + ``None`` then the cookie never expires. This lifetime only applies + to the *value* within the cookie. Meaning that if the cookie expires + due to a lower ``max_age``, then this setting has no effect. + Default: ``1200``. ``reissue_time`` The number of seconds that must pass before the cookie is automatically reissued as the result of a request which accesses the session. The duration is measured as the number of seconds since the last session cookie was issued and 'now'. If this value is ``0``, a new cookie - will be reissued on every request accesses the session. If ``None`` + will be reissued on every request accessing the session. If ``None`` then the cookie's lifetime will never be extended. A good rule of thumb: if you want auto-expired cookies based on @@ -548,14 +551,17 @@ def SignedCookieSessionFactory( ``timeout`` A number of seconds of inactivity before a session times out. If - ``None`` then the cookie never expires. Default: 1200. + ``None`` then the cookie never expires. This lifetime only applies + to the *value* within the cookie. Meaning that if the cookie expires + due to a lower ``max_age``, then this setting has no effect. + Default: ``1200``. ``reissue_time`` The number of seconds that must pass before the cookie is automatically - reissued as the result of a request which accesses the session. The + reissued as the result of accessing the session. The duration is measured as the number of seconds since the last session cookie was issued and 'now'. If this value is ``0``, a new cookie - will be reissued on every request accesses the session. If ``None`` + will be reissued on every request accessing the session. If ``None`` then the cookie's lifetime will never be extended. A good rule of thumb: if you want auto-expired cookies based on -- cgit v1.2.3