WebKit.PlugIn
index
/var/www/docs/Webware-1.1.1/WebKit/PlugIn.py

 
Modules
       
os
sys

 
Classes
       
__builtin__.object
PlugIn
exceptions.Exception(exceptions.BaseException)
PlugInError

 
class PlugIn(__builtin__.object)
    Template for Webware Plug-ins.
 
A plug-in is a software component that is loaded by WebKit in order to
provide additional WebKit functionality without necessarily having to modify
WebKit's source. The most infamous plug-in is PSP (Python Server Pages)
which ships with Webware.
 
Plug-ins often provide additional servlet factories, servlet subclasses,
examples and documentation. Ultimately, it is the plug-in author's choice
as to what to provide and in what manner.
 
Instances of this class represent plug-ins which are ultimately Python
packages (see the Python Tutorial, 6.4: "Packages" at
http://docs.python.org/tut/node8.html#SECTION008400000000000000000).
 
A plug-in must also be a Webware component which means that it will have
a Properties.py file advertising its name, version, requirements, etc.
You can ask a plug-in for its properties().
 
The plug-in/package must have an __init__.py while must contain a function:
    def InstallInWebKit(appServer):
This function is invoked to take whatever actions are needed to plug the
new component into WebKit. See PSP for an example.
 
If you ask an AppServer for its plugIns(), you will get a list of instances
of this class.
 
The path of the plug-in is added to sys.path, if it's not already there.
This is convenient, but we may need a more sophisticated solution in the
future to avoid name collisions between plug-ins.
 
Note that this class is hardly ever subclassed. The software in the
plug-in package is what provides new functionality and there is currently
no way to tell AppServer to use custom subclasses of this class on a
case-by-case basis (and so far there is currently no need).
 
Instructions for invoking:
    p = PlugIn(self, '../Foo') # 'self' is typically AppServer. It gets passed to InstallInWebKit()
    willNotLoadReason = plugIn.load()
    if willNotLoadReason:
        print '    Plug-in %s cannot be loaded because:
%s' % (path, willNotLoadReason)
        return None
    p.install()
    # Note that load() and install() could raise exceptions. You should expect this.
 
  Methods defined here:
__init__(self, appServer, path)
Initializes the plug-in with basic information.
 
This lightweight constructor does not access the file system.
directory(self)
Return the directory in which the plug-in resides. Example: '..'
docs(self)
docsContext(self)
examplePages(self)
examplePagesContext(self)
hasDocs(self)
hasExamplePages(self)
install(self)
Install plug-in by invoking its required InstallInWebKit function.
load(self)
Loads the plug-in into memory, but does not yet install it.
 
Will return None on success, otherwise a message (string) that says
why the plug-in could not be loaded.
module(self)
Return the Python module object of the plug-in.
name(self)
Return the name of the plug-in. Example: 'Foo'
path(self)
Return the full path of the plug-in. Example: '../Foo'
properties(self)
Return the properties.
 
This is a dictionary-like object, of the plug-in which comes
from its Properties.py file. See MiscUtils.PropertiesObject.py.
serverSidePath(self, path=None)
setUpDocContext(self)
Add a context for the documentation.
setUpExamplePages(self)
Add a context for the examples.

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

 
class PlugInError(exceptions.Exception)
    Plug-in error.
 
 
Method resolution order:
PlugInError
exceptions.Exception
exceptions.BaseException
__builtin__.object

Data descriptors defined here:
__weakref__
list of weak references to the object (if defined)

Methods inherited from exceptions.Exception:
__init__(...)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature

Data and other attributes inherited from exceptions.Exception:
__new__ = <built-in method __new__ of type object>
T.__new__(S, ...) -> a new object with type S, a subtype of T

Methods inherited from exceptions.BaseException:
__delattr__(...)
x.__delattr__('name') <==> del x.name
__getattribute__(...)
x.__getattribute__('name') <==> x.name
__getitem__(...)
x.__getitem__(y) <==> x[y]
__getslice__(...)
x.__getslice__(i, j) <==> x[i:j]
 
Use of negative indices is not supported.
__reduce__(...)
__repr__(...)
x.__repr__() <==> repr(x)
__setattr__(...)
x.__setattr__('name', value) <==> x.name = value
__setstate__(...)
__str__(...)
x.__str__() <==> str(x)
__unicode__(...)

Data descriptors inherited from exceptions.BaseException:
__dict__
args
message