Ńň
ha-Kc
@ sá d Z d d Z d d d !Z d d k Z d d k l Z l Z l Z l Z d d k l Z d d k
Z
d d k Z e Z
e Z d
d d d
d d d g Z e e
i d p e e
i d d n d
e f d YZ d Z d Z d Z d Z d Z e d Z e d Z e d Z d d Z e d d Z e d d Z! d Z" y8 d d k# l Z l Z l Z l Z l Z l! Z! e Z$ Wn
e Z$ n Xd! d% d" YZ% d# Z& e' d$ j o e& n d S(& s This module supports Cheetah's optional NameMapper syntax.
Overview
================================================================================
NameMapper provides a simple syntax for accessing Python data structures,
functions, and methods from Cheetah. It's called NameMapper because it 'maps'
simple 'names' in Cheetah templates to possibly more complex syntax in Python.
Its purpose is to make working with Cheetah easy for non-programmers.
Specifically, non-programmers using Cheetah should NOT need to be taught (a)
what the difference is between an object and a dictionary, (b) what functions
and methods are, and (c) what 'self' is. A further aim (d) is to buffer the
code in Cheetah templates from changes in the implementation of the Python data
structures behind them.
Consider this scenario:
You are building a customer information system. The designers with you want to
use information from your system on the client's website --AND-- they want to
understand the display code and so they can maintian it themselves.
You write a UI class with a 'customers' method that returns a dictionary of all
the customer objects. Each customer object has an 'address' method that returns
the a dictionary with information about the customer's address. The designers
want to be able to access that information.
Using PSP, the display code for the website would look something like the
following, assuming your servlet subclasses the class you created for managing
customer information:
<%= self.customer()[ID].address()['city'] %> (42 chars)
Using Cheetah's NameMapper syntax it could be any of the following:
$self.customers()[$ID].address()['city'] (39 chars)
--OR--
$customers()[$ID].address()['city']
--OR--
$customers()[$ID].address().city
--OR--
$customers()[$ID].address.city
--OR--
$customers()[$ID].address.city
--OR--
$customers[$ID].address.city (27 chars)
Which of these would you prefer to explain to the designers, who have no
programming experience? The last form is 15 characters shorter than the PSP
and, conceptually, is far more accessible. With PHP or ASP, the code would be
even messier than the PSP
This is a rather extreme example and, of course, you could also just implement
'$getCustomer($ID).city' and obey the Law of Demeter (search Google for more on that).
But good object orientated design isn't the point here.
Details
================================================================================
The parenthesized letters below correspond to the aims in the second paragraph.
DICTIONARY ACCESS (a)
---------------------
NameMapper allows access to items in a dictionary using the same dotted notation
used to access object attributes in Python. This aspect of NameMapper is known
as 'Unified Dotted Notation'.
For example, with Cheetah it is possible to write:
$customers()['kerr'].address() --OR-- $customers().kerr.address()
where the second form is in NameMapper syntax.
This only works with dictionary keys that are also valid python identifiers:
regex = '[a-zA-Z_][a-zA-Z_0-9]*'
AUTOCALLING (b,d)
-----------------
NameMapper automatically detects functions and methods in Cheetah $vars and calls
them if the parentheses have been left off.
For example if 'a' is an object, 'b' is a method
$a.b
is equivalent to
$a.b()
If b returns a dictionary, then following variations are possible
$a.b.c --OR-- $a.b().c --OR-- $a.b()['c']
where 'c' is a key in the dictionary that a.b() returns.
Further notes:
* NameMapper autocalls the function or method without any arguments. Thus
autocalling can only be used with functions or methods that either have no
arguments or have default values for all arguments.
* NameMapper only autocalls functions and methods. Classes and callable object instances
will not be autocalled.
* Autocalling can be disabled using Cheetah's 'useAutocalling' setting.
LEAVING OUT 'self' (c,d)
------------------------
NameMapper makes it possible to access the attributes of a servlet in Cheetah
without needing to include 'self' in the variable names. See the NAMESPACE
CASCADING section below for details.
NAMESPACE CASCADING (d)
--------------------
...
Implementation details
================================================================================
* NameMapper's search order is dictionary keys then object attributes
* NameMapper.NotFound is raised if a value can't be found for a name.
Performance and the C version
================================================================================
Cheetah comes with both a C version and a Python version of NameMapper. The C
version is significantly faster and the exception tracebacks are much easier to
read. It's still slower than standard Python syntax, but you won't notice the
difference in realistic usage scenarios.
Cheetah uses the optimized C version (_namemapper.c) if it has
been compiled or falls back to the Python version if not.
Meta-Data
================================================================================
Authors: Tavis Rudd ,
Chuck Esterbrook
Version: $Revision: 1.32 $
Start Date: 2001/04/03
Last Revision Date: $Date: 2007/12/10 19:20:09 $
s" Tavis Rudd ,s)
Chuck Esterbrook s $Revision: 1.32 $i iţ˙˙˙i˙˙˙˙N( t
StringTypet InstanceTypet ClassTypet TypeType( t pformatt NotFoundt hasKeyt valueForKeyt valueForNamet valueFromSearchListt valueFromFrameOrSearchListt valueFromFramet get_suffixesc C s d g S( s .pyt Ui ( s .pyR
i ( ( ( ( s8 /usr/lib64/python2.6/site-packages/Cheetah/NameMapper.pyt Ś s c B s e Z RS( ( t __name__t
__module__( ( ( s8 /usr/lib64/python2.6/site-packages/Cheetah/NameMapper.pyR s c C s9 d | } t o | d t | 7} n t | d S( Ns cannot find '%s's in the namespace %s( t. _INCLUDE_NAMESPACE_REPR_IN_NOTFOUND_EXCEPTIONSR R ( t keyt namespacet excString( ( s8 /usr/lib64/python2.6/site-packages/Cheetah/NameMapper.pyt _raiseNotFoundException° s
c C su t p nd | i d } | i d d j o= | d | 7} t o | d t | 7} n | f | _ n d S( Ni s while searchingi˙˙˙˙s while searching for '%s's in the namespace %s( t& _ALLOW_WRAPPING_OF_NOTFOUND_EXCEPTIONSt argst findR R ( t exct fullNameR t excStr( ( s8 /usr/lib64/python2.6/site-packages/Cheetah/NameMapper.pyt _wrapNotFoundExceptionś s
c C s t | t t f j o t St | d oc t | d o t St | d p t | d p t | d o t St | d o t Sn t S( Nt __class__t mrot im_funct func_codet __self__t __init__( t typeR R t Truet hasattrt False( t obj( ( s8 /usr/lib64/python2.6/site-packages/Cheetah/NameMapper.pyt _isInstanceOrClass s 0 c C s? t | d o | | j o t St | | o t St Sd S( s Determine if 'obj' has 'key' t has_keyN( R% R$ R& ( R' R ( ( s8 /usr/lib64/python2.6/site-packages/Cheetah/NameMapper.pyR Ô s
c C sU t | d o | | j o | | St | | o t | | St | | d S( NR) ( R% t getattrR ( R' R ( ( s8 /usr/lib64/python2.6/site-packages/Cheetah/NameMapper.pyR Ý s
c C sÓ | i d } x˝ t t | D]Š } | | } t | d o | | j o | | } n7 y t | | } Wn t j
o t | | n X| o+ t | d o t | o
| } q" | } q" W| S( Nt .R) t __call__( t splitt ranget lenR% R* t AttributeErrorR R( ( R' t namet executeCallablest
nameChunkst iR t nextObj( ( s8 /usr/lib64/python2.6/site-packages/Cheetah/NameMapper.pyt
_valueForNameĺ s
%
c C sF y t | | | SWn+ t j
o } t | d | d | n Xd S( NR R ( R6 R R ( R' R1 R2 t e( ( s8 /usr/lib64/python2.6/site-packages/Cheetah/NameMapper.pyR ÷ s c C sY | i d d } x2 | D]* } t | | o t | | d | Sq Wt | | d S( NR+ i R2 ( R- R R6 R ( t
searchListR1 R2 R R ( ( s8 /usr/lib64/python2.6/site-packages/Cheetah/NameMapper.pyR ý s c c s: | i V| o x | D] } | Vq Wn | i Vt Vd S( N( t f_localst f_globalst __builtins__( t callerFrameR8 R ( ( s8 /usr/lib64/python2.6/site-packages/Cheetah/NameMapper.pyt _namespaces s
c s f d } zu | p t i d d } n i d d } x/ t | D] t | o | Sq] Wt | Wd ~ Xd S( Nc sI y t d SWn+ t j
o } t | d d n Xd S( NR2 R R ( R6 R R ( R7 ( R1 R8 R2 R ( s8 /usr/lib64/python2.6/site-packages/Cheetah/NameMapper.pyt __valueForName s i i R+ ( t inspectt stackR- R= R R ( R8 R1 R2 t frameR> R ( ( R1 R8 R2 R s8 /usr/lib64/python2.6/site-packages/Cheetah/NameMapper.pyR
s c C sM zB | p t i d d } n t d d d | d | d | SWd ~ Xd S( Ni i R8 R1 R2 RA ( R? R@ R
t None( R1 R2 RA ( ( s8 /usr/lib64/python2.6/site-packages/Cheetah/NameMapper.pyR s c C sX | i d d } t | | p t Sy t | | t SWn t j
o t SXd S( s" Determine if 'obj' has the 'name' R+ i N( R- R R& R R$ R ( R' R1 R ( ( s8 /usr/lib64/python2.6/site-packages/Cheetah/NameMapper.pyt hasName- s
( R R R R R
R t Mixinc B s e Z d Z d Z d Z RS( s @@ document mec C s
t | | S( N( R ( t selfR1 ( ( s8 /usr/lib64/python2.6/site-packages/Cheetah/NameMapper.pyR E s c C s
t | | S( N( R ( RE R ( ( s8 /usr/lib64/python2.6/site-packages/Cheetah/NameMapper.pyR H s ( R R t __doc__R R ( ( ( s8 /usr/lib64/python2.6/site-packages/Cheetah/NameMapper.pyRD C s c C s d t f d Y} d | f d Y} | } d | _ d d } h | d 6| i d 6d
d 6h | i d 6d
6| _ d } t | i d
GHt | d GHt t d GHt t d GHt t d GHt t d d t GHt t d d t GHd S( Nt Ac B s2 e Z d Z d d Z d d Z d d Z RS( s classVar vals method 1 default argc S s | S( N( ( RE t arg( ( s8 /usr/lib64/python2.6/site-packages/Cheetah/NameMapper.pyt methodQ s s meth 2 default argc S s h | d 6S( Nt item1( ( RE RH ( ( s8 /usr/lib64/python2.6/site-packages/Cheetah/NameMapper.pyt method2T s s meth 3 defaultc S s | S( N( ( RE RH ( ( s8 /usr/lib64/python2.6/site-packages/Cheetah/NameMapper.pyt method3W s ( R R t classVarRI RK RL ( ( ( s8 /usr/lib64/python2.6/site-packages/Cheetah/NameMapper.pyRG O s t Bc B s e Z d Z RS( s
classBvar val( R R t classBvar( ( ( s8 /usr/lib64/python2.6/site-packages/Cheetah/NameMapper.pyRN Z s t valueForOnet defaultc S s# h d d 6d d 6d d 6} | | S( Ns default outputRQ s output option onet ones output option twot two( ( t whichOnet values( ( s8 /usr/lib64/python2.6/site-packages/Cheetah/NameMapper.pyt function_ s
t funcRI t itemvalt itemt nestedMethodt subDicts this is local bs dic.itemt bt dirs
a.classVars
a.dic.funcR2 s a.method2.item1( RD RR RL t dicR R t varsR; R$ ( RG RN t aRV R\ ( ( s8 /usr/lib64/python2.6/site-packages/Cheetah/NameMapper.pyt exampleN s$
t __main__( (( RF t
__author__t __revision__t typesR R R R t pprintR R? t pdbR& R R$ R t __all__R% t impt setattrt LookupErrorR R R R( R R R6 R R RB R= R
R RC t _namemappert C_VERSIONRD Ra R ( ( ( s8 /usr/lib64/python2.6/site-packages/Cheetah/NameMapper.pyt sT
" .
)