TJc @ sz d d k Z d d k Z d d k Z d d k l Z d d k l Z d d k l Z l Z l Z l
Z
l Z l Z d d k
l Z d d k Z d d k l Z l Z l Z l Z l Z l Z l Z l Z l Z e d d k Z d d k Td d k l Z l Z d d
d d d
d d d d g Z e i e! Z" e d e# e$ Z% e d e& e' Z( d Z) e i* d Z+ e i* d Z, d Z- e Z. d e i/ f d YZ0 e0 i1 i2 Z1 d e3 f d YZ4 e5 d d d d d d g Z6 d
e3 f d YZ7 d e7 f d YZ8 d e0 f d! YZ9 d e0 f d" YZ: e! d# j o* d d k; Z; e; i< d$ e; i= e; i> B n d S(% iN( t copy( t warn( t ifiltert countt chaint izipt islicet ifilterfalse( t isclass( t assert_bool_attrt callable_wo_argst unflatten_argst
OrderedSett
make_buncht install_frameworkt ThreadSafeDescriptort RequestLocalDescriptort LRUCache( t *( t
WidgetTypet WidgetsListt WidgetR t WidgetRepeatert RepeatedWidgett WidgetBuncht RepeatingWidgetBuncht Childt valid_idt adapt_valuet _is_initializedc s f d } | S( Nc sN t | i | d } t | t o | i o
t n | | | d S( N( t getattrt __class__t Nonet
isinstanceR t
_is_lockedt WidgetLocked( t selft kt argst
descriptor( t func( s0 /usr/lib/python2.6/site-packages/tw/core/base.pyt __setattr__, s
( ( R( R) ( ( R( s0 /usr/lib/python2.6/site-packages/tw/core/base.pyt only_if_unlocked+ s s ^[a-zA-Z][\w\-\_\:\.]*$s ^\w+$c C sX t i | o t S| d j o t St i | o t d | t d t St Sd S( Nt _methodsp The id %s will no longer be supported since it doesn't conform to the W3C Spec: http://www.w3.org/TR/xhtml1/#C_8i ( t valid_id_ret matcht Truet _deprecated_id_reR t DeprecationWarningt False( t s( ( s0 /usr/lib/python2.6/site-packages/tw/core/base.pyR 8 s
c B s e Z d Z e Z d6 Z d6 Z h d d 6d d 6d d 6Z g Z g Z
g Z e Z
e Z d Z e e d d Z d
Z e e d d Z d Z e e d d
Z d Z e e d d Z e d Z d Z e e d d Z d Z e e d d Z d6 d6 g d Z e d Z e d Z d6 d6 g d Z d Z d Z d6 e d Z d d Z e d Z! e d Z" e d Z# d! Z$ d" Z% d6 d# Z& d6 d$ Z' d6 d% Z( d& Z) e d' Z* e d( Z+ d) Z, d* Z- d+ Z. d, Z/ e0 d- Z1 e d6 d. Z2 e3 d/ Z4 e3 d0 Z5 d1 Z6 d2 Z7 d3 Z8 d4 Z9 e: d5 Z; RS(7 sD
Base class for all widgets.
Example:
.. sourcecode:: python
>>> w = Widget('foo')
>>> w.id
'foo'
>>> w = Widget('foo', children=[Widget('c1'), Widget('c2')])
>>> [c.id for c in w.children]
['foo_c1', 'foo_c2']
>>> [c.parent.id for c in w.children]
['foo', 'foo']
It is a **must** that all initial state is entirely determined by the
arguments to this function. This means that two widgets
(of the same class) that receive the same parameters
must behave in exactly the same way. You should not rely on external
sources inside __init__ to set initial state.
If you need to fetch data from external sources, do it at
:meth:`update_params` instead.
Essential pre, and post initialization is done in :meth:`__new__` and
:meth:`post_init` respectively. :meth:`post_init` is guaranteed to run after
the instance finishes initialization and it's behavior is rather special
as all post_init's in mro will be called to have a chance to set final
state in the instance.
Basic pre-initialization consists of binding all kw arguments to the
widget instance, attaching the widget to it's parent (if given),
attaching the children and copying mutable arguments listed at
:attr:`params` from the class to the instance to avoid accidental
manipulation.
.. sourcecode:: python
>>> w = Widget('foo', a=1, b=2)
>>> w.id
'foo'
>>> w.a
1
>>> w.b
2
Basic post-initialization consists of caching required CSS and JS
resources and setting the widget as initialized preventing further
modification of it's attributes.
.. sourcecode:: python
>>> w = Widget('foo', a='1', b='2')
>>> w.a = 'bar'
Traceback (most recent call last):
...
WidgetLocked: The widget is locked. It's unthread-safe to alter it's attributes after initialization.
Widget attributes can only be modified in this method because widgets
should behave in a state-less way as they are shared among threads for
multiple requests.
Per request modification of variables sent to the template should be
done inside :meth:`update_params` and all state flowing from parent to
children should occur inside that dict.
Widgets should be instantiated at import time and reused among requests,
most widgets allow overriding most of their parameters (not neccesarily all
of them) at display time to change behavior. You should try avoiding
instantiating widgets for every request as their initialization could be
quite expensive for heavily nested widgets.
Request-local storage provided by the hosting framework in
``tw.framework.request`` can be used to pass state among widgets
which don't share the same root.
s The id of this widget. This id is used to reference a widget from its parent ``children`` attribute and is usually the DOM id of outermost HTML tag of the widget.t ids Main CSS class for this widgett css_classs- A list with extra css classes for the widget.t css_classesc C s# | i o t i i S| i i Sd S( N( t is_roott twt frameworkt default_viewt parentt engine_name( R$ ( ( s0 /usr/lib/python2.6/site-packages/tw/core/base.pyt displays_on s
t docs7 Where the widget is being displayed on
c C sI d i t g } | i D] } | i o | | i q q ~ p d S( Nt _( t joint reversedt patht id_path_elemR ( R$ t _[1]t w( ( s0 /usr/lib/python2.6/site-packages/tw/core/base.pyR3 s <s The calculated id of the widget. This string will provide a unique
id for each widget in the tree in a format which allows to re-recreate
the nested structure.
Example::
>>> A = Widget("A", children=[
... Widget("B", children=[
... Widget("C")
... ])
... ])
...
>>> C = A.c.B.c.C
>>> C.id
'A_B_C'
c C sQ d d i t g } | i D] } | i o | | i q q ~ d p d S( Nt .i( R? R@ RA RB R ( R$ RC RD ( ( s0 /usr/lib/python2.6/site-packages/tw/core/base.pyt key s As A string that can be used as a key to index the dictionary of
parameters sent to the root widget so it reaches this widget when
displaying.
Example::
>>> A = Widget("A", children=[
... Widget("B", children=[
... Widget("C")
... ])
... ])
...
>>> C = A.c.B.c.C
>>> C.key
'.B.C'
c c s' | } x | o | V| i } q Wd S( N( R: ( R$ t item( ( s0 /usr/lib/python2.6/site-packages/tw/core/base.pyRA s
sI Iterates a walk from this widget to the root of the tree
c C s | i S( N( t _id( R$ ( ( s0 /usr/lib/python2.6/site-packages/tw/core/base.pyRB s c C s t | i d S( Ni( t listRA ( R$ ( ( s0 /usr/lib/python2.6/site-packages/tw/core/base.pyt root s s The root of this widget treec C s
| i d j S( N( R: R ( R$ ( ( s0 /usr/lib/python2.6/site-packages/tw/core/base.pyR6 s s( True if the widget doesn't have a parentc K s t i i | | | | | } xZ | i D]L \ } } | i d p0 y t | | | Wqw t j
o } qw Xq+ q+ W| i | _ | d j o" t
| o t d | n | | _ t
i | _ | d j o= | i o
t n t i | | _ | i i i | n t | _ | _ t | o t | t o
| } n g } | D] }
| | i |
qc~ p_ | i } t | o t | t o
| } n g } | D] }
| | i |
q~ n x t | i d d g D]h }
yL t | |
d } t! | t" t# f o t | } n t | |
| Wqt j
o qXqWg | _$ t% | _& t | d d p | i' i( i) | _* n | S( si
Takes care of Widget instances creation. Should not need to be overrien
likely.
R> s! %r is not a valid id for a Widgett csst
javascriptR4 N(+ t viewt
Renderablet __new__t iteritemst
startswitht setattrt AttributeErrorR t orig_kwR R t
ValueErrorRH t serial_generatort nextt _serialR t WidgetInitializedt weakreft proxyR: t childrent appendR t cR t
issubclassR t
_append_childt
_cls_childrenR t paramsR R! RI t dictt _js_callsR t
_resourcesR t __name__t lowerR4 ( t clsR3 R: R\ t kwt objR% t vt eRC R^ t cls_childrent _[2]t namet attr( ( s0 /usr/lib/python2.6/site-packages/tw/core/base.pyRO sP
+
, c O s+ t | i | i d | i | i | | S( s
Returns a cloned version of the widget instance, optionally
overriding initialization parameters.
This is the only way to safely "modify" a widget instance.
Example::
>>> w = Widget('foo', a=2)
>>> w.id, w.a
('foo', 2)
>>> w2 = w.clone(a=3)
>>> w2.id, w2.a
('foo', 3)
R\ ( R R RH R\ RT ( R$ R& Ri ( ( s0 /usr/lib/python2.6/site-packages/tw/core/base.pyt clone= s c O sV | i } d | i } t | t | f h } t | | i d | i | i | | S( Nt RepeatedR\ ( R Rf t typeR R RH R\ RT ( R$ R& Ri Rh t new_namet new_class( ( s0 /usr/lib/python2.6/site-packages/tw/core/base.pyt _as_repeatedU s
c K s d S( s Initializes a Widget instance.
`id`
The widget's id. All widgets in the same level of nested
widgets trees should have distinct ids.
`parent`
A reference to the widget's parent. This parent needs to be in an
uninitialized state which means it can only be passed to a child
inside the parent's __init__ method.
`children`
A list, or WidgetsList (instance or class) or any other iterable
with a reference to the children this widget should have.
`\*\*kw`
Any other extra keyword arguments for the widget. All of these will
get bound to the Widget instance.
N( ( R$ R3 R: R\ Ri ( ( s0 /usr/lib/python2.6/site-packages/tw/core/base.pyt __init__b s c
C s | i } | i t g } | i D] } | | i q ~ | i t g } | i D] } | | i qT ~ | i t g } | i D] } | | i q ~ d S( s- picks up resources from self and all childrenN( Re t add_allR RK RL R\ ( R$ t osetRC R^ Rn t _[3]( ( s0 /usr/lib/python2.6/site-packages/tw/core/base.pyt _collect_resources| s 44c O sf t | i d j o0 d d k l } | i i | d | i n | i t | _ t | _ d S( s
This method is called for all :class:`tw.api.Widget` base classes to
perform final setup after the widget is initialized but before it is
locked.
i i( t JSFunctionCallst function_callsN(
t lenRd t tw.core.resourcesR| RL R] R{ R. R R" ( R$ R& Ri R| ( ( s0 /usr/lib/python2.6/site-packages/tw/core/base.pyt post_init s
c s4 f d } o t | S| S( s
Does a pre-order walk on widget tree rooted at self optionally
applying a filter on them.
Example::
>>> W = Widget
>>> w = W('a', children=[W('b', children=[W('c')]), W('d')])
>>> ''.join(i._id for i in w.walk())
'abcd'
>>> ''.join(i._id for i in w.walk(lambda x: not x.is_root))
'bcd'
>>> ''.join(i._id for i in w.walk(lambda x: x._id == 'c'))
'c'
Recursion can be prevented on children that not match filter.
>>> ''.join(i._id for i in w.walk(lambda x: x._id == 'c', False))
''
c 3 sm Vt i } o o i } n x0 | D]( } x | i D] } | VqV Wq= Wd S( N( t iterR\ t ifilter_childrent walk( t iteratorR^ RD ( R$ t filtert recur_if_filtered( s0 /usr/lib/python2.6/site-packages/tw/core/base.pyt _walk s ( R ( R$ R R R ( ( R R$ R s0 /usr/lib/python2.6/site-packages/tw/core/base.pyR s t
bodybottomc C sH | i o$ d d k l } | i | | n | i i t | d S( so
Adds a :func:`tw.api.js_function` call that will be made when the
widget is rendered.
i( t dynamic_js_callsN( R R R t inject_callRd R] t str( R$ t callt locationR ( ( s0 /usr/lib/python2.6/site-packages/tw/core/base.pyt add_call s
c C s t d t d g S( NsZ retrieve_css is deprecated. Please use retrieve_resources instead and filter them yourselfi ( R R0 ( R$ ( ( s0 /usr/lib/python2.6/site-packages/tw/core/base.pyt retrieve_css s
c C s t d t d g S( Nsa retrieve_javascript is deprecated. Please use retrieve_resources instead and filter them yourselfi ( R R0 ( R$ ( ( s0 /usr/lib/python2.6/site-packages/tw/core/base.pyt retrieve_javascript s
c C sR d d k l } t d | D } x% | i D] } | | i i | q0 W| S( s
Returns a dict keyed by location with ordered collections of
resources from this widget and its children as values.
i( t locationsc s s" x | ] } | t f Vq Wd S( N( R ( t .0R% ( ( s0 /usr/lib/python2.6/site-packages/tw/core/base.pys s ( t tw.apiR Rc Re R t add( R$ R t resourcest r( ( s0 /usr/lib/python2.6/site-packages/tw/core/base.pyt retrieve_resources s
c C s t | d oV x | i i D]; \ } } t | d j o | d | | >> class MyWidget(Widget):
... params = ["foo", "bar", "null"]
... foo = "foo"
...
>>> w = MyWidget('test', bar=lambda: "bar")
>>> d = {}
>>> w.update_params(d)
>>> d['bar']
'bar'
>>> d['foo']
'foo'
>>> d['null'] is None
True
>>> d = {'foo':'overriden'}
>>> w.update_params(d)
>>> d['foo']
'overriden'
s Autocalling param '%s'N(
R t __contains__Rb R R R! RI Rc R R R
t logt debug( R$ R R% Rp ( ( s0 /usr/lib/python2.6/site-packages/tw/core/base.pyR X s *
c C s t | | i S( s
Returns an iterator for all children applying a filter to them.
.. sourcecode:: python
>>> class Widgets(WidgetsList):
... aa = Widget()
... ab = Widget()
... ba = Widget()
... bb = Widget()
...
>>> w = Widget(children=Widgets)
>>> [c.id for c in w.ifilter_children(lambda w: w.id.startswith('a'))]
['aa', 'ab']
( R R\ ( R$ R ( ( s0 /usr/lib/python2.6/site-packages/tw/core/base.pyR s c s f d } | S( Nc s o t | d o t t o
| i } n. t | t o t t o
| i } n y | SWq t t t f j
o d q Xn d S( Nt
repetition( R R! RI R R Rc RH t
IndexErrort KeyErrort TypeErrorR ( t child_id( R ( s0 /usr/lib/python2.6/site-packages/tw/core/base.pyt value_getter s
( ( R$ R R ( ( R s0 /usr/lib/python2.6/site-packages/tw/core/base.pyR s c s3 t t o t n f d } | S( Nc s t | d o t t o
| i } n. t | t o t t o
| i } n y | SWn t t t f j
o h SXd S( NR (
R R! RI R R Rc RH R R R ( R ( R ( s0 /usr/lib/python2.6/site-packages/tw/core/base.pyt args_getter s
( R! Rc R ( R$ R R ( ( R s0 /usr/lib/python2.6/site-packages/tw/core/base.pyR s
c C sS t | t o | i | n/ t | t o | | n t d | d S( s Append an object as a childs) Can only append Widgets or Childs, not %rN( R! R t
_append_toR RU ( R$ Rj ( ( s0 /usr/lib/python2.6/site-packages/tw/core/base.pyR` s
c C s
| i | S( N( Rq ( R$ R: ( ( s0 /usr/lib/python2.6/site-packages/tw/core/base.pyR s c C s t i | | | d S( N( t objectR) ( R$ R% Rk ( ( s0 /usr/lib/python2.6/site-packages/tw/core/base.pyR) s c C s t i | | d S( N( R t __delattr__( R$ R% ( ( s0 /usr/lib/python2.6/site-packages/tw/core/base.pyR s c C s) | i i } d | | i | i | i f S( Ns %s(%r, children=%r, **%r)( R Rf RH R\ RT ( R$ Ro ( ( s0 /usr/lib/python2.6/site-packages/tw/core/base.pyt __repr__ s c C s
| i S( N( R ( R$ ( ( s0 /usr/lib/python2.6/site-packages/tw/core/base.pyt __str__ s c C s | | j S( N( ( R$ t other( ( s0 /usr/lib/python2.6/site-packages/tw/core/base.pyt __ne__ s c C sR t | d d | i j o6 | i | i j o# | i | i j o | i | i j S( NR ( R R R RH R\ RT ( R$ R ( ( s0 /usr/lib/python2.6/site-packages/tw/core/base.pyt __eq__ s c s f d } | S( Nc sS t | t t f o | } n | } | i | | i | | S( N( R! t
basestringt intt updateR ( t widgetRi t child_kw( R R R\ ( s0 /usr/lib/python2.6/site-packages/tw/core/base.pyR s
( ( R\ R R R ( ( R R\ R s0 /usr/lib/python2.6/site-packages/tw/core/base.pyR s N(< Rf t
__module__t __doc__R t
__metaclass__R R: R Rb RK RL R5 R1 R R" R< t propertyR3 RF RA RB RJ R6 RO t only_if_initializedRq Rv Rw R{ R R. R R R R R R R R R R R R R R R R R t only_if_uninitializedR` R R* R) R R R R R t staticmethodR ( ( ( s0 /usr/lib/python2.6/site-packages/tw/core/base.pyR I s~ O
D
"
( 7 c B s/ e Z d Z d Z d g d Z d d Z RS( s
Prepares a Widget to being attached to a parent Widget.
Creates a Widget instance with supplied arguments to the constructor when
called (optionally overriding default arguments).
>>> c = Child(Widget, 'foo')
>>> w = c()
>>> w.id
'foo'
Parameters can be overriden when called.
>>> w = c(id='bar')
>>> w.id
'bar'
t widget_classR3 R\ Ri c K s* | | | _ | _ | | | _ | _ d S( N( R R3 R\ Ri ( R$ R R3 R\ Ri ( ( s0 /usr/lib/python2.6/site-packages/tw/core/base.pyRw s c K sK | i i } | i d | i d | d | i | i | | i | S( NR3 R: R\ ( Ri R R R3 R\ R ( R$ R: Ri t kw_( ( s0 /usr/lib/python2.6/site-packages/tw/core/base.pyR s "
( s widget_classs ids childrens kwN( Rf R R t __slots__R Rw R ( ( ( s0 /usr/lib/python2.6/site-packages/tw/core/base.pyR s t _widget_lstt _widget_dctt _widgett _repetitionst _parentt _repetition_cachec B s e Z d Z d Z d Z d Z d Z d Z d Z d Z d Z
d Z d
Z d Z
d d
d d Z d Z d Z d Z d Z d Z d Z e Z d Z RS( s
An ordered collection of widgets.
>>> from tw.core import Widget
>>> wb = WidgetBunch(Widget('foo'), Widget('bar'))
>>> wb[0].id == 'foo'
True
>>> wb[1].id == 'bar'
True
Exposes a mixed dict/list interface which permits indexing both by widget
id and position.
>>> wb['foo'] == wb[0]
True
>>> wb['bar'] == wb[1]
True
Also permits attribute access as long as the attribute doesn't conflict
with an internal attribute, in case of conflict the internal attrbute
will prevail.
>>> wb.foo.id == 'foo'
True
>>> wb.append(Widget('append'))
>>> wb.append.id
Traceback (most recent call last):
...
AttributeError: 'function' object has no attribute 'id'
>>> wb['append'].id == 'append'
True
Iteration is also supported
>>> [w.id for w in wb]
['foo', 'bar', 'append']
Some dict-like iterators too
>>> [id for id in wb.iterkeys()]
['foo', 'bar', 'append']
>>> [id for id in wb.keys()]
['foo', 'bar', 'append']
>>> [w.id for w in wb.itervalues()]
['foo', 'bar', 'append']
>>> [w.id for w in wb.values()]
['foo', 'bar', 'append']
c G s4 g | _ h | _ x | D] } | i | q Wd S( N( R R R] ( R$ R& t wid( ( s0 /usr/lib/python2.6/site-packages/tw/core/base.pyRw c s
c C s | i | i | d S( N( R) RH ( R$ R ( ( s0 /usr/lib/python2.6/site-packages/tw/core/base.pyR] i s c C s1 t } x! | D] } | i | i q W| S( N( R Rx R ( R$ Ry t child( ( s0 /usr/lib/python2.6/site-packages/tw/core/base.pyR l s
c C s1 t } x! | D] } | i | i q W| S( N( R Rx R ( R$ Ry R ( ( s0 /usr/lib/python2.6/site-packages/tw/core/base.pyR r s
c C sT d d k l } l } t d | D } x! | D] } | | | i q3 W| S( Ni( t merge_resourcesR c s s" x | ] } | t f Vq Wd S( N( R ( R R% ( ( s0 /usr/lib/python2.6/site-packages/tw/core/base.pys z s ( R R R Rc R ( R$ R R R RD ( ( s0 /usr/lib/python2.6/site-packages/tw/core/base.pyR x s c C sI t | t o | i | St | t o | i | St d | d S( Ns No widget by %r( R! R R R R R ( R$ RG ( ( s0 /usr/lib/python2.6/site-packages/tw/core/base.pyt __getitem__ s
c C sQ | t j o t i | | Sy | | SWn t j
o t d | n Xd S( Ns No widget by %r( t _WidgetBunch_attrsR t __getattribute__R RS ( R$ Ro ( ( s0 /usr/lib/python2.6/site-packages/tw/core/base.pyt __getattr__ s
c C sB | t j o t i | | | S| i i | | | i | | d j o
| i } n x t | D] } | | Vq' Wd S( N( R R t xrange( R$ t repst i( ( s0 /usr/lib/python2.6/site-packages/tw/core/base.pyR s
c C s t | t p t d n y | i | } WnK t j
o? | i i d | } t i | d | i | | i | } | | i | | d | i
t
| d j | | q ~ } d
i d | D | d
s t output( R R R R R R R R0 R t maxR~ R R R R? ( R$ R t v_ft a_fRC RD t outputs( ( s0 /usr/lib/python2.6/site-packages/tw/core/base.pyR s
lN( Rf R Rb R R R R R RB t templateR RF RO R ( ( ( s0 /usr/lib/python2.6/site-packages/tw/core/base.pyR s c B s5 e Z d g Z d Z e d Z e d Z RS( R i c C s d | i | i p d f S( Ns %s-%di ( RH R ( R$ ( ( s0 /usr/lib/python2.6/site-packages/tw/core/base.pyRB s c O s | i | | S( N( Rq ( R$ R& Ri ( ( s0 /usr/lib/python2.6/site-packages/tw/core/base.pyRv s ( Rf R Rb R R RB R Rv ( ( ( s0 /usr/lib/python2.6/site-packages/tw/core/base.pyR s t __main__t optionflags(? t reRZ t loggingR t warningsR t itertoolsR R R R R R t inspectR R7 t utilR R
R R R
R R R R RM t
exceptionst metaR R t __all__t getLoggerRf R R. t WidgetUninitializedR R1 RY R R* t compileR, R/ R RV RN R R t im_funcR R t frozensetR R R R R t doctestt testmodt ELLIPSISt NORMALIZE_WHITESPACE( ( ( s0 /usr/lib/python2.6/site-packages/tw/core/base.pyt sV $. @
' ,