Ignore:
Timestamp:
Oct 24, 2011 2:02:30 PM (13 years ago)
Author:
Gervaise Alina <gervyh@…>
Branches:
master, ESS_GUI, ESS_GUI_Docs, ESS_GUI_batch_fitting, ESS_GUI_bumps_abstraction, ESS_GUI_iss1116, ESS_GUI_iss879, ESS_GUI_iss959, ESS_GUI_opencl, ESS_GUI_ordering, ESS_GUI_sync_sascalc, costrafo411, magnetic_scatt, release-4.1.1, release-4.1.2, release-4.2.2, release_4.0.1, ticket-1009, ticket-1094-headless, ticket-1242-2d-resolution, ticket-1243, ticket-1249, ticket885, unittest-saveload
Children:
70ecd530
Parents:
a4f04f2
Message:

updates docs

File:
1 edited

Legend:

Unmodified
Added
Removed

  • sansdataloader/docs/sphinx/html/api/loader.html

    rfc5d49e3 r7247844  
    33<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" 
    44  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 
     5 
    56 
    67<html xmlns="http://www.w3.org/1999/xhtml"> 
    … …  
    89    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> 
    910     
    10     <title>loader &mdash; DataLoader v0.1.0 documentation</title> 
     11    <title>loader &mdash; DataLoader 0.1.0 documentation</title> 
     12     
    1113    <link rel="stylesheet" href="../_static/default.css" type="text/css" /> 
    1214    <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> 
     15     
    1316    <script type="text/javascript"> 
    1417      var DOCUMENTATION_OPTIONS = { 
    … …  
    2326    <script type="text/javascript" src="../_static/underscore.js"></script> 
    2427    <script type="text/javascript" src="../_static/doctools.js"></script> 
    25     <link rel="top" title="DataLoader v0.1.0 documentation" href="../index.html" /> 
     28    <link rel="top" title="DataLoader 0.1.0 documentation" href="../index.html" /> 
    2629    <link rel="up" title="Reference" href="index.html" /> 
    2730    <link rel="next" title="manipulations" href="manipulations.html" /> 
    … …  
    4447          <a href="data_info.html" title="data_info" 
    4548             accesskey="P">previous</a> |</li> 
    46         <li><a href="../index.html">DataLoader v0.1.0 documentation</a> &raquo;</li> 
     49        <li><a href="../index.html">DataLoader 0.1.0 documentation</a> &raquo;</li> 
    4750          <li><a href="index.html" accesskey="U">Reference</a> &raquo;</li>  
    4851      </ul> 
    … …  
    5659  <div class="section" id="loader"> 
    5760<h1>loader<a class="headerlink" href="#loader" title="Permalink to this headline">¶</a></h1> 
    58 <div class="section" id="module-DataLoader.loader"> 
    59 <span id="dataloader-loader"></span><h2><a class="reference internal" href="#module-DataLoader.loader" title="DataLoader.loader"><tt class="xref py py-mod docutils literal"><span class="pre">DataLoader.loader</span></tt></a><a class="headerlink" href="#module-DataLoader.loader" title="Permalink to this headline">¶</a></h2> 
    60 <p>File handler to support different file extensions. 
     61<div class="section" id="sans-dataloader-loader"> 
     62<h2><a class="reference internal" href="#module-sans.dataloader.loader" title="sans.dataloader.loader"><tt class="xref py py-mod docutils literal"><span class="pre">sans.dataloader.loader</span></tt></a><a class="headerlink" href="#sans-dataloader-loader" title="Permalink to this headline">¶</a></h2> 
     63<span class="target" id="module-sans.dataloader.loader"></span><p>File handler to support different file extensions. 
    6164Uses reflectometry&#8217;s registry utility.</p> 
    6265<p>The default readers are found in the &#8216;readers&#8217; sub-module 
    … …  
    6871look for new readers/writers.</p> 
    6972<dl class="class"> 
    70 <dt id="DataLoader.loader.Loader"> 
    71 <em class="property">class </em><tt class="descclassname">DataLoader.loader.</tt><tt class="descname">Loader</tt><a class="headerlink" href="#DataLoader.loader.Loader" title="Permalink to this definition">¶</a></dt> 
     73<dt id="sans.dataloader.loader.Loader"> 
     74<em class="property">class </em><tt class="descclassname">sans.dataloader.loader.</tt><tt class="descname">Loader</tt><a class="headerlink" href="#sans.dataloader.loader.Loader" title="Permalink to this definition">¶</a></dt> 
    7275<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p> 
    7376<p>Utility class to use the Registry as a singleton.</p> 
    74 <dl class="method"> 
    75 <dt id="DataLoader.loader.Loader.associate_file_reader"> 
    76 <tt class="descname">associate_file_reader</tt><big>(</big><em>ext</em>, <em>loader</em><big>)</big><a class="headerlink" href="#DataLoader.loader.Loader.associate_file_reader" title="Permalink to this definition">¶</a></dt> 
     77<dl class="attribute"> 
     78<dt id="sans.dataloader.loader.Loader._Loader__registry"> 
     79<tt class="descname">_Loader__registry</tt><em class="property"> = &lt;sans.dataloader.loader.Registry object at 0x023A7870&gt;</em><a class="headerlink" href="#sans.dataloader.loader.Loader._Loader__registry" title="Permalink to this definition">¶</a></dt> 
     80<dd></dd></dl> 
     81 
     82<dl class="attribute"> 
     83<dt id="sans.dataloader.loader.Loader.__class__"> 
     84<tt class="descname">__class__</tt><a class="headerlink" href="#sans.dataloader.loader.Loader.__class__" title="Permalink to this definition">¶</a></dt> 
     85<dd><p>alias of <tt class="xref py py-class docutils literal"><span class="pre">type</span></tt></p> 
     86</dd></dl> 
     87 
     88<dl class="attribute"> 
     89<dt id="sans.dataloader.loader.Loader.__delattr__"> 
     90<tt class="descname">__delattr__</tt><a class="headerlink" href="#sans.dataloader.loader.Loader.__delattr__" title="Permalink to this definition">¶</a></dt> 
     91<dd><p>x.__delattr__(&#8216;name&#8217;) &lt;==&gt; del x.name</p> 
     92</dd></dl> 
     93 
     94<dl class="attribute"> 
     95<dt id="sans.dataloader.loader.Loader.__dict__"> 
     96<tt class="descname">__dict__</tt><em class="property"> = &lt;dictproxy object at 0x01D4DD30&gt;</em><a class="headerlink" href="#sans.dataloader.loader.Loader.__dict__" title="Permalink to this definition">¶</a></dt> 
     97<dd></dd></dl> 
     98 
     99<dl class="attribute"> 
     100<dt id="sans.dataloader.loader.Loader.__getattribute__"> 
     101<tt class="descname">__getattribute__</tt><a class="headerlink" href="#sans.dataloader.loader.Loader.__getattribute__" title="Permalink to this definition">¶</a></dt> 
     102<dd><p>x.__getattribute__(&#8216;name&#8217;) &lt;==&gt; x.name</p> 
     103</dd></dl> 
     104 
     105<dl class="attribute"> 
     106<dt id="sans.dataloader.loader.Loader.__hash__"> 
     107<tt class="descname">__hash__</tt><a class="headerlink" href="#sans.dataloader.loader.Loader.__hash__" title="Permalink to this definition">¶</a></dt> 
     108<dd><p>x.__hash__() &lt;==&gt; hash(x)</p> 
     109</dd></dl> 
     110 
     111<dl class="attribute"> 
     112<dt id="sans.dataloader.loader.Loader.__init__"> 
     113<tt class="descname">__init__</tt><a class="headerlink" href="#sans.dataloader.loader.Loader.__init__" title="Permalink to this definition">¶</a></dt> 
     114<dd><p>x.__init__(...) initializes x; see x.__class__.__doc__ for signature</p> 
     115</dd></dl> 
     116 
     117<dl class="attribute"> 
     118<dt id="sans.dataloader.loader.Loader.__module__"> 
     119<tt class="descname">__module__</tt><em class="property"> = 'sans.dataloader.loader'</em><a class="headerlink" href="#sans.dataloader.loader.Loader.__module__" title="Permalink to this definition">¶</a></dt> 
     120<dd></dd></dl> 
     121 
     122<dl class="staticmethod"> 
     123<dt id="sans.dataloader.loader.Loader.__new__"> 
     124<em class="property">static </em><tt class="descname">__new__</tt><big>(</big><em>S</em>, <em>...</em><big>)</big> &rarr; a new object with type S, a subtype of T<a class="headerlink" href="#sans.dataloader.loader.Loader.__new__" title="Permalink to this definition">¶</a></dt> 
     125<dd></dd></dl> 
     126 
     127<dl class="method"> 
     128<dt id="sans.dataloader.loader.Loader.__reduce__"> 
     129<tt class="descname">__reduce__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.loader.Loader.__reduce__" title="Permalink to this definition">¶</a></dt> 
     130<dd><p>helper for pickle</p> 
     131</dd></dl> 
     132 
     133<dl class="method"> 
     134<dt id="sans.dataloader.loader.Loader.__reduce_ex__"> 
     135<tt class="descname">__reduce_ex__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.loader.Loader.__reduce_ex__" title="Permalink to this definition">¶</a></dt> 
     136<dd><p>helper for pickle</p> 
     137</dd></dl> 
     138 
     139<dl class="attribute"> 
     140<dt id="sans.dataloader.loader.Loader.__repr__"> 
     141<tt class="descname">__repr__</tt><a class="headerlink" href="#sans.dataloader.loader.Loader.__repr__" title="Permalink to this definition">¶</a></dt> 
     142<dd><p>x.__repr__() &lt;==&gt; repr(x)</p> 
     143</dd></dl> 
     144 
     145<dl class="attribute"> 
     146<dt id="sans.dataloader.loader.Loader.__setattr__"> 
     147<tt class="descname">__setattr__</tt><a class="headerlink" href="#sans.dataloader.loader.Loader.__setattr__" title="Permalink to this definition">¶</a></dt> 
     148<dd><p>x.__setattr__(&#8216;name&#8217;, value) &lt;==&gt; x.name = value</p> 
     149</dd></dl> 
     150 
     151<dl class="attribute"> 
     152<dt id="sans.dataloader.loader.Loader.__str__"> 
     153<tt class="descname">__str__</tt><a class="headerlink" href="#sans.dataloader.loader.Loader.__str__" title="Permalink to this definition">¶</a></dt> 
     154<dd><p>x.__str__() &lt;==&gt; str(x)</p> 
     155</dd></dl> 
     156 
     157<dl class="attribute"> 
     158<dt id="sans.dataloader.loader.Loader.__weakref__"> 
     159<tt class="descname">__weakref__</tt><a class="headerlink" href="#sans.dataloader.loader.Loader.__weakref__" title="Permalink to this definition">¶</a></dt> 
     160<dd><p>list of weak references to the object (if defined)</p> 
     161</dd></dl> 
     162 
     163<dl class="method"> 
     164<dt id="sans.dataloader.loader.Loader._get_registry_creation_time"> 
     165<tt class="descname">_get_registry_creation_time</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.loader.Loader._get_registry_creation_time" title="Permalink to this definition">¶</a></dt> 
     166<dd><p>Internal method used to test the uniqueness 
     167of the registry object</p> 
     168</dd></dl> 
     169 
     170<dl class="method"> 
     171<dt id="sans.dataloader.loader.Loader.associate_file_reader"> 
     172<tt class="descname">associate_file_reader</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.loader.Loader.associate_file_reader" title="Permalink to this definition">¶</a></dt> 
    77173<dd><p>Append a reader object to readers</p> 
    78174<table class="docutils field-list" frame="void" rules="none"> 
    … …  
    80176<col class="field-body" /> 
    81177<tbody valign="top"> 
    82 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
     178<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
    83179<li><strong>ext</strong> &#8211; file extension [string]</li> 
    84180<li><strong>module</strong> &#8211; reader object</li> 
    … …  
    91187 
    92188<dl class="method"> 
    93 <dt id="DataLoader.loader.Loader.associate_file_type"> 
    94 <tt class="descname">associate_file_type</tt><big>(</big><em>ext</em>, <em>module</em><big>)</big><a class="headerlink" href="#DataLoader.loader.Loader.associate_file_type" title="Permalink to this definition">¶</a></dt> 
     189<dt id="sans.dataloader.loader.Loader.associate_file_type"> 
     190<tt class="descname">associate_file_type</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.loader.Loader.associate_file_type" title="Permalink to this definition">¶</a></dt> 
    95191<dd><p>Look into a module to find whether it contains a  
    96192Reader class. If so, append it to readers and (potentially) 
    … …  
    100196<col class="field-body" /> 
    101197<tbody valign="top"> 
    102 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
     198<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
    103199<li><strong>ext</strong> &#8211; file extension [string]</li> 
    104200<li><strong>module</strong> &#8211; module object</li> 
    … …  
    111207 
    112208<dl class="method"> 
    113 <dt id="DataLoader.loader.Loader.find_plugins"> 
    114 <tt class="descname">find_plugins</tt><big>(</big><em>dir</em><big>)</big><a class="headerlink" href="#DataLoader.loader.Loader.find_plugins" title="Permalink to this definition">¶</a></dt> 
     209<dt id="sans.dataloader.loader.Loader.find_plugins"> 
     210<tt class="descname">find_plugins</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.loader.Loader.find_plugins" title="Permalink to this definition">¶</a></dt> 
    115211<dd><p>Find plugins in a given directory</p> 
    116212<table class="docutils field-list" frame="void" rules="none"> 
    … …  
    118214<col class="field-body" /> 
    119215<tbody valign="top"> 
    120 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>dir</strong> &#8211; directory to look into to find new readers/writers</td> 
    121 </tr> 
    122 </tbody> 
    123 </table> 
    124 </dd></dl> 
    125  
    126 <dl class="method"> 
    127 <dt id="DataLoader.loader.Loader.get_wildcards"> 
    128 <tt class="descname">get_wildcards</tt><big>(</big><big>)</big><a class="headerlink" href="#DataLoader.loader.Loader.get_wildcards" title="Permalink to this definition">¶</a></dt> 
    129 <dd></dd></dl> 
    130  
    131 <dl class="method"> 
    132 <dt id="DataLoader.loader.Loader.load"> 
    133 <tt class="descname">load</tt><big>(</big><em>file</em>, <em>format=None</em><big>)</big><a class="headerlink" href="#DataLoader.loader.Loader.load" title="Permalink to this definition">¶</a></dt> 
     216<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>dir</strong> &#8211; directory to look into to find new readers/writers</td> 
     217</tr> 
     218</tbody> 
     219</table> 
     220</dd></dl> 
     221 
     222<dl class="method"> 
     223<dt id="sans.dataloader.loader.Loader.get_wildcards"> 
     224<tt class="descname">get_wildcards</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.loader.Loader.get_wildcards" title="Permalink to this definition">¶</a></dt> 
     225<dd></dd></dl> 
     226 
     227<dl class="method"> 
     228<dt id="sans.dataloader.loader.Loader.load"> 
     229<tt class="descname">load</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.loader.Loader.load" title="Permalink to this definition">¶</a></dt> 
    134230<dd><p>Load a file</p> 
    135231<table class="docutils field-list" frame="void" rules="none"> 
    … …  
    137233<col class="field-body" /> 
    138234<tbody valign="top"> 
    139 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> 
     235<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> 
    140236<li><strong>file</strong> &#8211; file name (path)</li> 
    141237<li><strong>format</strong> &#8211; specified format to use (optional)</li> 
    … …  
    143239</td> 
    144240</tr> 
    145 <tr class="field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">DataInfo object</p> 
    146 </td> 
    147 </tr> 
    148 </tbody> 
    149 </table> 
    150 </dd></dl> 
    151  
    152 <dl class="method"> 
    153 <dt id="DataLoader.loader.Loader.save"> 
    154 <tt class="descname">save</tt><big>(</big><em>file</em>, <em>data</em>, <em>format</em><big>)</big><a class="headerlink" href="#DataLoader.loader.Loader.save" title="Permalink to this definition">¶</a></dt> 
     241<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">DataInfo object</p> 
     242</td> 
     243</tr> 
     244</tbody> 
     245</table> 
     246</dd></dl> 
     247 
     248<dl class="method"> 
     249<dt id="sans.dataloader.loader.Loader.save"> 
     250<tt class="descname">save</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.loader.Loader.save" title="Permalink to this definition">¶</a></dt> 
    155251<dd><p>Save a DataInfo object to file 
    156252:param file: file name (path) 
    … …  
    162258 
    163259<dl class="class"> 
    164 <dt id="DataLoader.loader.Registry"> 
    165 <em class="property">class </em><tt class="descclassname">DataLoader.loader.</tt><tt class="descname">Registry</tt><a class="headerlink" href="#DataLoader.loader.Registry" title="Permalink to this definition">¶</a></dt> 
     260<dt id="sans.dataloader.loader.Registry"> 
     261<em class="property">class </em><tt class="descclassname">sans.dataloader.loader.</tt><tt class="descname">Registry</tt><a class="headerlink" href="#sans.dataloader.loader.Registry" title="Permalink to this definition">¶</a></dt> 
    166262<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">data_util.registry.ExtensionRegistry</span></tt></p> 
    167263<p>Registry class for file format extensions. 
    168264Readers and writers are supported.</p> 
    169 <dl class="method"> 
    170 <dt id="DataLoader.loader.Registry.associate_file_reader"> 
    171 <tt class="descname">associate_file_reader</tt><big>(</big><em>ext</em>, <em>loader</em><big>)</big><a class="headerlink" href="#DataLoader.loader.Registry.associate_file_reader" title="Permalink to this definition">¶</a></dt> 
     265<dl class="attribute"> 
     266<dt id="sans.dataloader.loader.Registry.__class__"> 
     267<tt class="descname">__class__</tt><a class="headerlink" href="#sans.dataloader.loader.Registry.__class__" title="Permalink to this definition">¶</a></dt> 
     268<dd><p>alias of <tt class="xref py py-class docutils literal"><span class="pre">type</span></tt></p> 
     269</dd></dl> 
     270 
     271<dl class="method"> 
     272<dt id="sans.dataloader.loader.Registry.__contains__"> 
     273<tt class="descname">__contains__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.loader.Registry.__contains__" title="Permalink to this definition">¶</a></dt> 
     274<dd></dd></dl> 
     275 
     276<dl class="attribute"> 
     277<dt id="sans.dataloader.loader.Registry.__delattr__"> 
     278<tt class="descname">__delattr__</tt><a class="headerlink" href="#sans.dataloader.loader.Registry.__delattr__" title="Permalink to this definition">¶</a></dt> 
     279<dd><p>x.__delattr__(&#8216;name&#8217;) &lt;==&gt; del x.name</p> 
     280</dd></dl> 
     281 
     282<dl class="attribute"> 
     283<dt id="sans.dataloader.loader.Registry.__dict__"> 
     284<tt class="descname">__dict__</tt><em class="property"> = &lt;dictproxy object at 0x01D30550&gt;</em><a class="headerlink" href="#sans.dataloader.loader.Registry.__dict__" title="Permalink to this definition">¶</a></dt> 
     285<dd></dd></dl> 
     286 
     287<dl class="attribute"> 
     288<dt id="sans.dataloader.loader.Registry.__getattribute__"> 
     289<tt class="descname">__getattribute__</tt><a class="headerlink" href="#sans.dataloader.loader.Registry.__getattribute__" title="Permalink to this definition">¶</a></dt> 
     290<dd><p>x.__getattribute__(&#8216;name&#8217;) &lt;==&gt; x.name</p> 
     291</dd></dl> 
     292 
     293<dl class="method"> 
     294<dt id="sans.dataloader.loader.Registry.__getitem__"> 
     295<tt class="descname">__getitem__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.loader.Registry.__getitem__" title="Permalink to this definition">¶</a></dt> 
     296<dd></dd></dl> 
     297 
     298<dl class="attribute"> 
     299<dt id="sans.dataloader.loader.Registry.__hash__"> 
     300<tt class="descname">__hash__</tt><a class="headerlink" href="#sans.dataloader.loader.Registry.__hash__" title="Permalink to this definition">¶</a></dt> 
     301<dd><p>x.__hash__() &lt;==&gt; hash(x)</p> 
     302</dd></dl> 
     303 
     304<dl class="method"> 
     305<dt id="sans.dataloader.loader.Registry.__init__"> 
     306<tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.loader.Registry.__init__" title="Permalink to this definition">¶</a></dt> 
     307<dd></dd></dl> 
     308 
     309<dl class="attribute"> 
     310<dt id="sans.dataloader.loader.Registry.__module__"> 
     311<tt class="descname">__module__</tt><em class="property"> = 'sans.dataloader.loader'</em><a class="headerlink" href="#sans.dataloader.loader.Registry.__module__" title="Permalink to this definition">¶</a></dt> 
     312<dd></dd></dl> 
     313 
     314<dl class="staticmethod"> 
     315<dt id="sans.dataloader.loader.Registry.__new__"> 
     316<em class="property">static </em><tt class="descname">__new__</tt><big>(</big><em>S</em>, <em>...</em><big>)</big> &rarr; a new object with type S, a subtype of T<a class="headerlink" href="#sans.dataloader.loader.Registry.__new__" title="Permalink to this definition">¶</a></dt> 
     317<dd></dd></dl> 
     318 
     319<dl class="method"> 
     320<dt id="sans.dataloader.loader.Registry.__reduce__"> 
     321<tt class="descname">__reduce__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.loader.Registry.__reduce__" title="Permalink to this definition">¶</a></dt> 
     322<dd><p>helper for pickle</p> 
     323</dd></dl> 
     324 
     325<dl class="method"> 
     326<dt id="sans.dataloader.loader.Registry.__reduce_ex__"> 
     327<tt class="descname">__reduce_ex__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.loader.Registry.__reduce_ex__" title="Permalink to this definition">¶</a></dt> 
     328<dd><p>helper for pickle</p> 
     329</dd></dl> 
     330 
     331<dl class="attribute"> 
     332<dt id="sans.dataloader.loader.Registry.__repr__"> 
     333<tt class="descname">__repr__</tt><a class="headerlink" href="#sans.dataloader.loader.Registry.__repr__" title="Permalink to this definition">¶</a></dt> 
     334<dd><p>x.__repr__() &lt;==&gt; repr(x)</p> 
     335</dd></dl> 
     336 
     337<dl class="attribute"> 
     338<dt id="sans.dataloader.loader.Registry.__setattr__"> 
     339<tt class="descname">__setattr__</tt><a class="headerlink" href="#sans.dataloader.loader.Registry.__setattr__" title="Permalink to this definition">¶</a></dt> 
     340<dd><p>x.__setattr__(&#8216;name&#8217;, value) &lt;==&gt; x.name = value</p> 
     341</dd></dl> 
     342 
     343<dl class="method"> 
     344<dt id="sans.dataloader.loader.Registry.__setitem__"> 
     345<tt class="descname">__setitem__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.loader.Registry.__setitem__" title="Permalink to this definition">¶</a></dt> 
     346<dd></dd></dl> 
     347 
     348<dl class="attribute"> 
     349<dt id="sans.dataloader.loader.Registry.__str__"> 
     350<tt class="descname">__str__</tt><a class="headerlink" href="#sans.dataloader.loader.Registry.__str__" title="Permalink to this definition">¶</a></dt> 
     351<dd><p>x.__str__() &lt;==&gt; str(x)</p> 
     352</dd></dl> 
     353 
     354<dl class="attribute"> 
     355<dt id="sans.dataloader.loader.Registry.__weakref__"> 
     356<tt class="descname">__weakref__</tt><a class="headerlink" href="#sans.dataloader.loader.Registry.__weakref__" title="Permalink to this definition">¶</a></dt> 
     357<dd><p>list of weak references to the object (if defined)</p> 
     358</dd></dl> 
     359 
     360<dl class="method"> 
     361<dt id="sans.dataloader.loader.Registry._identify_plugin"> 
     362<tt class="descname">_identify_plugin</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.loader.Registry._identify_plugin" title="Permalink to this definition">¶</a></dt> 
     363<dd><p>Look into a module to find whether it contains a  
     364Reader class. If so, add it to readers and (potentially) 
     365to the list of writers. 
     366:param module: module object</p> 
     367</dd></dl> 
     368 
     369<dl class="method"> 
     370<dt id="sans.dataloader.loader.Registry.associate_file_reader"> 
     371<tt class="descname">associate_file_reader</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.loader.Registry.associate_file_reader" title="Permalink to this definition">¶</a></dt> 
    172372<dd><p>Append a reader object to readers</p> 
    173373<table class="docutils field-list" frame="void" rules="none"> 
    … …  
    175375<col class="field-body" /> 
    176376<tbody valign="top"> 
    177 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
     377<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
    178378<li><strong>ext</strong> &#8211; file extension [string]</li> 
    179379<li><strong>module</strong> &#8211; reader object</li> 
    … …  
    186386 
    187387<dl class="method"> 
    188 <dt id="DataLoader.loader.Registry.associate_file_type"> 
    189 <tt class="descname">associate_file_type</tt><big>(</big><em>ext</em>, <em>module</em><big>)</big><a class="headerlink" href="#DataLoader.loader.Registry.associate_file_type" title="Permalink to this definition">¶</a></dt> 
     388<dt id="sans.dataloader.loader.Registry.associate_file_type"> 
     389<tt class="descname">associate_file_type</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.loader.Registry.associate_file_type" title="Permalink to this definition">¶</a></dt> 
    190390<dd><p>Look into a module to find whether it contains a  
    191391Reader class. If so, APPEND it to readers and (potentially) 
    … …  
    195395<col class="field-body" /> 
    196396<tbody valign="top"> 
    197 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
     397<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
    198398<li><strong>ext</strong> &#8211; file extension [string]</li> 
    199399<li><strong>module</strong> &#8211; module object</li> 
    … …  
    206406 
    207407<dl class="method"> 
    208 <dt id="DataLoader.loader.Registry.extensions"> 
    209 <tt class="descname">extensions</tt><big>(</big><big>)</big><a class="headerlink" href="#DataLoader.loader.Registry.extensions" title="Permalink to this definition">¶</a></dt> 
     408<dt id="sans.dataloader.loader.Registry.extensions"> 
     409<tt class="descname">extensions</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.loader.Registry.extensions" title="Permalink to this definition">¶</a></dt> 
    210410<dd><p>Return a sorted list of registered extensions.</p> 
    211411</dd></dl> 
    212412 
    213413<dl class="method"> 
    214 <dt id="DataLoader.loader.Registry.find_plugins"> 
    215 <tt class="descname">find_plugins</tt><big>(</big><em>dir</em><big>)</big><a class="headerlink" href="#DataLoader.loader.Registry.find_plugins" title="Permalink to this definition">¶</a></dt> 
     414<dt id="sans.dataloader.loader.Registry.find_plugins"> 
     415<tt class="descname">find_plugins</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.loader.Registry.find_plugins" title="Permalink to this definition">¶</a></dt> 
    216416<dd><p>Find readers in a given directory. This method 
    217417can be used to inspect user plug-in directories to 
    … …  
    221421<col class="field-body" /> 
    222422<tbody valign="top"> 
    223 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>dir</strong> &#8211; directory to search into</td> 
    224 </tr> 
    225 <tr class="field"><th class="field-name">Returns:</th><td class="field-body">number of readers found</td> 
    226 </tr> 
    227 </tbody> 
    228 </table> 
    229 </dd></dl> 
    230  
    231 <dl class="method"> 
    232 <dt id="DataLoader.loader.Registry.formats"> 
    233 <tt class="descname">formats</tt><big>(</big><big>)</big><a class="headerlink" href="#DataLoader.loader.Registry.formats" title="Permalink to this definition">¶</a></dt> 
     423<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>dir</strong> &#8211; directory to search into</td> 
     424</tr> 
     425<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">number of readers found</td> 
     426</tr> 
     427</tbody> 
     428</table> 
     429</dd></dl> 
     430 
     431<dl class="method"> 
     432<dt id="sans.dataloader.loader.Registry.formats"> 
     433<tt class="descname">formats</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.loader.Registry.formats" title="Permalink to this definition">¶</a></dt> 
    234434<dd><p>Return a sorted list of the registered formats.</p> 
    235435</dd></dl> 
    236436 
    237437<dl class="method"> 
    238 <dt id="DataLoader.loader.Registry.load"> 
    239 <tt class="descname">load</tt><big>(</big><em>path</em>, <em>format=None</em><big>)</big><a class="headerlink" href="#DataLoader.loader.Registry.load" title="Permalink to this definition">¶</a></dt> 
     438<dt id="sans.dataloader.loader.Registry.load"> 
     439<tt class="descname">load</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.loader.Registry.load" title="Permalink to this definition">¶</a></dt> 
    240440<dd><p>Call the loader for the file type of path.</p> 
    241441<table class="docutils field-list" frame="void" rules="none"> 
    … …  
    243443<col class="field-body" /> 
    244444<tbody valign="top"> 
    245 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
     445<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
    246446<li><strong>path</strong> &#8211; file path</li> 
    247447<li><strong>format</strong> &#8211; explicit extension, to force the use  
    … …  
    258458 
    259459<dl class="method"> 
    260 <dt id="DataLoader.loader.Registry.lookup"> 
    261 <tt class="descname">lookup</tt><big>(</big><em>path</em><big>)</big><a class="headerlink" href="#DataLoader.loader.Registry.lookup" title="Permalink to this definition">¶</a></dt> 
     460<dt id="sans.dataloader.loader.Registry.lookup"> 
     461<tt class="descname">lookup</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.loader.Registry.lookup" title="Permalink to this definition">¶</a></dt> 
    262462<dd><p>Return the loader associated with the file type of path.</p> 
    263463<p>Raises ValueError if file type is not known.</p> 
    … …  
    265465 
    266466<dl class="method"> 
    267 <dt id="DataLoader.loader.Registry.lookup_writers"> 
    268 <tt class="descname">lookup_writers</tt><big>(</big><em>path</em><big>)</big><a class="headerlink" href="#DataLoader.loader.Registry.lookup_writers" title="Permalink to this definition">¶</a></dt> 
     467<dt id="sans.dataloader.loader.Registry.lookup_writers"> 
     468<tt class="descname">lookup_writers</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.loader.Registry.lookup_writers" title="Permalink to this definition">¶</a></dt> 
    269469<dd><table class="docutils field-list" frame="void" rules="none"> 
    270470<col class="field-name" /> 
    271471<col class="field-body" /> 
    272472<tbody valign="top"> 
    273 <tr class="field"><th class="field-name">Returns:</th><td class="field-body">the loader associated with the file type of path.</td> 
    274 </tr> 
    275 <tr class="field"><th class="field-name" colspan="2">Raises ValueError:</th></tr> 
    276 <tr><td>&nbsp;</td><td class="field-body">if file type is not known.</td> 
    277 </tr> 
    278 </tbody> 
    279 </table> 
    280 </dd></dl> 
    281  
    282 <dl class="method"> 
    283 <dt id="DataLoader.loader.Registry.save"> 
    284 <tt class="descname">save</tt><big>(</big><em>path</em>, <em>data</em>, <em>format=None</em><big>)</big><a class="headerlink" href="#DataLoader.loader.Registry.save" title="Permalink to this definition">¶</a></dt> 
     473<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">the loader associated with the file type of path.</td> 
     474</tr> 
     475<tr class="field-even field"><th class="field-name" colspan="2">Raises ValueError:</th></tr> 
     476<tr class="field-even field"><td>&nbsp;</td><td class="field-body">if file type is not known.</td> 
     477</tr> 
     478</tbody> 
     479</table> 
     480</dd></dl> 
     481 
     482<dl class="method"> 
     483<dt id="sans.dataloader.loader.Registry.save"> 
     484<tt class="descname">save</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.loader.Registry.save" title="Permalink to this definition">¶</a></dt> 
    285485<dd><p>Call the writer for the file type of path.</p> 
    286486<p>Raises ValueError if no writer is available. 
    … …  
    303503  <ul> 
    304504<li><a class="reference internal" href="#">loader</a><ul> 
    305 <li><a class="reference internal" href="#module-DataLoader.loader"><tt class="docutils literal"><span class="pre">DataLoader.loader</span></tt></a></li> 
     505<li><a class="reference internal" href="#sans-dataloader-loader"><tt class="docutils literal"><span class="pre">sans.dataloader.loader</span></tt></a></li> 
    306506</ul> 
    307507</li> 
    … …  
    322522  <h3>Quick search</h3> 
    323523    <form class="search" action="../search.html" method="get"> 
    324       <input type="text" name="q" size="18" /> 
     524      <input type="text" name="q" /> 
    325525      <input type="submit" value="Go" /> 
    326526      <input type="hidden" name="check_keywords" value="yes" /> 
    … …  
    351551          <a href="data_info.html" title="data_info" 
    352552             >previous</a> |</li> 
    353         <li><a href="../index.html">DataLoader v0.1.0 documentation</a> &raquo;</li> 
     553        <li><a href="../index.html">DataLoader 0.1.0 documentation</a> &raquo;</li> 
    354554          <li><a href="index.html" >Reference</a> &raquo;</li>  
    355555      </ul> 
    … …  
    357557    <div class="footer"> 
    358558        &copy; Copyright 2010, sans group. 
    359       Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7. 
     559      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1. 
    360560    </div> 
    361561  </body> 
Note: See TracChangeset for help on using the changeset viewer.