changeset 114:87147faa031a

Added docs for define_property() and get_property().
author Atul Varma <varmaa@toolness.com>
date Mon, 17 Aug 2009 03:02:51 -0700
parents e616b4605db0
children f4c550369332
files docs/rendered/_sources/pymonkey.txt docs/rendered/genindex.html docs/rendered/pymonkey.html docs/rendered/searchindex.js docs/src/pymonkey.txt
diffstat 5 files changed, 82 insertions(+), 2 deletions(-) [+]
line wrap: on
line diff
--- a/docs/rendered/_sources/pymonkey.txt	Sun Aug 16 22:48:50 2009 -0700
+++ b/docs/rendered/_sources/pymonkey.txt	Mon Aug 17 03:02:51 2009 -0700
@@ -104,6 +104,29 @@
         >>> cx.evaluate_script(obj, 'add(1, 1);', '<string>', 1)
         2
 
+   .. method:: define_property(object, name, value)
+
+      Creates a new property on `object`, bypassing any JavaScript setters.
+
+   .. method:: get_property(object, name)
+
+      Finds the specified property on `object` and returns its value,
+      possibly invoking a JavaScript getter.
+
+      Example:
+
+        >>> cx = pymonkey.Runtime().new_context()
+        >>> obj = cx.new_object()
+        >>> cx.define_property(obj, 'beets', 'i like beets.')
+        >>> cx.get_property(obj, 'beets')
+        u'i like beets.'
+
+      Note also that calling this function on undefined properties
+      yields :data:`undefined`:
+
+        >>> cx.get_property(obj, 'carrots')
+        pymonkey.undefined
+
    .. method:: get_object_private(object)
 
       Returns the ``private_obj`` passed to :meth:`new_object()`
--- a/docs/rendered/genindex.html	Sun Aug 16 22:48:50 2009 -0700
+++ b/docs/rendered/genindex.html	Mon Aug 17 03:02:51 2009 -0700
@@ -43,7 +43,7 @@
 
    <h1 id="index">Index</h1>
 
-   <a href="#C"><strong>C</strong></a> | <a href="#E"><strong>E</strong></a> | <a href="#F"><strong>F</strong></a> | <a href="#G"><strong>G</strong></a> | <a href="#I"><strong>I</strong></a> | <a href="#N"><strong>N</strong></a> | <a href="#O"><strong>O</strong></a> | <a href="#P"><strong>P</strong></a> | <a href="#R"><strong>R</strong></a> | <a href="#U"><strong>U</strong></a> 
+   <a href="#C"><strong>C</strong></a> | <a href="#D"><strong>D</strong></a> | <a href="#E"><strong>E</strong></a> | <a href="#F"><strong>F</strong></a> | <a href="#G"><strong>G</strong></a> | <a href="#I"><strong>I</strong></a> | <a href="#N"><strong>N</strong></a> | <a href="#O"><strong>O</strong></a> | <a href="#P"><strong>P</strong></a> | <a href="#R"><strong>R</strong></a> | <a href="#U"><strong>U</strong></a> 
 
    <hr />
 
@@ -57,6 +57,13 @@
 <dt><a href="pymonkey.html#pymonkey.Context">Context (class in pymonkey)</a></dt>
 </dl></td></tr></table>
 
+<h2 id="D">D</h2>
+<table width="100%" class="indextable"><tr><td width="33%" valign="top">
+<dl>
+
+<dt><a href="pymonkey.html#pymonkey.Context.define_property">define_property() (pymonkey.Context method)</a></dt></dl></td><td width="33%" valign="top"><dl>
+</dl></td></tr></table>
+
 <h2 id="E">E</h2>
 <table width="100%" class="indextable"><tr><td width="33%" valign="top">
 <dl>
@@ -77,6 +84,7 @@
 <dl>
 
 <dt><a href="pymonkey.html#pymonkey.Context.get_object_private">get_object_private() (pymonkey.Context method)</a></dt>
+<dt><a href="pymonkey.html#pymonkey.Context.get_property">get_property() (pymonkey.Context method)</a></dt>
 <dt><a href="pymonkey.html#pymonkey.Context.get_runtime">get_runtime() (pymonkey.Context method)</a></dt>
   <dd><dl>
     <dt><a href="pymonkey.html#pymonkey.Object.get_runtime">(pymonkey.Object method)</a></dt>
