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

Modules

``

WebUtils | os | re | sys

Classes

``

WebKit.Object.Object(__builtin__.object, MiscUtils.NamedValueAccess.NamedValueAccess)
  Session
exceptions.Exception
  SessionError

class Session(WebKit.Object.Object)

``

`Implementation of client sessions.
All methods that deal with time stamps, such as creationTime(),
treat time as the number of seconds since January 1, 1970.
Session identifiers are stored in cookies. Therefore, clients
must have cookies enabled.
Unlike Response and Request, which have HTTP subclass versions
(e.g., HTTPRequest and HTTPResponse respectively), Session does
not. This is because there is nothing protocol specific in
Session. (Is that true considering cookies? @@ 2000-04-09 ce)
2000-04-27 ce: With regards to ids/cookies, maybe the notion
of a session id should be part of the interface of a Request.
Note that the session id should be a string that is valid
as part of a filename. This is currently true, and should
be maintained if the session id generation technique is
modified. Session ids can be used in filenames.
FUTURE
* invalidate()
* Sessions don't actually time out and invalidate themselves.
* Should this be called 'HTTPSession'?
* Should "numTransactions" be exposed as a method? Should it
be common to all transaction objects that do the
awake()-respond()-sleep() thing? And should there be an
abstract super class to codify that?
`

Method resolution order:
  Session
  WebKit.Object.Object
  __builtin__.object
  MiscUtils.NamedValueAccess.NamedValueAccess

Methods defined here:

__delitem__(self, name)

__getitem__(self, name)

__init__(self, trans, identifier=None)

__setitem__(self, name, value)

awake(self, trans)
  `Let the session awake.
  Invoked during the beginning of a transaction, giving a Session an
  opportunity to perform any required setup. The default implementation
  updates the 'lastAccessTime'.`

creationTime(self)
  `Return the time when this session was created.`

delValue(self, name)

expiring(self)
  `Let the session expire.
  Called when session is expired by the application.
  Subclasses should invoke super.
  Session store __delitem__()s should invoke if not isExpired().`

hasValue(self, name)

identifier(self)
  `Return a string that uniquely identifies the session.
  This method will create the identifier if needed.`

invalidate(self)
  `Invalidate the session.
  It will be discarded the next time it is accessed.`

isExpired(self)
  `Check whether the session has been previously expired.
  See also: expiring()`

isNew(self)
  `Check whether the session is new.`

lastAccessTime(self)
  `Get last access time.
  Returns the last time the user accessed the session through
  interaction. This attribute is updated in awake(), which is
  invoked at the beginning of a transaction.`

respond(self, trans)
  `Let the session respond to a request.
  The default implementation does nothing, but could do something
  in the future. Subclasses should invoke super.`

sessionEncode(self, url)
  `Encode the session ID as a parameter to a url.`

setTimeout(self, timeout)
  `Set the timeout on this session in seconds.`

setValue(self, name, value)

sleep(self, trans)
  `Let the session sleep again.
  Invoked during the ending of a transaction, giving a Session an
  opportunity to perform any required shutdown. The default
  implementation does nothing, but could do something in the future.
  Subclasses should invoke super.`

timeout(self)
  `Return the timeout for this session in seconds.`

value(self, name, default=<class MiscUtils.NoDefault>)

values(self)

writeExceptionReport(self, handler)

Data and other attributes defined here:

exceptionReportAttrNames = ['lastAccessTime', 'isExpired', 'numTrans', 'timeout', 'values']

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.`

class SessionError(exceptions.Exception)

``

Methods inherited from exceptions.Exception:

__getitem__(...)

__init__(...)

__str__(...)

Functions

``

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

localtime(...)
  `localtime([seconds]) -> (tm_year,tm_mon,tm_day,tm_hour,tm_min,tm_sec,tm_wday,tm_yday,tm_isdst)
  Convert seconds since the Epoch to a time tuple expressing local time.
  When 'seconds' is not passed in, convert the current time instead.`

time(...)
  `time() -> floating point number
  Return the current time in seconds since the Epoch.
  Fractions of a second may be present if the system clock provides them.`