Class Session

source code

 object --+        
          |        
       dict --+    
              |    
storage.Storage --+
                  |
                 Session

Defines the session object and the default values of its members (None)

- session_storage_type   : 'file', 'db', or 'cookie'
- session_cookie_compression_level :
- session_cookie_expires : cookie expiration
- session_cookie_key     : for encrypted sessions in cookies
- session_id             : a number or None if no session
- session_id_name        :
- session_locked         :
- session_masterapp      :
- session_new            : a new session obj is being created
- session_hash           : hash of the pickled loaded session
- session_pickled        : picked session

if session in cookie:

- session_data_name      : name of the cookie for session data

if session in db:

- session_db_record_id
- session_db_table
- session_db_unique_key

if session in file:

- session_file
- session_filename

Used in models, allows to customize Session handling

Args:
    request: the request object
    response: the response object
    db: to store/retrieve sessions in db (a table is created)
    tablename(str): table name
    masterapp(str): points to another's app sessions. This enables a
        "SSO" environment among apps
    migrate: passed to the underlying db
    separate: with True, creates a folder with the 2 initials of the
        session id. Can also be a function, e.g. ::

            separate=lambda(session_name): session_name[-2:]

    check_client: if True, sessions can only come from the same ip
    cookie_key(str): secret for cookie encryption
    cookie_expires: sets the expiration of the cookie
    compression_level(int): 0-9, sets zlib compression on the data
        before the encryption