WebKit.Response
index
/usr/local/share/webware/WebKit/Response.py

 
Modules
       
WebUtils
os
sys
time

 
Classes
       
WebKit.Message.Message(WebKit.Object.Object)
Response

 
class Response(WebKit.Message.Message)
    The abstract response class.
 
Response is a type of Message that offers the following:
 
        * @@ 2000-04-17 ce
        * ...
 
Response is an abstract class; developers typically use HTTPResponse.
 
FUTURE
        * Consider implementing the buffer/flush logic here
          including buffer size.
        * Also, consider then having a method that doesn't allow
          committment until the end.
 
 
Method resolution order:
Response
WebKit.Message.Message
WebKit.Object.Object
__builtin__.object
MiscUtils.NamedValueAccess.NamedValueAccess

Methods defined here:
__init__(self, trans, strmOut)
clearTransaction(self)
deliver(self)
endTime(self)
isCommitted(self)
recordEndTime(self)
Record the end time of the response.
 
Stores the current time as the end time of the response. This should
be invoked at the end of deliver(). It may also be invoked by the
application for those responses that never deliver due to an error.
reset(self)
streamOut(self)
write(self, string)

Methods inherited from WebKit.Message.Message:
arg(self, name, default=<class MiscUtils.NoDefault at 0x8c81d0>)
argNames(self)
Returns a list of argument names.
clearArgs(self)
contentLength(self)
Returns the length of the message body or -1 if not known.
contentType(self)
Returns the MIME type of the message body or None if not known.
deleteArg(self, name)
hasArg(self, name)
protocol(self)
Return the protocol-
 
Returns the name and version of the protocol the message uses
in the form protocol/majorVersion.minorVersion, for example, HTTP/1.1.
setArg(self, name, value)
writeExceptionReport(self, handler)

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 descriptors inherited from WebKit.Object.Object:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

Methods inherited from MiscUtils.NamedValueAccess.NamedValueAccess:
handleUnknownSetKey(self, key)
hasValueForKey(self, key)
Check whether key is available.
 
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)
Check whether name is available.
resetKeyBindings(self)
Rest all key bindings, releasing alreaedy referenced values.
setValueForKey(self, key, value)
Set value for a given key.
 
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 at 0x8c81d0>)
Get value for given key.
 
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)
Get the value for the given list of keys.
valueForName(self, keysString, default=None)
Get 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)
valuesForNames(self, keys, default=None, defaults=None, forgive=0, includeNames=0)
Get all values for given names.
 
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 and defaults are sequences.
default is any kind of object.
forgive and includeNames are flags.
 
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 is true, then unknown keys simply don't produce
any values.
Otherwise, if default and defaults are None, and forgive is false,
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