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

Modules

``

WebUtils WebKit.ImportSpy | os sys | threading time |

Classes

``

WebKit.Object.Object(__builtin__.object, MiscUtils.NamedValueAccess.NamedValueAccess)
  ServletFactory
    PythonServletFactory

class PythonServletFactory(ServletFactory)
`` | `The factory for Python servlets. This is the factory for ordinary Python servlets whose extensions are empty or .py. The servlets are unique per file since the file itself defines the servlet.`

Method resolution order:
  PythonServletFactory
  ServletFactory
  WebKit.Object.Object
  __builtin__.object
  MiscUtils.NamedValueAccess.NamedValueAccess

Methods defined here:

extensions(self)

loadClass(self, transaction, path)

uniqueness(self)

Methods inherited from ServletFactory:

__init__(self, application)
  `Create servlet factory.
  Stores a reference to the application in self._app, because
  subclasses may or may not need to talk back to the application
  to do their work.`

flushCache(self)
  `Flush the servlet cache and start fresh.
  Servlets that are currently in the wild may find their way back
  into the cache (this may be a problem).`

importAsPackage(self, transaction, serverSidePathToImport)
  `Import requested module.
  Imports the module at the given path in the proper package/subpackage
  for the current request. For example, if the transaction has the URL
  http://localhost/WebKit.cgi/MyContextDirectory/MySubdirectory/MyPage
  and path = 'some/random/path/MyModule.py' and the context is configured
  to have the name 'MyContext' then this function imports the module at
  that path as MyContext.MySubdirectory.MyModule . Note that the context
  name may differ from the name of the directory containing the context,
  even though they are usually the same by convention.
  Note that the module imported may have a different name from the
  servlet name specified in the URL. This is used in PSP.`

name(self)
  `Return the name of the factory.
  This is a convenience for the class name.`

returnServlet(self, trans, servlet)
  `Return servlet to the pool.
  Called by Servlet.close(), which returns the servlet
  to the servlet pool if necessary.`

servletForTransaction(self, transaction)
  `Return a new servlet that will handle the transaction.
  This method handles caching, and will call loadClass(trans, filepath)
  if no cache is found. Caching is generally controlled by servlets
  with the canBeReused() and canBeThreaded() methods.`

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 ServletFactory(WebKit.Object.Object)

``

`Servlet factory template.
ServletFactory is an abstract class that defines the protocol for
all servlet factories.
Servlet factories are used by the Application to create servlets
for transactions.
A factory must inherit from this class and override uniqueness(),
extensions() and either loadClass() or servletForTransaction().
Do not invoke the base class methods as they all raise AbstractErrors.
Each method is documented below.
`

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

Methods defined here:

__init__(self, application)
  `Create servlet factory.
  Stores a reference to the application in self._app, because
  subclasses may or may not need to talk back to the application
  to do their work.`

extensions(self)
  `Return a list of extensions that match this handler.
  Extensions should include the dot. An empty string indicates a file
  with no extension and is a valid value. The extension '.*' is a special
  case that is looked for a URL's extension doesn't match anything.`

flushCache(self)
  `Flush the servlet cache and start fresh.
  Servlets that are currently in the wild may find their way back
  into the cache (this may be a problem).`

importAsPackage(self, transaction, serverSidePathToImport)
  `Import requested module.
  Imports the module at the given path in the proper package/subpackage
  for the current request. For example, if the transaction has the URL
  http://localhost/WebKit.cgi/MyContextDirectory/MySubdirectory/MyPage
  and path = 'some/random/path/MyModule.py' and the context is configured
  to have the name 'MyContext' then this function imports the module at
  that path as MyContext.MySubdirectory.MyModule . Note that the context
  name may differ from the name of the directory containing the context,
  even though they are usually the same by convention.
  Note that the module imported may have a different name from the
  servlet name specified in the URL. This is used in PSP.`

loadClass(self, transaction, path)
  `Load the appropriate class.
  Given a transaction and a path, load the class for creating these
  servlets. Caching, pooling, and threadsafeness are all handled by
  servletForTransaction. This method is not expected to be threadsafe.`

name(self)
  `Return the name of the factory.
  This is a convenience for the class name.`

returnServlet(self, trans, servlet)
  `Return servlet to the pool.
  Called by Servlet.close(), which returns the servlet
  to the servlet pool if necessary.`

servletForTransaction(self, transaction)
  `Return a new servlet that will handle the transaction.
  This method handles caching, and will call loadClass(trans, filepath)
  if no cache is found. Caching is generally controlled by servlets
  with the canBeReused() and canBeThreaded() methods.`

uniqueness(self)
  `Return uniqueness type.
  Returns a string to indicate the uniqueness of the ServletFactory's
  servlets. The Application needs to know if the servlets are unique
  per file, per extension or per application.
  Return values are 'file', 'extension' and 'application'.
  NOTE: Application only supports 'file' uniqueness at this point in time.`

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`

iskeyword = __contains__(...)
  `x.__contains__(y) <==> y in x.`