Package twisted :: Package web :: Module twcgi :: Class CGIScript
[frames | no frames]

Class CGIScript

Collection --+            
             |            
   Constrained --+        
                 |        
  ConfigCollection --+    
                     |    
              Resource --+
                         |
                        CGIScript

Known Subclasses:
FilteredScript

I represent a CGI script.

My implementation is complex due to the fact that it requires asynchronous IPC with an external process with an unpleasant protocol.
Method Summary
  __init__(self, filename, registry)
Initialize, with the name of a CGI script file.
  render(self, request)
Do various things to conform to the CGI specification.
  runProcess(self, env, request, qargs)
    Inherited from Resource
  delEntity(self, name)
Remove a static reference for 'name'.
  getChild(self, path, request)
Retrieve a 'child' resource from me.
  getChildForRequest(self, request)
(internal) Get a child of mine dependant on a particular request.
  getChildWithDefault(self, path, request)
Retrieve a static or dynamically generated child resource from me.
  getDynamicEntity(self, name, request)
Subclass this to generate an entity on demand.
  getStaticEntity(self, name)
Get an entity that was added to me using putEntity.
  listDynamicEntities(self, request)
A list of all name, entity that I can generate on demand.
  listDynamicNames(self)
Retrieve a list of the names of entities that I store references to.
  listEntities(self)
  listNames(self)
  listStaticEntities(self)
Retrieve a list of all name, entity pairs that I store references to.
  listStaticNames(self)
Retrieve a list of the names of entities that I store references to.
  putChild(self, path, child)
Register a static child.
  reallyPutEntity(self, name, entity)
    Inherited from ConfigCollection
  entityConstraint(self, entity)
A method that determines whether an entity may be added to me.
  getEntityType(self)
  getNameType(self)
    Inherited from Constrained
  nameConstraint(self, name)
A method that determines whether an entity may be added to me with a given name.
  putEntity(self, name, entity)
Store an entity if it meets both constraints.
    Inherited from Collection
  getEntity(self, name, request)
Retrieve an entity from me.
  removeEntity(self, name, request)
Remove an entity for 'name', based on the content of 'request'.
  storeEntity(self, name, request)
Store an entity for 'name', based on the content of 'request'.

Class Variable Summary
int isLeaf = 1                                                                     
    Inherited from Resource
tuple __implements__ = (<class twisted.web.resource.IResource ...
NoneType server = None                                                                  

Method Details

__init__(self, filename, registry=None)
(Constructor)

Initialize, with the name of a CGI script file.
Overrides:
twisted.web.resource.Resource.__init__

render(self, request)

Do various things to conform to the CGI specification.

I will set up the usual slew of environment variables, then spin off a process.
Overrides:
twisted.web.resource.Resource.render

Class Variable Details

isLeaf

Type:
int
Value:
1                                                                     

Generated by Epydoc 2.0 on Sat Sep 13 04:20:51 2003 http://epydoc.sf.net