Package twisted :: Package coil :: Module coil
[show private | hide private]
[frames | no frames]

Module twisted.coil.coil

Twisted COIL: COnfiguration ILlumination.

An end-user direct-manipulation interface to Twisted, accessible through the web.

This is a work in progress.
Classes
CollectionWrapper Wrap an existing roots.Collection as a IConfigCollection.
ConfigCollection A default implementation of IConfigCollection.
Configurator A configurator object implementing default behaviour.
DispenserStorage A mini-database of dispensers.
ICollection A collection for coil.
IConfigCollection A coil collection to which objects can be added.
IConfigurator A configurator object.
IStaticCollection A coil collection to which we can't add items.
StaticCollection A roots.Locked that implement IStaticCollection.

Exceptions
InvalidConfiguration I am is raised in the case of an invalid configuration.

Function Summary
  createConfigurable(configurableClass, container, name)
Instantiate a configurable.
  getCollection(obj)
Get an object implementing ICollection for obj.
  getConfigurator(obj)
Get an object implement IConfigurator for obj.
  getConfiguratorClass(klass)
Return an IConfigurator class for given class.
  getConfiguratorsForTree(root)
Return iterator of Configurators for a config tree.
  getImplementors(interface)
Return list of registered classes that implement an interface.
  hasFactory(configurableClass)
Check if factory is available for this class.
  registerConfigurator(configuratorClass, factory)
Register a configurator for a class.
  registerFactory(configurableClass, factory)
Register a factory for a class.

Variable Summary
dict factories
dict interfaceImplementors

Function Details

createConfigurable(configurableClass, container, name)

Instantiate a configurable.

First, I will find the factory for class configurableClass. Then I will call it, with 'container' and 'name' as arguments.

getCollection(obj)

Get an object implementing ICollection for obj.

getConfigurator(obj)

Get an object implement IConfigurator for obj.

getConfiguratorClass(klass)

Return an IConfigurator class for given class.

getConfiguratorsForTree(root)

Return iterator of Configurators for a config tree.

This really ought to be implemented as a generator.

getImplementors(interface)

Return list of registered classes that implement an interface.

hasFactory(configurableClass)

Check if factory is available for this class.

registerConfigurator(configuratorClass, factory=None)

Register a configurator for a class.

registerFactory(configurableClass, factory)

Register a factory for a class.

Variable Details

factories

Type:
dict
Value:
{<class twisted.web.static.File at 0x10244d30>: <function staticFactor\
y at 0x103b9f50>,
 <class twisted.manhole.telnet.ShellFactory at 0x103b02e0>: <function \
factory at 0x103bb988>,
 <class twisted.protocols.ftp.FTPFactory at 0x103b9c88>: <function fac\
tory at 0x104f2b08>,
 <class twisted.web.proxy.ReverseProxyResource at 0x103b9f18>: <functi\
on proxyFactory at 0x1051b740>,
...                                                                    

interfaceImplementors

Type:
dict
Value:
{<class twisted.internet.interfaces.IProtocolFactory at 0x10265b98>: [\
<class twisted.protocols.ftp.FTPFactory at 0x103b9c88>,
                                                                      \
<class twisted.protocols.portforward.ProxyFactory at 0x10425f08>,
                                                                      \
<class twisted.protocols.socks.SOCKSv4Factory at 0x10404758>,
                                                                      \
<class twisted.manhole.telnet.ShellFactory at 0x103b02e0>,
...                                                                    

Generated by Epydoc 1.2 prerelease on Wed Jan 29 06:25:31 2003 http://epydoc.sf.net