/usr/share/doc/python-reconfigure-doc/html/_modules/reconfigure/items/bound.html is in python-reconfigure-doc 0.1.74+git49a20890-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>reconfigure.items.bound — Reconfigure documentation</title>
<link rel="stylesheet" href="../../../_static/default.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../../../',
VERSION: '1.0a1',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</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>
<link rel="top" title="Reconfigure documentation" href="../../../index.html" />
<link rel="up" title="Module code" href="../../index.html" />
</head>
<body>
<div class="related">
<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><a href="../../../index.html">Reconfigure docs</a> »</li>
<li><a href="../../index.html" accesskey="U">Module code</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<h1>Source code for reconfigure.items.bound</h1><div class="highlight"><pre>
<span class="kn">import</span> <span class="nn">json</span>
<div class="viewcode-block" id="BoundCollection"><a class="viewcode-back" href="../../../ref/reconfigure.items.bound.html#reconfigure.items.bound.BoundCollection">[docs]</a><span class="k">class</span> <span class="nc">BoundCollection</span> <span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Binds a list-like object to a set of nodes</span>
<span class="sd"> :param node: target node (its children will be bound)</span>
<span class="sd"> :param item_class: :class:`BoundData` class for items</span>
<span class="sd"> :param selector: ``lambda x: bool``, used to filter out a subset of nodes</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">node</span><span class="p">,</span> <span class="n">item_class</span><span class="p">,</span> <span class="n">selector</span><span class="o">=</span><span class="k">lambda</span> <span class="n">x</span><span class="p">:</span> <span class="bp">True</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">node</span> <span class="o">=</span> <span class="n">node</span>
<span class="bp">self</span><span class="o">.</span><span class="n">selector</span> <span class="o">=</span> <span class="n">selector</span>
<span class="bp">self</span><span class="o">.</span><span class="n">item_class</span> <span class="o">=</span> <span class="n">item_class</span>
<span class="bp">self</span><span class="o">.</span><span class="n">data</span> <span class="o">=</span> <span class="p">[]</span>
<span class="bp">self</span><span class="o">.</span><span class="n">rebuild</span><span class="p">()</span>
<div class="viewcode-block" id="BoundCollection.rebuild"><a class="viewcode-back" href="../../../ref/reconfigure.items.bound.html#reconfigure.items.bound.BoundCollection.rebuild">[docs]</a> <span class="k">def</span> <span class="nf">rebuild</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Discards cached collection and rebuilds it from the nodes</span>
<span class="sd"> """</span>
<span class="k">del</span> <span class="bp">self</span><span class="o">.</span><span class="n">data</span><span class="p">[:]</span>
<span class="k">for</span> <span class="n">node</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">node</span><span class="o">.</span><span class="n">children</span><span class="p">:</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">selector</span><span class="p">(</span><span class="n">node</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">data</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">item_class</span><span class="p">(</span><span class="n">node</span><span class="p">))</span>
</div>
<div class="viewcode-block" id="BoundCollection.to_dict"><a class="viewcode-back" href="../../../ref/reconfigure.items.bound.html#reconfigure.items.bound.BoundCollection.to_dict">[docs]</a> <span class="k">def</span> <span class="nf">to_dict</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="p">[</span><span class="n">x</span><span class="o">.</span><span class="n">to_dict</span><span class="p">()</span> <span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="s">'to_dict'</span><span class="p">)</span> <span class="k">else</span> <span class="n">x</span> <span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="bp">self</span><span class="p">]</span>
</div>
<div class="viewcode-block" id="BoundCollection.to_json"><a class="viewcode-back" href="../../../ref/reconfigure.items.bound.html#reconfigure.items.bound.BoundCollection.to_json">[docs]</a> <span class="k">def</span> <span class="nf">to_json</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="n">json</span><span class="o">.</span><span class="n">dumps</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">to_dict</span><span class="p">(),</span> <span class="n">indent</span><span class="o">=</span><span class="mi">4</span><span class="p">)</span>
</div>
<span class="k">def</span> <span class="nf">__str__</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">to_json</span><span class="p">()</span>
<span class="k">def</span> <span class="nf">__iter__</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">data</span><span class="o">.</span><span class="n">__iter__</span><span class="p">()</span>
<span class="k">def</span> <span class="nf">__getitem__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">index</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">data</span><span class="o">.</span><span class="n">__getitem__</span><span class="p">(</span><span class="n">index</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">__len__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">data</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">__contains__</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">return</span> <span class="n">item</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">data</span>
<div class="viewcode-block" id="BoundCollection.append"><a class="viewcode-back" href="../../../ref/reconfigure.items.bound.html#reconfigure.items.bound.BoundCollection.append">[docs]</a> <span class="k">def</span> <span class="nf">append</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="bp">self</span><span class="o">.</span><span class="n">node</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">item</span><span class="o">.</span><span class="n">_node</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">data</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">item</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="BoundCollection.remove"><a class="viewcode-back" href="../../../ref/reconfigure.items.bound.html#reconfigure.items.bound.BoundCollection.remove">[docs]</a> <span class="k">def</span> <span class="nf">remove</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="bp">self</span><span class="o">.</span><span class="n">node</span><span class="o">.</span><span class="n">remove</span><span class="p">(</span><span class="n">item</span><span class="o">.</span><span class="n">_node</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">data</span><span class="o">.</span><span class="n">remove</span><span class="p">(</span><span class="n">item</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="BoundCollection.insert"><a class="viewcode-back" href="../../../ref/reconfigure.items.bound.html#reconfigure.items.bound.BoundCollection.insert">[docs]</a> <span class="k">def</span> <span class="nf">insert</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">index</span><span class="p">,</span> <span class="n">item</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">node</span><span class="o">.</span><span class="n">children</span><span class="o">.</span><span class="n">insert</span><span class="p">(</span><span class="n">index</span><span class="p">,</span> <span class="n">item</span><span class="o">.</span><span class="n">_node</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">data</span><span class="o">.</span><span class="n">insert</span><span class="p">(</span><span class="n">index</span><span class="p">,</span> <span class="n">item</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="BoundCollection.pop"><a class="viewcode-back" href="../../../ref/reconfigure.items.bound.html#reconfigure.items.bound.BoundCollection.pop">[docs]</a> <span class="k">def</span> <span class="nf">pop</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">index</span><span class="p">):</span>
<span class="n">d</span> <span class="o">=</span> <span class="bp">self</span><span class="p">[</span><span class="n">index</span><span class="p">]</span>
<span class="bp">self</span><span class="o">.</span><span class="n">remove</span><span class="p">(</span><span class="n">d</span><span class="p">)</span>
<span class="k">return</span> <span class="n">d</span>
</div></div>
<div class="viewcode-block" id="BoundDictionary"><a class="viewcode-back" href="../../../ref/reconfigure.items.bound.html#reconfigure.items.bound.BoundDictionary">[docs]</a><span class="k">class</span> <span class="nc">BoundDictionary</span> <span class="p">(</span><span class="n">BoundCollection</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Binds a dict-like object to a set of nodes. Accepts same params as :class:`BoundCollection` plus ``key``</span>
<span class="sd"> :param key: ``lambda value: object``, is used to get key for value in the collection</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">key</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">key</span> <span class="o">=</span> <span class="n">key</span>
<span class="n">BoundCollection</span><span class="o">.</span><span class="n">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
<div class="viewcode-block" id="BoundDictionary.rebuild"><a class="viewcode-back" href="../../../ref/reconfigure.items.bound.html#reconfigure.items.bound.BoundDictionary.rebuild">[docs]</a> <span class="k">def</span> <span class="nf">rebuild</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="n">BoundCollection</span><span class="o">.</span><span class="n">rebuild</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">rebuild_dict</span><span class="p">()</span>
</div>
<div class="viewcode-block" id="BoundDictionary.rebuild_dict"><a class="viewcode-back" href="../../../ref/reconfigure.items.bound.html#reconfigure.items.bound.BoundDictionary.rebuild_dict">[docs]</a> <span class="k">def</span> <span class="nf">rebuild_dict</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">datadict</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">((</span><span class="bp">self</span><span class="o">.</span><span class="n">key</span><span class="p">(</span><span class="n">x</span><span class="p">),</span> <span class="n">x</span><span class="p">)</span> <span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">data</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="BoundDictionary.to_dict"><a class="viewcode-back" href="../../../ref/reconfigure.items.bound.html#reconfigure.items.bound.BoundDictionary.to_dict">[docs]</a> <span class="k">def</span> <span class="nf">to_dict</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="nb">dict</span><span class="p">((</span><span class="n">k</span><span class="p">,</span> <span class="n">x</span><span class="o">.</span><span class="n">to_dict</span><span class="p">()</span> <span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="s">'to_dict'</span><span class="p">)</span> <span class="k">else</span> <span class="n">x</span><span class="p">)</span> <span class="k">for</span> <span class="n">k</span><span class="p">,</span> <span class="n">x</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">items</span><span class="p">())</span>
</div>
<span class="k">def</span> <span class="nf">__getitem__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">rebuild_dict</span><span class="p">()</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">datadict</span><span class="p">[</span><span class="n">key</span><span class="p">]</span>
<span class="k">def</span> <span class="nf">__setitem__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">rebuild_dict</span><span class="p">()</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">key</span> <span class="ow">in</span> <span class="bp">self</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">datadict</span><span class="p">[</span><span class="n">key</span><span class="p">]</span> <span class="o">=</span> <span class="n">value</span>
<span class="bp">self</span><span class="o">.</span><span class="n">rebuild_dict</span><span class="p">()</span>
<span class="k">def</span> <span class="nf">__contains__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">rebuild_dict</span><span class="p">()</span>
<span class="k">return</span> <span class="n">key</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">datadict</span>
<span class="k">def</span> <span class="nf">__iter__</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">rebuild_dict</span><span class="p">()</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">datadict</span><span class="o">.</span><span class="n">__iter__</span><span class="p">()</span>
<div class="viewcode-block" id="BoundDictionary.iteritems"><a class="viewcode-back" href="../../../ref/reconfigure.items.bound.html#reconfigure.items.bound.BoundDictionary.iteritems">[docs]</a> <span class="k">def</span> <span class="nf">iteritems</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">rebuild_dict</span><span class="p">()</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">datadict</span><span class="o">.</span><span class="n">items</span><span class="p">()</span>
</div>
<span class="n">items</span> <span class="o">=</span> <span class="n">iteritems</span>
<div class="viewcode-block" id="BoundDictionary.setdefault"><a class="viewcode-back" href="../../../ref/reconfigure.items.bound.html#reconfigure.items.bound.BoundDictionary.setdefault">[docs]</a> <span class="k">def</span> <span class="nf">setdefault</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">k</span><span class="p">,</span> <span class="n">v</span><span class="p">):</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">k</span> <span class="ow">in</span> <span class="bp">self</span><span class="p">:</span>
<span class="bp">self</span><span class="p">[</span><span class="n">k</span><span class="p">]</span> <span class="o">=</span> <span class="n">v</span>
<span class="bp">self</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">v</span><span class="p">)</span>
<span class="k">return</span> <span class="bp">self</span><span class="p">[</span><span class="n">k</span><span class="p">]</span>
</div>
<div class="viewcode-block" id="BoundDictionary.values"><a class="viewcode-back" href="../../../ref/reconfigure.items.bound.html#reconfigure.items.bound.BoundDictionary.values">[docs]</a> <span class="k">def</span> <span class="nf">values</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">rebuild_dict</span><span class="p">()</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">data</span>
</div>
<div class="viewcode-block" id="BoundDictionary.update"><a class="viewcode-back" href="../../../ref/reconfigure.items.bound.html#reconfigure.items.bound.BoundDictionary.update">[docs]</a> <span class="k">def</span> <span class="nf">update</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span>
<span class="k">for</span> <span class="n">k</span><span class="p">,</span> <span class="n">v</span> <span class="ow">in</span> <span class="n">other</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
<span class="bp">self</span><span class="p">[</span><span class="n">k</span><span class="p">]</span> <span class="o">=</span> <span class="n">v</span>
</div>
<div class="viewcode-block" id="BoundDictionary.pop"><a class="viewcode-back" href="../../../ref/reconfigure.items.bound.html#reconfigure.items.bound.BoundDictionary.pop">[docs]</a> <span class="k">def</span> <span class="nf">pop</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">):</span>
<span class="k">if</span> <span class="n">key</span> <span class="ow">in</span> <span class="bp">self</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">remove</span><span class="p">(</span><span class="bp">self</span><span class="p">[</span><span class="n">key</span><span class="p">])</span>
</div></div>
<div class="viewcode-block" id="BoundData"><a class="viewcode-back" href="../../../ref/reconfigure.items.bound.html#reconfigure.items.bound.BoundData">[docs]</a><span class="k">class</span> <span class="nc">BoundData</span> <span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Binds itself to a node.</span>
<span class="sd"> ``bind_*`` classmethods should be called on module-level, after subclass declaration.</span>
<span class="sd"> :param node: all bindings will be relative to this node</span>
<span class="sd"> :param kwargs: if ``node`` is ``None``, ``template(**kwargs)`` will be used to create node tree fragment</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">node</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="k">if</span> <span class="n">node</span> <span class="ow">is</span> <span class="bp">None</span><span class="p">:</span>
<span class="n">node</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">template</span><span class="p">(</span><span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_node</span> <span class="o">=</span> <span class="n">node</span>
<div class="viewcode-block" id="BoundData.template"><a class="viewcode-back" href="../../../ref/reconfigure.items.bound.html#reconfigure.items.bound.BoundData.template">[docs]</a> <span class="k">def</span> <span class="nf">template</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Override to create empty objects.</span>
<span class="sd"> :returns: a :class:`reconfigure.nodes.Node` tree that will be used as a template for new BoundData instance</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="bp">None</span>
</div>
<div class="viewcode-block" id="BoundData.to_dict"><a class="viewcode-back" href="../../../ref/reconfigure.items.bound.html#reconfigure.items.bound.BoundData.to_dict">[docs]</a> <span class="k">def</span> <span class="nf">to_dict</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="n">res_dict</span> <span class="o">=</span> <span class="p">{}</span>
<span class="k">for</span> <span class="n">attr_key</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">__class__</span><span class="o">.</span><span class="n">__dict__</span><span class="p">:</span>
<span class="k">if</span> <span class="n">attr_key</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">__class__</span><span class="o">.</span><span class="n">_bound</span><span class="p">:</span>
<span class="n">attr_value</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">attr_key</span><span class="p">)</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">attr_value</span><span class="p">,</span> <span class="n">BoundData</span><span class="p">):</span>
<span class="n">res_dict</span><span class="p">[</span><span class="n">attr_key</span><span class="p">]</span> <span class="o">=</span> <span class="n">attr_value</span><span class="o">.</span><span class="n">to_dict</span><span class="p">()</span>
<span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">attr_value</span><span class="p">,</span> <span class="n">BoundCollection</span><span class="p">):</span>
<span class="n">res_dict</span><span class="p">[</span><span class="n">attr_key</span><span class="p">]</span> <span class="o">=</span> <span class="n">attr_value</span><span class="o">.</span><span class="n">to_dict</span><span class="p">()</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">res_dict</span><span class="p">[</span><span class="n">attr_key</span><span class="p">]</span> <span class="o">=</span> <span class="n">attr_value</span>
<span class="k">return</span> <span class="n">res_dict</span>
</div>
<div class="viewcode-block" id="BoundData.to_json"><a class="viewcode-back" href="../../../ref/reconfigure.items.bound.html#reconfigure.items.bound.BoundData.to_json">[docs]</a> <span class="k">def</span> <span class="nf">to_json</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="n">json</span><span class="o">.</span><span class="n">dumps</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">to_dict</span><span class="p">(),</span> <span class="n">indent</span><span class="o">=</span><span class="mi">4</span><span class="p">)</span>
</div>
<span class="k">def</span> <span class="nf">__str__</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">to_json</span><span class="p">()</span>
<span class="nd">@classmethod</span>
<div class="viewcode-block" id="BoundData.bind"><a class="viewcode-back" href="../../../ref/reconfigure.items.bound.html#reconfigure.items.bound.BoundData.bind">[docs]</a> <span class="k">def</span> <span class="nf">bind</span><span class="p">(</span><span class="n">cls</span><span class="p">,</span> <span class="n">data_property</span><span class="p">,</span> <span class="n">getter</span><span class="p">,</span> <span class="n">setter</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Creates an arbitrary named property in the class with given getter and setter. Not usually used directly.</span>
<span class="sd"> :param data_property: property name</span>
<span class="sd"> :param getter: ``lambda: object``, property getter</span>
<span class="sd"> :param setter: ``lambda value: None``, property setter</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="ow">not</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">cls</span><span class="p">,</span> <span class="s">'_bound'</span><span class="p">):</span>
<span class="n">cls</span><span class="o">.</span><span class="n">_bound</span> <span class="o">=</span> <span class="p">[]</span>
<span class="n">cls</span><span class="o">.</span><span class="n">_bound</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">data_property</span><span class="p">)</span>
<span class="nb">setattr</span><span class="p">(</span><span class="n">cls</span><span class="p">,</span> <span class="n">data_property</span><span class="p">,</span> <span class="nb">property</span><span class="p">(</span><span class="n">getter</span><span class="p">,</span> <span class="n">setter</span><span class="p">))</span>
</div>
<span class="nd">@classmethod</span>
<div class="viewcode-block" id="BoundData.bind_property"><a class="viewcode-back" href="../../../ref/reconfigure.items.bound.html#reconfigure.items.bound.BoundData.bind_property">[docs]</a> <span class="k">def</span> <span class="nf">bind_property</span><span class="p">(</span><span class="n">cls</span><span class="p">,</span> <span class="n">node_property</span><span class="p">,</span> <span class="n">data_property</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> \
<span class="n">default_remove</span><span class="o">=</span><span class="p">[],</span> \
<span class="n">path</span><span class="o">=</span><span class="k">lambda</span> <span class="n">x</span><span class="p">:</span> <span class="n">x</span><span class="p">,</span> <span class="n">getter</span><span class="o">=</span><span class="k">lambda</span> <span class="n">x</span><span class="p">:</span> <span class="n">x</span><span class="p">,</span> <span class="n">setter</span><span class="o">=</span><span class="k">lambda</span> <span class="n">x</span><span class="p">:</span> <span class="n">x</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Binds the value of a child :class:`reconfigure.node.PropertyNode` to a property</span>
<span class="sd"> :param node_property: ``PropertyNode``'s ``name``</span>
<span class="sd"> :param data_property: property name to be created</span>
<span class="sd"> :param default: default value of the property (is ``PropertyNode`` doesn't exist)</span>
<span class="sd"> :param default_remove: if setting a value contained in default_remove, the target property is removed</span>
<span class="sd"> :param path: ``lambda self.node: PropertyNode``, can be used to point binding to another Node instead of ``self.node``.</span>
<span class="sd"> :param getter: ``lambda object: object``, used to transform value when getting</span>
<span class="sd"> :param setter: ``lambda object: object``, used to transform value when setting</span>
<span class="sd"> """</span>
<span class="k">def</span> <span class="nf">pget</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="n">prop</span> <span class="o">=</span> <span class="n">path</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_node</span><span class="p">)</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">node_property</span><span class="p">)</span>
<span class="k">if</span> <span class="n">prop</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">:</span>
<span class="k">return</span> <span class="n">getter</span><span class="p">(</span><span class="n">prop</span><span class="o">.</span><span class="n">value</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">return</span> <span class="n">default</span>
<span class="k">def</span> <span class="nf">pset</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
<span class="k">if</span> <span class="n">setter</span><span class="p">(</span><span class="n">value</span><span class="p">)</span> <span class="ow">in</span> <span class="n">default_remove</span><span class="p">:</span>
<span class="n">node</span> <span class="o">=</span> <span class="n">path</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_node</span><span class="p">)</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">node_property</span><span class="p">)</span>
<span class="k">if</span> <span class="n">node</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">:</span>
<span class="n">path</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_node</span><span class="p">)</span><span class="o">.</span><span class="n">remove</span><span class="p">(</span><span class="n">node</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">path</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_node</span><span class="p">)</span><span class="o">.</span><span class="n">set_property</span><span class="p">(</span><span class="n">node_property</span><span class="p">,</span> <span class="n">setter</span><span class="p">(</span><span class="n">value</span><span class="p">))</span>
<span class="n">cls</span><span class="o">.</span><span class="n">bind</span><span class="p">(</span><span class="n">data_property</span><span class="p">,</span> <span class="n">pget</span><span class="p">,</span> <span class="n">pset</span><span class="p">)</span>
</div>
<span class="nd">@classmethod</span>
<div class="viewcode-block" id="BoundData.bind_attribute"><a class="viewcode-back" href="../../../ref/reconfigure.items.bound.html#reconfigure.items.bound.BoundData.bind_attribute">[docs]</a> <span class="k">def</span> <span class="nf">bind_attribute</span><span class="p">(</span><span class="n">cls</span><span class="p">,</span> <span class="n">node_attribute</span><span class="p">,</span> <span class="n">data_property</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> \
<span class="n">path</span><span class="o">=</span><span class="k">lambda</span> <span class="n">x</span><span class="p">:</span> <span class="n">x</span><span class="p">,</span> <span class="n">getter</span><span class="o">=</span><span class="k">lambda</span> <span class="n">x</span><span class="p">:</span> <span class="n">x</span><span class="p">,</span> <span class="n">setter</span><span class="o">=</span><span class="k">lambda</span> <span class="n">x</span><span class="p">:</span> <span class="n">x</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Binds the value of node object's attribute to a property</span>
<span class="sd"> :param node_attribute: ``Node``'s attribute name</span>
<span class="sd"> :param data_property: property name to be created</span>
<span class="sd"> :param default: default value of the property (is ``PropertyNode`` doesn't exist)</span>
<span class="sd"> :param path: ``lambda self.node: PropertyNode``, can be used to point binding to another Node instead of ``self.node``.</span>
<span class="sd"> :param getter: ``lambda object: object``, used to transform value when getting</span>
<span class="sd"> :param setter: ``lambda object: object``, used to transform value when setting</span>
<span class="sd"> """</span>
<span class="k">def</span> <span class="nf">pget</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="n">prop</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">path</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_node</span><span class="p">),</span> <span class="n">node_attribute</span><span class="p">)</span>
<span class="k">if</span> <span class="n">prop</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">:</span>
<span class="k">return</span> <span class="n">getter</span><span class="p">(</span><span class="n">prop</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">return</span> <span class="n">getter</span><span class="p">(</span><span class="n">default</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">pset</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
<span class="nb">setattr</span><span class="p">(</span><span class="n">path</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_node</span><span class="p">),</span> <span class="n">node_attribute</span><span class="p">,</span> <span class="n">setter</span><span class="p">(</span><span class="n">value</span><span class="p">))</span>
<span class="n">cls</span><span class="o">.</span><span class="n">bind</span><span class="p">(</span><span class="n">data_property</span><span class="p">,</span> <span class="n">pget</span><span class="p">,</span> <span class="n">pset</span><span class="p">)</span>
</div>
<span class="nd">@classmethod</span>
<div class="viewcode-block" id="BoundData.bind_collection"><a class="viewcode-back" href="../../../ref/reconfigure.items.bound.html#reconfigure.items.bound.BoundData.bind_collection">[docs]</a> <span class="k">def</span> <span class="nf">bind_collection</span><span class="p">(</span><span class="n">cls</span><span class="p">,</span> <span class="n">data_property</span><span class="p">,</span> <span class="n">path</span><span class="o">=</span><span class="k">lambda</span> <span class="n">x</span><span class="p">:</span> <span class="n">x</span><span class="p">,</span> <span class="n">selector</span><span class="o">=</span><span class="k">lambda</span> <span class="n">x</span><span class="p">:</span> <span class="bp">True</span><span class="p">,</span> <span class="n">item_class</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> \
<span class="n">collection_class</span><span class="o">=</span><span class="n">BoundCollection</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Binds the subset of node's children to a collection property</span>
<span class="sd"> :param data_property: property name to be created</span>
<span class="sd"> :param path: ``lambda self.node: PropertyNode``, can be used to point binding to another Node instead of ``self.node``.</span>
<span class="sd"> :param selector: ``lambda Node: bool``, can be used to filter out a subset of child nodes</span>
<span class="sd"> :param item_class: a :class:`BoundData` subclass to be used for collection items</span>
<span class="sd"> :param collection_class: a :class:`BoundCollection` subclass to be used for collection property itself</span>
<span class="sd"> """</span>
<span class="k">def</span> <span class="nf">pget</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">if</span> <span class="ow">not</span> <span class="nb">hasattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s">'__'</span> <span class="o">+</span> <span class="n">data_property</span><span class="p">):</span>
<span class="nb">setattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s">'__'</span> <span class="o">+</span> <span class="n">data_property</span><span class="p">,</span>
<span class="n">collection_class</span><span class="p">(</span>
<span class="n">node</span><span class="o">=</span><span class="n">path</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_node</span><span class="p">),</span>
<span class="n">item_class</span><span class="o">=</span><span class="n">item_class</span><span class="p">,</span>
<span class="n">selector</span><span class="o">=</span><span class="n">selector</span><span class="p">,</span>
<span class="o">**</span><span class="n">kwargs</span>
<span class="p">)</span>
<span class="p">)</span>
<span class="k">return</span> <span class="nb">getattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s">'__'</span> <span class="o">+</span> <span class="n">data_property</span><span class="p">)</span>
<span class="n">cls</span><span class="o">.</span><span class="n">bind</span><span class="p">(</span><span class="n">data_property</span><span class="p">,</span> <span class="n">pget</span><span class="p">,</span> <span class="bp">None</span><span class="p">)</span>
</div>
<span class="nd">@classmethod</span>
<div class="viewcode-block" id="BoundData.bind_name"><a class="viewcode-back" href="../../../ref/reconfigure.items.bound.html#reconfigure.items.bound.BoundData.bind_name">[docs]</a> <span class="k">def</span> <span class="nf">bind_name</span><span class="p">(</span><span class="n">cls</span><span class="p">,</span> <span class="n">data_property</span><span class="p">,</span> <span class="n">getter</span><span class="o">=</span><span class="k">lambda</span> <span class="n">x</span><span class="p">:</span> <span class="n">x</span><span class="p">,</span> <span class="n">setter</span><span class="o">=</span><span class="k">lambda</span> <span class="n">x</span><span class="p">:</span> <span class="n">x</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Binds the value of node's ``name`` attribute to a property</span>
<span class="sd"> :param data_property: property name to be created</span>
<span class="sd"> :param getter: ``lambda object: object``, used to transform value when getting</span>
<span class="sd"> :param setter: ``lambda object: object``, used to transform value when setting</span>
<span class="sd"> """</span>
<span class="k">def</span> <span class="nf">pget</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="n">getter</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_node</span><span class="o">.</span><span class="n">name</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">pset</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_node</span><span class="o">.</span><span class="n">name</span> <span class="o">=</span> <span class="n">setter</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
<span class="n">cls</span><span class="o">.</span><span class="n">bind</span><span class="p">(</span><span class="n">data_property</span><span class="p">,</span> <span class="n">pget</span><span class="p">,</span> <span class="n">pset</span><span class="p">)</span>
</div>
<span class="nd">@classmethod</span>
<div class="viewcode-block" id="BoundData.bind_child"><a class="viewcode-back" href="../../../ref/reconfigure.items.bound.html#reconfigure.items.bound.BoundData.bind_child">[docs]</a> <span class="k">def</span> <span class="nf">bind_child</span><span class="p">(</span><span class="n">cls</span><span class="p">,</span> <span class="n">data_property</span><span class="p">,</span> <span class="n">path</span><span class="o">=</span><span class="k">lambda</span> <span class="n">x</span><span class="p">:</span> <span class="n">x</span><span class="p">,</span> <span class="n">item_class</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Directly binds a child Node to a BoundData property</span>
<span class="sd"> :param data_property: property name to be created</span>
<span class="sd"> :param path: ``lambda self.node: PropertyNode``, can be used to point binding to another Node instead of ``self.node``.</span>
<span class="sd"> :param item_class: a :class:`BoundData` subclass to be used for the property value</span>
<span class="sd"> """</span>
<span class="k">def</span> <span class="nf">pget</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">if</span> <span class="ow">not</span> <span class="nb">hasattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s">'__'</span> <span class="o">+</span> <span class="n">data_property</span><span class="p">):</span>
<span class="nb">setattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s">'__'</span> <span class="o">+</span> <span class="n">data_property</span><span class="p">,</span>
<span class="n">item_class</span><span class="p">(</span>
<span class="n">path</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_node</span><span class="p">),</span>
<span class="p">)</span>
<span class="p">)</span>
<span class="k">return</span> <span class="nb">getattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s">'__'</span> <span class="o">+</span> <span class="n">data_property</span><span class="p">)</span>
<span class="n">cls</span><span class="o">.</span><span class="n">bind</span><span class="p">(</span><span class="n">data_property</span><span class="p">,</span> <span class="n">pget</span><span class="p">,</span> <span class="bp">None</span><span class="p">)</span></div></div>
</pre></div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<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>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<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><a href="../../../index.html">Reconfigure docs</a> »</li>
<li><a href="../../index.html" >Module code</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright 2013, Eugeny Pankov.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
</div>
</body>
</html>
|