<!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>pyxb.utils package — PyXB 1.2.6 documentation</title>
<link rel="stylesheet" href="_static/classic.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '1.2.6',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</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>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="pyxb.xmlschema package" href="pyxb.xmlschema.html" />
<link rel="prev" title="pyxb.namespace package" href="pyxb.namespace.html" />
</head>
<body role="document">
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="pyxb.xmlschema.html" title="pyxb.xmlschema package"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="pyxb.namespace.html" title="pyxb.namespace package"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">PyXB 1.2.6 documentation</a> »</li>
<li class="nav-item nav-item-1"><a href="pyxb.html" accesskey="U">pyxb package</a> »</li>
<li style="margin-left: 20px">PyXB hosted on <a href="http://sourceforge.net/projects/pyxb"><img src="http://sflogo.sourceforge.net/sflogo.php?group_id=263147&type=9"
width="80" height="15" alt="Get PyXB: Python XML Schema Bindings at SourceForge.net. Fast, secure and Free Open Source software downloads"/></a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="pyxb-utils-package">
<h1>pyxb.utils package<a class="headerlink" href="#pyxb-utils-package" title="Permalink to this headline">¶</a></h1>
<div class="section" id="submodules">
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
</div>
<div class="section" id="module-pyxb.utils.activestate">
<span id="pyxb-utils-activestate-module"></span><h2>pyxb.utils.activestate module<a class="headerlink" href="#module-pyxb.utils.activestate" title="Permalink to this headline">¶</a></h2>
<dl class="function">
<dt id="pyxb.utils.activestate.detectXMLEncoding">
<code class="descclassname">pyxb.utils.activestate.</code><code class="descname">detectXMLEncoding</code><span class="sig-paren">(</span><em>fp</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.activestate.detectXMLEncoding" title="Permalink to this definition">¶</a></dt>
<dd><p>Attempts to detect the character encoding of the xml file
given by a file object fp. fp must not be a codec wrapped file
object!</p>
<dl class="docutils">
<dt>The return value can be:</dt>
<dd><ul class="first simple">
<li>if detection of the BOM succeeds, the codec name of the</li>
</ul>
<p>corresponding unicode charset is returned</p>
<ul class="simple">
<li>if BOM detection fails, the xml declaration is searched for</li>
</ul>
<p>the encoding attribute and its value returned. the “<”
character has to be the very first in the file then (it’s xml
standard after all).</p>
<ul class="simple">
<li>if BOM and xml declaration fail, None is returned. According</li>
</ul>
<p class="last">to xml 1.0 it should be utf_8 then, but it wasn’t detected by
the means offered here. at least one can be pretty sure that a
character coding including most of ASCII is used :-/</p>
</dd>
</dl>
</dd></dl>
</div>
<div class="section" id="module-pyxb.utils.domutils">
<span id="pyxb-utils-domutils-module"></span><h2>pyxb.utils.domutils module<a class="headerlink" href="#module-pyxb.utils.domutils" title="Permalink to this headline">¶</a></h2>
<p>Functions that support activities related to the Document Object Model.</p>
<dl class="class">
<dt id="pyxb.utils.domutils.BindingDOMSupport">
<em class="property">class </em><code class="descclassname">pyxb.utils.domutils.</code><code class="descname">BindingDOMSupport</code><span class="sig-paren">(</span><em>implementation=None</em>, <em>default_namespace=None</em>, <em>require_xsi_type=False</em>, <em>namespace_prefix_map=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.domutils.BindingDOMSupport" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
<p>This holds DOM-related information used when generating a DOM tree from
a binding instance.</p>
<dl class="classmethod">
<dt id="pyxb.utils.domutils.BindingDOMSupport.DeclareNamespace">
<em class="property">classmethod </em><code class="descname">DeclareNamespace</code><span class="sig-paren">(</span><em>namespace</em>, <em>prefix=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.domutils.BindingDOMSupport.DeclareNamespace" title="Permalink to this definition">¶</a></dt>
<dd><p>Declare a namespace that will made available to each created instance.</p>
</dd></dl>
<dl class="classmethod">
<dt id="pyxb.utils.domutils.BindingDOMSupport.DefaultNamespace">
<em class="property">classmethod </em><code class="descname">DefaultNamespace</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.domutils.BindingDOMSupport.DefaultNamespace" title="Permalink to this definition">¶</a></dt>
<dd><p>The global default namespace (used on instance creation if not overridden)</p>
</dd></dl>
<dl class="classmethod">
<dt id="pyxb.utils.domutils.BindingDOMSupport.Reset">
<em class="property">classmethod </em><code class="descname">Reset</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.domutils.BindingDOMSupport.Reset" title="Permalink to this definition">¶</a></dt>
<dd><p>Reset the global defaults for default/prefix/namespace information.</p>
</dd></dl>
<dl class="classmethod">
<dt id="pyxb.utils.domutils.BindingDOMSupport.SetDefaultNamespace">
<em class="property">classmethod </em><code class="descname">SetDefaultNamespace</code><span class="sig-paren">(</span><em>default_namespace</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.domutils.BindingDOMSupport.SetDefaultNamespace" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.domutils.BindingDOMSupport._BindingDOMSupport__NamespaceContext">
<code class="descname">_BindingDOMSupport__NamespaceContext</code><em class="property"> = <pyxb.namespace.resolution.NamespaceContext object></em><a class="headerlink" href="#pyxb.utils.domutils.BindingDOMSupport._BindingDOMSupport__NamespaceContext" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.domutils.BindingDOMSupport._BindingDOMSupport__document">
<code class="descname">_BindingDOMSupport__document</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.utils.domutils.BindingDOMSupport._BindingDOMSupport__document" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.domutils.BindingDOMSupport._BindingDOMSupport__implementation">
<code class="descname">_BindingDOMSupport__implementation</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.utils.domutils.BindingDOMSupport._BindingDOMSupport__implementation" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.domutils.BindingDOMSupport._BindingDOMSupport__namespaceContext">
<code class="descname">_BindingDOMSupport__namespaceContext</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.utils.domutils.BindingDOMSupport._BindingDOMSupport__namespaceContext" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.domutils.BindingDOMSupport._BindingDOMSupport__referencedNamespacePrefixes">
<code class="descname">_BindingDOMSupport__referencedNamespacePrefixes</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.utils.domutils.BindingDOMSupport._BindingDOMSupport__referencedNamespacePrefixes" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.domutils.BindingDOMSupport._BindingDOMSupport__requireXSIType">
<code class="descname">_BindingDOMSupport__requireXSIType</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.utils.domutils.BindingDOMSupport._BindingDOMSupport__requireXSIType" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.utils.domutils.BindingDOMSupport._deepClone">
<code class="descname">_deepClone</code><span class="sig-paren">(</span><em>node</em>, <em>docnode</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.domutils.BindingDOMSupport._deepClone" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.utils.domutils.BindingDOMSupport._makeURINodeNamePair">
<code class="descname">_makeURINodeNamePair</code><span class="sig-paren">(</span><em>node</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.domutils.BindingDOMSupport._makeURINodeNamePair" title="Permalink to this definition">¶</a></dt>
<dd><p>Convert namespace information from a DOM node to text for new DOM node.</p>
<p>The namespaceURI and nodeName are extracted and parsed. The namespace
(if any) is registered within the document, along with any prefix from
the node name. A pair is returned where the first element is the
namespace URI or <code class="xref py py-obj docutils literal"><span class="pre">None</span></code>, and the second is a QName to be used for the
expanded name within this document.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>node</strong> – An xml.dom.Node instance, presumably from a wildcard match.</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><code class="xref py py-obj docutils literal"><span class="pre">(</span> <span class="pre">str,</span> <span class="pre">str</span> <span class="pre">)</span></code></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.domutils.BindingDOMSupport.addAttribute">
<code class="descname">addAttribute</code><span class="sig-paren">(</span><em>element</em>, <em>expanded_name</em>, <em>value</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.domutils.BindingDOMSupport.addAttribute" title="Permalink to this definition">¶</a></dt>
<dd><p>Add an attribute to the given element.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>element</strong> (<code class="xref py py-obj docutils literal"><span class="pre">xml.dom.Element</span></code>) – The element to which the attribute should be added</li>
<li><strong>expanded_name</strong> – The name of the attribute. This may be a local</li>
</ul>
</td>
</tr>
</tbody>
</table>
<p>name if the attribute is not in a namespace.
:type expanded_name: <a class="reference internal" href="pyxb.namespace.html#pyxb.namespace.Namespace" title="pyxb.namespace.Namespace"><code class="xref py py-obj docutils literal"><span class="pre">pyxb.namespace.Namespace</span></code></a> or <code class="xref py py-obj docutils literal"><span class="pre">str</span></code> or <code class="xref py py-obj docutils literal"><span class="pre">unicode</span></code>
:param value: The value of the attribute
:type value: <code class="xref py py-obj docutils literal"><span class="pre">str</span></code> or <code class="xref py py-obj docutils literal"><span class="pre">unicode</span></code></p>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.domutils.BindingDOMSupport.addXMLNSDeclaration">
<code class="descname">addXMLNSDeclaration</code><span class="sig-paren">(</span><em>element</em>, <em>namespace</em>, <em>prefix=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.domutils.BindingDOMSupport.addXMLNSDeclaration" title="Permalink to this definition">¶</a></dt>
<dd><p>Manually add an XMLNS declaration to the document element.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>namespace</strong> – a <a class="reference internal" href="pyxb.namespace.html#pyxb.namespace.Namespace" title="pyxb.namespace.Namespace"><code class="xref py py-obj docutils literal"><span class="pre">pyxb.namespace.Namespace</span></code></a> instance</li>
<li><strong>prefix</strong> – the prefix by which the namespace is known. If</li>
</ul>
</td>
</tr>
</tbody>
</table>
<p><code class="xref py py-obj docutils literal"><span class="pre">None</span></code>, the default prefix as previously declared will be used; if
<code class="xref py py-obj docutils literal"><span class="pre">''</span></code> (empty string) a declaration for <code class="xref py py-obj docutils literal"><span class="pre">namespace</span></code> as the default
namespace will be generated.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><code class="xref py py-obj docutils literal"><span class="pre">prefix</span></code> as used in the added declaration.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.domutils.BindingDOMSupport.appendChild">
<code class="descname">appendChild</code><span class="sig-paren">(</span><em>child</em>, <em>parent</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.domutils.BindingDOMSupport.appendChild" title="Permalink to this definition">¶</a></dt>
<dd><p>Add the child to the parent.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Note:</th><td class="field-body">If the child and the parent use different DOM implementations,</td>
</tr>
</tbody>
</table>
<p>this operation will clone the child into a new instance, and give that
to the parent.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>child</strong> (<code class="xref py py-obj docutils literal"><span class="pre">xml.dom.Node</span></code>) – The value to be appended</li>
<li><strong>parent</strong> (<code class="xref py py-obj docutils literal"><span class="pre">xml.dom.Node</span></code>) – The new parent of the child</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><code class="xref py py-obj docutils literal"><span class="pre">xml.dom.Node</span></code></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.domutils.BindingDOMSupport.appendTextChild">
<code class="descname">appendTextChild</code><span class="sig-paren">(</span><em>text</em>, <em>parent</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.domutils.BindingDOMSupport.appendTextChild" title="Permalink to this definition">¶</a></dt>
<dd><p>Add the text to the parent as a text node.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.domutils.BindingDOMSupport.cloneIntoImplementation">
<code class="descname">cloneIntoImplementation</code><span class="sig-paren">(</span><em>node</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.domutils.BindingDOMSupport.cloneIntoImplementation" title="Permalink to this definition">¶</a></dt>
<dd><p>Create a deep copy of the node in the target implementation.</p>
<p>Used when converting a DOM instance from one implementation (e.g.,
<a class="reference internal" href="#module-pyxb.utils.saxdom" title="pyxb.utils.saxdom"><code class="xref py py-obj docutils literal"><span class="pre">pyxb.utils.saxdom</span></code></a>) into another (e.g., <code class="xref py py-obj docutils literal"><span class="pre">xml.dom.minidom</span></code>).</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.domutils.BindingDOMSupport.createChildElement">
<code class="descname">createChildElement</code><span class="sig-paren">(</span><em>expanded_name</em>, <em>parent=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.domutils.BindingDOMSupport.createChildElement" title="Permalink to this definition">¶</a></dt>
<dd><p>Create a new element node in the tree.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>expanded_name</strong> – The name of the element. A plain string</td>
</tr>
</tbody>
</table>
<p>indicates a name in no namespace.
:type expanded_name: <a class="reference internal" href="pyxb.namespace.html#pyxb.namespace.ExpandedName" title="pyxb.namespace.ExpandedName"><code class="xref py py-obj docutils literal"><span class="pre">pyxb.namespace.ExpandedName</span></code></a> or <code class="xref py py-obj docutils literal"><span class="pre">str</span></code> or <code class="xref py py-obj docutils literal"><span class="pre">unicode</span></code></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>parent</strong> – The node in the tree that will serve as the child’s</td>
</tr>
</tbody>
</table>
<p>parent. If <code class="xref py py-obj docutils literal"><span class="pre">None</span></code>, the document element is used. (If there is no
document element, then this call creates it as a side-effect.)</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">A newly created DOM element</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><code class="xref py py-obj docutils literal"><span class="pre">xml.dom.Element</span></code></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.domutils.BindingDOMSupport.declareNamespace">
<code class="descname">declareNamespace</code><span class="sig-paren">(</span><em>namespace</em>, <em>prefix=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.domutils.BindingDOMSupport.declareNamespace" title="Permalink to this definition">¶</a></dt>
<dd><p>Declare a namespace within this instance only.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.domutils.BindingDOMSupport.defaultNamespace">
<code class="descname">defaultNamespace</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.domutils.BindingDOMSupport.defaultNamespace" title="Permalink to this definition">¶</a></dt>
<dd><p>The default namespace for this instance</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.domutils.BindingDOMSupport.document">
<code class="descname">document</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.domutils.BindingDOMSupport.document" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the document generated using this instance.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.domutils.BindingDOMSupport.finalize">
<code class="descname">finalize</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.domutils.BindingDOMSupport.finalize" title="Permalink to this definition">¶</a></dt>
<dd><p>Do the final cleanup after generating the tree. This makes sure
that the document element includes XML Namespace declarations for all
namespaces referenced in the tree.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">The document that has been created.</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><code class="xref py py-obj docutils literal"><span class="pre">xml.dom.Document</span></code></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.domutils.BindingDOMSupport.implementation">
<code class="descname">implementation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.domutils.BindingDOMSupport.implementation" title="Permalink to this definition">¶</a></dt>
<dd><p>The DOMImplementation object to be used.</p>
<p>Defaults to <a class="reference internal" href="#pyxb.utils.domutils.GetDOMImplementation" title="pyxb.utils.domutils.GetDOMImplementation"><code class="xref py py-obj docutils literal"><span class="pre">pyxb.utils.domutils.GetDOMImplementation()</span></code></a>, but can be
overridden in the constructor call using the <a class="reference internal" href="#pyxb.utils.domutils.BindingDOMSupport.implementation" title="pyxb.utils.domutils.BindingDOMSupport.implementation"><code class="xref py py-obj docutils literal"><span class="pre">implementation</span></code></a>
keyword.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.domutils.BindingDOMSupport.namespacePrefix">
<code class="descname">namespacePrefix</code><span class="sig-paren">(</span><em>namespace</em>, <em>enable_default_namespace=True</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.domutils.BindingDOMSupport.namespacePrefix" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the prefix to be used for the given namespace.</p>
<p>This will <a class="reference internal" href="#pyxb.utils.domutils.BindingDOMSupport.declareNamespace" title="pyxb.utils.domutils.BindingDOMSupport.declareNamespace"><code class="xref py py-obj docutils literal"><span class="pre">declare</span></code></a> the namespace if it has not
yet been observed. It will also ensure the mapping from the returned
prefix to <code class="xref py py-obj docutils literal"><span class="pre">namespace</span></code> is recorded for addition as an xmlns directive
in the final document.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>namespace</strong> – The namespace for which a prefix is needed. If the</td>
</tr>
</tbody>
</table>
<p>provided namespace is <code class="xref py py-obj docutils literal"><span class="pre">None</span></code> or an absent namespace, the <code class="xref py py-obj docutils literal"><span class="pre">None</span></code>
value will be returned as the corresponding prefix.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>enable_default_namespace</strong> – Normally if the namespace is the default</td>
</tr>
</tbody>
</table>
<p>namespace <code class="xref py py-obj docutils literal"><span class="pre">None</span></code> is returned to indicate this. If this keyword is
<code class="xref py py-obj docutils literal"><span class="pre">False</span></code> then we need a namespace prefix even if this is the default.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.domutils.BindingDOMSupport.qnameAsText">
<code class="descname">qnameAsText</code><span class="sig-paren">(</span><em>qname</em>, <em>enable_default_namespace=True</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.domutils.BindingDOMSupport.qnameAsText" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.utils.domutils.BindingDOMSupport.requireXSIType">
<code class="descname">requireXSIType</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.domutils.BindingDOMSupport.requireXSIType" title="Permalink to this definition">¶</a></dt>
<dd><p>Indicates whether {xsi:type<<a class="reference external" href="http://www.w3.org/TR/xmlschema-1/#xsi_type">http://www.w3.org/TR/xmlschema-1/#xsi_type</a>>} should be added to all elements.</p>
<p>Certain WSDL styles and encodings seem to require explicit notation of
the type of each element, even if it was specified in the schema.</p>
<p>This value can only be set in the constructor.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.domutils.BindingDOMSupport.reset">
<code class="descname">reset</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.domutils.BindingDOMSupport.reset" title="Permalink to this definition">¶</a></dt>
<dd><p>Reset this instance to the state it was when created.</p>
<p>This creates a new root document with no content, resets the
namespace-prefix map to its as-constructed content, and clears the set
of referenced namespace prefixes. The defaultNamespace and
requireXSIType are not modified.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.domutils.BindingDOMSupport.setDefaultNamespace">
<code class="descname">setDefaultNamespace</code><span class="sig-paren">(</span><em>default_namespace</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.domutils.BindingDOMSupport.setDefaultNamespace" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.utils.domutils.BindingDOMSupport.valueAsText">
<code class="descname">valueAsText</code><span class="sig-paren">(</span><em>value</em>, <em>enable_default_namespace=True</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.domutils.BindingDOMSupport.valueAsText" title="Permalink to this definition">¶</a></dt>
<dd><p>Represent a simple type value as XML text.</p>
<p>This is essentially what <code class="xref py py-obj docutils literal"><span class="pre">value.xsdLiteral()</span></code> does, but this one
handles any special cases such as QName values where the lexical
representation cannot be done in isolation of external information
such as namespace declarations.</p>
</dd></dl>
</dd></dl>
<dl class="function">
<dt id="pyxb.utils.domutils.ExtractTextContent">
<code class="descclassname">pyxb.utils.domutils.</code><code class="descname">ExtractTextContent</code><span class="sig-paren">(</span><em>node</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.domutils.ExtractTextContent" title="Permalink to this definition">¶</a></dt>
<dd><p>Walk all the children, extracting all text content and
catenating it into the return value.</p>
<p>Returns <code class="xref py py-obj docutils literal"><span class="pre">None</span></code> if no text content (including whitespace) is found.</p>
<p>This is mainly used to strip comments out of the content of complex
elements with simple types.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><code class="xref py py-obj docutils literal"><span class="pre">unicode</span></code> or <code class="xref py py-obj docutils literal"><span class="pre">str</span></code></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="pyxb.utils.domutils.GetDOMImplementation">
<code class="descclassname">pyxb.utils.domutils.</code><code class="descname">GetDOMImplementation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.domutils.GetDOMImplementation" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the DOMImplementation object used for pyxb operations.</p>
<p>This is primarily used as the default implementation when generating DOM
trees from a binding instance. It defaults to whatever
xml.dom.getDOMImplementation() returns in your installation (often
xml.dom.minidom). It can be overridden with SetDOMImplementation().</p>
</dd></dl>
<dl class="function">
<dt id="pyxb.utils.domutils.HasNonAnnotationChild">
<code class="descclassname">pyxb.utils.domutils.</code><code class="descname">HasNonAnnotationChild</code><span class="sig-paren">(</span><em>node</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.domutils.HasNonAnnotationChild" title="Permalink to this definition">¶</a></dt>
<dd><p>Return True iff <code class="xref py py-obj docutils literal"><span class="pre">node</span></code> has an ELEMENT_NODE child that is not an
XMLSchema annotation node.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><code class="xref py py-obj docutils literal"><span class="pre">bool</span></code></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="pyxb.utils.domutils.LocateFirstChildElement">
<code class="descclassname">pyxb.utils.domutils.</code><code class="descname">LocateFirstChildElement</code><span class="sig-paren">(</span><em>node</em>, <em>absent_ok=True</em>, <em>require_unique=False</em>, <em>ignore_annotations=True</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.domutils.LocateFirstChildElement" title="Permalink to this definition">¶</a></dt>
<dd><p>Locate the first element child of the node.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>node</strong> – An a xml.dom.Node ELEMENT_NODE instance.</li>
<li><strong>absent_ok</strong> – If <code class="xref py py-obj docutils literal"><span class="pre">True</span></code> (default), <code class="xref py py-obj docutils literal"><span class="pre">None</span></code> is returned if no match</li>
</ul>
</td>
</tr>
</tbody>
</table>
<p>can be found. If <code class="xref py py-obj docutils literal"><span class="pre">False</span></code>, an exception is raised if no match can be
found.
:keyword require_unique: If <code class="xref py py-obj docutils literal"><span class="pre">False</span></code> (default), it is acceptable for there
to be multiple child elements. If <code class="xref py py-obj docutils literal"><span class="pre">True</span></code>, presence of multiple child
elements raises an exception.
:keyword ignore_annotations: If <code class="xref py py-obj docutils literal"><span class="pre">True</span></code> (default), annotations are skipped
wheen looking for the first child element. If <code class="xref py py-obj docutils literal"><span class="pre">False</span></code>, an annotation
counts as an element.
:rtype: <code class="xref py py-obj docutils literal"><span class="pre">xml.dom.Node</span></code></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Raises:</th><td class="field-body"><a class="reference internal" href="pyxb.html#pyxb.exceptions_.SchemaValidationError" title="pyxb.exceptions_.SchemaValidationError"><strong>SchemaValidationError</strong></a> – <code class="xref py py-obj docutils literal"><span class="pre">absent_ok</span></code> is <code class="xref py py-obj docutils literal"><span class="pre">False</span></code> and no child</td>
</tr>
</tbody>
</table>
<p>element was identified.
:raise SchemaValidationError: <code class="xref py py-obj docutils literal"><span class="pre">require_unique</span></code> is <code class="xref py py-obj docutils literal"><span class="pre">True</span></code> and multiple
child elements were identified</p>
</dd></dl>
<dl class="function">
<dt id="pyxb.utils.domutils.LocateMatchingChildren">
<code class="descclassname">pyxb.utils.domutils.</code><code class="descname">LocateMatchingChildren</code><span class="sig-paren">(</span><em>node</em>, <em>tag</em>, <em>namespace=<pyxb.namespace.builtin._XMLSchema object></em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.domutils.LocateMatchingChildren" title="Permalink to this definition">¶</a></dt>
<dd><p>Locate all children of the DOM node that have a particular tag.</p>
<p>This function returns a list of children of node which are ELEMENT_NODE
instances and have a tag consistent with the given tag.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>node</strong> – An a xml.dom.Node ELEMENT_NODE instance.</li>
<li><strong>tag</strong> – the NCName of an element in the namespace, which defaults to the</li>
</ul>
</td>
</tr>
</tbody>
</table>
<p>XMLSchema namespace.
:keyword namespace: The namespace to which the child element belongs.
Default is the XMLSchema namespace.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><code class="xref py py-obj docutils literal"><span class="pre">list(xml.dom.Node)</span></code></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="pyxb.utils.domutils.LocateUniqueChild">
<code class="descclassname">pyxb.utils.domutils.</code><code class="descname">LocateUniqueChild</code><span class="sig-paren">(</span><em>node</em>, <em>tag</em>, <em>absent_ok=True</em>, <em>namespace=<pyxb.namespace.builtin._XMLSchema object></em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.domutils.LocateUniqueChild" title="Permalink to this definition">¶</a></dt>
<dd><p>Locate a unique child of the DOM node.</p>
<p>This function returns the sole child of node which is an ELEMENT_NODE
instance and has a tag consistent with the given tag. If multiple nodes
with a matching <code class="xref py py-obj docutils literal"><span class="pre">tag</span></code> are found, or <code class="xref py py-obj docutils literal"><span class="pre">absent_ok</span></code> is <code class="xref py py-obj docutils literal"><span class="pre">False</span></code> and no
matching tag is found, an exception is raised.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>node</strong> – An a xml.dom.Node ELEMENT_NODE instance</li>
<li><strong>tag</strong> – the NCName of an element in the namespace</li>
<li><strong>absent_ok</strong> – If <code class="xref py py-obj docutils literal"><span class="pre">True</span></code> (default), <code class="xref py py-obj docutils literal"><span class="pre">None</span></code> is returned if no match</li>
</ul>
</td>
</tr>
</tbody>
</table>
<p>can be found. If <code class="xref py py-obj docutils literal"><span class="pre">False</span></code>, an exception is raised if no match can be
found.
:keyword namespace: The namespace to which the child element belongs.
Default is the XMLSchema namespace.
:rtype: <code class="xref py py-obj docutils literal"><span class="pre">xml.dom.Node</span></code></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Raises:</th><td class="field-body"><ul class="first last simple">
<li><strong>pyxb.SchemaValidationError</strong> – multiple elements are identified</li>
<li><strong>pyxb.SchemaValidationError</strong> – <code class="xref py py-obj docutils literal"><span class="pre">absent_ok</span></code> is <code class="xref py py-obj docutils literal"><span class="pre">False</span></code> and no element is identified.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="pyxb.utils.domutils.NodeAttribute">
<code class="descclassname">pyxb.utils.domutils.</code><code class="descname">NodeAttribute</code><span class="sig-paren">(</span><em>node</em>, <em>attribute_ncname</em>, <em>attribute_ns=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.domutils.NodeAttribute" title="Permalink to this definition">¶</a></dt>
<dd><p>Namespace-aware search for an optional attribute in a node.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>attribute_ncname</strong> (<code class="xref py py-obj docutils literal"><span class="pre">str</span></code> or <code class="xref py py-obj docutils literal"><span class="pre">unicode</span></code>) – The local name of the attribute.</li>
<li><strong>attribute_ns</strong> – The namespace of the attribute. Defaults to None</li>
</ul>
</td>
</tr>
</tbody>
</table>
<p>since most attributes are not in a namespace. Can be provided as either a
<a class="reference internal" href="pyxb.namespace.html#pyxb.namespace.Namespace" title="pyxb.namespace.Namespace"><code class="xref py py-obj docutils literal"><span class="pre">pyxb.namespace.Namespace</span></code></a> instance, or a string URI.
:type attribute_ns: <code class="xref py py-obj docutils literal"><span class="pre">None</span></code> or <code class="xref py py-obj docutils literal"><span class="pre">str</span></code> or <code class="xref py py-obj docutils literal"><span class="pre">unicode</span></code> or <a class="reference internal" href="pyxb.namespace.html#pyxb.namespace.Namespace" title="pyxb.namespace.Namespace"><code class="xref py py-obj docutils literal"><span class="pre">pyxb.namespace.Namespace</span></code></a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">The value of the attribute, or <code class="xref py py-obj docutils literal"><span class="pre">None</span></code> if the attribute is not</td>
</tr>
</tbody>
</table>
<p>present. (Unless <code class="xref py py-obj docutils literal"><span class="pre">None</span></code>, the value will always be a (unicode) string.)</p>
</dd></dl>
<dl class="function">
<dt id="pyxb.utils.domutils.NodeAttributeQName">
<code class="descclassname">pyxb.utils.domutils.</code><code class="descname">NodeAttributeQName</code><span class="sig-paren">(</span><em>node</em>, <em>attribute_ncname</em>, <em>attribute_ns=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.domutils.NodeAttributeQName" title="Permalink to this definition">¶</a></dt>
<dd><p>Like <a class="reference internal" href="#pyxb.utils.domutils.NodeAttribute" title="pyxb.utils.domutils.NodeAttribute"><code class="xref py py-obj docutils literal"><span class="pre">NodeAttribute</span></code></a> but where the content is a QName that must be
resolved in the context of the node.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>attribute_ncname</strong> – as in <a class="reference internal" href="#pyxb.utils.domutils.NodeAttribute" title="pyxb.utils.domutils.NodeAttribute"><code class="xref py py-obj docutils literal"><span class="pre">NodeAttribute</span></code></a></li>
<li><strong>attribute_ns</strong> – as in <a class="reference internal" href="#pyxb.utils.domutils.NodeAttribute" title="pyxb.utils.domutils.NodeAttribute"><code class="xref py py-obj docutils literal"><span class="pre">NodeAttribute</span></code></a></li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">The expanded name to which the value of the attribute resolves</p>
</td>
</tr>
</tbody>
</table>
<p>given current namespaces, or <code class="xref py py-obj docutils literal"><span class="pre">None</span></code> if the attribute is not present
:rtype: <a class="reference internal" href="pyxb.namespace.html#pyxb.namespace.ExpandedName" title="pyxb.namespace.ExpandedName"><code class="xref py py-obj docutils literal"><span class="pre">pyxb.namespace.ExpandedName</span></code></a></p>
</dd></dl>
<dl class="function">
<dt id="pyxb.utils.domutils.SetDOMImplementation">
<code class="descclassname">pyxb.utils.domutils.</code><code class="descname">SetDOMImplementation</code><span class="sig-paren">(</span><em>dom_implementation</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.domutils.SetDOMImplementation" title="Permalink to this definition">¶</a></dt>
<dd><p>Override the default DOMImplementation object.</p>
</dd></dl>
<dl class="function">
<dt id="pyxb.utils.domutils.StringToDOM">
<code class="descclassname">pyxb.utils.domutils.</code><code class="descname">StringToDOM</code><span class="sig-paren">(</span><em>xml_text</em>, <em>**kw</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.domutils.StringToDOM" title="Permalink to this definition">¶</a></dt>
<dd><p>Convert string to a DOM instance.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">See:</th><td class="field-body"><a class="reference internal" href="pyxb.html#pyxb._SetXMLStyle" title="pyxb._SetXMLStyle"><code class="xref py py-obj docutils literal"><span class="pre">pyxb._SetXMLStyle</span></code></a>.</td>
</tr>
</tbody>
</table>
</dd></dl>
</div>
<div class="section" id="pyxb-utils-fac-module">
<h2>pyxb.utils.fac module<a class="headerlink" href="#pyxb-utils-fac-module" title="Permalink to this headline">¶</a></h2>
<span class="target" id="module-pyxb.utils.fac"></span><p>This module provides Finite Automata with Counters.</p>
<p>FACs are type of state machine where a transition may include a
constraint and a modification to a set of counters. They are used to
implement regular expressions with numerical constraints, as are found
in POSIX regexp, Perl, and XML schema.</p>
<p>The implementation here derives from U{Regular Expressions with
Numerical Constraints and Automata with Counters
<<a class="reference external" href="https://bora.uib.no/bitstream/1956/3628/3/Hovland_LNCS%205684.pdf">https://bora.uib.no/bitstream/1956/3628/3/Hovland_LNCS%205684.pdf</a>>},
Dag Hovland, Lecture Notes in Computer Science, 2009, Volume 5684,
Theoretical Aspects of Computing - ICTAC 2009, Pages 231-245. In what
follows, this reference will be denoted B{HOV09}.</p>
<p>A regular expression is directly translated into a term tree, where
nodes are operators such as sequence, choice, and counter
restrictions, and the leaf nodes denote symbols in the language of the
regular expression.</p>
<p>In the case of XML content models, the symbols include L{element
declarations <pyxb.xmlschema.structures.ElementDeclaration>} and
<a class="reference internal" href="pyxb.xmlschema.html#pyxb.xmlschema.structures.Wildcard" title="pyxb.xmlschema.structures.Wildcard"><code class="xref py py-obj docutils literal"><span class="pre">wildcard</span> <span class="pre">elements</span></code></a>. A
numerical constraint node corresponds to an L{XML particle
<pyxb.xmlschema.structures.Particle>}, and choice and sequence nodes
derive from <a class="reference internal" href="pyxb.xmlschema.html#pyxb.xmlschema.structures.ModelGroup" title="pyxb.xmlschema.structures.ModelGroup"><code class="xref py py-obj docutils literal"><span class="pre">model</span> <span class="pre">groups</span></code></a> of
types B{choice} and B{sequence}. As suggested in U{The Membership
Problem for Regular Expressions with Unordered Concatenation and
Numerical Constraints <<a class="reference external" href="http://www.ii.uib.no/~dagh/presLATA2012.pdf">http://www.ii.uib.no/~dagh/presLATA2012.pdf</a>>}
the B{all} content model can be translated into state machine using
choice and sequence at the cost of a quadratic size explosion. Since
some XML content models might have a hundred terms in an unordered
catenation, this is not acceptable, and the implementation here
optimizes this construct by creating a leaf node in the automaton
which in turn contains sub-automata for each term, and permits an exit
transition only when all the terms that are required have been
completed.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">note:</th><td class="field-body">In XSD 1.1 the restriction that terms in an B{all} model group</td>
</tr>
</tbody>
</table>
<p>occur at most once has been removed. Since the current implementation
removes a completed term from the set of available terms, this will
not work: instead the subconfiguration with its counter values must be
retained between matches.</p>
<dl class="class">
<dt id="pyxb.utils.fac.All">
<em class="property">class </em><code class="descclassname">pyxb.utils.fac.</code><code class="descname">All</code><span class="sig-paren">(</span><em>*terms</em>, <em>**kw</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.All" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#pyxb.utils.fac.MultiTermNode" title="pyxb.utils.fac.MultiTermNode"><code class="xref py py-class docutils literal"><span class="pre">pyxb.utils.fac.MultiTermNode</span></code></a>, <a class="reference internal" href="#pyxb.utils.fac.LeafNode" title="pyxb.utils.fac.LeafNode"><code class="xref py py-class docutils literal"><span class="pre">pyxb.utils.fac.LeafNode</span></code></a></p>
<p>A term that is an unordered sequence of terms.</p>
<p>Note that the inheritance structure for this node is unusual. It
has multiple children when it is treated as a term tree, but is
considered a leaf node when constructing an automaton.</p>
<dl class="classmethod">
<dt id="pyxb.utils.fac.All.CreateTermTree">
<em class="property">classmethod </em><code class="descname">CreateTermTree</code><span class="sig-paren">(</span><em>*terms</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.All.CreateTermTree" title="Permalink to this definition">¶</a></dt>
<dd><p>Create a term tree that implements unordered catenation of
the terms.</p>
<p>This expansion results in a standard choice/sequence term
tree, at the cost of quadratic state expansion because terms
are <a class="reference internal" href="#pyxb.utils.fac.Node.clone" title="pyxb.utils.fac.Node.clone"><code class="xref py py-obj docutils literal"><span class="pre">cloned</span></code></a> as required to satisfy the tree
requirements of the term tree.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>terms</strong> – The tuple of terms that are elements of an</td>
</tr>
</tbody>
</table>
<p>accepted sequence.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">A term tree comprising a choice between sequences</td>
</tr>
</tbody>
</table>
<p>that connect each term to the unordered catenation of the
remaining terms.</p>
</dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.fac.All._Precedence">
<code class="descname">_Precedence</code><em class="property"> = 0</em><a class="headerlink" href="#pyxb.utils.fac.All._Precedence" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.utils.fac.All._nullable">
<code class="descname">_nullable</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.All._nullable" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="pyxb.utils.fac.Automaton">
<em class="property">class </em><code class="descclassname">pyxb.utils.fac.</code><code class="descname">Automaton</code><span class="sig-paren">(</span><em>states</em>, <em>counter_conditions</em>, <em>nullable</em>, <em>containing_state=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.Automaton" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
<p>Representation of a Finite Automaton with Counters.</p>
<p>This has all the standard FAC elements, plus links to other
states/automata as required to support the nested automata
construct used for matching unordered catenation terms.</p>
<dl class="attribute">
<dt id="pyxb.utils.fac.Automaton._Automaton__containingState">
<code class="descname">_Automaton__containingState</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.utils.fac.Automaton._Automaton__containingState" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.fac.Automaton._Automaton__counterConditions">
<code class="descname">_Automaton__counterConditions</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.utils.fac.Automaton._Automaton__counterConditions" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.fac.Automaton._Automaton__finalStates">
<code class="descname">_Automaton__finalStates</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.utils.fac.Automaton._Automaton__finalStates" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.utils.fac.Automaton._Automaton__get_containingState">
<code class="descname">_Automaton__get_containingState</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.Automaton._Automaton__get_containingState" title="Permalink to this definition">¶</a></dt>
<dd><p>The <a class="reference internal" href="#pyxb.utils.fac.State" title="pyxb.utils.fac.State"><code class="xref py py-obj docutils literal"><span class="pre">State</span></code></a> instance for which this is a sub-automaton.</p>
<p><code class="xref py py-obj docutils literal"><span class="pre">None</span></code> if this is not a sub-automaton.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.fac.Automaton._Automaton__get_counterConditions">
<code class="descname">_Automaton__get_counterConditions</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.Automaton._Automaton__get_counterConditions" title="Permalink to this definition">¶</a></dt>
<dd><p>The set of :py:obj:<a href="#id1"><span class="problematic" id="id2">`</span></a>CounterCondition`s in the automaton.</p>
<p>These are marked positions in the regular expression, or
<a class="reference internal" href="pyxb.xmlschema.html#pyxb.xmlschema.structures.Particle" title="pyxb.xmlschema.structures.Particle"><code class="xref py py-obj docutils literal"><span class="pre">particles</span></code></a> in an XML
schema, paired with their occurrence constraints.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.fac.Automaton._Automaton__get_finalStates">
<code class="descname">_Automaton__get_finalStates</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.Automaton._Automaton__get_finalStates" title="Permalink to this definition">¶</a></dt>
<dd><p>The set of <a class="reference internal" href="#pyxb.utils.fac.State" title="pyxb.utils.fac.State"><code class="xref py py-obj docutils literal"><span class="pre">State</span></code></a> members which can terminate a match.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.fac.Automaton._Automaton__get_initialTransitions">
<code class="descname">_Automaton__get_initialTransitions</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.Automaton._Automaton__get_initialTransitions" title="Permalink to this definition">¶</a></dt>
<dd><p>The set of transitions that may be made to enter the automaton.</p>
<p>These are full transitions, including chains into subautomata
if an initial state represents a node with sub-automata.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Note:</th><td class="field-body">As with <a class="reference internal" href="#pyxb.utils.fac.State.transitionSet" title="pyxb.utils.fac.State.transitionSet"><code class="xref py py-obj docutils literal"><span class="pre">State.transitionSet</span></code></a>, the set is represented</td>
</tr>
</tbody>
</table>
<p>as a list to preserve priority when resolving
non-deterministic matches.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.fac.Automaton._Automaton__get_nullable">
<code class="descname">_Automaton__get_nullable</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.Automaton._Automaton__get_nullable" title="Permalink to this definition">¶</a></dt>
<dd><p><code class="xref py py-obj docutils literal"><span class="pre">True</span></code> iff the automaton accepts the empty string.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.fac.Automaton._Automaton__get_states">
<code class="descname">_Automaton__get_states</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.Automaton._Automaton__get_states" title="Permalink to this definition">¶</a></dt>
<dd><p>The set of :py:obj:<a href="#id3"><span class="problematic" id="id4">`</span></a>State`s in the automaton.</p>
<p>These correspond essentially to marked symbols in the original
regular expression, or L{element
declarations<pyxb.xmlschema.structures.ElementDeclaration>} in
an XML schema.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Note:</th><td class="field-body">These are conceptually a set and are stored that way.</td>
</tr>
</tbody>
</table>
<p>When an <a class="reference internal" href="#pyxb.utils.fac.Automaton" title="pyxb.utils.fac.Automaton"><code class="xref py py-obj docutils literal"><span class="pre">Automaton</span></code></a> is constructed the incoming states should
be passed as a list so the calculated initial transitions are
executed in a deterministic order.</p>
</dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.fac.Automaton._Automaton__initialTransitions">
<code class="descname">_Automaton__initialTransitions</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.utils.fac.Automaton._Automaton__initialTransitions" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.fac.Automaton._Automaton__nullable">
<code class="descname">_Automaton__nullable</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.utils.fac.Automaton._Automaton__nullable" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.fac.Automaton._Automaton__states">
<code class="descname">_Automaton__states</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.utils.fac.Automaton._Automaton__states" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.fac.Automaton.containingState">
<code class="descname">containingState</code><a class="headerlink" href="#pyxb.utils.fac.Automaton.containingState" title="Permalink to this definition">¶</a></dt>
<dd><p>The <a class="reference internal" href="#pyxb.utils.fac.State" title="pyxb.utils.fac.State"><code class="xref py py-obj docutils literal"><span class="pre">State</span></code></a> instance for which this is a sub-automaton.</p>
<p><code class="xref py py-obj docutils literal"><span class="pre">None</span></code> if this is not a sub-automaton.</p>
</dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.fac.Automaton.counterConditions">
<code class="descname">counterConditions</code><a class="headerlink" href="#pyxb.utils.fac.Automaton.counterConditions" title="Permalink to this definition">¶</a></dt>
<dd><p>The set of :py:obj:<a href="#id5"><span class="problematic" id="id6">`</span></a>CounterCondition`s in the automaton.</p>
<p>These are marked positions in the regular expression, or
<a class="reference internal" href="pyxb.xmlschema.html#pyxb.xmlschema.structures.Particle" title="pyxb.xmlschema.structures.Particle"><code class="xref py py-obj docutils literal"><span class="pre">particles</span></code></a> in an XML
schema, paired with their occurrence constraints.</p>
</dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.fac.Automaton.finalStates">
<code class="descname">finalStates</code><a class="headerlink" href="#pyxb.utils.fac.Automaton.finalStates" title="Permalink to this definition">¶</a></dt>
<dd><p>The set of <a class="reference internal" href="#pyxb.utils.fac.State" title="pyxb.utils.fac.State"><code class="xref py py-obj docutils literal"><span class="pre">State</span></code></a> members which can terminate a match.</p>
</dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.fac.Automaton.initialTransitions">
<code class="descname">initialTransitions</code><a class="headerlink" href="#pyxb.utils.fac.Automaton.initialTransitions" title="Permalink to this definition">¶</a></dt>
<dd><p>The set of transitions that may be made to enter the automaton.</p>
<p>These are full transitions, including chains into subautomata
if an initial state represents a node with sub-automata.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Note:</th><td class="field-body">As with <a class="reference internal" href="#pyxb.utils.fac.State.transitionSet" title="pyxb.utils.fac.State.transitionSet"><code class="xref py py-obj docutils literal"><span class="pre">State.transitionSet</span></code></a>, the set is represented</td>
</tr>
</tbody>
</table>
<p>as a list to preserve priority when resolving
non-deterministic matches.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.fac.Automaton.newConfiguration">
<code class="descname">newConfiguration</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.Automaton.newConfiguration" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a new <a class="reference internal" href="#pyxb.utils.fac.Configuration" title="pyxb.utils.fac.Configuration"><code class="xref py py-obj docutils literal"><span class="pre">Configuration</span></code></a> instance for this automaton.</p>
</dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.fac.Automaton.nullable">
<code class="descname">nullable</code><a class="headerlink" href="#pyxb.utils.fac.Automaton.nullable" title="Permalink to this definition">¶</a></dt>
<dd><p><code class="xref py py-obj docutils literal"><span class="pre">True</span></code> iff the automaton accepts the empty string.</p>
</dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.fac.Automaton.states">
<code class="descname">states</code><a class="headerlink" href="#pyxb.utils.fac.Automaton.states" title="Permalink to this definition">¶</a></dt>
<dd><p>The set of :py:obj:<a href="#id7"><span class="problematic" id="id8">`</span></a>State`s in the automaton.</p>
<p>These correspond essentially to marked symbols in the original
regular expression, or L{element
declarations<pyxb.xmlschema.structures.ElementDeclaration>} in
an XML schema.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Note:</th><td class="field-body">These are conceptually a set and are stored that way.</td>
</tr>
</tbody>
</table>
<p>When an <a class="reference internal" href="#pyxb.utils.fac.Automaton" title="pyxb.utils.fac.Automaton"><code class="xref py py-obj docutils literal"><span class="pre">Automaton</span></code></a> is constructed the incoming states should
be passed as a list so the calculated initial transitions are
executed in a deterministic order.</p>
</dd></dl>
</dd></dl>
<dl class="exception">
<dt id="pyxb.utils.fac.AutomatonStepError">
<em class="property">exception </em><code class="descclassname">pyxb.utils.fac.</code><code class="descname">AutomatonStepError</code><span class="sig-paren">(</span><em>*args</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.AutomatonStepError" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">exceptions.Exception</span></code></p>
<p>Symbol rejected by <a class="reference internal" href="#pyxb.utils.fac.Configuration_ABC.step" title="pyxb.utils.fac.Configuration_ABC.step"><code class="xref py py-obj docutils literal"><span class="pre">Configuration_ABC.step</span></code></a>.</p>
<p>The exception indicates that the proposed symbol either failed to
produce a transition (<a class="reference internal" href="#pyxb.utils.fac.UnrecognizedSymbolError" title="pyxb.utils.fac.UnrecognizedSymbolError"><code class="xref py py-obj docutils literal"><span class="pre">UnrecognizedSymbolError</span></code></a>) or produced
multiple equally valid transitions
(<a class="reference internal" href="#pyxb.utils.fac.NondeterministicSymbolError" title="pyxb.utils.fac.NondeterministicSymbolError"><code class="xref py py-obj docutils literal"><span class="pre">NondeterministicSymbolError</span></code></a>).</p>
<dl class="method">
<dt id="pyxb.utils.fac.AutomatonStepError._AutomatonStepError__get_acceptable">
<code class="descname">_AutomatonStepError__get_acceptable</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.AutomatonStepError._AutomatonStepError__get_acceptable" title="Permalink to this definition">¶</a></dt>
<dd><p>A list of symbols that the configuration would accept in its current state.</p>
</dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.fac.AutomatonStepError.acceptable">
<code class="descname">acceptable</code><a class="headerlink" href="#pyxb.utils.fac.AutomatonStepError.acceptable" title="Permalink to this definition">¶</a></dt>
<dd><p>A list of symbols that the configuration would accept in its current state.</p>
</dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.fac.AutomatonStepError.configuration">
<code class="descname">configuration</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.utils.fac.AutomatonStepError.configuration" title="Permalink to this definition">¶</a></dt>
<dd><p>The instance of <a class="reference internal" href="#pyxb.utils.fac.Configuration_ABC" title="pyxb.utils.fac.Configuration_ABC"><code class="xref py py-obj docutils literal"><span class="pre">Configuration_ABC</span></code></a> that raised the exception.
From <a class="reference internal" href="#pyxb.utils.fac.Configuration_ABC.acceptableSymbols" title="pyxb.utils.fac.Configuration_ABC.acceptableSymbols"><code class="xref py py-obj docutils literal"><span class="pre">Configuration_ABC.acceptableSymbols</span></code></a> you can determine what
alternatives might be present.</p>
</dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.fac.AutomatonStepError.symbol">
<code class="descname">symbol</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.utils.fac.AutomatonStepError.symbol" title="Permalink to this definition">¶</a></dt>
<dd><p>The symbol that was not accepted.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="pyxb.utils.fac.Choice">
<em class="property">class </em><code class="descclassname">pyxb.utils.fac.</code><code class="descname">Choice</code><span class="sig-paren">(</span><em>*terms</em>, <em>**kw</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.Choice" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#pyxb.utils.fac.MultiTermNode" title="pyxb.utils.fac.MultiTermNode"><code class="xref py py-class docutils literal"><span class="pre">pyxb.utils.fac.MultiTermNode</span></code></a></p>
<p>A term that may be any one of a set of terms.</p>
<p>This term matches if any one of its contained terms matches.</p>
<dl class="attribute">
<dt id="pyxb.utils.fac.Choice._Precedence">
<code class="descname">_Precedence</code><em class="property"> = -3</em><a class="headerlink" href="#pyxb.utils.fac.Choice._Precedence" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.utils.fac.Choice._first">
<code class="descname">_first</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.Choice._first" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.utils.fac.Choice._follow">
<code class="descname">_follow</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.Choice._follow" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.utils.fac.Choice._last">
<code class="descname">_last</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.Choice._last" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.utils.fac.Choice._nullable">
<code class="descname">_nullable</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.Choice._nullable" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="pyxb.utils.fac.Configuration">
<em class="property">class </em><code class="descclassname">pyxb.utils.fac.</code><code class="descname">Configuration</code><span class="sig-paren">(</span><em>automaton</em>, <em>super_configuration=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.Configuration" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#pyxb.utils.fac.Configuration_ABC" title="pyxb.utils.fac.Configuration_ABC"><code class="xref py py-class docutils literal"><span class="pre">pyxb.utils.fac.Configuration_ABC</span></code></a></p>
<p>The state of an <a class="reference internal" href="#pyxb.utils.fac.Automaton" title="pyxb.utils.fac.Automaton"><code class="xref py py-obj docutils literal"><span class="pre">Automaton</span></code></a> in execution.</p>
<p>This combines a state node of the automaton with a set of counter
values.</p>
<dl class="attribute">
<dt id="pyxb.utils.fac.Configuration._Configuration__automaton">
<code class="descname">_Configuration__automaton</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.utils.fac.Configuration._Configuration__automaton" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.fac.Configuration._Configuration__counterValues">
<code class="descname">_Configuration__counterValues</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.utils.fac.Configuration._Configuration__counterValues" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.utils.fac.Configuration._Configuration__get_automaton">
<code class="descname">_Configuration__get_automaton</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.Configuration._Configuration__get_automaton" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.utils.fac.Configuration._Configuration__get_state">
<code class="descname">_Configuration__get_state</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.Configuration._Configuration__get_state" title="Permalink to this definition">¶</a></dt>
<dd><p>The state of the configuration.</p>
<p>This is <code class="xref py py-obj docutils literal"><span class="pre">None</span></code> to indicate an initial state, or one of the underlying automaton’s states.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.fac.Configuration._Configuration__get_subAutomata">
<code class="descname">_Configuration__get_subAutomata</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.Configuration._Configuration__get_subAutomata" title="Permalink to this definition">¶</a></dt>
<dd><p>A set of automata that must be satisfied before the current state can complete.</p>
<p>This is used in unordered catenation. Each sub-automaton
represents a term in the catenation. When the configuration
enters a state with sub-automata, a set containing references
to those automata is assigned to this attribute.
Subsequently, until all automata in the state are satisfied,
transitions can only occur within an active sub-automaton, out
of the active sub-automaton if it is in an accepting state,
and into a new sub-automaton if no sub-automaton is active.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.fac.Configuration._Configuration__get_subConfiguration">
<code class="descname">_Configuration__get_subConfiguration</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.Configuration._Configuration__get_subConfiguration" title="Permalink to this definition">¶</a></dt>
<dd><p>Reference to configuration being executed in a sub-automaton.</p>
<p><code class="xref py py-obj docutils literal"><span class="pre">None</span></code> if no sub-automaton is active, else a reference to a
configuration that is being executed in a sub-automaton.</p>
<p>Sub-configurations are used to match sub-terms in an
<a class="reference internal" href="#pyxb.utils.fac.All" title="pyxb.utils.fac.All"><code class="xref py py-obj docutils literal"><span class="pre">unordered</span> <span class="pre">catenation</span></code></a> term. A configuration may have
at most one sub-configuration at a time, and the configuration
will be removed and possibly replaced when the term being
processed completes.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.fac.Configuration._Configuration__get_superConfiguration">
<code class="descname">_Configuration__get_superConfiguration</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.Configuration._Configuration__get_superConfiguration" title="Permalink to this definition">¶</a></dt>
<dd><p>Reference to the configuration for which this is a
sub-configuration.</p>
<p><code class="xref py py-obj docutils literal"><span class="pre">None</span></code> if no super-automaton is active, else a reference to a
configuration that is being executed in a super-automaton.</p>
<p>The super-configuration relation persists for the lifetime of
the configuration.</p>
</dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.fac.Configuration._Configuration__state">
<code class="descname">_Configuration__state</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.utils.fac.Configuration._Configuration__state" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.fac.Configuration._Configuration__subAutomata">
<code class="descname">_Configuration__subAutomata</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.utils.fac.Configuration._Configuration__subAutomata" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.fac.Configuration._Configuration__subConfiguration">
<code class="descname">_Configuration__subConfiguration</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.utils.fac.Configuration._Configuration__subConfiguration" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.fac.Configuration._Configuration__superConfiguration">
<code class="descname">_Configuration__superConfiguration</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.utils.fac.Configuration._Configuration__superConfiguration" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.utils.fac.Configuration._clone">
<code class="descname">_clone</code><span class="sig-paren">(</span><em>clone_map</em>, <em>super_configuration</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.Configuration._clone" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.utils.fac.Configuration._get_counterValues">
<code class="descname">_get_counterValues</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.Configuration._get_counterValues" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.utils.fac.Configuration._set_state">
<code class="descname">_set_state</code><span class="sig-paren">(</span><em>state</em>, <em>is_layer_change</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.Configuration._set_state" title="Permalink to this definition">¶</a></dt>
<dd><p>Internal state transition interface.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>state</strong> – the new destination state</li>
<li><strong>is_layer_change</strong> – <code class="xref py py-obj docutils literal"><span class="pre">True</span></code> iff the transition inducing</li>
</ul>
</td>
</tr>
</tbody>
</table>
<p>the state change involves a layer change.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.fac.Configuration._set_subAutomata">
<code class="descname">_set_subAutomata</code><span class="sig-paren">(</span><em>automata</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.Configuration._set_subAutomata" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.utils.fac.Configuration.acceptableSymbols">
<code class="descname">acceptableSymbols</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.Configuration.acceptableSymbols" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.fac.Configuration.automaton">
<code class="descname">automaton</code><a class="headerlink" href="#pyxb.utils.fac.Configuration.automaton" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.utils.fac.Configuration.candidateTransitions">
<code class="descname">candidateTransitions</code><span class="sig-paren">(</span><em>symbol=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.Configuration.candidateTransitions" title="Permalink to this definition">¶</a></dt>
<dd><p>Return list of viable transitions on <code class="xref py py-obj docutils literal"><span class="pre">symbol</span></code></p>
<p>The transitions that are structurally permitted from this
state, in order, filtering out those transitions where the
update instruction is not satisfied by the configuration
counter values and optionally those for which the symbol does
not match.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>symbol</strong> – A symbol through which a transition from this</td>
</tr>
</tbody>
</table>
<p>state is intended. A value of <code class="xref py py-obj docutils literal"><span class="pre">None</span></code> indicates that the set
of transitions should ignore the symbol; candidates are still
filtered based on the counter state of the configuration.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">A list of <a class="reference internal" href="#pyxb.utils.fac.Transition" title="pyxb.utils.fac.Transition"><code class="xref py py-obj docutils literal"><span class="pre">Transition</span></code></a> instances permitted from the</td>
</tr>
</tbody>
</table>
<p>current configuration. If <code class="xref py py-obj docutils literal"><span class="pre">symbol</span></code> is not <code class="xref py py-obj docutils literal"><span class="pre">None</span></code>,
transitions that would not accept the symbol are excluded.
Any transition that would require an unsatisfied counter
update is also excluded. Non-deterministic automata may
result in a lits with multiple members.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.fac.Configuration.clone">
<code class="descname">clone</code><span class="sig-paren">(</span><em>clone_map=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.Configuration.clone" title="Permalink to this definition">¶</a></dt>
<dd><p>Clone a configuration and its descendents.</p>
<p>This is used for parallel execution where a configuration has
multiple candidate transitions and must follow all of them.
It clones the entire chain of configurations through
multiple layers.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>clone_map</strong> – Optional map into which the translation from</td>
</tr>
</tbody>
</table>
<p>the original configuration object to the corresponding cloned
configuration object can be reconstructed, e.g. when applying
a transition that includes automata exits referencing
superconfigurations from the original configuration.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.fac.Configuration.enterAutomaton">
<code class="descname">enterAutomaton</code><span class="sig-paren">(</span><em>automaton</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.Configuration.enterAutomaton" title="Permalink to this definition">¶</a></dt>
<dd><p>Execute steps to enter a new automaton.</p>
<p>The new automaton is removed from the set of remaining
automata for the current state, and a new configuration
created. No transition is made in that new configuration.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>automaton</strong> – The automaton to be entered</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The configuration that executes the new automaton as</td>
</tr>
</tbody>
</table>
<p>a sub-configuration of <code class="xref py py-obj docutils literal"><span class="pre">self</span></code>.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.fac.Configuration.isAccepting">
<code class="descname">isAccepting</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.Configuration.isAccepting" title="Permalink to this definition">¶</a></dt>
<dd><p>Return <code class="xref py py-obj docutils literal"><span class="pre">True</span></code> iff the automaton is in an accepting state.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.fac.Configuration.isInitial">
<code class="descname">isInitial</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.Configuration.isInitial" title="Permalink to this definition">¶</a></dt>
<dd><p>Return <code class="xref py py-obj docutils literal"><span class="pre">True</span></code> iff no transitions have ever been made.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.fac.Configuration.leaveAutomaton">
<code class="descname">leaveAutomaton</code><span class="sig-paren">(</span><em>sub_configuration</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.Configuration.leaveAutomaton" title="Permalink to this definition">¶</a></dt>
<dd><p>Execute steps to leave a sub-automaton.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>sub_configuration</strong> – The configuration associated with</td>
</tr>
</tbody>
</table>
<p>the automata that has completed.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><code class="xref py py-obj docutils literal"><span class="pre">self</span></code></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.fac.Configuration.makeLeaveAutomatonTransition">
<code class="descname">makeLeaveAutomatonTransition</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.Configuration.makeLeaveAutomatonTransition" title="Permalink to this definition">¶</a></dt>
<dd><p>Create a transition back to the containing configuration.</p>
<p>This is done when a configuration is in an accepting state and
there are candidate transitions to other states that must be
considered. The transition does not consume a symbol.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.fac.Configuration.reset">
<code class="descname">reset</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.Configuration.reset" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.utils.fac.Configuration.satisfies">
<code class="descname">satisfies</code><span class="sig-paren">(</span><em>transition</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.Configuration.satisfies" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.fac.Configuration.state">
<code class="descname">state</code><a class="headerlink" href="#pyxb.utils.fac.Configuration.state" title="Permalink to this definition">¶</a></dt>
<dd><p>The state of the configuration.</p>
<p>This is <code class="xref py py-obj docutils literal"><span class="pre">None</span></code> to indicate an initial state, or one of the underlying automaton’s states.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.fac.Configuration.step">
<code class="descname">step</code><span class="sig-paren">(</span><em>symbol</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.Configuration.step" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.fac.Configuration.subAutomata">
<code class="descname">subAutomata</code><a class="headerlink" href="#pyxb.utils.fac.Configuration.subAutomata" title="Permalink to this definition">¶</a></dt>
<dd><p>A set of automata that must be satisfied before the current state can complete.</p>
<p>This is used in unordered catenation. Each sub-automaton
represents a term in the catenation. When the configuration
enters a state with sub-automata, a set containing references
to those automata is assigned to this attribute.
Subsequently, until all automata in the state are satisfied,
transitions can only occur within an active sub-automaton, out
of the active sub-automaton if it is in an accepting state,
and into a new sub-automaton if no sub-automaton is active.</p>
</dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.fac.Configuration.subConfiguration">
<code class="descname">subConfiguration</code><a class="headerlink" href="#pyxb.utils.fac.Configuration.subConfiguration" title="Permalink to this definition">¶</a></dt>
<dd><p>Reference to configuration being executed in a sub-automaton.</p>
<p><code class="xref py py-obj docutils literal"><span class="pre">None</span></code> if no sub-automaton is active, else a reference to a
configuration that is being executed in a sub-automaton.</p>
<p>Sub-configurations are used to match sub-terms in an
<a class="reference internal" href="#pyxb.utils.fac.All" title="pyxb.utils.fac.All"><code class="xref py py-obj docutils literal"><span class="pre">unordered</span> <span class="pre">catenation</span></code></a> term. A configuration may have
at most one sub-configuration at a time, and the configuration
will be removed and possibly replaced when the term being
processed completes.</p>
</dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.fac.Configuration.superConfiguration">
<code class="descname">superConfiguration</code><a class="headerlink" href="#pyxb.utils.fac.Configuration.superConfiguration" title="Permalink to this definition">¶</a></dt>
<dd><p>Reference to the configuration for which this is a
sub-configuration.</p>
<p><code class="xref py py-obj docutils literal"><span class="pre">None</span></code> if no super-automaton is active, else a reference to a
configuration that is being executed in a super-automaton.</p>
<p>The super-configuration relation persists for the lifetime of
the configuration.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="pyxb.utils.fac.Configuration_ABC">
<em class="property">class </em><code class="descclassname">pyxb.utils.fac.</code><code class="descname">Configuration_ABC</code><a class="headerlink" href="#pyxb.utils.fac.Configuration_ABC" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
<p>Base class for something that represents an <a class="reference internal" href="#pyxb.utils.fac.Automaton" title="pyxb.utils.fac.Automaton"><code class="xref py py-obj docutils literal"><span class="pre">Automaton</span></code></a> in
execution.</p>
<p>For deterministic automata, this is generally a <a class="reference internal" href="#pyxb.utils.fac.Configuration" title="pyxb.utils.fac.Configuration"><code class="xref py py-obj docutils literal"><span class="pre">Configuration</span></code></a>
which records the current automaton state along with its counter
values.</p>
<p>For non-deterministic automata, this is a <a class="reference internal" href="#pyxb.utils.fac.MultiConfiguration" title="pyxb.utils.fac.MultiConfiguration"><code class="xref py py-obj docutils literal"><span class="pre">MultiConfiguration</span></code></a>
which records a set of :py:obj:<a href="#id9"><span class="problematic" id="id10">`</span></a>Configuration`s.</p>
<dl class="method">
<dt id="pyxb.utils.fac.Configuration_ABC.acceptableSymbols">
<code class="descname">acceptableSymbols</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.Configuration_ABC.acceptableSymbols" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the acceptable :py:obj:<a href="#id11"><span class="problematic" id="id12">`</span></a>Symbol`s given the current
configuration.</p>
<p>This method extracts the symbol from all candidate transitions
that are permitted based on the current counter values.
Because transitions are presented in a preferred order, the
symbols are as well.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.fac.Configuration_ABC.step">
<code class="descname">step</code><span class="sig-paren">(</span><em>symbol</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.Configuration_ABC.step" title="Permalink to this definition">¶</a></dt>
<dd><p>Execute an automaton transition using the given symbol.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>symbol</strong> – A symbol from the alphabet of the automaton’s</td>
</tr>
</tbody>
</table>
<p>language. This is a Python value that should be accepted by
the <a class="reference internal" href="#pyxb.utils.fac.SymbolMatch_mixin.match" title="pyxb.utils.fac.SymbolMatch_mixin.match"><code class="xref py py-obj docutils literal"><span class="pre">SymbolMatch_mixin.match</span></code></a> method of a <a class="reference internal" href="#pyxb.utils.fac.State.symbol" title="pyxb.utils.fac.State.symbol"><code class="xref py py-obj docutils literal"><span class="pre">State.symbol</span></code></a>.
It is not a <a class="reference internal" href="#pyxb.utils.fac.Symbol" title="pyxb.utils.fac.Symbol"><code class="xref py py-obj docutils literal"><span class="pre">Symbol</span></code></a> instance.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">The new configuration resulting from the step.</td>
</tr>
<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><a class="reference internal" href="#pyxb.utils.fac.AutomatonStepError" title="pyxb.utils.fac.AutomatonStepError"><strong>AutomatonStepError</strong></a> – <a class="reference internal" href="#pyxb.utils.fac.UnrecognizedSymbolError" title="pyxb.utils.fac.UnrecognizedSymbolError"><code class="xref py py-obj docutils literal"><span class="pre">UnrecognizedSymbolError</span></code></a></td>
</tr>
</tbody>
</table>
<p>when no transition compatible with <code class="xref py py-obj docutils literal"><span class="pre">symbol</span></code> is available, and
<a class="reference internal" href="#pyxb.utils.fac.NondeterministicSymbolError" title="pyxb.utils.fac.NondeterministicSymbolError"><code class="xref py py-obj docutils literal"><span class="pre">NondeterministicSymbolError</span></code></a> if <code class="xref py py-obj docutils literal"><span class="pre">symbol</span></code> admits multiple
transitions and the subclass does not support
non-deterministic steps (see <a class="reference internal" href="#pyxb.utils.fac.MultiConfiguration" title="pyxb.utils.fac.MultiConfiguration"><code class="xref py py-obj docutils literal"><span class="pre">MultiConfiguration</span></code></a>).</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Warning:</th><td class="field-body">If the step entered or left a sub-automaton the</td>
</tr>
</tbody>
</table>
<p>return value will not be the configuration that was used to
execute the step. The proper pattern for using this method
is:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">cfg</span> <span class="o">=</span> <span class="n">cfg</span><span class="o">.</span><span class="n">step</span><span class="p">(</span><span class="n">sym</span><span class="p">)</span>
</pre></div>
</div>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="pyxb.utils.fac.CounterCondition">
<em class="property">class </em><code class="descclassname">pyxb.utils.fac.</code><code class="descname">CounterCondition</code><span class="sig-paren">(</span><em>min</em>, <em>max</em>, <em>metadata=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.CounterCondition" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
<p>A counter condition is a range limit on valid counter values.</p>
<p>Instances of this class serve as keys for the counters that
represent the configuration of a FAC. The instance also maintains
a pointer to application-specific <a class="reference internal" href="#pyxb.utils.fac.CounterCondition.metadata" title="pyxb.utils.fac.CounterCondition.metadata"><code class="xref py py-obj docutils literal"><span class="pre">metadata</span></code></a>.</p>
<dl class="method">
<dt id="pyxb.utils.fac.CounterCondition._CounterCondition__get_max">
<code class="descname">_CounterCondition__get_max</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.CounterCondition._CounterCondition__get_max" title="Permalink to this definition">¶</a></dt>
<dd><p>The maximum legal value for the counter.</p>
<p>This is a positive integer, or <code class="xref py py-obj docutils literal"><span class="pre">None</span></code> to indicate that the
counter is unbounded.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.fac.CounterCondition._CounterCondition__get_metadata">
<code class="descname">_CounterCondition__get_metadata</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.CounterCondition._CounterCondition__get_metadata" title="Permalink to this definition">¶</a></dt>
<dd><p>A pointer to application metadata provided when the condition was created.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.fac.CounterCondition._CounterCondition__get_min">
<code class="descname">_CounterCondition__get_min</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.CounterCondition._CounterCondition__get_min" title="Permalink to this definition">¶</a></dt>
<dd><p>The minimum legal value for the counter.</p>
<p>This is a non-negative integer.</p>
</dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.fac.CounterCondition._CounterCondition__max">
<code class="descname">_CounterCondition__max</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.utils.fac.CounterCondition._CounterCondition__max" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.fac.CounterCondition._CounterCondition__metadata">
<code class="descname">_CounterCondition__metadata</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.utils.fac.CounterCondition._CounterCondition__metadata" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.fac.CounterCondition._CounterCondition__min">
<code class="descname">_CounterCondition__min</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.utils.fac.CounterCondition._CounterCondition__min" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.fac.CounterCondition.max">
<code class="descname">max</code><a class="headerlink" href="#pyxb.utils.fac.CounterCondition.max" title="Permalink to this definition">¶</a></dt>
<dd><p>The maximum legal value for the counter.</p>
<p>This is a positive integer, or <code class="xref py py-obj docutils literal"><span class="pre">None</span></code> to indicate that the
counter is unbounded.</p>
</dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.fac.CounterCondition.metadata">
<code class="descname">metadata</code><a class="headerlink" href="#pyxb.utils.fac.CounterCondition.metadata" title="Permalink to this definition">¶</a></dt>
<dd><p>A pointer to application metadata provided when the condition was created.</p>
</dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.fac.CounterCondition.min">
<code class="descname">min</code><a class="headerlink" href="#pyxb.utils.fac.CounterCondition.min" title="Permalink to this definition">¶</a></dt>
<dd><p>The minimum legal value for the counter.</p>
<p>This is a non-negative integer.</p>
</dd></dl>
</dd></dl>
<dl class="exception">
<dt id="pyxb.utils.fac.FACError">
<em class="property">exception </em><code class="descclassname">pyxb.utils.fac.</code><code class="descname">FACError</code><a class="headerlink" href="#pyxb.utils.fac.FACError" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">exceptions.Exception</span></code></p>
</dd></dl>
<dl class="exception">
<dt id="pyxb.utils.fac.InvalidTermTreeError">
<em class="property">exception </em><code class="descclassname">pyxb.utils.fac.</code><code class="descname">InvalidTermTreeError</code><span class="sig-paren">(</span><em>*args</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.InvalidTermTreeError" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#pyxb.utils.fac.FACError" title="pyxb.utils.fac.FACError"><code class="xref py py-class docutils literal"><span class="pre">pyxb.utils.fac.FACError</span></code></a></p>
<p>Exception raised when a FAC term tree is not a tree.</p>
<p>For example, a <a class="reference internal" href="#pyxb.utils.fac.Symbol" title="pyxb.utils.fac.Symbol"><code class="xref py py-obj docutils literal"><span class="pre">Symbol</span></code></a> node appears multiple times, or a cycle is detected.</p>
<dl class="attribute">
<dt id="pyxb.utils.fac.InvalidTermTreeError.parent">
<code class="descname">parent</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.utils.fac.InvalidTermTreeError.parent" title="Permalink to this definition">¶</a></dt>
<dd><p>The <a class="reference internal" href="#pyxb.utils.fac.MultiTermNode" title="pyxb.utils.fac.MultiTermNode"><code class="xref py py-obj docutils literal"><span class="pre">MultiTermNode</span></code></a> containing the term that proves invalidity</p>
</dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.fac.InvalidTermTreeError.term">
<code class="descname">term</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.utils.fac.InvalidTermTreeError.term" title="Permalink to this definition">¶</a></dt>
<dd><p>The <a class="reference internal" href="#pyxb.utils.fac.Node" title="pyxb.utils.fac.Node"><code class="xref py py-obj docutils literal"><span class="pre">Node</span></code></a> that proves invalidity</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="pyxb.utils.fac.LeafNode">
<em class="property">class </em><code class="descclassname">pyxb.utils.fac.</code><code class="descname">LeafNode</code><span class="sig-paren">(</span><em>**kw</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.LeafNode" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#pyxb.utils.fac.Node" title="pyxb.utils.fac.Node"><code class="xref py py-class docutils literal"><span class="pre">pyxb.utils.fac.Node</span></code></a></p>
<p>Intermediary for nodes that have no child nodes.</p>
<dl class="method">
<dt id="pyxb.utils.fac.LeafNode._first">
<code class="descname">_first</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.LeafNode._first" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.utils.fac.LeafNode._follow">
<code class="descname">_follow</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.LeafNode._follow" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.utils.fac.LeafNode._last">
<code class="descname">_last</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.LeafNode._last" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.utils.fac.LeafNode._nullable">
<code class="descname">_nullable</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.LeafNode._nullable" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.utils.fac.LeafNode._walkTermTree">
<code class="descname">_walkTermTree</code><span class="sig-paren">(</span><em>position</em>, <em>pre</em>, <em>post</em>, <em>arg</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.LeafNode._walkTermTree" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="pyxb.utils.fac.MultiConfiguration">
<em class="property">class </em><code class="descclassname">pyxb.utils.fac.</code><code class="descname">MultiConfiguration</code><span class="sig-paren">(</span><em>configuration</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.MultiConfiguration" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#pyxb.utils.fac.Configuration_ABC" title="pyxb.utils.fac.Configuration_ABC"><code class="xref py py-class docutils literal"><span class="pre">pyxb.utils.fac.Configuration_ABC</span></code></a></p>
<p>Support parallel execution of state machine.</p>
<p>This holds a set of configurations, and executes each transition
on each one. Configurations which fail to accept a step are
silently dropped; only if this results in no remaining
configurations will <a class="reference internal" href="#pyxb.utils.fac.UnrecognizedSymbolError" title="pyxb.utils.fac.UnrecognizedSymbolError"><code class="xref py py-obj docutils literal"><span class="pre">UnrecognizedSymbolError</span></code></a> be raised. If a
step admits multiple valid transitions, a configuration is added
for each one.</p>
<p>See <a class="reference internal" href="pyxb.binding.html#pyxb.binding.content.AutomatonConfiguration" title="pyxb.binding.content.AutomatonConfiguration"><code class="xref py py-obj docutils literal"><span class="pre">pyxb.binding.content.AutomatonConfiguration</span></code></a> for an
alternative solution which holds actions associated with the
transition until the non-determinism is resolved.</p>
<dl class="attribute">
<dt id="pyxb.utils.fac.MultiConfiguration._MultiConfiguration__configurations">
<code class="descname">_MultiConfiguration__configurations</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.utils.fac.MultiConfiguration._MultiConfiguration__configurations" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.utils.fac.MultiConfiguration.acceptableSymbols">
<code class="descname">acceptableSymbols</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.MultiConfiguration.acceptableSymbols" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.utils.fac.MultiConfiguration.acceptingConfigurations">
<code class="descname">acceptingConfigurations</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.MultiConfiguration.acceptingConfigurations" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the set of configurations that are in an accepting state.</p>
<p>Note that some of the configurations may be within a
sub-automaton; their presence in the return value is because
the root configuration is also accepting.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.fac.MultiConfiguration.step">
<code class="descname">step</code><span class="sig-paren">(</span><em>symbol</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.MultiConfiguration.step" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="pyxb.utils.fac.MultiTermNode">
<em class="property">class </em><code class="descclassname">pyxb.utils.fac.</code><code class="descname">MultiTermNode</code><span class="sig-paren">(</span><em>*terms</em>, <em>**kw</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.MultiTermNode" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#pyxb.utils.fac.Node" title="pyxb.utils.fac.Node"><code class="xref py py-class docutils literal"><span class="pre">pyxb.utils.fac.Node</span></code></a></p>
<p>Intermediary for nodes that have multiple child nodes.</p>
<dl class="method">
<dt id="pyxb.utils.fac.MultiTermNode._MultiTermNode__get_terms">
<code class="descname">_MultiTermNode__get_terms</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.MultiTermNode._MultiTermNode__get_terms" title="Permalink to this definition">¶</a></dt>
<dd><p>The set of subordinate terms of the current node.</p>
</dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.fac.MultiTermNode._MultiTermNode__terms">
<code class="descname">_MultiTermNode__terms</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.utils.fac.MultiTermNode._MultiTermNode__terms" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.utils.fac.MultiTermNode._walkTermTree">
<code class="descname">_walkTermTree</code><span class="sig-paren">(</span><em>position</em>, <em>pre</em>, <em>post</em>, <em>arg</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.MultiTermNode._walkTermTree" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.utils.fac.MultiTermNode.clone">
<code class="descname">clone</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.MultiTermNode.clone" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.fac.MultiTermNode.terms">
<code class="descname">terms</code><a class="headerlink" href="#pyxb.utils.fac.MultiTermNode.terms" title="Permalink to this definition">¶</a></dt>
<dd><p>The set of subordinate terms of the current node.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="pyxb.utils.fac.Node">
<em class="property">class </em><code class="descclassname">pyxb.utils.fac.</code><code class="descname">Node</code><span class="sig-paren">(</span><em>**kw</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.Node" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
<p>Abstract class for any node in the term tree.</p>
<p>In its original form a B{position} (<code class="xref py py-obj docutils literal"><span class="pre">pos</span></code>) is a tuple of
non-negative integers comprising a path from a node in the term
tree. It identifies a node in the tree. After the FAC has been
constructed, only positions that are leaf nodes in the term tree
remain, and the corresponding symbol value (Python instance) is
used as the position.</p>
<p>An B{update instruction} (<code class="xref py py-obj docutils literal"><span class="pre">psi</span></code>) is a map from positions to
either <a class="reference internal" href="#pyxb.utils.fac.Node.RESET" title="pyxb.utils.fac.Node.RESET"><code class="xref py py-obj docutils literal"><span class="pre">Node.RESET</span></code></a> or <a class="reference internal" href="#pyxb.utils.fac.Node.INCREMENT" title="pyxb.utils.fac.Node.INCREMENT"><code class="xref py py-obj docutils literal"><span class="pre">Node.INCREMENT</span></code></a>. It identifies actions
to be taken on the counter states corresponding to the positions
in its domain.</p>
<p>A B{transition} is a pair containing a position and an update
instruction. It identifies a potential next node in the state and
the updates that are to be performed if the transition is taken.</p>
<p>A B{follow value} is a map from a position to a set of transitions
that may originate from the pos. This set is represented as a
Python list since update instructions are dicts and cannot be
hashed.</p>
<dl class="attribute">
<dt id="pyxb.utils.fac.Node.INCREMENT">
<code class="descname">INCREMENT</code><em class="property"> = True</em><a class="headerlink" href="#pyxb.utils.fac.Node.INCREMENT" title="Permalink to this definition">¶</a></dt>
<dd><p>An arbitrary value representing increment of a counter.</p>
</dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.fac.Node.RESET">
<code class="descname">RESET</code><em class="property"> = False</em><a class="headerlink" href="#pyxb.utils.fac.Node.RESET" title="Permalink to this definition">¶</a></dt>
<dd><p>An arbitrary value representing reset of a counter.</p>
</dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.fac.Node._Node__counterPositions">
<code class="descname">_Node__counterPositions</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.utils.fac.Node._Node__counterPositions" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.fac.Node._Node__first">
<code class="descname">_Node__first</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.utils.fac.Node._Node__first" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.fac.Node._Node__follow">
<code class="descname">_Node__follow</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.utils.fac.Node._Node__follow" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.utils.fac.Node._Node__get_counterPositions">
<code class="descname">_Node__get_counterPositions</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.Node._Node__get_counterPositions" title="Permalink to this definition">¶</a></dt>
<dd><p>Implement definition 13.1 from B{HOV09}.</p>
<p>The return value is the set of all positions leading to
<a class="reference internal" href="#pyxb.utils.fac.NumericalConstraint" title="pyxb.utils.fac.NumericalConstraint"><code class="xref py py-obj docutils literal"><span class="pre">NumericalConstraint</span></code></a> nodes for which either the minimum
value is not 1 or the maximum value is not unbounded.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.fac.Node._Node__get_first">
<code class="descname">_Node__get_first</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.Node._Node__get_first" title="Permalink to this definition">¶</a></dt>
<dd><p>The I{first} set for the node.</p>
<p>This is the set of positions leading to symbols that can
appear first in a string matched by an execution starting at
the node.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.fac.Node._Node__get_follow">
<code class="descname">_Node__get_follow</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.Node._Node__get_follow" title="Permalink to this definition">¶</a></dt>
<dd><p>The I{follow} map for the node.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.fac.Node._Node__get_last">
<code class="descname">_Node__get_last</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.Node._Node__get_last" title="Permalink to this definition">¶</a></dt>
<dd><p>The I{last} set for the node.</p>
<p>This is the set of positions leading to symbols that can
appear last in a string matched by an execution starting at
the node.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.fac.Node._Node__get_metadata">
<code class="descname">_Node__get_metadata</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.Node._Node__get_metadata" title="Permalink to this definition">¶</a></dt>
<dd><p>Application-specific metadata provided during construction.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.fac.Node._Node__get_nodePosMap">
<code class="descname">_Node__get_nodePosMap</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.Node._Node__get_nodePosMap" title="Permalink to this definition">¶</a></dt>
<dd><p>A map from nodes to their position in the term tree.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.fac.Node._Node__get_nullable">
<code class="descname">_Node__get_nullable</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.Node._Node__get_nullable" title="Permalink to this definition">¶</a></dt>
<dd><p><code class="xref py py-obj docutils literal"><span class="pre">True</span></code> iff the empty string is accepted by this node.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.fac.Node._Node__get_posNodeMap">
<code class="descname">_Node__get_posNodeMap</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.Node._Node__get_posNodeMap" title="Permalink to this definition">¶</a></dt>
<dd><p>A map from positions to nodes in the term tree.</p>
</dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.fac.Node._Node__last">
<code class="descname">_Node__last</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.utils.fac.Node._Node__last" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.fac.Node._Node__metadata">
<code class="descname">_Node__metadata</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.utils.fac.Node._Node__metadata" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.fac.Node._Node__nodePosMap">
<code class="descname">_Node__nodePosMap</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.utils.fac.Node._Node__nodePosMap" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.fac.Node._Node__nullable">
<code class="descname">_Node__nullable</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.utils.fac.Node._Node__nullable" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.fac.Node._Node__posNodeMap">
<code class="descname">_Node__posNodeMap</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.utils.fac.Node._Node__posNodeMap" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.utils.fac.Node._Node__resetAndValidate">
<code class="descname">_Node__resetAndValidate</code><span class="sig-paren">(</span><em>node</em>, <em>pos</em>, <em>visited_nodes</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.Node._Node__resetAndValidate" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="classmethod">
<dt id="pyxb.utils.fac.Node._PosConcatPosSet">
<em class="property">classmethod </em><code class="descname">_PosConcatPosSet</code><span class="sig-paren">(</span><em>pos</em>, <em>pos_set</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.Node._PosConcatPosSet" title="Permalink to this definition">¶</a></dt>
<dd><p>Implement definition 11.1 in B{HOV09}.</p>
</dd></dl>
<dl class="classmethod">
<dt id="pyxb.utils.fac.Node._PosConcatTransitionSet">
<em class="property">classmethod </em><code class="descname">_PosConcatTransitionSet</code><span class="sig-paren">(</span><em>pos</em>, <em>transition_set</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.Node._PosConcatTransitionSet" title="Permalink to this definition">¶</a></dt>
<dd><p>Implement definition 11.3 in B{HOV09}</p>
</dd></dl>
<dl class="classmethod">
<dt id="pyxb.utils.fac.Node._PosConcatUpdateInstruction">
<em class="property">classmethod </em><code class="descname">_PosConcatUpdateInstruction</code><span class="sig-paren">(</span><em>pos</em>, <em>psi</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.Node._PosConcatUpdateInstruction" title="Permalink to this definition">¶</a></dt>
<dd><p>Implement definition 11.2 in B{HOV09}</p>
</dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.fac.Node._Precedence">
<code class="descname">_Precedence</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.utils.fac.Node._Precedence" title="Permalink to this definition">¶</a></dt>
<dd><p>An integral value used for parenthesizing expressions.</p>
<p>A subterm that has a precedence less than that of its containing
term must be enclosed in parentheses when forming a text
expression representing the containing term.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.fac.Node._facToString">
<code class="descname">_facToString</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.Node._facToString" title="Permalink to this definition">¶</a></dt>
<dd><p>Obtain a description of the FAC in text format.</p>
<p>This is a diagnostic tool, returning first, last, and follow
maps using positions.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.fac.Node._first">
<code class="descname">_first</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.Node._first" title="Permalink to this definition">¶</a></dt>
<dd><p>Abstract method that defines <a class="reference internal" href="#pyxb.utils.fac.Node.first" title="pyxb.utils.fac.Node.first"><code class="xref py py-obj docutils literal"><span class="pre">first</span></code></a> for the subclass.</p>
<p>The return value should be an iterable of tuples of integers
denoting paths from this node through the term tree to a
symbol.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.fac.Node._follow">
<code class="descname">_follow</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.Node._follow" title="Permalink to this definition">¶</a></dt>
<dd><p>Abstract method that defines <a class="reference internal" href="#pyxb.utils.fac.Node.follow" title="pyxb.utils.fac.Node.follow"><code class="xref py py-obj docutils literal"><span class="pre">follow</span></code></a> for the subclass.</p>
<p>The return value should be a map from tuples of integers (positions)
to a list of transitions, where a transition is a position and
an update instruction.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.fac.Node._last">
<code class="descname">_last</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.Node._last" title="Permalink to this definition">¶</a></dt>
<dd><p>Abstract method that defines <a class="reference internal" href="#pyxb.utils.fac.Node.last" title="pyxb.utils.fac.Node.last"><code class="xref py py-obj docutils literal"><span class="pre">last</span></code></a> for the subclass.</p>
<p>The return value should be an iterable of tuples of integers
denoting paths from this node through the term tree to a
symbol.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.fac.Node._nullable">
<code class="descname">_nullable</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.Node._nullable" title="Permalink to this definition">¶</a></dt>
<dd><p>Abstract method that defines <a class="reference internal" href="#pyxb.utils.fac.Node.nullable" title="pyxb.utils.fac.Node.nullable"><code class="xref py py-obj docutils literal"><span class="pre">nullable</span></code></a> for the subclass.</p>
<p>The return value should be <code class="xref py py-obj docutils literal"><span class="pre">True</span></code> or <code class="xref py py-obj docutils literal"><span class="pre">False</span></code>.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.fac.Node._walkTermTree">
<code class="descname">_walkTermTree</code><span class="sig-paren">(</span><em>position</em>, <em>pre</em>, <em>post</em>, <em>arg</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.Node._walkTermTree" title="Permalink to this definition">¶</a></dt>
<dd><p>Abstract method implementing <a class="reference internal" href="#pyxb.utils.fac.Node.walkTermTree" title="pyxb.utils.fac.Node.walkTermTree"><code class="xref py py-obj docutils literal"><span class="pre">walkTermTree</span></code></a> for the subclass.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.fac.Node.buildAutomaton">
<code class="descname">buildAutomaton</code><span class="sig-paren">(</span><em>state_ctor=<class 'pyxb.utils.fac.State'></em>, <em>ctr_cond_ctor=<class 'pyxb.utils.fac.CounterCondition'></em>, <em>containing_state=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.Node.buildAutomaton" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.utils.fac.Node.clone">
<code class="descname">clone</code><span class="sig-paren">(</span><em>*args</em>, <em>**kw</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.Node.clone" title="Permalink to this definition">¶</a></dt>
<dd><p>Create a deep copy of the node.</p>
<p>All term-tree–related attributes and properties are replaced
with deep clones. Other attributes are preserved.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>args</strong> – A tuple of arguments to be passed to the instance</td>
</tr>
</tbody>
</table>
<p>constructor.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>kw</strong> – A dict of keywords to be passed to the instance</td>
</tr>
</tbody>
</table>
<p>constructor.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Note:</th><td class="field-body">Subclasses should pre-extend this method to augment the</td>
</tr>
</tbody>
</table>
<p><code class="xref py py-obj docutils literal"><span class="pre">args</span></code> and <code class="xref py py-obj docutils literal"><span class="pre">kw</span></code> parameters as necessary to match the
expectations of the <code class="xref py py-obj docutils literal"><span class="pre">__init__</span></code> method of the class being
cloned.</p>
</dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.fac.Node.counterPositions">
<code class="descname">counterPositions</code><a class="headerlink" href="#pyxb.utils.fac.Node.counterPositions" title="Permalink to this definition">¶</a></dt>
<dd><p>Implement definition 13.1 from B{HOV09}.</p>
<p>The return value is the set of all positions leading to
<a class="reference internal" href="#pyxb.utils.fac.NumericalConstraint" title="pyxb.utils.fac.NumericalConstraint"><code class="xref py py-obj docutils literal"><span class="pre">NumericalConstraint</span></code></a> nodes for which either the minimum
value is not 1 or the maximum value is not unbounded.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.fac.Node.counterSubPositions">
<code class="descname">counterSubPositions</code><span class="sig-paren">(</span><em>pos</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.Node.counterSubPositions" title="Permalink to this definition">¶</a></dt>
<dd><p>Implement definition 13.2 from B{HOV09}.</p>
<p>This is the subset of <a class="reference internal" href="#pyxb.utils.fac.Node.counterPositions" title="pyxb.utils.fac.Node.counterPositions"><code class="xref py py-obj docutils literal"><span class="pre">counterPositions</span></code></a> that occur along the
path to <code class="xref py py-obj docutils literal"><span class="pre">pos</span></code>.</p>
</dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.fac.Node.first">
<code class="descname">first</code><a class="headerlink" href="#pyxb.utils.fac.Node.first" title="Permalink to this definition">¶</a></dt>
<dd><p>The I{first} set for the node.</p>
<p>This is the set of positions leading to symbols that can
appear first in a string matched by an execution starting at
the node.</p>
</dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.fac.Node.follow">
<code class="descname">follow</code><a class="headerlink" href="#pyxb.utils.fac.Node.follow" title="Permalink to this definition">¶</a></dt>
<dd><p>The I{follow} map for the node.</p>
</dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.fac.Node.last">
<code class="descname">last</code><a class="headerlink" href="#pyxb.utils.fac.Node.last" title="Permalink to this definition">¶</a></dt>
<dd><p>The I{last} set for the node.</p>
<p>This is the set of positions leading to symbols that can
appear last in a string matched by an execution starting at
the node.</p>
</dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.fac.Node.metadata">
<code class="descname">metadata</code><a class="headerlink" href="#pyxb.utils.fac.Node.metadata" title="Permalink to this definition">¶</a></dt>
<dd><p>Application-specific metadata provided during construction.</p>
</dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.fac.Node.nodePosMap">
<code class="descname">nodePosMap</code><a class="headerlink" href="#pyxb.utils.fac.Node.nodePosMap" title="Permalink to this definition">¶</a></dt>
<dd><p>A map from nodes to their position in the term tree.</p>
</dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.fac.Node.nullable">
<code class="descname">nullable</code><a class="headerlink" href="#pyxb.utils.fac.Node.nullable" title="Permalink to this definition">¶</a></dt>
<dd><p><code class="xref py py-obj docutils literal"><span class="pre">True</span></code> iff the empty string is accepted by this node.</p>
</dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.fac.Node.posNodeMap">
<code class="descname">posNodeMap</code><a class="headerlink" href="#pyxb.utils.fac.Node.posNodeMap" title="Permalink to this definition">¶</a></dt>
<dd><p>A map from positions to nodes in the term tree.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.fac.Node.reset">
<code class="descname">reset</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.Node.reset" title="Permalink to this definition">¶</a></dt>
<dd><p>Reset any term-tree state associated with the node.</p>
<p>Any change to the structure of the term tree in which the node
appears invalidates memoized first/follow sets and related
information. This method clears all that data so it can be
recalculated. It does not clear the <a class="reference internal" href="#pyxb.utils.fac.Node.metadata" title="pyxb.utils.fac.Node.metadata"><code class="xref py py-obj docutils literal"><span class="pre">metadata</span></code></a> link, or any
existing structural data.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.fac.Node.walkTermTree">
<code class="descname">walkTermTree</code><span class="sig-paren">(</span><em>pre</em>, <em>post</em>, <em>arg</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.Node.walkTermTree" title="Permalink to this definition">¶</a></dt>
<dd><p>Utility function for term tree processing.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>pre</strong> – a callable that, unless <code class="xref py py-obj docutils literal"><span class="pre">None</span></code>, is invoked at</td>
</tr>
</tbody>
</table>
<p>each node <code class="xref py py-obj docutils literal"><span class="pre">n</span></code> with parameters <code class="xref py py-obj docutils literal"><span class="pre">n</span></code>, <code class="xref py py-obj docutils literal"><span class="pre">pos</span></code>, and <code class="xref py py-obj docutils literal"><span class="pre">arg</span></code>, where
<code class="xref py py-obj docutils literal"><span class="pre">pos</span></code> is the tuple of integers identifying the path from the
node at on which this method was invoked to the node being
processed. The invocation occurs before processing any
subordinate nodes.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>post</strong> – as with <code class="xref py py-obj docutils literal"><span class="pre">pre</span></code> but invocation occurs after</td>
</tr>
</tbody>
</table>
<p>processing any subordinate nodes.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>arg</strong> – a value passed to invocations of <code class="xref py py-obj docutils literal"><span class="pre">pre</span></code> and</td>
</tr>
</tbody>
</table>
<p><code class="xref py py-obj docutils literal"><span class="pre">post</span></code>.</p>
</dd></dl>
</dd></dl>
<dl class="exception">
<dt id="pyxb.utils.fac.NondeterministicSymbolError">
<em class="property">exception </em><code class="descclassname">pyxb.utils.fac.</code><code class="descname">NondeterministicSymbolError</code><span class="sig-paren">(</span><em>*args</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.NondeterministicSymbolError" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#pyxb.utils.fac.AutomatonStepError" title="pyxb.utils.fac.AutomatonStepError"><code class="xref py py-class docutils literal"><span class="pre">pyxb.utils.fac.AutomatonStepError</span></code></a></p>
<p><a class="reference internal" href="#pyxb.utils.fac.Configuration.step" title="pyxb.utils.fac.Configuration.step"><code class="xref py py-obj docutils literal"><span class="pre">Configuration.step</span></code></a> found multiple transitions.</p>
</dd></dl>
<dl class="class">
<dt id="pyxb.utils.fac.NumericalConstraint">
<em class="property">class </em><code class="descclassname">pyxb.utils.fac.</code><code class="descname">NumericalConstraint</code><span class="sig-paren">(</span><em>term</em>, <em>min=0</em>, <em>max=1</em>, <em>**kw</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.NumericalConstraint" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#pyxb.utils.fac.Node" title="pyxb.utils.fac.Node"><code class="xref py py-class docutils literal"><span class="pre">pyxb.utils.fac.Node</span></code></a></p>
<p>A term with a numeric range constraint.</p>
<p>This corresponds to a “particle” in the XML Schema content model.</p>
<dl class="method">
<dt id="pyxb.utils.fac.NumericalConstraint._NumericalConstraint__get_max">
<code class="descname">_NumericalConstraint__get_max</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.NumericalConstraint._NumericalConstraint__get_max" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.utils.fac.NumericalConstraint._NumericalConstraint__get_min">
<code class="descname">_NumericalConstraint__get_min</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.NumericalConstraint._NumericalConstraint__get_min" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.utils.fac.NumericalConstraint._NumericalConstraint__get_term">
<code class="descname">_NumericalConstraint__get_term</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.NumericalConstraint._NumericalConstraint__get_term" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.fac.NumericalConstraint._NumericalConstraint__max">
<code class="descname">_NumericalConstraint__max</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.utils.fac.NumericalConstraint._NumericalConstraint__max" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.fac.NumericalConstraint._NumericalConstraint__min">
<code class="descname">_NumericalConstraint__min</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.utils.fac.NumericalConstraint._NumericalConstraint__min" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.fac.NumericalConstraint._NumericalConstraint__term">
<code class="descname">_NumericalConstraint__term</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.utils.fac.NumericalConstraint._NumericalConstraint__term" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.fac.NumericalConstraint._Precedence">
<code class="descname">_Precedence</code><em class="property"> = -1</em><a class="headerlink" href="#pyxb.utils.fac.NumericalConstraint._Precedence" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.utils.fac.NumericalConstraint._first">
<code class="descname">_first</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.NumericalConstraint._first" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.utils.fac.NumericalConstraint._follow">
<code class="descname">_follow</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.NumericalConstraint._follow" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.utils.fac.NumericalConstraint._last">
<code class="descname">_last</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.NumericalConstraint._last" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.utils.fac.NumericalConstraint._nullable">
<code class="descname">_nullable</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.NumericalConstraint._nullable" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.utils.fac.NumericalConstraint._walkTermTree">
<code class="descname">_walkTermTree</code><span class="sig-paren">(</span><em>position</em>, <em>pre</em>, <em>post</em>, <em>arg</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.NumericalConstraint._walkTermTree" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.utils.fac.NumericalConstraint.clone">
<code class="descname">clone</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.NumericalConstraint.clone" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.fac.NumericalConstraint.max">
<code class="descname">max</code><a class="headerlink" href="#pyxb.utils.fac.NumericalConstraint.max" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.fac.NumericalConstraint.min">
<code class="descname">min</code><a class="headerlink" href="#pyxb.utils.fac.NumericalConstraint.min" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.fac.NumericalConstraint.term">
<code class="descname">term</code><a class="headerlink" href="#pyxb.utils.fac.NumericalConstraint.term" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="pyxb.utils.fac.Sequence">
<em class="property">class </em><code class="descclassname">pyxb.utils.fac.</code><code class="descname">Sequence</code><span class="sig-paren">(</span><em>*terms</em>, <em>**kw</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.Sequence" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#pyxb.utils.fac.MultiTermNode" title="pyxb.utils.fac.MultiTermNode"><code class="xref py py-class docutils literal"><span class="pre">pyxb.utils.fac.MultiTermNode</span></code></a></p>
<p>A term that is an ordered sequence of terms.</p>
<dl class="attribute">
<dt id="pyxb.utils.fac.Sequence._Precedence">
<code class="descname">_Precedence</code><em class="property"> = -2</em><a class="headerlink" href="#pyxb.utils.fac.Sequence._Precedence" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.utils.fac.Sequence._first">
<code class="descname">_first</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.Sequence._first" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.utils.fac.Sequence._follow">
<code class="descname">_follow</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.Sequence._follow" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.utils.fac.Sequence._last">
<code class="descname">_last</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.Sequence._last" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.utils.fac.Sequence._nullable">
<code class="descname">_nullable</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.Sequence._nullable" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="pyxb.utils.fac.State">
<em class="property">class </em><code class="descclassname">pyxb.utils.fac.</code><code class="descname">State</code><span class="sig-paren">(</span><em>symbol</em>, <em>is_initial</em>, <em>final_update=None</em>, <em>is_unordered_catenation=False</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.State" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
<p>A thin wrapper around an object reference.</p>
<p>The state of the automaton corresponds to a position, or marked
symbol, in the term tree. Because the same symbol may appear at
multiple locations in the tree, and the distinction between these
positions is critical, a <a class="reference internal" href="#pyxb.utils.fac.State" title="pyxb.utils.fac.State"><code class="xref py py-obj docutils literal"><span class="pre">State</span></code></a> wrapper is provided to maintain
distinct values.</p>
<dl class="attribute">
<dt id="pyxb.utils.fac.State._State__automaton">
<code class="descname">_State__automaton</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.utils.fac.State._State__automaton" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.fac.State._State__automatonEntryTransitions">
<code class="descname">_State__automatonEntryTransitions</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.utils.fac.State._State__automatonEntryTransitions" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.fac.State._State__finalUpdate">
<code class="descname">_State__finalUpdate</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.utils.fac.State._State__finalUpdate" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.utils.fac.State._State__get_automaton">
<code class="descname">_State__get_automaton</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.State._State__get_automaton" title="Permalink to this definition">¶</a></dt>
<dd><p>Link to the <a class="reference internal" href="#pyxb.utils.fac.Automaton" title="pyxb.utils.fac.Automaton"><code class="xref py py-obj docutils literal"><span class="pre">Automaton</span></code></a> to which the state belongs.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.fac.State._State__get_automatonEntryTransitions">
<code class="descname">_State__get_automatonEntryTransitions</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.State._State__get_automatonEntryTransitions" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the set of initial transitions allowing entry to the automata through this state.</p>
<p>These are structurally-permitted transitions only, and must be
filtered based on the symbol that might trigger the
transition. The results are not filtered based on counter
value, since this value is used to determine how the
containing automaton might be entered. Consequently the
return value is the empty set unless this is an initial state.</p>
<p>The returned set is closed under entry to sub-automata,
i.e. it is guaranteed that each transition includes a
consuming state even if it requires a multi-element chain of
transitions into subautomata to reach one.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.fac.State._State__get_finalUpdate">
<code class="descname">_State__get_finalUpdate</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.State._State__get_finalUpdate" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the update instructions that must be satisfied for this to be a final state.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.fac.State._State__get_isInitial">
<code class="descname">_State__get_isInitial</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.State._State__get_isInitial" title="Permalink to this definition">¶</a></dt>
<dd><p><code class="xref py py-obj docutils literal"><span class="pre">True</span></code> iff this state may be the first state the automaton enters.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.fac.State._State__get_isUnorderedCatenation">
<code class="descname">_State__get_isUnorderedCatenation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.State._State__get_isUnorderedCatenation" title="Permalink to this definition">¶</a></dt>
<dd><p>Indicate whether the state has subautomata for unordered
catenation.</p>
<p>To reduce state explosion due to non-determinism, such a state
executes internal transitions in subautomata until all terms
have matched or a failure is discovered.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.fac.State._State__get_subAutomata">
<code class="descname">_State__get_subAutomata</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.State._State__get_subAutomata" title="Permalink to this definition">¶</a></dt>
<dd><p>A sequence of sub-automata supporting internal state transitions.</p>
<p>This will return <code class="xref py py-obj docutils literal"><span class="pre">None</span></code> unless <a class="reference internal" href="#pyxb.utils.fac.State.isUnorderedCatenation" title="pyxb.utils.fac.State.isUnorderedCatenation"><code class="xref py py-obj docutils literal"><span class="pre">isUnorderedCatenation</span></code></a> is <code class="xref py py-obj docutils literal"><span class="pre">True</span></code>.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.fac.State._State__get_symbol">
<code class="descname">_State__get_symbol</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.State._State__get_symbol" title="Permalink to this definition">¶</a></dt>
<dd><p>Application-specific metadata identifying the symbol.</p>
<p>See also <a class="reference internal" href="#pyxb.utils.fac.State.match" title="pyxb.utils.fac.State.match"><code class="xref py py-obj docutils literal"><span class="pre">match</span></code></a>.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.fac.State._State__get_transitionSet">
<code class="descname">_State__get_transitionSet</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.State._State__get_transitionSet" title="Permalink to this definition">¶</a></dt>
<dd><p>Definitions of viable transitions from this state.</p>
<p>The transition set of a state is a set of <a class="reference internal" href="#pyxb.utils.fac.Transition" title="pyxb.utils.fac.Transition"><code class="xref py py-obj docutils literal"><span class="pre">Transition</span></code></a> nodes
identifying a state reachable in a single step from this
state, and a set of counter updates that must apply if the
transition is taken.</p>
<p>These transitions may not in themselves consume a symbol. For
example, if the destination state represents a match of an
<a class="reference internal" href="#pyxb.utils.fac.All" title="pyxb.utils.fac.All"><code class="xref py py-obj docutils literal"><span class="pre">unordered</span> <span class="pre">catenation</span> <span class="pre">of</span> <span class="pre">terms</span></code></a>, then secondary
processing must be done to traverse into the automata for
those terms and identify transitions that include a symbol
consumption.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Note:</th><td class="field-body">Although conceptually the viable transitions are a set,</td>
</tr>
</tbody>
</table>
<p>this implementation maintains them in a list so that order is
preserved when automata processing becomes non-deterministic.
PyXB is careful to build the transition list so that the
states are attempted in the order in which they appear in the
schema that define the automata.</p>
</dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.fac.State._State__isInitial">
<code class="descname">_State__isInitial</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.utils.fac.State._State__isInitial" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.fac.State._State__isUnorderedCatenation">
<code class="descname">_State__isUnorderedCatenation</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.utils.fac.State._State__isUnorderedCatenation" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.fac.State._State__subAutomata">
<code class="descname">_State__subAutomata</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.utils.fac.State._State__subAutomata" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.fac.State._State__symbol">
<code class="descname">_State__symbol</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.utils.fac.State._State__symbol" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.fac.State._State__transitionSet">
<code class="descname">_State__transitionSet</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.utils.fac.State._State__transitionSet" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.utils.fac.State._facText">
<code class="descname">_facText</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.State._facText" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.utils.fac.State._set_automaton">
<code class="descname">_set_automaton</code><span class="sig-paren">(</span><em>automaton</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.State._set_automaton" title="Permalink to this definition">¶</a></dt>
<dd><p>Method invoked during automaton construction to set state owner.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.fac.State._set_subAutomata">
<code class="descname">_set_subAutomata</code><span class="sig-paren">(</span><em>*automata</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.State._set_subAutomata" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.utils.fac.State._set_transitionSet">
<code class="descname">_set_transitionSet</code><span class="sig-paren">(</span><em>transition_set</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.State._set_transitionSet" title="Permalink to this definition">¶</a></dt>
<dd><p>Method invoked during automaton construction to set the
legal transitions from the state.</p>
<p>The set of transitions cannot be defined until all states that
appear in it are available, so the creation of the automaton
requires that the association of the transition set be
delayed. (Though described as a set, the transitions are a
list where order reflects priority.)</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>transition_set</strong> – a list of pairs where the first</td>
</tr>
</tbody>
</table>
<p>member is the destination <a class="reference internal" href="#pyxb.utils.fac.State" title="pyxb.utils.fac.State"><code class="xref py py-obj docutils literal"><span class="pre">State</span></code></a> and the second member is the
set of :py:obj:<a href="#id13"><span class="problematic" id="id14">`</span></a>UpdateInstruction`s that apply when the automaton
transitions to the destination state.</p>
</dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.fac.State.automaton">
<code class="descname">automaton</code><a class="headerlink" href="#pyxb.utils.fac.State.automaton" title="Permalink to this definition">¶</a></dt>
<dd><p>Link to the <a class="reference internal" href="#pyxb.utils.fac.Automaton" title="pyxb.utils.fac.Automaton"><code class="xref py py-obj docutils literal"><span class="pre">Automaton</span></code></a> to which the state belongs.</p>
</dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.fac.State.automatonEntryTransitions">
<code class="descname">automatonEntryTransitions</code><a class="headerlink" href="#pyxb.utils.fac.State.automatonEntryTransitions" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the set of initial transitions allowing entry to the automata through this state.</p>
<p>These are structurally-permitted transitions only, and must be
filtered based on the symbol that might trigger the
transition. The results are not filtered based on counter
value, since this value is used to determine how the
containing automaton might be entered. Consequently the
return value is the empty set unless this is an initial state.</p>
<p>The returned set is closed under entry to sub-automata,
i.e. it is guaranteed that each transition includes a
consuming state even if it requires a multi-element chain of
transitions into subautomata to reach one.</p>
</dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.fac.State.finalUpdate">
<code class="descname">finalUpdate</code><a class="headerlink" href="#pyxb.utils.fac.State.finalUpdate" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the update instructions that must be satisfied for this to be a final state.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.fac.State.isAccepting">
<code class="descname">isAccepting</code><span class="sig-paren">(</span><em>counter_values</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.State.isAccepting" title="Permalink to this definition">¶</a></dt>
<dd><p><code class="xref py py-obj docutils literal"><span class="pre">True</span></code> iff this state is an accepting state for the automaton.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>counter_values</strong> – Counter values that further validate</td>
</tr>
</tbody>
</table>
<p>whether the requirements of the automaton have been met.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><code class="xref py py-obj docutils literal"><span class="pre">True</span></code> if this is an accepting state and the</td>
</tr>
</tbody>
</table>
<p>counter values relevant at it are satisfied.</p>
</dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.fac.State.isInitial">
<code class="descname">isInitial</code><a class="headerlink" href="#pyxb.utils.fac.State.isInitial" title="Permalink to this definition">¶</a></dt>
<dd><p><code class="xref py py-obj docutils literal"><span class="pre">True</span></code> iff this state may be the first state the automaton enters.</p>
</dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.fac.State.isUnorderedCatenation">
<code class="descname">isUnorderedCatenation</code><a class="headerlink" href="#pyxb.utils.fac.State.isUnorderedCatenation" title="Permalink to this definition">¶</a></dt>
<dd><p>Indicate whether the state has subautomata for unordered
catenation.</p>
<p>To reduce state explosion due to non-determinism, such a state
executes internal transitions in subautomata until all terms
have matched or a failure is discovered.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.fac.State.match">
<code class="descname">match</code><span class="sig-paren">(</span><em>symbol</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.State.match" title="Permalink to this definition">¶</a></dt>
<dd><p>Return <code class="xref py py-obj docutils literal"><span class="pre">True</span></code> iff the symbol matches for this state.</p>
<p>This may be overridden by subclasses when matching by
equivalence does not work. Alternatively, if the symbol
stored in this node is a subclass of <a class="reference internal" href="#pyxb.utils.fac.SymbolMatch_mixin" title="pyxb.utils.fac.SymbolMatch_mixin"><code class="xref py py-obj docutils literal"><span class="pre">SymbolMatch_mixin</span></code></a>, then
its match method will be used. Otherwise <a class="reference internal" href="#pyxb.utils.fac.State.symbol" title="pyxb.utils.fac.State.symbol"><code class="xref py py-obj docutils literal"><span class="pre">symbol</span></code></a> matches
only if it is equal to the <a class="reference internal" href="#pyxb.utils.fac.State.symbol" title="pyxb.utils.fac.State.symbol"><code class="xref py py-obj docutils literal"><span class="pre">symbol</span></code></a> of this state.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>symbol</strong> – A candidate symbol corresponding to the</td>
</tr>
</tbody>
</table>
<p>expression symbol for this state.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><code class="xref py py-obj docutils literal"><span class="pre">True</span></code> iff <a class="reference internal" href="#pyxb.utils.fac.State.symbol" title="pyxb.utils.fac.State.symbol"><code class="xref py py-obj docutils literal"><span class="pre">symbol</span></code></a> is a match for this state.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.fac.State.subAutomata">
<code class="descname">subAutomata</code><a class="headerlink" href="#pyxb.utils.fac.State.subAutomata" title="Permalink to this definition">¶</a></dt>
<dd><p>A sequence of sub-automata supporting internal state transitions.</p>
<p>This will return <code class="xref py py-obj docutils literal"><span class="pre">None</span></code> unless <a class="reference internal" href="#pyxb.utils.fac.State.isUnorderedCatenation" title="pyxb.utils.fac.State.isUnorderedCatenation"><code class="xref py py-obj docutils literal"><span class="pre">isUnorderedCatenation</span></code></a> is <code class="xref py py-obj docutils literal"><span class="pre">True</span></code>.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.fac.State.subAutomataInitialTransitions">
<code class="descname">subAutomataInitialTransitions</code><span class="sig-paren">(</span><em>sub_automata=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.State.subAutomataInitialTransitions" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the set of candidate transitions to enter a sub-automaton of this state.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>sub_automata</strong> – A subset of the sub-automata of this</td>
</tr>
</tbody>
</table>
<p>state which should contribute to the result. If <code class="xref py py-obj docutils literal"><span class="pre">None</span></code>, all
sub-automata are used.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">A pair <code class="xref py py-obj docutils literal"><span class="pre">(nullable,</span> <span class="pre">transitions)</span></code> where <code class="xref py py-obj docutils literal"><span class="pre">nullable</span></code></td>
</tr>
</tbody>
</table>
<p>is <code class="xref py py-obj docutils literal"><span class="pre">True</span></code> iff there is at least one sub-automaton that is in
an accepting state on entry, and <code class="xref py py-obj docutils literal"><span class="pre">transitions</span></code> is a list of
<a class="reference internal" href="#pyxb.utils.fac.Transition" title="pyxb.utils.fac.Transition"><code class="xref py py-obj docutils literal"><span class="pre">Transition</span></code></a> instances describing how to reach some state in
a sub-automaton via a consumed symbol.</p>
</dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.fac.State.symbol">
<code class="descname">symbol</code><a class="headerlink" href="#pyxb.utils.fac.State.symbol" title="Permalink to this definition">¶</a></dt>
<dd><p>Application-specific metadata identifying the symbol.</p>
<p>See also <a class="reference internal" href="#pyxb.utils.fac.State.match" title="pyxb.utils.fac.State.match"><code class="xref py py-obj docutils literal"><span class="pre">match</span></code></a>.</p>
</dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.fac.State.transitionSet">
<code class="descname">transitionSet</code><a class="headerlink" href="#pyxb.utils.fac.State.transitionSet" title="Permalink to this definition">¶</a></dt>
<dd><p>Definitions of viable transitions from this state.</p>
<p>The transition set of a state is a set of <a class="reference internal" href="#pyxb.utils.fac.Transition" title="pyxb.utils.fac.Transition"><code class="xref py py-obj docutils literal"><span class="pre">Transition</span></code></a> nodes
identifying a state reachable in a single step from this
state, and a set of counter updates that must apply if the
transition is taken.</p>
<p>These transitions may not in themselves consume a symbol. For
example, if the destination state represents a match of an
<a class="reference internal" href="#pyxb.utils.fac.All" title="pyxb.utils.fac.All"><code class="xref py py-obj docutils literal"><span class="pre">unordered</span> <span class="pre">catenation</span> <span class="pre">of</span> <span class="pre">terms</span></code></a>, then secondary
processing must be done to traverse into the automata for
those terms and identify transitions that include a symbol
consumption.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Note:</th><td class="field-body">Although conceptually the viable transitions are a set,</td>
</tr>
</tbody>
</table>
<p>this implementation maintains them in a list so that order is
preserved when automata processing becomes non-deterministic.
PyXB is careful to build the transition list so that the
states are attempted in the order in which they appear in the
schema that define the automata.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="pyxb.utils.fac.Symbol">
<em class="property">class </em><code class="descclassname">pyxb.utils.fac.</code><code class="descname">Symbol</code><span class="sig-paren">(</span><em>symbol</em>, <em>**kw</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.Symbol" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#pyxb.utils.fac.LeafNode" title="pyxb.utils.fac.LeafNode"><code class="xref py py-class docutils literal"><span class="pre">pyxb.utils.fac.LeafNode</span></code></a></p>
<p>A leaf term that is a symbol.</p>
<p>The symbol is represented by the <code class="xref py py-obj docutils literal"><span class="pre">metadata</span></code> field.</p>
<dl class="attribute">
<dt id="pyxb.utils.fac.Symbol._Precedence">
<code class="descname">_Precedence</code><em class="property"> = 0</em><a class="headerlink" href="#pyxb.utils.fac.Symbol._Precedence" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.utils.fac.Symbol.clone">
<code class="descname">clone</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.Symbol.clone" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="pyxb.utils.fac.SymbolMatch_mixin">
<em class="property">class </em><code class="descclassname">pyxb.utils.fac.</code><code class="descname">SymbolMatch_mixin</code><a class="headerlink" href="#pyxb.utils.fac.SymbolMatch_mixin" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
<p>Mix-in used by symbols to provide a custom match implementation.</p>
<p>If a <a class="reference internal" href="#pyxb.utils.fac.State.symbol" title="pyxb.utils.fac.State.symbol"><code class="xref py py-obj docutils literal"><span class="pre">State.symbol</span></code></a> value is an instance of this mix-in, then it
will be used to validate a candidate symbol for a match.</p>
<dl class="method">
<dt id="pyxb.utils.fac.SymbolMatch_mixin.match">
<code class="descname">match</code><span class="sig-paren">(</span><em>symbol</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.SymbolMatch_mixin.match" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="pyxb.utils.fac.Transition">
<em class="property">class </em><code class="descclassname">pyxb.utils.fac.</code><code class="descname">Transition</code><span class="sig-paren">(</span><em>destination</em>, <em>update_instructions</em>, <em>layer_link=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.Transition" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
<p>Representation of a FAC state transition.</p>
<dl class="attribute">
<dt id="pyxb.utils.fac.Transition._Transition__destination">
<code class="descname">_Transition__destination</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.utils.fac.Transition._Transition__destination" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.utils.fac.Transition._Transition__get_destination">
<code class="descname">_Transition__get_destination</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.Transition._Transition__get_destination" title="Permalink to this definition">¶</a></dt>
<dd><p>The transition destination state.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.fac.Transition._Transition__get_layerLink">
<code class="descname">_Transition__get_layerLink</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.Transition._Transition__get_layerLink" title="Permalink to this definition">¶</a></dt>
<dd><p>A directive relating to changing automaton layer on transition.</p>
<p><code class="xref py py-obj docutils literal"><span class="pre">None</span></code> indicates this transition is from one state to another
within a single automaton.</p>
<p>An instance of <a class="reference internal" href="#pyxb.utils.fac.Configuration" title="pyxb.utils.fac.Configuration"><code class="xref py py-obj docutils literal"><span class="pre">Configuration</span></code></a> is a transition on completion
of a subautomaton back to the configuration in the parent
automaton. The <a class="reference internal" href="#pyxb.utils.fac.Transition.destination" title="pyxb.utils.fac.Transition.destination"><code class="xref py py-obj docutils literal"><span class="pre">destination</span></code></a> is the state in the parent automaton.</p>
<p>An instance of <a class="reference internal" href="#pyxb.utils.fac.Automaton" title="pyxb.utils.fac.Automaton"><code class="xref py py-obj docutils literal"><span class="pre">Automaton</span></code></a> requires creation of a
sub-configuration and initial entry into the automaton. The
<a class="reference internal" href="#pyxb.utils.fac.Transition.destination" title="pyxb.utils.fac.Transition.destination"><code class="xref py py-obj docutils literal"><span class="pre">destination</span></code></a> is the state in the sub-automaton.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.fac.Transition._Transition__get_nextTransition">
<code class="descname">_Transition__get_nextTransition</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.Transition._Transition__get_nextTransition" title="Permalink to this definition">¶</a></dt>
<dd><p>The next transition to apply in this chain.</p>
<p><code class="xref py py-obj docutils literal"><span class="pre">None</span></code> if this is the last transition in the chain.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.fac.Transition._Transition__get_updateInstructions">
<code class="descname">_Transition__get_updateInstructions</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.Transition._Transition__get_updateInstructions" title="Permalink to this definition">¶</a></dt>
<dd><p>The set of counter updates that are applied when the transition is taken.</p>
</dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.fac.Transition._Transition__layerLink">
<code class="descname">_Transition__layerLink</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.utils.fac.Transition._Transition__layerLink" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.fac.Transition._Transition__nextTransition">
<code class="descname">_Transition__nextTransition</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.utils.fac.Transition._Transition__nextTransition" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.fac.Transition._Transition__updateInstructions">
<code class="descname">_Transition__updateInstructions</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.utils.fac.Transition._Transition__updateInstructions" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.utils.fac.Transition.apply">
<code class="descname">apply</code><span class="sig-paren">(</span><em>configuration</em>, <em>clone_map=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.Transition.apply" title="Permalink to this definition">¶</a></dt>
<dd><p>Apply the transitition to a configuration.</p>
<p>This updates the configuration counter values based on the
update instructions, and sets the new configuration state.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Note:</th><td class="field-body">If the transition involves leaving a sub-automaton or</td>
</tr>
</tbody>
</table>
<p>creating a new sub-automaton, the returned configuration
structure will be different from the one passed in. You
should invoke this as:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">cfg</span> <span class="o">=</span> <span class="n">transition</span><span class="o">.</span><span class="n">apply</span><span class="p">(</span><span class="n">cfg</span><span class="p">)</span>
</pre></div>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>configuration</strong> – A <a class="reference internal" href="#pyxb.utils.fac.Configuration" title="pyxb.utils.fac.Configuration"><code class="xref py py-obj docutils literal"><span class="pre">Configuration</span></code></a> of an executing automaton</li>
<li><strong>clone_map</strong> – A map from <a class="reference internal" href="#pyxb.utils.fac.Configuration" title="pyxb.utils.fac.Configuration"><code class="xref py py-obj docutils literal"><span class="pre">Configuration</span></code></a> to</li>
</ul>
</td>
</tr>
</tbody>
</table>
<p><a class="reference internal" href="#pyxb.utils.fac.Configuration" title="pyxb.utils.fac.Configuration"><code class="xref py py-obj docutils literal"><span class="pre">Configuration</span></code></a> reflecting the replacements made when the
configuration for which the transition was calculated was
subsequently cloned into the <code class="xref py py-obj docutils literal"><span class="pre">configuration</span></code> passed into this
method. This is only necessary when the transition includes
layer transitions.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">The resulting configuration</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.fac.Transition.chainTo">
<code class="descname">chainTo</code><span class="sig-paren">(</span><em>next_transition</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.Transition.chainTo" title="Permalink to this definition">¶</a></dt>
<dd><p>Duplicate the state and chain the duplicate to a successor
transition.</p>
<p>This returns a new transition which applies the operation for
this transition, then proceeds to apply the next transition in
the chain.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Note:</th><td class="field-body">The node that is invoking this must not have successor</td>
</tr>
</tbody>
</table>
<p>transitions.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>next_transition</strong> – A <a class="reference internal" href="#pyxb.utils.fac.Transition" title="pyxb.utils.fac.Transition"><code class="xref py py-obj docutils literal"><span class="pre">Transition</span></code></a> node describing a</td>
</tr>
</tbody>
</table>
<p>subsequent transition.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">a clone of this node, augmented with a link to</td>
</tr>
</tbody>
</table>
<p><code class="xref py py-obj docutils literal"><span class="pre">next_transition</span></code>.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.fac.Transition.consumedSymbol">
<code class="descname">consumedSymbol</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.Transition.consumedSymbol" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the <a class="reference internal" href="#pyxb.utils.fac.State.symbol" title="pyxb.utils.fac.State.symbol"><code class="xref py py-obj docutils literal"><span class="pre">symbol</span></code></a> of the <a class="reference internal" href="#pyxb.utils.fac.Transition.consumingState" title="pyxb.utils.fac.Transition.consumingState"><code class="xref py py-obj docutils literal"><span class="pre">consumingState</span></code></a>.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.fac.Transition.consumingState">
<code class="descname">consumingState</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.Transition.consumingState" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the state in this transition chain that must match a symbol.</p>
</dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.fac.Transition.destination">
<code class="descname">destination</code><a class="headerlink" href="#pyxb.utils.fac.Transition.destination" title="Permalink to this definition">¶</a></dt>
<dd><p>The transition destination state.</p>
</dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.fac.Transition.layerLink">
<code class="descname">layerLink</code><a class="headerlink" href="#pyxb.utils.fac.Transition.layerLink" title="Permalink to this definition">¶</a></dt>
<dd><p>A directive relating to changing automaton layer on transition.</p>
<p><code class="xref py py-obj docutils literal"><span class="pre">None</span></code> indicates this transition is from one state to another
within a single automaton.</p>
<p>An instance of <a class="reference internal" href="#pyxb.utils.fac.Configuration" title="pyxb.utils.fac.Configuration"><code class="xref py py-obj docutils literal"><span class="pre">Configuration</span></code></a> is a transition on completion
of a subautomaton back to the configuration in the parent
automaton. The <a class="reference internal" href="#pyxb.utils.fac.Transition.destination" title="pyxb.utils.fac.Transition.destination"><code class="xref py py-obj docutils literal"><span class="pre">destination</span></code></a> is the state in the parent automaton.</p>
<p>An instance of <a class="reference internal" href="#pyxb.utils.fac.Automaton" title="pyxb.utils.fac.Automaton"><code class="xref py py-obj docutils literal"><span class="pre">Automaton</span></code></a> requires creation of a
sub-configuration and initial entry into the automaton. The
<a class="reference internal" href="#pyxb.utils.fac.Transition.destination" title="pyxb.utils.fac.Transition.destination"><code class="xref py py-obj docutils literal"><span class="pre">destination</span></code></a> is the state in the sub-automaton.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.fac.Transition.makeEnterAutomatonTransition">
<code class="descname">makeEnterAutomatonTransition</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.Transition.makeEnterAutomatonTransition" title="Permalink to this definition">¶</a></dt>
<dd><p>Replicate the transition as a layer link into its automaton.</p>
<p>This is used on initial transitions into sub-automata where a
sub-configuration must be created and recorded.</p>
</dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.fac.Transition.nextTransition">
<code class="descname">nextTransition</code><a class="headerlink" href="#pyxb.utils.fac.Transition.nextTransition" title="Permalink to this definition">¶</a></dt>
<dd><p>The next transition to apply in this chain.</p>
<p><code class="xref py py-obj docutils literal"><span class="pre">None</span></code> if this is the last transition in the chain.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.fac.Transition.satisfiedBy">
<code class="descname">satisfiedBy</code><span class="sig-paren">(</span><em>configuration</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.Transition.satisfiedBy" title="Permalink to this definition">¶</a></dt>
<dd><p>Check the transition update instructions against
configuration counter values.</p>
<p>This implementation follows layer changes, updating the
configuration used as counter value source as necessary.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>configuration</strong> – A <a class="reference internal" href="#pyxb.utils.fac.Configuration" title="pyxb.utils.fac.Configuration"><code class="xref py py-obj docutils literal"><span class="pre">Configuration</span></code></a> instance containing</td>
</tr>
</tbody>
</table>
<p>counter data against which update instruction satisfaction is
checked.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><code class="xref py py-obj docutils literal"><span class="pre">True</span></code> iff all update instructions along the</td>
</tr>
</tbody>
</table>
<p>transition chain are satisfied by their relevant
configuration.</p>
</dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.fac.Transition.updateInstructions">
<code class="descname">updateInstructions</code><a class="headerlink" href="#pyxb.utils.fac.Transition.updateInstructions" title="Permalink to this definition">¶</a></dt>
<dd><p>The set of counter updates that are applied when the transition is taken.</p>
</dd></dl>
</dd></dl>
<dl class="exception">
<dt id="pyxb.utils.fac.UnrecognizedSymbolError">
<em class="property">exception </em><code class="descclassname">pyxb.utils.fac.</code><code class="descname">UnrecognizedSymbolError</code><span class="sig-paren">(</span><em>*args</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.UnrecognizedSymbolError" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#pyxb.utils.fac.AutomatonStepError" title="pyxb.utils.fac.AutomatonStepError"><code class="xref py py-class docutils literal"><span class="pre">pyxb.utils.fac.AutomatonStepError</span></code></a></p>
<p><a class="reference internal" href="#pyxb.utils.fac.Configuration.step" title="pyxb.utils.fac.Configuration.step"><code class="xref py py-obj docutils literal"><span class="pre">Configuration.step</span></code></a> failed to find a valid transition.</p>
</dd></dl>
<dl class="exception">
<dt id="pyxb.utils.fac.UpdateApplicationError">
<em class="property">exception </em><code class="descclassname">pyxb.utils.fac.</code><code class="descname">UpdateApplicationError</code><span class="sig-paren">(</span><em>*args</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.UpdateApplicationError" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#pyxb.utils.fac.FACError" title="pyxb.utils.fac.FACError"><code class="xref py py-class docutils literal"><span class="pre">pyxb.utils.fac.FACError</span></code></a></p>
<p>Exception raised when an unsatisfied update instruction is executed.</p>
<p>This indicates an internal error in the implementation.</p>
<dl class="attribute">
<dt id="pyxb.utils.fac.UpdateApplicationError.update_instruction">
<code class="descname">update_instruction</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.utils.fac.UpdateApplicationError.update_instruction" title="Permalink to this definition">¶</a></dt>
<dd><p>The <a class="reference internal" href="#pyxb.utils.fac.UpdateInstruction" title="pyxb.utils.fac.UpdateInstruction"><code class="xref py py-obj docutils literal"><span class="pre">UpdateInstruction</span></code></a> with an unsatisfied <a class="reference internal" href="#pyxb.utils.fac.CounterCondition" title="pyxb.utils.fac.CounterCondition"><code class="xref py py-obj docutils literal"><span class="pre">CounterCondition</span></code></a></p>
</dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.fac.UpdateApplicationError.values">
<code class="descname">values</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.utils.fac.UpdateApplicationError.values" title="Permalink to this definition">¶</a></dt>
<dd><p>The unsatisfying value map from <a class="reference internal" href="#pyxb.utils.fac.CounterCondition" title="pyxb.utils.fac.CounterCondition"><code class="xref py py-obj docutils literal"><span class="pre">CounterCondition</span></code></a> instances to integers</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="pyxb.utils.fac.UpdateInstruction">
<em class="property">class </em><code class="descclassname">pyxb.utils.fac.</code><code class="descname">UpdateInstruction</code><span class="sig-paren">(</span><em>counter_condition</em>, <em>do_increment</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.UpdateInstruction" title="Permalink to this definition">¶</a></dt>
<dd><p>An update instruction pairs a counter with a mutation of that
counter.</p>
<p>The instruction is executed during a transition from one state to
another, and causes the corresponding counter to be incremented or
reset. The instruction may only be applied if doing so does not
violate the conditions of the counter it affects.</p>
<dl class="classmethod">
<dt id="pyxb.utils.fac.UpdateInstruction.Apply">
<em class="property">classmethod </em><code class="descname">Apply</code><span class="sig-paren">(</span><em>update_instructions</em>, <em>counter_values</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.UpdateInstruction.Apply" title="Permalink to this definition">¶</a></dt>
<dd><p>Apply the update instructions to the counter values.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>update_instructions</strong> – A set of <a class="reference internal" href="#pyxb.utils.fac.UpdateInstruction" title="pyxb.utils.fac.UpdateInstruction"><code class="xref py py-obj docutils literal"><span class="pre">UpdateInstruction</span></code></a></td>
</tr>
</tbody>
</table>
<p>instances.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>counter_values</strong> – A map from <a class="reference internal" href="#pyxb.utils.fac.CounterCondition" title="pyxb.utils.fac.CounterCondition"><code class="xref py py-obj docutils literal"><span class="pre">CounterCondition</span></code></a></td>
</tr>
</tbody>
</table>
<p>instances to non-negative integers. This map is updated
in-place by applying each instruction in
<code class="xref py py-obj docutils literal"><span class="pre">update_instructions</span></code>.</p>
</dd></dl>
<dl class="classmethod">
<dt id="pyxb.utils.fac.UpdateInstruction.Satisfies">
<em class="property">classmethod </em><code class="descname">Satisfies</code><span class="sig-paren">(</span><em>counter_values</em>, <em>update_instructions</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.UpdateInstruction.Satisfies" title="Permalink to this definition">¶</a></dt>
<dd><p>Return <code class="xref py py-obj docutils literal"><span class="pre">True</span></code> iff the counter values satisfy the update
instructions.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>counter_values</strong> – A map from <a class="reference internal" href="#pyxb.utils.fac.CounterCondition" title="pyxb.utils.fac.CounterCondition"><code class="xref py py-obj docutils literal"><span class="pre">CounterCondition</span></code></a> to</td>
</tr>
</tbody>
</table>
<p>integer counter values</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>update_instructions</strong> – A set of <a class="reference internal" href="#pyxb.utils.fac.UpdateInstruction" title="pyxb.utils.fac.UpdateInstruction"><code class="xref py py-obj docutils literal"><span class="pre">UpdateInstruction</span></code></a></td>
</tr>
</tbody>
</table>
<p>instances</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><code class="xref py py-obj docutils literal"><span class="pre">True</span></code> iff all instructions are satisfied by the</td>
</tr>
</tbody>
</table>
<p>values and limits.</p>
</dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.fac.UpdateInstruction._UpdateInstruction__counterCondition">
<code class="descname">_UpdateInstruction__counterCondition</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.utils.fac.UpdateInstruction._UpdateInstruction__counterCondition" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.fac.UpdateInstruction._UpdateInstruction__doIncrement">
<code class="descname">_UpdateInstruction__doIncrement</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.utils.fac.UpdateInstruction._UpdateInstruction__doIncrement" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.utils.fac.UpdateInstruction._UpdateInstruction__get_counterCondition">
<code class="descname">_UpdateInstruction__get_counterCondition</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.UpdateInstruction._UpdateInstruction__get_counterCondition" title="Permalink to this definition">¶</a></dt>
<dd><p>A reference to the <a class="reference internal" href="#pyxb.utils.fac.CounterCondition" title="pyxb.utils.fac.CounterCondition"><code class="xref py py-obj docutils literal"><span class="pre">CounterCondition</span></code></a> identifying the
counter to be updated.</p>
<p>The counter condition instance is used as a key to the
dictionary maintaining current counter values.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.fac.UpdateInstruction._UpdateInstruction__get_doIncrement">
<code class="descname">_UpdateInstruction__get_doIncrement</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.UpdateInstruction._UpdateInstruction__get_doIncrement" title="Permalink to this definition">¶</a></dt>
<dd><p><code class="xref py py-obj docutils literal"><span class="pre">True</span></code> if the counter is to be incremented; <code class="xref py py-obj docutils literal"><span class="pre">False</span></code> if it is to be reset.</p>
</dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.fac.UpdateInstruction._UpdateInstruction__max">
<code class="descname">_UpdateInstruction__max</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.utils.fac.UpdateInstruction._UpdateInstruction__max" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.fac.UpdateInstruction._UpdateInstruction__min">
<code class="descname">_UpdateInstruction__min</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.utils.fac.UpdateInstruction._UpdateInstruction__min" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.utils.fac.UpdateInstruction.apply">
<code class="descname">apply</code><span class="sig-paren">(</span><em>counter_values</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.UpdateInstruction.apply" title="Permalink to this definition">¶</a></dt>
<dd><p>Apply the update instruction to the provided counter values.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>counter_values</strong> – A map from <a class="reference internal" href="#pyxb.utils.fac.CounterCondition" title="pyxb.utils.fac.CounterCondition"><code class="xref py py-obj docutils literal"><span class="pre">CounterCondition</span></code></a> to</td>
</tr>
</tbody>
</table>
<p>integer counter values. This map is updated in-place.</p>
</dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.fac.UpdateInstruction.counterCondition">
<code class="descname">counterCondition</code><a class="headerlink" href="#pyxb.utils.fac.UpdateInstruction.counterCondition" title="Permalink to this definition">¶</a></dt>
<dd><p>A reference to the <a class="reference internal" href="#pyxb.utils.fac.CounterCondition" title="pyxb.utils.fac.CounterCondition"><code class="xref py py-obj docutils literal"><span class="pre">CounterCondition</span></code></a> identifying the
counter to be updated.</p>
<p>The counter condition instance is used as a key to the
dictionary maintaining current counter values.</p>
</dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.fac.UpdateInstruction.doIncrement">
<code class="descname">doIncrement</code><a class="headerlink" href="#pyxb.utils.fac.UpdateInstruction.doIncrement" title="Permalink to this definition">¶</a></dt>
<dd><p><code class="xref py py-obj docutils literal"><span class="pre">True</span></code> if the counter is to be incremented; <code class="xref py py-obj docutils literal"><span class="pre">False</span></code> if it is to be reset.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.fac.UpdateInstruction.satisfiedBy">
<code class="descname">satisfiedBy</code><span class="sig-paren">(</span><em>counter_values</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.fac.UpdateInstruction.satisfiedBy" title="Permalink to this definition">¶</a></dt>
<dd><p>Implement a component of definition 5 from B{HOV09}.</p>
<p>The update instruction is satisfied by the counter values if
its action may be legitimately applied to the value of its
associated counter.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>counter_values</strong> – A map from :py:obj:<a href="#id15"><span class="problematic" id="id16">`</span></a>CounterCondition`s to</td>
</tr>
</tbody>
</table>
<p>non-negative integers</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><code class="xref py py-obj docutils literal"><span class="pre">True</span></code> or <code class="xref py py-obj docutils literal"><span class="pre">False</span></code></td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="module-pyxb.utils.saxdom">
<span id="pyxb-utils-saxdom-module"></span><h2>pyxb.utils.saxdom module<a class="headerlink" href="#module-pyxb.utils.saxdom" title="Permalink to this headline">¶</a></h2>
<p>This module contains support for a DOM tree representation from an XML
document using a SAX parser.</p>
<p>This functionality exists because we need a DOM interface to generate the
binding classses, but the Python <code class="xref py py-obj docutils literal"><span class="pre">xml.dom.minidom</span></code> package does not support
location information. The SAX interface does, so we have a SAX content
handler which converts the SAX events into a DOM tree.</p>
<p>This is not a general-purpose DOM capability; only a small subset of the DOM
interface is supported, and only for storing the XML information, not for
converting it back into document format.</p>
<dl class="class">
<dt id="pyxb.utils.saxdom.Attr">
<em class="property">class </em><code class="descclassname">pyxb.utils.saxdom.</code><code class="descname">Attr</code><span class="sig-paren">(</span><em>**kw</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.saxdom.Attr" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#pyxb.utils.saxdom.Node" title="pyxb.utils.saxdom.Node"><code class="xref py py-class docutils literal"><span class="pre">pyxb.utils.saxdom.Node</span></code></a></p>
<p>Add the nodeName and nodeValue interface.</p>
<dl class="attribute">
<dt id="pyxb.utils.saxdom.Attr.name">
<code class="descname">name</code><a class="headerlink" href="#pyxb.utils.saxdom.Attr.name" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.saxdom.Attr.nodeName">
<code class="descname">nodeName</code><a class="headerlink" href="#pyxb.utils.saxdom.Attr.nodeName" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.saxdom.Attr.nodeValue">
<code class="descname">nodeValue</code><a class="headerlink" href="#pyxb.utils.saxdom.Attr.nodeValue" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="pyxb.utils.saxdom.Comment">
<em class="property">class </em><code class="descclassname">pyxb.utils.saxdom.</code><code class="descname">Comment</code><span class="sig-paren">(</span><em>text</em>, <em>**kw</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.saxdom.Comment" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#pyxb.utils.saxdom._CharacterData" title="pyxb.utils.saxdom._CharacterData"><code class="xref py py-class docutils literal"><span class="pre">pyxb.utils.saxdom._CharacterData</span></code></a></p>
</dd></dl>
<dl class="class">
<dt id="pyxb.utils.saxdom.Document">
<em class="property">class </em><code class="descclassname">pyxb.utils.saxdom.</code><code class="descname">Document</code><span class="sig-paren">(</span><em>**kw</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.saxdom.Document" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#pyxb.utils.saxdom.Node" title="pyxb.utils.saxdom.Node"><code class="xref py py-class docutils literal"><span class="pre">pyxb.utils.saxdom.Node</span></code></a></p>
<p>Add the documentElement interface.</p>
<dl class="attribute">
<dt id="pyxb.utils.saxdom.Document.documentElement">
<code class="descname">documentElement</code><a class="headerlink" href="#pyxb.utils.saxdom.Document.documentElement" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="pyxb.utils.saxdom.Element">
<em class="property">class </em><code class="descclassname">pyxb.utils.saxdom.</code><code class="descname">Element</code><span class="sig-paren">(</span><em>**kw</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.saxdom.Element" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#pyxb.utils.saxdom.Node" title="pyxb.utils.saxdom.Node"><code class="xref py py-class docutils literal"><span class="pre">pyxb.utils.saxdom.Node</span></code></a></p>
<dl class="attribute">
<dt id="pyxb.utils.saxdom.Element.nodeName">
<code class="descname">nodeName</code><a class="headerlink" href="#pyxb.utils.saxdom.Element.nodeName" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.saxdom.Element.tagName">
<code class="descname">tagName</code><a class="headerlink" href="#pyxb.utils.saxdom.Element.tagName" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="pyxb.utils.saxdom.NamedNodeMap">
<em class="property">class </em><code class="descclassname">pyxb.utils.saxdom.</code><code class="descname">NamedNodeMap</code><a class="headerlink" href="#pyxb.utils.saxdom.NamedNodeMap" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
<p>Implement that portion of NamedNodeMap required to satisfy PyXB’s
needs.</p>
<dl class="attribute">
<dt id="pyxb.utils.saxdom.NamedNodeMap._NamedNodeMap__memberMap">
<code class="descname">_NamedNodeMap__memberMap</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.utils.saxdom.NamedNodeMap._NamedNodeMap__memberMap" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.saxdom.NamedNodeMap._NamedNodeMap__members">
<code class="descname">_NamedNodeMap__members</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.utils.saxdom.NamedNodeMap._NamedNodeMap__members" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.utils.saxdom.NamedNodeMap._addItem">
<code class="descname">_addItem</code><span class="sig-paren">(</span><em>attr</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.saxdom.NamedNodeMap._addItem" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.utils.saxdom.NamedNodeMap._getAttr">
<code class="descname">_getAttr</code><span class="sig-paren">(</span><em>name</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.saxdom.NamedNodeMap._getAttr" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.utils.saxdom.NamedNodeMap.item">
<code class="descname">item</code><span class="sig-paren">(</span><em>index</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.saxdom.NamedNodeMap.item" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.saxdom.NamedNodeMap.length">
<code class="descname">length</code><a class="headerlink" href="#pyxb.utils.saxdom.NamedNodeMap.length" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="pyxb.utils.saxdom.Node">
<em class="property">class </em><code class="descclassname">pyxb.utils.saxdom.</code><code class="descname">Node</code><span class="sig-paren">(</span><em>node_type</em>, <em>**kw</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.saxdom.Node" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">xml.dom.Node</span></code>, <a class="reference internal" href="#pyxb.utils.utility.Locatable_mixin" title="pyxb.utils.utility.Locatable_mixin"><code class="xref py py-class docutils literal"><span class="pre">pyxb.utils.utility.Locatable_mixin</span></code></a></p>
<p>Base for the minimal DOM interface required by PyXB.</p>
<dl class="attribute">
<dt id="pyxb.utils.saxdom.Node._Node__attributes">
<code class="descname">_Node__attributes</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.utils.saxdom.Node._Node__attributes" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.utils.saxdom.Node._Node__childIfPresent">
<code class="descname">_Node__childIfPresent</code><span class="sig-paren">(</span><em>index</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.saxdom.Node._Node__childIfPresent" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.saxdom.Node._Node__expandedName">
<code class="descname">_Node__expandedName</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.utils.saxdom.Node._Node__expandedName" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.saxdom.Node._Node__localName">
<code class="descname">_Node__localName</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.utils.saxdom.Node._Node__localName" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.saxdom.Node._Node__namespaceURI">
<code class="descname">_Node__namespaceURI</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.utils.saxdom.Node._Node__namespaceURI" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.saxdom.Node._Node__prefix">
<code class="descname">_Node__prefix</code><em class="property"> = ''</em><a class="headerlink" href="#pyxb.utils.saxdom.Node._Node__prefix" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.saxdom.Node._Node__tagName">
<code class="descname">_Node__tagName</code><em class="property"> = ''</em><a class="headerlink" href="#pyxb.utils.saxdom.Node._Node__tagName" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.saxdom.Node._Node__value">
<code class="descname">_Node__value</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.utils.saxdom.Node._Node__value" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.saxdom.Node._expandedName">
<code class="descname">_expandedName</code><a class="headerlink" href="#pyxb.utils.saxdom.Node._expandedName" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.utils.saxdom.Node._indexInParent">
<code class="descname">_indexInParent</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.saxdom.Node._indexInParent" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.utils.saxdom.Node._setAttributes">
<code class="descname">_setAttributes</code><span class="sig-paren">(</span><em>attributes</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.saxdom.Node._setAttributes" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.utils.saxdom.Node._setParentNode">
<code class="descname">_setParentNode</code><span class="sig-paren">(</span><em>parent_node</em>, <em>index_in_parent</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.saxdom.Node._setParentNode" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.utils.saxdom.Node.appendChild">
<code class="descname">appendChild</code><span class="sig-paren">(</span><em>new_child</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.saxdom.Node.appendChild" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.saxdom.Node.attributes">
<code class="descname">attributes</code><a class="headerlink" href="#pyxb.utils.saxdom.Node.attributes" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.saxdom.Node.childNodes">
<code class="descname">childNodes</code><a class="headerlink" href="#pyxb.utils.saxdom.Node.childNodes" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.saxdom.Node.firstChild">
<code class="descname">firstChild</code><a class="headerlink" href="#pyxb.utils.saxdom.Node.firstChild" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.utils.saxdom.Node.getAttributeNS">
<code class="descname">getAttributeNS</code><span class="sig-paren">(</span><em>ns_uri</em>, <em>local_name</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.saxdom.Node.getAttributeNS" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.utils.saxdom.Node.getAttributeNodeNS">
<code class="descname">getAttributeNodeNS</code><span class="sig-paren">(</span><em>ns_uri</em>, <em>local_name</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.saxdom.Node.getAttributeNodeNS" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.utils.saxdom.Node.hasAttributeNS">
<code class="descname">hasAttributeNS</code><span class="sig-paren">(</span><em>ns_uri</em>, <em>local_name</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.saxdom.Node.hasAttributeNS" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.saxdom.Node.localName">
<code class="descname">localName</code><a class="headerlink" href="#pyxb.utils.saxdom.Node.localName" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.saxdom.Node.location">
<code class="descname">location</code><a class="headerlink" href="#pyxb.utils.saxdom.Node.location" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.saxdom.Node.namespaceURI">
<code class="descname">namespaceURI</code><a class="headerlink" href="#pyxb.utils.saxdom.Node.namespaceURI" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.saxdom.Node.nextSibling">
<code class="descname">nextSibling</code><a class="headerlink" href="#pyxb.utils.saxdom.Node.nextSibling" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.saxdom.Node.nodeType">
<code class="descname">nodeType</code><a class="headerlink" href="#pyxb.utils.saxdom.Node.nodeType" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.saxdom.Node.parentNode">
<code class="descname">parentNode</code><a class="headerlink" href="#pyxb.utils.saxdom.Node.parentNode" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.saxdom.Node.prefix">
<code class="descname">prefix</code><a class="headerlink" href="#pyxb.utils.saxdom.Node.prefix" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.saxdom.Node.tagName">
<code class="descname">tagName</code><a class="headerlink" href="#pyxb.utils.saxdom.Node.tagName" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.saxdom.Node.value">
<code class="descname">value</code><a class="headerlink" href="#pyxb.utils.saxdom.Node.value" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="pyxb.utils.saxdom.Text">
<em class="property">class </em><code class="descclassname">pyxb.utils.saxdom.</code><code class="descname">Text</code><span class="sig-paren">(</span><em>text</em>, <em>**kw</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.saxdom.Text" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#pyxb.utils.saxdom._CharacterData" title="pyxb.utils.saxdom._CharacterData"><code class="xref py py-class docutils literal"><span class="pre">pyxb.utils.saxdom._CharacterData</span></code></a></p>
</dd></dl>
<dl class="class">
<dt id="pyxb.utils.saxdom._CharacterData">
<em class="property">class </em><code class="descclassname">pyxb.utils.saxdom.</code><code class="descname">_CharacterData</code><span class="sig-paren">(</span><em>node_type</em>, <em>**kw</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.saxdom._CharacterData" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#pyxb.utils.saxdom.Node" title="pyxb.utils.saxdom.Node"><code class="xref py py-class docutils literal"><span class="pre">pyxb.utils.saxdom.Node</span></code></a></p>
<p>Abstract base for anything holding text data.</p>
<dl class="attribute">
<dt id="pyxb.utils.saxdom._CharacterData.data">
<code class="descname">data</code><a class="headerlink" href="#pyxb.utils.saxdom._CharacterData.data" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="pyxb.utils.saxdom._DOMSAXHandler">
<em class="property">class </em><code class="descclassname">pyxb.utils.saxdom.</code><code class="descname">_DOMSAXHandler</code><span class="sig-paren">(</span><em>**kw</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.saxdom._DOMSAXHandler" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#pyxb.utils.saxutils.BaseSAXHandler" title="pyxb.utils.saxutils.BaseSAXHandler"><code class="xref py py-class docutils literal"><span class="pre">pyxb.utils.saxutils.BaseSAXHandler</span></code></a></p>
<p>SAX handler class that transforms events into a DOM tree.</p>
<dl class="attribute">
<dt id="pyxb.utils.saxdom._DOMSAXHandler._DOMSAXHandler__document">
<code class="descname">_DOMSAXHandler__document</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.utils.saxdom._DOMSAXHandler._DOMSAXHandler__document" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.utils.saxdom._DOMSAXHandler.document">
<code class="descname">document</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.saxdom._DOMSAXHandler.document" title="Permalink to this definition">¶</a></dt>
<dd><p>The document that is the root of the generated tree.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.saxdom._DOMSAXHandler.endDocument">
<code class="descname">endDocument</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.saxdom._DOMSAXHandler.endDocument" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.utils.saxdom._DOMSAXHandler.endElementNS">
<code class="descname">endElementNS</code><span class="sig-paren">(</span><em>name</em>, <em>qname</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.saxdom._DOMSAXHandler.endElementNS" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.utils.saxdom._DOMSAXHandler.startDocument">
<code class="descname">startDocument</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.saxdom._DOMSAXHandler.startDocument" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.utils.saxdom._DOMSAXHandler.startElementNS">
<code class="descname">startElementNS</code><span class="sig-paren">(</span><em>name</em>, <em>qname</em>, <em>attrs</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.saxdom._DOMSAXHandler.startElementNS" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="function">
<dt id="pyxb.utils.saxdom._DumpDOM">
<code class="descclassname">pyxb.utils.saxdom.</code><code class="descname">_DumpDOM</code><span class="sig-paren">(</span><em>n</em>, <em>depth=0</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.saxdom._DumpDOM" title="Permalink to this definition">¶</a></dt>
<dd><p>Utility function to print a DOM tree.</p>
</dd></dl>
<dl class="function">
<dt id="pyxb.utils.saxdom.parse">
<code class="descclassname">pyxb.utils.saxdom.</code><code class="descname">parse</code><span class="sig-paren">(</span><em>stream</em>, <em>**kw</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.saxdom.parse" title="Permalink to this definition">¶</a></dt>
<dd><p>Parse a stream containing an XML document and return the DOM tree
representing its contents.</p>
<p>Keywords not described here are passed to <a class="reference internal" href="#pyxb.utils.saxutils.make_parser" title="pyxb.utils.saxutils.make_parser"><code class="xref py py-obj docutils literal"><span class="pre">pyxb.utils.saxutils.make_parser</span></code></a>.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>stream</strong> – An object presenting the standard file <code class="xref py py-obj docutils literal"><span class="pre">read</span></code> interface</td>
</tr>
</tbody>
</table>
<p>from which the document can be read. The content should be data, not text.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>content_handler_constructor</strong> – Input is overridden to assign this a</td>
</tr>
</tbody>
</table>
<p>value of <a class="reference internal" href="#pyxb.utils.saxdom._DOMSAXHandler" title="pyxb.utils.saxdom._DOMSAXHandler"><code class="xref py py-obj docutils literal"><span class="pre">_DOMSAXHandler</span></code></a>.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><code class="xref py py-obj docutils literal"><span class="pre">xml.dom.Document</span></code></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="pyxb.utils.saxdom.parseString">
<code class="descclassname">pyxb.utils.saxdom.</code><code class="descname">parseString</code><span class="sig-paren">(</span><em>xml_text</em>, <em>**kw</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.saxdom.parseString" title="Permalink to this definition">¶</a></dt>
<dd><p>Parse a string holding an XML document and return the corresponding DOM
tree.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>xml_text</strong> – the XML content to be parsed, in a text representation.</td>
</tr>
</tbody>
</table>
</dd></dl>
</div>
<div class="section" id="module-pyxb.utils.saxutils">
<span id="pyxb-utils-saxutils-module"></span><h2>pyxb.utils.saxutils module<a class="headerlink" href="#module-pyxb.utils.saxutils" title="Permalink to this headline">¶</a></h2>
<p>This module contains support for processing XML using a SAX parser.</p>
<p>In particular, it provides a <a class="reference internal" href="#pyxb.utils.saxutils.BaseSAXHandler" title="pyxb.utils.saxutils.BaseSAXHandler"><code class="xref py py-obj docutils literal"><span class="pre">base</span> <span class="pre">content</span> <span class="pre">handler</span> <span class="pre">class</span></code></a>
that maintains namespace context and element state in a stack; and a L{base
element state class <SAXElementState>} which records the location of the
element in the stream. These classes are extended for specific parsing needs
(e.g., <a class="reference internal" href="pyxb.binding.html#module-pyxb.binding.saxer" title="pyxb.binding.saxer"><code class="xref py py-obj docutils literal"><span class="pre">pyxb.binding.saxer</span></code></a>).</p>
<dl class="class">
<dt id="pyxb.utils.saxutils.BaseSAXHandler">
<em class="property">class </em><code class="descclassname">pyxb.utils.saxutils.</code><code class="descname">BaseSAXHandler</code><span class="sig-paren">(</span><em>**kw</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.saxutils.BaseSAXHandler" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">xml.sax.handler.ContentHandler</span></code>, <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
<p>A SAX handler class that maintains a stack of enclosing elements and
manages namespace declarations.</p>
<p>This is the base for <a class="reference internal" href="#pyxb.utils.saxdom._DOMSAXHandler" title="pyxb.utils.saxdom._DOMSAXHandler"><code class="xref py py-obj docutils literal"><span class="pre">pyxb.utils.saxdom._DOMSAXHandler</span></code></a> and
<a class="reference internal" href="pyxb.binding.html#pyxb.binding.saxer.PyXBSAXHandler" title="pyxb.binding.saxer.PyXBSAXHandler"><code class="xref py py-obj docutils literal"><span class="pre">pyxb.binding.saxer.PyXBSAXHandler</span></code></a>.</p>
<dl class="attribute">
<dt id="pyxb.utils.saxutils.BaseSAXHandler._BaseSAXHandler__elementState">
<code class="descname">_BaseSAXHandler__elementState</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.utils.saxutils.BaseSAXHandler._BaseSAXHandler__elementState" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.saxutils.BaseSAXHandler._BaseSAXHandler__elementStateConstructor">
<code class="descname">_BaseSAXHandler__elementStateConstructor</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.utils.saxutils.BaseSAXHandler._BaseSAXHandler__elementStateConstructor" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.saxutils.BaseSAXHandler._BaseSAXHandler__elementStateStack">
<code class="descname">_BaseSAXHandler__elementStateStack</code><em class="property"> = []</em><a class="headerlink" href="#pyxb.utils.saxutils.BaseSAXHandler._BaseSAXHandler__elementStateStack" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.saxutils.BaseSAXHandler._BaseSAXHandler__fallbackNamespace">
<code class="descname">_BaseSAXHandler__fallbackNamespace</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.utils.saxutils.BaseSAXHandler._BaseSAXHandler__fallbackNamespace" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.utils.saxutils.BaseSAXHandler._BaseSAXHandler__flushPendingText">
<code class="descname">_BaseSAXHandler__flushPendingText</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.saxutils.BaseSAXHandler._BaseSAXHandler__flushPendingText" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.utils.saxutils.BaseSAXHandler._BaseSAXHandler__getOrCreateNextNamespaceContext">
<code class="descname">_BaseSAXHandler__getOrCreateNextNamespaceContext</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.saxutils.BaseSAXHandler._BaseSAXHandler__getOrCreateNextNamespaceContext" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.saxutils.BaseSAXHandler._BaseSAXHandler__includingContext">
<code class="descname">_BaseSAXHandler__includingContext</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.utils.saxutils.BaseSAXHandler._BaseSAXHandler__includingContext" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.saxutils.BaseSAXHandler._BaseSAXHandler__locationTemplate">
<code class="descname">_BaseSAXHandler__locationTemplate</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.utils.saxutils.BaseSAXHandler._BaseSAXHandler__locationTemplate" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.saxutils.BaseSAXHandler._BaseSAXHandler__locator">
<code class="descname">_BaseSAXHandler__locator</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.utils.saxutils.BaseSAXHandler._BaseSAXHandler__locator" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.saxutils.BaseSAXHandler._BaseSAXHandler__namespaceContext">
<code class="descname">_BaseSAXHandler__namespaceContext</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.utils.saxutils.BaseSAXHandler._BaseSAXHandler__namespaceContext" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.saxutils.BaseSAXHandler._BaseSAXHandler__nextNamespaceContext">
<code class="descname">_BaseSAXHandler__nextNamespaceContext</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.utils.saxutils.BaseSAXHandler._BaseSAXHandler__nextNamespaceContext" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.saxutils.BaseSAXHandler._BaseSAXHandler__pendingText">
<code class="descname">_BaseSAXHandler__pendingText</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.utils.saxutils.BaseSAXHandler._BaseSAXHandler__pendingText" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.saxutils.BaseSAXHandler._BaseSAXHandler__pendingTextLocation">
<code class="descname">_BaseSAXHandler__pendingTextLocation</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.utils.saxutils.BaseSAXHandler._BaseSAXHandler__pendingTextLocation" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.saxutils.BaseSAXHandler._BaseSAXHandler__rootObject">
<code class="descname">_BaseSAXHandler__rootObject</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.utils.saxutils.BaseSAXHandler._BaseSAXHandler__rootObject" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.utils.saxutils.BaseSAXHandler.characters">
<code class="descname">characters</code><span class="sig-paren">(</span><em>content</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.saxutils.BaseSAXHandler.characters" title="Permalink to this definition">¶</a></dt>
<dd><p>Save the text as content</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.saxutils.BaseSAXHandler.elementState">
<code class="descname">elementState</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.saxutils.BaseSAXHandler.elementState" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.utils.saxutils.BaseSAXHandler.endElementNS">
<code class="descname">endElementNS</code><span class="sig-paren">(</span><em>name</em>, <em>qname</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.saxutils.BaseSAXHandler.endElementNS" title="Permalink to this definition">¶</a></dt>
<dd><p>Process the completion of an element.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.saxutils.BaseSAXHandler.fallbackNamespace">
<code class="descname">fallbackNamespace</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.saxutils.BaseSAXHandler.fallbackNamespace" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the namespace used to resolve unqualified names with no default namespace.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.saxutils.BaseSAXHandler.ignorableWhitespace">
<code class="descname">ignorableWhitespace</code><span class="sig-paren">(</span><em>whitespace</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.saxutils.BaseSAXHandler.ignorableWhitespace" title="Permalink to this definition">¶</a></dt>
<dd><p>Save whitespace as content too.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.saxutils.BaseSAXHandler.location">
<code class="descname">location</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.saxutils.BaseSAXHandler.location" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the current location within the SAX-processed document.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.saxutils.BaseSAXHandler.namespaceContext">
<code class="descname">namespaceContext</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.saxutils.BaseSAXHandler.namespaceContext" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the namespace context used for QName resolution within the
current element.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">An instance of <code class="xref py py-obj docutils literal"><span class="pre">pyxb.namespace.NamespaceContext</span></code></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.saxutils.BaseSAXHandler.processingInstruction">
<code class="descname">processingInstruction</code><span class="sig-paren">(</span><em>target</em>, <em>data</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.saxutils.BaseSAXHandler.processingInstruction" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.utils.saxutils.BaseSAXHandler.reset">
<code class="descname">reset</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.saxutils.BaseSAXHandler.reset" title="Permalink to this definition">¶</a></dt>
<dd><p>Reset the state of the handler in preparation for processing a new
document.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><code class="xref py py-obj docutils literal"><span class="pre">self</span></code></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.saxutils.BaseSAXHandler.rootObject">
<code class="descname">rootObject</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.saxutils.BaseSAXHandler.rootObject" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the binding object corresponding to the top-most
element in the document</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">An instance of <code class="xref py py-obj docutils literal"><span class="pre">basis._TypeBinding_mixin</span></code> (most usually a</td>
</tr>
</tbody>
</table>
<p><code class="xref py py-obj docutils literal"><span class="pre">basis.complexTypeDefinition</span></code>.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.saxutils.BaseSAXHandler.setDocumentLocator">
<code class="descname">setDocumentLocator</code><span class="sig-paren">(</span><em>locator</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.saxutils.BaseSAXHandler.setDocumentLocator" title="Permalink to this definition">¶</a></dt>
<dd><p>Save the locator object.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.saxutils.BaseSAXHandler.startDocument">
<code class="descname">startDocument</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.saxutils.BaseSAXHandler.startDocument" title="Permalink to this definition">¶</a></dt>
<dd><p>Process the start of a document.</p>
<p>This resets this handler for a new document.
:note: setDocumentLocator is invoked before startDocument</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.saxutils.BaseSAXHandler.startElementNS">
<code class="descname">startElementNS</code><span class="sig-paren">(</span><em>name</em>, <em>qname</em>, <em>attrs</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.saxutils.BaseSAXHandler.startElementNS" title="Permalink to this definition">¶</a></dt>
<dd><p>Process the start of an element.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.saxutils.BaseSAXHandler.startPrefixMapping">
<code class="descname">startPrefixMapping</code><span class="sig-paren">(</span><em>prefix</em>, <em>uri</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.saxutils.BaseSAXHandler.startPrefixMapping" title="Permalink to this definition">¶</a></dt>
<dd><p>Implement base class method.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Note:</th><td class="field-body">For this to be invoked, the <code class="xref py py-obj docutils literal"><span class="pre">feature_namespaces</span></code> feature must</td>
</tr>
</tbody>
</table>
<p>be enabled in the SAX parser.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="pyxb.utils.saxutils.SAXElementState">
<em class="property">class </em><code class="descclassname">pyxb.utils.saxutils.</code><code class="descname">SAXElementState</code><span class="sig-paren">(</span><em>**kw</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.saxutils.SAXElementState" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
<p>State corresponding to processing a given element with the SAX
model.</p>
<dl class="attribute">
<dt id="pyxb.utils.saxutils.SAXElementState._SAXElementState__content">
<code class="descname">_SAXElementState__content</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.utils.saxutils.SAXElementState._SAXElementState__content" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.saxutils.SAXElementState._SAXElementState__contentHandler">
<code class="descname">_SAXElementState__contentHandler</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.utils.saxutils.SAXElementState._SAXElementState__contentHandler" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.saxutils.SAXElementState._SAXElementState__expandedName">
<code class="descname">_SAXElementState__expandedName</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.utils.saxutils.SAXElementState._SAXElementState__expandedName" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.saxutils.SAXElementState._SAXElementState__location">
<code class="descname">_SAXElementState__location</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.utils.saxutils.SAXElementState._SAXElementState__location" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.saxutils.SAXElementState._SAXElementState__namespaceContext">
<code class="descname">_SAXElementState__namespaceContext</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.utils.saxutils.SAXElementState._SAXElementState__namespaceContext" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.saxutils.SAXElementState._SAXElementState__parentState">
<code class="descname">_SAXElementState__parentState</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.utils.saxutils.SAXElementState._SAXElementState__parentState" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.utils.saxutils.SAXElementState.addElementContent">
<code class="descname">addElementContent</code><span class="sig-paren">(</span><em>location</em>, <em>element</em>, <em>element_decl=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.saxutils.SAXElementState.addElementContent" title="Permalink to this definition">¶</a></dt>
<dd><p>Add the given binding instance as element content corresponding to
the given use.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>element</strong> – Any <a class="reference internal" href="pyxb.binding.html#pyxb.binding.basis._TypeBinding_mixin" title="pyxb.binding.basis._TypeBinding_mixin"><code class="xref py py-obj docutils literal"><span class="pre">binding</span> <span class="pre">instance</span></code></a>.</li>
<li><strong>element_decl</strong> – The L{element</li>
</ul>
</td>
</tr>
</tbody>
</table>
<p>use<pyxb.binding.content.ElementDeclaration>} in the containing complex type.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.saxutils.SAXElementState.addTextContent">
<code class="descname">addTextContent</code><span class="sig-paren">(</span><em>location</em>, <em>content</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.saxutils.SAXElementState.addTextContent" title="Permalink to this definition">¶</a></dt>
<dd><p>Add the given text as non-element content of the current element.
:type content: <code class="xref py py-obj docutils literal"><span class="pre">unicode</span></code> or <code class="xref py py-obj docutils literal"><span class="pre">str</span></code>
:return: <code class="xref py py-obj docutils literal"><span class="pre">self</span></code></p>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.saxutils.SAXElementState.content">
<code class="descname">content</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.saxutils.SAXElementState.content" title="Permalink to this definition">¶</a></dt>
<dd><p>An accumulation of content to be supplied to the content model when
the element end is reached.</p>
<p>This is a list, with each member being C{(content, element_use,
maybe_element)}. <a class="reference internal" href="#pyxb.utils.saxutils.SAXElementState.content" title="pyxb.utils.saxutils.SAXElementState.content"><code class="xref py py-obj docutils literal"><span class="pre">content</span></code></a> is text or a binding instance;
<code class="xref py py-obj docutils literal"><span class="pre">element_use</span></code> is <code class="xref py py-obj docutils literal"><span class="pre">None</span></code> or the
<a class="reference internal" href="pyxb.binding.html#pyxb.binding.content.ElementDeclaration" title="pyxb.binding.content.ElementDeclaration"><code class="xref py py-obj docutils literal"><span class="pre">ElementDeclaration</span></code></a> instance used to create
the content; and <code class="xref py py-obj docutils literal"><span class="pre">maybe_element</span></code> is <code class="xref py py-obj docutils literal"><span class="pre">True</span></code> iff the content is
non-content text.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.saxutils.SAXElementState.contentHandler">
<code class="descname">contentHandler</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.saxutils.SAXElementState.contentHandler" title="Permalink to this definition">¶</a></dt>
<dd><p>Reference to the <code class="xref py py-obj docutils literal"><span class="pre">xml.sxa.handler.ContentHandler</span></code> that is processing the document.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.saxutils.SAXElementState.expandedName">
<code class="descname">expandedName</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.saxutils.SAXElementState.expandedName" title="Permalink to this definition">¶</a></dt>
<dd><p>The <a class="reference internal" href="pyxb.namespace.html#pyxb.namespace.ExpandedName" title="pyxb.namespace.ExpandedName"><code class="xref py py-obj docutils literal"><span class="pre">expanded</span> <span class="pre">name</span></code></a> of the
element.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.saxutils.SAXElementState.location">
<code class="descname">location</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.saxutils.SAXElementState.location" title="Permalink to this definition">¶</a></dt>
<dd><p>The <a class="reference internal" href="#pyxb.utils.utility.Location" title="pyxb.utils.utility.Location"><code class="xref py py-obj docutils literal"><span class="pre">location</span></code></a> corresponding to the
element event.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.saxutils.SAXElementState.namespaceContext">
<code class="descname">namespaceContext</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.saxutils.SAXElementState.namespaceContext" title="Permalink to this definition">¶</a></dt>
<dd><p>The <code class="xref py py-obj docutils literal"><span class="pre">pyxb.namespace.NamespaceContext</span></code> used for this binding.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.saxutils.SAXElementState.parentState">
<code class="descname">parentState</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.saxutils.SAXElementState.parentState" title="Permalink to this definition">¶</a></dt>
<dd><p>Reference to the SAXElementState of the element enclosing this
one.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="pyxb.utils.saxutils.SAXInformationItem">
<em class="property">class </em><code class="descclassname">pyxb.utils.saxutils.</code><code class="descname">SAXInformationItem</code><span class="sig-paren">(</span><em>location</em>, <em>item</em>, <em>maybe_element</em>, <em>element_decl=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.saxutils.SAXInformationItem" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
<p>Class used to capture an item discovered in the body of an element.</p>
<dl class="attribute">
<dt id="pyxb.utils.saxutils.SAXInformationItem.element_decl">
<code class="descname">element_decl</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.utils.saxutils.SAXInformationItem.element_decl" title="Permalink to this definition">¶</a></dt>
<dd><p>A reference to the
<a class="reference internal" href="pyxb.binding.html#pyxb.binding.content.ElementDeclaration" title="pyxb.binding.content.ElementDeclaration"><code class="xref py py-obj docutils literal"><span class="pre">ElementDeclaration</span></code></a> used for
the <a class="reference internal" href="#pyxb.utils.saxutils.SAXInformationItem.item" title="pyxb.utils.saxutils.SAXInformationItem.item"><code class="xref py py-obj docutils literal"><span class="pre">item</span></code></a>. This will be <code class="xref py py-obj docutils literal"><span class="pre">None</span></code> for element content that does not have
an enclosing CTD scope.</p>
</dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.saxutils.SAXInformationItem.item">
<code class="descname">item</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.utils.saxutils.SAXInformationItem.item" title="Permalink to this definition">¶</a></dt>
<dd><p>The item. Generally either character information (as text) or a DOM
Node instance or a binding instance.</p>
</dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.saxutils.SAXInformationItem.location">
<code class="descname">location</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.utils.saxutils.SAXInformationItem.location" title="Permalink to this definition">¶</a></dt>
<dd><p>Where the item began in the document.</p>
</dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.saxutils.SAXInformationItem.maybe_element">
<code class="descname">maybe_element</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.utils.saxutils.SAXInformationItem.maybe_element" title="Permalink to this definition">¶</a></dt>
<dd><p><code class="xref py py-obj docutils literal"><span class="pre">False</span></code> iff the <a class="reference internal" href="#pyxb.utils.saxutils.SAXInformationItem.item" title="pyxb.utils.saxutils.SAXInformationItem.item"><code class="xref py py-obj docutils literal"><span class="pre">item</span></code></a> is character information as opposed to element content.</p>
</dd></dl>
</dd></dl>
<dl class="function">
<dt id="pyxb.utils.saxutils.SetCreateParserModules">
<code class="descclassname">pyxb.utils.saxutils.</code><code class="descname">SetCreateParserModules</code><span class="sig-paren">(</span><em>create_parser_modules</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.saxutils.SetCreateParserModules" title="Permalink to this definition">¶</a></dt>
<dd><p>Provide list of modules to be used when creating parsers.</p>
<p><code class="xref py py-obj docutils literal"><span class="pre">xml.sax.make_parser()</span></code> takes as a parameter an optional list of modules
which allow customization of the parser to be used. Certain parsers have
better support for Unicode than others.</p>
<p>As an example, providing <code class="xref py py-obj docutils literal"><span class="pre">["drv_libxml2"]</span></code> causes the libxml2 parser to
be used.</p>
<p>The default behavior if this function is not called, or if it is called
with an empty list or <code class="xref py py-obj docutils literal"><span class="pre">None</span></code>, is to provide no specific modules, which
will result in the system default parser (probably expat).</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>create_parser_modules</strong> – an iterable list of names of modules that</td>
</tr>
</tbody>
</table>
<p>provide a <code class="xref py py-obj docutils literal"><span class="pre">create_parser</span></code> function. Pass <code class="xref py py-obj docutils literal"><span class="pre">None</span></code> to reset to the system
default.</p>
</dd></dl>
<dl class="class">
<dt id="pyxb.utils.saxutils.TracingSAXHandler">
<em class="property">class </em><code class="descclassname">pyxb.utils.saxutils.</code><code class="descname">TracingSAXHandler</code><a class="headerlink" href="#pyxb.utils.saxutils.TracingSAXHandler" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">xml.sax.handler.ContentHandler</span></code></p>
<p>A SAX handler class which prints each method invocation.</p>
<dl class="attribute">
<dt id="pyxb.utils.saxutils.TracingSAXHandler._TracingSAXHandler__trace">
<code class="descname">_TracingSAXHandler__trace</code><em class="property"> = False</em><a class="headerlink" href="#pyxb.utils.saxutils.TracingSAXHandler._TracingSAXHandler__trace" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.utils.saxutils.TracingSAXHandler.characters">
<code class="descname">characters</code><span class="sig-paren">(</span><em>content</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.saxutils.TracingSAXHandler.characters" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.utils.saxutils.TracingSAXHandler.endElementNS">
<code class="descname">endElementNS</code><span class="sig-paren">(</span><em>name</em>, <em>qname</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.saxutils.TracingSAXHandler.endElementNS" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.utils.saxutils.TracingSAXHandler.endPrefixMapping">
<code class="descname">endPrefixMapping</code><span class="sig-paren">(</span><em>prefix</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.saxutils.TracingSAXHandler.endPrefixMapping" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.utils.saxutils.TracingSAXHandler.ignorableWhitespace">
<code class="descname">ignorableWhitespace</code><span class="sig-paren">(</span><em>whitespace</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.saxutils.TracingSAXHandler.ignorableWhitespace" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.utils.saxutils.TracingSAXHandler.processingInstruction">
<code class="descname">processingInstruction</code><span class="sig-paren">(</span><em>target</em>, <em>data</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.saxutils.TracingSAXHandler.processingInstruction" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.utils.saxutils.TracingSAXHandler.setDocumentLocator">
<code class="descname">setDocumentLocator</code><span class="sig-paren">(</span><em>locator</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.saxutils.TracingSAXHandler.setDocumentLocator" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.utils.saxutils.TracingSAXHandler.startDocument">
<code class="descname">startDocument</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.saxutils.TracingSAXHandler.startDocument" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.utils.saxutils.TracingSAXHandler.startElementNS">
<code class="descname">startElementNS</code><span class="sig-paren">(</span><em>name</em>, <em>qname</em>, <em>attrs</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.saxutils.TracingSAXHandler.startElementNS" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.utils.saxutils.TracingSAXHandler.startPrefixMapping">
<code class="descname">startPrefixMapping</code><span class="sig-paren">(</span><em>prefix</em>, <em>uri</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.saxutils.TracingSAXHandler.startPrefixMapping" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="pyxb.utils.saxutils._EntityResolver">
<em class="property">class </em><code class="descclassname">pyxb.utils.saxutils.</code><code class="descname">_EntityResolver</code><a class="headerlink" href="#pyxb.utils.saxutils._EntityResolver" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
<p>Dummy used to prevent the SAX parser from crashing when it sees
processing instructions that we don’t care about.</p>
<dl class="method">
<dt id="pyxb.utils.saxutils._EntityResolver.resolveEntity">
<code class="descname">resolveEntity</code><span class="sig-paren">(</span><em>public_id</em>, <em>system_id</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.saxutils._EntityResolver.resolveEntity" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="pyxb.utils.saxutils._NoopSAXHandler">
<em class="property">class </em><code class="descclassname">pyxb.utils.saxutils.</code><code class="descname">_NoopSAXHandler</code><a class="headerlink" href="#pyxb.utils.saxutils._NoopSAXHandler" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">xml.sax.handler.ContentHandler</span></code></p>
<p>A SAX handler class which doesn’t do anything. Used to get baseline
performance parsing a particular document.</p>
<dl class="method">
<dt id="pyxb.utils.saxutils._NoopSAXHandler.characters">
<code class="descname">characters</code><span class="sig-paren">(</span><em>content</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.saxutils._NoopSAXHandler.characters" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.utils.saxutils._NoopSAXHandler.endElementNS">
<code class="descname">endElementNS</code><span class="sig-paren">(</span><em>name</em>, <em>qname</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.saxutils._NoopSAXHandler.endElementNS" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.utils.saxutils._NoopSAXHandler.endPrefixMapping">
<code class="descname">endPrefixMapping</code><span class="sig-paren">(</span><em>prefix</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.saxutils._NoopSAXHandler.endPrefixMapping" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.utils.saxutils._NoopSAXHandler.ignorableWhitespace">
<code class="descname">ignorableWhitespace</code><span class="sig-paren">(</span><em>whitespace</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.saxutils._NoopSAXHandler.ignorableWhitespace" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.utils.saxutils._NoopSAXHandler.processingInstruction">
<code class="descname">processingInstruction</code><span class="sig-paren">(</span><em>target</em>, <em>data</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.saxutils._NoopSAXHandler.processingInstruction" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.utils.saxutils._NoopSAXHandler.setDocumentLocator">
<code class="descname">setDocumentLocator</code><span class="sig-paren">(</span><em>locator</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.saxutils._NoopSAXHandler.setDocumentLocator" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.utils.saxutils._NoopSAXHandler.startDocument">
<code class="descname">startDocument</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.saxutils._NoopSAXHandler.startDocument" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.utils.saxutils._NoopSAXHandler.startElementNS">
<code class="descname">startElementNS</code><span class="sig-paren">(</span><em>name</em>, <em>qname</em>, <em>attrs</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.saxutils._NoopSAXHandler.startElementNS" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.utils.saxutils._NoopSAXHandler.startPrefixMapping">
<code class="descname">startPrefixMapping</code><span class="sig-paren">(</span><em>prefix</em>, <em>uri</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.saxutils._NoopSAXHandler.startPrefixMapping" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="function">
<dt id="pyxb.utils.saxutils.make_parser">
<code class="descclassname">pyxb.utils.saxutils.</code><code class="descname">make_parser</code><span class="sig-paren">(</span><em>**kw</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.saxutils.make_parser" title="Permalink to this definition">¶</a></dt>
<dd><p>Extend <code class="xref py py-obj docutils literal"><span class="pre">xml.sax.make_parser</span></code> to configure the parser the way we
need it:</p>
<blockquote>
<div><ul class="simple">
<li><code class="xref py py-obj docutils literal"><span class="pre">feature_namespaces</span></code> is set to <code class="xref py py-obj docutils literal"><span class="pre">True</span></code> so we process xmlns
directives properly</li>
<li><code class="xref py py-obj docutils literal"><span class="pre">feature_namespace_prefixes</span></code> is set to <code class="xref py py-obj docutils literal"><span class="pre">False</span></code> so we don’t get
prefixes encoded into our names (probably redundant with the above but
still...)</li>
</ul>
</div></blockquote>
<p>All keywords not documented here (and <code class="xref py py-obj docutils literal"><span class="pre">fallback_namespace</span></code>, which is) are
passed to the <code class="xref py py-obj docutils literal"><span class="pre">content_handler_constructor</span></code> if that must be invoked.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>content_handler</strong> – The content handler instance for the</td>
</tr>
</tbody>
</table>
<p>parser to use. If not provided, an instance of <code class="xref py py-obj docutils literal"><span class="pre">content_handler_constructor</span></code>
is created and used.
:type content_handler: <code class="xref py py-obj docutils literal"><span class="pre">xml.sax.handler.ContentHandler</span></code></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>content_handler_constructor</strong> – A callable which produces an</td>
</tr>
</tbody>
</table>
<p>appropriate instance of (a subclass of) <a class="reference internal" href="#pyxb.utils.saxutils.BaseSAXHandler" title="pyxb.utils.saxutils.BaseSAXHandler"><code class="xref py py-obj docutils literal"><span class="pre">BaseSAXHandler</span></code></a>. The default is
<a class="reference internal" href="#pyxb.utils.saxutils.BaseSAXHandler" title="pyxb.utils.saxutils.BaseSAXHandler"><code class="xref py py-obj docutils literal"><span class="pre">BaseSAXHandler</span></code></a>.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>fallback_namespace</strong> – The namespace to use for lookups of</td>
</tr>
</tbody>
</table>
<p>unqualified names in absent namespaces; see
<a class="reference internal" href="pyxb.namespace.html#pyxb.namespace.ExpandedName" title="pyxb.namespace.ExpandedName"><code class="xref py py-obj docutils literal"><span class="pre">pyxb.namespace.ExpandedName</span></code></a>. This keyword is not used by this
function, but is passed to the <code class="xref py py-obj docutils literal"><span class="pre">content_handler_constructor</span></code>.
:type fallback_namespace: <a class="reference internal" href="pyxb.namespace.html#pyxb.namespace.Namespace" title="pyxb.namespace.Namespace"><code class="xref py py-obj docutils literal"><span class="pre">pyxb.namespace.Namespace</span></code></a></p>
</dd></dl>
</div>
<div class="section" id="module-pyxb.utils.six">
<span id="pyxb-utils-six-module"></span><h2>pyxb.utils.six module<a class="headerlink" href="#module-pyxb.utils.six" title="Permalink to this headline">¶</a></h2>
<p>Utilities for writing code that runs on Python 2 and 3</p>
<dl class="class">
<dt id="pyxb.utils.six.Iterator">
<em class="property">class </em><code class="descclassname">pyxb.utils.six.</code><code class="descname">Iterator</code><a class="headerlink" href="#pyxb.utils.six.Iterator" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
<dl class="method">
<dt id="pyxb.utils.six.Iterator.next">
<code class="descname">next</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.six.Iterator.next" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="pyxb.utils.six.Module_six_moves_urllib">
<em class="property">class </em><code class="descclassname">pyxb.utils.six.</code><code class="descname">Module_six_moves_urllib</code><a class="headerlink" href="#pyxb.utils.six.Module_six_moves_urllib" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">module</span></code></p>
<p>Create a six.moves.urllib namespace that resembles the Python 3 namespace</p>
<dl class="attribute">
<dt id="pyxb.utils.six.Module_six_moves_urllib.error">
<code class="descname">error</code><em class="property"> = <module 'pyxb.utils.six.moves.urllib.error' (built-in)></em><a class="headerlink" href="#pyxb.utils.six.Module_six_moves_urllib.error" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six.Module_six_moves_urllib.parse">
<code class="descname">parse</code><em class="property"> = <module 'pyxb.utils.six.moves.urllib_parse' (built-in)></em><a class="headerlink" href="#pyxb.utils.six.Module_six_moves_urllib.parse" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six.Module_six_moves_urllib.request">
<code class="descname">request</code><em class="property"> = <module 'pyxb.utils.six.moves.urllib.request' (built-in)></em><a class="headerlink" href="#pyxb.utils.six.Module_six_moves_urllib.request" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six.Module_six_moves_urllib.response">
<code class="descname">response</code><em class="property"> = <module 'pyxb.utils.six.moves.urllib.response' (built-in)></em><a class="headerlink" href="#pyxb.utils.six.Module_six_moves_urllib.response" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six.Module_six_moves_urllib.robotparser">
<code class="descname">robotparser</code><em class="property"> = <module 'pyxb.utils.six.moves.urllib.robotparser' (built-in)></em><a class="headerlink" href="#pyxb.utils.six.Module_six_moves_urllib.robotparser" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="pyxb.utils.six.Module_six_moves_urllib_error">
<em class="property">class </em><code class="descclassname">pyxb.utils.six.</code><code class="descname">Module_six_moves_urllib_error</code><span class="sig-paren">(</span><em>name</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.six.Module_six_moves_urllib_error" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#pyxb.utils.six._LazyModule" title="pyxb.utils.six._LazyModule"><code class="xref py py-class docutils literal"><span class="pre">pyxb.utils.six._LazyModule</span></code></a></p>
<p>Lazy loading of moved objects in six.moves.urllib_error</p>
<dl class="attribute">
<dt id="pyxb.utils.six.Module_six_moves_urllib_error.ContentTooShortError">
<code class="descname">ContentTooShortError</code><a class="headerlink" href="#pyxb.utils.six.Module_six_moves_urllib_error.ContentTooShortError" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six.Module_six_moves_urllib_error.HTTPError">
<code class="descname">HTTPError</code><a class="headerlink" href="#pyxb.utils.six.Module_six_moves_urllib_error.HTTPError" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six.Module_six_moves_urllib_error.URLError">
<code class="descname">URLError</code><a class="headerlink" href="#pyxb.utils.six.Module_six_moves_urllib_error.URLError" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six.Module_six_moves_urllib_error._moved_attributes">
<code class="descname">_moved_attributes</code><em class="property"> = [<pyxb.utils.six.MovedAttribute object>, <pyxb.utils.six.MovedAttribute object>, <pyxb.utils.six.MovedAttribute object>]</em><a class="headerlink" href="#pyxb.utils.six.Module_six_moves_urllib_error._moved_attributes" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="pyxb.utils.six.Module_six_moves_urllib_parse">
<em class="property">class </em><code class="descclassname">pyxb.utils.six.</code><code class="descname">Module_six_moves_urllib_parse</code><span class="sig-paren">(</span><em>name</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.six.Module_six_moves_urllib_parse" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#pyxb.utils.six._LazyModule" title="pyxb.utils.six._LazyModule"><code class="xref py py-class docutils literal"><span class="pre">pyxb.utils.six._LazyModule</span></code></a></p>
<p>Lazy loading of moved objects in six.moves.urllib_parse</p>
<dl class="attribute">
<dt id="pyxb.utils.six.Module_six_moves_urllib_parse.ParseResult">
<code class="descname">ParseResult</code><a class="headerlink" href="#pyxb.utils.six.Module_six_moves_urllib_parse.ParseResult" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six.Module_six_moves_urllib_parse.SplitResult">
<code class="descname">SplitResult</code><a class="headerlink" href="#pyxb.utils.six.Module_six_moves_urllib_parse.SplitResult" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six.Module_six_moves_urllib_parse._moved_attributes">
<code class="descname">_moved_attributes</code><em class="property"> = [<pyxb.utils.six.MovedAttribute object>, <pyxb.utils.six.MovedAttribute object>, <pyxb.utils.six.MovedAttribute object>, <pyxb.utils.six.MovedAttribute object>, <pyxb.utils.six.MovedAttribute object>, <pyxb.utils.six.MovedAttribute object>, <pyxb.utils.six.MovedAttribute object>, <pyxb.utils.six.MovedAttribute object>, <pyxb.utils.six.MovedAttribute object>, <pyxb.utils.six.MovedAttribute object>, <pyxb.utils.six.MovedAttribute object>, <pyxb.utils.six.MovedAttribute object>, <pyxb.utils.six.MovedAttribute object>, <pyxb.utils.six.MovedAttribute object>, <pyxb.utils.six.MovedAttribute object>, <pyxb.utils.six.MovedAttribute object>, <pyxb.utils.six.MovedAttribute object>, <pyxb.utils.six.MovedAttribute object>, <pyxb.utils.six.MovedAttribute object>, <pyxb.utils.six.MovedAttribute object>, <pyxb.utils.six.MovedAttribute object>, <pyxb.utils.six.MovedAttribute object>, <pyxb.utils.six.MovedAttribute object>]</em><a class="headerlink" href="#pyxb.utils.six.Module_six_moves_urllib_parse._moved_attributes" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six.Module_six_moves_urllib_parse.parse_qs">
<code class="descname">parse_qs</code><a class="headerlink" href="#pyxb.utils.six.Module_six_moves_urllib_parse.parse_qs" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six.Module_six_moves_urllib_parse.parse_qsl">
<code class="descname">parse_qsl</code><a class="headerlink" href="#pyxb.utils.six.Module_six_moves_urllib_parse.parse_qsl" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six.Module_six_moves_urllib_parse.quote">
<code class="descname">quote</code><a class="headerlink" href="#pyxb.utils.six.Module_six_moves_urllib_parse.quote" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six.Module_six_moves_urllib_parse.quote_plus">
<code class="descname">quote_plus</code><a class="headerlink" href="#pyxb.utils.six.Module_six_moves_urllib_parse.quote_plus" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six.Module_six_moves_urllib_parse.splitquery">
<code class="descname">splitquery</code><a class="headerlink" href="#pyxb.utils.six.Module_six_moves_urllib_parse.splitquery" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six.Module_six_moves_urllib_parse.splittag">
<code class="descname">splittag</code><a class="headerlink" href="#pyxb.utils.six.Module_six_moves_urllib_parse.splittag" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six.Module_six_moves_urllib_parse.splituser">
<code class="descname">splituser</code><a class="headerlink" href="#pyxb.utils.six.Module_six_moves_urllib_parse.splituser" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six.Module_six_moves_urllib_parse.unquote">
<code class="descname">unquote</code><a class="headerlink" href="#pyxb.utils.six.Module_six_moves_urllib_parse.unquote" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six.Module_six_moves_urllib_parse.unquote_plus">
<code class="descname">unquote_plus</code><a class="headerlink" href="#pyxb.utils.six.Module_six_moves_urllib_parse.unquote_plus" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six.Module_six_moves_urllib_parse.urldefrag">
<code class="descname">urldefrag</code><a class="headerlink" href="#pyxb.utils.six.Module_six_moves_urllib_parse.urldefrag" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six.Module_six_moves_urllib_parse.urlencode">
<code class="descname">urlencode</code><a class="headerlink" href="#pyxb.utils.six.Module_six_moves_urllib_parse.urlencode" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six.Module_six_moves_urllib_parse.urljoin">
<code class="descname">urljoin</code><a class="headerlink" href="#pyxb.utils.six.Module_six_moves_urllib_parse.urljoin" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six.Module_six_moves_urllib_parse.urlsplit">
<code class="descname">urlsplit</code><a class="headerlink" href="#pyxb.utils.six.Module_six_moves_urllib_parse.urlsplit" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six.Module_six_moves_urllib_parse.urlunparse">
<code class="descname">urlunparse</code><a class="headerlink" href="#pyxb.utils.six.Module_six_moves_urllib_parse.urlunparse" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six.Module_six_moves_urllib_parse.urlunsplit">
<code class="descname">urlunsplit</code><a class="headerlink" href="#pyxb.utils.six.Module_six_moves_urllib_parse.urlunsplit" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six.Module_six_moves_urllib_parse.uses_fragment">
<code class="descname">uses_fragment</code><a class="headerlink" href="#pyxb.utils.six.Module_six_moves_urllib_parse.uses_fragment" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six.Module_six_moves_urllib_parse.uses_netloc">
<code class="descname">uses_netloc</code><a class="headerlink" href="#pyxb.utils.six.Module_six_moves_urllib_parse.uses_netloc" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six.Module_six_moves_urllib_parse.uses_params">
<code class="descname">uses_params</code><a class="headerlink" href="#pyxb.utils.six.Module_six_moves_urllib_parse.uses_params" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six.Module_six_moves_urllib_parse.uses_query">
<code class="descname">uses_query</code><a class="headerlink" href="#pyxb.utils.six.Module_six_moves_urllib_parse.uses_query" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six.Module_six_moves_urllib_parse.uses_relative">
<code class="descname">uses_relative</code><a class="headerlink" href="#pyxb.utils.six.Module_six_moves_urllib_parse.uses_relative" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="pyxb.utils.six.Module_six_moves_urllib_request">
<em class="property">class </em><code class="descclassname">pyxb.utils.six.</code><code class="descname">Module_six_moves_urllib_request</code><span class="sig-paren">(</span><em>name</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.six.Module_six_moves_urllib_request" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#pyxb.utils.six._LazyModule" title="pyxb.utils.six._LazyModule"><code class="xref py py-class docutils literal"><span class="pre">pyxb.utils.six._LazyModule</span></code></a></p>
<p>Lazy loading of moved objects in six.moves.urllib_request</p>
<dl class="attribute">
<dt id="pyxb.utils.six.Module_six_moves_urllib_request.AbstractBasicAuthHandler">
<code class="descname">AbstractBasicAuthHandler</code><a class="headerlink" href="#pyxb.utils.six.Module_six_moves_urllib_request.AbstractBasicAuthHandler" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six.Module_six_moves_urllib_request.AbstractDigestAuthHandler">
<code class="descname">AbstractDigestAuthHandler</code><a class="headerlink" href="#pyxb.utils.six.Module_six_moves_urllib_request.AbstractDigestAuthHandler" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six.Module_six_moves_urllib_request.BaseHandler">
<code class="descname">BaseHandler</code><a class="headerlink" href="#pyxb.utils.six.Module_six_moves_urllib_request.BaseHandler" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six.Module_six_moves_urllib_request.CacheFTPHandler">
<code class="descname">CacheFTPHandler</code><a class="headerlink" href="#pyxb.utils.six.Module_six_moves_urllib_request.CacheFTPHandler" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six.Module_six_moves_urllib_request.FTPHandler">
<code class="descname">FTPHandler</code><a class="headerlink" href="#pyxb.utils.six.Module_six_moves_urllib_request.FTPHandler" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six.Module_six_moves_urllib_request.FancyURLopener">
<code class="descname">FancyURLopener</code><a class="headerlink" href="#pyxb.utils.six.Module_six_moves_urllib_request.FancyURLopener" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six.Module_six_moves_urllib_request.FileHandler">
<code class="descname">FileHandler</code><a class="headerlink" href="#pyxb.utils.six.Module_six_moves_urllib_request.FileHandler" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six.Module_six_moves_urllib_request.HTTPBasicAuthHandler">
<code class="descname">HTTPBasicAuthHandler</code><a class="headerlink" href="#pyxb.utils.six.Module_six_moves_urllib_request.HTTPBasicAuthHandler" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six.Module_six_moves_urllib_request.HTTPCookieProcessor">
<code class="descname">HTTPCookieProcessor</code><a class="headerlink" href="#pyxb.utils.six.Module_six_moves_urllib_request.HTTPCookieProcessor" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six.Module_six_moves_urllib_request.HTTPDefaultErrorHandler">
<code class="descname">HTTPDefaultErrorHandler</code><a class="headerlink" href="#pyxb.utils.six.Module_six_moves_urllib_request.HTTPDefaultErrorHandler" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six.Module_six_moves_urllib_request.HTTPDigestAuthHandler">
<code class="descname">HTTPDigestAuthHandler</code><a class="headerlink" href="#pyxb.utils.six.Module_six_moves_urllib_request.HTTPDigestAuthHandler" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six.Module_six_moves_urllib_request.HTTPErrorProcessor">
<code class="descname">HTTPErrorProcessor</code><a class="headerlink" href="#pyxb.utils.six.Module_six_moves_urllib_request.HTTPErrorProcessor" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six.Module_six_moves_urllib_request.HTTPHandler">
<code class="descname">HTTPHandler</code><a class="headerlink" href="#pyxb.utils.six.Module_six_moves_urllib_request.HTTPHandler" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six.Module_six_moves_urllib_request.HTTPPasswordMgr">
<code class="descname">HTTPPasswordMgr</code><a class="headerlink" href="#pyxb.utils.six.Module_six_moves_urllib_request.HTTPPasswordMgr" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six.Module_six_moves_urllib_request.HTTPPasswordMgrWithDefaultRealm">
<code class="descname">HTTPPasswordMgrWithDefaultRealm</code><a class="headerlink" href="#pyxb.utils.six.Module_six_moves_urllib_request.HTTPPasswordMgrWithDefaultRealm" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six.Module_six_moves_urllib_request.HTTPRedirectHandler">
<code class="descname">HTTPRedirectHandler</code><a class="headerlink" href="#pyxb.utils.six.Module_six_moves_urllib_request.HTTPRedirectHandler" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six.Module_six_moves_urllib_request.HTTPSHandler">
<code class="descname">HTTPSHandler</code><a class="headerlink" href="#pyxb.utils.six.Module_six_moves_urllib_request.HTTPSHandler" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six.Module_six_moves_urllib_request.OpenerDirector">
<code class="descname">OpenerDirector</code><a class="headerlink" href="#pyxb.utils.six.Module_six_moves_urllib_request.OpenerDirector" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six.Module_six_moves_urllib_request.ProxyBasicAuthHandler">
<code class="descname">ProxyBasicAuthHandler</code><a class="headerlink" href="#pyxb.utils.six.Module_six_moves_urllib_request.ProxyBasicAuthHandler" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six.Module_six_moves_urllib_request.ProxyDigestAuthHandler">
<code class="descname">ProxyDigestAuthHandler</code><a class="headerlink" href="#pyxb.utils.six.Module_six_moves_urllib_request.ProxyDigestAuthHandler" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six.Module_six_moves_urllib_request.ProxyHandler">
<code class="descname">ProxyHandler</code><a class="headerlink" href="#pyxb.utils.six.Module_six_moves_urllib_request.ProxyHandler" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six.Module_six_moves_urllib_request.Request">
<code class="descname">Request</code><a class="headerlink" href="#pyxb.utils.six.Module_six_moves_urllib_request.Request" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six.Module_six_moves_urllib_request.URLopener">
<code class="descname">URLopener</code><a class="headerlink" href="#pyxb.utils.six.Module_six_moves_urllib_request.URLopener" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six.Module_six_moves_urllib_request.UnknownHandler">
<code class="descname">UnknownHandler</code><a class="headerlink" href="#pyxb.utils.six.Module_six_moves_urllib_request.UnknownHandler" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six.Module_six_moves_urllib_request._moved_attributes">
<code class="descname">_moved_attributes</code><em class="property"> = [<pyxb.utils.six.MovedAttribute object>, <pyxb.utils.six.MovedAttribute object>, <pyxb.utils.six.MovedAttribute object>, <pyxb.utils.six.MovedAttribute object>, <pyxb.utils.six.MovedAttribute object>, <pyxb.utils.six.MovedAttribute object>, <pyxb.utils.six.MovedAttribute object>, <pyxb.utils.six.MovedAttribute object>, <pyxb.utils.six.MovedAttribute object>, <pyxb.utils.six.MovedAttribute object>, <pyxb.utils.six.MovedAttribute object>, <pyxb.utils.six.MovedAttribute object>, <pyxb.utils.six.MovedAttribute object>, <pyxb.utils.six.MovedAttribute object>, <pyxb.utils.six.MovedAttribute object>, <pyxb.utils.six.MovedAttribute object>, <pyxb.utils.six.MovedAttribute object>, <pyxb.utils.six.MovedAttribute object>, <pyxb.utils.six.MovedAttribute object>, <pyxb.utils.six.MovedAttribute object>, <pyxb.utils.six.MovedAttribute object>, <pyxb.utils.six.MovedAttribute object>, <pyxb.utils.six.MovedAttribute object>, <pyxb.utils.six.MovedAttribute object>, <pyxb.utils.six.MovedAttribute object>, <pyxb.utils.six.MovedAttribute object>, <pyxb.utils.six.MovedAttribute object>, <pyxb.utils.six.MovedAttribute object>, <pyxb.utils.six.MovedAttribute object>, <pyxb.utils.six.MovedAttribute object>, <pyxb.utils.six.MovedAttribute object>, <pyxb.utils.six.MovedAttribute object>, <pyxb.utils.six.MovedAttribute object>]</em><a class="headerlink" href="#pyxb.utils.six.Module_six_moves_urllib_request._moved_attributes" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six.Module_six_moves_urllib_request.build_opener">
<code class="descname">build_opener</code><a class="headerlink" href="#pyxb.utils.six.Module_six_moves_urllib_request.build_opener" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six.Module_six_moves_urllib_request.getproxies">
<code class="descname">getproxies</code><a class="headerlink" href="#pyxb.utils.six.Module_six_moves_urllib_request.getproxies" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six.Module_six_moves_urllib_request.install_opener">
<code class="descname">install_opener</code><a class="headerlink" href="#pyxb.utils.six.Module_six_moves_urllib_request.install_opener" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six.Module_six_moves_urllib_request.pathname2url">
<code class="descname">pathname2url</code><a class="headerlink" href="#pyxb.utils.six.Module_six_moves_urllib_request.pathname2url" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six.Module_six_moves_urllib_request.proxy_bypass">
<code class="descname">proxy_bypass</code><a class="headerlink" href="#pyxb.utils.six.Module_six_moves_urllib_request.proxy_bypass" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six.Module_six_moves_urllib_request.url2pathname">
<code class="descname">url2pathname</code><a class="headerlink" href="#pyxb.utils.six.Module_six_moves_urllib_request.url2pathname" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six.Module_six_moves_urllib_request.urlcleanup">
<code class="descname">urlcleanup</code><a class="headerlink" href="#pyxb.utils.six.Module_six_moves_urllib_request.urlcleanup" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six.Module_six_moves_urllib_request.urlopen">
<code class="descname">urlopen</code><a class="headerlink" href="#pyxb.utils.six.Module_six_moves_urllib_request.urlopen" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six.Module_six_moves_urllib_request.urlretrieve">
<code class="descname">urlretrieve</code><a class="headerlink" href="#pyxb.utils.six.Module_six_moves_urllib_request.urlretrieve" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="pyxb.utils.six.Module_six_moves_urllib_response">
<em class="property">class </em><code class="descclassname">pyxb.utils.six.</code><code class="descname">Module_six_moves_urllib_response</code><span class="sig-paren">(</span><em>name</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.six.Module_six_moves_urllib_response" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#pyxb.utils.six._LazyModule" title="pyxb.utils.six._LazyModule"><code class="xref py py-class docutils literal"><span class="pre">pyxb.utils.six._LazyModule</span></code></a></p>
<p>Lazy loading of moved objects in six.moves.urllib_response</p>
<dl class="attribute">
<dt id="pyxb.utils.six.Module_six_moves_urllib_response._moved_attributes">
<code class="descname">_moved_attributes</code><em class="property"> = [<pyxb.utils.six.MovedAttribute object>, <pyxb.utils.six.MovedAttribute object>, <pyxb.utils.six.MovedAttribute object>, <pyxb.utils.six.MovedAttribute object>]</em><a class="headerlink" href="#pyxb.utils.six.Module_six_moves_urllib_response._moved_attributes" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six.Module_six_moves_urllib_response.addbase">
<code class="descname">addbase</code><a class="headerlink" href="#pyxb.utils.six.Module_six_moves_urllib_response.addbase" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six.Module_six_moves_urllib_response.addclosehook">
<code class="descname">addclosehook</code><a class="headerlink" href="#pyxb.utils.six.Module_six_moves_urllib_response.addclosehook" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six.Module_six_moves_urllib_response.addinfo">
<code class="descname">addinfo</code><a class="headerlink" href="#pyxb.utils.six.Module_six_moves_urllib_response.addinfo" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six.Module_six_moves_urllib_response.addinfourl">
<code class="descname">addinfourl</code><a class="headerlink" href="#pyxb.utils.six.Module_six_moves_urllib_response.addinfourl" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="pyxb.utils.six.Module_six_moves_urllib_robotparser">
<em class="property">class </em><code class="descclassname">pyxb.utils.six.</code><code class="descname">Module_six_moves_urllib_robotparser</code><span class="sig-paren">(</span><em>name</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.six.Module_six_moves_urllib_robotparser" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#pyxb.utils.six._LazyModule" title="pyxb.utils.six._LazyModule"><code class="xref py py-class docutils literal"><span class="pre">pyxb.utils.six._LazyModule</span></code></a></p>
<p>Lazy loading of moved objects in six.moves.urllib_robotparser</p>
<dl class="attribute">
<dt id="pyxb.utils.six.Module_six_moves_urllib_robotparser.RobotFileParser">
<code class="descname">RobotFileParser</code><a class="headerlink" href="#pyxb.utils.six.Module_six_moves_urllib_robotparser.RobotFileParser" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six.Module_six_moves_urllib_robotparser._moved_attributes">
<code class="descname">_moved_attributes</code><em class="property"> = [<pyxb.utils.six.MovedAttribute object>]</em><a class="headerlink" href="#pyxb.utils.six.Module_six_moves_urllib_robotparser._moved_attributes" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="pyxb.utils.six.MovedAttribute">
<em class="property">class </em><code class="descclassname">pyxb.utils.six.</code><code class="descname">MovedAttribute</code><span class="sig-paren">(</span><em>name</em>, <em>old_mod</em>, <em>new_mod</em>, <em>old_attr=None</em>, <em>new_attr=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.six.MovedAttribute" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#pyxb.utils.six._LazyDescr" title="pyxb.utils.six._LazyDescr"><code class="xref py py-class docutils literal"><span class="pre">pyxb.utils.six._LazyDescr</span></code></a></p>
<dl class="method">
<dt id="pyxb.utils.six.MovedAttribute._resolve">
<code class="descname">_resolve</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.six.MovedAttribute._resolve" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="pyxb.utils.six.MovedModule">
<em class="property">class </em><code class="descclassname">pyxb.utils.six.</code><code class="descname">MovedModule</code><span class="sig-paren">(</span><em>name</em>, <em>old</em>, <em>new=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.six.MovedModule" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#pyxb.utils.six._LazyDescr" title="pyxb.utils.six._LazyDescr"><code class="xref py py-class docutils literal"><span class="pre">pyxb.utils.six._LazyDescr</span></code></a></p>
<dl class="method">
<dt id="pyxb.utils.six.MovedModule._resolve">
<code class="descname">_resolve</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.six.MovedModule._resolve" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="pyxb.utils.six._LazyDescr">
<em class="property">class </em><code class="descclassname">pyxb.utils.six.</code><code class="descname">_LazyDescr</code><span class="sig-paren">(</span><em>name</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.six._LazyDescr" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
</dd></dl>
<dl class="class">
<dt id="pyxb.utils.six._LazyModule">
<em class="property">class </em><code class="descclassname">pyxb.utils.six.</code><code class="descname">_LazyModule</code><span class="sig-paren">(</span><em>name</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.six._LazyModule" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">module</span></code></p>
<dl class="attribute">
<dt id="pyxb.utils.six._LazyModule._moved_attributes">
<code class="descname">_moved_attributes</code><em class="property"> = []</em><a class="headerlink" href="#pyxb.utils.six._LazyModule._moved_attributes" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="pyxb.utils.six._MovedItems">
<em class="property">class </em><code class="descclassname">pyxb.utils.six.</code><code class="descname">_MovedItems</code><span class="sig-paren">(</span><em>name</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.six._MovedItems" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#pyxb.utils.six._LazyModule" title="pyxb.utils.six._LazyModule"><code class="xref py py-class docutils literal"><span class="pre">pyxb.utils.six._LazyModule</span></code></a></p>
<p>Lazy loading of moved objects</p>
<dl class="attribute">
<dt id="pyxb.utils.six._MovedItems.BaseHTTPServer">
<code class="descname">BaseHTTPServer</code><a class="headerlink" href="#pyxb.utils.six._MovedItems.BaseHTTPServer" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six._MovedItems.CGIHTTPServer">
<code class="descname">CGIHTTPServer</code><a class="headerlink" href="#pyxb.utils.six._MovedItems.CGIHTTPServer" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six._MovedItems.SimpleHTTPServer">
<code class="descname">SimpleHTTPServer</code><a class="headerlink" href="#pyxb.utils.six._MovedItems.SimpleHTTPServer" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six._MovedItems.StringIO">
<code class="descname">StringIO</code><a class="headerlink" href="#pyxb.utils.six._MovedItems.StringIO" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six._MovedItems.UserDict">
<code class="descname">UserDict</code><a class="headerlink" href="#pyxb.utils.six._MovedItems.UserDict" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six._MovedItems.UserList">
<code class="descname">UserList</code><a class="headerlink" href="#pyxb.utils.six._MovedItems.UserList" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six._MovedItems.UserString">
<code class="descname">UserString</code><a class="headerlink" href="#pyxb.utils.six._MovedItems.UserString" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six._MovedItems._dummy_thread">
<code class="descname">_dummy_thread</code><a class="headerlink" href="#pyxb.utils.six._MovedItems._dummy_thread" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six._MovedItems._moved_attributes">
<code class="descname">_moved_attributes</code><em class="property"> = [<pyxb.utils.six.MovedAttribute object>, <pyxb.utils.six.MovedAttribute object>, <pyxb.utils.six.MovedAttribute object>, <pyxb.utils.six.MovedAttribute object>, <pyxb.utils.six.MovedAttribute object>, <pyxb.utils.six.MovedAttribute object>, <pyxb.utils.six.MovedAttribute object>, <pyxb.utils.six.MovedAttribute object>, <pyxb.utils.six.MovedAttribute object>, <pyxb.utils.six.MovedAttribute object>, <pyxb.utils.six.MovedAttribute object>, <pyxb.utils.six.MovedAttribute object>, <pyxb.utils.six.MovedAttribute object>, <pyxb.utils.six.MovedAttribute object>, <pyxb.utils.six.MovedAttribute object>, <pyxb.utils.six.MovedAttribute object>, <pyxb.utils.six.MovedAttribute object>, <pyxb.utils.six.MovedAttribute object>, <pyxb.utils.six.MovedAttribute object>, <pyxb.utils.six.MovedAttribute object>, <pyxb.utils.six.MovedModule object>, <pyxb.utils.six.MovedModule object>, <pyxb.utils.six.MovedModule object>, <pyxb.utils.six.MovedModule object>, <pyxb.utils.six.MovedModule object>, <pyxb.utils.six.MovedModule object>, <pyxb.utils.six.MovedModule object>, <pyxb.utils.six.MovedModule object>, <pyxb.utils.six.MovedModule object>, <pyxb.utils.six.MovedModule object>, <pyxb.utils.six.MovedModule object>, <pyxb.utils.six.MovedModule object>, <pyxb.utils.six.MovedModule object>, <pyxb.utils.six.MovedModule object>, <pyxb.utils.six.MovedModule object>, <pyxb.utils.six.MovedModule object>, <pyxb.utils.six.MovedModule object>, <pyxb.utils.six.MovedModule object>, <pyxb.utils.six.MovedModule object>, <pyxb.utils.six.MovedModule object>, <pyxb.utils.six.MovedModule object>, <pyxb.utils.six.MovedModule object>, <pyxb.utils.six.MovedModule object>, <pyxb.utils.six.MovedModule object>, <pyxb.utils.six.MovedModule object>, <pyxb.utils.six.MovedModule object>, <pyxb.utils.six.MovedModule object>, <pyxb.utils.six.MovedModule object>, <pyxb.utils.six.MovedModule object>, <pyxb.utils.six.MovedModule object>, <pyxb.utils.six.MovedModule object>, <pyxb.utils.six.MovedModule object>, <pyxb.utils.six.MovedModule object>, <pyxb.utils.six.MovedModule object>, <pyxb.utils.six.MovedModule object>, <pyxb.utils.six.MovedModule object>, <pyxb.utils.six.MovedModule object>, <pyxb.utils.six.MovedModule object>, <pyxb.utils.six.MovedModule object>, <pyxb.utils.six.MovedModule object>, <pyxb.utils.six.MovedModule object>, <pyxb.utils.six.MovedModule object>, <pyxb.utils.six.MovedModule object>]</em><a class="headerlink" href="#pyxb.utils.six._MovedItems._moved_attributes" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six._MovedItems._thread">
<code class="descname">_thread</code><a class="headerlink" href="#pyxb.utils.six._MovedItems._thread" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six._MovedItems.cStringIO">
<code class="descname">cStringIO</code><a class="headerlink" href="#pyxb.utils.six._MovedItems.cStringIO" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six._MovedItems.configparser">
<code class="descname">configparser</code><a class="headerlink" href="#pyxb.utils.six._MovedItems.configparser" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six._MovedItems.copyreg">
<code class="descname">copyreg</code><a class="headerlink" href="#pyxb.utils.six._MovedItems.copyreg" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six._MovedItems.dbm_gnu">
<code class="descname">dbm_gnu</code><a class="headerlink" href="#pyxb.utils.six._MovedItems.dbm_gnu" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six._MovedItems.email_mime_base">
<code class="descname">email_mime_base</code><a class="headerlink" href="#pyxb.utils.six._MovedItems.email_mime_base" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six._MovedItems.email_mime_multipart">
<code class="descname">email_mime_multipart</code><a class="headerlink" href="#pyxb.utils.six._MovedItems.email_mime_multipart" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six._MovedItems.email_mime_nonmultipart">
<code class="descname">email_mime_nonmultipart</code><a class="headerlink" href="#pyxb.utils.six._MovedItems.email_mime_nonmultipart" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six._MovedItems.email_mime_text">
<code class="descname">email_mime_text</code><a class="headerlink" href="#pyxb.utils.six._MovedItems.email_mime_text" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six._MovedItems.file">
<code class="descname">file</code><a class="headerlink" href="#pyxb.utils.six._MovedItems.file" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six._MovedItems.filter">
<code class="descname">filter</code><a class="headerlink" href="#pyxb.utils.six._MovedItems.filter" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six._MovedItems.filterfalse">
<code class="descname">filterfalse</code><a class="headerlink" href="#pyxb.utils.six._MovedItems.filterfalse" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six._MovedItems.getcwd">
<code class="descname">getcwd</code><a class="headerlink" href="#pyxb.utils.six._MovedItems.getcwd" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six._MovedItems.getcwdb">
<code class="descname">getcwdb</code><a class="headerlink" href="#pyxb.utils.six._MovedItems.getcwdb" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six._MovedItems.html_entities">
<code class="descname">html_entities</code><a class="headerlink" href="#pyxb.utils.six._MovedItems.html_entities" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six._MovedItems.html_parser">
<code class="descname">html_parser</code><a class="headerlink" href="#pyxb.utils.six._MovedItems.html_parser" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six._MovedItems.http_client">
<code class="descname">http_client</code><a class="headerlink" href="#pyxb.utils.six._MovedItems.http_client" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six._MovedItems.http_cookiejar">
<code class="descname">http_cookiejar</code><a class="headerlink" href="#pyxb.utils.six._MovedItems.http_cookiejar" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six._MovedItems.http_cookies">
<code class="descname">http_cookies</code><a class="headerlink" href="#pyxb.utils.six._MovedItems.http_cookies" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six._MovedItems.input">
<code class="descname">input</code><a class="headerlink" href="#pyxb.utils.six._MovedItems.input" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six._MovedItems.map">
<code class="descname">map</code><a class="headerlink" href="#pyxb.utils.six._MovedItems.map" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six._MovedItems.queue">
<code class="descname">queue</code><a class="headerlink" href="#pyxb.utils.six._MovedItems.queue" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six._MovedItems.range">
<code class="descname">range</code><a class="headerlink" href="#pyxb.utils.six._MovedItems.range" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six._MovedItems.reduce">
<code class="descname">reduce</code><a class="headerlink" href="#pyxb.utils.six._MovedItems.reduce" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six._MovedItems.reload_module">
<code class="descname">reload_module</code><a class="headerlink" href="#pyxb.utils.six._MovedItems.reload_module" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six._MovedItems.reprlib">
<code class="descname">reprlib</code><a class="headerlink" href="#pyxb.utils.six._MovedItems.reprlib" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six._MovedItems.shlex_quote">
<code class="descname">shlex_quote</code><a class="headerlink" href="#pyxb.utils.six._MovedItems.shlex_quote" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six._MovedItems.socketserver">
<code class="descname">socketserver</code><a class="headerlink" href="#pyxb.utils.six._MovedItems.socketserver" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six._MovedItems.tkinter">
<code class="descname">tkinter</code><a class="headerlink" href="#pyxb.utils.six._MovedItems.tkinter" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six._MovedItems.tkinter_colorchooser">
<code class="descname">tkinter_colorchooser</code><a class="headerlink" href="#pyxb.utils.six._MovedItems.tkinter_colorchooser" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six._MovedItems.tkinter_commondialog">
<code class="descname">tkinter_commondialog</code><a class="headerlink" href="#pyxb.utils.six._MovedItems.tkinter_commondialog" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six._MovedItems.tkinter_constants">
<code class="descname">tkinter_constants</code><a class="headerlink" href="#pyxb.utils.six._MovedItems.tkinter_constants" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six._MovedItems.tkinter_dialog">
<code class="descname">tkinter_dialog</code><a class="headerlink" href="#pyxb.utils.six._MovedItems.tkinter_dialog" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six._MovedItems.tkinter_dnd">
<code class="descname">tkinter_dnd</code><a class="headerlink" href="#pyxb.utils.six._MovedItems.tkinter_dnd" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six._MovedItems.tkinter_filedialog">
<code class="descname">tkinter_filedialog</code><a class="headerlink" href="#pyxb.utils.six._MovedItems.tkinter_filedialog" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six._MovedItems.tkinter_font">
<code class="descname">tkinter_font</code><a class="headerlink" href="#pyxb.utils.six._MovedItems.tkinter_font" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six._MovedItems.tkinter_messagebox">
<code class="descname">tkinter_messagebox</code><a class="headerlink" href="#pyxb.utils.six._MovedItems.tkinter_messagebox" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six._MovedItems.tkinter_scrolledtext">
<code class="descname">tkinter_scrolledtext</code><a class="headerlink" href="#pyxb.utils.six._MovedItems.tkinter_scrolledtext" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six._MovedItems.tkinter_simpledialog">
<code class="descname">tkinter_simpledialog</code><a class="headerlink" href="#pyxb.utils.six._MovedItems.tkinter_simpledialog" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six._MovedItems.tkinter_tix">
<code class="descname">tkinter_tix</code><a class="headerlink" href="#pyxb.utils.six._MovedItems.tkinter_tix" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six._MovedItems.tkinter_tkfiledialog">
<code class="descname">tkinter_tkfiledialog</code><a class="headerlink" href="#pyxb.utils.six._MovedItems.tkinter_tkfiledialog" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six._MovedItems.tkinter_tksimpledialog">
<code class="descname">tkinter_tksimpledialog</code><a class="headerlink" href="#pyxb.utils.six._MovedItems.tkinter_tksimpledialog" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six._MovedItems.tkinter_ttk">
<code class="descname">tkinter_ttk</code><a class="headerlink" href="#pyxb.utils.six._MovedItems.tkinter_ttk" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six._MovedItems.urllib">
<code class="descname">urllib</code><a class="headerlink" href="#pyxb.utils.six._MovedItems.urllib" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six._MovedItems.urllib_error">
<code class="descname">urllib_error</code><a class="headerlink" href="#pyxb.utils.six._MovedItems.urllib_error" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six._MovedItems.urllib_parse">
<code class="descname">urllib_parse</code><a class="headerlink" href="#pyxb.utils.six._MovedItems.urllib_parse" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six._MovedItems.urllib_robotparser">
<code class="descname">urllib_robotparser</code><a class="headerlink" href="#pyxb.utils.six._MovedItems.urllib_robotparser" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six._MovedItems.xmlrpc_client">
<code class="descname">xmlrpc_client</code><a class="headerlink" href="#pyxb.utils.six._MovedItems.xmlrpc_client" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six._MovedItems.xmlrpc_server">
<code class="descname">xmlrpc_server</code><a class="headerlink" href="#pyxb.utils.six._MovedItems.xmlrpc_server" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six._MovedItems.zip">
<code class="descname">zip</code><a class="headerlink" href="#pyxb.utils.six._MovedItems.zip" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.six._MovedItems.zip_longest">
<code class="descname">zip_longest</code><a class="headerlink" href="#pyxb.utils.six._MovedItems.zip_longest" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="pyxb.utils.six._SixMetaPathImporter">
<em class="property">class </em><code class="descclassname">pyxb.utils.six.</code><code class="descname">_SixMetaPathImporter</code><span class="sig-paren">(</span><em>six_module_name</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.six._SixMetaPathImporter" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
<p>A meta path importer to import six.moves and its submodules.</p>
<p>This class implements a PEP302 finder and loader. It should be compatible
with Python 2.5 and all existing versions of Python3</p>
<dl class="method">
<dt id="pyxb.utils.six._SixMetaPathImporter._SixMetaPathImporter__get_module">
<code class="descname">_SixMetaPathImporter__get_module</code><span class="sig-paren">(</span><em>fullname</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.six._SixMetaPathImporter._SixMetaPathImporter__get_module" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.utils.six._SixMetaPathImporter._add_module">
<code class="descname">_add_module</code><span class="sig-paren">(</span><em>mod</em>, <em>*fullnames</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.six._SixMetaPathImporter._add_module" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.utils.six._SixMetaPathImporter._get_module">
<code class="descname">_get_module</code><span class="sig-paren">(</span><em>fullname</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.six._SixMetaPathImporter._get_module" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.utils.six._SixMetaPathImporter.find_module">
<code class="descname">find_module</code><span class="sig-paren">(</span><em>fullname</em>, <em>path=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.six._SixMetaPathImporter.find_module" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.utils.six._SixMetaPathImporter.get_code">
<code class="descname">get_code</code><span class="sig-paren">(</span><em>fullname</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.six._SixMetaPathImporter.get_code" title="Permalink to this definition">¶</a></dt>
<dd><p>Return None</p>
<p>Required, if is_package is implemented</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.six._SixMetaPathImporter.get_source">
<code class="descname">get_source</code><span class="sig-paren">(</span><em>fullname</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.six._SixMetaPathImporter.get_source" title="Permalink to this definition">¶</a></dt>
<dd><p>Return None</p>
<p>Required, if is_package is implemented</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.six._SixMetaPathImporter.is_package">
<code class="descname">is_package</code><span class="sig-paren">(</span><em>fullname</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.six._SixMetaPathImporter.is_package" title="Permalink to this definition">¶</a></dt>
<dd><p>Return true, if the named module is a package.</p>
<p>We need this method to get correct spec objects with
Python 3.4 (see PEP451)</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.six._SixMetaPathImporter.load_module">
<code class="descname">load_module</code><span class="sig-paren">(</span><em>fullname</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.six._SixMetaPathImporter.load_module" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="function">
<dt id="pyxb.utils.six._add_doc">
<code class="descclassname">pyxb.utils.six.</code><code class="descname">_add_doc</code><span class="sig-paren">(</span><em>func</em>, <em>doc</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.six._add_doc" title="Permalink to this definition">¶</a></dt>
<dd><p>Add documentation to a function.</p>
</dd></dl>
<dl class="function">
<dt id="pyxb.utils.six._import_module">
<code class="descclassname">pyxb.utils.six.</code><code class="descname">_import_module</code><span class="sig-paren">(</span><em>name</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.six._import_module" title="Permalink to this definition">¶</a></dt>
<dd><p>Import module, returning the module after the last dot.</p>
</dd></dl>
<dl class="function">
<dt id="pyxb.utils.six.add_metaclass">
<code class="descclassname">pyxb.utils.six.</code><code class="descname">add_metaclass</code><span class="sig-paren">(</span><em>metaclass</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.six.add_metaclass" title="Permalink to this definition">¶</a></dt>
<dd><p>Class decorator for creating a class with a metaclass.</p>
</dd></dl>
<dl class="function">
<dt id="pyxb.utils.six.add_move">
<code class="descclassname">pyxb.utils.six.</code><code class="descname">add_move</code><span class="sig-paren">(</span><em>move</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.six.add_move" title="Permalink to this definition">¶</a></dt>
<dd><p>Add an item to six.moves.</p>
</dd></dl>
<dl class="function">
<dt id="pyxb.utils.six.assertCountEqual">
<code class="descclassname">pyxb.utils.six.</code><code class="descname">assertCountEqual</code><span class="sig-paren">(</span><em>self</em>, <em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.six.assertCountEqual" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="function">
<dt id="pyxb.utils.six.assertRaisesRegex">
<code class="descclassname">pyxb.utils.six.</code><code class="descname">assertRaisesRegex</code><span class="sig-paren">(</span><em>self</em>, <em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.six.assertRaisesRegex" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="function">
<dt id="pyxb.utils.six.assertRegex">
<code class="descclassname">pyxb.utils.six.</code><code class="descname">assertRegex</code><span class="sig-paren">(</span><em>self</em>, <em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.six.assertRegex" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="function">
<dt id="pyxb.utils.six.b">
<code class="descclassname">pyxb.utils.six.</code><code class="descname">b</code><span class="sig-paren">(</span><em>s</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.six.b" title="Permalink to this definition">¶</a></dt>
<dd><p>Byte literal</p>
</dd></dl>
<dl class="function">
<dt id="pyxb.utils.six.byte2int">
<code class="descclassname">pyxb.utils.six.</code><code class="descname">byte2int</code><span class="sig-paren">(</span><em>bs</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.six.byte2int" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="function">
<dt id="pyxb.utils.six.create_bound_method">
<code class="descclassname">pyxb.utils.six.</code><code class="descname">create_bound_method</code><span class="sig-paren">(</span><em>func</em>, <em>obj</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.six.create_bound_method" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="function">
<dt id="pyxb.utils.six.create_unbound_method">
<code class="descclassname">pyxb.utils.six.</code><code class="descname">create_unbound_method</code><span class="sig-paren">(</span><em>func</em>, <em>cls</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.six.create_unbound_method" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="function">
<dt id="pyxb.utils.six.exec_">
<code class="descclassname">pyxb.utils.six.</code><code class="descname">exec_</code><span class="sig-paren">(</span><em>_code_</em>, <em>_globs_=None</em>, <em>_locs_=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.six.exec_" title="Permalink to this definition">¶</a></dt>
<dd><p>Execute code in a namespace.</p>
</dd></dl>
<dl class="function">
<dt id="pyxb.utils.six.get_unbound_function">
<code class="descclassname">pyxb.utils.six.</code><code class="descname">get_unbound_function</code><span class="sig-paren">(</span><em>unbound</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.six.get_unbound_function" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the function out of a possibly unbound function</p>
</dd></dl>
<dl class="function">
<dt id="pyxb.utils.six.indexbytes">
<code class="descclassname">pyxb.utils.six.</code><code class="descname">indexbytes</code><span class="sig-paren">(</span><em>buf</em>, <em>i</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.six.indexbytes" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="function">
<dt id="pyxb.utils.six.iteritems">
<code class="descclassname">pyxb.utils.six.</code><code class="descname">iteritems</code><span class="sig-paren">(</span><em>d</em>, <em>**kw</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.six.iteritems" title="Permalink to this definition">¶</a></dt>
<dd><p>Return an iterator over the (key, value) pairs of a dictionary.</p>
</dd></dl>
<dl class="function">
<dt id="pyxb.utils.six.iterkeys">
<code class="descclassname">pyxb.utils.six.</code><code class="descname">iterkeys</code><span class="sig-paren">(</span><em>d</em>, <em>**kw</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.six.iterkeys" title="Permalink to this definition">¶</a></dt>
<dd><p>Return an iterator over the keys of a dictionary.</p>
</dd></dl>
<dl class="function">
<dt id="pyxb.utils.six.iterlists">
<code class="descclassname">pyxb.utils.six.</code><code class="descname">iterlists</code><span class="sig-paren">(</span><em>d</em>, <em>**kw</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.six.iterlists" title="Permalink to this definition">¶</a></dt>
<dd><p>Return an iterator over the (key, [values]) pairs of a dictionary.</p>
</dd></dl>
<dl class="function">
<dt id="pyxb.utils.six.itervalues">
<code class="descclassname">pyxb.utils.six.</code><code class="descname">itervalues</code><span class="sig-paren">(</span><em>d</em>, <em>**kw</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.six.itervalues" title="Permalink to this definition">¶</a></dt>
<dd><p>Return an iterator over the values of a dictionary.</p>
</dd></dl>
<dl class="function">
<dt id="pyxb.utils.six.print_">
<code class="descclassname">pyxb.utils.six.</code><code class="descname">print_</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.six.print_" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="function">
<dt id="pyxb.utils.six.python_2_unicode_compatible">
<code class="descclassname">pyxb.utils.six.</code><code class="descname">python_2_unicode_compatible</code><span class="sig-paren">(</span><em>klass</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.six.python_2_unicode_compatible" title="Permalink to this definition">¶</a></dt>
<dd><p>A decorator that defines __unicode__ and __str__ methods under Python 2.
Under Python 3 it does nothing.</p>
<p>To support Python 2 and 3 with a single code base, define a __str__ method
returning text and apply this decorator to the class.</p>
</dd></dl>
<dl class="function">
<dt id="pyxb.utils.six.raise_from">
<code class="descclassname">pyxb.utils.six.</code><code class="descname">raise_from</code><span class="sig-paren">(</span><em>value</em>, <em>from_value</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.six.raise_from" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="function">
<dt id="pyxb.utils.six.remove_move">
<code class="descclassname">pyxb.utils.six.</code><code class="descname">remove_move</code><span class="sig-paren">(</span><em>name</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.six.remove_move" title="Permalink to this definition">¶</a></dt>
<dd><p>Remove item from six.moves.</p>
</dd></dl>
<dl class="function">
<dt id="pyxb.utils.six.reraise">
<code class="descclassname">pyxb.utils.six.</code><code class="descname">reraise</code><span class="sig-paren">(</span><em>tp</em>, <em>value</em>, <em>tb=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.six.reraise" title="Permalink to this definition">¶</a></dt>
<dd><p>Reraise an exception.</p>
</dd></dl>
<dl class="function">
<dt id="pyxb.utils.six.u">
<code class="descclassname">pyxb.utils.six.</code><code class="descname">u</code><span class="sig-paren">(</span><em>s</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.six.u" title="Permalink to this definition">¶</a></dt>
<dd><p>Text literal</p>
</dd></dl>
<dl class="function">
<dt id="pyxb.utils.six.with_metaclass">
<code class="descclassname">pyxb.utils.six.</code><code class="descname">with_metaclass</code><span class="sig-paren">(</span><em>meta</em>, <em>*bases</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.six.with_metaclass" title="Permalink to this definition">¶</a></dt>
<dd><p>Create a base class with a metaclass.</p>
</dd></dl>
<dl class="function">
<dt id="pyxb.utils.six.wraps">
<code class="descclassname">pyxb.utils.six.</code><code class="descname">wraps</code><span class="sig-paren">(</span><em>wrapped</em>, <em>assigned=('__module__'</em>, <em>'__name__'</em>, <em>'__doc__')</em>, <em>updated=('__dict__'</em>, <em>)</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.six.wraps" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</div>
<div class="section" id="module-pyxb.utils.templates">
<span id="pyxb-utils-templates-module"></span><h2>pyxb.utils.templates module<a class="headerlink" href="#module-pyxb.utils.templates" title="Permalink to this headline">¶</a></h2>
<p>Functions that aid with generating text from templates and maps.</p>
<dl class="function">
<dt id="pyxb.utils.templates._bodyConditionalPattern">
<code class="descclassname">pyxb.utils.templates.</code><code class="descname">_bodyConditionalPattern</code><span class="sig-paren">(</span><em>match_object</em>, <em>dictionary</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.templates._bodyConditionalPattern" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="function">
<dt id="pyxb.utils.templates._bodyIfDefinedPattern">
<code class="descclassname">pyxb.utils.templates.</code><code class="descname">_bodyIfDefinedPattern</code><span class="sig-paren">(</span><em>match_object</em>, <em>dictionary</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.templates._bodyIfDefinedPattern" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="function">
<dt id="pyxb.utils.templates.replaceInText">
<code class="descclassname">pyxb.utils.templates.</code><code class="descname">replaceInText</code><span class="sig-paren">(</span><em>text</em>, <em>**dictionary</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.templates.replaceInText" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</div>
<div class="section" id="module-pyxb.utils.unicode">
<span id="pyxb-utils-unicode-module"></span><h2>pyxb.utils.unicode module<a class="headerlink" href="#module-pyxb.utils.unicode" title="Permalink to this headline">¶</a></h2>
<p>This module contains support for Unicode characters as required to
support the regular expression syntax defined in U{annex F
<<a class="reference external" href="http://www/Documentation/W3C/www.w3.org/TR/xmlschema-2/index.html#regexs">http://www/Documentation/W3C/www.w3.org/TR/xmlschema-2/index.html#regexs</a>>}
of the XML Schema definition.</p>
<p>In particular, we need to be able to identify character properties and
block escapes, as defined in F.1.1, by name.</p>
<blockquote>
<div><ul class="simple">
<li>Block data: <a class="reference external" href="http://www.unicode.org/Public/3.1-Update/Blocks-4.txt">http://www.unicode.org/Public/3.1-Update/Blocks-4.txt</a></li>
<li>Property list data: <a class="reference external" href="http://www.unicode.org/Public/3.1-Update/PropList-3.1.0.txt">http://www.unicode.org/Public/3.1-Update/PropList-3.1.0.txt</a></li>
<li>Full dataset: <a class="reference external" href="http://www.unicode.org/Public/3.1-Update/UnicodeData-3.1.0.txt">http://www.unicode.org/Public/3.1-Update/UnicodeData-3.1.0.txt</a></li>
</ul>
</div></blockquote>
<p>The Unicode database active at the time XML Schema 1.0 was defined is
archived at
<a class="reference external" href="http://www.unicode.org/Public/3.1-Update/UnicodeCharacterDatabase-3.1.0.html">http://www.unicode.org/Public/3.1-Update/UnicodeCharacterDatabase-3.1.0.html</a>,
and refers to U{Unicode Standard Annex #27: Unicode 3.1
<<a class="reference external" href="http://www.unicode.org/unicode/reports/tr27/">http://www.unicode.org/unicode/reports/tr27/</a>>}.</p>
<dl class="class">
<dt id="pyxb.utils.unicode.CodePointSet">
<em class="property">class </em><code class="descclassname">pyxb.utils.unicode.</code><code class="descname">CodePointSet</code><span class="sig-paren">(</span><em>*args</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.unicode.CodePointSet" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
<p>Represent a set of Unicode code points.</p>
<p>Each code point is an integral value between 0 and 0x10FFFF. This
class is used to represent a set of code points in a manner
suitable for use as regular expression character sets.</p>
<dl class="attribute">
<dt id="pyxb.utils.unicode.CodePointSet.MaxCodePoint">
<code class="descname">MaxCodePoint</code><em class="property"> = 1114111</em><a class="headerlink" href="#pyxb.utils.unicode.CodePointSet.MaxCodePoint" title="Permalink to this definition">¶</a></dt>
<dd><p>The maximum value for a code point in the Unicode code point
space. This is normally 0xFFFF, because wide unicode characters
are generally not enabled in Python builds. If, however, they are
enabled, this will be the full value of 0x10FFFF.</p>
</dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.unicode.CodePointSet.MaxShortCodePoint">
<code class="descname">MaxShortCodePoint</code><em class="property"> = 65535</em><a class="headerlink" href="#pyxb.utils.unicode.CodePointSet.MaxShortCodePoint" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.unicode.CodePointSet._CodePointSet__XMLtoPythonREEscapedCodepoints">
<code class="descname">_CodePointSet__XMLtoPythonREEscapedCodepoints</code><em class="property"> = (0, 94, 92, 91, 93, 45)</em><a class="headerlink" href="#pyxb.utils.unicode.CodePointSet._CodePointSet__XMLtoPythonREEscapedCodepoints" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.unicode.CodePointSet._CodePointSet__codepoints">
<code class="descname">_CodePointSet__codepoints</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.utils.unicode.CodePointSet._CodePointSet__codepoints" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.utils.unicode.CodePointSet._CodePointSet__mutate">
<code class="descname">_CodePointSet__mutate</code><span class="sig-paren">(</span><em>value</em>, <em>do_add</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.unicode.CodePointSet._CodePointSet__mutate" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.utils.unicode.CodePointSet._CodePointSet__unichr">
<code class="descname">_CodePointSet__unichr</code><span class="sig-paren">(</span><em>code_point</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.unicode.CodePointSet._CodePointSet__unichr" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.utils.unicode.CodePointSet._codepoints">
<code class="descname">_codepoints</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.unicode.CodePointSet._codepoints" title="Permalink to this definition">¶</a></dt>
<dd><p>For testing purrposes only, access to the codepoints
internal representation.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.unicode.CodePointSet.add">
<code class="descname">add</code><span class="sig-paren">(</span><em>value</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.unicode.CodePointSet.add" title="Permalink to this definition">¶</a></dt>
<dd><p>Add the given value to the code point set.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>value</strong> – An integral value denoting a code point, or a</td>
</tr>
</tbody>
</table>
<p>tuple <code class="xref py py-obj docutils literal"><span class="pre">(s,e)</span></code> denoting the start and end (inclusive) code
points in a range.
:return: <code class="xref py py-obj docutils literal"><span class="pre">self</span></code></p>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.unicode.CodePointSet.asPattern">
<code class="descname">asPattern</code><span class="sig-paren">(</span><em>with_brackets=True</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.unicode.CodePointSet.asPattern" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the code point set as Unicode regular expression
character group consisting of a sequence of characters or
character ranges.</p>
<p>This returns a regular expression fragment using Python’s
regular expression syntax. Note that different regular expression
syntaxes are not compatible, often in subtle ways.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>with_brackets</strong> – If <code class="xref py py-obj docutils literal"><span class="pre">True</span></code> (default), square brackets</td>
</tr>
</tbody>
</table>
<p>are added to enclose the returned character group.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.unicode.CodePointSet.asSingleCharacter">
<code class="descname">asSingleCharacter</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.unicode.CodePointSet.asSingleCharacter" title="Permalink to this definition">¶</a></dt>
<dd><p>If this set represents a single character, return it as its
unicode string value. Otherwise return <code class="xref py py-obj docutils literal"><span class="pre">None</span></code>.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.unicode.CodePointSet.asTuples">
<code class="descname">asTuples</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.unicode.CodePointSet.asTuples" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the codepoints as tuples denoting the ranges that are in
the set.</p>
<p>Each tuple <code class="xref py py-obj docutils literal"><span class="pre">(s,</span> <span class="pre">e)</span></code> indicates that the code points from <code class="xref py py-obj docutils literal"><span class="pre">s</span></code>
(inclusive) to <code class="xref py py-obj docutils literal"><span class="pre">e</span></code>) (inclusive) are in the set.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.unicode.CodePointSet.extend">
<code class="descname">extend</code><span class="sig-paren">(</span><em>values</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.unicode.CodePointSet.extend" title="Permalink to this definition">¶</a></dt>
<dd><p>Add multiple values to a code point set.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>values</strong> – Either a <a class="reference internal" href="#pyxb.utils.unicode.CodePointSet" title="pyxb.utils.unicode.CodePointSet"><code class="xref py py-obj docutils literal"><span class="pre">CodePointSet</span></code></a> instance, or an iterable</td>
</tr>
</tbody>
</table>
<p>whose members are valid parameters to <a class="reference internal" href="#pyxb.utils.unicode.CodePointSet.add" title="pyxb.utils.unicode.CodePointSet.add"><code class="xref py py-obj docutils literal"><span class="pre">add</span></code></a>.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><code class="xref py py-obj docutils literal"><span class="pre">self</span></code></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.unicode.CodePointSet.negate">
<code class="descname">negate</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.unicode.CodePointSet.negate" title="Permalink to this definition">¶</a></dt>
<dd><p>Return an instance that represents the inverse of this set.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.unicode.CodePointSet.subtract">
<code class="descname">subtract</code><span class="sig-paren">(</span><em>value</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.unicode.CodePointSet.subtract" title="Permalink to this definition">¶</a></dt>
<dd><p>Remove the given value from the code point set.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>value</strong> – An integral value denoting a code point, or a tuple</td>
</tr>
</tbody>
</table>
<p><code class="xref py py-obj docutils literal"><span class="pre">(s,e)</span></code> denoting the start and end (inclusive) code points in a
range, or a <a class="reference internal" href="#pyxb.utils.unicode.CodePointSet" title="pyxb.utils.unicode.CodePointSet"><code class="xref py py-obj docutils literal"><span class="pre">CodePointSet</span></code></a>.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><code class="xref py py-obj docutils literal"><span class="pre">self</span></code></td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
<dl class="exception">
<dt id="pyxb.utils.unicode.CodePointSetError">
<em class="property">exception </em><code class="descclassname">pyxb.utils.unicode.</code><code class="descname">CodePointSetError</code><a class="headerlink" href="#pyxb.utils.unicode.CodePointSetError" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">exceptions.LookupError</span></code></p>
<p>Raised when some abuse of a <a class="reference internal" href="#pyxb.utils.unicode.CodePointSet" title="pyxb.utils.unicode.CodePointSet"><code class="xref py py-obj docutils literal"><span class="pre">CodePointSet</span></code></a> is detected.</p>
</dd></dl>
<dl class="class">
<dt id="pyxb.utils.unicode.XML1p0e2">
<em class="property">class </em><code class="descclassname">pyxb.utils.unicode.</code><code class="descname">XML1p0e2</code><a class="headerlink" href="#pyxb.utils.unicode.XML1p0e2" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
<p>Regular expression support for XML Schema Data Types.</p>
<p>This class holds character classes and regular expressions used to
constrain the lexical space of XML Schema datatypes derived from
string<<a class="reference external" href="http://www.w3.org/TR/xmlschema-2/#string">http://www.w3.org/TR/xmlschema-2/#string</a>>. They are
from U{XML 1.0 (Second
Edition)<<a class="reference external" href="http://www.w3.org/TR/2000/WD-xml-2e-20000814">http://www.w3.org/TR/2000/WD-xml-2e-20000814</a>>} and
U{Namespaces in XML
<<a class="reference external" href="http://www.w3.org/TR/1999/REC-xml-names-19990114/">http://www.w3.org/TR/1999/REC-xml-names-19990114/</a>>}.</p>
<p>Unlike the regular expressions used for pattern constraints in XML
Schema, which are derived from the Unicode 3.1 specification,
these are derived from the Unicode 2.0 specification.</p>
<p>The XML Schema definition refers explicitly to the second edition
of XML, so we have to use these code point sets and patterns. Be
aware that U{subsequent updates to the XML specification
<<a class="reference external" href="http://www.w3.org/XML/xml-V10-4e-errata#E09">http://www.w3.org/XML/xml-V10-4e-errata#E09</a>>} have changed the
corresponding patterns for other uses of XML. One significant
change is that the original specification, used here, does not
allow wide unicode characters.</p>
<dl class="attribute">
<dt id="pyxb.utils.unicode.XML1p0e2.BaseChar">
<code class="descname">BaseChar</code><em class="property"> = <pyxb.utils.unicode.CodePointSet object></em><a class="headerlink" href="#pyxb.utils.unicode.XML1p0e2.BaseChar" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.unicode.XML1p0e2.Char">
<code class="descname">Char</code><em class="property"> = <pyxb.utils.unicode.CodePointSet object></em><a class="headerlink" href="#pyxb.utils.unicode.XML1p0e2.Char" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.unicode.XML1p0e2.CombiningChar">
<code class="descname">CombiningChar</code><em class="property"> = <pyxb.utils.unicode.CodePointSet object></em><a class="headerlink" href="#pyxb.utils.unicode.XML1p0e2.CombiningChar" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.unicode.XML1p0e2.Digit">
<code class="descname">Digit</code><em class="property"> = <pyxb.utils.unicode.CodePointSet object></em><a class="headerlink" href="#pyxb.utils.unicode.XML1p0e2.Digit" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.unicode.XML1p0e2.Extender">
<code class="descname">Extender</code><em class="property"> = <pyxb.utils.unicode.CodePointSet object></em><a class="headerlink" href="#pyxb.utils.unicode.XML1p0e2.Extender" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.unicode.XML1p0e2.Ideographic">
<code class="descname">Ideographic</code><em class="property"> = <pyxb.utils.unicode.CodePointSet object></em><a class="headerlink" href="#pyxb.utils.unicode.XML1p0e2.Ideographic" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.unicode.XML1p0e2.Letter">
<code class="descname">Letter</code><em class="property"> = <pyxb.utils.unicode.CodePointSet object></em><a class="headerlink" href="#pyxb.utils.unicode.XML1p0e2.Letter" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.unicode.XML1p0e2.NCNameChar">
<code class="descname">NCNameChar</code><em class="property"> = <pyxb.utils.unicode.CodePointSet object></em><a class="headerlink" href="#pyxb.utils.unicode.XML1p0e2.NCNameChar" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.unicode.XML1p0e2.NCNameStartChar">
<code class="descname">NCNameStartChar</code><em class="property"> = <pyxb.utils.unicode.CodePointSet object></em><a class="headerlink" href="#pyxb.utils.unicode.XML1p0e2.NCNameStartChar" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.unicode.XML1p0e2.NCName_pat">
<code class="descname">NCName_pat</code><em class="property"> = u'[A-Z_a-z\xc0-\xd6\xd8-\xf6\xf8-\u0131\u0134-\u013e\u0141-\u0148\u014a-\u017e\u0180-\u01c3\u01cd-\u01f0\u01f4-\u01f5\u01fa-\u0217\u0250-\u02a8\u02bb-\u02c1\u0386\u0388-\u038a\u038c\u038e-\u03a1\u03a3-\u03ce\u03d0-\u03d6\u03da\u03dc\u03de\u03e0\u03e2-\u03f3\u0401-\u040c\u040e-\u044f\u0451-\u045c\u045e-\u0481\u0490-\u04c4\u04c7-\u04c8\u04cb-\u04cc\u04d0-\u04eb\u04ee-\u04f5\u04f8-\u04f9\u0531-\u0556\u0559\u0561-\u0586\u05d0-\u05ea\u05f0-\u05f2\u0621-\u063a\u0641-\u064a\u0671-\u06b7\u06ba-\u06be\u06c0-\u06ce\u06d0-\u06d3\u06d5\u06e5-\u06e6\u0905-\u0939\u093d\u0958-\u0961\u0985-\u098c\u098f-\u0990\u0993-\u09a8\u09aa-\u09b0\u09b2\u09b6-\u09b9\u09dc-\u09dd\u09df-\u09e1\u09f0-\u09f1\u0a05-\u0a0a\u0a0f-\u0a10\u0a13-\u0a28\u0a2a-\u0a30\u0a32-\u0a33\u0a35-\u0a36\u0a38-\u0a39\u0a59-\u0a5c\u0a5e\u0a72-\u0a74\u0a85-\u0a8b\u0a8d\u0a8f-\u0a91\u0a93-\u0aa8\u0aaa-\u0ab0\u0ab2-\u0ab3\u0ab5-\u0ab9\u0abd\u0ae0\u0b05-\u0b0c\u0b0f-\u0b10\u0b13-\u0b28\u0b2a-\u0b30\u0b32-\u0b33\u0b36-\u0b39\u0b3d\u0b5c-\u0b5d\u0b5f-\u0b61\u0b85-\u0b8a\u0b8e-\u0b90\u0b92-\u0b95\u0b99-\u0b9a\u0b9c\u0b9e-\u0b9f\u0ba3-\u0ba4\u0ba8-\u0baa\u0bae-\u0bb5\u0bb7-\u0bb9\u0c05-\u0c0c\u0c0e-\u0c10\u0c12-\u0c28\u0c2a-\u0c33\u0c35-\u0c39\u0c60-\u0c61\u0c85-\u0c8c\u0c8e-\u0c90\u0c92-\u0ca8\u0caa-\u0cb3\u0cb5-\u0cb9\u0cde\u0ce0-\u0ce1\u0d05-\u0d0c\u0d0e-\u0d10\u0d12-\u0d28\u0d2a-\u0d39\u0d60-\u0d61\u0e01-\u0e2e\u0e30\u0e32-\u0e33\u0e40-\u0e45\u0e81-\u0e82\u0e84\u0e87-\u0e88\u0e8a\u0e8d\u0e94-\u0e97\u0e99-\u0e9f\u0ea1-\u0ea3\u0ea5\u0ea7\u0eaa-\u0eab\u0ead-\u0eae\u0eb0\u0eb2-\u0eb3\u0ebd\u0ec0-\u0ec4\u0f40-\u0f47\u0f49-\u0f69\u10a0-\u10c5\u10d0-\u10f6\u1100\u1102-\u1103\u1105-\u1107\u1109\u110b-\u110c\u110e-\u1112\u113c\u113e\u1140\u114c\u114e\u1150\u1154-\u1155\u1159\u115f-\u1161\u1163\u1165\u1167\u1169\u116d-\u116e\u1172-\u1173\u1175\u119e\u11a8\u11ab\u11ae-\u11af\u11b7-\u11b8\u11ba\u11bc-\u11c2\u11eb\u11f0\u11f9\u1e00-\u1e9b\u1ea0-\u1ef9\u1f00-\u1f15\u1f18-\u1f1d\u1f20-\u1f45\u1f48-\u1f4d\u1f50-\u1f57\u1f59\u1f5b\u1f5d\u1f5f-\u1f7d\u1f80-\u1fb4\u1fb6-\u1fbc\u1fbe\u1fc2-\u1fc4\u1fc6-\u1fcc\u1fd0-\u1fd3\u1fd6-\u1fdb\u1fe0-\u1fec\u1ff2-\u1ff4\u1ff6-\u1ffc\u2126\u212a-\u212b\u212e\u2180-\u2182\u3007\u3021-\u3029\u3041-\u3094\u30a1-\u30fa\u3105-\u312c\u4e00-\u9fa5\uac00-\ud7a3][\\--.0-9A-Z_a-z\xb7\xc0-\xd6\xd8-\xf6\xf8-\u0131\u0134-\u013e\u0141-\u0148\u014a-\u017e\u0180-\u01c3\u01cd-\u01f0\u01f4-\u01f5\u01fa-\u0217\u0250-\u02a8\u02bb-\u02c1\u02d0-\u02d1\u0300-\u0345\u0360-\u0361\u0386-\u038a\u038c\u038e-\u03a1\u03a3-\u03ce\u03d0-\u03d6\u03da\u03dc\u03de\u03e0\u03e2-\u03f3\u0401-\u040c\u040e-\u044f\u0451-\u045c\u045e-\u0481\u0483-\u0486\u0490-\u04c4\u04c7-\u04c8\u04cb-\u04cc\u04d0-\u04eb\u04ee-\u04f5\u04f8-\u04f9\u0531-\u0556\u0559\u0561-\u0586\u0591-\u05a1\u05a3-\u05b9\u05bb-\u05bd\u05bf\u05c1-\u05c2\u05c4\u05d0-\u05ea\u05f0-\u05f2\u0621-\u063a\u0640-\u0652\u0660-\u0669\u0670-\u06b7\u06ba-\u06be\u06c0-\u06ce\u06d0-\u06d3\u06d5-\u06e8\u06ea-\u06ed\u06f0-\u06f9\u0901-\u0903\u0905-\u0939\u093c-\u094d\u0951-\u0954\u0958-\u0963\u0966-\u096f\u0981-\u0983\u0985-\u098c\u098f-\u0990\u0993-\u09a8\u09aa-\u09b0\u09b2\u09b6-\u09b9\u09bc\u09be-\u09c4\u09c7-\u09c8\u09cb-\u09cd\u09d7\u09dc-\u09dd\u09df-\u09e3\u09e6-\u09f1\u0a02\u0a05-\u0a0a\u0a0f-\u0a10\u0a13-\u0a28\u0a2a-\u0a30\u0a32-\u0a33\u0a35-\u0a36\u0a38-\u0a39\u0a3c\u0a3e-\u0a42\u0a47-\u0a48\u0a4b-\u0a4d\u0a59-\u0a5c\u0a5e\u0a66-\u0a74\u0a81-\u0a83\u0a85-\u0a8b\u0a8d\u0a8f-\u0a91\u0a93-\u0aa8\u0aaa-\u0ab0\u0ab2-\u0ab3\u0ab5-\u0ab9\u0abc-\u0ac5\u0ac7-\u0ac9\u0acb-\u0acd\u0ae0\u0ae6-\u0aef\u0b01-\u0b03\u0b05-\u0b0c\u0b0f-\u0b10\u0b13-\u0b28\u0b2a-\u0b30\u0b32-\u0b33\u0b36-\u0b39\u0b3c-\u0b43\u0b47-\u0b48\u0b4b-\u0b4d\u0b56-\u0b57\u0b5c-\u0b5d\u0b5f-\u0b61\u0b66-\u0b6f\u0b82-\u0b83\u0b85-\u0b8a\u0b8e-\u0b90\u0b92-\u0b95\u0b99-\u0b9a\u0b9c\u0b9e-\u0b9f\u0ba3-\u0ba4\u0ba8-\u0baa\u0bae-\u0bb5\u0bb7-\u0bb9\u0bbe-\u0bc2\u0bc6-\u0bc8\u0bca-\u0bcd\u0bd7\u0be7-\u0bef\u0c01-\u0c03\u0c05-\u0c0c\u0c0e-\u0c10\u0c12-\u0c28\u0c2a-\u0c33\u0c35-\u0c39\u0c3e-\u0c44\u0c46-\u0c48\u0c4a-\u0c4d\u0c55-\u0c56\u0c60-\u0c61\u0c66-\u0c6f\u0c82-\u0c83\u0c85-\u0c8c\u0c8e-\u0c90\u0c92-\u0ca8\u0caa-\u0cb3\u0cb5-\u0cb9\u0cbe-\u0cc4\u0cc6-\u0cc8\u0cca-\u0ccd\u0cd5-\u0cd6\u0cde\u0ce0-\u0ce1\u0ce6-\u0cef\u0d02-\u0d03\u0d05-\u0d0c\u0d0e-\u0d10\u0d12-\u0d28\u0d2a-\u0d39\u0d3e-\u0d43\u0d46-\u0d48\u0d4a-\u0d4d\u0d57\u0d60-\u0d61\u0d66-\u0d6f\u0e01-\u0e2e\u0e30-\u0e3a\u0e40-\u0e4e\u0e50-\u0e59\u0e81-\u0e82\u0e84\u0e87-\u0e88\u0e8a\u0e8d\u0e94-\u0e97\u0e99-\u0e9f\u0ea1-\u0ea3\u0ea5\u0ea7\u0eaa-\u0eab\u0ead-\u0eae\u0eb0-\u0eb9\u0ebb-\u0ebd\u0ec0-\u0ec4\u0ec6\u0ec8-\u0ecd\u0ed0-\u0ed9\u0f18-\u0f19\u0f20-\u0f29\u0f35\u0f37\u0f39\u0f3e-\u0f47\u0f49-\u0f69\u0f71-\u0f84\u0f86-\u0f8b\u0f90-\u0f95\u0f97\u0f99-\u0fad\u0fb1-\u0fb7\u0fb9\u10a0-\u10c5\u10d0-\u10f6\u1100\u1102-\u1103\u1105-\u1107\u1109\u110b-\u110c\u110e-\u1112\u113c\u113e\u1140\u114c\u114e\u1150\u1154-\u1155\u1159\u115f-\u1161\u1163\u1165\u1167\u1169\u116d-\u116e\u1172-\u1173\u1175\u119e\u11a8\u11ab\u11ae-\u11af\u11b7-\u11b8\u11ba\u11bc-\u11c2\u11eb\u11f0\u11f9\u1e00-\u1e9b\u1ea0-\u1ef9\u1f00-\u1f15\u1f18-\u1f1d\u1f20-\u1f45\u1f48-\u1f4d\u1f50-\u1f57\u1f59\u1f5b\u1f5d\u1f5f-\u1f7d\u1f80-\u1fb4\u1fb6-\u1fbc\u1fbe\u1fc2-\u1fc4\u1fc6-\u1fcc\u1fd0-\u1fd3\u1fd6-\u1fdb\u1fe0-\u1fec\u1ff2-\u1ff4\u1ff6-\u1ffc\u20d0-\u20dc\u20e1\u2126\u212a-\u212b\u212e\u2180-\u2182\u3005\u3007\u3021-\u302f\u3031-\u3035\u3041-\u3094\u3099-\u309a\u309d-\u309e\u30a1-\u30fa\u30fc-\u30fe\u3105-\u312c\u4e00-\u9fa5\uac00-\ud7a3]*'</em><a class="headerlink" href="#pyxb.utils.unicode.XML1p0e2.NCName_pat" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.unicode.XML1p0e2.NCName_re">
<code class="descname">NCName_re</code><em class="property"> = <_sre.SRE_Pattern object at 0x3bd73f0></em><a class="headerlink" href="#pyxb.utils.unicode.XML1p0e2.NCName_re" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.unicode.XML1p0e2.NameChar">
<code class="descname">NameChar</code><em class="property"> = <pyxb.utils.unicode.CodePointSet object></em><a class="headerlink" href="#pyxb.utils.unicode.XML1p0e2.NameChar" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.unicode.XML1p0e2.NameStartChar">
<code class="descname">NameStartChar</code><em class="property"> = <pyxb.utils.unicode.CodePointSet object></em><a class="headerlink" href="#pyxb.utils.unicode.XML1p0e2.NameStartChar" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.unicode.XML1p0e2.Name_pat">
<code class="descname">Name_pat</code><em class="property"> = u'[:A-Z_a-z\xc0-\xd6\xd8-\xf6\xf8-\u0131\u0134-\u013e\u0141-\u0148\u014a-\u017e\u0180-\u01c3\u01cd-\u01f0\u01f4-\u01f5\u01fa-\u0217\u0250-\u02a8\u02bb-\u02c1\u0386\u0388-\u038a\u038c\u038e-\u03a1\u03a3-\u03ce\u03d0-\u03d6\u03da\u03dc\u03de\u03e0\u03e2-\u03f3\u0401-\u040c\u040e-\u044f\u0451-\u045c\u045e-\u0481\u0490-\u04c4\u04c7-\u04c8\u04cb-\u04cc\u04d0-\u04eb\u04ee-\u04f5\u04f8-\u04f9\u0531-\u0556\u0559\u0561-\u0586\u05d0-\u05ea\u05f0-\u05f2\u0621-\u063a\u0641-\u064a\u0671-\u06b7\u06ba-\u06be\u06c0-\u06ce\u06d0-\u06d3\u06d5\u06e5-\u06e6\u0905-\u0939\u093d\u0958-\u0961\u0985-\u098c\u098f-\u0990\u0993-\u09a8\u09aa-\u09b0\u09b2\u09b6-\u09b9\u09dc-\u09dd\u09df-\u09e1\u09f0-\u09f1\u0a05-\u0a0a\u0a0f-\u0a10\u0a13-\u0a28\u0a2a-\u0a30\u0a32-\u0a33\u0a35-\u0a36\u0a38-\u0a39\u0a59-\u0a5c\u0a5e\u0a72-\u0a74\u0a85-\u0a8b\u0a8d\u0a8f-\u0a91\u0a93-\u0aa8\u0aaa-\u0ab0\u0ab2-\u0ab3\u0ab5-\u0ab9\u0abd\u0ae0\u0b05-\u0b0c\u0b0f-\u0b10\u0b13-\u0b28\u0b2a-\u0b30\u0b32-\u0b33\u0b36-\u0b39\u0b3d\u0b5c-\u0b5d\u0b5f-\u0b61\u0b85-\u0b8a\u0b8e-\u0b90\u0b92-\u0b95\u0b99-\u0b9a\u0b9c\u0b9e-\u0b9f\u0ba3-\u0ba4\u0ba8-\u0baa\u0bae-\u0bb5\u0bb7-\u0bb9\u0c05-\u0c0c\u0c0e-\u0c10\u0c12-\u0c28\u0c2a-\u0c33\u0c35-\u0c39\u0c60-\u0c61\u0c85-\u0c8c\u0c8e-\u0c90\u0c92-\u0ca8\u0caa-\u0cb3\u0cb5-\u0cb9\u0cde\u0ce0-\u0ce1\u0d05-\u0d0c\u0d0e-\u0d10\u0d12-\u0d28\u0d2a-\u0d39\u0d60-\u0d61\u0e01-\u0e2e\u0e30\u0e32-\u0e33\u0e40-\u0e45\u0e81-\u0e82\u0e84\u0e87-\u0e88\u0e8a\u0e8d\u0e94-\u0e97\u0e99-\u0e9f\u0ea1-\u0ea3\u0ea5\u0ea7\u0eaa-\u0eab\u0ead-\u0eae\u0eb0\u0eb2-\u0eb3\u0ebd\u0ec0-\u0ec4\u0f40-\u0f47\u0f49-\u0f69\u10a0-\u10c5\u10d0-\u10f6\u1100\u1102-\u1103\u1105-\u1107\u1109\u110b-\u110c\u110e-\u1112\u113c\u113e\u1140\u114c\u114e\u1150\u1154-\u1155\u1159\u115f-\u1161\u1163\u1165\u1167\u1169\u116d-\u116e\u1172-\u1173\u1175\u119e\u11a8\u11ab\u11ae-\u11af\u11b7-\u11b8\u11ba\u11bc-\u11c2\u11eb\u11f0\u11f9\u1e00-\u1e9b\u1ea0-\u1ef9\u1f00-\u1f15\u1f18-\u1f1d\u1f20-\u1f45\u1f48-\u1f4d\u1f50-\u1f57\u1f59\u1f5b\u1f5d\u1f5f-\u1f7d\u1f80-\u1fb4\u1fb6-\u1fbc\u1fbe\u1fc2-\u1fc4\u1fc6-\u1fcc\u1fd0-\u1fd3\u1fd6-\u1fdb\u1fe0-\u1fec\u1ff2-\u1ff4\u1ff6-\u1ffc\u2126\u212a-\u212b\u212e\u2180-\u2182\u3007\u3021-\u3029\u3041-\u3094\u30a1-\u30fa\u3105-\u312c\u4e00-\u9fa5\uac00-\ud7a3][\\--.0-:A-Z_a-z\xb7\xc0-\xd6\xd8-\xf6\xf8-\u0131\u0134-\u013e\u0141-\u0148\u014a-\u017e\u0180-\u01c3\u01cd-\u01f0\u01f4-\u01f5\u01fa-\u0217\u0250-\u02a8\u02bb-\u02c1\u02d0-\u02d1\u0300-\u0345\u0360-\u0361\u0386-\u038a\u038c\u038e-\u03a1\u03a3-\u03ce\u03d0-\u03d6\u03da\u03dc\u03de\u03e0\u03e2-\u03f3\u0401-\u040c\u040e-\u044f\u0451-\u045c\u045e-\u0481\u0483-\u0486\u0490-\u04c4\u04c7-\u04c8\u04cb-\u04cc\u04d0-\u04eb\u04ee-\u04f5\u04f8-\u04f9\u0531-\u0556\u0559\u0561-\u0586\u0591-\u05a1\u05a3-\u05b9\u05bb-\u05bd\u05bf\u05c1-\u05c2\u05c4\u05d0-\u05ea\u05f0-\u05f2\u0621-\u063a\u0640-\u0652\u0660-\u0669\u0670-\u06b7\u06ba-\u06be\u06c0-\u06ce\u06d0-\u06d3\u06d5-\u06e8\u06ea-\u06ed\u06f0-\u06f9\u0901-\u0903\u0905-\u0939\u093c-\u094d\u0951-\u0954\u0958-\u0963\u0966-\u096f\u0981-\u0983\u0985-\u098c\u098f-\u0990\u0993-\u09a8\u09aa-\u09b0\u09b2\u09b6-\u09b9\u09bc\u09be-\u09c4\u09c7-\u09c8\u09cb-\u09cd\u09d7\u09dc-\u09dd\u09df-\u09e3\u09e6-\u09f1\u0a02\u0a05-\u0a0a\u0a0f-\u0a10\u0a13-\u0a28\u0a2a-\u0a30\u0a32-\u0a33\u0a35-\u0a36\u0a38-\u0a39\u0a3c\u0a3e-\u0a42\u0a47-\u0a48\u0a4b-\u0a4d\u0a59-\u0a5c\u0a5e\u0a66-\u0a74\u0a81-\u0a83\u0a85-\u0a8b\u0a8d\u0a8f-\u0a91\u0a93-\u0aa8\u0aaa-\u0ab0\u0ab2-\u0ab3\u0ab5-\u0ab9\u0abc-\u0ac5\u0ac7-\u0ac9\u0acb-\u0acd\u0ae0\u0ae6-\u0aef\u0b01-\u0b03\u0b05-\u0b0c\u0b0f-\u0b10\u0b13-\u0b28\u0b2a-\u0b30\u0b32-\u0b33\u0b36-\u0b39\u0b3c-\u0b43\u0b47-\u0b48\u0b4b-\u0b4d\u0b56-\u0b57\u0b5c-\u0b5d\u0b5f-\u0b61\u0b66-\u0b6f\u0b82-\u0b83\u0b85-\u0b8a\u0b8e-\u0b90\u0b92-\u0b95\u0b99-\u0b9a\u0b9c\u0b9e-\u0b9f\u0ba3-\u0ba4\u0ba8-\u0baa\u0bae-\u0bb5\u0bb7-\u0bb9\u0bbe-\u0bc2\u0bc6-\u0bc8\u0bca-\u0bcd\u0bd7\u0be7-\u0bef\u0c01-\u0c03\u0c05-\u0c0c\u0c0e-\u0c10\u0c12-\u0c28\u0c2a-\u0c33\u0c35-\u0c39\u0c3e-\u0c44\u0c46-\u0c48\u0c4a-\u0c4d\u0c55-\u0c56\u0c60-\u0c61\u0c66-\u0c6f\u0c82-\u0c83\u0c85-\u0c8c\u0c8e-\u0c90\u0c92-\u0ca8\u0caa-\u0cb3\u0cb5-\u0cb9\u0cbe-\u0cc4\u0cc6-\u0cc8\u0cca-\u0ccd\u0cd5-\u0cd6\u0cde\u0ce0-\u0ce1\u0ce6-\u0cef\u0d02-\u0d03\u0d05-\u0d0c\u0d0e-\u0d10\u0d12-\u0d28\u0d2a-\u0d39\u0d3e-\u0d43\u0d46-\u0d48\u0d4a-\u0d4d\u0d57\u0d60-\u0d61\u0d66-\u0d6f\u0e01-\u0e2e\u0e30-\u0e3a\u0e40-\u0e4e\u0e50-\u0e59\u0e81-\u0e82\u0e84\u0e87-\u0e88\u0e8a\u0e8d\u0e94-\u0e97\u0e99-\u0e9f\u0ea1-\u0ea3\u0ea5\u0ea7\u0eaa-\u0eab\u0ead-\u0eae\u0eb0-\u0eb9\u0ebb-\u0ebd\u0ec0-\u0ec4\u0ec6\u0ec8-\u0ecd\u0ed0-\u0ed9\u0f18-\u0f19\u0f20-\u0f29\u0f35\u0f37\u0f39\u0f3e-\u0f47\u0f49-\u0f69\u0f71-\u0f84\u0f86-\u0f8b\u0f90-\u0f95\u0f97\u0f99-\u0fad\u0fb1-\u0fb7\u0fb9\u10a0-\u10c5\u10d0-\u10f6\u1100\u1102-\u1103\u1105-\u1107\u1109\u110b-\u110c\u110e-\u1112\u113c\u113e\u1140\u114c\u114e\u1150\u1154-\u1155\u1159\u115f-\u1161\u1163\u1165\u1167\u1169\u116d-\u116e\u1172-\u1173\u1175\u119e\u11a8\u11ab\u11ae-\u11af\u11b7-\u11b8\u11ba\u11bc-\u11c2\u11eb\u11f0\u11f9\u1e00-\u1e9b\u1ea0-\u1ef9\u1f00-\u1f15\u1f18-\u1f1d\u1f20-\u1f45\u1f48-\u1f4d\u1f50-\u1f57\u1f59\u1f5b\u1f5d\u1f5f-\u1f7d\u1f80-\u1fb4\u1fb6-\u1fbc\u1fbe\u1fc2-\u1fc4\u1fc6-\u1fcc\u1fd0-\u1fd3\u1fd6-\u1fdb\u1fe0-\u1fec\u1ff2-\u1ff4\u1ff6-\u1ffc\u20d0-\u20dc\u20e1\u2126\u212a-\u212b\u212e\u2180-\u2182\u3005\u3007\u3021-\u302f\u3031-\u3035\u3041-\u3094\u3099-\u309a\u309d-\u309e\u30a1-\u30fa\u30fc-\u30fe\u3105-\u312c\u4e00-\u9fa5\uac00-\ud7a3]*'</em><a class="headerlink" href="#pyxb.utils.unicode.XML1p0e2.Name_pat" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.unicode.XML1p0e2.Name_re">
<code class="descname">Name_re</code><em class="property"> = <_sre.SRE_Pattern object at 0x3bd27a0></em><a class="headerlink" href="#pyxb.utils.unicode.XML1p0e2.Name_re" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.unicode.XML1p0e2.NmToken_pat">
<code class="descname">NmToken_pat</code><em class="property"> = u'[\\--.0-:A-Z_a-z\xb7\xc0-\xd6\xd8-\xf6\xf8-\u0131\u0134-\u013e\u0141-\u0148\u014a-\u017e\u0180-\u01c3\u01cd-\u01f0\u01f4-\u01f5\u01fa-\u0217\u0250-\u02a8\u02bb-\u02c1\u02d0-\u02d1\u0300-\u0345\u0360-\u0361\u0386-\u038a\u038c\u038e-\u03a1\u03a3-\u03ce\u03d0-\u03d6\u03da\u03dc\u03de\u03e0\u03e2-\u03f3\u0401-\u040c\u040e-\u044f\u0451-\u045c\u045e-\u0481\u0483-\u0486\u0490-\u04c4\u04c7-\u04c8\u04cb-\u04cc\u04d0-\u04eb\u04ee-\u04f5\u04f8-\u04f9\u0531-\u0556\u0559\u0561-\u0586\u0591-\u05a1\u05a3-\u05b9\u05bb-\u05bd\u05bf\u05c1-\u05c2\u05c4\u05d0-\u05ea\u05f0-\u05f2\u0621-\u063a\u0640-\u0652\u0660-\u0669\u0670-\u06b7\u06ba-\u06be\u06c0-\u06ce\u06d0-\u06d3\u06d5-\u06e8\u06ea-\u06ed\u06f0-\u06f9\u0901-\u0903\u0905-\u0939\u093c-\u094d\u0951-\u0954\u0958-\u0963\u0966-\u096f\u0981-\u0983\u0985-\u098c\u098f-\u0990\u0993-\u09a8\u09aa-\u09b0\u09b2\u09b6-\u09b9\u09bc\u09be-\u09c4\u09c7-\u09c8\u09cb-\u09cd\u09d7\u09dc-\u09dd\u09df-\u09e3\u09e6-\u09f1\u0a02\u0a05-\u0a0a\u0a0f-\u0a10\u0a13-\u0a28\u0a2a-\u0a30\u0a32-\u0a33\u0a35-\u0a36\u0a38-\u0a39\u0a3c\u0a3e-\u0a42\u0a47-\u0a48\u0a4b-\u0a4d\u0a59-\u0a5c\u0a5e\u0a66-\u0a74\u0a81-\u0a83\u0a85-\u0a8b\u0a8d\u0a8f-\u0a91\u0a93-\u0aa8\u0aaa-\u0ab0\u0ab2-\u0ab3\u0ab5-\u0ab9\u0abc-\u0ac5\u0ac7-\u0ac9\u0acb-\u0acd\u0ae0\u0ae6-\u0aef\u0b01-\u0b03\u0b05-\u0b0c\u0b0f-\u0b10\u0b13-\u0b28\u0b2a-\u0b30\u0b32-\u0b33\u0b36-\u0b39\u0b3c-\u0b43\u0b47-\u0b48\u0b4b-\u0b4d\u0b56-\u0b57\u0b5c-\u0b5d\u0b5f-\u0b61\u0b66-\u0b6f\u0b82-\u0b83\u0b85-\u0b8a\u0b8e-\u0b90\u0b92-\u0b95\u0b99-\u0b9a\u0b9c\u0b9e-\u0b9f\u0ba3-\u0ba4\u0ba8-\u0baa\u0bae-\u0bb5\u0bb7-\u0bb9\u0bbe-\u0bc2\u0bc6-\u0bc8\u0bca-\u0bcd\u0bd7\u0be7-\u0bef\u0c01-\u0c03\u0c05-\u0c0c\u0c0e-\u0c10\u0c12-\u0c28\u0c2a-\u0c33\u0c35-\u0c39\u0c3e-\u0c44\u0c46-\u0c48\u0c4a-\u0c4d\u0c55-\u0c56\u0c60-\u0c61\u0c66-\u0c6f\u0c82-\u0c83\u0c85-\u0c8c\u0c8e-\u0c90\u0c92-\u0ca8\u0caa-\u0cb3\u0cb5-\u0cb9\u0cbe-\u0cc4\u0cc6-\u0cc8\u0cca-\u0ccd\u0cd5-\u0cd6\u0cde\u0ce0-\u0ce1\u0ce6-\u0cef\u0d02-\u0d03\u0d05-\u0d0c\u0d0e-\u0d10\u0d12-\u0d28\u0d2a-\u0d39\u0d3e-\u0d43\u0d46-\u0d48\u0d4a-\u0d4d\u0d57\u0d60-\u0d61\u0d66-\u0d6f\u0e01-\u0e2e\u0e30-\u0e3a\u0e40-\u0e4e\u0e50-\u0e59\u0e81-\u0e82\u0e84\u0e87-\u0e88\u0e8a\u0e8d\u0e94-\u0e97\u0e99-\u0e9f\u0ea1-\u0ea3\u0ea5\u0ea7\u0eaa-\u0eab\u0ead-\u0eae\u0eb0-\u0eb9\u0ebb-\u0ebd\u0ec0-\u0ec4\u0ec6\u0ec8-\u0ecd\u0ed0-\u0ed9\u0f18-\u0f19\u0f20-\u0f29\u0f35\u0f37\u0f39\u0f3e-\u0f47\u0f49-\u0f69\u0f71-\u0f84\u0f86-\u0f8b\u0f90-\u0f95\u0f97\u0f99-\u0fad\u0fb1-\u0fb7\u0fb9\u10a0-\u10c5\u10d0-\u10f6\u1100\u1102-\u1103\u1105-\u1107\u1109\u110b-\u110c\u110e-\u1112\u113c\u113e\u1140\u114c\u114e\u1150\u1154-\u1155\u1159\u115f-\u1161\u1163\u1165\u1167\u1169\u116d-\u116e\u1172-\u1173\u1175\u119e\u11a8\u11ab\u11ae-\u11af\u11b7-\u11b8\u11ba\u11bc-\u11c2\u11eb\u11f0\u11f9\u1e00-\u1e9b\u1ea0-\u1ef9\u1f00-\u1f15\u1f18-\u1f1d\u1f20-\u1f45\u1f48-\u1f4d\u1f50-\u1f57\u1f59\u1f5b\u1f5d\u1f5f-\u1f7d\u1f80-\u1fb4\u1fb6-\u1fbc\u1fbe\u1fc2-\u1fc4\u1fc6-\u1fcc\u1fd0-\u1fd3\u1fd6-\u1fdb\u1fe0-\u1fec\u1ff2-\u1ff4\u1ff6-\u1ffc\u20d0-\u20dc\u20e1\u2126\u212a-\u212b\u212e\u2180-\u2182\u3005\u3007\u3021-\u302f\u3031-\u3035\u3041-\u3094\u3099-\u309a\u309d-\u309e\u30a1-\u30fa\u30fc-\u30fe\u3105-\u312c\u4e00-\u9fa5\uac00-\ud7a3]+'</em><a class="headerlink" href="#pyxb.utils.unicode.XML1p0e2.NmToken_pat" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.unicode.XML1p0e2.NmToken_re">
<code class="descname">NmToken_re</code><em class="property"> = <_sre.SRE_Pattern object at 0x425ff10></em><a class="headerlink" href="#pyxb.utils.unicode.XML1p0e2.NmToken_re" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.unicode.XML1p0e2.QName_pat">
<code class="descname">QName_pat</code><em class="property"> = u'([A-Z_a-z\xc0-\xd6\xd8-\xf6\xf8-\u0131\u0134-\u013e\u0141-\u0148\u014a-\u017e\u0180-\u01c3\u01cd-\u01f0\u01f4-\u01f5\u01fa-\u0217\u0250-\u02a8\u02bb-\u02c1\u0386\u0388-\u038a\u038c\u038e-\u03a1\u03a3-\u03ce\u03d0-\u03d6\u03da\u03dc\u03de\u03e0\u03e2-\u03f3\u0401-\u040c\u040e-\u044f\u0451-\u045c\u045e-\u0481\u0490-\u04c4\u04c7-\u04c8\u04cb-\u04cc\u04d0-\u04eb\u04ee-\u04f5\u04f8-\u04f9\u0531-\u0556\u0559\u0561-\u0586\u05d0-\u05ea\u05f0-\u05f2\u0621-\u063a\u0641-\u064a\u0671-\u06b7\u06ba-\u06be\u06c0-\u06ce\u06d0-\u06d3\u06d5\u06e5-\u06e6\u0905-\u0939\u093d\u0958-\u0961\u0985-\u098c\u098f-\u0990\u0993-\u09a8\u09aa-\u09b0\u09b2\u09b6-\u09b9\u09dc-\u09dd\u09df-\u09e1\u09f0-\u09f1\u0a05-\u0a0a\u0a0f-\u0a10\u0a13-\u0a28\u0a2a-\u0a30\u0a32-\u0a33\u0a35-\u0a36\u0a38-\u0a39\u0a59-\u0a5c\u0a5e\u0a72-\u0a74\u0a85-\u0a8b\u0a8d\u0a8f-\u0a91\u0a93-\u0aa8\u0aaa-\u0ab0\u0ab2-\u0ab3\u0ab5-\u0ab9\u0abd\u0ae0\u0b05-\u0b0c\u0b0f-\u0b10\u0b13-\u0b28\u0b2a-\u0b30\u0b32-\u0b33\u0b36-\u0b39\u0b3d\u0b5c-\u0b5d\u0b5f-\u0b61\u0b85-\u0b8a\u0b8e-\u0b90\u0b92-\u0b95\u0b99-\u0b9a\u0b9c\u0b9e-\u0b9f\u0ba3-\u0ba4\u0ba8-\u0baa\u0bae-\u0bb5\u0bb7-\u0bb9\u0c05-\u0c0c\u0c0e-\u0c10\u0c12-\u0c28\u0c2a-\u0c33\u0c35-\u0c39\u0c60-\u0c61\u0c85-\u0c8c\u0c8e-\u0c90\u0c92-\u0ca8\u0caa-\u0cb3\u0cb5-\u0cb9\u0cde\u0ce0-\u0ce1\u0d05-\u0d0c\u0d0e-\u0d10\u0d12-\u0d28\u0d2a-\u0d39\u0d60-\u0d61\u0e01-\u0e2e\u0e30\u0e32-\u0e33\u0e40-\u0e45\u0e81-\u0e82\u0e84\u0e87-\u0e88\u0e8a\u0e8d\u0e94-\u0e97\u0e99-\u0e9f\u0ea1-\u0ea3\u0ea5\u0ea7\u0eaa-\u0eab\u0ead-\u0eae\u0eb0\u0eb2-\u0eb3\u0ebd\u0ec0-\u0ec4\u0f40-\u0f47\u0f49-\u0f69\u10a0-\u10c5\u10d0-\u10f6\u1100\u1102-\u1103\u1105-\u1107\u1109\u110b-\u110c\u110e-\u1112\u113c\u113e\u1140\u114c\u114e\u1150\u1154-\u1155\u1159\u115f-\u1161\u1163\u1165\u1167\u1169\u116d-\u116e\u1172-\u1173\u1175\u119e\u11a8\u11ab\u11ae-\u11af\u11b7-\u11b8\u11ba\u11bc-\u11c2\u11eb\u11f0\u11f9\u1e00-\u1e9b\u1ea0-\u1ef9\u1f00-\u1f15\u1f18-\u1f1d\u1f20-\u1f45\u1f48-\u1f4d\u1f50-\u1f57\u1f59\u1f5b\u1f5d\u1f5f-\u1f7d\u1f80-\u1fb4\u1fb6-\u1fbc\u1fbe\u1fc2-\u1fc4\u1fc6-\u1fcc\u1fd0-\u1fd3\u1fd6-\u1fdb\u1fe0-\u1fec\u1ff2-\u1ff4\u1ff6-\u1ffc\u2126\u212a-\u212b\u212e\u2180-\u2182\u3007\u3021-\u3029\u3041-\u3094\u30a1-\u30fa\u3105-\u312c\u4e00-\u9fa5\uac00-\ud7a3][\\--.0-9A-Z_a-z\xb7\xc0-\xd6\xd8-\xf6\xf8-\u0131\u0134-\u013e\u0141-\u0148\u014a-\u017e\u0180-\u01c3\u01cd-\u01f0\u01f4-\u01f5\u01fa-\u0217\u0250-\u02a8\u02bb-\u02c1\u02d0-\u02d1\u0300-\u0345\u0360-\u0361\u0386-\u038a\u038c\u038e-\u03a1\u03a3-\u03ce\u03d0-\u03d6\u03da\u03dc\u03de\u03e0\u03e2-\u03f3\u0401-\u040c\u040e-\u044f\u0451-\u045c\u045e-\u0481\u0483-\u0486\u0490-\u04c4\u04c7-\u04c8\u04cb-\u04cc\u04d0-\u04eb\u04ee-\u04f5\u04f8-\u04f9\u0531-\u0556\u0559\u0561-\u0586\u0591-\u05a1\u05a3-\u05b9\u05bb-\u05bd\u05bf\u05c1-\u05c2\u05c4\u05d0-\u05ea\u05f0-\u05f2\u0621-\u063a\u0640-\u0652\u0660-\u0669\u0670-\u06b7\u06ba-\u06be\u06c0-\u06ce\u06d0-\u06d3\u06d5-\u06e8\u06ea-\u06ed\u06f0-\u06f9\u0901-\u0903\u0905-\u0939\u093c-\u094d\u0951-\u0954\u0958-\u0963\u0966-\u096f\u0981-\u0983\u0985-\u098c\u098f-\u0990\u0993-\u09a8\u09aa-\u09b0\u09b2\u09b6-\u09b9\u09bc\u09be-\u09c4\u09c7-\u09c8\u09cb-\u09cd\u09d7\u09dc-\u09dd\u09df-\u09e3\u09e6-\u09f1\u0a02\u0a05-\u0a0a\u0a0f-\u0a10\u0a13-\u0a28\u0a2a-\u0a30\u0a32-\u0a33\u0a35-\u0a36\u0a38-\u0a39\u0a3c\u0a3e-\u0a42\u0a47-\u0a48\u0a4b-\u0a4d\u0a59-\u0a5c\u0a5e\u0a66-\u0a74\u0a81-\u0a83\u0a85-\u0a8b\u0a8d\u0a8f-\u0a91\u0a93-\u0aa8\u0aaa-\u0ab0\u0ab2-\u0ab3\u0ab5-\u0ab9\u0abc-\u0ac5\u0ac7-\u0ac9\u0acb-\u0acd\u0ae0\u0ae6-\u0aef\u0b01-\u0b03\u0b05-\u0b0c\u0b0f-\u0b10\u0b13-\u0b28\u0b2a-\u0b30\u0b32-\u0b33\u0b36-\u0b39\u0b3c-\u0b43\u0b47-\u0b48\u0b4b-\u0b4d\u0b56-\u0b57\u0b5c-\u0b5d\u0b5f-\u0b61\u0b66-\u0b6f\u0b82-\u0b83\u0b85-\u0b8a\u0b8e-\u0b90\u0b92-\u0b95\u0b99-\u0b9a\u0b9c\u0b9e-\u0b9f\u0ba3-\u0ba4\u0ba8-\u0baa\u0bae-\u0bb5\u0bb7-\u0bb9\u0bbe-\u0bc2\u0bc6-\u0bc8\u0bca-\u0bcd\u0bd7\u0be7-\u0bef\u0c01-\u0c03\u0c05-\u0c0c\u0c0e-\u0c10\u0c12-\u0c28\u0c2a-\u0c33\u0c35-\u0c39\u0c3e-\u0c44\u0c46-\u0c48\u0c4a-\u0c4d\u0c55-\u0c56\u0c60-\u0c61\u0c66-\u0c6f\u0c82-\u0c83\u0c85-\u0c8c\u0c8e-\u0c90\u0c92-\u0ca8\u0caa-\u0cb3\u0cb5-\u0cb9\u0cbe-\u0cc4\u0cc6-\u0cc8\u0cca-\u0ccd\u0cd5-\u0cd6\u0cde\u0ce0-\u0ce1\u0ce6-\u0cef\u0d02-\u0d03\u0d05-\u0d0c\u0d0e-\u0d10\u0d12-\u0d28\u0d2a-\u0d39\u0d3e-\u0d43\u0d46-\u0d48\u0d4a-\u0d4d\u0d57\u0d60-\u0d61\u0d66-\u0d6f\u0e01-\u0e2e\u0e30-\u0e3a\u0e40-\u0e4e\u0e50-\u0e59\u0e81-\u0e82\u0e84\u0e87-\u0e88\u0e8a\u0e8d\u0e94-\u0e97\u0e99-\u0e9f\u0ea1-\u0ea3\u0ea5\u0ea7\u0eaa-\u0eab\u0ead-\u0eae\u0eb0-\u0eb9\u0ebb-\u0ebd\u0ec0-\u0ec4\u0ec6\u0ec8-\u0ecd\u0ed0-\u0ed9\u0f18-\u0f19\u0f20-\u0f29\u0f35\u0f37\u0f39\u0f3e-\u0f47\u0f49-\u0f69\u0f71-\u0f84\u0f86-\u0f8b\u0f90-\u0f95\u0f97\u0f99-\u0fad\u0fb1-\u0fb7\u0fb9\u10a0-\u10c5\u10d0-\u10f6\u1100\u1102-\u1103\u1105-\u1107\u1109\u110b-\u110c\u110e-\u1112\u113c\u113e\u1140\u114c\u114e\u1150\u1154-\u1155\u1159\u115f-\u1161\u1163\u1165\u1167\u1169\u116d-\u116e\u1172-\u1173\u1175\u119e\u11a8\u11ab\u11ae-\u11af\u11b7-\u11b8\u11ba\u11bc-\u11c2\u11eb\u11f0\u11f9\u1e00-\u1e9b\u1ea0-\u1ef9\u1f00-\u1f15\u1f18-\u1f1d\u1f20-\u1f45\u1f48-\u1f4d\u1f50-\u1f57\u1f59\u1f5b\u1f5d\u1f5f-\u1f7d\u1f80-\u1fb4\u1fb6-\u1fbc\u1fbe\u1fc2-\u1fc4\u1fc6-\u1fcc\u1fd0-\u1fd3\u1fd6-\u1fdb\u1fe0-\u1fec\u1ff2-\u1ff4\u1ff6-\u1ffc\u20d0-\u20dc\u20e1\u2126\u212a-\u212b\u212e\u2180-\u2182\u3005\u3007\u3021-\u302f\u3031-\u3035\u3041-\u3094\u3099-\u309a\u309d-\u309e\u30a1-\u30fa\u30fc-\u30fe\u3105-\u312c\u4e00-\u9fa5\uac00-\ud7a3]*:)?[A-Z_a-z\xc0-\xd6\xd8-\xf6\xf8-\u0131\u0134-\u013e\u0141-\u0148\u014a-\u017e\u0180-\u01c3\u01cd-\u01f0\u01f4-\u01f5\u01fa-\u0217\u0250-\u02a8\u02bb-\u02c1\u0386\u0388-\u038a\u038c\u038e-\u03a1\u03a3-\u03ce\u03d0-\u03d6\u03da\u03dc\u03de\u03e0\u03e2-\u03f3\u0401-\u040c\u040e-\u044f\u0451-\u045c\u045e-\u0481\u0490-\u04c4\u04c7-\u04c8\u04cb-\u04cc\u04d0-\u04eb\u04ee-\u04f5\u04f8-\u04f9\u0531-\u0556\u0559\u0561-\u0586\u05d0-\u05ea\u05f0-\u05f2\u0621-\u063a\u0641-\u064a\u0671-\u06b7\u06ba-\u06be\u06c0-\u06ce\u06d0-\u06d3\u06d5\u06e5-\u06e6\u0905-\u0939\u093d\u0958-\u0961\u0985-\u098c\u098f-\u0990\u0993-\u09a8\u09aa-\u09b0\u09b2\u09b6-\u09b9\u09dc-\u09dd\u09df-\u09e1\u09f0-\u09f1\u0a05-\u0a0a\u0a0f-\u0a10\u0a13-\u0a28\u0a2a-\u0a30\u0a32-\u0a33\u0a35-\u0a36\u0a38-\u0a39\u0a59-\u0a5c\u0a5e\u0a72-\u0a74\u0a85-\u0a8b\u0a8d\u0a8f-\u0a91\u0a93-\u0aa8\u0aaa-\u0ab0\u0ab2-\u0ab3\u0ab5-\u0ab9\u0abd\u0ae0\u0b05-\u0b0c\u0b0f-\u0b10\u0b13-\u0b28\u0b2a-\u0b30\u0b32-\u0b33\u0b36-\u0b39\u0b3d\u0b5c-\u0b5d\u0b5f-\u0b61\u0b85-\u0b8a\u0b8e-\u0b90\u0b92-\u0b95\u0b99-\u0b9a\u0b9c\u0b9e-\u0b9f\u0ba3-\u0ba4\u0ba8-\u0baa\u0bae-\u0bb5\u0bb7-\u0bb9\u0c05-\u0c0c\u0c0e-\u0c10\u0c12-\u0c28\u0c2a-\u0c33\u0c35-\u0c39\u0c60-\u0c61\u0c85-\u0c8c\u0c8e-\u0c90\u0c92-\u0ca8\u0caa-\u0cb3\u0cb5-\u0cb9\u0cde\u0ce0-\u0ce1\u0d05-\u0d0c\u0d0e-\u0d10\u0d12-\u0d28\u0d2a-\u0d39\u0d60-\u0d61\u0e01-\u0e2e\u0e30\u0e32-\u0e33\u0e40-\u0e45\u0e81-\u0e82\u0e84\u0e87-\u0e88\u0e8a\u0e8d\u0e94-\u0e97\u0e99-\u0e9f\u0ea1-\u0ea3\u0ea5\u0ea7\u0eaa-\u0eab\u0ead-\u0eae\u0eb0\u0eb2-\u0eb3\u0ebd\u0ec0-\u0ec4\u0f40-\u0f47\u0f49-\u0f69\u10a0-\u10c5\u10d0-\u10f6\u1100\u1102-\u1103\u1105-\u1107\u1109\u110b-\u110c\u110e-\u1112\u113c\u113e\u1140\u114c\u114e\u1150\u1154-\u1155\u1159\u115f-\u1161\u1163\u1165\u1167\u1169\u116d-\u116e\u1172-\u1173\u1175\u119e\u11a8\u11ab\u11ae-\u11af\u11b7-\u11b8\u11ba\u11bc-\u11c2\u11eb\u11f0\u11f9\u1e00-\u1e9b\u1ea0-\u1ef9\u1f00-\u1f15\u1f18-\u1f1d\u1f20-\u1f45\u1f48-\u1f4d\u1f50-\u1f57\u1f59\u1f5b\u1f5d\u1f5f-\u1f7d\u1f80-\u1fb4\u1fb6-\u1fbc\u1fbe\u1fc2-\u1fc4\u1fc6-\u1fcc\u1fd0-\u1fd3\u1fd6-\u1fdb\u1fe0-\u1fec\u1ff2-\u1ff4\u1ff6-\u1ffc\u2126\u212a-\u212b\u212e\u2180-\u2182\u3007\u3021-\u3029\u3041-\u3094\u30a1-\u30fa\u3105-\u312c\u4e00-\u9fa5\uac00-\ud7a3][\\--.0-9A-Z_a-z\xb7\xc0-\xd6\xd8-\xf6\xf8-\u0131\u0134-\u013e\u0141-\u0148\u014a-\u017e\u0180-\u01c3\u01cd-\u01f0\u01f4-\u01f5\u01fa-\u0217\u0250-\u02a8\u02bb-\u02c1\u02d0-\u02d1\u0300-\u0345\u0360-\u0361\u0386-\u038a\u038c\u038e-\u03a1\u03a3-\u03ce\u03d0-\u03d6\u03da\u03dc\u03de\u03e0\u03e2-\u03f3\u0401-\u040c\u040e-\u044f\u0451-\u045c\u045e-\u0481\u0483-\u0486\u0490-\u04c4\u04c7-\u04c8\u04cb-\u04cc\u04d0-\u04eb\u04ee-\u04f5\u04f8-\u04f9\u0531-\u0556\u0559\u0561-\u0586\u0591-\u05a1\u05a3-\u05b9\u05bb-\u05bd\u05bf\u05c1-\u05c2\u05c4\u05d0-\u05ea\u05f0-\u05f2\u0621-\u063a\u0640-\u0652\u0660-\u0669\u0670-\u06b7\u06ba-\u06be\u06c0-\u06ce\u06d0-\u06d3\u06d5-\u06e8\u06ea-\u06ed\u06f0-\u06f9\u0901-\u0903\u0905-\u0939\u093c-\u094d\u0951-\u0954\u0958-\u0963\u0966-\u096f\u0981-\u0983\u0985-\u098c\u098f-\u0990\u0993-\u09a8\u09aa-\u09b0\u09b2\u09b6-\u09b9\u09bc\u09be-\u09c4\u09c7-\u09c8\u09cb-\u09cd\u09d7\u09dc-\u09dd\u09df-\u09e3\u09e6-\u09f1\u0a02\u0a05-\u0a0a\u0a0f-\u0a10\u0a13-\u0a28\u0a2a-\u0a30\u0a32-\u0a33\u0a35-\u0a36\u0a38-\u0a39\u0a3c\u0a3e-\u0a42\u0a47-\u0a48\u0a4b-\u0a4d\u0a59-\u0a5c\u0a5e\u0a66-\u0a74\u0a81-\u0a83\u0a85-\u0a8b\u0a8d\u0a8f-\u0a91\u0a93-\u0aa8\u0aaa-\u0ab0\u0ab2-\u0ab3\u0ab5-\u0ab9\u0abc-\u0ac5\u0ac7-\u0ac9\u0acb-\u0acd\u0ae0\u0ae6-\u0aef\u0b01-\u0b03\u0b05-\u0b0c\u0b0f-\u0b10\u0b13-\u0b28\u0b2a-\u0b30\u0b32-\u0b33\u0b36-\u0b39\u0b3c-\u0b43\u0b47-\u0b48\u0b4b-\u0b4d\u0b56-\u0b57\u0b5c-\u0b5d\u0b5f-\u0b61\u0b66-\u0b6f\u0b82-\u0b83\u0b85-\u0b8a\u0b8e-\u0b90\u0b92-\u0b95\u0b99-\u0b9a\u0b9c\u0b9e-\u0b9f\u0ba3-\u0ba4\u0ba8-\u0baa\u0bae-\u0bb5\u0bb7-\u0bb9\u0bbe-\u0bc2\u0bc6-\u0bc8\u0bca-\u0bcd\u0bd7\u0be7-\u0bef\u0c01-\u0c03\u0c05-\u0c0c\u0c0e-\u0c10\u0c12-\u0c28\u0c2a-\u0c33\u0c35-\u0c39\u0c3e-\u0c44\u0c46-\u0c48\u0c4a-\u0c4d\u0c55-\u0c56\u0c60-\u0c61\u0c66-\u0c6f\u0c82-\u0c83\u0c85-\u0c8c\u0c8e-\u0c90\u0c92-\u0ca8\u0caa-\u0cb3\u0cb5-\u0cb9\u0cbe-\u0cc4\u0cc6-\u0cc8\u0cca-\u0ccd\u0cd5-\u0cd6\u0cde\u0ce0-\u0ce1\u0ce6-\u0cef\u0d02-\u0d03\u0d05-\u0d0c\u0d0e-\u0d10\u0d12-\u0d28\u0d2a-\u0d39\u0d3e-\u0d43\u0d46-\u0d48\u0d4a-\u0d4d\u0d57\u0d60-\u0d61\u0d66-\u0d6f\u0e01-\u0e2e\u0e30-\u0e3a\u0e40-\u0e4e\u0e50-\u0e59\u0e81-\u0e82\u0e84\u0e87-\u0e88\u0e8a\u0e8d\u0e94-\u0e97\u0e99-\u0e9f\u0ea1-\u0ea3\u0ea5\u0ea7\u0eaa-\u0eab\u0ead-\u0eae\u0eb0-\u0eb9\u0ebb-\u0ebd\u0ec0-\u0ec4\u0ec6\u0ec8-\u0ecd\u0ed0-\u0ed9\u0f18-\u0f19\u0f20-\u0f29\u0f35\u0f37\u0f39\u0f3e-\u0f47\u0f49-\u0f69\u0f71-\u0f84\u0f86-\u0f8b\u0f90-\u0f95\u0f97\u0f99-\u0fad\u0fb1-\u0fb7\u0fb9\u10a0-\u10c5\u10d0-\u10f6\u1100\u1102-\u1103\u1105-\u1107\u1109\u110b-\u110c\u110e-\u1112\u113c\u113e\u1140\u114c\u114e\u1150\u1154-\u1155\u1159\u115f-\u1161\u1163\u1165\u1167\u1169\u116d-\u116e\u1172-\u1173\u1175\u119e\u11a8\u11ab\u11ae-\u11af\u11b7-\u11b8\u11ba\u11bc-\u11c2\u11eb\u11f0\u11f9\u1e00-\u1e9b\u1ea0-\u1ef9\u1f00-\u1f15\u1f18-\u1f1d\u1f20-\u1f45\u1f48-\u1f4d\u1f50-\u1f57\u1f59\u1f5b\u1f5d\u1f5f-\u1f7d\u1f80-\u1fb4\u1fb6-\u1fbc\u1fbe\u1fc2-\u1fc4\u1fc6-\u1fcc\u1fd0-\u1fd3\u1fd6-\u1fdb\u1fe0-\u1fec\u1ff2-\u1ff4\u1ff6-\u1ffc\u20d0-\u20dc\u20e1\u2126\u212a-\u212b\u212e\u2180-\u2182\u3005\u3007\u3021-\u302f\u3031-\u3035\u3041-\u3094\u3099-\u309a\u309d-\u309e\u30a1-\u30fa\u30fc-\u30fe\u3105-\u312c\u4e00-\u9fa5\uac00-\ud7a3]*'</em><a class="headerlink" href="#pyxb.utils.unicode.XML1p0e2.QName_pat" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.unicode.XML1p0e2.QName_re">
<code class="descname">QName_re</code><em class="property"> = <_sre.SRE_Pattern object at 0x4276480></em><a class="headerlink" href="#pyxb.utils.unicode.XML1p0e2.QName_re" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
</div>
<div class="section" id="module-pyxb.utils.unicode_data">
<span id="pyxb-utils-unicode-data-module"></span><h2>pyxb.utils.unicode_data module<a class="headerlink" href="#module-pyxb.utils.unicode_data" title="Permalink to this headline">¶</a></h2>
</div>
<div class="section" id="module-pyxb.utils.utility">
<span id="pyxb-utils-utility-module"></span><h2>pyxb.utils.utility module<a class="headerlink" href="#module-pyxb.utils.utility" title="Permalink to this headline">¶</a></h2>
<p>Utility functions and classes.</p>
<dl class="function">
<dt id="pyxb.utils.utility.BackfillComparisons">
<code class="descclassname">pyxb.utils.utility.</code><code class="descname">BackfillComparisons</code><span class="sig-paren">(</span><em>cls</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.utility.BackfillComparisons" title="Permalink to this definition">¶</a></dt>
<dd><p>Class decorator that fills in missing ordering methods.</p>
<p>Concept derived from Python 2.7.5 functools.total_ordering,
but this version requires that __eq__ and __lt__ be provided,
and unconditionally overrides __ne__, __gt__, __le__, and __ge__
with the derived versions.</p>
<p>This is still necessary in Python 3 because in Python 3 the
comparison x >= y is done by the __ge__ inherited from object,
which does not handle the case where x and y are not the same type
even if the underlying y < x would convert x to be compatible.</p>
</dd></dl>
<dl class="function">
<dt id="pyxb.utils.utility.DataFromURI">
<code class="descclassname">pyxb.utils.utility.</code><code class="descname">DataFromURI</code><span class="sig-paren">(</span><em>uri</em>, <em>archive_directory=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.utility.DataFromURI" title="Permalink to this definition">¶</a></dt>
<dd><p>Retrieve the contents of the uri as raw data.</p>
<p>If the uri does not include a scheme (e.g., <code class="xref py py-obj docutils literal"><span class="pre">http:</span></code>), it is
assumed to be a file path on the local system.</p>
</dd></dl>
<dl class="function">
<dt id="pyxb.utils.utility.DeconflictKeyword">
<code class="descclassname">pyxb.utils.utility.</code><code class="descname">DeconflictKeyword</code><span class="sig-paren">(</span><em>s</em>, <em>aux_keywords=frozenset([])</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.utility.DeconflictKeyword" title="Permalink to this definition">¶</a></dt>
<dd><p>If the provided string <code class="xref py py-obj docutils literal"><span class="pre">s</span></code> matches a Python language keyword,
append an underscore to distinguish them.</p>
<p>See also <a class="reference internal" href="#pyxb.utils.utility.MakeUnique" title="pyxb.utils.utility.MakeUnique"><code class="xref py py-obj docutils literal"><span class="pre">MakeUnique</span></code></a>.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>s</strong> – string to be deconflicted</li>
<li><strong>aux_keywords</strong> – optional iterable of additional strings</li>
</ul>
</td>
</tr>
</tbody>
</table>
<p>that should be treated as keywords.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><code class="xref py py-obj docutils literal"><span class="pre">str</span></code></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="pyxb.utils.utility.GetMatchingFiles">
<code class="descclassname">pyxb.utils.utility.</code><code class="descname">GetMatchingFiles</code><span class="sig-paren">(</span><em>path</em>, <em>pattern=None</em>, <em>default_path_wildcard=None</em>, <em>default_path=None</em>, <em>prefix_pattern=None</em>, <em>prefix_substituend=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.utility.GetMatchingFiles" title="Permalink to this definition">¶</a></dt>
<dd><p>Provide a list of absolute paths to files present in any of a
set of directories and meeting certain criteria.</p>
<p>This is used, for example, to locate namespace archive files
within the archive path specified by the user. One could use:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">files</span> <span class="o">=</span> <span class="n">GetMatchingFiles</span><span class="p">(</span><span class="s1">'&bundles//:+'</span><span class="p">,</span>
<span class="n">pattern</span><span class="o">=</span><span class="n">re</span><span class="o">.</span><span class="n">compile</span><span class="p">(</span><span class="s1">'.*\.wxs$'</span><span class="p">),</span>
<span class="n">default_path_wildcard</span><span class="o">=</span><span class="s1">'+'</span><span class="p">,</span>
<span class="n">default_path</span><span class="o">=</span><span class="s1">'/usr/local/pyxb/nsarchives'</span><span class="p">,</span>
<span class="n">prefix_pattern</span><span class="o">=</span><span class="s1">'&'</span><span class="p">,</span>
<span class="n">prefix_substituend</span><span class="o">=</span><span class="s1">'/opt/pyxb'</span><span class="p">)</span>
</pre></div>
</div>
<p>to obtain all files that can be recursively found within
<code class="xref py py-obj docutils literal"><span class="pre">/opt/pyxb/bundles</span></code>, or non-recursively within
<code class="xref py py-obj docutils literal"><span class="pre">/usr/local/pyxb/nsarchives</span></code>.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>path</strong> – A list of directories in which the search should be</td>
</tr>
</tbody>
</table>
<p>performed. The entries are separated by os.pathsep, which is a
colon on POSIX platforms and a semi-colon on Windows. If a path
entry ends with <code class="xref py py-obj docutils literal"><span class="pre">//</span></code> regardless of platform, the suffix <code class="xref py py-obj docutils literal"><span class="pre">//</span></code> is
stripped and any directory beneath the path is scanned as well,
recursively.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>pattern</strong> – Optional regular expression object used to</td>
</tr>
</tbody>
</table>
<p>determine whether a given directory entry should be returned. If
left as <code class="xref py py-obj docutils literal"><span class="pre">None</span></code>, all directory entries will be returned.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>default_path_wildcard</strong> – An optional string which, if</td>
</tr>
</tbody>
</table>
<p>present as a single directory in the path, is replaced by the
value of <code class="xref py py-obj docutils literal"><span class="pre">default-path</span></code>.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>default_path</strong> – A system-defined directory which can be</td>
</tr>
</tbody>
</table>
<p>restored to the path by placing the <code class="xref py py-obj docutils literal"><span class="pre">default_path_wildcard</span></code> in
the <code class="xref py py-obj docutils literal"><span class="pre">path</span></code>.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>prefix_pattern</strong> – An optional string which, if present at</td>
</tr>
</tbody>
</table>
<p>the start of a path element, is replaced by the value of
<code class="xref py py-obj docutils literal"><span class="pre">prefix_substituend</span></code>.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>prefix_substituend</strong> – A system-defined string (path prefix)</td>
</tr>
</tbody>
</table>
<p>which can be combined with the user-provided path information to
identify a file or subdirectory within an installation-specific
area.</p>
</dd></dl>
<dl class="class">
<dt id="pyxb.utils.utility.Graph">
<em class="property">class </em><code class="descclassname">pyxb.utils.utility.</code><code class="descname">Graph</code><span class="sig-paren">(</span><em>root=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.utility.Graph" title="Permalink to this definition">¶</a></dt>
<dd><p>Represent a directed graph with arbitrary objects as nodes.</p>
<p>This is used in the L{code
generator<pyxb.binding.generate.Generator>} to determine order
dependencies among components within a namespace, and schema that
comprise various namespaces. An edge from <code class="xref py py-obj docutils literal"><span class="pre">source</span></code> to <code class="xref py py-obj docutils literal"><span class="pre">target</span></code>
indicates that some aspect of <code class="xref py py-obj docutils literal"><span class="pre">source</span></code> requires that some aspect
of <code class="xref py py-obj docutils literal"><span class="pre">target</span></code> already be available.</p>
<dl class="attribute">
<dt id="pyxb.utils.utility.Graph._Graph__dfsOrder">
<code class="descname">_Graph__dfsOrder</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.utils.utility.Graph._Graph__dfsOrder" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.utils.utility.Graph._Graph__dfsWalk">
<code class="descname">_Graph__dfsWalk</code><span class="sig-paren">(</span><em>source</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.utility.Graph._Graph__dfsWalk" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.utility.Graph._Graph__edgeMap">
<code class="descname">_Graph__edgeMap</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.utils.utility.Graph._Graph__edgeMap" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.utility.Graph._Graph__roots">
<code class="descname">_Graph__roots</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.utils.utility.Graph._Graph__roots" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.utility.Graph._Graph__scc">
<code class="descname">_Graph__scc</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.utils.utility.Graph._Graph__scc" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.utility.Graph._Graph__sccMap">
<code class="descname">_Graph__sccMap</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.utils.utility.Graph._Graph__sccMap" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.utility.Graph._Graph__sccOrder">
<code class="descname">_Graph__sccOrder</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.utils.utility.Graph._Graph__sccOrder" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.utils.utility.Graph._generateDOT">
<code class="descname">_generateDOT</code><span class="sig-paren">(</span><em>title='UNKNOWN'</em>, <em>labeller=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.utility.Graph._generateDOT" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.utils.utility.Graph._tarjan">
<code class="descname">_tarjan</code><span class="sig-paren">(</span><em>v</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.utility.Graph._tarjan" title="Permalink to this definition">¶</a></dt>
<dd><p>Do the work of Tarjan’s algorithm for a given root node.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.utility.Graph.addEdge">
<code class="descname">addEdge</code><span class="sig-paren">(</span><em>source</em>, <em>target</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.utility.Graph.addEdge" title="Permalink to this definition">¶</a></dt>
<dd><p>Add a directed edge from the <code class="xref py py-obj docutils literal"><span class="pre">source</span></code> to the <code class="xref py py-obj docutils literal"><span class="pre">target</span></code>.</p>
<p>The nodes are added to the graph if necessary.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.utility.Graph.addNode">
<code class="descname">addNode</code><span class="sig-paren">(</span><em>node</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.utility.Graph.addNode" title="Permalink to this definition">¶</a></dt>
<dd><p>Add the given node to the graph.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.utility.Graph.addRoot">
<code class="descname">addRoot</code><span class="sig-paren">(</span><em>root</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.utility.Graph.addRoot" title="Permalink to this definition">¶</a></dt>
<dd><p>Add the provided node as a root node, even if it has incoming edges.</p>
<p>The node need not be present in the graph (if necessary, it is added).</p>
<p>Note that roots added in this way do not survive a reset using
<a class="reference internal" href="#pyxb.utils.utility.Graph.roots" title="pyxb.utils.utility.Graph.roots"><code class="xref py py-obj docutils literal"><span class="pre">roots</span></code></a>.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><code class="xref py py-obj docutils literal"><span class="pre">self</span></code></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.utility.Graph.cyclomaticComplexity">
<code class="descname">cyclomaticComplexity</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.utility.Graph.cyclomaticComplexity" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the cyclomatic complexity of the graph.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.utility.Graph.dfsOrder">
<code class="descname">dfsOrder</code><span class="sig-paren">(</span><em>reset=False</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.utility.Graph.dfsOrder" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the nodes of the graph in U{depth-first-search
order<<a class="reference external" href="http://en.wikipedia.org/wiki/Depth-first_search">http://en.wikipedia.org/wiki/Depth-first_search</a>>}.</p>
<p>The data structure is a list. Calculated lists are retained
and returned on future invocations, subject to the <code class="xref py py-obj docutils literal"><span class="pre">reset</span></code>
keyword.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>reset</strong> – If <code class="xref py py-obj docutils literal"><span class="pre">True</span></code>, discard cached results and recompute the order.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.utility.Graph.edgeMap">
<code class="descname">edgeMap</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.utility.Graph.edgeMap" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the edges in the graph.</p>
<p>The edge data structure is a map from the source node to the
set of nodes that can be reached in a single step from the
source.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.utility.Graph.edges">
<code class="descname">edges</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.utility.Graph.edges" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the edges in the graph.</p>
<p>The edge data structure is a set of node pairs represented as <code class="xref py py-obj docutils literal"><span class="pre">(</span> <span class="pre">source,</span> <span class="pre">target</span> <span class="pre">)</span></code>.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.utility.Graph.nodes">
<code class="descname">nodes</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.utility.Graph.nodes" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the set of nodes in the graph.</p>
<p>The node collection data structure is a set containing node
objects, whatever they may be.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.utility.Graph.rootSetOrder">
<code class="descname">rootSetOrder</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.utility.Graph.rootSetOrder" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the nodes of the graph as a sequence of root sets.</p>
<p>The first root set is the set of nodes that are roots: i.e.,
have no incoming edges. The second root set is the set of
nodes that have incoming nodes in the first root set. This
continues until all nodes have been reached. The sets impose
a partial order on the nodes, without being as constraining as
<a class="reference internal" href="#pyxb.utils.utility.Graph.sccOrder" title="pyxb.utils.utility.Graph.sccOrder"><code class="xref py py-obj docutils literal"><span class="pre">sccOrder</span></code></a>.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">a list of the root sets.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.utility.Graph.roots">
<code class="descname">roots</code><span class="sig-paren">(</span><em>reset=False</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.utility.Graph.roots" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the set of nodes calculated to be roots (i.e., those that have no incoming edges).</p>
<p>This caches the roots calculated in a previous invocation
unless the <code class="xref py py-obj docutils literal"><span class="pre">reset</span></code> keyword is given the value <code class="xref py py-obj docutils literal"><span class="pre">True</span></code>.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Note:</th><td class="field-body">Upon reset, any notes that had been manually added</td>
</tr>
</tbody>
</table>
<p>using <a class="reference internal" href="#pyxb.utils.utility.Graph.addNode" title="pyxb.utils.utility.Graph.addNode"><code class="xref py py-obj docutils literal"><span class="pre">addNode</span></code></a> will no longer be in the set.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>reset</strong> – If <code class="xref py py-obj docutils literal"><span class="pre">True</span></code>, any cached value is discarded and</td>
</tr>
</tbody>
</table>
<p>recomputed. No effect if <code class="xref py py-obj docutils literal"><span class="pre">False</span></code> (defalut).</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><code class="xref py py-obj docutils literal"><span class="pre">set</span></code></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.utility.Graph.scc">
<code class="descname">scc</code><span class="sig-paren">(</span><em>reset=False</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.utility.Graph.scc" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the strongly-connected components of the graph.</p>
<p>The data structure is a set, each element of which is itself a
set containing one or more nodes from the graph.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">See:</th><td class="field-body"><a class="reference internal" href="#pyxb.utils.utility.Graph.tarjan" title="pyxb.utils.utility.Graph.tarjan"><code class="xref py py-obj docutils literal"><span class="pre">tarjan</span></code></a>.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.utility.Graph.sccForNode">
<code class="descname">sccForNode</code><span class="sig-paren">(</span><em>node</em>, <em>**kw</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.utility.Graph.sccForNode" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the strongly-connected component to which the given
node belongs.</p>
<p>Any keywords suppliend when invoking this method are passed to
the <a class="reference internal" href="#pyxb.utils.utility.Graph.sccMap" title="pyxb.utils.utility.Graph.sccMap"><code class="xref py py-obj docutils literal"><span class="pre">sccMap</span></code></a> method.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">The SCC set, or <code class="xref py py-obj docutils literal"><span class="pre">None</span></code> if the node is not present in</td>
</tr>
</tbody>
</table>
<p>the results of Tarjan’s algorithm.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.utility.Graph.sccMap">
<code class="descname">sccMap</code><span class="sig-paren">(</span><em>reset=False</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.utility.Graph.sccMap" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a map from nodes to the strongly-connected component
to which the node belongs.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>reset</strong> – If <code class="xref py py-obj docutils literal"><span class="pre">True</span></code>, the <a class="reference internal" href="#pyxb.utils.utility.Graph.tarjan" title="pyxb.utils.utility.Graph.tarjan"><code class="xref py py-obj docutils literal"><span class="pre">tarjan</span></code></a> method will be</td>
</tr>
</tbody>
</table>
<p>re-invoked, propagating the <code class="xref py py-obj docutils literal"><span class="pre">reset</span></code> value. If <code class="xref py py-obj docutils literal"><span class="pre">False</span></code>
(default), a cached value will be returned if available.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">See:</th><td class="field-body"><a class="reference internal" href="#pyxb.utils.utility.Graph.tarjan" title="pyxb.utils.utility.Graph.tarjan"><code class="xref py py-obj docutils literal"><span class="pre">tarjan</span></code></a>.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.utility.Graph.sccOrder">
<code class="descname">sccOrder</code><span class="sig-paren">(</span><em>reset=False</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.utility.Graph.sccOrder" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the strongly-connected components in order.</p>
<p>The data structure is a list, in dependency order, of strongly
connected components (which can be single nodes). Appearance
of a node in a set earlier in the list indicates that it has
no dependencies on any node that appears in a subsequent set.
This order is preferred over <a class="reference internal" href="#pyxb.utils.utility.Graph.dfsOrder" title="pyxb.utils.utility.Graph.dfsOrder"><code class="xref py py-obj docutils literal"><span class="pre">dfsOrder</span></code></a> for code generation,
since it detects loops.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">See:</th><td class="field-body"><a class="reference internal" href="#pyxb.utils.utility.Graph.tarjan" title="pyxb.utils.utility.Graph.tarjan"><code class="xref py py-obj docutils literal"><span class="pre">tarjan</span></code></a>.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.utility.Graph.tarjan">
<code class="descname">tarjan</code><span class="sig-paren">(</span><em>reset=False</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.utility.Graph.tarjan" title="Permalink to this definition">¶</a></dt>
<dd><p>Execute Tarjan’s algorithm on the graph.</p>
<p>U{Tarjan’s
algorithm<<a class="reference external" href="http://en.wikipedia.org/wiki/Tarjan%27s_strongly_connected_components_algorithm">http://en.wikipedia.org/wiki/Tarjan%27s_strongly_connected_components_algorithm</a>>}
computes the U{strongly-connected
components<<a class="reference external" href="http://en.wikipedia.org/wiki/Strongly_connected_component">http://en.wikipedia.org/wiki/Strongly_connected_component</a>>}
of the graph: i.e., the sets of nodes that form a minimal
closed set under edge transition. In essence, the loops. We
use this to detect groups of components that have a dependency
cycle.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>reset</strong> – If <code class="xref py py-obj docutils literal"><span class="pre">True</span></code>, any cached component set is erased</td>
</tr>
</tbody>
</table>
<p>and recomputed. If <code class="xref py py-obj docutils literal"><span class="pre">True</span></code>, an existing previous result is
left unchanged.</p>
</dd></dl>
</dd></dl>
<dl class="function">
<dt id="pyxb.utils.utility.HashForText">
<code class="descclassname">pyxb.utils.utility.</code><code class="descname">HashForText</code><span class="sig-paren">(</span><em>text</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.utility.HashForText" title="Permalink to this definition">¶</a></dt>
<dd><p>Calculate a cryptographic hash of the given string.</p>
<p>For example, this is used to verify that a given module file
contains bindings from a previous generation run for the same
namespace. See <a class="reference internal" href="#pyxb.utils.utility.OpenOrCreate" title="pyxb.utils.utility.OpenOrCreate"><code class="xref py py-obj docutils literal"><span class="pre">OpenOrCreate</span></code></a>. If the text is in Unicode, the
hash is calculated on the UTF-8 encoding of the text.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">A <code class="xref py py-obj docutils literal"><span class="pre">str</span></code>, generally a sequence of hexadecimal “digit”s.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="pyxb.utils.utility.IteratedCompareMixed">
<code class="descclassname">pyxb.utils.utility.</code><code class="descname">IteratedCompareMixed</code><span class="sig-paren">(</span><em>lhs</em>, <em>rhs</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.utility.IteratedCompareMixed" title="Permalink to this definition">¶</a></dt>
<dd><p>Tuple comparison that permits <code class="xref py py-obj docutils literal"><span class="pre">None</span></code> as lower than any value,
and defines other cross-type comparison.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">-1 if lhs < rhs, 0 if lhs == rhs, 1 if lhs > rhs.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="class">
<dt id="pyxb.utils.utility.LocalTimeZone">
<em class="property">class </em><code class="descclassname">pyxb.utils.utility.</code><code class="descname">LocalTimeZone</code><a class="headerlink" href="#pyxb.utils.utility.LocalTimeZone" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">datetime.tzinfo</span></code></p>
<p>A <code class="xref py py-obj docutils literal"><span class="pre">datetime.tzinfo</span></code> subclass for the local time zone.</p>
<p>Mostly pinched from the <code class="xref py py-obj docutils literal"><span class="pre">datetime.tzinfo</span></code> documentation in Python 2.5.1.</p>
<dl class="attribute">
<dt id="pyxb.utils.utility.LocalTimeZone._LocalTimeZone__DSTDelta">
<code class="descname">_LocalTimeZone__DSTDelta</code><em class="property"> = datetime.timedelta(0, 3600)</em><a class="headerlink" href="#pyxb.utils.utility.LocalTimeZone._LocalTimeZone__DSTDelta" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.utility.LocalTimeZone._LocalTimeZone__DSTOffset">
<code class="descname">_LocalTimeZone__DSTOffset</code><em class="property"> = datetime.timedelta(-1, 68400)</em><a class="headerlink" href="#pyxb.utils.utility.LocalTimeZone._LocalTimeZone__DSTOffset" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.utility.LocalTimeZone._LocalTimeZone__STDOffset">
<code class="descname">_LocalTimeZone__STDOffset</code><em class="property"> = datetime.timedelta(-1, 64800)</em><a class="headerlink" href="#pyxb.utils.utility.LocalTimeZone._LocalTimeZone__STDOffset" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.utility.LocalTimeZone._LocalTimeZone__ZeroDelta">
<code class="descname">_LocalTimeZone__ZeroDelta</code><em class="property"> = datetime.timedelta(0)</em><a class="headerlink" href="#pyxb.utils.utility.LocalTimeZone._LocalTimeZone__ZeroDelta" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.utils.utility.LocalTimeZone._LocalTimeZone__isDST">
<code class="descname">_LocalTimeZone__isDST</code><span class="sig-paren">(</span><em>dt</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.utility.LocalTimeZone._LocalTimeZone__isDST" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.utils.utility.LocalTimeZone.dst">
<code class="descname">dst</code><span class="sig-paren">(</span><em>dt</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.utility.LocalTimeZone.dst" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.utils.utility.LocalTimeZone.tzname">
<code class="descname">tzname</code><span class="sig-paren">(</span><em>dt</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.utility.LocalTimeZone.tzname" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.utils.utility.LocalTimeZone.utcoffset">
<code class="descname">utcoffset</code><span class="sig-paren">(</span><em>dt</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.utility.LocalTimeZone.utcoffset" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="pyxb.utils.utility.Locatable_mixin">
<em class="property">class </em><code class="descclassname">pyxb.utils.utility.</code><code class="descname">Locatable_mixin</code><span class="sig-paren">(</span><em>*args</em>, <em>**kw</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.utility.Locatable_mixin" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="pyxb.html#pyxb.cscRoot" title="pyxb.cscRoot"><code class="xref py py-class docutils literal"><span class="pre">pyxb.cscRoot</span></code></a></p>
<dl class="attribute">
<dt id="pyxb.utils.utility.Locatable_mixin._Locatable_mixin__location">
<code class="descname">_Locatable_mixin__location</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.utils.utility.Locatable_mixin._Locatable_mixin__location" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.utils.utility.Locatable_mixin._location">
<code class="descname">_location</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.utility.Locatable_mixin._location" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.utils.utility.Locatable_mixin._setLocation">
<code class="descname">_setLocation</code><span class="sig-paren">(</span><em>location</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.utility.Locatable_mixin._setLocation" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="pyxb.utils.utility.Location">
<em class="property">class </em><code class="descclassname">pyxb.utils.utility.</code><code class="descname">Location</code><span class="sig-paren">(</span><em>location_base=None</em>, <em>line_number=None</em>, <em>column_number=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.utility.Location" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
<dl class="method">
<dt id="pyxb.utils.utility.Location._Location__cmpSingleUnlessNone">
<code class="descname">_Location__cmpSingleUnlessNone</code><span class="sig-paren">(</span><em>v1</em>, <em>v2</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.utility.Location._Location__cmpSingleUnlessNone" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.utils.utility.Location._Location__cmpTupleUnlessNone">
<code class="descname">_Location__cmpTupleUnlessNone</code><span class="sig-paren">(</span><em>v1</em>, <em>v2</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.utility.Location._Location__cmpTupleUnlessNone" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.utility.Location._Location__columnNumber">
<code class="descname">_Location__columnNumber</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.utils.utility.Location._Location__columnNumber" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.utility.Location._Location__lineNumber">
<code class="descname">_Location__lineNumber</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.utils.utility.Location._Location__lineNumber" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.utility.Location._Location__locationBase">
<code class="descname">_Location__locationBase</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.utils.utility.Location._Location__locationBase" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.utility.Location.columnNumber">
<code class="descname">columnNumber</code><a class="headerlink" href="#pyxb.utils.utility.Location.columnNumber" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.utility.Location.lineNumber">
<code class="descname">lineNumber</code><a class="headerlink" href="#pyxb.utils.utility.Location.lineNumber" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.utility.Location.locationBase">
<code class="descname">locationBase</code><a class="headerlink" href="#pyxb.utils.utility.Location.locationBase" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.utils.utility.Location.newLocation">
<code class="descname">newLocation</code><span class="sig-paren">(</span><em>locator=None</em>, <em>line_number=None</em>, <em>column_number=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.utility.Location.newLocation" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="function">
<dt id="pyxb.utils.utility.MakeIdentifier">
<code class="descclassname">pyxb.utils.utility.</code><code class="descname">MakeIdentifier</code><span class="sig-paren">(</span><em>s</em>, <em>camel_case=False</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.utility.MakeIdentifier" title="Permalink to this definition">¶</a></dt>
<dd><p>Convert a string into something suitable to be a Python identifier.</p>
<p>The string is processed by <a class="reference internal" href="#pyxb.utils.utility._XMLIdentifierToPython" title="pyxb.utils.utility._XMLIdentifierToPython"><code class="xref py py-obj docutils literal"><span class="pre">_XMLIdentifierToPython</span></code></a>. Following
this, dashes, spaces, and periods are replaced by underscores, and
characters not permitted in Python identifiers are stripped.
Furthermore, any leading underscores are removed. If the result
begins with a digit, the character ‘n’ is prepended. If the
result is the empty string, the string ‘emptyString’ is
substituted.</p>
<p>No check is made for <a class="reference internal" href="#pyxb.utils.utility.DeconflictKeyword" title="pyxb.utils.utility.DeconflictKeyword"><code class="xref py py-obj docutils literal"><span class="pre">conflicts</span> <span class="pre">with</span> <span class="pre">keywords</span></code></a>.</p>
<p>:keyword camel_case : If <code class="xref py py-obj docutils literal"><span class="pre">True</span></code>, any underscore in the result
string that is immediately followed by an alphanumeric is replaced
by the capitalized version of that alphanumeric. Thus,
‘one_or_two’ becomes ‘oneOrTwo’. If <code class="xref py py-obj docutils literal"><span class="pre">False</span></code> (default), has no
effect.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><code class="xref py py-obj docutils literal"><span class="pre">str</span></code></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="pyxb.utils.utility.MakeModuleElement">
<code class="descclassname">pyxb.utils.utility.</code><code class="descname">MakeModuleElement</code><span class="sig-paren">(</span><em>s</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.utility.MakeModuleElement" title="Permalink to this definition">¶</a></dt>
<dd><p>Convert a string into something that can be a valid element in a
Python module path.</p>
<p>Module path elements are similar to identifiers, but may begin
with numbers and should not have leading underscores removed.</p>
</dd></dl>
<dl class="function">
<dt id="pyxb.utils.utility.MakeUnique">
<code class="descclassname">pyxb.utils.utility.</code><code class="descname">MakeUnique</code><span class="sig-paren">(</span><em>s</em>, <em>in_use</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.utility.MakeUnique" title="Permalink to this definition">¶</a></dt>
<dd><p>Return an identifier based on <code class="xref py py-obj docutils literal"><span class="pre">s</span></code> that is not in the given set.</p>
<p>The returned identifier is made unique by appending an underscore
and, if necessary, a serial number.</p>
<p>The order is : <code class="xref py py-obj docutils literal"><span class="pre">x</span></code>, <code class="xref py py-obj docutils literal"><span class="pre">x_</span></code>, <code class="xref py py-obj docutils literal"><span class="pre">x_2</span></code>, <code class="xref py py-obj docutils literal"><span class="pre">x_3</span></code>, ...</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>in_use</strong> – The set of identifiers already in use in the</td>
</tr>
</tbody>
</table>
<p>relevant scope. <code class="xref py py-obj docutils literal"><span class="pre">in_use</span></code> is updated to contain the returned
identifier.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><code class="xref py py-obj docutils literal"><span class="pre">str</span></code></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="pyxb.utils.utility.NormalizeLocation">
<code class="descclassname">pyxb.utils.utility.</code><code class="descname">NormalizeLocation</code><span class="sig-paren">(</span><em>uri</em>, <em>parent_uri=None</em>, <em>prefix_map=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.utility.NormalizeLocation" title="Permalink to this definition">¶</a></dt>
<dd><p>Normalize a URI against an optional parent_uri in the way that is
done for <code class="xref py py-obj docutils literal"><span class="pre">schemaLocation</span></code> attribute values.</p>
<p>If no URI schema is present, this will normalize a file system
path.</p>
<p>Optionally, the resulting absolute URI can subsequently be
rewritten to replace specified prefix strings with alternative
strings, e.g. to convert a remote URI to a local repository. This
rewriting is done after the conversion to an absolute URI, but
before normalizing file system URIs.</p>
<p>:param uri : The URI to normalize. If <code class="xref py py-obj docutils literal"><span class="pre">None</span></code>, function returns
<code class="xref py py-obj docutils literal"><span class="pre">None</span></code></p>
<p>:param parent_uri : The base URI against which normalization is
done, if <code class="xref py py-obj docutils literal"><span class="pre">uri</span></code> is a relative URI.</p>
<p>:param prefix_map : A map used to rewrite URI prefixes. If
<code class="xref py py-obj docutils literal"><span class="pre">None</span></code>, the value defaults to that stored by
<a class="reference internal" href="#pyxb.utils.utility.SetLocationPrefixRewriteMap" title="pyxb.utils.utility.SetLocationPrefixRewriteMap"><code class="xref py py-obj docutils literal"><span class="pre">SetLocationPrefixRewriteMap</span></code></a>.</p>
</dd></dl>
<dl class="function">
<dt id="pyxb.utils.utility.NormalizeWhitespace">
<code class="descclassname">pyxb.utils.utility.</code><code class="descname">NormalizeWhitespace</code><span class="sig-paren">(</span><em>text</em>, <em>preserve=False</em>, <em>replace=False</em>, <em>collapse=False</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.utility.NormalizeWhitespace" title="Permalink to this definition">¶</a></dt>
<dd><p>Normalize the given string.</p>
<p>Exactly one of the <code class="xref py py-obj docutils literal"><span class="pre">preserve</span></code>, <code class="xref py py-obj docutils literal"><span class="pre">replace</span></code>, and <code class="xref py py-obj docutils literal"><span class="pre">collapse</span></code> keyword
parameters must be assigned the value <code class="xref py py-obj docutils literal"><span class="pre">True</span></code> by the caller.</p>
<blockquote>
<div><ul class="simple">
<li><code class="xref py py-obj docutils literal"><span class="pre">preserve</span></code>: the text is returned unchanged.</li>
<li><code class="xref py py-obj docutils literal"><span class="pre">replace</span></code>: all tabs, newlines, and carriage returns are</li>
</ul>
<p>replaced with ASCII spaces.</p>
<ul class="simple">
<li><code class="xref py py-obj docutils literal"><span class="pre">collapse</span></code>: the <code class="xref py py-obj docutils literal"><span class="pre">replace</span></code> normalization is done, then</li>
</ul>
<p>sequences of two or more spaces are replaced by a single space.</p>
</div></blockquote>
<p>See the whiteSpace facet<<a class="reference external" href="http://www.w3.org/TR/xmlschema-2/#rf-whiteSpace">http://www.w3.org/TR/xmlschema-2/#rf-whiteSpace</a>>.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><code class="xref py py-obj docutils literal"><span class="pre">str</span></code></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="class">
<dt id="pyxb.utils.utility.Object">
<em class="property">class </em><code class="descclassname">pyxb.utils.utility.</code><code class="descname">Object</code><a class="headerlink" href="#pyxb.utils.utility.Object" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
<p>A dummy class used to hold arbitrary attributes.</p>
<p>Essentially this gives us a map without having to worry about
converting names to text to use as keys.</p>
</dd></dl>
<dl class="function">
<dt id="pyxb.utils.utility.OpenOrCreate">
<code class="descclassname">pyxb.utils.utility.</code><code class="descname">OpenOrCreate</code><span class="sig-paren">(</span><em>file_name</em>, <em>tag=None</em>, <em>preserve_contents=False</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.utility.OpenOrCreate" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a file object used to write binary data into the given file.</p>
<p>Use the <code class="xref py py-obj docutils literal"><span class="pre">tag</span></code> keyword to preserve the contents of existing files
that are not supposed to be overwritten.</p>
<p>To get a writable file but leaving any existing contents in place,
set the <code class="xref py py-obj docutils literal"><span class="pre">preserve_contents</span></code> keyword to <code class="xref py py-obj docutils literal"><span class="pre">True</span></code>. Normally, existing file
contents are erased.</p>
<p>The returned file pointer is positioned at the end of the file.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>tag</strong> – If not <code class="xref py py-obj docutils literal"><span class="pre">None</span></code> and the file already exists, absence</td>
</tr>
</tbody>
</table>
<p>of the given value in the first 4096 bytes of the file (decoded as
UTF-8) causes an <code class="xref py py-obj docutils literal"><span class="pre">IOError</span></code> to be raised with <code class="xref py py-obj docutils literal"><span class="pre">errno</span></code> set to
<code class="xref py py-obj docutils literal"><span class="pre">EEXIST</span></code>. I.e., only files with this value in the first 4KB will
be returned for writing.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>preserve_contents</strong> – This value controls whether existing</td>
</tr>
</tbody>
</table>
<p>contents of the file will be erased (<code class="xref py py-obj docutils literal"><span class="pre">False</span></code>, default) or left in
place (<code class="xref py py-obj docutils literal"><span class="pre">True</span></code>).</p>
</dd></dl>
<dl class="function">
<dt id="pyxb.utils.utility.PrepareIdentifier">
<code class="descclassname">pyxb.utils.utility.</code><code class="descname">PrepareIdentifier</code><span class="sig-paren">(</span><em>s</em>, <em>in_use</em>, <em>aux_keywords=frozenset([])</em>, <em>private=False</em>, <em>protected=False</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.utility.PrepareIdentifier" title="Permalink to this definition">¶</a></dt>
<dd><p>Combine everything required to create a unique identifier.</p>
<p>Leading and trailing underscores are stripped from all
identifiers.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>in_use</strong> – the set of already used identifiers. Upon return</td>
</tr>
</tbody>
</table>
<p>from this function, it is updated to include the returned
identifier.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>aux_keywords</strong> – an optional set of additional symbols that</td>
</tr>
</tbody>
</table>
<p>are illegal in the given context; use this to prevent conflicts
with known method names.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>private</strong> – if <code class="xref py py-obj docutils literal"><span class="pre">False</span></code> (default), all leading underscores</td>
</tr>
</tbody>
</table>
<p>are stripped, guaranteeing the identifier will not be private. If
<code class="xref py py-obj docutils literal"><span class="pre">True</span></code>, the returned identifier has two leading underscores,
making it a private variable within a Python class.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>protected</strong> – as for <code class="xref py py-obj docutils literal"><span class="pre">private</span></code>, but uses only one</td>
</tr>
</tbody>
</table>
<p>underscore.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><code class="xref py py-obj docutils literal"><span class="pre">str</span></code></td>
</tr>
<tr class="field-even field"><th class="field-name">Note:</th><td class="field-body">Only module-level identifiers should be treated as</td>
</tr>
</tbody>
</table>
<p>protected. The class-level <a class="reference internal" href="#pyxb.utils.utility._DeconflictSymbols_mixin" title="pyxb.utils.utility._DeconflictSymbols_mixin"><code class="xref py py-obj docutils literal"><span class="pre">_DeconflictSymbols_mixin</span></code></a>
infrastructure does not include protected symbols. All class and
instance members beginning with a single underscore are reserved
for the PyXB infrastructure.</p>
</dd></dl>
<dl class="class">
<dt id="pyxb.utils.utility.PrivateTransient_mixin">
<em class="property">class </em><code class="descclassname">pyxb.utils.utility.</code><code class="descname">PrivateTransient_mixin</code><span class="sig-paren">(</span><em>*args</em>, <em>**kw</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.utility.PrivateTransient_mixin" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="pyxb.html#pyxb.cscRoot" title="pyxb.cscRoot"><code class="xref py py-class docutils literal"><span class="pre">pyxb.cscRoot</span></code></a></p>
<p>Emulate the B{transient} keyword from Java for private member
variables.</p>
<p>This class defines a <code class="xref py py-obj docutils literal"><span class="pre">__getstate__</span></code> method which returns a copy
of <code class="xref py py-obj docutils literal"><span class="pre">self.__dict__</span></code> with certain members removed. Specifically,
if a string “s” appears in a class member variable named
<code class="xref py py-obj docutils literal"><span class="pre">__PrivateTransient</span></code> defined in the “Class” class, then the
corresponding private variable “_Class__s” will be removed from
the state dictionary. This is used to eliminate unnecessary
fields from instances placed in L{namespace
archives<pyxb.namespace.archive.NamespaceArchive>} without having
to implement a <code class="xref py py-obj docutils literal"><span class="pre">__getstate__</span></code> method in every class in the
instance hierarchy.</p>
<p>For an example, see
<a class="reference internal" href="pyxb.xmlschema.html#pyxb.xmlschema.structures._SchemaComponent_mixin" title="pyxb.xmlschema.structures._SchemaComponent_mixin"><code class="xref py py-obj docutils literal"><span class="pre">pyxb.xmlschema.structures._SchemaComponent_mixin</span></code></a></p>
<p>If you use this, it is your responsibility to define the
<code class="xref py py-obj docutils literal"><span class="pre">__PrivateTransient</span></code> class variable and add to it the required
variable names.</p>
<p>Classes that inherit from this are free to define their own
<code class="xref py py-obj docutils literal"><span class="pre">__getstate__</span></code> method, which may or may not invoke the superclass
one. If you do this, be sure that the class defining
<code class="xref py py-obj docutils literal"><span class="pre">__getstate__</span></code> lists <a class="reference internal" href="#pyxb.utils.utility.PrivateTransient_mixin" title="pyxb.utils.utility.PrivateTransient_mixin"><code class="xref py py-obj docutils literal"><span class="pre">PrivateTransient_mixin</span></code></a> as one of its
direct superclasses, lest the latter end up earlier in the mro and
consequently bypass the local override.</p>
<dl class="attribute">
<dt id="pyxb.utils.utility.PrivateTransient_mixin._PrivateTransient_mixin__Attribute">
<code class="descname">_PrivateTransient_mixin__Attribute</code><em class="property"> = '__PrivateTransient'</em><a class="headerlink" href="#pyxb.utils.utility.PrivateTransient_mixin._PrivateTransient_mixin__Attribute" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="function">
<dt id="pyxb.utils.utility.QuotedEscaped">
<code class="descclassname">pyxb.utils.utility.</code><code class="descname">QuotedEscaped</code><span class="sig-paren">(</span><em>s</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.utility.QuotedEscaped" title="Permalink to this definition">¶</a></dt>
<dd><p>Convert a string into a literal value that can be used in Python source.</p>
<p>This just calls <code class="xref py py-obj docutils literal"><span class="pre">repr</span></code>. No point in getting all complex when the language
already gives us what we need.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><code class="xref py py-obj docutils literal"><span class="pre">str</span></code></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="pyxb.utils.utility.SetLocationPrefixRewriteMap">
<code class="descclassname">pyxb.utils.utility.</code><code class="descname">SetLocationPrefixRewriteMap</code><span class="sig-paren">(</span><em>prefix_map</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.utility.SetLocationPrefixRewriteMap" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the map that is used to by <a class="reference internal" href="#pyxb.utils.utility.NormalizeLocation" title="pyxb.utils.utility.NormalizeLocation"><code class="xref py py-obj docutils literal"><span class="pre">NormalizeLocation</span></code></a> to rewrite URI prefixes.</p>
</dd></dl>
<dl class="class">
<dt id="pyxb.utils.utility.UTCOffsetTimeZone">
<em class="property">class </em><code class="descclassname">pyxb.utils.utility.</code><code class="descname">UTCOffsetTimeZone</code><span class="sig-paren">(</span><em>spec=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.utility.UTCOffsetTimeZone" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">datetime.tzinfo</span></code></p>
<p>A <code class="xref py py-obj docutils literal"><span class="pre">datetime.tzinfo</span></code> subclass that helps deal with UTC
conversions in an ISO8601 world.</p>
<p>This class only supports fixed offsets from UTC.</p>
<dl class="attribute">
<dt id="pyxb.utils.utility.UTCOffsetTimeZone._UTCOffsetTimeZone__Lexical_re">
<code class="descname">_UTCOffsetTimeZone__Lexical_re</code><em class="property"> = <_sre.SRE_Pattern object></em><a class="headerlink" href="#pyxb.utils.utility.UTCOffsetTimeZone._UTCOffsetTimeZone__Lexical_re" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.utility.UTCOffsetTimeZone._UTCOffsetTimeZone__MaxOffset_td">
<code class="descname">_UTCOffsetTimeZone__MaxOffset_td</code><em class="property"> = datetime.timedelta(0, 50400)</em><a class="headerlink" href="#pyxb.utils.utility.UTCOffsetTimeZone._UTCOffsetTimeZone__MaxOffset_td" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.utility.UTCOffsetTimeZone._UTCOffsetTimeZone__ZeroDuration">
<code class="descname">_UTCOffsetTimeZone__ZeroDuration</code><em class="property"> = datetime.timedelta(0)</em><a class="headerlink" href="#pyxb.utils.utility.UTCOffsetTimeZone._UTCOffsetTimeZone__ZeroDuration" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.utils.utility.UTCOffsetTimeZone._UTCOffsetTimeZone__otherForComparison">
<code class="descname">_UTCOffsetTimeZone__otherForComparison</code><span class="sig-paren">(</span><em>other</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.utility.UTCOffsetTimeZone._UTCOffsetTimeZone__otherForComparison" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.utility.UTCOffsetTimeZone._UTCOffsetTimeZone__utcOffset_min">
<code class="descname">_UTCOffsetTimeZone__utcOffset_min</code><em class="property"> = 0</em><a class="headerlink" href="#pyxb.utils.utility.UTCOffsetTimeZone._UTCOffsetTimeZone__utcOffset_min" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.utility.UTCOffsetTimeZone._UTCOffsetTimeZone__utcOffset_td">
<code class="descname">_UTCOffsetTimeZone__utcOffset_td</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.utils.utility.UTCOffsetTimeZone._UTCOffsetTimeZone__utcOffset_td" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.utils.utility.UTCOffsetTimeZone.dst">
<code class="descname">dst</code><span class="sig-paren">(</span><em>dt</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.utility.UTCOffsetTimeZone.dst" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns a constant zero duration.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.utility.UTCOffsetTimeZone.tzname">
<code class="descname">tzname</code><span class="sig-paren">(</span><em>dt</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.utility.UTCOffsetTimeZone.tzname" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the name of the timezone in the format expected by XML Schema.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.utility.UTCOffsetTimeZone.utcoffset">
<code class="descname">utcoffset</code><span class="sig-paren">(</span><em>dt</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.utility.UTCOffsetTimeZone.utcoffset" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the constant offset for this zone.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="pyxb.utils.utility.UniqueIdentifier">
<em class="property">class </em><code class="descclassname">pyxb.utils.utility.</code><code class="descname">UniqueIdentifier</code><span class="sig-paren">(</span><em>uid=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.utility.UniqueIdentifier" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
<p>Records a unique identifier, generally associated with a
binding generation action.</p>
<p>The identifier is a string, but gets wrapped in an instance of
this class to optimize comparisons and reduce memory footprint.</p>
<p>Invoking the constructor for this class on the same string
multiple times will return the same Python object.</p>
<p>An instance of this class compares equal to, and hashes equivalent
to, the uid string. When <code class="xref py py-obj docutils literal"><span class="pre">str</span></code>‘d, the result is the uid; when
<code class="xref py py-obj docutils literal"><span class="pre">repr</span></code>‘d, the result is a constructor call to
<a class="reference internal" href="#pyxb.utils.utility.UniqueIdentifier" title="pyxb.utils.utility.UniqueIdentifier"><code class="xref py py-obj docutils literal"><span class="pre">pyxb.utils.utility.UniqueIdentifier</span></code></a>.</p>
<dl class="attribute">
<dt id="pyxb.utils.utility.UniqueIdentifier._UniqueIdentifier__ExistingUIDs">
<code class="descname">_UniqueIdentifier__ExistingUIDs</code><em class="property"> = {'PyXB-1.2.6-Builtin': pyxb.utils.utility.UniqueIdentifier('PyXB-1.2.6-Builtin')}</em><a class="headerlink" href="#pyxb.utils.utility.UniqueIdentifier._UniqueIdentifier__ExistingUIDs" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.utility.UniqueIdentifier._UniqueIdentifier__associatedObjects">
<code class="descname">_UniqueIdentifier__associatedObjects</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.utils.utility.UniqueIdentifier._UniqueIdentifier__associatedObjects" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.utils.utility.UniqueIdentifier._UniqueIdentifier__uid">
<code class="descname">_UniqueIdentifier__uid</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.utils.utility.UniqueIdentifier._UniqueIdentifier__uid" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.utils.utility.UniqueIdentifier.associateObject">
<code class="descname">associateObject</code><span class="sig-paren">(</span><em>obj</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.utility.UniqueIdentifier.associateObject" title="Permalink to this definition">¶</a></dt>
<dd><p>Associate the given object witth this identifier.</p>
<p>This is a one-way association: the object is not provided with
a return path to this identifier instance.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.utility.UniqueIdentifier.associatedObjects">
<code class="descname">associatedObjects</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.utility.UniqueIdentifier.associatedObjects" title="Permalink to this definition">¶</a></dt>
<dd><p>The set of objects that have been associated with this
identifier instance.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.utils.utility.UniqueIdentifier.uid">
<code class="descname">uid</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.utility.UniqueIdentifier.uid" title="Permalink to this definition">¶</a></dt>
<dd><p>The string unique identifier</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="pyxb.utils.utility._DeconflictSymbols_mixin">
<em class="property">class </em><code class="descclassname">pyxb.utils.utility.</code><code class="descname">_DeconflictSymbols_mixin</code><a class="headerlink" href="#pyxb.utils.utility._DeconflictSymbols_mixin" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
<p>Mix-in used to deconflict public symbols in classes that may be
inherited by generated binding classes.</p>
<p>Some classes, like the <a class="reference internal" href="pyxb.binding.html#pyxb.binding.basis.element" title="pyxb.binding.basis.element"><code class="xref py py-obj docutils literal"><span class="pre">pyxb.binding.basis.element</span></code></a> or
<a class="reference internal" href="pyxb.binding.html#pyxb.binding.basis.simpleTypeDefinition" title="pyxb.binding.basis.simpleTypeDefinition"><code class="xref py py-obj docutils literal"><span class="pre">pyxb.binding.basis.simpleTypeDefinition</span></code></a> classes in
<a class="reference internal" href="pyxb.binding.html#module-pyxb.binding.basis" title="pyxb.binding.basis"><code class="xref py py-obj docutils literal"><span class="pre">pyxb.binding.basis</span></code></a>, have public symbols associated with
functions and variables. It is possible that an XML schema might
include tags and attribute names that match these symbols. To
avoid conflict, the reserved symbols marked in this class are
added to the pre-defined identifier set.</p>
<p>Subclasses should create a class-level variable
<a class="reference internal" href="#pyxb.utils.utility._DeconflictSymbols_mixin._ReservedSymbols" title="pyxb.utils.utility._DeconflictSymbols_mixin._ReservedSymbols"><code class="xref py py-obj docutils literal"><span class="pre">_ReservedSymbols</span></code></a> that contains a set of strings denoting the
symbols reserved in this class, combined with those from any
superclasses that also have reserved symbols. Code like the
following is suggested:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="c1"># For base classes (direct mix-in):</span>
<span class="n">_ReservedSymbols</span> <span class="o">=</span> <span class="nb">set</span><span class="p">([</span> <span class="s1">'one'</span><span class="p">,</span> <span class="s1">'two'</span> <span class="p">])</span>
<span class="c1"># For subclasses:</span>
<span class="n">_ReservedSymbols</span> <span class="o">=</span> <span class="n">SuperClass</span><span class="o">.</span><span class="n">_ReservedSymbols</span><span class="o">.</span><span class="n">union</span><span class="p">(</span><span class="nb">set</span><span class="p">([</span> <span class="s1">'three'</span> <span class="p">]))</span>
</pre></div>
</div>
<p>Only public symbols (those with no underscores) are currently
supported. (Private symbols can’t be deconflicted that easily,
and no protected symbols that derive from the XML are created by
the binding generator.)</p>
<dl class="attribute">
<dt id="pyxb.utils.utility._DeconflictSymbols_mixin._ReservedSymbols">
<code class="descname">_ReservedSymbols</code><em class="property"> = set([])</em><a class="headerlink" href="#pyxb.utils.utility._DeconflictSymbols_mixin._ReservedSymbols" title="Permalink to this definition">¶</a></dt>
<dd><p>There are no reserved symbols in the base class.</p>
</dd></dl>
</dd></dl>
<dl class="function">
<dt id="pyxb.utils.utility._DefaultXMLIdentifierToPython">
<code class="descclassname">pyxb.utils.utility.</code><code class="descname">_DefaultXMLIdentifierToPython</code><span class="sig-paren">(</span><em>identifier</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.utility._DefaultXMLIdentifierToPython" title="Permalink to this definition">¶</a></dt>
<dd><p>Default implementation for _XMLIdentifierToPython</p>
<p>For historical reasons, this converts the identifier from a str to
unicode in the system default encoding. This should have no
practical effect.</p>
<p>:param identifier : some XML identifier</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><code class="xref py py-obj docutils literal"><span class="pre">unicode(identifier)</span></code></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="pyxb.utils.utility._NewUUIDString">
<code class="descclassname">pyxb.utils.utility.</code><code class="descname">_NewUUIDString</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.utility._NewUUIDString" title="Permalink to this definition">¶</a></dt>
<dd><p>Obtain a UUID using the best available method. On a version of
python that does not incorporate the <code class="xref py py-obj docutils literal"><span class="pre">uuid</span></code> class, this creates a
string combining the current date and time (to the second) with a
random number.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><code class="xref py py-obj docutils literal"><span class="pre">str</span></code></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="pyxb.utils.utility._SetXMLIdentifierToPython">
<code class="descclassname">pyxb.utils.utility.</code><code class="descname">_SetXMLIdentifierToPython</code><span class="sig-paren">(</span><em>xml_identifier_to_python</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.utility._SetXMLIdentifierToPython" title="Permalink to this definition">¶</a></dt>
<dd><p>Configure a callable <a class="reference internal" href="#pyxb.utils.utility.MakeIdentifier" title="pyxb.utils.utility.MakeIdentifier"><code class="xref py py-obj docutils literal"><span class="pre">MakeIdentifier</span></code></a> uses to pre-process an XM Lidentifier.</p>
<p>In Python3, identifiers can be full Unicode tokens, but in Python2,
all identifiers must be ASCII characters. <a class="reference internal" href="#pyxb.utils.utility.MakeIdentifier" title="pyxb.utils.utility.MakeIdentifier"><code class="xref py py-obj docutils literal"><span class="pre">MakeIdentifier</span></code></a> enforces
this by removing all characters that are not valid within an
identifier.</p>
<p>In some cases, an application generating bindings may be able to
transliterate Unicode code points that are not valid Python identifier
characters into something else. This callable can be assigned to
perform that translation before the invalid characters are
stripped.</p>
<p>For example, see <a class="reference external" href="https://pypi.python.org/pypi/Unidecode">unidecode</a> and <a class="reference external" href="https://sourceforge.net/p/pyxb/discussion/956708/thread/5246b205/#1c7f">this forum posting</a>.</p>
<p>It is not the responsibility of this callable to do anything other
than replace whatever characters it wishes to. All
transformations performed by <a class="reference internal" href="#pyxb.utils.utility.MakeIdentifier" title="pyxb.utils.utility.MakeIdentifier"><code class="xref py py-obj docutils literal"><span class="pre">MakeIdentifier</span></code></a> will still be
applied, to ensure the output is in fact a legal identifier.</p>
<p>:param xml_identifier_to_python : A callable that takes a string
and returns a Unicode, possibly with non-identifier characters
replaced by other characters. Pass <code class="xref py py-obj docutils literal"><span class="pre">None</span></code> to reset to the
default implementation, which is <a class="reference internal" href="#pyxb.utils.utility._DefaultXMLIdentifierToPython" title="pyxb.utils.utility._DefaultXMLIdentifierToPython"><code class="xref py py-obj docutils literal"><span class="pre">_DefaultXMLIdentifierToPython</span></code></a>.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><code class="xref py py-obj docutils literal"><span class="pre">unicode</span></code></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="pyxb.utils.utility._XMLIdentifierToPython">
<code class="descclassname">pyxb.utils.utility.</code><code class="descname">_XMLIdentifierToPython</code><span class="sig-paren">(</span><em>identifier</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.utility._XMLIdentifierToPython" title="Permalink to this definition">¶</a></dt>
<dd><p>Default implementation for _XMLIdentifierToPython</p>
<p>For historical reasons, this converts the identifier from a str to
unicode in the system default encoding. This should have no
practical effect.</p>
<p>:param identifier : some XML identifier</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><code class="xref py py-obj docutils literal"><span class="pre">unicode(identifier)</span></code></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="pyxb.utils.utility.repr2to3">
<code class="descclassname">pyxb.utils.utility.</code><code class="descname">repr2to3</code><span class="sig-paren">(</span><em>v</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.utility.repr2to3" title="Permalink to this definition">¶</a></dt>
<dd><p>Filtered built-in repr for python 2/3 compatibility in
generated bindings.</p>
<p>All generated string values are to be unicode. We always import
unicode_literals from __future__, so we want plain quotes with no
prefix u. Strip that off.</p>
<p>Integer constants should not have the suffix L even if they do not
fit in a Python2 int. The references generated through this
function are never used for calculations, so the implicit cast to
a larger type is sufficient.</p>
<p>All other values use their standard representations.</p>
</dd></dl>
</div>
<div class="section" id="module-pyxb.utils.xmlre">
<span id="pyxb-utils-xmlre-module"></span><h2>pyxb.utils.xmlre module<a class="headerlink" href="#module-pyxb.utils.xmlre" title="Permalink to this headline">¶</a></h2>
<p>Support for regular expressions conformant to the XML Schema specification.</p>
<p>For the most part, XML regular expressions are similar to the POSIX
ones, and can be handled by the Python <code class="xref py py-obj docutils literal"><span class="pre">re</span></code> module. The exceptions
are for multi-character (<code class="xref py py-obj docutils literal"><span class="pre">w</span></code>) and category escapes (e.g., <code class="xref py py-obj docutils literal"><span class="pre">p{N</span></code>} or
<code class="xref py py-obj docutils literal"><span class="pre">p{IPAExtensions</span></code>}) and the character set subtraction capability.
This module supports those by scanning the regular expression,
replacing the category escapes with equivalent charset expressions.
It further detects the subtraction syntax and modifies the charset
expression to remove the unwanted code points.</p>
<p>The basic technique is to step through the characters of the regular
expression, entering a recursive-descent parser when one of the
translated constructs is encountered.</p>
<p>There is a nice set of XML regular expressions at
<a class="reference external" href="http://www.xmlschemareference.com/examples/Ch14/regexpDemo.xsd">http://www.xmlschemareference.com/examples/Ch14/regexpDemo.xsd</a>,
with a sample document at U{
<a class="reference external" href="http://www.xmlschemareference.com/examples/Ch14/regexpDemo.xml">http://www.xmlschemareference.com/examples/Ch14/regexpDemo.xml</a>}</p>
<dl class="function">
<dt id="pyxb.utils.xmlre.MaybeMatchCharacterClass">
<code class="descclassname">pyxb.utils.xmlre.</code><code class="descname">MaybeMatchCharacterClass</code><span class="sig-paren">(</span><em>text</em>, <em>position</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.xmlre.MaybeMatchCharacterClass" title="Permalink to this definition">¶</a></dt>
<dd><p>Attempt to match a U{character class expression
<<a class="reference external" href="http://www.w3.org/TR/xmlschema-2/#nt-charClassExpr">http://www.w3.org/TR/xmlschema-2/#nt-charClassExpr</a>>}.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>text</strong> – The complete text of the regular expression being</td>
</tr>
</tbody>
</table>
<p>translated</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>position</strong> – The offset of the start of the potential</td>
</tr>
</tbody>
</table>
<p>expression.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><code class="xref py py-obj docutils literal"><span class="pre">None</span></code> if <code class="xref py py-obj docutils literal"><span class="pre">position</span></code> does not begin a character class</td>
</tr>
</tbody>
</table>
<p>expression; otherwise a pair <code class="xref py py-obj docutils literal"><span class="pre">(cps,</span> <span class="pre">p)</span></code> where <code class="xref py py-obj docutils literal"><span class="pre">cps</span></code> is a
<a class="reference internal" href="#pyxb.utils.unicode.CodePointSet" title="pyxb.utils.unicode.CodePointSet"><code class="xref py py-obj docutils literal"><span class="pre">pyxb.utils.unicode.CodePointSet</span></code></a> containing the code points associated with
the property, and <code class="xref py py-obj docutils literal"><span class="pre">p</span></code> is the text offset immediately following
the closing brace.</p>
</dd></dl>
<dl class="exception">
<dt id="pyxb.utils.xmlre.RegularExpressionError">
<em class="property">exception </em><code class="descclassname">pyxb.utils.xmlre.</code><code class="descname">RegularExpressionError</code><span class="sig-paren">(</span><em>position</em>, <em>description</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.xmlre.RegularExpressionError" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">exceptions.ValueError</span></code></p>
<p>Raised when a regular expression cannot be processed..</p>
</dd></dl>
<dl class="function">
<dt id="pyxb.utils.xmlre.XMLToPython">
<code class="descclassname">pyxb.utils.xmlre.</code><code class="descname">XMLToPython</code><span class="sig-paren">(</span><em>pattern</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.xmlre.XMLToPython" title="Permalink to this definition">¶</a></dt>
<dd><p>Convert the given pattern to the format required for Python
regular expressions.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>pattern</strong> – A Unicode string defining a pattern consistent</td>
</tr>
</tbody>
</table>
<p>with U{XML regular
expressions<<a class="reference external" href="http://www.w3.org/TR/xmlschema-2/index.html#regexs">http://www.w3.org/TR/xmlschema-2/index.html#regexs</a>>}.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">A Unicode string specifying a Python regular expression</td>
</tr>
</tbody>
</table>
<p>that matches the same language as <code class="xref py py-obj docutils literal"><span class="pre">pattern</span></code>.</p>
</dd></dl>
<dl class="function">
<dt id="pyxb.utils.xmlre._InitializeAllEsc">
<code class="descclassname">pyxb.utils.xmlre.</code><code class="descname">_InitializeAllEsc</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.xmlre._InitializeAllEsc" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the values in _AllEsc without introducing <code class="xref py py-obj docutils literal"><span class="pre">k</span></code> and <code class="xref py py-obj docutils literal"><span class="pre">v</span></code> into
the module.</p>
</dd></dl>
<dl class="function">
<dt id="pyxb.utils.xmlre._MatchCharClassEsc">
<code class="descclassname">pyxb.utils.xmlre.</code><code class="descname">_MatchCharClassEsc</code><span class="sig-paren">(</span><em>text</em>, <em>position</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.xmlre._MatchCharClassEsc" title="Permalink to this definition">¶</a></dt>
<dd><p>Parse a charClassEsc<<a class="reference external" href="http://www.w3.org/TR/xmlschema-2/#nt-charClassEsc">http://www.w3.org/TR/xmlschema-2/#nt-charClassEsc</a>> term.</p>
<p>This is one of:</p>
<blockquote>
<div><ul class="simple">
<li>SingleCharEsc<<a class="reference external" href="http://www.w3.org/TR/xmlschema-2/#nt-SingleCharEsc">http://www.w3.org/TR/xmlschema-2/#nt-SingleCharEsc</a>>,</li>
</ul>
<p>an escaped single character such as :py:obj:<a href="#id17"><span class="problematic" id="id18">`</span></a>E{`n}</p>
<ul class="simple">
<li>MultiCharEsc<<a class="reference external" href="http://www.w3.org/TR/xmlschema-2/#nt-MultiCharEsc">http://www.w3.org/TR/xmlschema-2/#nt-MultiCharEsc</a>>,</li>
</ul>
<p>an escape code that can match a range of characters,
e.g. :py:obj:<a href="#id19"><span class="problematic" id="id20">`</span></a>E{`s} to match certain whitespace characters</p>
<ul class="simple">
<li>catEsc<<a class="reference external" href="http://www.w3.org/TR/xmlschema-2/#nt-catEsc">http://www.w3.org/TR/xmlschema-2/#nt-catEsc</a>>, the</li>
</ul>
<p>:py:obj:<a href="#id21"><span class="problematic" id="id22">`</span></a>E{`pE{lb}...E{rb}} Unicode property escapes including
categories and blocks</p>
<ul class="simple">
<li>complEsc<<a class="reference external" href="http://www.w3.org/TR/xmlschema-2/#nt-complEsc">http://www.w3.org/TR/xmlschema-2/#nt-complEsc</a>>,</li>
</ul>
<p>the :py:obj:<a href="#id23"><span class="problematic" id="id24">`</span></a>E{`PE{lb}...E{rb}} inverted Unicode property escapes</p>
</div></blockquote>
<p>If the parsing fails, throws a RegularExpressionError.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">A pair <code class="xref py py-obj docutils literal"><span class="pre">(cps,</span> <span class="pre">p)</span></code> where <code class="xref py py-obj docutils literal"><span class="pre">cps</span></code> is a</td>
</tr>
</tbody>
</table>
<p><a class="reference internal" href="#pyxb.utils.unicode.CodePointSet" title="pyxb.utils.unicode.CodePointSet"><code class="xref py py-obj docutils literal"><span class="pre">pyxb.utils.unicode.CodePointSet</span></code></a> containing the code points
associated with the character class, and <code class="xref py py-obj docutils literal"><span class="pre">p</span></code> is the text offset
immediately following the escape sequence.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Raises:</th><td class="field-body"><a class="reference internal" href="#pyxb.utils.xmlre.RegularExpressionError" title="pyxb.utils.xmlre.RegularExpressionError"><strong>RegularExpressionError</strong></a> – if the expression is syntactically</td>
</tr>
</tbody>
</table>
<p>invalid.</p>
</dd></dl>
<dl class="function">
<dt id="pyxb.utils.xmlre._MatchCharClassExpr">
<code class="descclassname">pyxb.utils.xmlre.</code><code class="descname">_MatchCharClassExpr</code><span class="sig-paren">(</span><em>text</em>, <em>position</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.xmlre._MatchCharClassExpr" title="Permalink to this definition">¶</a></dt>
<dd><p>Parse a charClassExpr<<a class="reference external" href="http://www.w3.org/TR/xmlschema-2/#nt-charClassExpr">http://www.w3.org/TR/xmlschema-2/#nt-charClassExpr</a>>.</p>
<p>These are XML regular expression classes such as <code class="xref py py-obj docutils literal"><span class="pre">[abc]</span></code>, <code class="xref py py-obj docutils literal"><span class="pre">[a-c]</span></code>, <code class="xref py py-obj docutils literal"><span class="pre">[^abc]</span></code>, or <code class="xref py py-obj docutils literal"><span class="pre">[a-z-[q]]</span></code>.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>text</strong> – The complete text of the regular expression being</td>
</tr>
</tbody>
</table>
<p>translated. The first character must be the <code class="xref py py-obj docutils literal"><span class="pre">[</span></code> starting a
character class.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>position</strong> – The offset of the start of the character group.</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">A pair <code class="xref py py-obj docutils literal"><span class="pre">(cps,</span> <span class="pre">p)</span></code> where <code class="xref py py-obj docutils literal"><span class="pre">cps</span></code> is a</td>
</tr>
</tbody>
</table>
<p><a class="reference internal" href="#pyxb.utils.unicode.CodePointSet" title="pyxb.utils.unicode.CodePointSet"><code class="xref py py-obj docutils literal"><span class="pre">pyxb.utils.unicode.CodePointSet</span></code></a> containing the code points
associated with the property, and <code class="xref py py-obj docutils literal"><span class="pre">p</span></code> is the text offset
immediately following the closing brace.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Raises:</th><td class="field-body"><a class="reference internal" href="#pyxb.utils.xmlre.RegularExpressionError" title="pyxb.utils.xmlre.RegularExpressionError"><strong>RegularExpressionError</strong></a> – if the expression is syntactically</td>
</tr>
</tbody>
</table>
<p>invalid.</p>
</dd></dl>
<dl class="function">
<dt id="pyxb.utils.xmlre._MatchPosCharGroup">
<code class="descclassname">pyxb.utils.xmlre.</code><code class="descname">_MatchPosCharGroup</code><span class="sig-paren">(</span><em>text</em>, <em>position</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.utils.xmlre._MatchPosCharGroup" title="Permalink to this definition">¶</a></dt>
<dd><p>Parse a posCharGroup<<a class="reference external" href="http://www.w3.org/TR/xmlschema-2/#nt-posCharGroup">http://www.w3.org/TR/xmlschema-2/#nt-posCharGroup</a>> term.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">A tuple <code class="xref py py-obj docutils literal"><span class="pre">(cps,</span> <span class="pre">fs,</span> <span class="pre">p)</span></code> where:
- <code class="xref py py-obj docutils literal"><span class="pre">cps</span></code> is a <a class="reference internal" href="#pyxb.utils.unicode.CodePointSet" title="pyxb.utils.unicode.CodePointSet"><code class="xref py py-obj docutils literal"><span class="pre">pyxb.utils.unicode.CodePointSet</span></code></a> containing the code points associated with the group;
- <code class="xref py py-obj docutils literal"><span class="pre">fs</span></code> is a <code class="xref py py-obj docutils literal"><span class="pre">bool</span></code> that is <code class="xref py py-obj docutils literal"><span class="pre">True</span></code> if the next character is the <code class="xref py py-obj docutils literal"><span class="pre">-</span></code> in a charClassSub<<a class="reference external" href="http://www.w3.org/TR/xmlschema-2/#nt-charClassSub">http://www.w3.org/TR/xmlschema-2/#nt-charClassSub</a>> and <code class="xref py py-obj docutils literal"><span class="pre">False</span></code> if the group is not part of a charClassSub;
- <code class="xref py py-obj docutils literal"><span class="pre">p</span></code> is the text offset immediately following the closing brace.</td>
</tr>
<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><a class="reference internal" href="#pyxb.utils.xmlre.RegularExpressionError" title="pyxb.utils.xmlre.RegularExpressionError"><strong>RegularExpressionError</strong></a> – if the expression is syntactically</td>
</tr>
</tbody>
</table>
<p>invalid.</p>
</dd></dl>
</div>
<div class="section" id="module-pyxb.utils">
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-pyxb.utils" title="Permalink to this headline">¶</a></h2>
<p>pyxb.utils – Utilities for the PyWXSB package.</p>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h3><a href="index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">pyxb.utils package</a><ul>
<li><a class="reference internal" href="#submodules">Submodules</a></li>
<li><a class="reference internal" href="#module-pyxb.utils.activestate">pyxb.utils.activestate module</a></li>
<li><a class="reference internal" href="#module-pyxb.utils.domutils">pyxb.utils.domutils module</a></li>
<li><a class="reference internal" href="#pyxb-utils-fac-module">pyxb.utils.fac module</a></li>
<li><a class="reference internal" href="#module-pyxb.utils.saxdom">pyxb.utils.saxdom module</a></li>
<li><a class="reference internal" href="#module-pyxb.utils.saxutils">pyxb.utils.saxutils module</a></li>
<li><a class="reference internal" href="#module-pyxb.utils.six">pyxb.utils.six module</a></li>
<li><a class="reference internal" href="#module-pyxb.utils.templates">pyxb.utils.templates module</a></li>
<li><a class="reference internal" href="#module-pyxb.utils.unicode">pyxb.utils.unicode module</a></li>
<li><a class="reference internal" href="#module-pyxb.utils.unicode_data">pyxb.utils.unicode_data module</a></li>
<li><a class="reference internal" href="#module-pyxb.utils.utility">pyxb.utils.utility module</a></li>
<li><a class="reference internal" href="#module-pyxb.utils.xmlre">pyxb.utils.xmlre module</a></li>
<li><a class="reference internal" href="#module-pyxb.utils">Module contents</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="pyxb.namespace.html"
title="previous chapter">pyxb.namespace package</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="pyxb.xmlschema.html"
title="next chapter">pyxb.xmlschema package</a></p>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/pyxb.utils.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<div><input type="text" name="q" /></div>
<div><input type="submit" value="Go" /></div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="pyxb.xmlschema.html" title="pyxb.xmlschema package"
>next</a> |</li>
<li class="right" >
<a href="pyxb.namespace.html" title="pyxb.namespace package"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">PyXB 1.2.6 documentation</a> »</li>
<li class="nav-item nav-item-1"><a href="pyxb.html" >pyxb package</a> »</li>
<li style="margin-left: 20px">PyXB hosted on <a href="http://sourceforge.net/projects/pyxb"><img src="http://sflogo.sourceforge.net/sflogo.php?group_id=263147&type=9"
width="80" height="15" alt="Get PyXB: Python XML Schema Bindings at SourceForge.net. Fast, secure and Free Open Source software downloads"/></a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright 2009-2017, Peter A. Bigot.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.5.5.
</div>
</body>
</html>
