source: sasview/_modules/sas/dataloader/readers/associations.html @ a462c6a

gh-pages
Last change on this file since a462c6a was a462c6a, checked in by ajj, 9 years ago

Rebuild to fix index and modules docs

  • Property mode set to 100644
File size: 17.4 KB
Line 
1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
4
5<html xmlns="http://www.w3.org/1999/xhtml">
6  <head>
7    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
8   
9    <title>sas.dataloader.readers.associations &mdash; SasView 3.0.0 documentation</title>
10   
11    <link rel="stylesheet" href="../../../../_static/default.css" type="text/css" />
12    <link rel="stylesheet" href="../../../../_static/pygments.css" type="text/css" />
13   
14    <script type="text/javascript">
15      var DOCUMENTATION_OPTIONS = {
16        URL_ROOT:    '../../../../',
17        VERSION:     '3.0.0',
18        COLLAPSE_INDEX: false,
19        FILE_SUFFIX: '.html',
20        HAS_SOURCE:  true
21      };
22    </script>
23    <script type="text/javascript" src="../../../../_static/jquery.js"></script>
24    <script type="text/javascript" src="../../../../_static/underscore.js"></script>
25    <script type="text/javascript" src="../../../../_static/doctools.js"></script>
26    <script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
27    <link rel="top" title="SasView 3.0.0 documentation" href="../../../../index.html" />
28    <link rel="up" title="sas.dataloader.readers" href="../readers.html" /> 
29  </head>
30  <body>
31    <div class="related">
32      <h3>Navigation</h3>
33      <ul>
34        <li class="right" style="margin-right: 10px">
35          <a href="../../../../genindex.html" title="General Index"
36             accesskey="I">index</a></li>
37        <li class="right" >
38          <a href="../../../../py-modindex.html" title="Python Module Index"
39             >modules</a> |</li>
40        <li><a href="../../../../index.html">SasView 3.0.0 documentation</a> &raquo;</li>
41          <li><a href="../../../index.html" >Module code</a> &raquo;</li>
42          <li><a href="../readers.html" accesskey="U">sas.dataloader.readers</a> &raquo;</li> 
43      </ul>
44    </div> 
45
46    <div class="document">
47      <div class="documentwrapper">
48        <div class="bodywrapper">
49          <div class="body">
50           
51  <h1>Source code for sas.dataloader.readers.associations</h1><div class="highlight"><pre>
52<span class="sd">&quot;&quot;&quot;</span>
53<span class="sd">Module to associate default readers to file extensions.</span>
54<span class="sd">The module reads an xml file to get the readers for each file extension.</span>
55<span class="sd">The readers are tried in order they appear when reading a file.</span>
56<span class="sd">&quot;&quot;&quot;</span>
57<span class="c">############################################################################</span>
58<span class="c">#This software was developed by the University of Tennessee as part of the</span>
59<span class="c">#Distributed Data Analysis of Neutron Scattering Experiments (DANSE)</span>
60<span class="c">#project funded by the US National Science Foundation.</span>
61<span class="c">#If you use DANSE applications to do scientific research that leads to</span>
62<span class="c">#publication, we ask that you acknowledge the use of the software with the</span>
63<span class="c">#following sentence:</span>
64<span class="c">#This work benefited from DANSE software developed under NSF award DMR-0520547.</span>
65<span class="c">#copyright 2009, University of Tennessee</span>
66<span class="c">#############################################################################</span>
67<span class="kn">import</span> <span class="nn">os</span>
68<span class="kn">import</span> <span class="nn">sys</span>
69<span class="kn">import</span> <span class="nn">logging</span>
70<span class="kn">from</span> <span class="nn">lxml</span> <span class="kn">import</span> <span class="n">etree</span>
71<span class="c"># Py2exe compatibility: import _elementpath to ensure that py2exe finds it</span>
72<span class="kn">from</span> <span class="nn">lxml</span> <span class="kn">import</span> <span class="n">_elementpath</span>
73
74<span class="c">## Format version for the XML settings file</span>
75<span class="n">VERSION</span> <span class="o">=</span> <span class="s">&#39;sasloader/1.0&#39;</span>
76
77
78<div class="viewcode-block" id="read_associations"><a class="viewcode-back" href="../../../../dev/api/sas.dataloader.readers.html#sas.dataloader.readers.associations.read_associations">[docs]</a><span class="k">def</span> <span class="nf">read_associations</span><span class="p">(</span><span class="n">loader</span><span class="p">,</span> <span class="n">settings</span><span class="o">=</span><span class="s">&#39;defaults.xml&#39;</span><span class="p">):</span>
79    <span class="sd">&quot;&quot;&quot;</span>
80<span class="sd">    Read the specified settings file to associate</span>
81<span class="sd">    default readers to file extension.</span>
82<span class="sd">    </span>
83<span class="sd">    :param loader: Loader object</span>
84<span class="sd">    :param settings: path to the XML settings file [string]</span>
85<span class="sd">    &quot;&quot;&quot;</span>
86    <span class="n">reader_dir</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">dirname</span><span class="p">(</span><span class="n">__file__</span><span class="p">)</span>
87    <span class="n">path</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">reader_dir</span><span class="p">,</span> <span class="n">settings</span><span class="p">)</span>
88   
89    <span class="c"># If we can&#39;t find the file in the installation</span>
90    <span class="c"># directory, look into the execution directory.</span>
91    <span class="k">if</span> <span class="ow">not</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">isfile</span><span class="p">(</span><span class="n">path</span><span class="p">):</span>
92        <span class="n">path</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">getcwd</span><span class="p">(),</span> <span class="n">settings</span><span class="p">)</span>
93    <span class="k">if</span> <span class="ow">not</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">isfile</span><span class="p">(</span><span class="n">path</span><span class="p">):</span>
94        <span class="n">path</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">sys</span><span class="o">.</span><span class="n">path</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="n">settings</span><span class="p">)</span>
95    <span class="k">if</span> <span class="ow">not</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">isfile</span><span class="p">(</span><span class="n">path</span><span class="p">):</span>
96        <span class="n">path</span> <span class="o">=</span> <span class="n">settings</span>
97    <span class="k">if</span> <span class="ow">not</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">isfile</span><span class="p">(</span><span class="n">path</span><span class="p">):</span>
98        <span class="n">path</span> <span class="o">=</span> <span class="s">&quot;./</span><span class="si">%s</span><span class="s">&quot;</span> <span class="o">%</span> <span class="n">settings</span>
99    <span class="k">if</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">isfile</span><span class="p">(</span><span class="n">path</span><span class="p">):</span>
100        <span class="n">tree</span> <span class="o">=</span> <span class="n">etree</span><span class="o">.</span><span class="n">parse</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">parser</span><span class="o">=</span><span class="n">etree</span><span class="o">.</span><span class="n">ETCompatXMLParser</span><span class="p">())</span>
101       
102        <span class="c"># Check the format version number</span>
103        <span class="c"># Specifying the namespace will take care of the file format version</span>
104        <span class="n">root</span> <span class="o">=</span> <span class="n">tree</span><span class="o">.</span><span class="n">getroot</span><span class="p">()</span>
105       
106        <span class="c"># Read in the file extension associations</span>
107        <span class="n">entry_list</span> <span class="o">=</span> <span class="n">root</span><span class="o">.</span><span class="n">xpath</span><span class="p">(</span><span class="s">&#39;/ns:SasLoader/ns:FileType&#39;</span><span class="p">,</span>
108                                 <span class="n">namespaces</span><span class="o">=</span><span class="p">{</span><span class="s">&#39;ns&#39;</span><span class="p">:</span> <span class="n">VERSION</span><span class="p">})</span>
109
110        <span class="c"># For each FileType entry, get the associated reader and extension</span>
111        <span class="k">for</span> <span class="n">entry</span> <span class="ow">in</span> <span class="n">entry_list</span><span class="p">:</span>
112            <span class="n">reader</span> <span class="o">=</span> <span class="n">entry</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&#39;reader&#39;</span><span class="p">)</span>
113            <span class="n">ext</span> <span class="o">=</span> <span class="n">entry</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&#39;extension&#39;</span><span class="p">)</span>
114           
115            <span class="k">if</span> <span class="n">reader</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span> <span class="ow">and</span> <span class="n">ext</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">:</span>
116                <span class="c"># Associate the extension with a particular reader</span>
117                <span class="c"># TODO: Modify the Register code to be case-insensitive</span>
118                <span class="c"># and remove the extra line below.</span>
119                <span class="k">try</span><span class="p">:</span>
120                    <span class="k">exec</span> <span class="s">&quot;import </span><span class="si">%s</span><span class="s">&quot;</span> <span class="o">%</span> <span class="n">reader</span>
121                    <span class="k">exec</span> <span class="s">&quot;loader.associate_file_type(&#39;</span><span class="si">%s</span><span class="s">&#39;, </span><span class="si">%s</span><span class="s">)&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">ext</span><span class="o">.</span><span class="n">lower</span><span class="p">(),</span>
122                                                                    <span class="n">reader</span><span class="p">)</span>
123                    <span class="k">exec</span> <span class="s">&quot;loader.associate_file_type(&#39;</span><span class="si">%s</span><span class="s">&#39;, </span><span class="si">%s</span><span class="s">)&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">ext</span><span class="o">.</span><span class="n">upper</span><span class="p">(),</span>
124                                                                    <span class="n">reader</span><span class="p">)</span>
125                <span class="k">except</span><span class="p">:</span>
126                    <span class="n">msg</span> <span class="o">=</span> <span class="s">&quot;read_associations: skipping association&quot;</span>
127                    <span class="n">msg</span> <span class="o">+=</span> <span class="s">&quot; for </span><span class="si">%s</span><span class="se">\n</span><span class="s">  </span><span class="si">%s</span><span class="s">&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">ext</span><span class="o">.</span><span class="n">lower</span><span class="p">(),</span> <span class="n">sys</span><span class="o">.</span><span class="n">exc_value</span><span class="p">)</span>
128                    <span class="n">logging</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
129    <span class="k">else</span><span class="p">:</span>
130        <span class="k">print</span> <span class="s">&quot;Could not find reader association settings</span><span class="se">\n</span><span class="s">  </span><span class="si">%s</span><span class="s"> [</span><span class="si">%s</span><span class="s">]&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">__file__</span><span class="p">,</span> <span class="n">os</span><span class="o">.</span><span class="n">getcwd</span><span class="p">())</span>
131         
132         </div>
133<div class="viewcode-block" id="register_readers"><a class="viewcode-back" href="../../../../dev/api/sas.dataloader.readers.html#sas.dataloader.readers.associations.register_readers">[docs]</a><span class="k">def</span> <span class="nf">register_readers</span><span class="p">(</span><span class="n">registry_function</span><span class="p">):</span>
134    <span class="sd">&quot;&quot;&quot;</span>
135<span class="sd">    Function called by the registry/loader object to register</span>
136<span class="sd">    all default readers using a call back function.</span>
137<span class="sd">    </span>
138<span class="sd">    :WARNING: this method is now obsolete</span>
139
140<span class="sd">    :param registry_function: function to be called to register each reader</span>
141<span class="sd">    &quot;&quot;&quot;</span>
142    <span class="n">logging</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s">&quot;register_readers is now obsolete: use read_associations()&quot;</span><span class="p">)</span>
143    <span class="kn">import</span> <span class="nn">abs_reader</span>
144    <span class="kn">import</span> <span class="nn">ascii_reader</span>
145    <span class="kn">import</span> <span class="nn">cansas_reader</span>
146    <span class="kn">import</span> <span class="nn">danse_reader</span>
147    <span class="kn">import</span> <span class="nn">hfir1d_reader</span>
148    <span class="kn">import</span> <span class="nn">IgorReader</span>
149    <span class="kn">import</span> <span class="nn">red2d_reader</span>
150    <span class="c">#import tiff_reader</span>
151    <span class="kn">import</span> <span class="nn">nexus_reader</span>
152
153    <span class="n">registry_function</span><span class="p">(</span><span class="n">abs_reader</span><span class="p">)</span>
154    <span class="n">registry_function</span><span class="p">(</span><span class="n">ascii_reader</span><span class="p">)</span>
155    <span class="n">registry_function</span><span class="p">(</span><span class="n">cansas_reader</span><span class="p">)</span>
156    <span class="n">registry_function</span><span class="p">(</span><span class="n">danse_reader</span><span class="p">)</span>
157    <span class="n">registry_function</span><span class="p">(</span><span class="n">hfir1d_reader</span><span class="p">)</span>
158    <span class="n">registry_function</span><span class="p">(</span><span class="n">IgorReader</span><span class="p">)</span>
159    <span class="n">registry_function</span><span class="p">(</span><span class="n">red2d_reader</span><span class="p">)</span>
160    <span class="c">#registry_function(tiff_reader)</span>
161    <span class="n">registry_function</span><span class="p">(</span><span class="n">nexus_reader</span><span class="p">)</span>
162   
163    <span class="k">return</span> <span class="bp">True</span></div>
164</pre></div>
165
166          </div>
167        </div>
168      </div>
169      <div class="sphinxsidebar">
170        <div class="sphinxsidebarwrapper">
171<div id="searchbox" style="display: none">
172  <h3>Quick search</h3>
173    <form class="search" action="../../../../search.html" method="get">
174      <input type="text" name="q" />
175      <input type="submit" value="Go" />
176      <input type="hidden" name="check_keywords" value="yes" />
177      <input type="hidden" name="area" value="default" />
178    </form>
179    <p class="searchtip" style="font-size: 90%">
180    Enter search terms or a module, class or function name.
181    </p>
182</div>
183<script type="text/javascript">$('#searchbox').show(0);</script>
184        </div>
185      </div>
186      <div class="clearer"></div>
187    </div>
188    <div class="related">
189      <h3>Navigation</h3>
190      <ul>
191        <li class="right" style="margin-right: 10px">
192          <a href="../../../../genindex.html" title="General Index"
193             >index</a></li>
194        <li class="right" >
195          <a href="../../../../py-modindex.html" title="Python Module Index"
196             >modules</a> |</li>
197        <li><a href="../../../../index.html">SasView 3.0.0 documentation</a> &raquo;</li>
198          <li><a href="../../../index.html" >Module code</a> &raquo;</li>
199          <li><a href="../readers.html" >sas.dataloader.readers</a> &raquo;</li> 
200      </ul>
201    </div>
202    <div class="footer">
203        &copy; Copyright 2013, The SasView Project.
204      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
205    </div>
206  </body>
207</html>
Note: See TracBrowser for help on using the repository browser.