Cheetah package¶
Cheetah is an open source template engine and code generation tool.
It can be used standalone or combined with other tools and frameworks. Web development is its principle use, but Cheetah is very flexible and is also being used to generate C++ game code, Java, sql, form emails and even Python code.
- Homepage, issue tracker
- Documentation
Subpackages¶
- Cheetah.Macros package
- Cheetah.Templates package
- Cheetah.Tests package- Submodules- Cheetah.Tests.Analyzer module
- Cheetah.Tests.Boinker module
- Cheetah.Tests.CheetahWrapper module- CFBase- CFBase.assertPosixSubprocess()
- CFBase.assertSubprocess()
- CFBase.assertWin32Subprocess()
- CFBase.checkCompile()
- CFBase.checkFill()
- CFBase.checkNoBackup()
- CFBase.checkSubdirPyInit()
- CFBase.expectError
- CFBase.go()
- CFBase.inform()
- CFBase.locate_cheetah()
- CFBase.setUp()
- CFBase.srcDir
- CFBase.srcFiles
- CFBase.subdirs
- CFBase.tearDown()
 
- CFIdirBase
- FileDataFill
- Flat
- FlatRecurseCollision
- IdirFlatRecurseCollision
- IdirOdirRecurse
- IdirRecurse
- NoBackup
- OneFile
- OneFileNoExtension
- OneFileWithOdir
- Popen4
- RecurseExplicit
- RecurseExplicitWIthOdir
- RecurseImplicit
- SplatTmpl
- SplatTmplWithSubdirectories
- ThreeFilesWithSubdirectories
- ThreeFilesWithSubdirectoriesNoExtension
- VarietyWithOdir
- listTests()
- main()
- warn()
 
- Cheetah.Tests.Cheps module
- Cheetah.Tests.Filters module
- Cheetah.Tests.Misc module
- Cheetah.Tests.NameMapper module- DummyClass
- DummyClassGetAttrRaises
- MapBuiltins
- NameMapperTest
- VFF
- VFFSL
- VFFSL_2
- VFFSL_3
- VFFSL_4
- VFN- VFN.test1()
- VFN.test10()
- VFN.test11()
- VFN.test12()
- VFN.test13()
- VFN.test14()
- VFN.test15()
- VFN.test16()
- VFN.test17()
- VFN.test18()
- VFN.test19()
- VFN.test2()
- VFN.test20()
- VFN.test21()
- VFN.test22()
- VFN.test23()
- VFN.test24()
- VFN.test27()
- VFN.test28()
- VFN.test29()
- VFN.test3()
- VFN.test30()
- VFN.test31()
- VFN.test32()
- VFN.test33()
- VFN.test34()
- VFN.test35()
- VFN.test36()
- VFN.test37()
- VFN.test38()
- VFN.test39()
- VFN.test4()
- VFN.test40()
- VFN.test41()
- VFN.test42()
- VFN.test43()
- VFN.test44()
- VFN.test45()
- VFN.test46()
- VFN.test47()
- VFN.test48()
- VFN.test49()
- VFN.test5()
- VFN.test50()
- VFN.test51()
- VFN.test52()
- VFN.test53()
- VFN.test54()
- VFN.test55()
- VFN.test56()
- VFN.test57()
- VFN.test58()
- VFN.test59()
- VFN.test6()
- VFN.test60()
- VFN.test61()
- VFN.test7()
- VFN.test8()
- VFN.test9()
 
- VFS
- VFS_2namespaces
- VFS_3namespaces
- VFS_4namespaces
- aClass
- aFunc()
- aMeth()
- dummyFunc()
- funcThatRaises()
 
