lemon.external.Cheetah.Tools.CGITemplate.CGITemplate

Package lemon :: Package external :: Package Cheetah :: Package Tools :: Module CGITemplate :: Class CGITemplate

[show private | hide private]

Class CGITemplate

       BaseServlet --+        
                     |        
               Servlet --+    
                         |    
_SettingsCollector --+   |    
                     |   |    
       SettingsManager --+    
                         |    
         WebInputMixin --+    
                         |    
                  Template --+
                             |
                            CGITemplate

Methods useful in CGI scripts.

Any class that inherits this mixin must also inherit Cheetah.Servlet.

Method Summary
	`cgiHeaders(self)` Outputs the CGI headers if this is a CGI script.
	`cgiHeadersHook(self)` Override if you want to customize the CGI headers.
	`isCgi(self)` Is this a CGI script?...
Inherited from Template
	`__init__(self, source, searchList, file, settings, filter, filtersLib, errorCatcher, compilerSettings, **KWs)` Reads in the template definition, sets up the namespace searchList, processes settings, then compiles.
	`compile(self, source, file, moduleName, mainMethodName)` Compile the template.
	`errorCatcher(self)` Return a reference to the current errorCatcher...
	`generatedClassCode(self)` Return the class code the compiler generated, or None if no compilation took place.
	`generatedModuleCode(self)` Return the module code the compiler generated, or None if no compilation took place.
	`getFileContents(self, path)` A hook for getting the contents of a file.
	`getVar(self, varName, default, autoCall)` Get a variable from the searchList.
	`hasVar(self, varName, autoCall)` Test if a variable name exists in the searchList.
	`refreshCache(self, cacheKey)` Refresh a cache item.
	`runAsMainProgram(self)` Allows enable the Template to function as a standalone command-line program for static page generation.
	`searchList(self)` Return a reference to the searchlist...
	`shutdown(self)` Break reference cycles before discarding a servlet.
	`varExists(self, varName, autoCall)` Test if a variable name exists in the searchList.
	`_bindCompiledMethod(self, methodCompiler)` Called by the Compiler class, to add new methods at runtime as the compilation process proceeds.
	`_bindFunctionAsMethod(self, function)` Used to dynamically bind a plain function as a method of the Template instance.
	`_genTmpFilename(self)` Generate a temporary file name.
	`_impModFromDummyPackage(self, packageName, pathToImport)` Imports a python .py module as if it were part of the package given by 'packageName'.
	`_importAsDummyModule(self, contents)` Used by the Compiler to do correct importing from Cheetah templates when the template is compiled via the Template class' interface rather than via 'cheetah compile'.
	`_importModuleFromDirectory(self, fullModuleName, moduleName, directory, isPackageDir, forceReload)` Imports the given module from the given directory.
	`_includeCheetahSource(self, srcArg, trans, includeFrom, raw, _includeID)` This is the method that #include directives translate into.
	`_makeDummyPackageForDir(self, dirName)` Returns a Python Package that thinks it came from 'dirName'.
Inherited from SettingsManager
	`copySettings(self)` Returns a shallow copy of the settings dictionary...
	`deepcopySettings(self)` Returns a deep copy of the settings dictionary...
	`getConfigString(self)` Return a string with the settings in .ini file format.
	`hasSetting(self, key)` True/False...
	`setSetting(self, name, value)` Set a setting in self._settings.
	`setting(self, name, default)` Get a setting from self._settings, with or without a default value.
	`settings(self)` Return a reference to the settings dictionary...
	`updateSettings(self, newSettings, merge)` Update the settings with a selective merge or a complete overwrite.
	`updateSettingsFromConfigFile(self, path, **kw)` Update the settings from a text file using the syntax accepted by Python's standard ConfigParser module (like Windows .ini files).
	`updateSettingsFromConfigFileObj(self, inFile, convert, merge)` See the docstring for .updateSettingsFromConfigFile() The caller of this method is responsible for closing the inFile file object.
	`updateSettingsFromConfigStr(self, configStr, convert, merge)` See the docstring for .updateSettingsFromConfigFile()...
	`updateSettingsFromPySrcFile(self, path, merge)` Update the settings from variables in a Python source file.
	`updateSettingsFromPySrcStr(self, theString, merge)` Update the settings from a code in a Python src string.
	`writeConfigFile(self, path)` Write all the settings that can be represented as strings to an .ini style config file.
	`_createConfigFile(self, outFile)` Write all the settings that can be represented as strings to an .ini style config string.
	`_defaultSettings(self)`
	`_initializeSettings(self)` A hook that allows for complex setting initialization sequences that involve references to 'self' or other settings.
Inherited from _SettingsCollector
	`_getAllAttrsFromContainer(self, container)` Extract all the attributes of a SettingsContainer subclass.
	`_isContainer(self, thing)` Check if 'thing' is a Python module or a subclass of SettingsContainer.
	`normalizePath(self, path)` A hook for any neccessary path manipulations.
	`readSettingsFromConfigFile(self, path, convert)`
	`readSettingsFromConfigFileObj(self, inFile, convert)` Return the settings from a config file that uses the syntax accepted by Python's standard ConfigParser module (like Windows .ini files).
	`readSettingsFromContainer(self, container, ignoreUnderscored)` Returns all settings from a SettingsContainer or Python module.
	`readSettingsFromModule(self, container, ignoreUnderscored)` Returns all settings from a SettingsContainer or Python module.
	`readSettingsFromPySrcFile(self, path)` Return new settings dict from variables in a Python source file.
	`readSettingsFromPySrcStr(self, theString)` Return a dictionary of the settings in a Python src string.
Inherited from Servlet
	`__str__(self, trans)`
	`awake(self, transaction)`
	`respond(self, trans)`
	`serverSidePath(self, path, normpath, abspath)`
	`sleep(self, transaction)`
Inherited from WebInputMixin
	`webInput(self, names, namesMulti, default, src, defaultInt, defaultFloat, badInt, badFloat, debug)` Import web transaction variables in bulk.

Class Variable Summary
Inherited from Template
`list`	`_legalKWs` = `['_globalSetVars', '_preBuiltSearchList']`
Inherited from _SettingsCollector
`lock`	`_sysPathLock` = `<thread.lock object at 0x008AD180>`
Inherited from Servlet
`NoneType`	`application` = None
`NoneType`	`request` = None
`NoneType`	`session` = None
`NoneType`	`transaction` = None
Inherited from BaseServlet
`int`	`_reusable` = 1
`int`	`_threadSafe` = 0

Method Details

cgiHeaders(self)

Outputs the CGI headers if this is a CGI script.

Usage:  $cgiHeaders#slurp
Override .cgiHeadersHook() if you want to customize the headers.

cgiHeadersHook(self)

Override if you want to customize the CGI headers.

isCgi(self)

Is this a CGI script?

Generated by Epydoc 2.0 on Mon Nov 10 15:07:55 2003

http://epydoc.sf.net