--- a/docs/rendered/pymonkey.html	Sun Aug 16 22:48:50 2009 -0700
+++ b/docs/rendered/pymonkey.html	Mon Aug 17 03:02:51 2009 -0700
@@ -155,6 +155,32 @@
 </dd></dl>
 
 <dl class="method">
+<dt id="pymonkey.Context.define_property">
+<tt class="descname">define_property</tt><big>(</big><em>object</em>, <em>name</em>, <em>value</em><big>)</big><a class="headerlink" href="#pymonkey.Context.define_property" title="Permalink to this definition">¶</a></dt>
+<dd>Creates a new property on <cite>object</cite>, bypassing any JavaScript setters.</dd></dl>
+
+<dl class="method">
+<dt id="pymonkey.Context.get_property">
+<tt class="descname">get_property</tt><big>(</big><em>object</em>, <em>name</em><big>)</big><a class="headerlink" href="#pymonkey.Context.get_property" title="Permalink to this definition">¶</a></dt>
+<dd><p>Finds the specified property on <cite>object</cite> and returns its value,
+possibly invoking a JavaScript getter.</p>
+<p>Example:</p>
+<div class="highlight-python"><div class="highlight"><pre><span class="gp">&gt;&gt;&gt; </span><span class="n">cx</span> <span class="o">=</span> <span class="n">pymonkey</span><span class="o">.</span><span class="n">Runtime</span><span class="p">()</span><span class="o">.</span><span class="n">new_context</span><span class="p">()</span>
+<span class="gp">&gt;&gt;&gt; </span><span class="n">obj</span> <span class="o">=</span> <span class="n">cx</span><span class="o">.</span><span class="n">new_object</span><span class="p">()</span>
+<span class="gp">&gt;&gt;&gt; </span><span class="n">cx</span><span class="o">.</span><span class="n">define_property</span><span class="p">(</span><span class="n">obj</span><span class="p">,</span> <span class="s">&#39;beets&#39;</span><span class="p">,</span> <span class="s">&#39;i like beets.&#39;</span><span class="p">)</span>
+<span class="gp">&gt;&gt;&gt; </span><span class="n">cx</span><span class="o">.</span><span class="n">get_property</span><span class="p">(</span><span class="n">obj</span><span class="p">,</span> <span class="s">&#39;beets&#39;</span><span class="p">)</span>
+<span class="go">u&#39;i like beets.&#39;</span>
+</pre></div>
+</div>
+<p>Note also that calling this function on undefined properties
+yields <a title="pymonkey.undefined" class="reference" href="#pymonkey.undefined"><tt class="xref docutils literal"><span class="pre">undefined</span></tt></a>:</p>
+<div class="highlight-python"><div class="highlight"><pre><span class="gp">&gt;&gt;&gt; </span><span class="n">cx</span><span class="o">.</span><span class="n">get_property</span><span class="p">(</span><span class="n">obj</span><span class="p">,</span> <span class="s">&#39;carrots&#39;</span><span class="p">)</span>
+<span class="go">pymonkey.undefined</span>
+</pre></div>
+</div>
+</dd></dl>
+
+<dl class="method">
 <dt id="pymonkey.Context.get_object_private">
 <tt class="descname">get_object_private</tt><big>(</big><em>object</em><big>)</big><a class="headerlink" href="#pymonkey.Context.get_object_private" title="Permalink to this definition">¶</a></dt>
 <dd><p>Returns the <tt class="docutils literal"><span class="pre">private_obj</span></tt> passed to <a title="pymonkey.Context.new_object" class="reference" href="#pymonkey.Context.new_object"><tt class="xref docutils literal"><span class="pre">new_object()</span></tt></a>
--- a/docs/rendered/searchindex.js	Sun Aug 16 22:48:50 2009 -0700
+++ b/docs/rendered/searchindex.js	Mon Aug 17 03:02:51 2009 -0700
@@ -1,1 +1,1 @@
-Search.setIndex({desctypes:{"0":"method","1":"exception","2":"class","3":"data"},terms:{spidermonkei:[0,1],represent:1,all:0,code:[0,1],untrust:0,lack:0,concept:0,get_object_priv:1,privat:1,depend:0,readabl:0,program:1,isinst:1,liter:1,string:1,veri:[0,1],join:[],vast:0,level:1,"try":0,second:1,pass:1,casual:0,even:[],index:0,evaluate_script:1,abl:0,access:[0,1],"new":1,objdir:[],method:1,metadata:1,involv:0,full:0,subtyp:1,never:0,new_object:1,here:0,objcec:[],path:[],valu:1,search:0,doctest:0,chang:1,tremend:0,via:[0,1],modul:[0,1],filenam:1,api:0,instal:0,test_pymonkei:[],from:[0,1],would:0,memori:0,init_standard_class:1,call:1,scope:1,type:1,more:[0,1],thisobj:1,mozilla:[0,1],ctype:0,known:0,central:[],must:0,none:1,retriev:1,setup:0,work:0,conceptu:1,can:[0,1],learn:0,akin:0,root:0,fetch:0,def:1,give:0,process:0,challeng:0,sudo:0,indic:0,want:[0,1],unfortun:[],alwai:0,goal:0,secur:[0,1],write:0,how:0,verifi:1,map:1,product:0,clone:[],usabl:0,befor:0,mai:1,associ:1,third:[0,1],counter:1,inform:1,sandbox:0,environ:0,enter:[],callabl:1,becaus:0,intermediari:0,through:1,dynam:0,platform:0,window:0,easier:0,them:0,within:1,"return":1,thei:[],python:[0,1],now:[],xpcom:0,name:1,anyth:0,get_runtim:1,easili:0,trap:0,each:1,debug:[0,1],side:0,mean:0,compil:0,everyth:0,realli:0,ensur:0,"static":[],collector:0,out:0,path_to_objdir:[],profil:0,lineno:1,rational:0,print:1,forth:1,math:1,situat:0,free:[],standard:[0,1],reason:[],base:0,thrown:1,thread:1,traceback:0,first:1,singleton:1,obviou:0,pyrex:0,feel:[],arrai:1,number:[0,1],get_properti:1,instruct:[],facil:0,given:1,script:[],interact:1,too:0,"final":0,store:1,relationship:0,tool:[],huh:[],than:0,wide:0,kind:[],provid:0,posit:1,browser:0,pre:1,falsi:1,argument:1,packag:0,have:[0,1],tabl:0,need:0,"null":1,engin:[0,1],built:1,equival:1,latter:[],client:0,note:0,also:[0,1],ideal:0,exampl:1,build:0,which:[0,1],noth:[0,1],trace:1,object:[0,1],plai:0,"class":1,don:0,clear:1,later:1,doe:[],runtim:1,awesom:0,text:1,particularli:0,eas:0,define_properti:1,current:[0,1],onli:[0,1],just:[],solut:0,should:0,busi:0,contribut:0,pave:0,increas:0,requir:0,enabl:0,contain:1,where:0,new_context:1,see:1,arg:1,disadvantag:0,best:1,detect:0,someth:0,state:1,won:0,outstand:0,between:0,atul:0,call_funct:1,javascript:[0,1],extens:0,preprocessor:0,complementari:0,come:1,easi:0,cycl:0,howev:0,blargh:[],instanc:[0,1],context:[0,1],logic:0,freeli:1,com:[],private_obj:1,simpli:[],sweep:0,header:0,assum:1,duplic:0,quit:0,java:0,creat:[0,1],three:1,mark:0,clear_object_priv:[0,1],ani:[0,1],func:1,straight:0,durat:1,defin:[0,1],error:1,advantag:0,unintuit:[],readm:[],contributor:0,blah:[],develop:0,parti:0,make:0,belong:1,cross:0,same:1,complex:0,document:[0,1],http:[],wherea:0,effect:1,hand:0,fairli:0,moment:[],rais:1,stack:[0,1],pymonkei:[0,1],off:[],macro:0,without:0,thi:[0,1],undefin:1,programm:0,model:0,know:[],new_funct:1,execut:[0,1],less:0,when:1,obtain:[],languag:0,web:0,expos:0,except:1,add:1,valid:0,around:0,read:0,swig:0,envis:0,capi:0,world:0,bit:0,like:[0,1],vibrant:0,manual:0,resolv:0,server:0,collect:0,either:[],docutil:1,page:0,right:[],some:0,back:[],global:1,mirror:[],librari:0,rhino:0,refer:0,run:0,garbag:0,broken:0,repositori:0,about:0,actual:0,manag:[],js_initstandardclass:1,due:0,serverj:0,wrap:1,your:0,span:1,wai:0,ergonom:0,custom:0,avail:0,interfac:1,low:1,lot:0,suit:0,"function":[0,1],properli:0,offer:1,tupl:1,globalobj:1,line:1,"true":1,count:0,made:0,possibl:0,similar:0,featur:0,evalu:1,runtm:1,doesn:[0,1],repres:1,exist:[0,1],file:[0,1],check:[],probabl:0,floor:1,boop:[],todo:[],nan:1,field:0,other:[0,1],test:0,you:[0,1],boof:[],matur:0,relat:1,eval:1,unbind:1,land:[0,1],sphinx:0,directori:[],obj:1,time:0},titles:["Pymonkey Documentation","<tt class=\"docutils literal docutils literal\"><span class=\"pre\">pymonkey</span></tt> &#8212; Access SpiderMonkey from Python"],modules:{pymonkey:1},descrefs:{"pymonkey.Runtime":{new_context:[1,0]},"pymonkey.Object":{get_runtime:[1,0]},"pymonkey.Context":{get_object_private:[1,0],new_object:[1,0],call_function:[1,0],evaluate_script:[1,0],clear_object_private:[1,0],new_function:[1,0],init_standard_classes:[1,0],get_runtime:[1,0]},pymonkey:{Function:[1,2],undefined:[1,3],Object:[1,2],Context:[1,2],error:[1,1],Runtime:[1,2]}},filenames:["index","pymonkey"]})
\ No newline at end of file
+Search.setIndex({desctypes:{"0":"method","1":"exception","2":"class","3":"data"},terms:{spidermonkei:[0,1],represent:1,all:0,code:[0,1],untrust:0,lack:0,concept:0,get_object_priv:1,privat:1,depend:0,readabl:0,program:1,isinst:1,liter:1,string:1,veri:[0,1],retriev:1,vast:0,level:1,"try":0,second:1,pass:1,casual:0,even:[],index:0,evaluate_script:1,abl:0,access:[0,1],"new":1,objdir:[],method:1,metadata:1,define_properti:1,full:0,subtyp:1,never:0,onli:[0,1],here:0,objcec:[],path:[],valu:1,search:0,doctest:0,chang:1,tremend:0,via:[0,1],modul:[0,1],filenam:1,api:0,instal:0,test_pymonkei:[],from:[0,1],would:0,memori:0,init_standard_class:1,call:1,scope:1,type:1,more:[0,1],thisobj:1,mozilla:[0,1],line:1,ctype:0,known:0,actual:0,must:0,none:1,join:[],setup:0,work:0,conceptu:1,can:[0,1],learn:0,akin:0,root:0,fetch:0,def:1,give:0,process:0,challeng:0,sudo:0,indic:0,carrot:1,want:[0,1],alwai:0,goal:0,secur:[0,1],write:0,how:0,verifi:1,map:1,product:0,clone:[],usabl:0,befor:0,mai:1,associ:1,third:[0,1],counter:1,inform:1,sandbox:0,environ:0,enter:[],callabl:1,becaus:0,intermediari:0,through:1,dynam:0,platform:0,window:0,bypass:1,easier:0,them:0,js_initstandardclass:1,"return":1,thei:[],python:[0,1],now:[],xpcom:0,name:1,anyth:0,get_runtim:1,easili:0,trap:0,each:1,debug:[0,1],side:0,mean:0,compil:0,everyth:0,realli:0,ensur:0,"static":[],collector:0,out:0,path_to_objdir:[],profil:0,lineno:1,rational:0,print:1,forth:1,math:1,situat:0,free:[],standard:[0,1],reason:[],base:0,thrown:1,thread:1,traceback:0,first:1,singleton:1,obviou:0,pyrex:0,feel:[],arrai:1,number:[0,1],get_properti:1,instruct:[],facil:0,given:1,script:[],interact:1,too:0,"final":0,store:1,relationship:0,tool:[],huh:[],specifi:1,getter:1,than:0,wide:0,kind:[],provid:0,posit:1,browser:0,pre:1,falsi:1,ani:[0,1],packag:0,have:[0,1],tabl:0,need:0,"null":1,engin:[0,1],built:1,equival:1,latter:[],client:0,note:[0,1],also:[0,1],ideal:0,exampl:1,build:0,which:[0,1],noth:[0,1],trace:1,object:[0,1],plai:0,"class":1,don:0,clear:1,later:1,doe:[],runtim:1,awesom:0,text:1,particularli:0,find:1,setter:1,involv:0,current:[0,1],new_object:1,execut:[0,1],solut:0,should:0,busi:0,contribut:0,pave:0,increas:0,requir:0,enabl:0,yield:1,contain:1,where:0,new_context:1,see:1,arg:1,disadvantag:0,best:1,detect:0,someth:0,state:1,won:0,outstand:0,between:0,atul:0,call_funct:1,javascript:[0,1],extens:0,preprocessor:0,complementari:0,come:1,expos:0,cycl:0,howev:0,blargh:[],instanc:[0,1],context:[0,1],logic:0,freeli:1,com:[],private_obj:1,simpli:[],sweep:0,wrap:1,header:0,assum:1,duplic:0,quit:0,java:0,evalu:1,three:1,mark:0,clear_object_priv:[0,1],argument:1,func:1,straight:0,properti:1,durat:1,defin:[0,1],invok:1,error:1,advantag:0,unintuit:[],readm:[],blah:[],develop:0,parti:0,make:0,belong:1,cross:0,same:1,complex:0,document:[0,1],http:[],wherea:0,effect:1,hand:0,fairli:0,moment:[],rais:1,stack:[0,1],pymonkei:[0,1],off:[],macro:0,without:0,thi:[0,1],undefin:1,programm:0,model:0,capi:0,new_funct:1,just:[],less:0,nan:1,obtain:[],languag:0,web:0,easi:0,except:1,add:1,other:[0,1],around:0,read:0,swig:0,envis:0,know:[],world:0,bit:0,like:[0,1],vibrant:0,manual:0,resolv:0,server:0,collect:0,either:[],docutil:1,page:0,right:[],some:0,back:[],global:1,mirror:[],librari:0,rhino:0,refer:0,run:0,garbag:0,broken:0,repositori:0,about:0,central:[],unfortun:[],within:1,due:0,serverj:0,contributor:0,your:0,manag:[],span:1,wai:0,ergonom:0,custom:0,avail:0,interfac:1,low:1,lot:0,suit:0,beet:1,"function":[0,1],properli:0,offer:1,tupl:1,globalobj:1,eas:0,"true":1,count:0,made:0,possibl:[0,1],similar:0,featur:0,creat:[0,1],runtm:1,doesn:[0,1],repres:1,exist:[0,1],file:[0,1],check:[],probabl:0,floor:1,boop:[],todo:[],when:1,field:0,valid:0,test:0,you:[0,1],boof:[],matur:0,relat:1,eval:1,unbind:1,land:[0,1],sphinx:0,directori:[],obj:1,time:0},titles:["Pymonkey Documentation","<tt class=\"docutils literal docutils literal\"><span class=\"pre\">pymonkey</span></tt> &#8212; Access SpiderMonkey from Python"],modules:{pymonkey:1},descrefs:{"pymonkey.Runtime":{new_context:[1,0]},"pymonkey.Object":{get_runtime:[1,0]},"pymonkey.Context":{get_property:[1,0],get_object_private:[1,0],new_object:[1,0],call_function:[1,0],evaluate_script:[1,0],clear_object_private:[1,0],new_function:[1,0],get_runtime:[1,0],define_property:[1,0],init_standard_classes:[1,0]},pymonkey:{Function:[1,2],undefined:[1,3],Object:[1,2],Context:[1,2],error:[1,1],Runtime:[1,2]}},filenames:["index","pymonkey"]})
\ No newline at end of file
--- a/docs/src/pymonkey.txt	Sun Aug 16 22:48:50 2009 -0700
+++ b/docs/src/pymonkey.txt	Mon Aug 17 03:02:51 2009 -0700
@@ -104,6 +104,29 @@
         >>> cx.evaluate_script(obj, 'add(1, 1);', '<string>', 1)
         2
 
+   .. method:: define_property(object, name, value)
+
+      Creates a new property on `object`, bypassing any JavaScript setters.
+
+   .. method:: get_property(object, name)
+
+      Finds the specified property on `object` and returns its value,
+      possibly invoking a JavaScript getter.
+
+      Example:
+
+        >>> cx = pymonkey.Runtime().new_context()
+        >>> obj = cx.new_object()
+        >>> cx.define_property(obj, 'beets', 'i like beets.')
+        >>> cx.get_property(obj, 'beets')
+        u'i like beets.'
+
+      Note also that calling this function on undefined properties
+      yields :data:`undefined`:
+
+        >>> cx.get_property(obj, 'carrots')
+        pymonkey.undefined
+
    .. method:: get_object_private(object)
 
       Returns the ``private_obj`` passed to :meth:`new_object()`