1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<h1 class="pudge-member-page-heading">
<tt>ClassRegistry</tt>
</h1>
<h4 class="pudge-member-page-subheading">
We'll be dealing with classes that reference each other, so
class C1 may reference C2 (in a join), while C2 references
C1 right back. Since classes are created in an order, there
will be a point when C1 exists but C2 doesn't. So we deal
with classes by name, and after each class is created we
try to fix up any references by replacing the names with
actual classes.
</h4>
<p class="pudge-member-parent-link">
<small>
The ClassRegistry class is accessible via the
<a href="module-sqlobject.classregistry.html">
<tt>sqlobject.classregistry</tt>
</a> module.
</small>
</p>
<div id="pudge-section-nav">
<ul>
<li>
<span class="pudge-missing-section-link">
Attributes
</span>
</li><li>
<a href="#methods" class="pudge-section-link">
Methods (9)
</a>
</li>
<li>
<a href="sqlobject/classregistry.py.html?f=28&l=114#28" class="pudge-section-link">
Source
</a>
</li>
</ul>
</div>
<div style="clear: left"></div>
<div class="rst pudge-module-doc">
<p>Here we keep a dictionaries of class names to classes -- note
that the classes might be spread among different modules, so
since we pile them together names need to be globally unique,
to just module unique.
Like needSet below, the container dictionary is keyed by the
class registry.</p>
</div>
<hr>
<a name="methods"></a>
<h2>Methods</h2>
<div class="pudge-member routine alias">
<a name="__format__"></a>
<h4 class="pudge-member-name"><span class="prefix">f</span>
<tt><a href="class-sqlobject.classregistry.ClassRegistry.html#__format__" class="pudge-obj-link">__format__</a>(...)</tt>
<a href="__builtin__.py.html" title="View Source">...</a>
</h4>
<div class="pudge-section rst">
<p class="pudge-member-blurb">
default object formatter
</p>
</div>
</div><div class="pudge-member routine alias">
<a name="__subclasshook__"></a>
<h4 class="pudge-member-name"><span class="prefix">f</span>
<tt><a href="class-sqlobject.classregistry.ClassRegistry.html#__subclasshook__" class="pudge-obj-link">__subclasshook__</a>(...)</tt>
<a href="None.html" title="View Source">...</a>
</h4>
<div class="pudge-section rst">
<p class="pudge-member-blurb">
Abstract classes can override this to customize issubclass().
</p>
<p>This is invoked early on by abc.ABCMeta.__subclasscheck__().
It should return True, False or NotImplemented. If it returns
NotImplemented, the normal algorithm is used. Otherwise, it
overrides the normal algorithm (and the outcome is cached).</p>
</div>
</div><div class="pudge-member routine alias">
<a name="__sizeof__"></a>
<h4 class="pudge-member-name"><span class="prefix">f</span>
<tt><a href="class-sqlobject.classregistry.ClassRegistry.html#__sizeof__" class="pudge-obj-link">__sizeof__</a>(...)</tt>
<a href="__builtin__.py.html" title="View Source">...</a>
</h4>
<div class="pudge-section rst">
<p class="pudge-member-blurb">
__sizeof__() -> int
size of object in memory, in bytes
</p>
</div>
</div><div class="pudge-member routine ">
<a name="__init__"></a>
<h4 class="pudge-member-name"><span class="prefix">f</span>
<tt><a href="class-sqlobject.classregistry.ClassRegistry.html#__init__" class="pudge-obj-link">__init__</a>(self, name)</tt>
<a href="sqlobject/classregistry.py.html?f=46&l=51#46" title="View Source">...</a>
</h4>
<div class="pudge-section rst">
</div>
</div><div class="pudge-member routine ">
<a name="addClassCallback"></a>
<h4 class="pudge-member-name"><span class="prefix">f</span>
<tt><a href="class-sqlobject.classregistry.ClassRegistry.html#addClassCallback" class="pudge-obj-link">addClassCallback</a>(self, className, callback, *args, **kw)</tt>
<a href="sqlobject/classregistry.py.html?f=52&l=64#52" title="View Source">...</a>
</h4>
<div class="pudge-section rst">
<p class="pudge-member-blurb">
Whenever a name is substituted for the class, you can register
a callback that will be called when the needed class is
created. If it's already been created, the callback will be
called immediately.
</p>
</div>
</div><div class="pudge-member routine ">
<a name="addCallback"></a>
<h4 class="pudge-member-name"><span class="prefix">f</span>
<tt><a href="class-sqlobject.classregistry.ClassRegistry.html#addCallback" class="pudge-obj-link">addCallback</a>(self, callback, *args, **kw)</tt>
<a href="sqlobject/classregistry.py.html?f=65&l=73#65" title="View Source">...</a>
</h4>
<div class="pudge-section rst">
<p class="pudge-member-blurb">
This callback is called for all classes, not just specific
ones (like addClassCallback).
</p>
</div>
</div><div class="pudge-member routine ">
<a name="addClass"></a>
<h4 class="pudge-member-name"><span class="prefix">f</span>
<tt><a href="class-sqlobject.classregistry.ClassRegistry.html#addClass" class="pudge-obj-link">addClass</a>(self, cls)</tt>
<a href="sqlobject/classregistry.py.html?f=74&l=101#74" title="View Source">...</a>
</h4>
<div class="pudge-section rst">
<p class="pudge-member-blurb">
Everytime a class is created, we add it to the registry, so
that other classes can find it by name. We also call any
callbacks that are waiting for the class.
</p>
</div>
</div><div class="pudge-member routine ">
<a name="getClass"></a>
<h4 class="pudge-member-name"><span class="prefix">f</span>
<tt><a href="class-sqlobject.classregistry.ClassRegistry.html#getClass" class="pudge-obj-link">getClass</a>(self, className)</tt>
<a href="sqlobject/classregistry.py.html?f=102&l=111#102" title="View Source">...</a>
</h4>
<div class="pudge-section rst">
</div>
</div><div class="pudge-member routine ">
<a name="allClasses"></a>
<h4 class="pudge-member-name"><span class="prefix">f</span>
<tt><a href="class-sqlobject.classregistry.ClassRegistry.html#allClasses" class="pudge-obj-link">allClasses</a>(self)</tt>
<a href="sqlobject/classregistry.py.html?f=112&l=114#112" title="View Source">...</a>
</h4>
<div class="pudge-section rst">
</div>
</div>
<p>
<small>
See
<a href="sqlobject/classregistry.py.html?f=28&l=114#28" title="sqlobject/classregistry.py:28">the source</a>
for more information.
</small>
</p>
|