<!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>astropy.io.votable.ucd — Astropy v0.2.4</title>
<link rel="stylesheet" href="../../../../_static/bootstrap-astropy.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.4',
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>
<script type="text/javascript" src="../../../../_static/sidebar.js"></script>
<link rel="shortcut icon" href="../../../../_static/astropy_logo.ico"/>
<link rel="top" title="Astropy v0.2.4" href="../../../../index.html" />
<link rel="up" title="Module code" href="../../../index.html" />
</head>
<body>
<div class="topbar">
<a class="brand" title="Documentation Home" href="../../../../index.html"></a>
<ul>
<li><a class="homelink" title="AstroPy Homepage" href="http://www.astropy.org"></a></li>
<li><a title="General Index" href="../../../../genindex.html">Index</a></li>
<li><a title="Python Module Index" href="../../../../py-modindex.html">Modules</a></li>
<li>
<form action="../../../../search.html" method="get">
<input type="text" name="q" placeholder="Search" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</li>
</ul>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li>
<a href="../../../../index.html">Astropy v0.2.4</a>
»
</li>
<li><a href="../../../index.html" accesskey="U">Module code</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<h1>Source code for astropy.io.votable.ucd</h1><div class="highlight"><pre>
<span class="c"># Licensed under a 3-clause BSD style license - see LICENSE.rst</span>
<span class="sd">"""</span>
<span class="sd">This file contains routines to verify the correctness of UCD strings.</span>
<span class="sd">"""</span>
<span class="kn">from</span> <span class="nn">__future__</span> <span class="kn">import</span> <span class="n">with_statement</span><span class="p">,</span> <span class="n">absolute_import</span>
<span class="c">#STDLIB</span>
<span class="kn">import</span> <span class="nn">re</span>
<span class="c">#LOCAL</span>
<span class="kn">from</span> <span class="nn">...utils</span> <span class="kn">import</span> <span class="n">data</span>
<span class="n">__all__</span> <span class="o">=</span> <span class="p">[</span><span class="s">'parse_ucd'</span><span class="p">,</span> <span class="s">'check_ucd'</span><span class="p">]</span>
<span class="k">class</span> <span class="nc">UCDWords</span><span class="p">:</span>
<span class="sd">"""</span>
<span class="sd"> Manages a list of acceptable UCD words.</span>
<span class="sd"> Works by reading in a data file exactly as provided by IVOA. This</span>
<span class="sd"> file resides in data/ucd1p-words.txt.</span>
<span class="sd"> """</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_primary</span> <span class="o">=</span> <span class="nb">set</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_secondary</span> <span class="o">=</span> <span class="nb">set</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_descriptions</span> <span class="o">=</span> <span class="p">{}</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_capitalization</span> <span class="o">=</span> <span class="p">{}</span>
<span class="k">with</span> <span class="n">data</span><span class="o">.</span><span class="n">get_pkg_data_fileobj</span><span class="p">(</span>
<span class="s">"data/ucd1p-words.txt"</span><span class="p">,</span> <span class="n">encoding</span><span class="o">=</span><span class="s">'ascii'</span><span class="p">)</span> <span class="k">as</span> <span class="n">fd</span><span class="p">:</span>
<span class="k">for</span> <span class="n">line</span> <span class="ow">in</span> <span class="n">fd</span><span class="o">.</span><span class="n">readlines</span><span class="p">():</span>
<span class="nb">type</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">descr</span> <span class="o">=</span> <span class="p">[</span>
<span class="n">x</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span> <span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="n">line</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">u'|'</span><span class="p">)]</span>
<span class="n">name_lower</span> <span class="o">=</span> <span class="n">name</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span>
<span class="k">if</span> <span class="nb">type</span> <span class="ow">in</span> <span class="s">u'QPEV'</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_primary</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">name_lower</span><span class="p">)</span>
<span class="k">if</span> <span class="nb">type</span> <span class="ow">in</span> <span class="s">u'QSEV'</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_secondary</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">name_lower</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_descriptions</span><span class="p">[</span><span class="n">name_lower</span><span class="p">]</span> <span class="o">=</span> <span class="n">descr</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_capitalization</span><span class="p">[</span><span class="n">name_lower</span><span class="p">]</span> <span class="o">=</span> <span class="n">name</span>
<span class="k">def</span> <span class="nf">is_primary</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Returns True if *name* is a valid primary name.</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="n">name</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_primary</span>
<span class="k">def</span> <span class="nf">is_secondary</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Returns True if *name* is a valid secondary name.</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="n">name</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_secondary</span>
<span class="k">def</span> <span class="nf">get_description</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Returns the official English description of the given UCD</span>
<span class="sd"> *name*.</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_descriptions</span><span class="p">[</span><span class="n">name</span><span class="o">.</span><span class="n">lower</span><span class="p">()]</span>
<span class="k">def</span> <span class="nf">normalize_capitalization</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Returns the standard capitalization form of the given name.</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_capitalization</span><span class="p">[</span><span class="n">name</span><span class="o">.</span><span class="n">lower</span><span class="p">()]</span>
<span class="n">_ucd_singleton</span> <span class="o">=</span> <span class="bp">None</span>
<div class="viewcode-block" id="parse_ucd"><a class="viewcode-back" href="../../../../_generated/astropy.io.votable.ucd.parse_ucd.html#astropy.io.votable.ucd.parse_ucd">[docs]</a><span class="k">def</span> <span class="nf">parse_ucd</span><span class="p">(</span><span class="n">ucd</span><span class="p">,</span> <span class="n">check_controlled_vocabulary</span><span class="o">=</span><span class="bp">False</span><span class="p">,</span> <span class="n">has_colon</span><span class="o">=</span><span class="bp">False</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Parse the UCD into its component parts.</span>
<span class="sd"> Parameters</span>
<span class="sd"> ----------</span>
<span class="sd"> ucd : str</span>
<span class="sd"> The UCD string</span>
<span class="sd"> check_controlled_vocabulary : bool, optional</span>
<span class="sd"> If `True`, then each word in the UCD will be verified against</span>
<span class="sd"> the UCD1+ controlled vocabulary, (as required by the VOTable</span>
<span class="sd"> specification version 1.2), otherwise not.</span>
<span class="sd"> has_colon : bool, optional</span>
<span class="sd"> If `True`, the UCD may contain a colon (as defined in earlier</span>
<span class="sd"> versions of the standard).</span>
<span class="sd"> Returns</span>
<span class="sd"> -------</span>
<span class="sd"> parts : list</span>
<span class="sd"> The result is a list of tuples of the form:</span>
<span class="sd"> (*namespace*, *word*)</span>
<span class="sd"> If no namespace was explicitly specified, *namespace* will be</span>
<span class="sd"> returned as ``'ivoa'`` (i.e., the default namespace).</span>
<span class="sd"> Raises</span>
<span class="sd"> ------</span>
<span class="sd"> ValueError : *ucd* is invalid</span>
<span class="sd"> """</span>
<span class="k">global</span> <span class="n">_ucd_singleton</span>
<span class="k">if</span> <span class="n">_ucd_singleton</span> <span class="ow">is</span> <span class="bp">None</span><span class="p">:</span>
<span class="n">_ucd_singleton</span> <span class="o">=</span> <span class="n">UCDWords</span><span class="p">()</span>
<span class="k">if</span> <span class="n">has_colon</span><span class="p">:</span>
<span class="n">m</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="s">u'[^A-Za-z0-9_.:;\-]'</span><span class="p">,</span> <span class="n">ucd</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">m</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="s">u'[^A-Za-z0-9_.;\-]'</span><span class="p">,</span> <span class="n">ucd</span><span class="p">)</span>
<span class="k">if</span> <span class="n">m</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s">"UCD has invalid character '</span><span class="si">%s</span><span class="s">' in '</span><span class="si">%s</span><span class="s">'"</span> <span class="o">%</span>
<span class="p">(</span><span class="n">m</span><span class="o">.</span><span class="n">group</span><span class="p">(</span><span class="mi">0</span><span class="p">),</span> <span class="n">ucd</span><span class="p">))</span>
<span class="n">word_component_re</span> <span class="o">=</span> <span class="s">u'[A-Za-z0-9][A-Za-z0-9\-_]*'</span>
<span class="n">word_re</span> <span class="o">=</span> <span class="s">u'</span><span class="si">%s</span><span class="s">(\.</span><span class="si">%s</span><span class="s">)*'</span> <span class="o">%</span> <span class="p">(</span><span class="n">word_component_re</span><span class="p">,</span> <span class="n">word_component_re</span><span class="p">)</span>
<span class="n">parts</span> <span class="o">=</span> <span class="n">ucd</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">u';'</span><span class="p">)</span>
<span class="n">words</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">for</span> <span class="n">i</span><span class="p">,</span> <span class="n">word</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">parts</span><span class="p">):</span>
<span class="n">colon_count</span> <span class="o">=</span> <span class="n">word</span><span class="o">.</span><span class="n">count</span><span class="p">(</span><span class="s">u':'</span><span class="p">)</span>
<span class="k">if</span> <span class="n">colon_count</span> <span class="o">==</span> <span class="mi">1</span><span class="p">:</span>
<span class="n">ns</span><span class="p">,</span> <span class="n">word</span> <span class="o">=</span> <span class="n">word</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">u':'</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">re</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="n">word_component_re</span><span class="p">,</span> <span class="n">ns</span><span class="p">):</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s">"Invalid namespace '</span><span class="si">%s</span><span class="s">'"</span> <span class="o">%</span> <span class="n">ns</span><span class="p">)</span>
<span class="n">ns</span> <span class="o">=</span> <span class="n">ns</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span>
<span class="k">elif</span> <span class="n">colon_count</span> <span class="o">></span> <span class="mi">1</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s">"Too many colons in '</span><span class="si">%s</span><span class="s">'"</span> <span class="o">%</span> <span class="n">word</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">ns</span> <span class="o">=</span> <span class="s">u'ivoa'</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">re</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="n">word_re</span><span class="p">,</span> <span class="n">word</span><span class="p">):</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s">"Invalid word '</span><span class="si">%s</span><span class="s">'"</span> <span class="o">%</span> <span class="n">word</span><span class="p">)</span>
<span class="k">if</span> <span class="n">ns</span> <span class="o">==</span> <span class="s">u'ivoa'</span> <span class="ow">and</span> <span class="n">check_controlled_vocabulary</span><span class="p">:</span>
<span class="k">if</span> <span class="n">i</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">_ucd_singleton</span><span class="o">.</span><span class="n">is_primary</span><span class="p">(</span><span class="n">word</span><span class="p">):</span>
<span class="k">if</span> <span class="n">_ucd_singleton</span><span class="o">.</span><span class="n">is_secondary</span><span class="p">(</span><span class="n">word</span><span class="p">):</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span>
<span class="s">"Secondary word '</span><span class="si">%s</span><span class="s">' is not valid as a primary "</span>
<span class="s">"word"</span> <span class="o">%</span> <span class="n">word</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s">"Unknown word '</span><span class="si">%s</span><span class="s">'"</span> <span class="o">%</span> <span class="n">word</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">_ucd_singleton</span><span class="o">.</span><span class="n">is_secondary</span><span class="p">(</span><span class="n">word</span><span class="p">):</span>
<span class="k">if</span> <span class="n">_ucd_singleton</span><span class="o">.</span><span class="n">is_primary</span><span class="p">(</span><span class="n">word</span><span class="p">):</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span>
<span class="s">"Primary word '</span><span class="si">%s</span><span class="s">' is not valid as a secondary "</span>
<span class="s">"word"</span> <span class="o">%</span> <span class="n">word</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s">"Unknown word '</span><span class="si">%s</span><span class="s">'"</span> <span class="o">%</span> <span class="n">word</span><span class="p">)</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">normalized_word</span> <span class="o">=</span> <span class="n">_ucd_singleton</span><span class="o">.</span><span class="n">normalize_capitalization</span><span class="p">(</span><span class="n">word</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">KeyError</span><span class="p">:</span>
<span class="n">normalized_word</span> <span class="o">=</span> <span class="n">word</span>
<span class="n">words</span><span class="o">.</span><span class="n">append</span><span class="p">((</span><span class="n">ns</span><span class="p">,</span> <span class="n">normalized_word</span><span class="p">))</span>
<span class="k">return</span> <span class="n">words</span>
</div>
<div class="viewcode-block" id="check_ucd"><a class="viewcode-back" href="../../../../_generated/astropy.io.votable.ucd.check_ucd.html#astropy.io.votable.ucd.check_ucd">[docs]</a><span class="k">def</span> <span class="nf">check_ucd</span><span class="p">(</span><span class="n">ucd</span><span class="p">,</span> <span class="n">check_controlled_vocabulary</span><span class="o">=</span><span class="bp">False</span><span class="p">,</span> <span class="n">has_colon</span><span class="o">=</span><span class="bp">False</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Returns False if *ucd* is not a valid `unified content descriptor`_.</span>
<span class="sd"> Parameters</span>
<span class="sd"> ----------</span>
<span class="sd"> ucd : str</span>
<span class="sd"> The UCD string</span>
<span class="sd"> check_controlled_vocabulary : bool, optional</span>
<span class="sd"> If `True`, then each word in the UCD will be verified against</span>
<span class="sd"> the UCD1+ controlled vocabulary, (as required by the VOTable</span>
<span class="sd"> specification version 1.2), otherwise not.</span>
<span class="sd"> Returns</span>
<span class="sd"> -------</span>
<span class="sd"> valid : bool</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="n">ucd</span> <span class="ow">is</span> <span class="bp">None</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">True</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">parse_ucd</span><span class="p">(</span><span class="n">ucd</span><span class="p">,</span>
<span class="n">check_controlled_vocabulary</span><span class="o">=</span><span class="n">check_controlled_vocabulary</span><span class="p">,</span>
<span class="n">has_colon</span><span class="o">=</span><span class="n">has_colon</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">ValueError</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">False</span>
<span class="k">return</span> <span class="bp">True</span></div>
</pre></div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper"><h3>Page Contents</h3>
</div>
</div>
<div class="clearer"></div>
</div>
<footer class="footer">
<p class="pull-right">
<a href="#">Back to Top</a></p>
<p>
© Copyright 2011-2013, The Astropy Developers.<br/>
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
Last built 22 Oct 2013. <br/>
</p>
</footer>
</body>
</html>