- Cheetah.Tests.Parser module
- Cheetah.Tests.Performance module
- Cheetah.Tests.Pinger module
- Cheetah.Tests.Regressions module
- Cheetah.Tests.SyntaxAndOutput module- AssertDirective
- AttrDirective
- Backslashes
- BlockDirective- BlockDirective.test1()
- BlockDirective.test10()
- BlockDirective.test11()
- BlockDirective.test12()
- BlockDirective.test13()
- BlockDirective.test14()
- BlockDirective.test15()
- BlockDirective.test2()
- BlockDirective.test3()
- BlockDirective.test4()
- BlockDirective.test5()
- BlockDirective.test6()
- BlockDirective.test7()
- BlockDirective.test8()
- BlockDirective.test9()
 
- BreakDirective
- BreakpointDirective
- CGI
- CacheDirective
- CallDirective
- CaptureDirective
- Comments_MultiLine
- Comments_MultiLine_NoGobble
- Comments_SingleLine- Comments_SingleLine.test1()
- Comments_SingleLine.test10()
- Comments_SingleLine.test11()
- Comments_SingleLine.test2()
- Comments_SingleLine.test3()
- Comments_SingleLine.test4()
- Comments_SingleLine.test5()
- Comments_SingleLine.test6()
- Comments_SingleLine.test7()
- Comments_SingleLine.test8()
- Comments_SingleLine.test9()
 
- CompilerDirective
- CompilerSettingsDirective
- ContinueDirective
- DecoratorDirective
- DefDirective- DefDirective.test1()
- DefDirective.test10()
- DefDirective.test11()
- DefDirective.test12()
- DefDirective.test13()
- DefDirective.test14()
- DefDirective.test15()
- DefDirective.test16()
- DefDirective.test17()
- DefDirective.test18()
- DefDirective.test19()
- DefDirective.test2()
- DefDirective.test3()
- DefDirective.test4()
- DefDirective.test5()
- DefDirective.test6()
- DefDirective.test7()
- DefDirective.test8()
- DefDirective.test9()
 
- DefmacroDirective
- DummyClass
- EOLSlurpToken
- EchoDirective
- EmptyTemplate
- EncodingDirective
- ErrorCatcherDirective
- ExtendsDirective
- FilterDirective
- ForDirective- ForDirective.test1()
- ForDirective.test10()
- ForDirective.test11()
- ForDirective.test12()
- ForDirective.test13()
- ForDirective.test14()
- ForDirective.test15()
- ForDirective.test16()
- ForDirective.test2()
- ForDirective.test3()
- ForDirective.test4()
- ForDirective.test5()
- ForDirective.test6()
- ForDirective.test7()
- ForDirective.test8()
- ForDirective.test9()
 
- GetVar
- I18nDirective
- IfDirective- IfDirective.test1()
- IfDirective.test10()
- IfDirective.test11()
- IfDirective.test12()
- IfDirective.test13()
- IfDirective.test14()
- IfDirective.test15()
- IfDirective.test16()
- IfDirective.test17()
- IfDirective.test18()
- IfDirective.test2()
- IfDirective.test3()
- IfDirective.test4()
- IfDirective.test5()
- IfDirective.test6()
- IfDirective.test7()
- IfDirective.test8()
- IfDirective.test9()
 
- ImportDirective
- ImportantExampleCases
- IncludeDirective- IncludeDirective.setUp()
- IncludeDirective.tearDown()
- IncludeDirective.test1()
- IncludeDirective.test10()
- IncludeDirective.test11()
- IncludeDirective.test12()
- IncludeDirective.test2()
- IncludeDirective.test3()
- IncludeDirective.test4()
- IncludeDirective.test5()
- IncludeDirective.test6()
- IncludeDirective.test7()
- IncludeDirective.test8()
- IncludeDirective.test9()
 
