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

Modules

``

WebUtils | os | sys | time

Classes

``

WebKit.Message.Message(WebKit.Object.Object)
  Request

class Request(WebKit.Message.Message)

``

`The abstract request class.
Request is a type of Message that offers the following:
* A time stamp (indicating when the request was made)
* An input stream. @@ 2000-04-30 ce: resolve this
* Remote request information (address, name)
* Local host information (address, name, port)
* A security indicator
Request is an abstract class; developers typically use HTTPRequest.
FUTURE
* Consider if the local host information should be moved up to Message.
* Locales
* Secure requests, authentication, etc.
`

Method resolution order:
  Request
  WebKit.Message.Message
  WebKit.Object.Object
  __builtin__.object
  MiscUtils.NamedValueAccess.NamedValueAccess

Methods defined here:

__init__(self)
  `Subclasses are responsible for invoking super and initializing self._time.`

clearTransaction(self)

input(self)
  `Return a file-style object that the contents can be read from.
  # @@ 2000-05-03 ce: This is bogus. Disregard for now.`

isSecure(self)
  `Check whether this is a secure channel.
  Returns true if request was made using a secure channel,
  such as HTTPS. This currently always returns false,
  since secure channels are not yet supported.`

localAddress(self)
  `Get local address.
  Returns a string containing the Internet Protocol (IP) address
  of the local host (e.g., the server) that received the request.`

localName(self)
  `Get local name.
  Returns the fully qualified name of the local host (e.g., the server)
  that received the request.`

localPort(self)
  `Get local port.
  Returns the port of the local host (e.g., the server)
  that received the request.`

remoteAddress(self)
  `Get the remote address.
  Returns a string containing the Internet Protocol (IP) address
  of the client that sent the request.`

remoteName(self)
  `Get the remote name.
  Returns the fully qualified name of the client that sent the request,
  or the IP address of the client if the name cannot be determined.`

time(self)

timeStamp(self)
  `Return time() as a human readable string, useful for logging and debugging.`

Methods inherited from WebKit.Message.Message:

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

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)

Data and other attributes inherited from WebKit.Message.Message:

exceptionReportAttrNames = ['args']

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`

asctime(...)
  `asctime([tuple]) -> string
  Convert a time tuple to a string, e.g. 'Sat Jun 06 16:26:11 1998'.
  When the time tuple is not present, current time as returned by localtime()
  is used.`

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