Home       Trees       Index       Help   
Package twisted :: Package web :: Module twcgi :: Class CGIScript
[show private | hide private]
[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.
  delEntity(self, name)
Remove a static reference for 'name'. (inherited from Resource)
  entityConstraint(self, entity)
A method that determines whether an entity may be added to me. (inherited from ConfigCollection)
  getChild(self, path, request)
Retrieve a 'child' resource from me. (inherited from Resource)
  getChildForRequest(self, request)
(internal) Get a child of mine dependant on a particular request. (inherited from Resource)
  getChildWithDefault(self, path, request)
Retrieve a static or dynamically generated child resource from me. (inherited from Resource)
  getDynamicEntity(self, name, request)
Subclass this to generate an entity on demand. (inherited from Resource)
  getEntity(self, name, request)
Retrieve an entity from me. (inherited from Collection)
  getEntityType(self)
(inherited from ConfigCollection)
  getNameType(self)
(inherited from ConfigCollection)
  getStaticEntity(self, name)
Get an entity that was added to me using putEntity. (inherited from Resource)
  listDynamicEntities(self, request)
A list of all name, entity that I can generate on demand. (inherited from Resource)
  listDynamicNames(self)
Retrieve a list of the names of entities that I store references to. (inherited from Resource)
  listEntities(self)
(inherited from Resource)
  listNames(self)
(inherited from Resource)
  listStaticEntities(self)
Retrieve a list of all name, entity pairs that I store references to. (inherited from Resource)
  listStaticNames(self)
Retrieve a list of the names of entities that I store references to. (inherited from Resource)
  nameConstraint(self, name)
A method that determines whether an entity may be added to me with a given name. (inherited from Constrained)
  putChild(self, path, child)
Register a static child. (inherited from Resource)
  putEntity(self, name, entity)
Store an entity if it meets both constraints. (inherited from Constrained)
  reallyPutEntity(self, name, entity)
(inherited from Resource)
  removeEntity(self, name, request)
Remove an entity for 'name', based on the content of 'request'. (inherited from Collection)
  render(self, request)
Do various things to conform to the CGI specification.
  runProcess(self, env, request, qargs)
  storeEntity(self, name, request)
Store an entity for 'name', based on the content of 'request'. (inherited from Collection)

Class Variable Summary
int isLeaf

Method Details

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

Initialize, with the name of a CGI script file.

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.

Class Variable Details

isLeaf

Type:
int
Value:
1

   Home       Trees       Index       Help   
Generated by Epydoc 1.1 on Fri Jun 27 03:49:04 2003 http://epydoc.sf.net