- Indenter
- MatchObject
- MiscComplexSyntax
- NameMapper- NameMapper.test1()
- NameMapper.test10()
- NameMapper.test11()
- NameMapper.test12()
- NameMapper.test13()
- NameMapper.test14()
- NameMapper.test15()
- NameMapper.test16()
- NameMapper.test17()
- NameMapper.test18()
- NameMapper.test19()
- NameMapper.test2()
- NameMapper.test20()
- NameMapper.test21()
- NameMapper.test3()
- NameMapper.test4()
- NameMapper.test5()
- NameMapper.test6()
- NameMapper.test7()
- NameMapper.test8()
- NameMapper.test9()
 
- NonTokens
- OutputTest
- PSP
- PassDirective
- PlaceholderStrings
- Placeholders- Placeholders.test1()
- Placeholders.test10()
- Placeholders.test11()
- Placeholders.test12()
- Placeholders.test13()
- Placeholders.test14()
- Placeholders.test15()
- Placeholders.test16()
- Placeholders.test17()
- Placeholders.test18()
- Placeholders.test19()
- Placeholders.test2()
- Placeholders.test20()
- Placeholders.test21()
- Placeholders.test3()
- Placeholders.test4()
- Placeholders.test5()
- Placeholders.test6()
- Placeholders.test7()
- Placeholders.test8()
- Placeholders.test9()
 
- Placeholders_Calls- Placeholders_Calls.test1()
- Placeholders_Calls.test10()
- Placeholders_Calls.test11()
- Placeholders_Calls.test12()
- Placeholders_Calls.test13()
- Placeholders_Calls.test14()
- Placeholders_Calls.test15()
- Placeholders_Calls.test16()
- Placeholders_Calls.test17()
- Placeholders_Calls.test18()
- Placeholders_Calls.test19()
- Placeholders_Calls.test2()
- Placeholders_Calls.test20()
- Placeholders_Calls.test21()
- Placeholders_Calls.test22()
- Placeholders_Calls.test23()
- Placeholders_Calls.test24()
- Placeholders_Calls.test25()
- Placeholders_Calls.test26()
- Placeholders_Calls.test3()
- Placeholders_Calls.test4()
- Placeholders_Calls.test5()
- Placeholders_Calls.test6()
- Placeholders_Calls.test7()
- Placeholders_Calls.test8()
- Placeholders_Calls.test9()
 
- Placeholders_Esc
- Placeholders_Vals
- RaiseDirective
- RawDirective
- RepeatDirective
- ReturnDirective
- SetDirective- SetDirective.test1()
- SetDirective.test10()
- SetDirective.test11()
- SetDirective.test12()
- SetDirective.test13()
- SetDirective.test14()
- SetDirective.test15()
- SetDirective.test16()
- SetDirective.test17()
- SetDirective.test18()
- SetDirective.test19()
- SetDirective.test2()
- SetDirective.test20()
- SetDirective.test3()
- SetDirective.test4()
- SetDirective.test5()
- SetDirective.test6()
- SetDirective.test7()
- SetDirective.test8()
- SetDirective.test9()
 
- SilentDirective
- SlurpDirective
- StopDirective
- SuperDirective
- TryDirective
- UnicodeDirective
- UnicodeStrings
- UnlessDirective
- Unspecified
- VarExists
- WhileDirective
- WhitespaceAfterDirectiveTokens
- YieldDirective
- dummyFunc()
- install_eols()
- testdecorator()
 
- Cheetah.Tests.Template module- ClassMethodSupport
- ClassMethods_compile- ClassMethods_compile.test_baseclassArg()
- ClassMethods_compile.test_basicUsage()
- ClassMethods_compile.test_classNameArg()
- ClassMethods_compile.test_compilationCache()
- ClassMethods_compile.test_keepRefToGeneratedCodeArg()
- ClassMethods_compile.test_mainMethodNameArg()
- ClassMethods_compile.test_moduleFileCaching()
- ClassMethods_compile.test_moduleGlobalsArg()
- ClassMethods_compile.test_moduleNameArg()
 
- ClassMethods_subclass
- MultipleInheritanceSupport
- OpenFileTest
- Preprocessors
- StaticMethodSupport
- SubclassSearchListTest
- TemplateTest
- TryExceptImportTest
 
