<!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.xmlutil — 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.xmlutil</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">Various XML-related utilities</span>
<span class="sd">"""</span>
<span class="kn">from</span> <span class="nn">__future__</span> <span class="kn">import</span> <span class="n">division</span><span class="p">,</span> <span class="n">absolute_import</span>
<span class="c"># ASTROPY</span>
<span class="kn">from</span> <span class="nn">...utils.xml</span> <span class="kn">import</span> <span class="n">check</span> <span class="k">as</span> <span class="n">xml_check</span>
<span class="kn">from</span> <span class="nn">...utils.xml</span> <span class="kn">import</span> <span class="n">validate</span>
<span class="c"># LOCAL</span>
<span class="kn">from</span> <span class="nn">.exceptions</span> <span class="kn">import</span> <span class="p">(</span><span class="n">warn_or_raise</span><span class="p">,</span> <span class="n">vo_warn</span><span class="p">,</span>
<span class="n">W02</span><span class="p">,</span> <span class="n">W03</span><span class="p">,</span> <span class="n">W04</span><span class="p">,</span> <span class="n">W05</span><span class="p">)</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">'check_id'</span><span class="p">,</span> <span class="s">'fix_id'</span><span class="p">,</span> <span class="s">'check_token'</span><span class="p">,</span> <span class="s">'check_mime_content_type'</span><span class="p">,</span>
<span class="s">'check_anyuri'</span><span class="p">,</span> <span class="s">'validate_schema'</span>
<span class="p">]</span>
<div class="viewcode-block" id="check_id"><a class="viewcode-back" href="../../../../_generated/astropy.io.votable.xmlutil.check_id.html#astropy.io.votable.xmlutil.check_id">[docs]</a><span class="k">def</span> <span class="nf">check_id</span><span class="p">(</span><span class="n">ID</span><span class="p">,</span> <span class="n">name</span><span class="o">=</span><span class="s">'ID'</span><span class="p">,</span> <span class="n">config</span><span class="o">=</span><span class="p">{},</span> <span class="n">pos</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Raises a `~astropy.io.votable.exceptions.VOTableSpecError` if *ID*</span>
<span class="sd"> is not a valid XML ID_.</span>
<span class="sd"> *name* is the name of the attribute being checked (used only for</span>
<span class="sd"> error messages).</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="p">(</span><span class="n">ID</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span> <span class="ow">and</span> <span class="ow">not</span> <span class="n">xml_check</span><span class="o">.</span><span class="n">check_id</span><span class="p">(</span><span class="n">ID</span><span class="p">)):</span>
<span class="n">warn_or_raise</span><span class="p">(</span><span class="n">W02</span><span class="p">,</span> <span class="n">W02</span><span class="p">,</span> <span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">ID</span><span class="p">),</span> <span class="n">config</span><span class="p">,</span> <span class="n">pos</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>
<div class="viewcode-block" id="fix_id"><a class="viewcode-back" href="../../../../_generated/astropy.io.votable.xmlutil.fix_id.html#astropy.io.votable.xmlutil.fix_id">[docs]</a><span class="k">def</span> <span class="nf">fix_id</span><span class="p">(</span><span class="n">ID</span><span class="p">,</span> <span class="n">config</span><span class="o">=</span><span class="p">{},</span> <span class="n">pos</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Given an arbitrary string, create one that can be used as an xml id.</span>
<span class="sd"> This is rather simplistic at the moment, since it just replaces</span>
<span class="sd"> non-valid characters with underscores.</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="n">ID</span> <span class="ow">is</span> <span class="bp">None</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">None</span>
<span class="n">corrected</span> <span class="o">=</span> <span class="n">xml_check</span><span class="o">.</span><span class="n">fix_id</span><span class="p">(</span><span class="n">ID</span><span class="p">)</span>
<span class="k">if</span> <span class="n">corrected</span> <span class="o">!=</span> <span class="n">ID</span><span class="p">:</span>
<span class="n">vo_warn</span><span class="p">(</span><span class="n">W03</span><span class="p">,</span> <span class="p">(</span><span class="n">ID</span><span class="p">,</span> <span class="n">corrected</span><span class="p">),</span> <span class="n">config</span><span class="p">,</span> <span class="n">pos</span><span class="p">)</span>
<span class="k">return</span> <span class="n">corrected</span>
</div>
<span class="n">_token_regex</span> <span class="o">=</span> <span class="s">r"(?![\r\l\t ])[^\r\l\t]*(?![\r\l\t ])"</span>
<div class="viewcode-block" id="check_token"><a class="viewcode-back" href="../../../../_generated/astropy.io.votable.xmlutil.check_token.html#astropy.io.votable.xmlutil.check_token">[docs]</a><span class="k">def</span> <span class="nf">check_token</span><span class="p">(</span><span class="n">token</span><span class="p">,</span> <span class="n">attr_name</span><span class="p">,</span> <span class="n">config</span><span class="o">=</span><span class="p">{},</span> <span class="n">pos</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Raises a `ValueError` if *token* is not a valid XML token.</span>
<span class="sd"> As defined by XML Schema Part 2.</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="p">(</span><span class="n">token</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span> <span class="ow">and</span> <span class="ow">not</span> <span class="n">xml_check</span><span class="o">.</span><span class="n">check_token</span><span class="p">(</span><span class="n">token</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>
<div class="viewcode-block" id="check_mime_content_type"><a class="viewcode-back" href="../../../../_generated/astropy.io.votable.xmlutil.check_mime_content_type.html#astropy.io.votable.xmlutil.check_mime_content_type">[docs]</a><span class="k">def</span> <span class="nf">check_mime_content_type</span><span class="p">(</span><span class="n">content_type</span><span class="p">,</span> <span class="n">config</span><span class="o">=</span><span class="p">{},</span> <span class="n">pos</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Raises a `~astropy.io.votable.exceptions.VOTableSpecError` if</span>
<span class="sd"> *content_type* is not a valid MIME content type.</span>
<span class="sd"> As defined by RFC 2045 (syntactically, at least).</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="p">(</span><span class="n">content_type</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span> <span class="ow">and</span>
<span class="ow">not</span> <span class="n">xml_check</span><span class="o">.</span><span class="n">check_mime_content_type</span><span class="p">(</span><span class="n">content_type</span><span class="p">)):</span>
<span class="n">warn_or_raise</span><span class="p">(</span><span class="n">W04</span><span class="p">,</span> <span class="n">W04</span><span class="p">,</span> <span class="n">content_type</span><span class="p">,</span> <span class="n">config</span><span class="p">,</span> <span class="n">pos</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>
<div class="viewcode-block" id="check_anyuri"><a class="viewcode-back" href="../../../../_generated/astropy.io.votable.xmlutil.check_anyuri.html#astropy.io.votable.xmlutil.check_anyuri">[docs]</a><span class="k">def</span> <span class="nf">check_anyuri</span><span class="p">(</span><span class="n">uri</span><span class="p">,</span> <span class="n">config</span><span class="o">=</span><span class="p">{},</span> <span class="n">pos</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Raises a `~astropy.io.votable.exceptions.VOTableSpecError` if</span>
<span class="sd"> *uri* is not a valid URI.</span>
<span class="sd"> As defined in RFC 2396.</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="p">(</span><span class="n">uri</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span> <span class="ow">and</span> <span class="ow">not</span> <span class="n">xml_check</span><span class="o">.</span><span class="n">check_anyuri</span><span class="p">(</span><span class="n">uri</span><span class="p">)):</span>
<span class="n">warn_or_raise</span><span class="p">(</span><span class="n">W05</span><span class="p">,</span> <span class="n">W05</span><span class="p">,</span> <span class="n">uri</span><span class="p">,</span> <span class="n">config</span><span class="p">,</span> <span class="n">pos</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>
<div class="viewcode-block" id="validate_schema"><a class="viewcode-back" href="../../../../_generated/astropy.io.votable.xmlutil.validate_schema.html#astropy.io.votable.xmlutil.validate_schema">[docs]</a><span class="k">def</span> <span class="nf">validate_schema</span><span class="p">(</span><span class="n">filename</span><span class="p">,</span> <span class="n">version</span><span class="o">=</span><span class="s">'1.2'</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Validates the given file against the appropriate VOTable schema.</span>
<span class="sd"> Parameters</span>
<span class="sd"> ----------</span>
<span class="sd"> filename : str</span>
<span class="sd"> The path to the XML file to validate</span>
<span class="sd"> version : str</span>
<span class="sd"> The VOTABLE version to check, which must be a string \"1.0\",</span>
<span class="sd"> \"1.1\", or \"1.2\".</span>
<span class="sd"> For version \"1.0\", it is checked against a DTD, since that</span>
<span class="sd"> version did not have an XML Schema.</span>
<span class="sd"> Returns</span>
<span class="sd"> -------</span>
<span class="sd"> returncode, stdout, stderr : int, str, str</span>
<span class="sd"> Returns the returncode from xmllint and the stdout and stderr</span>
<span class="sd"> as strings</span>
<span class="sd"> """</span>
<span class="k">assert</span> <span class="n">version</span> <span class="ow">in</span> <span class="p">(</span><span class="s">'1.0'</span><span class="p">,</span> <span class="s">'1.1'</span><span class="p">,</span> <span class="s">'1.2'</span><span class="p">)</span>
<span class="k">if</span> <span class="n">version</span> <span class="ow">in</span> <span class="p">(</span><span class="s">'1.1'</span><span class="p">,</span> <span class="s">'1.2'</span><span class="p">):</span>
<span class="n">schema_path</span> <span class="o">=</span> <span class="n">data</span><span class="o">.</span><span class="n">get_pkg_data_filename</span><span class="p">(</span>
<span class="s">'data/VOTable.v{0}.xsd'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">version</span><span class="p">))</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">schema_path</span> <span class="o">=</span> <span class="n">data</span><span class="o">.</span><span class="n">get_pkg_data_filename</span><span class="p">(</span>
<span class="s">'data/VOTable.dtd'</span><span class="p">)</span>
<span class="k">return</span> <span class="n">validate</span><span class="o">.</span><span class="n">validate_schema</span><span class="p">(</span><span class="n">filename</span><span class="p">,</span> <span class="n">schema_path</span><span class="p">)</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>
