Mercurial > pymonkey
changeset 54:234fca1c4b86
Added docs for pymonkey.undefined.
| author | Atul Varma <varmaa@toolness.com> |
|---|---|
| date | Fri, 10 Jul 2009 17:22:42 -0700 |
| parents | 2055d853b995 |
| children | 40a404b9c467 |
| 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, 77 insertions(+), 2 deletions(-) [+] |
line wrap: on
line diff
--- a/docs/rendered/_sources/pymonkey.txt Fri Jul 10 17:07:26 2009 -0700 +++ b/docs/rendered/_sources/pymonkey.txt Fri Jul 10 17:22:42 2009 -0700 @@ -16,6 +16,28 @@ This is the type of any SpiderMonkey-related errors thrown by this module. +.. data:: undefined + + This is the singleton that represents the JavaScript value + ``undefined``, as Python has no equivalent representation + (JavaScript's ``null`` is mapped to Python's ``None`` object). + For instance: + + >>> cx = pymonkey.Runtime().new_context() + >>> obj = cx.new_object() + >>> cx.evaluate_script(obj, '', '<string>', 1) + <type 'pymonkey.undefined'> + + Unfortunately, this object currently does not have a "falsy" value, + e.g.: + + >>> if (pymonkey.undefined): + ... print 'Huh, this is kind of unintuitive.' + Huh, this is kind of unintuitive. + + The reason for this is simply that we don't currently know how to + make this object have a falsy value, if it's even possible. + .. class:: Object This is the type of JavaScript objects. Such objects can only be
--- a/docs/rendered/genindex.html Fri Jul 10 17:07:26 2009 -0700 +++ b/docs/rendered/genindex.html Fri Jul 10 17:22:42 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="#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="#C"><strong>C</strong></a> | <a href="#E"><strong>E</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 /> @@ -90,6 +90,13 @@ <dt><a href="pymonkey.html#pymonkey.Runtime">Runtime (class in pymonkey)</a></dt></dl></td><td width="33%" valign="top"><dl> </dl></td></tr></table> +<h2 id="U">U</h2> +<table width="100%" class="indextable"><tr><td width="33%" valign="top"> +<dl> + +<dt><a href="pymonkey.html#pymonkey.undefined">undefined (in module pymonkey)</a></dt></dl></td><td width="33%" valign="top"><dl> +</dl></td></tr></table> + </div>
--- a/docs/rendered/pymonkey.html Fri Jul 10 17:07:26 2009 -0700 +++ b/docs/rendered/pymonkey.html Fri Jul 10 17:22:42 2009 -0700 @@ -54,6 +54,30 @@ <dd>This is the type of any SpiderMonkey-related errors thrown by this module.</dd></dl> +<dl class="data"> +<dt id="pymonkey.undefined"> +<tt class="descclassname">pymonkey.</tt><tt class="descname">undefined</tt><a class="headerlink" href="#pymonkey.undefined" title="Permalink to this definition">ΒΆ</a></dt> +<dd><p>This is the singleton that represents the JavaScript value +<tt class="docutils literal"><span class="pre">undefined</span></tt>, as Python has no equivalent representation +(JavaScript’s <tt class="docutils literal"><span class="pre">null</span></tt> is mapped to Python’s <tt class="xref docutils literal"><span class="pre">None</span></tt> object). +For instance:</p> +<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </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">>>> </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">>>> </span><span class="n">cx</span><span class="o">.</span><span class="n">evaluate_script</span><span class="p">(</span><span class="n">obj</span><span class="p">,</span> <span class="s">''</span><span class="p">,</span> <span class="s">'<string>'</span><span class="p">,</span> <span class="mf">1</span><span class="p">)</span> +<span class="go"><type 'pymonkey.undefined'></span> +</pre></div> +</div> +<p>Unfortunately, this object currently does not have a “falsy” value, +e.g.:</p> +<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="k">if</span> <span class="p">(</span><span class="n">pymonkey</span><span class="o">.</span><span class="n">undefined</span><span class="p">):</span> +<span class="gp">... </span> <span class="k">print</span> <span class="s">'Huh, this is kind of unintuitive.'</span> +<span class="go">Huh, this is kind of unintuitive.</span> +</pre></div> +</div> +<p>The reason for this is simply that we don’t currently know how to +make this object have a falsy value, if it’s even possible.</p> +</dd></dl> + <dl class="class"> <dt id="pymonkey.Object"> <em class="property">
--- a/docs/rendered/searchindex.js Fri Jul 10 17:07:26 2009 -0700 +++ b/docs/rendered/searchindex.js Fri Jul 10 17:22:42 2009 -0700 @@ -1,1 +1,1 @@ -Search.setIndex({desctypes:{"0":"exception","1":"class","2":"method"},terms:{spidermonkei:[0,1],all:0,code:[0,1],execut:[0,1],less:0,path_to_objdir:0,untrust:0,lack:0,becaus:0,intermediari:0,product:0,veri:0,concept:0,particularli:0,languag:0,involv:0,web:0,onli:[0,1],depend:0,just:0,expos:0,also:0,readabl:0,except:1,should:0,platform:0,add:[],busi:0,requir:0,counter:1,easier:0,isinst:1,them:0,liter:1,"return":1,around:0,thei:[],without:0,python:[0,1],swig:0,pave:0,obtain:0,envis:0,capi:0,increas:0,world:0,now:[],vast:0,enabl:0,xpcom:0,like:[0,1],anyth:0,vibrant:0,level:1,resolv:0,server:0,"try":0,easili:0,off:0,either:0,each:1,debug:0,through:1,where:0,manag:0,librari:0,mean:0,right:[],new_context:1,some:0,back:0,realli:0,"static":0,mirror:0,disadvantag:0,stack:0,collector:0,casual:0,best:1,out:0,index:0,detect:0,collect:0,test_pymonkei:[],someth:0,abl:0,rhino:0,access:[0,1],state:1,outstand:0,dynam:0,rational:0,between:0,atul:0,"new":1,objdir:0,forth:1,refer:0,docutil:1,full:0,run:0,complex:0,garbag:0,javascript:[0,1],situat:0,new_object:1,here:0,standard:0,objcec:[],extens:0,base:0,preprocessor:0,repositori:0,complementari:0,path:0,come:0,thrown:1,about:0,actual:0,easi:0,thread:1,befor:0,similar:0,current:[0,1],moment:0,page:0,instanc:0,doctest:0,context:1,logic:0,freeli:1,chang:1,com:0,tremend:0,via:[0,1],obviou:0,pyrex:0,feel:[],solut:0,modul:[0,1],runtm:1,number:0,header:0,instruct:0,api:0,serverj:0,central:0,contributor:0,mark:0,facil:0,your:0,duplic:0,quit:0,span:1,advantag:0,wai:0,script:0,ergonom:0,interact:1,due:0,custom:0,avail:0,program:1,call:1,too:0,lot:0,suit:[],interfac:1,contribut:0,type:1,"final":0,more:0,free:[],field:0,from:[0,1],relationship:0,offer:1,tool:0,mozilla:[0,1],search:0,ctype:0,indic:0,known:0,don:0,eas:0,"true":1,than:0,must:0,count:0,wide:0,made:0,packag:0,provid:0,straight:0,work:0,exampl:[],conceptu:1,can:[0,1],learn:0,akin:0,root:0,browser:0,pre:1,would:0,traceback:0,file:0,creat:[0,1],give:0,process:0,challeng:0,readm:0,ani:[0,1],doesn:0,trap:0,blah:[],exist:0,have:0,tabl:0,need:0,featur:0,check:[],probabl:0,low:1,alwai:0,sweep:0,engin:[0,1],goal:0,want:0,secur:0,boop:[],parti:0,make:0,cross:0,same:1,note:0,how:0,ideal:0,other:[0,1],read:0,build:0,which:0,test:0,verifi:1,you:0,document:0,noth:0,runtim:1,matur:0,relat:1,http:0,clone:0,object:[0,1],wherea:0,usabl:0,hand:0,fairli:0,plai:0,never:0,mai:1,develop:0,defin:0,associ:1,"class":1,pymonkei:[0,1],built:1,memori:0,land:0,sphinx:0,write:0,third:0,java:0,directori:0,macro:0,cycl:0,side:0,error:1,sandbox:0,client:0,environ:0,obj:1,thi:[0,1],programm:0,model:0,profil:0,latter:0,awesom:0},titles:["Pymonkey Documentation","<tt class=\"docutils literal docutils literal\"><span class=\"pre\">pymonkey</span></tt> — Access SpiderMonkey from Python"],modules:{pymonkey:1},descrefs:{"pymonkey.Runtime":{new_context:[1,2]},pymonkey:{Object:[1,1],Runtime:[1,1],Context:[1,1],error:[1,0]}},filenames:["index","pymonkey"]}) \ No newline at end of file +Search.setIndex({desctypes:{"0":"exception","1":"method","2":"class","3":"data"},terms:{spidermonkei:[0,1],represent:1,all:0,code:[0,1],just:0,less:0,path_to_objdir:0,untrust:0,lack:0,becaus:0,intermediari:0,product:0,veri:0,concept:0,particularli:0,environ:0,languag:0,make:[0,1],involv:0,web:0,onli:[0,1],depend:0,execut:[0,1],expos:0,also:0,readabl:0,except:1,should:0,platform:0,add:[],busi:0,requir:0,easier:0,isinst:1,them:0,liter:1,"return":1,around:0,thei:[],without:0,python:[0,1],swig:0,none:1,pave:0,obtain:0,atul:0,trap:0,envis:0,capi:0,increas:0,world:0,now:[],vast:0,enabl:0,xpcom:0,like:[0,1],level:1,vibrant:0,anyth:0,probabl:0,resolv:0,server:0,"try":0,easili:0,off:0,either:0,each:1,debug:0,through:1,where:0,manag:0,librari:0,mean:0,right:[],new_context:1,some:0,back:0,realli:0,"static":0,mirror:0,disadvantag:0,stack:0,collector:0,casual:0,best:1,out:0,even:1,index:0,detect:0,string:1,collect:0,test_pymonkei:[],someth:0,abl:0,rhino:0,access:[0,1],state:1,outstand:0,dynam:0,rational:0,between:0,print:1,"new":1,objdir:0,forth:1,challeng:0,refer:0,docutil:1,full:0,run:0,complex:0,garbag:0,javascript:[0,1],situat:0,new_object:1,here:0,standard:0,objcec:[],extens:0,reason:1,base:0,preprocessor:0,repositori:0,complementari:0,path:0,come:0,valu:1,thrown:1,about:0,actual:0,easi:0,thread:1,befor:0,similar:0,current:[0,1],moment:0,page:0,blargh:[],instanc:[0,1],doctest:0,context:1,logic:0,freeli:1,chang:1,com:0,tremend:0,singleton:1,via:[0,1],simpli:1,obviou:0,pyrex:0,feel:[],solut:0,modul:[0,1],runtm:1,number:0,header:0,instruct:0,api:0,serverj:0,central:0,contributor:0,side:0,mark:0,facil:0,your:0,duplic:0,quit:0,span:1,advantag:0,wai:0,script:0,ergonom:0,interact:1,due:0,custom:0,avail:0,process:0,program:1,call:1,low:1,lot:0,suit:[],interfac:1,type:1,"final":0,too:0,free:[],from:[0,1],relationship:0,offer:1,tool:0,mozilla:[0,1],huh:1,search:0,ctype:0,indic:0,known:0,sphinx:0,eas:0,"true":1,than:0,must:0,count:0,wide:0,kind:1,made:0,possibl:1,provid:0,straight:0,work:0,conceptu:1,can:[0,1],how:[0,1],learn:0,akin:0,more:0,root:0,browser:0,pre:1,would:0,traceback:0,file:0,creat:[0,1],give:0,falsi:1,unintuit:1,readm:0,ani:[0,1],doesn:0,repres:1,blah:[],exist:0,have:[0,1],tabl:0,need:0,unfortun:1,featur:0,check:[],contribut:0,packag:0,alwai:0,sweep:0,"null":1,engin:[0,1],goal:0,want:0,secur:0,boop:[],parti:0,latter:0,error:1,cross:0,same:1,client:0,note:0,field:0,ideal:0,other:[0,1],read:0,build:0,which:0,test:0,verifi:1,you:0,document:0,noth:0,boof:[],runtim:1,map:1,matur:0,relat:1,http:0,clone:0,object:[0,1],wherea:0,usabl:0,hand:0,fairli:0,plai:0,never:0,mai:1,develop:0,defin:0,associ:1,"class":1,pymonkei:[0,1],built:1,memori:0,todo:[],land:0,don:[0,1],equival:1,third:0,java:0,directori:0,macro:0,cycl:0,counter:1,doe:1,sandbox:0,exampl:[],write:0,obj:1,thi:[0,1],undefin:1,programm:0,model:0,profil:0,evaluate_script:1,awesom:0,know:1},titles:["Pymonkey Documentation","<tt class=\"docutils literal docutils literal\"><span class=\"pre\">pymonkey</span></tt> — Access SpiderMonkey from Python"],modules:{pymonkey:1},descrefs:{"pymonkey.Runtime":{new_context:[1,1]},pymonkey:{Object:[1,2],Runtime:[1,2],undefined:[1,3],Context:[1,2],error:[1,0]}},filenames:["index","pymonkey"]}) \ No newline at end of file
--- a/docs/src/pymonkey.txt Fri Jul 10 17:07:26 2009 -0700 +++ b/docs/src/pymonkey.txt Fri Jul 10 17:22:42 2009 -0700 @@ -16,6 +16,28 @@ This is the type of any SpiderMonkey-related errors thrown by this module. +.. data:: undefined + + This is the singleton that represents the JavaScript value + ``undefined``, as Python has no equivalent representation + (JavaScript's ``null`` is mapped to Python's ``None`` object). + For instance: + + >>> cx = pymonkey.Runtime().new_context() + >>> obj = cx.new_object() + >>> cx.evaluate_script(obj, '', '<string>', 1) + <type 'pymonkey.undefined'> + + Unfortunately, this object currently does not have a "falsy" value, + e.g.: + + >>> if (pymonkey.undefined): + ... print 'Huh, this is kind of unintuitive.' + Huh, this is kind of unintuitive. + + The reason for this is simply that we don't currently know how to + make this object have a falsy value, if it's even possible. + .. class:: Object This is the type of JavaScript objects. Such objects can only be