- Cheetah.Tests.Test module
- Cheetah.Tests.Unicode module
- Cheetah.Tests.xmlrunner module- XMLTestProgram
- XMLTestRunner
- XMLTestRunnerTest- XMLTestRunnerTest.NullStream
- XMLTestRunnerTest.setUp()
- XMLTestRunnerTest.test_error()
- XMLTestRunnerTest.test_failure()
- XMLTestRunnerTest.test_no_tests()
- XMLTestRunnerTest.test_stderr_capture()
- XMLTestRunnerTest.test_stdout_capture()
- XMLTestRunnerTest.test_success()
- XMLTestRunnerTest.test_unittests_changing_stderr()
- XMLTestRunnerTest.test_unittests_changing_stdout()
 
- create_error()
- create_failure()
- create_success()
- main
 
 
 
- Submodules
- Cheetah.Tools package- Subpackages
- Submodules- Cheetah.Tools.CGITemplate module
- Cheetah.Tools.MondoReport module
- Cheetah.Tools.RecursiveNull module
- Cheetah.Tools.SiteHierarchy module
 
 
- Cheetah.Utils package- Submodules- Cheetah.Utils.Indenter module- IndentProcessor- IndentProcessor.ARGS
- IndentProcessor.CHAR
- IndentProcessor.DEC
- IndentProcessor.DIRECTIVE
- IndentProcessor.INC
- IndentProcessor.INDENT_DIR
- IndentProcessor.LINE_SEP
- IndentProcessor.OFF
- IndentProcessor.ON
- IndentProcessor.POP
- IndentProcessor.PUSH
- IndentProcessor.SET
- IndentProcessor.WHITESPACES
- IndentProcessor.WS
- IndentProcessor.process()
 
- Indenter
- indentize()
 
- Cheetah.Utils.Misc module
- Cheetah.Utils.WebInputMixin module
- Cheetah.Utils.htmlDecode module
- Cheetah.Utils.htmlEncode module
- Cheetah.Utils.statprof module
 
- Cheetah.Utils.Indenter module
 
- Submodules
Submodules¶
- Cheetah.CacheRegion module
- Cheetah.CacheStore module
- Cheetah.CheetahWrapper module- Bundle
- CheetahWrapper- CheetahWrapper.BACKUP_SUFFIX
- CheetahWrapper.MAKE_BACKUPS
- CheetahWrapper.chatter()
- CheetahWrapper.compile()
- CheetahWrapper.debug()
- CheetahWrapper.error()
- CheetahWrapper.fill()
- CheetahWrapper.help()
- CheetahWrapper.main()
- CheetahWrapper.options()
- CheetahWrapper.parseOpts()
- CheetahWrapper.test()
- CheetahWrapper.version()
- CheetahWrapper.warn()
 
- Error
- fprintfMessage()
- usage()
 
- Cheetah.Compiler module- AutoClassCompiler
- AutoMethodCompiler
- ClassCompiler- ClassCompiler.addAttribute()
- ClassCompiler.addChunkToInit()
- ClassCompiler.addClassDocString()
- ClassCompiler.addDecorator()
- ClassCompiler.addErrorCatcherCall()
- ClassCompiler.addSuper()
- ClassCompiler.attributes()
- ClassCompiler.classDef()
- ClassCompiler.classDocstring()
- ClassCompiler.className()
- ClassCompiler.classSignature()
- ClassCompiler.cleanupState()
- ClassCompiler.closeBlock()
- ClassCompiler.closeDef()
- ClassCompiler.methodCompilerClass
- ClassCompiler.methodCompilerClassForInit
- ClassCompiler.methodDefs()
- ClassCompiler.setBaseClass()
- ClassCompiler.setClassName()
- ClassCompiler.setMainMethodArgs()
- ClassCompiler.setMainMethodName()
- ClassCompiler.setting()
- ClassCompiler.startMethodDef()
- ClassCompiler.wrapClassDef()
 
