<!doctype html>
<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
<head>
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>sqlobject.classregistry — SQLObject 3.7.0 documentation</title>
<link rel="stylesheet" href="../../_static/bizstyle.css" type="text/css" />
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<script type="text/javascript" src="../../_static/documentation_options.js"></script>
<script type="text/javascript" src="../../_static/jquery.js"></script>
<script type="text/javascript" src="../../_static/underscore.js"></script>
<script type="text/javascript" src="../../_static/doctools.js"></script>
<script type="text/javascript" src="../../_static/bizstyle.js"></script>
<link rel="index" title="Index" href="../../genindex.html" />
<link rel="search" title="Search" href="../../search.html" />
<meta name="viewport" content="width=device-width,initial-scale=1.0">
<!--[if lt IE 9]>
<script type="text/javascript" src="_static/css3-mediaqueries.js"></script>
<![endif]-->
</head><body>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="../../index.html">SQLObject 3.7.0 documentation</a> »</li>
<li class="nav-item nav-item-1"><a href="../index.html" accesskey="U">Module code</a> »</li>
</ul>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="../../search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<h1>Source code for sqlobject.classregistry</h1><div class="highlight"><pre>
<span></span><span class="sd">"""</span>
<span class="sd">classresolver.py</span>
<span class="sd"> 2 February 2004, Ian Bicking <ianb@colorstudy.com></span>
<span class="sd">Resolves strings to classes, and runs callbacks when referenced</span>
<span class="sd">classes are created.</span>
<span class="sd">Classes are referred to only by name, not by module. So that</span>
<span class="sd">identically-named classes can coexist, classes are put into individual</span>
<span class="sd">registries, which are keyed on strings (names). These registries are</span>
<span class="sd">created on demand.</span>
<span class="sd">Use like::</span>
<span class="sd"> >>> import classregistry</span>
<span class="sd"> >>> registry = classregistry.registry('MyModules')</span>
<span class="sd"> >>> def afterMyClassExists(cls):</span>
<span class="sd"> ... print('Class finally exists: %s' % cls)</span>
<span class="sd"> >>> registry.addClassCallback('MyClass', afterMyClassExists)</span>
<span class="sd"> >>> class MyClass:</span>
<span class="sd"> ... pass</span>
<span class="sd"> >>> registry.addClass(MyClass)</span>
<span class="sd"> Class finally exists: MyClass</span>
<span class="sd">"""</span>
<div class="viewcode-block" id="ClassRegistry"><a class="viewcode-back" href="../../api/sqlobject.classregistry.html#sqlobject.classregistry.ClassRegistry">[docs]</a><span class="k">class</span> <span class="nc">ClassRegistry</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> We'll be dealing with classes that reference each other, so</span>
<span class="sd"> class C1 may reference C2 (in a join), while C2 references</span>
<span class="sd"> C1 right back. Since classes are created in an order, there</span>
<span class="sd"> will be a point when C1 exists but C2 doesn't. So we deal</span>
<span class="sd"> with classes by name, and after each class is created we</span>
<span class="sd"> try to fix up any references by replacing the names with</span>
<span class="sd"> actual classes.</span>
<span class="sd"> Here we keep a dictionaries of class names to classes -- note</span>
<span class="sd"> that the classes might be spread among different modules, so</span>
<span class="sd"> since we pile them together names need to be globally unique,</span>
<span class="sd"> to just module unique.</span>
<span class="sd"> Like needSet below, the container dictionary is keyed by the</span>
<span class="sd"> class registry.</span>
<span class="sd"> """</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">name</span> <span class="o">=</span> <span class="n">name</span>
<span class="bp">self</span><span class="o">.</span><span class="n">classes</span> <span class="o">=</span> <span class="p">{}</span>
<span class="bp">self</span><span class="o">.</span><span class="n">callbacks</span> <span class="o">=</span> <span class="p">{}</span>
<span class="bp">self</span><span class="o">.</span><span class="n">genericCallbacks</span> <span class="o">=</span> <span class="p">[]</span>
<div class="viewcode-block" id="ClassRegistry.addClassCallback"><a class="viewcode-back" href="../../api/sqlobject.classregistry.html#sqlobject.classregistry.ClassRegistry.addClassCallback">[docs]</a> <span class="k">def</span> <span class="nf">addClassCallback</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">className</span><span class="p">,</span> <span class="n">callback</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kw</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Whenever a name is substituted for the class, you can register</span>
<span class="sd"> a callback that will be called when the needed class is</span>
<span class="sd"> created. If it's already been created, the callback will be</span>
<span class="sd"> called immediately.</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="n">className</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">classes</span><span class="p">:</span>
<span class="n">callback</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">classes</span><span class="p">[</span><span class="n">className</span><span class="p">],</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kw</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">callbacks</span><span class="o">.</span><span class="n">setdefault</span><span class="p">(</span><span class="n">className</span><span class="p">,</span> <span class="p">[])</span><span class="o">.</span><span class="n">append</span><span class="p">(</span>
<span class="p">(</span><span class="n">callback</span><span class="p">,</span> <span class="n">args</span><span class="p">,</span> <span class="n">kw</span><span class="p">))</span>
</div>
<div class="viewcode-block" id="ClassRegistry.addCallback"><a class="viewcode-back" href="../../api/sqlobject.classregistry.html#sqlobject.classregistry.ClassRegistry.addCallback">[docs]</a> <span class="k">def</span> <span class="nf">addCallback</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">callback</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kw</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> This callback is called for all classes, not just specific</span>
<span class="sd"> ones (like addClassCallback).</span>
<span class="sd"> """</span>
<span class="bp">self</span><span class="o">.</span><span class="n">genericCallbacks</span><span class="o">.</span><span class="n">append</span><span class="p">((</span><span class="n">callback</span><span class="p">,</span> <span class="n">args</span><span class="p">,</span> <span class="n">kw</span><span class="p">))</span>
<span class="k">for</span> <span class="bp">cls</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">classes</span><span class="o">.</span><span class="n">values</span><span class="p">():</span>
<span class="n">callback</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kw</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="ClassRegistry.addClass"><a class="viewcode-back" href="../../api/sqlobject.classregistry.html#sqlobject.classregistry.ClassRegistry.addClass">[docs]</a> <span class="k">def</span> <span class="nf">addClass</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="bp">cls</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Everytime a class is created, we add it to the registry, so</span>
<span class="sd"> that other classes can find it by name. We also call any</span>
<span class="sd"> callbacks that are waiting for the class.</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="bp">cls</span><span class="o">.</span><span class="vm">__name__</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">classes</span><span class="p">:</span>
<span class="kn">import</span> <span class="nn">sys</span>
<span class="n">other</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">classes</span><span class="p">[</span><span class="bp">cls</span><span class="o">.</span><span class="vm">__name__</span><span class="p">]</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span>
<span class="s2">"class </span><span class="si">%s</span><span class="s2"> is already in the registry (other class is "</span>
<span class="s2">"</span><span class="si">%r</span><span class="s2">, from the module </span><span class="si">%s</span><span class="s2"> in </span><span class="si">%s</span><span class="s2">; attempted new class is "</span>
<span class="s2">"</span><span class="si">%r</span><span class="s2">, from the module </span><span class="si">%s</span><span class="s2"> in </span><span class="si">%s</span><span class="s2">)"</span>
<span class="o">%</span> <span class="p">(</span><span class="bp">cls</span><span class="o">.</span><span class="vm">__name__</span><span class="p">,</span>
<span class="n">other</span><span class="p">,</span> <span class="n">other</span><span class="o">.</span><span class="vm">__module__</span><span class="p">,</span>
<span class="nb">getattr</span><span class="p">(</span><span class="n">sys</span><span class="o">.</span><span class="n">modules</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">other</span><span class="o">.</span><span class="vm">__module__</span><span class="p">),</span>
<span class="s1">'__file__'</span><span class="p">,</span> <span class="s1">'(unknown)'</span><span class="p">),</span>
<span class="bp">cls</span><span class="p">,</span> <span class="bp">cls</span><span class="o">.</span><span class="vm">__module__</span><span class="p">,</span>
<span class="nb">getattr</span><span class="p">(</span><span class="n">sys</span><span class="o">.</span><span class="n">modules</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="bp">cls</span><span class="o">.</span><span class="vm">__module__</span><span class="p">),</span>
<span class="s1">'__file__'</span><span class="p">,</span> <span class="s1">'(unknown)'</span><span class="p">)))</span>
<span class="bp">self</span><span class="o">.</span><span class="n">classes</span><span class="p">[</span><span class="bp">cls</span><span class="o">.</span><span class="vm">__name__</span><span class="p">]</span> <span class="o">=</span> <span class="bp">cls</span>
<span class="k">if</span> <span class="bp">cls</span><span class="o">.</span><span class="vm">__name__</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">callbacks</span><span class="p">:</span>
<span class="k">for</span> <span class="n">callback</span><span class="p">,</span> <span class="n">args</span><span class="p">,</span> <span class="n">kw</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">callbacks</span><span class="p">[</span><span class="bp">cls</span><span class="o">.</span><span class="vm">__name__</span><span class="p">]:</span>
<span class="n">callback</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kw</span><span class="p">)</span>
<span class="k">del</span> <span class="bp">self</span><span class="o">.</span><span class="n">callbacks</span><span class="p">[</span><span class="bp">cls</span><span class="o">.</span><span class="vm">__name__</span><span class="p">]</span>
<span class="k">for</span> <span class="n">callback</span><span class="p">,</span> <span class="n">args</span><span class="p">,</span> <span class="n">kw</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">genericCallbacks</span><span class="p">:</span>
<span class="n">callback</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kw</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="ClassRegistry.getClass"><a class="viewcode-back" href="../../api/sqlobject.classregistry.html#sqlobject.classregistry.ClassRegistry.getClass">[docs]</a> <span class="k">def</span> <span class="nf">getClass</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">className</span><span class="p">):</span>
<span class="k">try</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">classes</span><span class="p">[</span><span class="n">className</span><span class="p">]</span>
<span class="k">except</span> <span class="ne">KeyError</span><span class="p">:</span>
<span class="nb">all</span> <span class="o">=</span> <span class="nb">sorted</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">classes</span><span class="o">.</span><span class="n">keys</span><span class="p">())</span>
<span class="k">raise</span> <span class="ne">KeyError</span><span class="p">(</span>
<span class="s2">"No class </span><span class="si">%s</span><span class="s2"> found in the registry </span><span class="si">%s</span><span class="s2"> (these classes "</span>
<span class="s2">"exist: </span><span class="si">%s</span><span class="s2">)"</span>
<span class="o">%</span> <span class="p">(</span><span class="n">className</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">name</span> <span class="ow">or</span> <span class="s1">'[default]'</span><span class="p">,</span> <span class="s1">', '</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="nb">all</span><span class="p">)))</span>
</div>
<div class="viewcode-block" id="ClassRegistry.allClasses"><a class="viewcode-back" href="../../api/sqlobject.classregistry.html#sqlobject.classregistry.ClassRegistry.allClasses">[docs]</a> <span class="k">def</span> <span class="nf">allClasses</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">classes</span><span class="o">.</span><span class="n">values</span><span class="p">()</span>
</div></div>
<span class="k">class</span> <span class="nc">_MasterRegistry</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> This singleton holds all the class registries. There can be</span>
<span class="sd"> multiple registries to hold different unrelated sets of classes</span>
<span class="sd"> that reside in the same process. These registries are named with</span>
<span class="sd"> strings, and are created on demand. The MasterRegistry module</span>
<span class="sd"> global holds the singleton.</span>
<span class="sd"> """</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">registries</span> <span class="o">=</span> <span class="p">{}</span>
<span class="k">def</span> <span class="nf">registry</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">item</span><span class="p">):</span>
<span class="k">if</span> <span class="n">item</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">registries</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">registries</span><span class="p">[</span><span class="n">item</span><span class="p">]</span> <span class="o">=</span> <span class="n">ClassRegistry</span><span class="p">(</span><span class="n">item</span><span class="p">)</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">registries</span><span class="p">[</span><span class="n">item</span><span class="p">]</span>
<span class="n">MasterRegistry</span> <span class="o">=</span> <span class="n">_MasterRegistry</span><span class="p">()</span>
<span class="n">registry</span> <span class="o">=</span> <span class="n">MasterRegistry</span><span class="o">.</span><span class="n">registry</span>
<div class="viewcode-block" id="findClass"><a class="viewcode-back" href="../../api/sqlobject.classregistry.html#sqlobject.classregistry.findClass">[docs]</a><span class="k">def</span> <span class="nf">findClass</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">class_registry</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="k">return</span> <span class="n">registry</span><span class="p">(</span><span class="n">class_registry</span><span class="p">)</span><span class="o">.</span><span class="n">getClass</span><span class="p">(</span><span class="n">name</span><span class="p">)</span>
</pre></div></div>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="../../index.html">SQLObject 3.7.0 documentation</a> »</li>
<li class="nav-item nav-item-1"><a href="../index.html" >Module code</a> »</li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright 2004-2018, Ian Bicking and contributors.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.7.4.
</div>
</body>
</html>
distrib
>
Mageia
>
7
>
armv7hl
>
media
>
core-release
>
by-pkgid
>
f1af5ac4c8d0f3f6ef0bca84cf516f3e
>
files
>
668
