source: sasview/sansdataloader/docs/sphinx/html/api/loader.html @ 70ecd530

ESS_GUIESS_GUI_DocsESS_GUI_batch_fittingESS_GUI_bumps_abstractionESS_GUI_iss1116ESS_GUI_iss879ESS_GUI_iss959ESS_GUI_openclESS_GUI_orderingESS_GUI_sync_sascalccostrafo411magnetic_scattrelease-4.1.1release-4.1.2release-4.2.2release_4.0.1ticket-1009ticket-1094-headlessticket-1242-2d-resolutionticket-1243ticket-1249ticket885unittest-saveload
Last change on this file since 70ecd530 was 7247844, checked in by Gervaise Alina <gervyh@…>, 13 years ago

updates docs
  • Property mode set to 100644
File size: 26.0 KB
RevLine 
[16771b0]1
2
3<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5
[7247844]6
[16771b0]7<html xmlns="http://www.w3.org/1999/xhtml">
8  <head>
9    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
10   
[7247844]11    <title>loader &mdash; DataLoader 0.1.0 documentation</title>
12   
[16771b0]13    <link rel="stylesheet" href="../_static/default.css" type="text/css" />
14    <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
[7247844]15   
[16771b0]16    <script type="text/javascript">
17      var DOCUMENTATION_OPTIONS = {
18        URL_ROOT:    '../',
19        VERSION:     '0.1.0',
20        COLLAPSE_INDEX: false,
21        FILE_SUFFIX: '.html',
22        HAS_SOURCE:  true
23      };
24    </script>
25    <script type="text/javascript" src="../_static/jquery.js"></script>
26    <script type="text/javascript" src="../_static/underscore.js"></script>
27    <script type="text/javascript" src="../_static/doctools.js"></script>
[7247844]28    <link rel="top" title="DataLoader 0.1.0 documentation" href="../index.html" />
[16771b0]29    <link rel="up" title="Reference" href="index.html" />
30    <link rel="next" title="manipulations" href="manipulations.html" />
31    <link rel="prev" title="data_info" href="data_info.html" /> 
32  </head>
33  <body>
34    <div class="related">
35      <h3>Navigation</h3>
36      <ul>
37        <li class="right" style="margin-right: 10px">
38          <a href="../genindex.html" title="General Index"
39             accesskey="I">index</a></li>
40        <li class="right" >
41          <a href="../py-modindex.html" title="Python Module Index"
42             >modules</a> |</li>
43        <li class="right" >
44          <a href="manipulations.html" title="manipulations"
45             accesskey="N">next</a> |</li>
46        <li class="right" >
47          <a href="data_info.html" title="data_info"
48             accesskey="P">previous</a> |</li>
[7247844]49        <li><a href="../index.html">DataLoader 0.1.0 documentation</a> &raquo;</li>
[16771b0]50          <li><a href="index.html" accesskey="U">Reference</a> &raquo;</li> 
51      </ul>
52    </div> 
53
54    <div class="document">
55      <div class="documentwrapper">
56        <div class="bodywrapper">
57          <div class="body">
58           
59  <div class="section" id="loader">
60<h1>loader<a class="headerlink" href="#loader" title="Permalink to this headline">¶</a></h1>
[7247844]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.
[16771b0]64Uses reflectometry&#8217;s registry utility.</p>
65<p>The default readers are found in the &#8216;readers&#8217; sub-module
66and registered by default at initialization time.</p>
67<p>To add a new default reader, one must register it in
68the register_readers method found in readers/__init__.py.</p>
69<p>A utility method (find_plugins) is available to inspect
70a directory (for instance, a user plug-in directory) and
71look for new readers/writers.</p>
72<dl class="class">
[7247844]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>
[16771b0]75<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
76<p>Utility class to use the Registry as a singleton.</p>
[7247844]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
[16771b0]127<dl class="method">
[7247844]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>
[16771b0]173<dd><p>Append a reader object to readers</p>
174<table class="docutils field-list" frame="void" rules="none">
175<col class="field-name" />
176<col class="field-body" />
177<tbody valign="top">
[7247844]178<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
[16771b0]179<li><strong>ext</strong> &#8211; file extension [string]</li>
180<li><strong>module</strong> &#8211; reader object</li>
181</ul>
182</td>
183</tr>
184</tbody>
185</table>
186</dd></dl>
187
188<dl class="method">
[7247844]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>
[16771b0]191<dd><p>Look into a module to find whether it contains a
192Reader class. If so, append it to readers and (potentially)
193to the list of writers for the given extension</p>
194<table class="docutils field-list" frame="void" rules="none">
195<col class="field-name" />
196<col class="field-body" />
197<tbody valign="top">
[7247844]198<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
[16771b0]199<li><strong>ext</strong> &#8211; file extension [string]</li>
200<li><strong>module</strong> &#8211; module object</li>
201</ul>
202</td>
203</tr>
204</tbody>
205</table>
206</dd></dl>
207
208<dl class="method">
[7247844]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>
[16771b0]211<dd><p>Find plugins in a given directory</p>
212<table class="docutils field-list" frame="void" rules="none">
213<col class="field-name" />
214<col class="field-body" />
215<tbody valign="top">
[7247844]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>
[16771b0]217</tr>
218</tbody>
219</table>
220</dd></dl>
221
222<dl class="method">
[7247844]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>
[16771b0]225<dd></dd></dl>
226
227<dl class="method">
[7247844]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>
[16771b0]230<dd><p>Load a file</p>
231<table class="docutils field-list" frame="void" rules="none">
232<col class="field-name" />
233<col class="field-body" />
234<tbody valign="top">
[7247844]235<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
[16771b0]236<li><strong>file</strong> &#8211; file name (path)</li>
237<li><strong>format</strong> &#8211; specified format to use (optional)</li>
238</ul>
239</td>
240</tr>
[7247844]241<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">DataInfo object</p>
[16771b0]242</td>
243</tr>
244</tbody>
245</table>
246</dd></dl>
247
248<dl class="method">
[7247844]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>
[16771b0]251<dd><p>Save a DataInfo object to file
252:param file: file name (path)
253:param data: DataInfo object
254:param format: format to write the data in</p>
255</dd></dl>
256
257</dd></dl>
258
259<dl class="class">
[7247844]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>
[16771b0]262<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">data_util.registry.ExtensionRegistry</span></tt></p>
263<p>Registry class for file format extensions.
264Readers and writers are supported.</p>
[7247844]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
[16771b0]369<dl class="method">
[7247844]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>
[16771b0]372<dd><p>Append a reader object to readers</p>
373<table class="docutils field-list" frame="void" rules="none">
374<col class="field-name" />
375<col class="field-body" />
376<tbody valign="top">
[7247844]377<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
[16771b0]378<li><strong>ext</strong> &#8211; file extension [string]</li>
379<li><strong>module</strong> &#8211; reader object</li>
380</ul>
381</td>
382</tr>
383</tbody>
384</table>
385</dd></dl>
386
387<dl class="method">
[7247844]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>
[16771b0]390<dd><p>Look into a module to find whether it contains a
391Reader class. If so, APPEND it to readers and (potentially)
392to the list of writers for the given extension</p>
393<table class="docutils field-list" frame="void" rules="none">
394<col class="field-name" />
395<col class="field-body" />
396<tbody valign="top">
[7247844]397<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
[16771b0]398<li><strong>ext</strong> &#8211; file extension [string]</li>
399<li><strong>module</strong> &#8211; module object</li>
400</ul>
401</td>
402</tr>
403</tbody>
404</table>
405</dd></dl>
406
407<dl class="method">
[7247844]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>
[16771b0]410<dd><p>Return a sorted list of registered extensions.</p>
411</dd></dl>
412
413<dl class="method">
[7247844]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>
[16771b0]416<dd><p>Find readers in a given directory. This method
417can be used to inspect user plug-in directories to
418find new readers/writers.</p>
419<table class="docutils field-list" frame="void" rules="none">
420<col class="field-name" />
421<col class="field-body" />
422<tbody valign="top">
[7247844]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>
[16771b0]424</tr>
[7247844]425<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">number of readers found</td>
[16771b0]426</tr>
427</tbody>
428</table>
429</dd></dl>
430
431<dl class="method">
[7247844]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>
[16771b0]434<dd><p>Return a sorted list of the registered formats.</p>
435</dd></dl>
436
437<dl class="method">
[7247844]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>
[16771b0]440<dd><p>Call the loader for the file type of path.</p>
441<table class="docutils field-list" frame="void" rules="none">
442<col class="field-name" />
443<col class="field-body" />
444<tbody valign="top">
[7247844]445<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
[16771b0]446<li><strong>path</strong> &#8211; file path</li>
447<li><strong>format</strong> &#8211; explicit extension, to force the use
448of a particular reader</li>
449</ul>
450</td>
451</tr>
452</tbody>
453</table>
454<p>Defaults to the ascii (multi-column) reader
455if no reader was registered for the file&#8217;s
456extension.</p>
457</dd></dl>
458
459<dl class="method">
[7247844]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>
[16771b0]462<dd><p>Return the loader associated with the file type of path.</p>
463<p>Raises ValueError if file type is not known.</p>
464</dd></dl>
465
466<dl class="method">
[7247844]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>
[16771b0]469<dd><table class="docutils field-list" frame="void" rules="none">
470<col class="field-name" />
471<col class="field-body" />
472<tbody valign="top">
[7247844]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>
[16771b0]474</tr>
[7247844]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>
[16771b0]477</tr>
478</tbody>
479</table>
480</dd></dl>
481
482<dl class="method">
[7247844]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>
[16771b0]485<dd><p>Call the writer for the file type of path.</p>
486<p>Raises ValueError if no writer is available.
487Raises KeyError if format is not available.</p>
488<p>May raise a writer-defined exception if writer fails.</p>
489</dd></dl>
490
491</dd></dl>
492
493</div>
494</div>
495
496
497          </div>
498        </div>
499      </div>
500      <div class="sphinxsidebar">
501        <div class="sphinxsidebarwrapper">
502  <h3><a href="../index.html">Table Of Contents</a></h3>
503  <ul>
504<li><a class="reference internal" href="#">loader</a><ul>
[7247844]505<li><a class="reference internal" href="#sans-dataloader-loader"><tt class="docutils literal"><span class="pre">sans.dataloader.loader</span></tt></a></li>
[16771b0]506</ul>
507</li>
508</ul>
509
510  <h4>Previous topic</h4>
511  <p class="topless"><a href="data_info.html"
512                        title="previous chapter">data_info</a></p>
513  <h4>Next topic</h4>
514  <p class="topless"><a href="manipulations.html"
515                        title="next chapter">manipulations</a></p>
516  <h3>This Page</h3>
517  <ul class="this-page-menu">
518    <li><a href="../_sources/api/loader.txt"
519           rel="nofollow">Show Source</a></li>
520  </ul>
521<div id="searchbox" style="display: none">
522  <h3>Quick search</h3>
523    <form class="search" action="../search.html" method="get">
[7247844]524      <input type="text" name="q" />
[16771b0]525      <input type="submit" value="Go" />
526      <input type="hidden" name="check_keywords" value="yes" />
527      <input type="hidden" name="area" value="default" />
528    </form>
529    <p class="searchtip" style="font-size: 90%">
530    Enter search terms or a module, class or function name.
531    </p>
532</div>
533<script type="text/javascript">$('#searchbox').show(0);</script>
534        </div>
535      </div>
536      <div class="clearer"></div>
537    </div>
538    <div class="related">
539      <h3>Navigation</h3>
540      <ul>
541        <li class="right" style="margin-right: 10px">
542          <a href="../genindex.html" title="General Index"
543             >index</a></li>
544        <li class="right" >
545          <a href="../py-modindex.html" title="Python Module Index"
546             >modules</a> |</li>
547        <li class="right" >
548          <a href="manipulations.html" title="manipulations"
549             >next</a> |</li>
550        <li class="right" >
551          <a href="data_info.html" title="data_info"
552             >previous</a> |</li>
[7247844]553        <li><a href="../index.html">DataLoader 0.1.0 documentation</a> &raquo;</li>
[16771b0]554          <li><a href="index.html" >Reference</a> &raquo;</li> 
555      </ul>
556    </div>
557    <div class="footer">
558        &copy; Copyright 2010, sans group.
[7247844]559      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.
[16771b0]560    </div>
561  </body>
562</html>
Note: See TracBrowser for help on using the repository browser.