- Compiler
- Error
- GenUtils
- MethodCompiler- MethodCompiler.addAssert()
- MethodCompiler.addBreak()
- MethodCompiler.addChunk()
- MethodCompiler.addClosure()
- MethodCompiler.addContinue()
- MethodCompiler.addDel()
- MethodCompiler.addEcho()
- MethodCompiler.addElif()
- MethodCompiler.addElse()
- MethodCompiler.addExcept()
- MethodCompiler.addFilteredChunk()
- MethodCompiler.addFinally()
- MethodCompiler.addFor()
- MethodCompiler.addIf()
- MethodCompiler.addInclude()
- MethodCompiler.addIndentingDirective()
- MethodCompiler.addMethComment()
- MethodCompiler.addMethDocString()
- MethodCompiler.addOneLineIf()
- MethodCompiler.addPSP()
- MethodCompiler.addPass()
- MethodCompiler.addPlaceholder()
- MethodCompiler.addRaise()
- MethodCompiler.addRawText()
- MethodCompiler.addReIndentingDirective()
- MethodCompiler.addRepeat()
- MethodCompiler.addReturn()
- MethodCompiler.addSet()
- MethodCompiler.addSilent()
- MethodCompiler.addStrConst()
- MethodCompiler.addTernaryExpr()
- MethodCompiler.addTry()
- MethodCompiler.addUnless()
- MethodCompiler.addWhile()
- MethodCompiler.addWriteChunk()
- MethodCompiler.addYield()
- MethodCompiler.appendToPrevChunk()
- MethodCompiler.cleanupState()
- MethodCompiler.closeFilterBlock()
- MethodCompiler.commitStrConst()
- MethodCompiler.dedent()
- MethodCompiler.docString()
- MethodCompiler.endCacheRegion()
- MethodCompiler.endCallRegion()
- MethodCompiler.endCaptureRegion()
- MethodCompiler.handleWSBeforeDirective()
- MethodCompiler.indent()
- MethodCompiler.indentation()
- MethodCompiler.isErrorCatcherOn()
- MethodCompiler.methodBody()
- MethodCompiler.methodDef()
- MethodCompiler.methodName()
- MethodCompiler.methodSignature()
- MethodCompiler.nextCacheID()
- MethodCompiler.nextCallRegionID()
- MethodCompiler.nextCaptureRegionID()
- MethodCompiler.nextFilterRegionID()
- MethodCompiler.setCallArg()
- MethodCompiler.setErrorCatcher()
- MethodCompiler.setFilter()
- MethodCompiler.setMethodName()
- MethodCompiler.setMethodSignature()
- MethodCompiler.setTransform()
- MethodCompiler.setting()
- MethodCompiler.startCacheRegion()
- MethodCompiler.startCallRegion()
- MethodCompiler.startCaptureRegion()
- MethodCompiler.turnErrorCatcherOff()
- MethodCompiler.turnErrorCatcherOn()
- MethodCompiler.wrapCode()
 
