WebKit.SessionStore | index /usr/local/share/webware/WebKit/SessionStore.py

Modules
`` |  |
WebUtils | os | sys | time

Classes
`` |  | WebKit.Object.Object(__builtin__.object, MiscUtils.NamedValueAccess.NamedValueAccess) SessionStore
class SessionStore(WebKit.Object.Object)
`` | `A general session store. SessionStores are dictionary-like objects used by Application to store session state. This class is abstract and it's up to the concrete subclass to implement several key methods that determine how sessions are stored (such as in memory, on disk or in a database). Subclasses often encode sessions for storage somewhere. In light of that, this class also defines methods encoder(), decoder() and setEncoderDecoder(). The encoder and decoder default to the load() and dump() functions of the cPickle or pickle module. However, using the setEncoderDecoder() method, you can use the functions from marshal (if appropriate) or your own encoding scheme. Subclasses should use encoder() and decoder() (and not pickle.load() and pickle.dump()). Subclasses may rely on the attribute self._app to point to the application. Subclasses should be named SessionFooStore since Application expects "Foo" to appear for the "SessionStore" setting and automatically prepends Session and appends Store. Currently, you will also need to add another import statement in Application.py. Search for SessionStore and you'll find the place. TO DO * Should there be a check-in/check-out strategy for sessions to prevent concurrent requests on the same session? If so, that can probably be done at this level (as opposed to pushing the burden on various subclasses).`
| Method resolution order: SessionStore WebKit.Object.Object __builtin__.object MiscUtils.NamedValueAccess.NamedValueAccess Methods defined here: __delitem__(self, key) `Delete an item. Subclasses are responsible for expiring the session as well. Something along the lines of: sess = self[key] if not sess.isExpired(): sess.expiring()` __getitem__(self, key) __init__(self, app) `Subclasses must invoke super.` __len__(self) __repr__(self) __setitem__(self, key, item) application(self) cleanStaleSessions(self, task=None) `Clean stale sessions. Called by the Application to tell this store to clean out all sessions that have exceeded their lifetime.` clear(self) decoder(self) encoder(self) get(self, key, default=None) has_key(self, key) items(self) keys(self) setEncoderDecoder(self, encoder, decoder) setdefault(self, key, default) storeAllSessions(self) storeSession(self, session) values(self) Methods inherited from WebKit.Object.Object: deprecated(self, method) `Output a deprecation warning. The implementation of WebKit sometimes invokes this method which prints a warning that the method you are using has been deprecated. This method expects that deprecated methods say so at the beginning of their doc string and terminate that msg with @. For example: DEPRECATED: Class.foo() on 01/24/01 in ver 0.5. Use Class.bar() instead. @ Putting this information in the doc string is important for accuracy in the generated docs. Example call: deprecated(self.foo)` Data and other attributes inherited from WebKit.Object.Object: __dict__ = <dictproxy object> `dictionary for instance variables (if defined)` __weakref__ = <attribute '__weakref__' of 'Object' objects> `list of weak references to the object (if defined)` Methods inherited from MiscUtils.NamedValueAccess.NamedValueAccess: hasValueForKey(self, key) `Returns true if the key is available, although that does not guarantee that there will not be errors caused by retrieving the key.` hasValueForName(self, keysString) resetKeyBindings(self) setValueForKey(self, key, value) `Suppose key is 'foo'. This method sets the value with the following precedence: 1. Public attributes before private attributes 2. Methods before non-methods More specifically, this method then uses one of the following: @@ 2000-03-04 ce: fill in ...or invokes handleUnknownSetKey().` valueForKey(self, key, default=<class MiscUtils.NoDefault>) `Suppose key is 'foo'. This method returns the value with the following precedence: 1. Methods before non-methods 2. Public attributes before private attributes More specifically, this method then returns one of the following: * foo() * _foo() * self.foo * self._foo ...or default, if it was specified, otherwise invokes and returns result of valueForUnknownKey(). Note that valueForUnknownKey(), normally returns an exception. See valueForName() which is a more advanced version of this method that allows multiple, qualified keys.` valueForKeySequence(self, listOfKeys, default=None) valueForName(self, keysString, default=None) `Returns the value for the given keysString. This is the more advanced version of valueForKey(), which can only handle single names. This method can handle 'foo', 'foo1.foo2', 'a.b.c.d', etc. It will traverse dictionaries if needed.` valueForUnknownKey(self, key, default) `# Errors` valuesForNames(self, keys, default=None, defaults=None, forgive=0, includeNames=0) `Returns a list of values that match the given keys, each of which is passed through valueForName() and so could be of the form 'a.b.c'. keys is a sequence. default is any kind of object. defaults is a sequence. forgive and includeNames is a flag. If default is not None, then it is substituted when a key is not found. Otherwise, if defaults is not None, then it's corresponding/parallel value for the current key is substituted when a key is not found. Otherwise, if forgive=1, then unknown keys simply don't produce any values. Otherwise, if default and defaults are None, and forgive=0, then the unknown keys will probably raise an exception through valueForUnknownKey() although that method can always return a final, default value. if keys is None, then None is returned. If keys is an empty list, then None is returned. Often these last four arguments are specified by key. Examples: names = ['origin.x', 'origin.y', 'size.width', 'size.height'] obj.valuesForNames(names) obj.valuesForNames(names, default=0.0) obj.valuesForNames(names, defaults=[0.0, 0.0, 100.0, 100.0]) obj.valuesForNames(names, forgive=0) @@ 2000-03-04 ce: includeNames is only supported when forgive=1. It should be supported for the other cases. It should be documented. It should be included in the test cases.`

Functions
`` |  | StringIO(...) `StringIO([s]) -- Return a StringIO-like stream for reading or writing`