Ñò
Ê ¹Jc @ sÜ d Z d d k Z d d k Z d d k l Z d d k Z d d k Z d d d g Z e i e
ƒ Z d e i i
f d „ ƒ YZ d e f d „ ƒ YZ d e f d
„ ƒ YZ d e f d „ ƒ YZ d e f d
„ ƒ YZ d S( s³
Python-JS interface to dynamically create JS function calls from your widgets.
This module doesn't aim to serve as a Python-JS "translator". You should code
your client-side code in JavaScript and make it available in static files which
you include as JSLinks or inline using JSSources. This module is only intended
as a "bridge" or interface between Python and JavaScript so JS function
**calls** can be generated programatically.
iÿÿÿÿN( t imapt js_callbackt js_functiont js_symbolt TWEncoderc B s; e Z d Z d „ Z d „ Z d „ Z d „ Z d „ Z RS( sŽ A JSON encoder that can encode Widgets, js_calls, js_symbols and
js_callbacks.
Example::
>>> encode = TWEncoder().encode
>>> print encode({'onLoad': js_function("do_something")(js_symbol("this"))})
{"onLoad": do_something(this)}
>>> from tw.api import Widget
>>> w = Widget("foo")
>>> args = {'onLoad': js_callback(js_function('jQuery')(w).click(js_symbol('onClick')))}
>>> print encode(args)
{"onLoad": function(){jQuery("foo").click(onClick)}}
>>> print encode({'args':args})
{"args": {"onLoad": function(){jQuery("foo").click(onClick)}}}
Technical note: simplejson does not support arbitrary js injection, which
is needed in this module. We work around this by inserting distinct
tokens into the JSON encoding stream that can later be replaced with the
objects' js representations.
c O s t t | ƒ i | | Ž d S( N( t superR t __init__( t selft argst kw( ( s. /usr/lib/python2.6/site-packages/tw/core/js.pyR - s c C sR t | d ƒ o | i | ƒ St | d ƒ o t | i ƒ St t | ƒ i | ƒ S( Nt get_js_reprt _id( t hasattrt mark_for_escapet strt idR R t default( R t obj( ( s. /usr/lib/python2.6/site-packages/tw/core/js.pyR 0 s
c C s= h | _ t t | ƒ i | ƒ } | i | ƒ } h | _ | S( N( t unescape_symbolsR R t encodet unescape_marked( R R t encodedt unescaped( ( s. /usr/lib/python2.6/site-packages/tw/core/js.pyR 7 s
c C s' | | i t | ƒ s c s. t i d ƒ } ‡ f d † } | i | | ƒ S( Ns "TWEncoder_unescape_([0-9]*)"c sH y0 t | i d ƒ ƒ } ˆ i | } | i ƒ SWn | i d ƒ SXd S( Ni i ( t intt groupR R
( t matcht obj_idR ( R ( s. /usr/lib/python2.6/site-packages/tw/core/js.pyt unescapeD s
( t ret compilet sub( R R t unescape_patternR ( ( R s. /usr/lib/python2.6/site-packages/tw/core/js.pyR B s ( t __name__t
__module__t __doc__R R R R
R ( ( ( s. /usr/lib/python2.6/site-packages/tw/core/js.pyR s c B s# e Z d „ Z d „ Z d „ Z RS( c C s
| | _ d S( N( t _name( R t name( ( s. /usr/lib/python2.6/site-packages/tw/core/js.pyR O s c C s
t | i ƒ S( N( R R$ ( R ( ( s. /usr/lib/python2.6/site-packages/tw/core/js.pyR
Q s c C s
| i ƒ S( N( R
( R ( ( s. /usr/lib/python2.6/site-packages/tw/core/js.pyt __str__S s ( R! R" R R
R& ( ( ( s. /usr/lib/python2.6/site-packages/tw/core/js.pyR N s c B s2 e Z d Z d „ Z d „ Z d „ Z d „ Z RS( s² A js function that can be passed as a callback to be called
by another JS function
Examples:
.. sourcecode:: python
>>> str(js_callback("update_div"))
'update_div'
>>> str(js_callback("function (event) { .... }"))
'function (event) { .... }'
# Can also create callbacks for deferred js calls
>>> str(js_callback(js_function('foo')(1,2,3)))
'function(){foo(1, 2, 3)}'
# Or equivalently
>>> str(js_callback(js_function('foo'), 1,2,3))
'function(){foo(1, 2, 3)}'
# A more realistic example
>>> jQuery = js_function('jQuery')
>>> my_cb = js_callback('function() { alert(this.text)}')
>>> on_doc_load = jQuery('#foo').bind('click', my_cb)
>>> call = jQuery(js_callback(on_doc_load))
>>> print call
jQuery(function(){jQuery("#foo").bind("click", function() { alert(this.text)})})
c G sr t | t ƒ o
| | _ nR t | t ƒ o d | | Œ | _ n+ t | t ƒ o d | | _ n
d | _ d S( Ns function(){%s}t ( t
isinstancet
basestringt cbR t _js_call( R R* R ( ( s. /usr/lib/python2.6/site-packages/tw/core/js.pyR x s
c G s t d ƒ ‚ d S( Ns* A js_callback cannot be called from Python( t TypeError( R R ( ( s. /usr/lib/python2.6/site-packages/tw/core/js.pyt __call__‚ s c C s | i S( N( R* ( R ( ( s. /usr/lib/python2.6/site-packages/tw/core/js.pyR
… s c C s
| i ƒ S( N( R
( R ( ( s. /usr/lib/python2.6/site-packages/tw/core/js.pyR& ˆ s ( R! R" R# R R- R
R& ( ( ( s. /usr/lib/python2.6/site-packages/tw/core/js.pyR V s
!
c B s2 e Z d Z d „ Z d „ Z d „ Z d „ Z RS( s A JS function that can be "called" from python and and added to
a widget by widget.add_call() so it get's called every time the widget
is rendered.
Used to create a callable object that can be called from your widgets to
trigger actions in the browser. It's used primarily to initialize JS code
programatically. Calls can be chained and parameters are automatically
json-encoded into something JavaScript undersrtands. Example::
.. sourcecode:: python
>>> jQuery = js_function('jQuery')
>>> call = jQuery('#foo').datePicker({'option1': 'value1'})
>>> str(call)
'jQuery("#foo").datePicker({"option1": "value1"})'
Calls are added to the widget call stack with the ``add_call`` method.
If made at Widget initialization those calls will be placed in
the template for every request that renders the widget.
.. sourcecode:: python
>>> from tw.api import Widget
>>> class SomeWidget(Widget):
... params = ["pickerOptions"]
... pickerOptions = {}
... def __init__(self, *args, **kw):
... super(SomeWidget, self).__init__(*args, **kw)
... self.add_call(
... jQuery('#%s' % self.id).datePicker(self.pickerOptions)
... )
If we want to dynamically make calls on every request, we ca also add_calls
inside the ``update_params`` method.
.. sourcecode:: python
>>> class SomeWidget(Widget):
... params = ["pickerOptions"]
... pickerOptions = {}
... def update_params(self, d):
... super(SomeWidget, self).update_params(d)
... self.add_call(
... jQuery('#%s' % d.id).datePicker(d.pickerOptions)
... )
This would allow to pass different options to the datePicker on every
display.
JS calls are rendered by the same mechanisms that render required css and
js for a widget and places those calls at bodybottom so DOM elements which
we might target are available.
Examples:
.. sourcecode:: python
>>> call = js_function('jQuery')("a .async")
>>> str(call)
'jQuery("a .async")'
# js_function calls can be chained:
>>> call = js_function('jQuery')("a .async").foo().bar()
>>> str(call)
'jQuery("a .async").foo().bar()'
c C s
| | _ d S( N( t _js_function__name( R R% ( ( s. /usr/lib/python2.6/site-packages/tw/core/js.pyR Ñ s c G s t | i g | d t ƒS( Nt called( R+ R. t True( R R ( ( s. /usr/lib/python2.6/site-packages/tw/core/js.pyR- Ô s c C s
t | i ƒ S( N( R R. ( R ( ( s. /usr/lib/python2.6/site-packages/tw/core/js.pyR
× s c C s
| i ƒ S( N( R
( R ( ( s. /usr/lib/python2.6/site-packages/tw/core/js.pyR& Ú s ( R! R" R# R R- R
R& ( ( ( s. /usr/lib/python2.6/site-packages/tw/core/js.pyR ‹ s
E R+ c B sS e Z d Z d e d „ Z d „ Z d „ Z d „ Z d „ Z d „ Z
d
„ Z RS(
t __namet __call_listt __argst __calledc C s9 | | _ | | _ | | _ | i i | ƒ | | _ d S( N( t _js_call__namet _js_call__argst _js_call__call_listt appendt _js_call__called( R R% t call_listR R/ ( ( s. /usr/lib/python2.6/site-packages/tw/core/js.pyR á s
c C s | i | | i ƒ S( N( t __class__R7 ( R R% ( ( s. /usr/lib/python2.6/site-packages/tw/core/js.pyt __getattr__è s c G s | | _ t | _ | S( N( R6 R0 R9 ( R R ( ( s. /usr/lib/python2.6/site-packages/tw/core/js.pyR- ë s c s) t ƒ ‰ d i ‡ f d † | i Dƒ ƒ S( Nt .c 3 s" x | ] } | i ˆ ƒ Vq Wd S( N( t _js_call__get_js_repr_fragment( t .0t c( t encoder( s. /usr/lib/python2.6/site-packages/tw/core/js.pys ò s ( R t joinR7 ( R ( ( RA s. /usr/lib/python2.6/site-packages/tw/core/js.pyR
ð s c C sE | i o0 | i } d | i d i t | i | ƒ ƒ f S| i Sd S( Ns %s(%s)s , ( R9 R6 R5 RB R R ( R RA R ( ( s. /usr/lib/python2.6/site-packages/tw/core/js.pyt __get_js_repr_fragmentô s
'c C s$ | i p t d ƒ ‚ n | i ƒ S( Ns* Last element in the chain has to be called( R9 R, R
( R ( ( s. /usr/lib/python2.6/site-packages/tw/core/js.pyR& û s
c C s t | ƒ i t i ƒ ƒ S( N( R t decodet syst getdefaultencoding( R ( ( s. /usr/lib/python2.6/site-packages/tw/core/js.pyt __unicode__ s ( s __names __call_lists __argss __calledN( R! R" t __slots__t Nonet FalseR R< R- R
R> R& RG ( ( ( s. /usr/lib/python2.6/site-packages/tw/core/js.pyR+ Þ s ( R# RE t loggingt itertoolsR R t simplejson.encodert
simplejsont __all__t getLoggerR! t logRA t JSONEncoderR t objectR R R R+ ( ( ( s. /usr/lib/python2.6/site-packages/tw/core/js.pyt s 95S