<!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.utils.xml.check — 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="astropy.utils" href="../../utils.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" >Module code</a> »</li>
<li><a href="../../utils.html" accesskey="U">astropy.utils</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<h1>Source code for astropy.utils.xml.check</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">A collection of functions for checking various XML-related strings for</span>
<span class="sd">standards compliance.</span>
<span class="sd">"""</span>
<span class="kn">import</span> <span class="nn">re</span>
<span class="kn">import</span> <span class="nn">urlparse</span>
<div class="viewcode-block" id="check_id"><a class="viewcode-back" href="../../../../_generated/astropy.utils.xml.check.check_id.html#astropy.utils.xml.check.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="sd">"""</span>
<span class="sd"> Returns `True` if *ID* is a valid XML ID.</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="n">re</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="s">r"^[A-Za-z_][A-Za-z0-9_\.\-]*$"</span><span class="p">,</span> <span class="n">ID</span><span class="p">)</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span>
</div>
<div class="viewcode-block" id="fix_id"><a class="viewcode-back" href="../../../../_generated/astropy.utils.xml.check.fix_id.html#astropy.utils.xml.check.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="sd">"""</span>
<span class="sd"> Given an arbitrary string, create one that can be used as an xml</span>
<span class="sd"> id. This is rather simplistic at the moment, since it just</span>
<span class="sd"> replaces non-valid characters with underscores.</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="n">re</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="s">r"^[A-Za-z_][A-Za-z0-9_\.\-]*$"</span><span class="p">,</span> <span class="n">ID</span><span class="p">):</span>
<span class="k">return</span> <span class="n">ID</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">ID</span><span class="p">):</span>
<span class="n">corrected</span> <span class="o">=</span> <span class="n">ID</span>
<span class="k">if</span> <span class="ow">not</span> <span class="nb">len</span><span class="p">(</span><span class="n">corrected</span><span class="p">)</span> <span class="ow">or</span> <span class="n">re</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="s">'^[^A-Za-z_]$'</span><span class="p">,</span> <span class="n">corrected</span><span class="p">[</span><span class="mi">0</span><span class="p">]):</span>
<span class="n">corrected</span> <span class="o">=</span> <span class="s">'_'</span> <span class="o">+</span> <span class="n">corrected</span>
<span class="n">corrected</span> <span class="o">=</span> <span class="p">(</span><span class="n">re</span><span class="o">.</span><span class="n">sub</span><span class="p">(</span><span class="s">r"[^A-Za-z_]"</span><span class="p">,</span> <span class="s">'_'</span><span class="p">,</span> <span class="n">corrected</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span> <span class="o">+</span>
<span class="n">re</span><span class="o">.</span><span class="n">sub</span><span class="p">(</span><span class="s">r"[^A-Za-z0-9_\.\-]"</span><span class="p">,</span> <span class="s">"_"</span><span class="p">,</span> <span class="n">corrected</span><span class="p">[</span><span class="mi">1</span><span class="p">:]))</span>
<span class="k">return</span> <span class="n">corrected</span>
<span class="k">return</span> <span class="s">''</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.utils.xml.check.check_token.html#astropy.utils.xml.check.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="sd">"""</span>
<span class="sd"> Returns `True` if *token* is a valid XML token, as defined by XML</span>
<span class="sd"> Schema Part 2.</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="p">(</span><span class="n">token</span> <span class="o">==</span> <span class="s">''</span> <span class="ow">or</span>
<span class="n">re</span><span class="o">.</span><span class="n">match</span><span class="p">(</span>
<span class="s">"[^</span><span class="se">\r\n\t</span><span class="s"> ]?([^</span><span class="se">\r\n\t</span><span class="s"> ]| [^</span><span class="se">\r\n\t</span><span class="s"> ])*[^</span><span class="se">\r\n\t</span><span class="s"> ]?$"</span><span class="p">,</span> <span class="n">token</span><span class="p">)</span>
<span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="check_mime_content_type"><a class="viewcode-back" href="../../../../_generated/astropy.utils.xml.check.check_mime_content_type.html#astropy.utils.xml.check.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="sd">"""</span>
<span class="sd"> Returns `True` if *content_type* is a valid MIME content type</span>
<span class="sd"> (syntactically at least), as defined by RFC 2045.</span>
<span class="sd"> """</span>
<span class="n">ctrls</span> <span class="o">=</span> <span class="s">''</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="nb">chr</span><span class="p">(</span><span class="n">x</span><span class="p">)</span> <span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="nb">xrange</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="mh">0x20</span><span class="p">))</span>
<span class="n">token_regex</span> <span class="o">=</span> <span class="s">'[^()<>@,;:</span><span class="se">\\\"</span><span class="s">/[\]?= </span><span class="si">%s</span><span class="se">\x7f</span><span class="s">]+'</span> <span class="o">%</span> <span class="n">ctrls</span>
<span class="k">return</span> <span class="n">re</span><span class="o">.</span><span class="n">match</span><span class="p">(</span>
<span class="s">r'(?P<type></span><span class="si">%s</span><span class="s">)/(?P<subtype></span><span class="si">%s</span><span class="s">)$'</span> <span class="o">%</span> <span class="p">(</span><span class="n">token_regex</span><span class="p">,</span> <span class="n">token_regex</span><span class="p">),</span>
<span class="n">content_type</span><span class="p">)</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span>
</div>
<div class="viewcode-block" id="check_anyuri"><a class="viewcode-back" href="../../../../_generated/astropy.utils.xml.check.check_anyuri.html#astropy.utils.xml.check.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="sd">"""</span>
<span class="sd"> Returns `True` if *uri* is a valid URI as defined in RFC 2396.</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="p">(</span><span class="n">re</span><span class="o">.</span><span class="n">match</span><span class="p">(</span>
<span class="p">(</span><span class="s">r"(([a-zA-Z][0-9a-zA-Z+\-\.]*:)?/{0,2}[0-9a-zA-Z;"</span> <span class="o">+</span>
<span class="s">r"/?:@&=+$\.\-_!~*'()%]+)?(#[0-9a-zA-Z;/?:@&=+$\.\-_!~*'()%]+)?"</span><span class="p">),</span>
<span class="n">uri</span><span class="p">)</span> <span class="ow">is</span> <span class="bp">None</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">False</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">urlparse</span><span class="o">.</span><span class="n">urlparse</span><span class="p">(</span><span class="n">uri</span><span class="p">)</span>
<span class="k">except</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>
