|
- Method resolution order:
- PSPServletFactory
- WebKit.ServletFactory.ServletFactory
- WebKit.Object.Object
- __builtin__.object
- MiscUtils.NamedValueAccess.NamedValueAccess
Methods defined here:
- __init__(self, application)
- clearFileCache(self)
- Clear class files stored on disk.
- computeClassName(self, pagename)
- Generates a (hopefully) unique class/file name for each PSP file.
Argument: pagename: the path to the PSP source file
Returns: a unique name for the class generated fom this PSP source file
- extensions(self)
- flushCache(self)
- Clean out the cache of classes in memory and on disk.
- loadClass(self, transaction, path)
- loadClassFromFile(self, transaction, filename, classname)
- Create an actual class instance.
The module containing the class is imported as though it were a
module within the context's package (and appropriate subpackages).
- uniqueness(self)
Methods inherited from WebKit.ServletFactory.ServletFactory:
- 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, 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 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.
|