Package cherrypy :: Module _cptools :: Class SessionTool
[hide private]
[frames] | no frames]

Class SessionTool

source code

object --+    
         |    
      Tool --+
             |
            SessionTool

Session Tool for CherryPy.

sessions.locking
    When 'implicit' (the default), the session will be locked for you,
    just before running the page handler.
    
    When 'early', the session will be locked before reading the request
    body. This is off by default for safety reasons; for example,
    a large upload would block the session, denying an AJAX
    progress meter (see http://www.cherrypy.org/ticket/630).
    
    When 'explicit' (or any other value), you need to call
    cherrypy.session.acquire_lock() yourself before using
    session data.

Instance Methods [hide private]
 
__init__(self)
x.__init__(...) initializes x; see help(type(x)) for signature
source code
 
_lock_session(self) source code
 
_setup(self)
Hook this tool into cherrypy.request.
source code
 
regenerate(self)
Drop the current session and make a new one (with a new id).
source code

Inherited from Tool: __call__

Inherited from Tool (private): _get_on, _merged_args, _set_on, _setargs

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Class Variables [hide private]

Inherited from Tool: namespace

Properties [hide private]

Inherited from Tool: on

Inherited from object: __class__

Method Details [hide private]

__init__(self)
(Constructor)

source code 

x.__init__(...) initializes x; see help(type(x)) for signature

Overrides: object.__init__
(inherited documentation)

_setup(self)

source code 

Hook this tool into cherrypy.request.

The standard CherryPy request object will automatically call this method when the tool is "turned on" in config.

Overrides: Tool._setup