diff docs/rendered/pymonkey.html @ 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
line wrap: on
line diff
--- 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&#8217;s <tt class="docutils literal"><span class="pre">null</span></tt> is mapped to Python&#8217;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">&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">evaluate_script</span><span class="p">(</span><span class="n">obj</span><span class="p">,</span> <span class="s">&#39;&#39;</span><span class="p">,</span> <span class="s">&#39;&lt;string&gt;&#39;</span><span class="p">,</span> <span class="mf">1</span><span class="p">)</span>
+<span class="go">&lt;type &#39;pymonkey.undefined&#39;&gt;</span>
+</pre></div>
+</div>
+<p>Unfortunately, this object currently does not have a &#8220;falsy&#8221; value,
+e.g.:</p>
+<div class="highlight-python"><div class="highlight"><pre><span class="gp">&gt;&gt;&gt; </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">&#39;Huh, this is kind of unintuitive.&#39;</span>
+<span class="go">Huh, this is kind of unintuitive.</span>
+</pre></div>
+</div>
+<p>The reason for this is simply that we don&#8217;t currently know how to
+make this object have a falsy value, if it&#8217;s even possible.</p>
+</dd></dl>
+
 <dl class="class">
 <dt id="pymonkey.Object">
 <em class="property">