changeset 53:2055d853b995

Added docs for pymonkey.Object.
author Atul Varma <varmaa@toolness.com>
date Fri, 10 Jul 2009 17:07:26 -0700
parents 427b01954b22
children 234fca1c4b86
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, 55 insertions(+), 11 deletions(-) [+]
line wrap: on
line diff
--- a/docs/rendered/_sources/pymonkey.txt	Wed Jul 08 18:45:38 2009 -0700
+++ b/docs/rendered/_sources/pymonkey.txt	Fri Jul 10 17:07:26 2009 -0700
@@ -16,6 +16,18 @@
    This is the type of any SpiderMonkey-related errors thrown by this
    module.
 
+.. class:: Object
+
+   This is the type of JavaScript objects. Such objects can only be
+   created via Pymonkey calls like :meth:`Context.new_object()` or
+   through the execution of JS code, but this type object can be used
+   with Python's built-in :func:`isinstance()` to verify that an
+   object is a JS object, like so:
+
+     >>> obj = pymonkey.Runtime().new_context().new_object()
+     >>> isinstance(obj, pymonkey.Object)
+     True
+
 .. class:: Context
 
    This is the type of JavaScript context objects. Contexts can only
@@ -29,9 +41,8 @@
 
 .. class:: Runtime()
 
-   Creates a new JavaScript runtime. JS objects created by the
-   runtime may interact with other JS objects of the runtime, but
-   they can't interact with objects from other runtimes.
+   Creates a new JavaScript runtime. JS objects created by the runtime
+   may only interact with other JS objects of the same runtime.
 
    .. method:: new_context()
 
--- a/docs/rendered/genindex.html	Wed Jul 08 18:45:38 2009 -0700
+++ b/docs/rendered/genindex.html	Fri Jul 10 17:07:26 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="#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> 
 
    <hr />
 
@@ -69,6 +69,13 @@
 <dt><a href="pymonkey.html#pymonkey.Runtime.new_context">new_context() (pymonkey.Runtime method)</a></dt></dl></td><td width="33%" valign="top"><dl>
 </dl></td></tr></table>
 
+<h2 id="O">O</h2>
+<table width="100%" class="indextable"><tr><td width="33%" valign="top">
+<dl>
+
+<dt><a href="pymonkey.html#pymonkey.Object">Object (class in pymonkey)</a></dt></dl></td><td width="33%" valign="top"><dl>
+</dl></td></tr></table>
+
 <h2 id="P">P</h2>
 <table width="100%" class="indextable"><tr><td width="33%" valign="top">
 <dl>
--- a/docs/rendered/pymonkey.html	Wed Jul 08 18:45:38 2009 -0700
+++ b/docs/rendered/pymonkey.html	Fri Jul 10 17:07:26 2009 -0700
@@ -55,6 +55,22 @@
 module.</dd></dl>
 
 <dl class="class">
+<dt id="pymonkey.Object">
+<em class="property">
+class </em><tt class="descclassname">pymonkey.</tt><tt class="descname">Object</tt><a class="headerlink" href="#pymonkey.Object" title="Permalink to this definition">¶</a></dt>
+<dd><p>This is the type of JavaScript objects. Such objects can only be
+created via Pymonkey calls like <tt class="xref docutils literal"><span class="pre">Context.new_object()</span></tt> or
+through the execution of JS code, but this type object can be used
+with Python&#8217;s built-in <tt class="xref docutils literal"><span class="pre">isinstance()</span></tt> to verify that an
+object is a JS object, like so:</p>
+<div class="highlight-python"><div class="highlight"><pre><span class="gp">&gt;&gt;&gt; </span><span class="n">obj</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="o">.</span><span class="n">new_object</span><span class="p">()</span>
+<span class="gp">&gt;&gt;&gt; </span><span class="nb">isinstance</span><span class="p">(</span><span class="n">obj</span><span class="p">,</span> <span class="n">pymonkey</span><span class="o">.</span><span class="n">Object</span><span class="p">)</span>
+<span class="go">True</span>
+</pre></div>
+</div>
+</dd></dl>
+
+<dl class="class">
 <dt id="pymonkey.Context">
 <em class="property">
 class </em><tt class="descclassname">pymonkey.</tt><tt class="descname">Context</tt><a class="headerlink" href="#pymonkey.Context" title="Permalink to this definition">¶</a></dt>
@@ -73,9 +89,8 @@
 <dt id="pymonkey.Runtime">
 <em class="property">
 class </em><tt class="descclassname">pymonkey.</tt><tt class="descname">Runtime</tt><a class="headerlink" href="#pymonkey.Runtime" title="Permalink to this definition">¶</a></dt>
-<dd><p>Creates a new JavaScript runtime. JS objects created by the
-runtime may interact with other JS objects of the runtime, but
-they can&#8217;t interact with objects from other runtimes.</p>
+<dd><p>Creates a new JavaScript runtime. JS objects created by the runtime
+may only interact with other JS objects of the same runtime.</p>
 <dl class="method">
 <dt id="pymonkey.Runtime.new_context">
 <tt class="descname">new_context</tt><big>(</big><big>)</big><a class="headerlink" href="#pymonkey.Runtime.new_context" title="Permalink to this definition">¶</a></dt>
