/usr/share/doc/phatch/html/lib.listData.html is in phatch-doc 0.2.7.1-3.1.
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 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 | <!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>listData — Phatch 0.2 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: '0.2',
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="Phatch 0.2 documentation" href="index.html" />
<link rel="up" title="lib" href="lib.html" />
<link rel="next" title="metadata" href="lib.metadata.html" />
<link rel="prev" title="nautilusExtension" href="lib.linux.nautilusExtension.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 class="right" >
<a href="lib.metadata.html" title="metadata"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="lib.linux.nautilusExtension.html" title="nautilusExtension"
accesskey="P">previous</a> |</li>
<li><a href="index.html">Phatch 0.2 documentation</a> »</li>
<li><a href="lib.html" accesskey="U">lib</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="module-lib.listData">
<span id="listdata"></span><h1>listData<a class="headerlink" href="#module-lib.listData" title="Permalink to this headline">¶</a></h1>
<dl class="class">
<dt id="lib.listData.DataDict">
<em class="property">class </em><tt class="descclassname">lib.listData.</tt><tt class="descname">DataDict</tt><big>(</big><em>data=None</em>, <em>headers=None</em>, <em>id='id'</em><big>)</big><a class="headerlink" href="#lib.listData.DataDict" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#lib.listData.DataTuple" title="lib.listData.DataTuple"><tt class="xref py py-class docutils literal"><span class="pre">lib.listData.DataTuple</span></tt></a></p>
<dl class="method">
<dt id="lib.listData.DataDict.get">
<tt class="descname">get</tt><big>(</big><em>row</em>, <em>col</em>, <em>default=''</em><big>)</big><a class="headerlink" href="#lib.listData.DataDict.get" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the cell value specified by the row and column index.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>row</strong> (<em>int</em>) – index of row</li>
<li><strong>col</strong> (<em>int</em>) – index of column</li>
<li><strong>default</strong> – value to return if column header does not exist</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">cell value</p>
</td>
</tr>
</tbody>
</table>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">data</span> <span class="o">=</span> <span class="n">DataDict</span><span class="p">([{</span><span class="s">'id'</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s">'hello'</span><span class="p">:</span><span class="s">'world'</span><span class="p">},</span>
<span class="gp">... </span><span class="p">{</span><span class="s">'id'</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span> <span class="s">'foo'</span><span class="p">:</span><span class="s">'bar'</span><span class="p">}])</span>
<span class="gp">>>> </span><span class="n">data</span><span class="o">.</span><span class="n">get_headers</span><span class="p">()</span>
<span class="go">['foo', 'hello', 'id']</span>
<span class="gp">>>> </span><span class="n">data</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span><span class="mi">0</span><span class="p">)</span>
<span class="go">''</span>
<span class="gp">>>> </span><span class="n">data</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span><span class="mi">1</span><span class="p">)</span>
<span class="go">'world'</span>
<span class="gp">>>> </span><span class="n">data</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span><span class="mi">0</span><span class="p">)</span>
<span class="go">'bar'</span>
<span class="gp">>>> </span><span class="n">data</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span><span class="mi">1</span><span class="p">)</span>
<span class="go">''</span>
<span class="gp">>>> </span><span class="n">data</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span><span class="mi">2</span><span class="p">)</span>
<span class="go">1</span>
</pre></div>
</div>
</dd></dl>
<dl class="method">
<dt id="lib.listData.DataDict.get_by_header">
<tt class="descname">get_by_header</tt><big>(</big><em>row</em>, <em>header</em>, <em>default=''</em><big>)</big><a class="headerlink" href="#lib.listData.DataDict.get_by_header" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the cell value specified by the row and column header.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>row</strong> (<em>int</em>) – index of row</li>
<li><strong>col</strong> (<em>string</em>) – column header</li>
<li><strong>default</strong> – value to return if column header does not exist</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">cell value</p>
</td>
</tr>
</tbody>
</table>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">data</span> <span class="o">=</span> <span class="n">DataDict</span><span class="p">([{</span><span class="s">'id'</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s">'hello'</span><span class="p">:</span><span class="s">'world'</span><span class="p">},</span>
<span class="gp">... </span><span class="p">{</span><span class="s">'id'</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span> <span class="s">'foo'</span><span class="p">:</span><span class="s">'bar'</span><span class="p">}],</span> <span class="n">headers</span><span class="o">=</span><span class="p">[</span><span class="s">'foo'</span><span class="p">,</span><span class="s">'hello'</span><span class="p">])</span>
<span class="gp">>>> </span><span class="n">data</span><span class="o">.</span><span class="n">get_by_header</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span><span class="s">'foo'</span><span class="p">)</span>
<span class="go">''</span>
<span class="gp">>>> </span><span class="n">data</span><span class="o">.</span><span class="n">get_by_header</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span><span class="s">'hello'</span><span class="p">)</span>
<span class="go">'world'</span>
<span class="gp">>>> </span><span class="n">data</span><span class="o">.</span><span class="n">get_by_header</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span><span class="s">'foo'</span><span class="p">)</span>
<span class="go">'bar'</span>
</pre></div>
</div>
</dd></dl>
<dl class="method">
<dt id="lib.listData.DataDict.get_headers">
<tt class="descname">get_headers</tt><big>(</big><big>)</big><a class="headerlink" href="#lib.listData.DataDict.get_headers" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the headers of the columns.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">headers of the columns</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">list of strings</td>
</tr>
</tbody>
</table>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">data</span> <span class="o">=</span> <span class="n">DataDict</span><span class="p">([{</span><span class="s">'id'</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s">'hello'</span><span class="p">:</span><span class="s">'world'</span><span class="p">},</span>
<span class="gp">... </span><span class="p">{</span><span class="s">'id'</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span> <span class="s">'foo'</span><span class="p">:</span><span class="s">'bar'</span><span class="p">,</span> <span class="s">'hello'</span><span class="p">:</span><span class="s">'planet'</span><span class="p">}])</span>
<span class="gp">>>> </span><span class="n">data</span><span class="o">.</span><span class="n">get_headers</span><span class="p">()</span>
<span class="go">['foo', 'hello', 'id']</span>
</pre></div>
</div>
</dd></dl>
<dl class="method">
<dt id="lib.listData.DataDict.sort">
<tt class="descname">sort</tt><big>(</big><em>data</em><big>)</big><a class="headerlink" href="#lib.listData.DataDict.sort" title="Permalink to this definition">¶</a></dt>
<dd><p>Sorts the data in place.</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">DataDict</span><span class="p">(</span><span class="nb">id</span><span class="o">=</span><span class="s">'path'</span><span class="p">)</span><span class="o">.</span><span class="n">sort</span><span class="p">([{</span><span class="s">'path'</span><span class="p">:</span> <span class="s">'id1'</span><span class="p">,</span> <span class="s">'name'</span><span class="p">:</span> <span class="s">'f1'</span><span class="p">},</span>
<span class="gp">... </span><span class="p">{</span><span class="s">'path'</span><span class="p">:</span> <span class="s">'id0'</span><span class="p">,</span> <span class="s">'name'</span><span class="p">:</span> <span class="s">'f2'</span><span class="p">}])</span>
<span class="go">[{'path': 'id0', 'name': 'f2'}, {'path': 'id1', 'name': 'f1'}]</span>
</pre></div>
</div>
</dd></dl>
<dl class="method">
<dt id="lib.listData.DataDict.update_headers">
<tt class="descname">update_headers</tt><big>(</big><em>headers=None</em>, <em>all=False</em><big>)</big><a class="headerlink" href="#lib.listData.DataDict.update_headers" title="Permalink to this definition">¶</a></dt>
<dd><p>Change sequence and find all headers (dict keys) in the data.</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">data</span> <span class="o">=</span> <span class="n">DataDict</span><span class="p">([{</span><span class="s">'id'</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s">'hello'</span><span class="p">:</span><span class="s">'world'</span><span class="p">},</span>
<span class="gp">... </span><span class="p">{</span><span class="s">'id'</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span> <span class="s">'foo'</span><span class="p">:</span><span class="s">'bar'</span><span class="p">}])</span>
<span class="gp">>>> </span><span class="n">data</span><span class="o">.</span><span class="n">get_headers</span><span class="p">()</span>
<span class="go">['foo', 'hello', 'id']</span>
<span class="gp">>>> </span><span class="n">data</span><span class="o">.</span><span class="n">update_headers</span><span class="p">([</span><span class="s">'hello'</span><span class="p">])</span>
<span class="gp">>>> </span><span class="n">data</span><span class="o">.</span><span class="n">get_headers</span><span class="p">()</span>
<span class="go">['hello']</span>
<span class="gp">>>> </span><span class="n">data</span><span class="o">.</span><span class="n">update_headers</span><span class="p">([</span><span class="s">'hello'</span><span class="p">],</span> <span class="nb">all</span><span class="o">=</span><span class="bp">True</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">data</span><span class="o">.</span><span class="n">_headers</span>
<span class="go">['hello', 'foo', 'id']</span>
</pre></div>
</div>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="lib.listData.DataTuple">
<em class="property">class </em><tt class="descclassname">lib.listData.</tt><tt class="descname">DataTuple</tt><big>(</big><em>data=None</em><big>)</big><a class="headerlink" href="#lib.listData.DataTuple" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
<dl class="method">
<dt id="lib.listData.DataTuple.get">
<tt class="descname">get</tt><big>(</big><em>row</em>, <em>col</em><big>)</big><a class="headerlink" href="#lib.listData.DataTuple.get" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the cell value specified by the row and col.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>row</strong> (<em>int</em>) – index of row</li>
<li><strong>col</strong> (<em>int</em>) – index of column</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">cell value</p>
</td>
</tr>
</tbody>
</table>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">data</span> <span class="o">=</span> <span class="n">DataTuple</span><span class="p">([(</span><span class="mi">0</span><span class="p">,</span> <span class="mi">6</span><span class="p">)])</span>
<span class="gp">>>> </span><span class="n">data</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span><span class="mi">0</span><span class="p">)</span>
<span class="go">6</span>
</pre></div>
</div>
</dd></dl>
<dl class="method">
<dt id="lib.listData.DataTuple.get_headers">
<tt class="descname">get_headers</tt><big>(</big><big>)</big><a class="headerlink" href="#lib.listData.DataTuple.get_headers" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the headers of the columns.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">headers of the columns</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">list of strings</td>
</tr>
</tbody>
</table>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">data</span> <span class="o">=</span> <span class="n">DataTuple</span><span class="p">([(</span><span class="s">'id1'</span><span class="p">,</span><span class="s">'f1'</span><span class="p">),(</span><span class="s">'id0'</span><span class="p">,</span><span class="s">'f2'</span><span class="p">)])</span>
<span class="gp">>>> </span><span class="n">data</span><span class="o">.</span><span class="n">get_headers</span><span class="p">()</span>
<span class="go">['0']</span>
</pre></div>
</div>
</dd></dl>
<dl class="method">
<dt id="lib.listData.DataTuple.set_data">
<tt class="descname">set_data</tt><big>(</big><em>data</em>, <em>amount=None</em>, <em>sort=True</em><big>)</big><a class="headerlink" href="#lib.listData.DataTuple.set_data" title="Permalink to this definition">¶</a></dt>
<dd><p>The data is organised as tuple/list of tuples. Amount is how much
is visible and not necessarily the length of the data tuple!</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>data</strong> (<em>tuple/list</em>) – data organized in rows</li>
<li><strong>amount</strong> (<em>int</em>) – amount of rows visible</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">whether the underlying data has really changed</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">bool</p>
</td>
</tr>
</tbody>
</table>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">data</span> <span class="o">=</span> <span class="n">DataTuple</span><span class="p">()</span>
<span class="gp">>>> </span><span class="n">data</span><span class="o">.</span><span class="n">set_data</span><span class="p">([(</span><span class="mi">6</span><span class="p">,</span> <span class="p">),(</span><span class="mi">5</span><span class="p">,</span> <span class="p">)],</span> <span class="n">amount</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span>
<span class="go">True</span>
<span class="gp">>>> </span><span class="n">data</span><span class="o">.</span><span class="n">set_data</span><span class="p">([(</span><span class="mi">6</span><span class="p">,</span> <span class="p">),(</span><span class="mi">5</span><span class="p">,</span> <span class="p">)],</span> <span class="n">amount</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span>
<span class="go">False</span>
<span class="gp">>>> </span><span class="nb">len</span><span class="p">(</span><span class="n">data</span><span class="p">)</span> <span class="o">==</span> <span class="n">data</span><span class="o">.</span><span class="n">amount</span>
<span class="go">False</span>
</pre></div>
</div>
</dd></dl>
<dl class="method">
<dt id="lib.listData.DataTuple.set_filter">
<tt class="descname">set_filter</tt><big>(</big><em>filter</em><big>)</big><a class="headerlink" href="#lib.listData.DataTuple.set_filter" title="Permalink to this definition">¶</a></dt>
<dd><p>Filters the data which is visible. It puts the visible data
rows to the front and limits the amount. The visible data is
automatically sorted.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>filter</strong> (<em>string</em>) – substring which should appear in the data rows</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">whether the filter has really changed</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">bool</td>
</tr>
</tbody>
</table>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">data</span> <span class="o">=</span> <span class="n">DataTuple</span><span class="p">([(</span><span class="mi">6</span><span class="p">,</span> <span class="p">),(</span><span class="mi">5</span><span class="p">,</span> <span class="p">)])</span>
<span class="gp">>>> </span><span class="n">data</span><span class="o">.</span><span class="n">set_filter</span><span class="p">(</span><span class="s">'6'</span><span class="p">)</span>
<span class="go">True</span>
<span class="gp">>>> </span><span class="n">data</span><span class="o">.</span><span class="n">set_filter</span><span class="p">(</span><span class="s">'6'</span><span class="p">)</span>
<span class="go">False</span>
<span class="gp">>>> </span><span class="n">data</span><span class="o">.</span><span class="n">amount</span>
<span class="go">1</span>
<span class="gp">>>> </span><span class="nb">len</span><span class="p">(</span><span class="n">data</span><span class="p">)</span>
<span class="go">2</span>
</pre></div>
</div>
</dd></dl>
<dl class="method">
<dt id="lib.listData.DataTuple.sort">
<tt class="descname">sort</tt><big>(</big><em>data</em><big>)</big><a class="headerlink" href="#lib.listData.DataTuple.sort" title="Permalink to this definition">¶</a></dt>
<dd><p>Sorts the data in place.</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">DataTuple</span><span class="p">()</span><span class="o">.</span><span class="n">sort</span><span class="p">([(</span><span class="s">'id1'</span><span class="p">,</span><span class="s">'f1'</span><span class="p">),(</span><span class="s">'id0'</span><span class="p">,</span><span class="s">'f2'</span><span class="p">)])</span>
<span class="go">[('id0', 'f2'), ('id1', 'f1')]</span>
</pre></div>
</div>
</dd></dl>
</dd></dl>
<dl class="function">
<dt id="lib.listData.files_data_dict">
<tt class="descclassname">lib.listData.</tt><tt class="descname">files_data_dict</tt><big>(</big><em>files</em><big>)</big><a class="headerlink" href="#lib.listData.files_data_dict" title="Permalink to this definition">¶</a></dt>
<dd><p>Turns a flat file list into a hierarchical one , of which the data
values can be fed to the DataDict Class (not the whole hierarchy).</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>files</strong> (<em>list</em>) – rows which consists of tuples, each tuples contains
the full filename as the first element before other data</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">folder hierarchy</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">dict</td>
</tr>
</tbody>
</table>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="kn">import</span> <span class="nn">pprint</span>
<span class="gp">>>> </span><span class="n">files</span> <span class="o">=</span> <span class="p">[{</span><span class="s">'path'</span><span class="p">:</span> <span class="s">'f0/i00'</span><span class="p">,</span> <span class="s">'size'</span><span class="p">:</span> <span class="s">'5kb'</span><span class="p">},</span>
<span class="gp">... </span><span class="p">{</span><span class="s">'path'</span><span class="p">:</span> <span class="s">'f0/i01'</span><span class="p">,</span> <span class="s">'size'</span><span class="p">:</span> <span class="s">'1kb'</span><span class="p">},</span>
<span class="gp">... </span><span class="p">{</span><span class="s">'path'</span><span class="p">:</span> <span class="s">'f1/i10'</span><span class="p">,</span> <span class="s">'size'</span><span class="p">:</span> <span class="s">'2kb'</span><span class="p">},</span>
<span class="gp">... </span><span class="p">{</span><span class="s">'path'</span><span class="p">:</span> <span class="s">'f1/f2/i120'</span><span class="p">,</span> <span class="s">'size'</span><span class="p">:</span> <span class="s">'3kb'</span><span class="p">}]</span>
<span class="gp">>>> </span><span class="n">pprint</span><span class="o">.</span><span class="n">pprint</span><span class="p">(</span><span class="n">files_data_dict</span><span class="p">(</span><span class="n">files</span><span class="p">),</span><span class="n">width</span><span class="o">=</span><span class="mi">60</span><span class="p">)</span>
<span class="go">{'f0/': {'children': {},</span>
<span class="go"> 'data': [{'path': 'f0/i00', 'size': '5kb'},</span>
<span class="go"> {'path': 'f0/i01', 'size': '1kb'}]},</span>
<span class="go"> 'f1/': {'children': {},</span>
<span class="go"> 'data': [{'path': 'f1/i10', 'size': '2kb'}]},</span>
<span class="go"> 'f1/f2/': {'children': {},</span>
<span class="go"> 'data': [{'path': 'f1/f2/i120',</span>
<span class="go"> 'size': '3kb'}]}}</span>
</pre></div>
</div>
</dd></dl>
<dl class="function">
<dt id="lib.listData.files_data_tuple">
<tt class="descclassname">lib.listData.</tt><tt class="descname">files_data_tuple</tt><big>(</big><em>files</em><big>)</big><a class="headerlink" href="#lib.listData.files_data_tuple" title="Permalink to this definition">¶</a></dt>
<dd><p>Turns a flat file list into a hierarchical one, of which the data
values can be fed to the DataTuple Class (not the whole hierarchy).</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>files</strong> (<em>list</em>) – rows which consists of tuples, each tuples contains
the full filename as the first element before other data</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">folder hierarchy</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">dict</td>
</tr>
</tbody>
</table>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="kn">import</span> <span class="nn">pprint</span>
<span class="gp">>>> </span><span class="n">files</span> <span class="o">=</span> <span class="p">[(</span><span class="s">'f0/i00'</span><span class="p">,</span> <span class="mi">0</span><span class="p">),</span> <span class="p">(</span><span class="s">'f0/i01'</span><span class="p">,</span> <span class="mi">1</span><span class="p">),</span>
<span class="gp">... </span><span class="p">(</span><span class="s">'f1/i10'</span><span class="p">,</span> <span class="mi">2</span><span class="p">),</span> <span class="p">(</span><span class="s">'f1/f2/i120'</span><span class="p">,</span> <span class="mi">3</span><span class="p">),]</span>
<span class="gp">>>> </span><span class="n">pprint</span><span class="o">.</span><span class="n">pprint</span><span class="p">(</span><span class="n">files_data_tuple</span><span class="p">(</span><span class="n">files</span><span class="p">),</span><span class="n">width</span><span class="o">=</span><span class="mi">60</span><span class="p">)</span>
<span class="go">{'f0/': {'children': {},</span>
<span class="go"> 'data': [('f0/i00', 0), ('f0/i01', 1)]},</span>
<span class="go"> 'f1/': {'children': {}, 'data': [('f1/i10', 2)]},</span>
<span class="go"> 'f1/f2/': {'children': {}, 'data': [('f1/f2/i120', 3)]}}</span>
</pre></div>
</div>
</dd></dl>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h4>Previous topic</h4>
<p class="topless"><a href="lib.linux.nautilusExtension.html"
title="previous chapter">nautilusExtension</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="lib.metadata.html"
title="next chapter">metadata</a></p>
<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 class="right" >
<a href="lib.metadata.html" title="metadata"
>next</a> |</li>
<li class="right" >
<a href="lib.linux.nautilusExtension.html" title="nautilusExtension"
>previous</a> |</li>
<li><a href="index.html">Phatch 0.2 documentation</a> »</li>
<li><a href="lib.html" >lib</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright 2009, www.stani.be.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.2.
</div>
</body>
</html>
|