<html><head><title>/home/phd/current/SQLObject/SQLObject/sqlobject/classregistry.py</title> <script type="text/javascript"><!-- function show_line_range() { var href = document.location.href; if (href.indexOf('?') == -1) { return; } var qs = href.substring(href.indexOf('?')+1); if (qs.indexOf('#') >= 0) { qs = qs.substring(0, qs.indexOf('#')); } var first = qs.match(/f=(\d+)/)[1]; var last = qs.match(/l=(\d+)/)[1]; if (! first || ! last) { return; } var anchors = document.getElementsByTagName('A'); var container = document.createElement('DIV'); container.className = 'highlighted'; var children = []; var start = null; var parent = null; var highlight = false; for (var i = 0; i < anchors.length; i++) { var el = anchors[i]; if (el.getAttribute('name') == first) { start = el.previousSibling; parent = el.parentNode; highlight = true; } if (el.getAttribute('name') == last) { break; } if (highlight) { children[children.length] = el; el = el.nextSibling; while (el && el.tagName != 'A') { children[children.length] = el; el = el.nextSibling; } } } for (i=0; i<children.length; i++) { container.appendChild(children[i]); } if (start) { start.parentNode.insertBefore(container, start.nextSibling); } else { parent.insertBefore(container, parent.childNodes[0]); } } // --></script> <style> div.python { color: #333 } div.python a.lnum { color: #555; background-color: #eee; border-right: 1px solid #999; padding-right: 2px; margin-right: 4px; } div.python span.comment { color: #933 } div.python span.keyword { color: #a3e; font-weight: bold } div.python span.op { color: #c96 } div.python span.string { color: #6a6 } div.python span.name { } div.python span.text { color: #333 } div.highlighted { background-color: #ff9; border: 1px solid #009 } </style></head><body onload="show_line_range()"><div class="python"><code><a class="lnum" href="#1" name="1">0001</a><span class="string">"""</span><br /> <a class="lnum" href="#2" name="2">0002</a><span class="string">classresolver.py</span><br /> <a class="lnum" href="#3" name="3">0003</a><span class="string">  2 February 2004, Ian Bicking <ianb@colorstudy.com></span><br /> <a class="lnum" href="#4" name="4">0004</a><span class="string"></span><br /> <a class="lnum" href="#5" name="5">0005</a><span class="string">Resolves strings to classes, and runs callbacks when referenced</span><br /> <a class="lnum" href="#6" name="6">0006</a><span class="string">classes are created.</span><br /> <a class="lnum" href="#7" name="7">0007</a><span class="string"></span><br /> <a class="lnum" href="#8" name="8">0008</a><span class="string">Classes are referred to only by name, not by module.  So that</span><br /> <a class="lnum" href="#9" name="9">0009</a><span class="string">identically-named classes can coexist, classes are put into individual</span><br /> <a class="lnum" href="#10" name="10">0010</a><span class="string">registries, which are keyed on strings (names).  These registries are</span><br /> <a class="lnum" href="#11" name="11">0011</a><span class="string">created on demand.</span><br /> <a class="lnum" href="#12" name="12">0012</a><span class="string"></span><br /> <a class="lnum" href="#13" name="13">0013</a><span class="string">Use like::</span><br /> <a class="lnum" href="#14" name="14">0014</a><span class="string"></span><br /> <a class="lnum" href="#15" name="15">0015</a><span class="string">    >>> import classregistry</span><br /> <a class="lnum" href="#16" name="16">0016</a><span class="string">    >>> registry = classregistry.registry('MyModules')</span><br /> <a class="lnum" href="#17" name="17">0017</a><span class="string">    >>> def afterMyClassExists(cls):</span><br /> <a class="lnum" href="#18" name="18">0018</a><span class="string">    ...    print 'Class finally exists:', cls</span><br /> <a class="lnum" href="#19" name="19">0019</a><span class="string">    >>> registry.addClassCallback('MyClass', afterMyClassExists)</span><br /> <a class="lnum" href="#20" name="20">0020</a><span class="string">    >>> class MyClass:</span><br /> <a class="lnum" href="#21" name="21">0021</a><span class="string">    ...    pass</span><br /> <a class="lnum" href="#22" name="22">0022</a><span class="string">    >>> registry.addClass(MyClass)</span><br /> <a class="lnum" href="#23" name="23">0023</a><span class="string">    Class finally exists: MyClass</span><br /> <a class="lnum" href="#24" name="24">0024</a><span class="string"></span><br /> <a class="lnum" href="#25" name="25">0025</a><span class="string">"""</span><br /> <a class="lnum" href="#26" name="26">0026</a><br /> <a class="lnum" href="#27" name="27">0027</a><span class="keyword">class</span> <span class="name">ClassRegistry</span><span class="op">(</span><span class="name">object</span><span class="op">)</span><span class="op">:</span><br /> <a class="lnum" href="#28" name="28">0028</a>    <span class="string">"""</span><br /> <a class="lnum" href="#29" name="29">0029</a><span class="string">    We'll be dealing with classes that reference each other, so</span><br /> <a class="lnum" href="#30" name="30">0030</a><span class="string">    class C1 may reference C2 (in a join), while C2 references</span><br /> <a class="lnum" href="#31" name="31">0031</a><span class="string">    C1 right back.  Since classes are created in an order, there</span><br /> <a class="lnum" href="#32" name="32">0032</a><span class="string">    will be a point when C1 exists but C2 doesn't.  So we deal</span><br /> <a class="lnum" href="#33" name="33">0033</a><span class="string">    with classes by name, and after each class is created we</span><br /> <a class="lnum" href="#34" name="34">0034</a><span class="string">    try to fix up any references by replacing the names with</span><br /> <a class="lnum" href="#35" name="35">0035</a><span class="string">    actual classes.</span><br /> <a class="lnum" href="#36" name="36">0036</a><span class="string"></span><br /> <a class="lnum" href="#37" name="37">0037</a><span class="string">    Here we keep a dictionaries of class names to classes -- note</span><br /> <a class="lnum" href="#38" name="38">0038</a><span class="string">    that the classes might be spread among different modules, so</span><br /> <a class="lnum" href="#39" name="39">0039</a><span class="string">    since we pile them together names need to be globally unique,</span><br /> <a class="lnum" href="#40" name="40">0040</a><span class="string">    to just module unique.</span><br /> <a class="lnum" href="#41" name="41">0041</a><span class="string">    Like needSet below, the container dictionary is keyed by the</span><br /> <a class="lnum" href="#42" name="42">0042</a><span class="string">    class registry.</span><br /> <a class="lnum" href="#43" name="43">0043</a><span class="string">    """</span><br /> <a class="lnum" href="#44" name="44">0044</a><br /> <a class="lnum" href="#45" name="45">0045</a>    <span class="keyword">def</span> <span class="name">__init__</span><span class="op">(</span><span class="name">self</span><span class="op">,</span> <span class="name">name</span><span class="op">)</span><span class="op">:</span><br /> <a class="lnum" href="#46" name="46">0046</a>        <span class="name">self</span><span class="op">.</span><span class="name">name</span> <span class="op">=</span> <span class="name">name</span><br /> <a class="lnum" href="#47" name="47">0047</a>        <span class="name">self</span><span class="op">.</span><span class="name">classes</span> <span class="op">=</span> <span class="op">{</span><span class="op">}</span><br /> <a class="lnum" href="#48" name="48">0048</a>        <span class="name">self</span><span class="op">.</span><span class="name">callbacks</span> <span class="op">=</span> <span class="op">{</span><span class="op">}</span><br /> <a class="lnum" href="#49" name="49">0049</a>        <span class="name">self</span><span class="op">.</span><span class="name">genericCallbacks</span> <span class="op">=</span> <span class="op">[</span><span class="op">]</span><br /> <a class="lnum" href="#50" name="50">0050</a><br /> <a class="lnum" href="#51" name="51">0051</a>    <span class="keyword">def</span> <span class="name">addClassCallback</span><span class="op">(</span><span class="name">self</span><span class="op">,</span> <span class="name">className</span><span class="op">,</span> <span class="name">callback</span><span class="op">,</span> <span class="op">*</span><span class="name">args</span><span class="op">,</span> <span class="op">**</span><span class="name">kw</span><span class="op">)</span><span class="op">:</span><br /> <a class="lnum" href="#52" name="52">0052</a>        <span class="string">"""</span><br /> <a class="lnum" href="#53" name="53">0053</a><span class="string">        Whenever a name is substituted for the class, you can register</span><br /> <a class="lnum" href="#54" name="54">0054</a><span class="string">        a callback that will be called when the needed class is</span><br /> <a class="lnum" href="#55" name="55">0055</a><span class="string">        created.  If it's already been created, the callback will be</span><br /> <a class="lnum" href="#56" name="56">0056</a><span class="string">        called immediately.</span><br /> <a class="lnum" href="#57" name="57">0057</a><span class="string">        """</span><br /> <a class="lnum" href="#58" name="58">0058</a>        <span class="keyword">if</span> <span class="name">className</span> <span class="keyword">in</span> <span class="name">self</span><span class="op">.</span><span class="name">classes</span><span class="op">:</span><br /> <a class="lnum" href="#59" name="59">0059</a>            <span class="name">callback</span><span class="op">(</span><span class="name">self</span><span class="op">.</span><span class="name">classes</span><span class="op">[</span><span class="name">className</span><span class="op">]</span><span class="op">,</span> <span class="op">*</span><span class="name">args</span><span class="op">,</span> <span class="op">**</span><span class="name">kw</span><span class="op">)</span><br /> <a class="lnum" href="#60" name="60">0060</a>        <span class="keyword">else</span><span class="op">:</span><br /> <a class="lnum" href="#61" name="61">0061</a>            <span class="name">self</span><span class="op">.</span><span class="name">callbacks</span><span class="op">.</span><span class="name">setdefault</span><span class="op">(</span><span class="name">className</span><span class="op">,</span> <span class="op">[</span><span class="op">]</span><span class="op">)</span><span class="op">.</span><span class="name">append</span><span class="op">(</span><span class="op">(</span><span class="name">callback</span><span class="op">,</span> <span class="name">args</span><span class="op">,</span> <span class="name">kw</span><span class="op">)</span><span class="op">)</span><br /> <a class="lnum" href="#62" name="62">0062</a><br /> <a class="lnum" href="#63" name="63">0063</a>    <span class="keyword">def</span> <span class="name">addCallback</span><span class="op">(</span><span class="name">self</span><span class="op">,</span> <span class="name">callback</span><span class="op">,</span> <span class="op">*</span><span class="name">args</span><span class="op">,</span> <span class="op">**</span><span class="name">kw</span><span class="op">)</span><span class="op">:</span><br /> <a class="lnum" href="#64" name="64">0064</a>        <span class="string">"""</span><br /> <a class="lnum" href="#65" name="65">0065</a><span class="string">        This callback is called for all classes, not just specific</span><br /> <a class="lnum" href="#66" name="66">0066</a><span class="string">        ones (like addClassCallback).</span><br /> <a class="lnum" href="#67" name="67">0067</a><span class="string">        """</span><br /> <a class="lnum" href="#68" name="68">0068</a>        <span class="name">self</span><span class="op">.</span><span class="name">genericCallbacks</span><span class="op">.</span><span class="name">append</span><span class="op">(</span><span class="op">(</span><span class="name">callback</span><span class="op">,</span> <span class="name">args</span><span class="op">,</span> <span class="name">kw</span><span class="op">)</span><span class="op">)</span><br /> <a class="lnum" href="#69" name="69">0069</a>        <span class="keyword">for</span> <span class="name">cls</span> <span class="keyword">in</span> <span class="name">self</span><span class="op">.</span><span class="name">classes</span><span class="op">.</span><span class="name">values</span><span class="op">(</span><span class="op">)</span><span class="op">:</span><br /> <a class="lnum" href="#70" name="70">0070</a>            <span class="name">callback</span><span class="op">(</span><span class="name">cls</span><span class="op">,</span> <span class="op">*</span><span class="name">args</span><span class="op">,</span> <span class="op">**</span><span class="name">kw</span><span class="op">)</span><br /> <a class="lnum" href="#71" name="71">0071</a><br /> <a class="lnum" href="#72" name="72">0072</a>    <span class="keyword">def</span> <span class="name">addClass</span><span class="op">(</span><span class="name">self</span><span class="op">,</span> <span class="name">cls</span><span class="op">)</span><span class="op">:</span><br /> <a class="lnum" href="#73" name="73">0073</a>        <span class="string">"""</span><br /> <a class="lnum" href="#74" name="74">0074</a><span class="string">        Everytime a class is created, we add it to the registry, so</span><br /> <a class="lnum" href="#75" name="75">0075</a><span class="string">        that other classes can find it by name.  We also call any</span><br /> <a class="lnum" href="#76" name="76">0076</a><span class="string">        callbacks that are waiting for the class.</span><br /> <a class="lnum" href="#77" name="77">0077</a><span class="string">        """</span><br /> <a class="lnum" href="#78" name="78">0078</a>        <span class="keyword">if</span> <span class="name">cls</span><span class="op">.</span><span class="name">__name__</span> <span class="keyword">in</span> <span class="name">self</span><span class="op">.</span><span class="name">classes</span><span class="op">:</span><br /> <a class="lnum" href="#79" name="79">0079</a>            <span class="keyword">import</span> <span class="name">sys</span><br /> <a class="lnum" href="#80" name="80">0080</a>            <span class="name">other</span> <span class="op">=</span> <span class="name">self</span><span class="op">.</span><span class="name">classes</span><span class="op">[</span><span class="name">cls</span><span class="op">.</span><span class="name">__name__</span><span class="op">]</span><br /> <a class="lnum" href="#81" name="81">0081</a>            <span class="keyword">raise</span> <span class="name">ValueError</span><span class="op">(</span><br /> <a class="lnum" href="#82" name="82">0082</a>                <span class="string">"class %s is already in the registry (other class is "</span><br /> <a class="lnum" href="#83" name="83">0083</a>                <span class="string">"%r, from the module %s in %s; attempted new class is "</span><br /> <a class="lnum" href="#84" name="84">0084</a>                <span class="string">"%r, from the module %s in %s)"</span><br /> <a class="lnum" href="#85" name="85">0085</a>                <span class="op">%</span> <span class="op">(</span><span class="name">cls</span><span class="op">.</span><span class="name">__name__</span><span class="op">,</span><br /> <a class="lnum" href="#86" name="86">0086</a>                   <span class="name">other</span><span class="op">,</span> <span class="name">other</span><span class="op">.</span><span class="name">__module__</span><span class="op">,</span><br /> <a class="lnum" href="#87" name="87">0087</a>                   <span class="name">getattr</span><span class="op">(</span><span class="name">sys</span><span class="op">.</span><span class="name">modules</span><span class="op">.</span><span class="name">get</span><span class="op">(</span><span class="name">other</span><span class="op">.</span><span class="name">__module__</span><span class="op">)</span><span class="op">,</span><br /> <a class="lnum" href="#88" name="88">0088</a>                           <span class="string">'__file__'</span><span class="op">,</span> <span class="string">'(unknown)'</span><span class="op">)</span><span class="op">,</span><br /> <a class="lnum" href="#89" name="89">0089</a>                   <span class="name">cls</span><span class="op">,</span> <span class="name">cls</span><span class="op">.</span><span class="name">__module__</span><span class="op">,</span><br /> <a class="lnum" href="#90" name="90">0090</a>                   <span class="name">getattr</span><span class="op">(</span><span class="name">sys</span><span class="op">.</span><span class="name">modules</span><span class="op">.</span><span class="name">get</span><span class="op">(</span><span class="name">cls</span><span class="op">.</span><span class="name">__module__</span><span class="op">)</span><span class="op">,</span><br /> <a class="lnum" href="#91" name="91">0091</a>                           <span class="string">'__file__'</span><span class="op">,</span> <span class="string">'(unknown)'</span><span class="op">)</span><span class="op">)</span><span class="op">)</span><br /> <a class="lnum" href="#92" name="92">0092</a>        <span class="name">self</span><span class="op">.</span><span class="name">classes</span><span class="op">[</span><span class="name">cls</span><span class="op">.</span><span class="name">__name__</span><span class="op">]</span> <span class="op">=</span> <span class="name">cls</span><br /> <a class="lnum" href="#93" name="93">0093</a>        <span class="keyword">if</span> <span class="name">cls</span><span class="op">.</span><span class="name">__name__</span> <span class="keyword">in</span> <span class="name">self</span><span class="op">.</span><span class="name">callbacks</span><span class="op">:</span><br /> <a class="lnum" href="#94" name="94">0094</a>            <span class="keyword">for</span> <span class="name">callback</span><span class="op">,</span> <span class="name">args</span><span class="op">,</span> <span class="name">kw</span> <span class="keyword">in</span> <span class="name">self</span><span class="op">.</span><span class="name">callbacks</span><span class="op">[</span><span class="name">cls</span><span class="op">.</span><span class="name">__name__</span><span class="op">]</span><span class="op">:</span><br /> <a class="lnum" href="#95" name="95">0095</a>                <span class="name">callback</span><span class="op">(</span><span class="name">cls</span><span class="op">,</span> <span class="op">*</span><span class="name">args</span><span class="op">,</span> <span class="op">**</span><span class="name">kw</span><span class="op">)</span><br /> <a class="lnum" href="#96" name="96">0096</a>            <span class="keyword">del</span> <span class="name">self</span><span class="op">.</span><span class="name">callbacks</span><span class="op">[</span><span class="name">cls</span><span class="op">.</span><span class="name">__name__</span><span class="op">]</span><br /> <a class="lnum" href="#97" name="97">0097</a>        <span class="keyword">for</span> <span class="name">callback</span><span class="op">,</span> <span class="name">args</span><span class="op">,</span> <span class="name">kw</span> <span class="keyword">in</span> <span class="name">self</span><span class="op">.</span><span class="name">genericCallbacks</span><span class="op">:</span><br /> <a class="lnum" href="#98" name="98">0098</a>            <span class="name">callback</span><span class="op">(</span><span class="name">cls</span><span class="op">,</span> <span class="op">*</span><span class="name">args</span><span class="op">,</span> <span class="op">**</span><span class="name">kw</span><span class="op">)</span><br /> <a class="lnum" href="#99" name="99">0099</a><br /> <a class="lnum" href="#100" name="100">0100</a>    <span class="keyword">def</span> <span class="name">getClass</span><span class="op">(</span><span class="name">self</span><span class="op">,</span> <span class="name">className</span><span class="op">)</span><span class="op">:</span><br /> <a class="lnum" href="#101" name="101">0101</a>        <span class="keyword">try</span><span class="op">:</span><br /> <a class="lnum" href="#102" name="102">0102</a>            <span class="keyword">return</span> <span class="name">self</span><span class="op">.</span><span class="name">classes</span><span class="op">[</span><span class="name">className</span><span class="op">]</span><br /> <a class="lnum" href="#103" name="103">0103</a>        <span class="keyword">except</span> <span class="name">KeyError</span><span class="op">:</span><br /> <a class="lnum" href="#104" name="104">0104</a>            <span class="name">all</span> <span class="op">=</span> <span class="name">self</span><span class="op">.</span><span class="name">classes</span><span class="op">.</span><span class="name">keys</span><span class="op">(</span><span class="op">)</span><br /> <a class="lnum" href="#105" name="105">0105</a>            <span class="name">all</span><span class="op">.</span><span class="name">sort</span><span class="op">(</span><span class="op">)</span><br /> <a class="lnum" href="#106" name="106">0106</a>            <span class="keyword">raise</span> <span class="name">KeyError</span><span class="op">(</span><br /> <a class="lnum" href="#107" name="107">0107</a>                <span class="string">"No class %s found in the registry %s (these classes "</span><br /> <a class="lnum" href="#108" name="108">0108</a>                <span class="string">"exist: %s)"</span><br /> <a class="lnum" href="#109" name="109">0109</a>                <span class="op">%</span> <span class="op">(</span><span class="name">className</span><span class="op">,</span> <span class="name">self</span><span class="op">.</span><span class="name">name</span> <span class="keyword">or</span> <span class="string">'[default]'</span><span class="op">,</span> <span class="string">', '</span><span class="op">.</span><span class="name">join</span><span class="op">(</span><span class="name">all</span><span class="op">)</span><span class="op">)</span><span class="op">)</span><br /> <a class="lnum" href="#110" name="110">0110</a><br /> <a class="lnum" href="#111" name="111">0111</a>    <span class="keyword">def</span> <span class="name">allClasses</span><span class="op">(</span><span class="name">self</span><span class="op">)</span><span class="op">:</span><br /> <a class="lnum" href="#112" name="112">0112</a>        <span class="keyword">return</span> <span class="name">self</span><span class="op">.</span><span class="name">classes</span><span class="op">.</span><span class="name">values</span><span class="op">(</span><span class="op">)</span><br /> <a class="lnum" href="#113" name="113">0113</a><br /> <a class="lnum" href="#114" name="114">0114</a><span class="keyword">class</span> <span class="name">_MasterRegistry</span><span class="op">(</span><span class="name">object</span><span class="op">)</span><span class="op">:</span><br /> <a class="lnum" href="#115" name="115">0115</a>    <span class="string">"""</span><br /> <a class="lnum" href="#116" name="116">0116</a><span class="string">    This singleton holds all the class registries.  There can be</span><br /> <a class="lnum" href="#117" name="117">0117</a><span class="string">    multiple registries to hold different unrelated sets of classes</span><br /> <a class="lnum" href="#118" name="118">0118</a><span class="string">    that reside in the same process.  These registries are named with</span><br /> <a class="lnum" href="#119" name="119">0119</a><span class="string">    strings, and are created on demand.  The MasterRegistry module</span><br /> <a class="lnum" href="#120" name="120">0120</a><span class="string">    global holds the singleton.</span><br /> <a class="lnum" href="#121" name="121">0121</a><span class="string">    """</span><br /> <a class="lnum" href="#122" name="122">0122</a><br /> <a class="lnum" href="#123" name="123">0123</a>    <span class="keyword">def</span> <span class="name">__init__</span><span class="op">(</span><span class="name">self</span><span class="op">)</span><span class="op">:</span><br /> <a class="lnum" href="#124" name="124">0124</a>        <span class="name">self</span><span class="op">.</span><span class="name">registries</span> <span class="op">=</span> <span class="op">{</span><span class="op">}</span><br /> <a class="lnum" href="#125" name="125">0125</a><br /> <a class="lnum" href="#126" name="126">0126</a>    <span class="keyword">def</span> <span class="name">registry</span><span class="op">(</span><span class="name">self</span><span class="op">,</span> <span class="name">item</span><span class="op">)</span><span class="op">:</span><br /> <a class="lnum" href="#127" name="127">0127</a>        <span class="keyword">if</span> <span class="name">item</span> <span class="keyword">not</span> <span class="keyword">in</span> <span class="name">self</span><span class="op">.</span><span class="name">registries</span><span class="op">:</span><br /> <a class="lnum" href="#128" name="128">0128</a>            <span class="name">self</span><span class="op">.</span><span class="name">registries</span><span class="op">[</span><span class="name">item</span><span class="op">]</span> <span class="op">=</span> <span class="name">ClassRegistry</span><span class="op">(</span><span class="name">item</span><span class="op">)</span><br /> <a class="lnum" href="#129" name="129">0129</a>        <span class="keyword">return</span> <span class="name">self</span><span class="op">.</span><span class="name">registries</span><span class="op">[</span><span class="name">item</span><span class="op">]</span><br /> <a class="lnum" href="#130" name="130">0130</a><br /> <a class="lnum" href="#131" name="131">0131</a><span class="name">MasterRegistry</span> <span class="op">=</span> <span class="name">_MasterRegistry</span><span class="op">(</span><span class="op">)</span><br /> <a class="lnum" href="#132" name="132">0132</a><span class="name">registry</span> <span class="op">=</span> <span class="name">MasterRegistry</span><span class="op">.</span><span class="name">registry</span><br /> <a class="lnum" href="#133" name="133">0133</a><br /> <a class="lnum" href="#134" name="134">0134</a><span class="keyword">def</span> <span class="name">findClass</span><span class="op">(</span><span class="name">name</span><span class="op">,</span> <span class="name">class_registry</span><span class="op">=</span><span class="name">None</span><span class="op">)</span><span class="op">:</span><br /> <a class="lnum" href="#135" name="135">0135</a>    <span class="keyword">return</span> <span class="name">registry</span><span class="op">(</span><span class="name">class_registry</span><span class="op">)</span><span class="op">.</span><span class="name">getClass</span><span class="op">(</span><span class="name">name</span><span class="op">)</span></code></div></body></html>