ha-Kc - @ si d Z d d k Z d d k Z d d k Z d d k Z d d k Z d d k Z d d k Z d d k l
Z
d d k Z d d k Z d d k
Z
d d k Z d d k Z d d k Z d d k Z d d k l Z l Z y d d k l Z Wn% e j
o e i e i f Z n Xy d d k l Z Wn& e j
o d f d YZ n Xy
e Z Wn# e j
o d d k l Z n Xd d
k l Z l Z d d k l! Z! d d k" l# Z# d d
k$ l% Z% l& Z& d d k' l( Z( l) Z) d d k* l+ Z+ d d k* l, Z, d d k- l. Z. d d k/ l0 Z0 d d k1 l2 Z2 d d k3 l4 Z4 l5 Z5 d d k6 l7 Z7 l8 Z8 d d k9 l: Z: d d k; l< Z< l= Z= l> Z> d d k? l@ Z@ eA ZB d ZC d eD f d YZE d eE f d YZF d ZG d ZH d ZI eJ aK d! ZL d" eM f d# YZN d$ eM f d% YZO d& e# f d' YZP eP ZQ e eR eP eP _S d( ZT d S() sw
Provides the core API for Cheetah.
See the docstring in the Template class and the Users' Guide for more information
iN( t randrange( t
StringTypet ClassType( t StringTypes( t LockR c B s e Z d Z d Z RS( c C s d S( N( ( t self( ( s6 /usr/lib64/python2.6/site-packages/Cheetah/Template.pyt acquire" s c C s d S( N( ( R ( ( s6 /usr/lib64/python2.6/site-packages/Cheetah/Template.pyt release$ s ( t __name__t
__module__R R ( ( ( s6 /usr/lib64/python2.6/site-packages/Cheetah/Template.pyR ! s ( t Set( t convertVersionStringToTuplet MinCompatibleVersionTuple( t MinCompatibleVersion( t Servlet( t
ParseErrort SourceReader( t Compilert DEFAULT_COMPILER_SETTINGS( t
ErrorCatchers( t Filters( t convertTmplPathToModuleName( t
checkKeywords( t Indenter( t NotFoundt valueFromSearchList( t MemoryCacheStoret MemcachedCacheStore( t CacheRegion( t
_Convertert _lookupt NonNumericInputError( t Unspecifiedc C s | t d e* e d3 Z? e d4 Z@ e@ ZA e e e e e e e d5 ZB d6 ZC d7 ZD e e d& e2 e e e e d8 ZE e e e* e e d9 ZF e d: e d; ZG d< ZH f d= d> d? d@ d? d@ e dA ZI RS(B sW
This class provides a) methods used by templates at runtime and b)
methods for compiling Cheetah source code into template classes.
This documentation assumes you already know Python and the basics of object
oriented programming. If you don't know Python, see the sections of the
Cheetah Users' Guide for non-programmers. It also assumes you have read
about Cheetah's syntax in the Users' Guide.
The following explains how to use Cheetah from within Python programs or via
the interpreter. If you statically compile your templates on the command
line using the 'cheetah' script, this is not relevant to you. Statically
compiled Cheetah template modules/classes (e.g. myTemplate.py:
MyTemplateClasss) are just like any other Python module or class. Also note,
most Python web frameworks (Webware, Aquarium, mod_python, Turbogears,
CherryPy, Quixote, etc.) provide plugins that handle Cheetah compilation for
you.
There are several possible usage patterns:
1) tclass = Template.compile(src)
t1 = tclass() # or tclass(namespaces=[namespace,...])
t2 = tclass() # or tclass(namespaces=[namespace2,...])
outputStr = str(t1) # or outputStr = t1.aMethodYouDefined()
Template.compile provides a rich and very flexible API via its
optional arguments so there are many possible variations of this
pattern. One example is:
tclass = Template.compile('hello $name from $caller', baseclass=dict)
print tclass(name='world', caller='me')
See the Template.compile() docstring for more details.
2) tmplInstance = Template(src)
# or Template(src, namespaces=[namespace,...])
outputStr = str(tmplInstance) # or outputStr = tmplInstance.aMethodYouDefined(...args...)
Notes on the usage patterns:
usage pattern 1)
This is the most flexible, but it is slightly more verbose unless you
write a wrapper function to hide the plumbing. Under the hood, all
other usage patterns are based on this approach. Templates compiled
this way can #extend (subclass) any Python baseclass: old-style or
new-style (based on object or a builtin type).
usage pattern 2)
This was Cheetah's original usage pattern. It returns an instance,
but you can still access the generated class via
tmplInstance.__class__. If you want to use several different
namespace 'searchLists' with a single template source definition,
you're better off with Template.compile (1).
Limitations (use pattern 1 instead):
- Templates compiled this way can only #extend subclasses of the
new-style 'object' baseclass. Cheetah.Template is a subclass of
'object'. You also can not #extend dict, list, or other builtin
types.
- If your template baseclass' __init__ constructor expects args there
is currently no way to pass them in.
If you need to subclass a dynamically compiled Cheetah class, do something like this:
from Cheetah.Template import Template
T1 = Template.compile('$meth1 #def meth1: this is meth1 in T1')
T2 = Template.compile('#implements meth1
this is meth1 redefined in T2', baseclass=T1)
print T1, T1()
print T2, T2()
Note about class and instance attribute names:
Attributes used by Cheetah have a special prefix to avoid confusion with
the attributes of the templates themselves or those of template
baseclasses.
Class attributes which are used in class methods look like this:
klass._CHEETAH_useCompilationCache (_CHEETAH_xxx)
Instance attributes look like this:
klass._CHEETAH__globalSetVars (_CHEETAH__xxx with 2 underscores)
t _initCheetahInstancet
searchListt errorCatchert getVart varExistst getFileContentst i18nt runAsMainProgramt respondt shutdownt webInputt serverSidePatht generatedClassCodet generatedModuleCodet _getCacheStoret _getCacheStoreIdPrefixt _createCacheRegiont getCacheRegiont getCacheRegionst refreshCachet _handleCheetahIncludet2 _getTemplateAPIClassForIncludeDirectiveCompilationt subclasst cacheRegionClasst
cacheStoret cacheStoreIdPrefixt cacheStoreClasst" DynamicallyCompiledCheetahTemplatec C s | i S( N( t _CHEETAH_compilerClass( RQ RR RS ( ( s6 /usr/lib64/python2.6/site-packages/Cheetah/Template.pyt _getCompilerClass= s c C s | i S( N( t _CHEETAH_compilerSettings( RQ RR RS ( ( s6 /usr/lib64/python2.6/site-packages/Cheetah/Template.pyt _getCompilerSettingsA s c ) B s d } e | e i e f o e | d d f n e | e i e e i f o e | d d f n | e j o
| i } n e | e o
| i } n e | e i e e i
e i f o e | d d f n | e j o
| i } n e | e
e f o e | d d f n | e j o
| i } n e | e
e f o e | d
d f n | e j o | i | | p h } n e | e o e | d d f n | e j o | i | | } n |
e j o
| i }
n | e j o
| i } n e | e
e f o e | d
d f n e | e i e f o e | d d f n e } | o: | o
e | e o e | } | } n
| i } n | e j o
| i } n e | e i e f o e | d d f n e i d d | p | } | e j o
| i } n e | e i e f o e | d d f n |
e j o
| i }
n | e j o
| i } n e | e
e f o e | d d f n | e j o
| i } n e | e i e f o e | d d f n |
o% | } | i | | |
\ } } n e } e } | oQ e | e o
| } n4 e | e i
e i f o d | i } | } n n e } e } | p
e | e oe } | o e! | } n e } |
o e! |
} n e } | oD e" e# | } e$ d o | e" e% i& i' | 7} n n yj d i( g } e# | | | | | e# | e# | | | e# | g
D] } | e" | q~ } Wn n Xn d } e } | o | o
| | i) j o | i) | } | i* } nr | | | d | d | d | d | d | p h } | o | i+ | i, n | i- | i. } | i/ } | oU | d j o6 | i0 d } | i1 d d | d i( | } n | i2 | Sn| o e3 i3 | _4 | i5 Sn z| i6 i7 e8 | }! |! d }" | oW e% i& i9 | o e: d | n e% i& i( | |" }" e; |" d i< | n e= i> e" |! }# |
o1 x* |
i? D] \ }$ } e@ |# |$ | qWn |" |# _A | o e% i& i9 | o
| |# _B n | o | o e@ |# | | n y' e- | |" d! }% |% |# iC f d" UWn eD j
oQ }& y eE | | | d# |& }' Wn# eF |" | | |& _G |& n X|' n/ e: j
o" }& eF |" | | |& _G n X|# eH iI |! (if module, must contain subclasses of Cheetah.Filters.Filter)Rp s string, class or NonesB (if class, must be subclass of Cheetah.ErrorCatchers.ErrorCatcher)R R s- you must supply either a source string or thes& 'file' keyword argument, but not botht _CHEETAH_versionTuplesl This template was compiled with Cheetah version %s. Templates compiled before version %s must be recompiled.t prioritizeSearchListOverSelfs` The following keys are members of the Template class and will result in NameMapper collisions! s > %s s , s Please change the key's name or use the compiler setting "prioritizeSearchListOverSelf=True" to prevent the NameMapper from using s: the Template member in place of your searchList variable Ro R t _globalSetVarst _preBuiltSearchListN( s sources string or None( s files& string, file open for reading, or None( s filters string or classs6 (if class, must be subclass of Cheetah.Filters.Filter)( s
filtersLibs string or modules> (if module, must contain subclasses of Cheetah.Filters.Filter)( s errorCatchers string, class or NonesB (if class, must be subclass of Cheetah.ErrorCatchers.ErrorCatcher)( s compilerSettingss
dictionary(+ R' R R R R R R R t
issubclassR t Filtert
ModuleTypeRX R R R t ErrorCatcherR t DictTypeR Rm RO RW R8 R9 R R t __CHEETAH_version__R R t AssertionErrorR
R( t Reserved_SearchListt sett keyst gett loggingt infoR R* Rn t _compile( R RR R Ro RS R R! Rp R R$ R% R t errmsgextrat errR t compiledVersiont compiledVersionTuplet namespacet intersectiont warn( ( s6 /usr/lib64/python2.6/site-packages/Cheetah/Template.pyRO s z
'
c C s | i S( se Return the module code the compiler generated, or None if no
compilation took place.
( R ( R ( ( s6 /usr/lib64/python2.6/site-packages/Cheetah/Template.pyR{ s c C s& | i | i i d | i i d !S( sd Return the class code the compiler generated, or None if no
compilation took place.
s
class s
## END CLASS DEFINITION( R t find( R ( ( s6 /usr/lib64/python2.6/site-packages/Cheetah/Template.pyRz s c C s | i S( s- Return a reference to the searchlist
( t _CHEETAH__searchList( R ( ( s6 /usr/lib64/python2.6/site-packages/Cheetah/Template.pyRo s c C s | i S( s7 Return a reference to the current errorCatcher
( t _CHEETAH__errorCatcher( R ( ( s6 /usr/lib64/python2.6/site-packages/Cheetah/Template.pyRp s c C sD | i p3 | i d j o | i | _ q= | i | _ n | i S( N( t _CHEETAH__cacheStoret _CHEETAH_cacheStoreRX t _CHEETAH_cacheStoreClass( R ( ( s6 /usr/lib64/python2.6/site-packages/Cheetah/Template.pyR| s
c C s, | i d j o | i St t | Sd S( N( t _CHEETAH_cacheStoreIdPrefixRX R: t id( R ( ( s6 /usr/lib64/python2.6/site-packages/Cheetah/Template.pyR} s c C s( | i d | d | i d | i S( Nt regionIDt templateCacheIdPrefixR ( t _CHEETAH_cacheRegionClassR} R| ( R RC ( ( s6 /usr/lib64/python2.6/site-packages/Cheetah/Template.pyR~ s c C sE | i i | } | o' | o | i | } | | i | R? (
R Ro R R R! Rp R$ R R% t
filterNameRQ t errorCatcherClasst ec( ( s6 /usr/lib64/python2.6/site-packages/Cheetah/Template.pyRn sb
$
c C s | t j o | i | | p h } n | p | i } d | _ d | _ d | _ | oV t | t oF | i | } t
i i | | _ t
i i
| \ | _ | _ n | | _ | i | | d | d | d | d t } | | _ | i | t | d p
d | _ n d S( s Compile the template. This method is automatically called by
Template.__init__ it is provided with 'file' or 'source' args.
USERS SHOULD *NEVER* CALL THIS METHOD THEMSELVES. Use Template.compile
instead.
R R R R Rc N( R R t _CHEETAH_defaultMainMethodNameRX t
_fileMtimet _fileDirNamet
_fileBaseNameR' R Ry R R R R t _filePathR\ R R RO RW Rc ( R RR RS R R R R ( ( s6 /usr/lib64/python2.6/site-packages/Cheetah/Template.pyR3 s(
"
RS c C s | } | | i j o<| p | d j od d } t | t j oA t | d o | i | } } q t i i | } } q | } n
| } d } | i | | } | i
d | d | }
|
d | i d | i } | i
| _
| i
| _ | | i | | d j o1 t d j o t i a n d t i } } nY|
o | d j o t d n5|
o | d j o t d n|
o' | d j o d | i i } } n |
o- | d j o d | i i
i } } n | d j o d | i i } } n | d j o d
| i i } } na | d j o d | i i } } n: | d j o d | i i
i } } n
t
d | d }
h t d d | | d
6t d t | | d 6t d t | | d 6} h } x3 | D]+ } t | | t | \ } } | | | tags.
** KLUDGE: 'debug' is supposed to insert into the template output, but it
wasn't working so I changed it to a'print' statement. So the debugging
output will appear wherever standard output is pointed, whether at the
terminal, in a Webware log file, or whatever. ***
Since we didn't specify any coversions, the value is a string. It's a
'single' value because we specified it in 'names' rather than
'namesMulti'. Single values work like this:
* If one value is found, take it.
* If several values are found, choose one arbitrarily and ignore the rest.
* If no values are found, use or raise the appropriate 'default*' value.
Multi values work like this:
* If one value is found, put it in a list.
* If several values are found, leave them in a list.
* If no values are found, use the empty list ([]). The 'default*'
arguments are *not* consulted in this case.
Example: assume 'days' came from a set of checkboxes or a multiple combo
box on a form, and the user chose'Monday', 'Tuesday' and 'Thursday'.
#silent $webInput([], ['days'])
The days you chose are: #slurp
#for $day in $days
$day #slurp
#end for
dic = self.webInput([], ['days'])
write('The days you chose are: ')
for day in dic['days']:
write(day + ' ')
Both these examples print: 'The days you chose are: Monday Tuesday Thursday'.
By default, missing strings are replaced by '' and missing/bad numbers
by zero. (A'bad number' means the converter raised an exception for
it, usually because of non-numeric characters in the value.) This
mimics Perl/PHP behavior, and simplifies coding for many applications
where missing/bad values *should* be blank/zero. In those relatively
few cases where you must distinguish between empty-string/zero on the
one hand and missing/bad on the other, change the appropriate
'default*' and 'bad*' arguments to something like:
* None
* another constant value
* $NonNumericInputError/self.NonNumericInputError
* $ValueError/ValueError
(NonNumericInputError is defined in this class and is useful for
distinguishing between bad input vs a TypeError/ValueError thrown for
some other rason.)
Here's an example using multiple values to schedule newspaper
deliveries. 'checkboxes' comes from a form with checkboxes for all the
days of the week. The days the user previously chose are preselected.
The user checks/unchecks boxes as desired and presses Submit. The value
of 'checkboxes' is a list of checkboxes that were checked when Submit
was pressed. Our task now is to turn on the days the user checked, turn
off the days he unchecked, and leave on or off the days he didn't
change.
dic = self.webInput([], ['dayCheckboxes'])
wantedDays = dic['dayCheckboxes'] # The days the user checked.
for day, on in self.getAllValues():
if not on and wantedDays.has_key(day):
self.TurnOn(day)
# ... Set a flag or insert a database record ...
elif on and not wantedDays.has_key(day):
self.TurnOff(day)
# ... Unset a flag or delete a database record ...
'source' allows you to look up the variables from a number of different
sources:
'f' fields (CGI GET/POST parameters)
'c' cookies
's' session variables
'v' 'values', meaning fields or cookies
In many forms, you're dealing only with strings, which is why the
'default' argument is third and the numeric arguments are banished to
the end. But sometimes you want automatic number conversion, so that
you can do numeric comparisions in your templates without having to
write a bunch of conversion/exception handling code. Example:
#silent $webInput(['name', 'height:int'])
$name is $height cm tall.
#if $height >= 300
Wow, you're tall!
#else
Pshaw, you're short.
#end if
dic = self.webInput(['name', 'height:int'])
name = dic[name]
height = dic[height]
write('%s is %s cm tall.' % (name, height))
if height > 300:
write('Wow, you're tall!')
else:
write('Pshaw, you're short.')
To convert a value to a number, suffix ':int' or ':float' to the name.
The method will search first for a 'height:int' variable and then for a
'height' variable. (It will be called 'height' in the final
dictionary.) If a numeric conversion fails, use or raise 'badInt' or
'badFloat'. Missing values work the same way as for strings, except the
default is 'defaultInt' or 'defaultFloat' instead of 'default'.
If a name represents an uploaded file, the entire file will be read into
memory. For more sophistocated file-upload handling, leave that name
out of the list and do your own handling, or wait for
Cheetah.Utils.UploadFileMixin.
This only in a subclass that also inherits from Webware's Servlet or
HTTPServlet. Otherwise you'll get an AttributeError on 'self.request'.
EXCEPTIONS: ValueError if 'source' is not one of the stated characters.
TypeError if a conversion suffix is not ':int' or ':float'.
FUTURE EXPANSION: a future version of this method may allow source
cascading; e.g., 'vs' would look first in 'values' and then in session
variables.
Meta-Data
================================================================================
Author: Mike Orr
License: This software is released for unlimited distribution under the
terms of the MIT license. See the LICENSE file.
Version: $Revision: 1.186 $
Start Date: 2002/03/17
Last Revision Date: $Date: 2008/03/10 04:48:11 $
Rb R1 t fieldt cs# can't get cookies from a CGI scriptt ss- can't get session variables from a CGI scriptR# t sessiont cookies arg 'src' invalidt stringR R t floats
s
i ( Rb R1 N( t lowerRo t _formUsedByWebInputRX t cgit FieldStoraget getvaluet RuntimeErrort requestR# R R R R R R R R R R t pprintt pformatRo R ( R t namest
namesMultiRS RE t
defaultIntt defaultFloatt badIntt badFloatt debugt isCgiRR t funct sourcest
converterst dict nameR5 R1 ( ( s6 /usr/lib64/python2.6/site-packages/Cheetah/Template.pyRx R sR
(J R R Rl R R R R R RX R R( R R R Rs R R R R R R R R R R R R R R RL R R R R RE R R@ R? RA R R R R R\ R R R R R R R RO R{ Rz Ro Rp R| R} R~ R R R Rw Rq Rr t hasVarRt Rs Ru Rn R3 R R Rx ( ( ( s6 /usr/lib64/python2.6/site-packages/Cheetah/Template.pyRm s N 8L
N ,
c C sS t | t t f o | p d } t i } t i d | | i } t | d o
| i } n" t
t i d | i
d } | i } g } xP t d d D]? }
| |
d j o Pn | i | d |
| | |
f q Wg } xR t d d D]A }
| |
t | j p Pn | i | |
| | |
f qW| i d } | d 7} x< | o4 | i }
| d h |
d d 6|
d d
67} qfWt | d o$ | d d
| i p d d 7} n x< | o4 | i }
| d h |
d d 6|
d d
67} qWd d d d t | d | d d g } t i d | } | o; t
| i
d } t
| i
d } | i d n d } d } t i d d i | t | d d } | oH t
| i
d } t
| i
d } | i d | i d n d i | } t | d | } t | | d | d | S( Ni t linenos [ ]*File.*line (\d+)i i s Line|Python Code
sC ----|-------------------------------------------------------------
s %(row)-4d|%(line)s
t rowt linet offsett i s ^
sC Error in the Python code which Cheetah generated for this template:t =iP R s line (\d+), col (\d+)i s)
Here is the corresponding Cheetah code:
s
s(
Here is the corresponding Cheetah code.sM ** I had to guess the line & column numbers, so they are probably incorrect:
RD t col( R' R: RT RX t StringIOt tracebackt print_excR RW R R R t searcht groupRB t rangeR, RA t reverset popR R t maxR R ( RR RS t generatedPyCodeR RD t siot formatedExct pyLinenoRH t prevLinest it nextLinest reportt lineInfoRU t cheetahPosMatchR R t reader( ( s6 /usr/lib64/python2.6/site-packages/Cheetah/Template.pyR : sr #
! ' #
)$ )
#
(U Rl R8 R R R1 R t os.pathR R; t randomR t impRZ R R R R R R R R t ImportErrort UnicodeTypet threadingR R. t xt NameErrort setsR
t Cheetah.VersionR R R
t Cheetah.ServletR t Cheetah.ParserR R t Cheetah.CompilerR R t CheetahR R t# Cheetah.convertTmplPathToModuleNameR t Cheetah.Utils.MiscR t Cheetah.Utils.IndenterR t Cheetah.NameMapperR R t Cheetah.CacheStoreR R t Cheetah.CacheRegionR t Cheetah.Utils.WebInputMixinR R R t Cheetah.UnspecifiedR R R! R$ R R% R& R+ R) R? RX R RJ R RK RL Rm t Tt dirR- R ( ( ( s6 /usr/lib64/python2.6/site-packages/Cheetah/Template.pyt s
+