--- a/docs/rendered/searchindex.js	Wed Jul 08 18:45:38 2009 -0700
+++ b/docs/rendered/searchindex.js	Fri Jul 10 17:07:26 2009 -0700
@@ -1,1 +1,1 @@
-Search.setIndex({desctypes:{"0":"exception","1":"class","2":"method"},terms:{spidermonkei:[0,1],all:0,code:0,just:0,less:0,abl:0,untrust:0,lack:0,becaus:0,cross:0,veri:0,concept:0,particularli:0,matur:0,languag:0,involv:0,web:0,onli:[0,1],depend:0,execut:[0,1],expos:0,how:0,readabl:0,except:1,should:0,platform:0,add:[],busi:0,requir:0,counter:1,easier:0,isinst:1,build:0,them:0,liter:1,"return":1,around:0,thei:1,python:[0,1],swig:0,pave:0,obtain:0,envis:0,capi:0,increas:0,world:0,now:[],"class":1,vast:0,enabl:0,xpcom:0,document:0,like:[0,1],level:1,vibrant:0,anyth:0,resolv:0,server:0,"try":0,easili:0,either:0,each:1,debug:0,where:0,manag:0,mean:0,right:[],new_context:1,some:0,back:0,realli:0,"static":0,mirror:0,disadvantag:0,collector:0,casual:0,best:1,out:0,index:0,detect:0,collect:0,facil:0,someth:0,path_to_objdir:0,rhino:0,access:[0,1],state:1,outstand:0,dynam:0,rational:0,between:0,atul:0,"new":1,objdir:0,forth:1,sphinx:0,refer:0,docutil:1,full:0,run:0,garbag:0,javascript:[0,1],situat:0,here:0,standard:0,objcec:[],extens:0,base:0,preprocessor:0,repositori:0,complementari:0,path:0,come:0,don:0,thrown:1,about:0,actual:0,easi:0,thread:1,fairli:0,root:0,current:[0,1],plai:0,page:0,instanc:0,doctest:0,context:1,logic:0,freeli:1,chang:1,com:0,other:[0,1],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,contributor:0,custom:0,test_pymonkei:[],your:0,duplic:0,quit:0,span:1,creat:[0,1],wai:0,script:0,ergonom:0,interact:1,due:0,mark:0,avail:0,program:1,call:1,too:0,lot:0,suit:[],interfac:1,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,doesn:0,known:0,central:0,eas:0,"true":1,than:0,must:0,count:0,wide:0,made:0,blah:[],provid:0,straight:0,work:0,conceptu:1,can:[0,1],learn:0,akin:0,similar:0,browser:0,pre:1,would:0,traceback:0,have:0,advantag:0,give:0,process:0,challeng:0,readm:0,ani:[0,1],indic:0,trap:0,packag:0,exist:0,file:0,tabl:0,need:0,featur:0,check:[],contribut:0,low:1,alwai:0,sweep:0,engin:[0,1],goal:0,want:0,secur:0,boop:[],parti:0,make:0,error:1,intermediari:0,same:1,client:0,note:0,also:0,ideal:0,complex:0,librari:0,which:0,test:0,verifi:1,you:0,probabl:0,noth:0,product:0,relat:1,http:0,clone:0,object:[0,1],wherea:0,usabl:0,hand:0,befor:0,moment:0,never:0,mai:1,develop:0,defin:0,associ:1,stack:0,pymonkei:[0,1],built:1,directori:0,memori:0,land:0,off:0,write:0,third:0,java:0,read:0,macro:0,cycl:0,side:0,without:0,sandbox:0,exampl:[],environ:0,runtim: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> &#8212; Access SpiderMonkey from Python"],modules:{pymonkey:1},descrefs:{"pymonkey.Runtime":{new_context:[1,2]},pymonkey:{Runtime:[1,1],Context:[1,1],error:[1,0]}},filenames:["index","pymonkey"]})
\ No newline at end of file
+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> &#8212; 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
--- a/docs/src/pymonkey.txt	Wed Jul 08 18:45:38 2009 -0700
+++ b/docs/src/pymonkey.txt	Fri Jul 10 17:07:26 2009 -0700
@@ -16,6 +16,18 @@
    This is the type of any SpiderMonkey-related errors thrown by this
    module.
 
+.. class:: Object
+
+   This is the type of JavaScript objects. Such objects can only be
+   created via Pymonkey calls like :meth:`Context.new_object()` or
+   through the execution of JS code, but this type object can be used
+   with Python's built-in :func:`isinstance()` to verify that an
+   object is a JS object, like so:
+
+     >>> obj = pymonkey.Runtime().new_context().new_object()
+     >>> isinstance(obj, pymonkey.Object)
+     True
+
 .. class:: Context
 
    This is the type of JavaScript context objects. Contexts can only
@@ -29,9 +41,8 @@
 
 .. class:: Runtime()
 
-   Creates a new JavaScript runtime. JS objects created by the
-   runtime may interact with other JS objects of the runtime, but
-   they can't interact with objects from other runtimes.
+   Creates a new JavaScript runtime. JS objects created by the runtime
+   may only interact with other JS objects of the same runtime.
 
    .. method:: new_context()