Download Install Tutorial Docs FAQ Tools WikiLicense Team IRC Planet Involvement Shop Book

Changeset 1472

Show
Ignore:
Timestamp:
12/06/06 18:25:52
Author:
fumanchu
Message:

Docstring for lib.sessions.init.

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved
  • trunk/cherrypy/lib/sessions.py

    r1454 r1472  
    411411    """Initialize session object (using cookies). 
    412412     
    413     Any additional kwargs will be bound to the new Session instance. 
     413    storage_type: one of 'ram', 'file', 'postgresql'. This will be used 
     414        to look up the corresponding class in cherrypy.lib.sessions 
     415        globals. For example, 'file' will use the FileSession class. 
     416    path: the 'path' value to stick in the response cookie metadata. 
     417    path_header: if 'path' is None (the default), then the response 
     418        cookie 'path' will be pulled from request.headers[path_header]. 
     419    name: the name of the cookie. 
     420    timeout: the expiration timeout for the cookie. 
     421    domain: the cookie domain. 
     422    secure: if False (the default) the cookie 'secure' value will not 
     423        be set. If True, the cookie 'secure' value will be set (to 1). 
     424    locking: If 'implicit' (the default), this function will lock the 
     425        session for you. If 'explicit' (or any other value), you need 
     426        to call cherrypy.session.acquire_lock() yourself before 
     427        using session data. 
     428    clean_freq (minutes): the poll rate for expired session cleanup. 
     429     
     430    Any additional kwargs will be bound to the new Session instance, 
     431    and may be specific to the storage type. See the subclass of Session 
     432    you're using for more information. 
    414433    """ 
    415434     

Hosted by WebFaction

Log in as guest/cpguest to create tickets