- ModuleCompiler- ModuleCompiler.addAttribute()
- ModuleCompiler.addComment()
- ModuleCompiler.addImportStatement()
- ModuleCompiler.addImportedVarNames()
- ModuleCompiler.addModuleDocString()
- ModuleCompiler.addModuleGlobal()
- ModuleCompiler.addModuleHeader()
- ModuleCompiler.addSpecialVar()
- ModuleCompiler.classCompilerClass
- ModuleCompiler.classDefs()
- ModuleCompiler.compile()
- ModuleCompiler.getModuleCode()
- ModuleCompiler.getModuleEncoding()
- ModuleCompiler.importStatements()
- ModuleCompiler.importedVarNames()
- ModuleCompiler.moduleConstants()
- ModuleCompiler.moduleDocstring()
- ModuleCompiler.moduleFooter()
- ModuleCompiler.moduleHeader()
- ModuleCompiler.parserClass
- ModuleCompiler.setBaseClass()
- ModuleCompiler.setCompilerSetting()
- ModuleCompiler.setCompilerSettings()
- ModuleCompiler.setModuleEncoding()
- ModuleCompiler.setShBang()
- ModuleCompiler.specialVars()
- ModuleCompiler.timestamp()
- ModuleCompiler.wrapModuleDef()
 
 
- Cheetah.DirectiveAnalyzer module
- Cheetah.Django module
- Cheetah.DummyTransaction module
- Cheetah.ErrorCatchers module
- Cheetah.FileUtils module
- Cheetah.Filters module
- Cheetah.ImportHooks module
- Cheetah.ImportManager module
- Cheetah.NameMapper module
- Cheetah.Parser module
- Cheetah.Servlet module
- Cheetah.SettingsManager module- ConfigParserCaseSensitive
- Error
- NoDefault
- SettingsManager- SettingsManager.copySettings()
- SettingsManager.deepcopySettings()
- SettingsManager.hasSetting()
- SettingsManager.setSetting()
- SettingsManager.setting()
- SettingsManager.settings()
- SettingsManager.updateSettings()
- SettingsManager.updateSettingsFromConfigFileObj()
- SettingsManager.updateSettingsFromConfigStr()
- SettingsManager.updateSettingsFromPySrcStr()
 
- convStringToNum()
- mergeNestedDictionaries()
- stringIsNumber()
 
- Cheetah.SourceReader module- ENCODINGsearch()
- Error
- SourceReader- SourceReader.advance()
- SourceReader.atEnd()
- SourceReader.atStart()
- SourceReader.breakPoint()
- SourceReader.checkPos()
- SourceReader.filename()
- SourceReader.find()
- SourceReader.findBOL()
- SourceReader.findEOL()
- SourceReader.getLine()
- SourceReader.getNonWhiteSpace()
- SourceReader.getRowCol()
- SourceReader.getRowColLine()
- SourceReader.getWhiteSpace()
- SourceReader.getc()
- SourceReader.gotoBookmark()
- SourceReader.hasBookmark()
- SourceReader.isLineClearToPos()
- SourceReader.lineNum()
- SourceReader.matchNonWhiteSpace()
- SourceReader.matchWhiteSpace()
- SourceReader.matches()
- SourceReader.peek()
- SourceReader.pos()
- SourceReader.read()
- SourceReader.readTo()
- SourceReader.readToEOL()
- SourceReader.rev()
- SourceReader.rfind()
- SourceReader.setBookmark()
- SourceReader.setBreakPoint()
- SourceReader.setPos()
- SourceReader.splitlines()
- SourceReader.src()
- SourceReader.startswith()
- SourceReader.ungetc()
- SourceReader.validPos()
 
 
- Cheetah.Template module- CompileCacheItem
- Error
- PreprocessError
- T
- Template- Template.NonNumericInputError
- Template.Reserved_SearchList
- Template.compile()
- Template.errorCatcher()
- Template.generatedClassCode()
- Template.generatedModuleCode()
- Template.getCacheRegion()
- Template.getCacheRegions()
- Template.getFileContents()
- Template.getVar()
- Template.hasVar()
- Template.i18n()
- Template.refreshCache()
- Template.runAsMainProgram()
- Template.searchList()
- Template.shutdown()
- Template.subclass()
- Template.varExists()
- Template.webInput()
 
- TemplatePreprocessor
- checkFileMtime()
- createMethod()
- genParserErrorFromPythonException()
- hashDict()
- hashList()
- updateLinecache()
 
- Cheetah.TemplateCmdLineIface module
- Cheetah.Unspecified module
- Cheetah.Version module
- Cheetah.compat module
- Cheetah.convertTmplPathToModuleName module