jack
/
cocorobolx


			
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989
							<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8">
    <title>JSDoc: Namespace: abstr</title>

    <script src="scripts/prettify/prettify.js"> </script>
    <script src="scripts/prettify/lang-css.js"> </script>
    <!--[if lt IE 9]>
      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
    <![endif]-->
    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>

<body>

<div id="main">

    <h1 class="page-title">Namespace: abstr</h1>

    
<section>

<header>
    
        <h2>
            <span class="ancestors"><a href="Sk.html">Sk</a>.</span>
        
        abstr
        </h2>
        
    
</header>

<article>
    <div class="container-overview">
    
        
<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="abstract.js.html">abstract.js</a>, <a href="abstract.js.html#line1">line 1</a>
    </li></ul></dd>
    

</dl>


    </div>

    
        <h3 class="subsection-title">Methods</h3>

        
    <h4 class="name" id=".iter"><span class="type-signature">(static) </span>iter<span class="signature">(obj)</span><span class="type-signature"> &rarr; {Object}</span></h4>

    
<div class="description">
    <p>Get the iterator for a Python object  This iterator could be one of the following.
This is the preferred mechanism for consistently getting the correct iterator.  You should
not just use tp$iter because that could lead to incorrect behavior of a user created class.</p>
<ul>
<li>tp$iter</li>
<li>A user defined <code>__iter__</code> method</li>
<li>A user defined <code>__getitem__</code> method</li>
</ul>
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>obj</code></td>
            

            <td class="type">
            
            </td>

            
            <td class="description last"></td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="abstract.js.html">abstract.js</a>, <a href="abstract.js.html#line894">line 894</a>
    </li></ul></dd>
    

</dl>


<h5>Throws:</h5>

        
    <div class="param-desc">
    
        
<span class="param-type">Sk.builtin.TypeError</span>


    </div>


<h5>Returns:</h5>

        
<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Object</span>


    </dd>
</dl>

    
    <h4 class="name" id=".lookupSpecial"><span class="type-signature">(static) </span>lookupSpecial<span class="signature">()</span><span class="type-signature"> &rarr; {null|Object}</span></h4>

    
<div class="description">
    <p>Special method look up. First try getting the method via
internal dict and getattr. If getattr is not present (builtins)
try if method is defined on the object itself</p>
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="abstract.js.html">abstract.js</a>, <a href="abstract.js.html#line954">line 954</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    <p>Return null if not found or the function</p>
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">null</span>
|

<span class="param-type">Object</span>


    </dd>
</dl>

    
    <h4 class="name" id=".markUnhashable"><span class="type-signature">(static) </span>markUnhashable<span class="signature">(thisClass)</span><span class="type-signature"> &rarr; {undefined}</span></h4>

    
<div class="description">
    <p>Mark a class as unhashable and prevent its <code>__hash__</code> function from being called.</p>
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>thisClass</code></td>
            

            <td class="type">
            
                
<span class="param-type">function</span>


            </td>

            
            <td class="description last"><p>The class to mark as unhashable.</p></td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="abstract.js.html">abstract.js</a>, <a href="abstract.js.html#line972">line 972</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">undefined</span>


    </dd>
</dl>

    
    <h4 class="name" id=".setUpInheritance"><span class="type-signature">(static) </span>setUpInheritance<span class="signature">(childName, child, parent)</span><span class="type-signature"> &rarr; {undefined}</span></h4>

    
<div class="description">
    <p>Set up inheritance between two Python classes. This allows only for single
inheritance -- multiple inheritance is not supported by Javascript.</p>
<p>Javascript's inheritance is prototypal. This means that properties must
be defined on the superclass' prototype in order for subclasses to inherit
them.</p>
<pre class="prettyprint source"><code>Sk.superclass.myProperty                 # will NOT be inherited
Sk.superclass.prototype.myProperty       # will be inherited</code></pre><p>In order for a class to be subclassable, it must (directly or indirectly)
inherit from Sk.builtin.object so that it will be properly initialized in
<a href="Sk.html#.doOneTimeInitialization">Sk.doOneTimeInitialization</a> (in src/import.js). Further, all Python
builtins should inherit from Sk.builtin.object.</p>
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>childName</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last"><p>The Python name of the child (subclass).</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>child</code></td>
            

            <td class="type">
            
                
<span class="param-type">function</span>


            </td>

            
            <td class="description last"><p>The subclass.</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>parent</code></td>
            

            <td class="type">
            
                
<span class="param-type">function</span>


            </td>

            
            <td class="description last"><p>The superclass.</p></td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="abstract.js.html">abstract.js</a>, <a href="abstract.js.html#line1001">line 1001</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">undefined</span>


    </dd>
</dl>

    
    <h4 class="name" id=".superConstructor"><span class="type-signature">(static) </span>superConstructor<span class="signature">(thisClass, self, &hellip;args)</span><span class="type-signature"> &rarr; {undefined}</span></h4>

    
<div class="description">
    <p>Call the super constructor of the provided class, with the object <code>self</code> as
the <code>this</code> value of that constructor. Any arguments passed to this function
after <code>self</code> will be passed as-is to the constructor.</p>
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>thisClass</code></td>
            

            <td class="type">
            
                
<span class="param-type">function</span>


            </td>

            
                <td class="attributes">
                

                </td>
            

            <td class="description last"><p>The subclass.</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>self</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            </td>

            
                <td class="attributes">
                

                </td>
            

            <td class="description last"><p>The instance of the subclas.</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>args</code></td>
            

            <td class="type">
            
                
<span class="param-type">?</span>


            </td>

            
                <td class="attributes">
                

                    &lt;repeatable><br>
                
                </td>
            

            <td class="description last"><p>Arguments to pass to the constructor.</p></td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="abstract.js.html">abstract.js</a>, <a href="abstract.js.html#line1018">line 1018</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">undefined</span>


    </dd>
</dl>

    
</article>

</section>


</div>

<nav>
    <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Sk.abstr.iter-seqIter.html">seqIter</a></li><li><a href="Sk.builtin.bool.html">bool</a></li><li><a href="Sk.builtin.float_.html">float_</a></li><li><a href="Sk.builtin.func.html">func</a></li><li><a href="Sk.builtin.int_.html">int_</a></li><li><a href="Sk.builtin.none.html">none</a></li><li><a href="Sk.builtin.NotImplemented.html">NotImplemented</a></li><li><a href="Sk.builtin.numtype.html">numtype</a></li><li><a href="Sk.builtin.object.html">object</a></li><li><a href="Sk.builtin.seqtype.html">seqtype</a></li><li><a href="Sk.misceval.Suspension.html">Suspension</a></li></ul><h3>Namespaces</h3><ul><li><a href="Sk.html">Sk</a></li><li><a href="Sk.abstr.html">abstr</a></li><li><a href="Sk.builtin.html">builtin</a></li><li><a href="Sk.ffi.html">ffi</a></li><li><a href="Sk.misceval.html">misceval</a></li></ul>
</nav>

<br class="clear">

<footer>
    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0</a> on Thu Aug 13 2015 08:14:27 GMT-0500 (CDT)
</footer>

<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>