<!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.namespace 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.utils package" href="pyxb.utils.html" />
<link rel="prev" title="pyxb.binding package" href="pyxb.binding.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.utils.html" title="pyxb.utils package"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="pyxb.binding.html" title="pyxb.binding 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-namespace-package">
<h1>pyxb.namespace package<a class="headerlink" href="#pyxb-namespace-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="pyxb-namespace-archive-module">
<h2>pyxb.namespace.archive module<a class="headerlink" href="#pyxb-namespace-archive-module" title="Permalink to this headline">¶</a></h2>
<span class="target" id="module-pyxb.namespace.archive"></span><p>Classes and global objects related to archiving U{XML
Namespaces<<a class="reference external" href="http://www.w3.org/TR/2006/REC-xml-names-20060816/index.html">http://www.w3.org/TR/2006/REC-xml-names-20060816/index.html</a>>}.</p>
<dl class="data">
<dt id="pyxb.namespace.archive.DefaultArchivePrefix">
<code class="descclassname">pyxb.namespace.archive.</code><code class="descname">DefaultArchivePrefix</code><em class="property"> = '/tmp/pyxbdist.WUiBAra/PyXB-1.2.6'</em><a class="headerlink" href="#pyxb.namespace.archive.DefaultArchivePrefix" title="Permalink to this definition">¶</a></dt>
<dd><p>The default archive prefix, substituted for <code class="xref py py-obj docutils literal"><span class="pre">&</span></code> in <code class="xref py py-obj docutils literal"><span class="pre">PYXB_ARCHIVE_PATH</span></code>.</p>
</dd></dl>
<dl class="function">
<dt id="pyxb.namespace.archive.GetArchivePath">
<code class="descclassname">pyxb.namespace.archive.</code><code class="descname">GetArchivePath</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.archive.GetArchivePath" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the archive path as defined by the <a class="reference internal" href="#pyxb.namespace.archive.PathEnvironmentVariable" title="pyxb.namespace.archive.PathEnvironmentVariable"><code class="xref py py-obj docutils literal"><span class="pre">PathEnvironmentVariable</span></code></a>,
or <code class="xref py py-obj docutils literal"><span class="pre">None</span></code> if that variable is not defined.</p>
</dd></dl>
<dl class="class">
<dt id="pyxb.namespace.archive.ModuleRecord">
<em class="property">class </em><code class="descclassname">pyxb.namespace.archive.</code><code class="descname">ModuleRecord</code><span class="sig-paren">(</span><em>namespace</em>, <em>generation_uid</em>, <em>**kw</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.archive.ModuleRecord" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="pyxb.utils.html#pyxb.utils.utility.PrivateTransient_mixin" title="pyxb.utils.utility.PrivateTransient_mixin"><code class="xref py py-class docutils literal"><span class="pre">pyxb.utils.utility.PrivateTransient_mixin</span></code></a></p>
<dl class="attribute">
<dt id="pyxb.namespace.archive.ModuleRecord._ModuleRecord__PrivateTransient">
<code class="descname">_ModuleRecord__PrivateTransient</code><em class="property"> = set(['constructedLocally', 'categoryObjects', 'isIncorporated', 'archive'])</em><a class="headerlink" href="#pyxb.namespace.archive.ModuleRecord._ModuleRecord__PrivateTransient" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.namespace.archive.ModuleRecord._ModuleRecord__archive">
<code class="descname">_ModuleRecord__archive</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.namespace.archive.ModuleRecord._ModuleRecord__archive" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.namespace.archive.ModuleRecord._ModuleRecord__categoryObjects">
<code class="descname">_ModuleRecord__categoryObjects</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.namespace.archive.ModuleRecord._ModuleRecord__categoryObjects" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.namespace.archive.ModuleRecord._ModuleRecord__constructedLocally">
<code class="descname">_ModuleRecord__constructedLocally</code><em class="property"> = False</em><a class="headerlink" href="#pyxb.namespace.archive.ModuleRecord._ModuleRecord__constructedLocally" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.namespace.archive.ModuleRecord._ModuleRecord__dependsOnExternal">
<code class="descname">_ModuleRecord__dependsOnExternal</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.namespace.archive.ModuleRecord._ModuleRecord__dependsOnExternal" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.namespace.archive.ModuleRecord._ModuleRecord__generationUID">
<code class="descname">_ModuleRecord__generationUID</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.namespace.archive.ModuleRecord._ModuleRecord__generationUID" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.namespace.archive.ModuleRecord._ModuleRecord__isIncorporated">
<code class="descname">_ModuleRecord__isIncorporated</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.namespace.archive.ModuleRecord._ModuleRecord__isIncorporated" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.namespace.archive.ModuleRecord._ModuleRecord__isLoadable">
<code class="descname">_ModuleRecord__isLoadable</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.namespace.archive.ModuleRecord._ModuleRecord__isLoadable" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.namespace.archive.ModuleRecord._ModuleRecord__isPublic">
<code class="descname">_ModuleRecord__isPublic</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.namespace.archive.ModuleRecord._ModuleRecord__isPublic" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.namespace.archive.ModuleRecord._ModuleRecord__modulePath">
<code class="descname">_ModuleRecord__modulePath</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.namespace.archive.ModuleRecord._ModuleRecord__modulePath" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.namespace.archive.ModuleRecord._ModuleRecord__namespace">
<code class="descname">_ModuleRecord__namespace</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.namespace.archive.ModuleRecord._ModuleRecord__namespace" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.namespace.archive.ModuleRecord._ModuleRecord__originMap">
<code class="descname">_ModuleRecord__originMap</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.namespace.archive.ModuleRecord._ModuleRecord__originMap" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.namespace.archive.ModuleRecord._ModuleRecord__referencedNamespaces">
<code class="descname">_ModuleRecord__referencedNamespaces</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.namespace.archive.ModuleRecord._ModuleRecord__referencedNamespaces" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.namespace.archive.ModuleRecord._addCategoryObject">
<code class="descname">_addCategoryObject</code><span class="sig-paren">(</span><em>category</em>, <em>name</em>, <em>obj</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.archive.ModuleRecord._addCategoryObject" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.namespace.archive.ModuleRecord._loadCategoryObjects">
<code class="descname">_loadCategoryObjects</code><span class="sig-paren">(</span><em>category_objects</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.archive.ModuleRecord._loadCategoryObjects" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.namespace.archive.ModuleRecord._setArchive">
<code class="descname">_setArchive</code><span class="sig-paren">(</span><em>archive</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.archive.ModuleRecord._setArchive" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.namespace.archive.ModuleRecord._setFromOther">
<code class="descname">_setFromOther</code><span class="sig-paren">(</span><em>other</em>, <em>archive</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.archive.ModuleRecord._setFromOther" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.namespace.archive.ModuleRecord._setIsLoadable">
<code class="descname">_setIsLoadable</code><span class="sig-paren">(</span><em>is_loadable</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.archive.ModuleRecord._setIsLoadable" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.namespace.archive.ModuleRecord._setIsPublic">
<code class="descname">_setIsPublic</code><span class="sig-paren">(</span><em>is_public</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.archive.ModuleRecord._setIsPublic" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.namespace.archive.ModuleRecord._setOrigins">
<code class="descname">_setOrigins</code><span class="sig-paren">(</span><em>origins</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.archive.ModuleRecord._setOrigins" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.namespace.archive.ModuleRecord._setReferencedNamespaces">
<code class="descname">_setReferencedNamespaces</code><span class="sig-paren">(</span><em>referenced_namespaces</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.archive.ModuleRecord._setReferencedNamespaces" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.namespace.archive.ModuleRecord.addOrigin">
<code class="descname">addOrigin</code><span class="sig-paren">(</span><em>origin</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.archive.ModuleRecord.addOrigin" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.namespace.archive.ModuleRecord.archive">
<code class="descname">archive</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.archive.ModuleRecord.archive" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.namespace.archive.ModuleRecord.categoryObjects">
<code class="descname">categoryObjects</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.archive.ModuleRecord.categoryObjects" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.namespace.archive.ModuleRecord.completeGenerationAssociations">
<code class="descname">completeGenerationAssociations</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.archive.ModuleRecord.completeGenerationAssociations" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.namespace.archive.ModuleRecord.dependsOnExternal">
<code class="descname">dependsOnExternal</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.archive.ModuleRecord.dependsOnExternal" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.namespace.archive.ModuleRecord.generationUID">
<code class="descname">generationUID</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.archive.ModuleRecord.generationUID" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.namespace.archive.ModuleRecord.hasMatchingOrigin">
<code class="descname">hasMatchingOrigin</code><span class="sig-paren">(</span><em>**kw</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.archive.ModuleRecord.hasMatchingOrigin" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.namespace.archive.ModuleRecord.isIncorporated">
<code class="descname">isIncorporated</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.archive.ModuleRecord.isIncorporated" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.namespace.archive.ModuleRecord.isLoadable">
<code class="descname">isLoadable</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.archive.ModuleRecord.isLoadable" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.namespace.archive.ModuleRecord.isPublic">
<code class="descname">isPublic</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.archive.ModuleRecord.isPublic" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.namespace.archive.ModuleRecord.lookupOriginBySignature">
<code class="descname">lookupOriginBySignature</code><span class="sig-paren">(</span><em>signature</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.archive.ModuleRecord.lookupOriginBySignature" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.namespace.archive.ModuleRecord.markIncorporated">
<code class="descname">markIncorporated</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.archive.ModuleRecord.markIncorporated" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.namespace.archive.ModuleRecord.modulePath">
<code class="descname">modulePath</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.archive.ModuleRecord.modulePath" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.namespace.archive.ModuleRecord.namespace">
<code class="descname">namespace</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.archive.ModuleRecord.namespace" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.namespace.archive.ModuleRecord.origins">
<code class="descname">origins</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.archive.ModuleRecord.origins" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.namespace.archive.ModuleRecord.prepareForArchive">
<code class="descname">prepareForArchive</code><span class="sig-paren">(</span><em>archive</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.archive.ModuleRecord.prepareForArchive" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.namespace.archive.ModuleRecord.referenceNamespace">
<code class="descname">referenceNamespace</code><span class="sig-paren">(</span><em>namespace</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.archive.ModuleRecord.referenceNamespace" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.namespace.archive.ModuleRecord.referencedNamespaces">
<code class="descname">referencedNamespaces</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.archive.ModuleRecord.referencedNamespaces" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.namespace.archive.ModuleRecord.resetCategoryObjects">
<code class="descname">resetCategoryObjects</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.archive.ModuleRecord.resetCategoryObjects" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.namespace.archive.ModuleRecord.setModulePath">
<code class="descname">setModulePath</code><span class="sig-paren">(</span><em>module_path</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.archive.ModuleRecord.setModulePath" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="pyxb.namespace.archive.NamespaceArchive">
<em class="property">class </em><code class="descclassname">pyxb.namespace.archive.</code><code class="descname">NamespaceArchive</code><span class="sig-paren">(</span><em>archive_path=None</em>, <em>generation_uid=None</em>, <em>loadable=True</em>, <em>stage=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.archive.NamespaceArchive" 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 file from which one or more namespaces can be read, or to
which they will be written.</p>
<dl class="classmethod">
<dt id="pyxb.namespace.archive.NamespaceArchive.ForPath">
<em class="property">classmethod </em><code class="descname">ForPath</code><span class="sig-paren">(</span><em>archive_file</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.archive.NamespaceArchive.ForPath" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the <a class="reference internal" href="#pyxb.namespace.archive.NamespaceArchive" title="pyxb.namespace.archive.NamespaceArchive"><code class="xref py py-obj docutils literal"><span class="pre">NamespaceArchive</span></code></a> instance that can be found at the
given path.</p>
</dd></dl>
<dl class="classmethod">
<dt id="pyxb.namespace.archive.NamespaceArchive.PicklingArchive">
<em class="property">classmethod </em><code class="descname">PicklingArchive</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.archive.NamespaceArchive.PicklingArchive" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a reference to a set specifying the namespace instances that
are being archived.</p>
<p>This is needed to determine whether a component must be serialized as
aa reference.</p>
</dd></dl>
<dl class="classmethod">
<dt id="pyxb.namespace.archive.NamespaceArchive.PreLoadArchives">
<em class="property">classmethod </em><code class="descname">PreLoadArchives</code><span class="sig-paren">(</span><em>archive_path=None</em>, <em>reset=False</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.archive.NamespaceArchive.PreLoadArchives" title="Permalink to this definition">¶</a></dt>
<dd><p>Scan for available archives, associating them with namespaces.</p>
<p>This only validates potential archive contents; it does not load
namespace data from the archives.</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>archive_path</strong> – A list of files or directories in which</td>
</tr>
</tbody>
</table>
<p>namespace archives can be found. The entries are separated by
os.pathsep, which is a colon on POSIX platforms and a semi-colon on
Windows. See <a class="reference internal" href="#pyxb.namespace.archive.PathEnvironmentVariable" title="pyxb.namespace.archive.PathEnvironmentVariable"><code class="xref py py-obj docutils literal"><span class="pre">PathEnvironmentVariable</span></code></a>. Defaults to
<a class="reference internal" href="#pyxb.namespace.archive.GetArchivePath" title="pyxb.namespace.archive.GetArchivePath"><code class="xref py py-obj docutils literal"><span class="pre">GetArchivePath()</span></code></a>. If not defaulted, <code class="xref py py-obj docutils literal"><span class="pre">reset</span></code> will be forced to
<code class="xref py py-obj docutils literal"><span class="pre">True</span></code>. For any directory in the path, all files ending with
<code class="xref py py-obj docutils literal"><span class="pre">wxs</span></code> are examined.</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">False</span></code> (default), the most recently read set of</td>
</tr>
</tbody>
</table>
<p>archives is returned; if <code class="xref py py-obj docutils literal"><span class="pre">True</span></code>, the archive path is re-scanned and the
namespace associations validated.</p>
</dd></dl>
<dl class="classmethod">
<dt id="pyxb.namespace.archive.NamespaceArchive._AnonymousCategory">
<em class="property">classmethod </em><code class="descname">_AnonymousCategory</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.archive.NamespaceArchive._AnonymousCategory" title="Permalink to this definition">¶</a></dt>
<dd><p>The category name to use when storing references to anonymous type
definitions. For example, attribute definitions defined within an
attribute use in a model group definition.that can be referenced frojm
ax different namespace.</p>
</dd></dl>
<dl class="attribute">
<dt id="pyxb.namespace.archive.NamespaceArchive._NamespaceArchive__AnonymousCategory">
<code class="descname">_NamespaceArchive__AnonymousCategory</code><em class="property"> = '_anonymousTypeDefinition'</em><a class="headerlink" href="#pyxb.namespace.archive.NamespaceArchive._NamespaceArchive__AnonymousCategory" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.namespace.archive.NamespaceArchive._NamespaceArchive__ArchivePattern_re">
<code class="descname">_NamespaceArchive__ArchivePattern_re</code><em class="property"> = <_sre.SRE_Pattern object></em><a class="headerlink" href="#pyxb.namespace.archive.NamespaceArchive._NamespaceArchive__ArchivePattern_re" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="classmethod">
<dt id="pyxb.namespace.archive.NamespaceArchive._NamespaceArchive__GetArchiveInstance">
<em class="property">classmethod </em><code class="descname">_NamespaceArchive__GetArchiveInstance</code><span class="sig-paren">(</span><em>archive_file</em>, <em>stage=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.archive.NamespaceArchive._NamespaceArchive__GetArchiveInstance" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a <a class="reference internal" href="#pyxb.namespace.archive.NamespaceArchive" title="pyxb.namespace.archive.NamespaceArchive"><code class="xref py py-obj docutils literal"><span class="pre">NamespaceArchive</span></code></a> instance associated with the given file.</p>
<p>To the extent possible, the same file accessed through different paths
returns the same <a class="reference internal" href="#pyxb.namespace.archive.NamespaceArchive" title="pyxb.namespace.archive.NamespaceArchive"><code class="xref py py-obj docutils literal"><span class="pre">NamespaceArchive</span></code></a> instance.</p>
</dd></dl>
<dl class="attribute">
<dt id="pyxb.namespace.archive.NamespaceArchive._NamespaceArchive__NamespaceArchives">
<code class="descname">_NamespaceArchive__NamespaceArchives</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.namespace.archive.NamespaceArchive._NamespaceArchive__NamespaceArchives" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.namespace.archive.NamespaceArchive._NamespaceArchive__PickleFormat">
<code class="descname">_NamespaceArchive__PickleFormat</code><em class="property"> = '200907190858'</em><a class="headerlink" href="#pyxb.namespace.archive.NamespaceArchive._NamespaceArchive__PickleFormat" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.namespace.archive.NamespaceArchive._NamespaceArchive__PicklingArchive">
<code class="descname">_NamespaceArchive__PicklingArchive</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.namespace.archive.NamespaceArchive._NamespaceArchive__PicklingArchive" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.namespace.archive.NamespaceArchive._NamespaceArchive__archivePath">
<code class="descname">_NamespaceArchive__archivePath</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.namespace.archive.NamespaceArchive._NamespaceArchive__archivePath" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.namespace.archive.NamespaceArchive._NamespaceArchive__createPickler">
<code class="descname">_NamespaceArchive__createPickler</code><span class="sig-paren">(</span><em>output</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.archive.NamespaceArchive._NamespaceArchive__createPickler" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.namespace.archive.NamespaceArchive._NamespaceArchive__createUnpickler">
<code class="descname">_NamespaceArchive__createUnpickler</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.archive.NamespaceArchive._NamespaceArchive__createUnpickler" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.namespace.archive.NamespaceArchive._NamespaceArchive__generationUID">
<code class="descname">_NamespaceArchive__generationUID</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.namespace.archive.NamespaceArchive._NamespaceArchive__generationUID" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.namespace.archive.NamespaceArchive._NamespaceArchive__isLoadable">
<code class="descname">_NamespaceArchive__isLoadable</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.namespace.archive.NamespaceArchive._NamespaceArchive__isLoadable" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.namespace.archive.NamespaceArchive._NamespaceArchive__locateModuleRecords">
<code class="descname">_NamespaceArchive__locateModuleRecords</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.archive.NamespaceArchive._NamespaceArchive__locateModuleRecords" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.namespace.archive.NamespaceArchive._NamespaceArchive__moduleRecords">
<code class="descname">_NamespaceArchive__moduleRecords</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.namespace.archive.NamespaceArchive._NamespaceArchive__moduleRecords" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.namespace.archive.NamespaceArchive._NamespaceArchive__namespaces">
<code class="descname">_NamespaceArchive__namespaces</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.namespace.archive.NamespaceArchive._NamespaceArchive__namespaces" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.namespace.archive.NamespaceArchive._NamespaceArchive__readComponentSet">
<code class="descname">_NamespaceArchive__readComponentSet</code><span class="sig-paren">(</span><em>unpickler</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.archive.NamespaceArchive._NamespaceArchive__readComponentSet" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.namespace.archive.NamespaceArchive._NamespaceArchive__readModules">
<code class="descname">_NamespaceArchive__readModules</code><span class="sig-paren">(</span><em>unpickler</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.archive.NamespaceArchive._NamespaceArchive__readModules" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.namespace.archive.NamespaceArchive._NamespaceArchive__stage">
<code class="descname">_NamespaceArchive__stage</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.namespace.archive.NamespaceArchive._NamespaceArchive__stage" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.namespace.archive.NamespaceArchive._NamespaceArchive__unpickler">
<code class="descname">_NamespaceArchive__unpickler</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.namespace.archive.NamespaceArchive._NamespaceArchive__unpickler" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.namespace.archive.NamespaceArchive._NamespaceArchive__validateModules">
<code class="descname">_NamespaceArchive__validateModules</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.archive.NamespaceArchive._NamespaceArchive__validateModules" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.namespace.archive.NamespaceArchive._NamespaceArchive__validatePrerequisites">
<code class="descname">_NamespaceArchive__validatePrerequisites</code><span class="sig-paren">(</span><em>stage</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.archive.NamespaceArchive._NamespaceArchive__validatePrerequisites" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.namespace.archive.NamespaceArchive._STAGE_COMPLETE">
<code class="descname">_STAGE_COMPLETE</code><em class="property"> = 4</em><a class="headerlink" href="#pyxb.namespace.archive.NamespaceArchive._STAGE_COMPLETE" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.namespace.archive.NamespaceArchive._STAGE_UNOPENED">
<code class="descname">_STAGE_UNOPENED</code><em class="property"> = 0</em><a class="headerlink" href="#pyxb.namespace.archive.NamespaceArchive._STAGE_UNOPENED" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.namespace.archive.NamespaceArchive._STAGE_readComponents">
<code class="descname">_STAGE_readComponents</code><em class="property"> = 4</em><a class="headerlink" href="#pyxb.namespace.archive.NamespaceArchive._STAGE_readComponents" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.namespace.archive.NamespaceArchive._STAGE_readModules">
<code class="descname">_STAGE_readModules</code><em class="property"> = 2</em><a class="headerlink" href="#pyxb.namespace.archive.NamespaceArchive._STAGE_readModules" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.namespace.archive.NamespaceArchive._STAGE_uid">
<code class="descname">_STAGE_uid</code><em class="property"> = 1</em><a class="headerlink" href="#pyxb.namespace.archive.NamespaceArchive._STAGE_uid" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.namespace.archive.NamespaceArchive._STAGE_validateModules">
<code class="descname">_STAGE_validateModules</code><em class="property"> = 3</em><a class="headerlink" href="#pyxb.namespace.archive.NamespaceArchive._STAGE_validateModules" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.namespace.archive.NamespaceArchive._readToStage">
<code class="descname">_readToStage</code><span class="sig-paren">(</span><em>stage</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.archive.NamespaceArchive._readToStage" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.namespace.archive.NamespaceArchive._stage">
<code class="descname">_stage</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.archive.NamespaceArchive._stage" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.namespace.archive.NamespaceArchive._unsatisfiedModulePrerequisites">
<code class="descname">_unsatisfiedModulePrerequisites</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.archive.NamespaceArchive._unsatisfiedModulePrerequisites" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.namespace.archive.NamespaceArchive.add">
<code class="descname">add</code><span class="sig-paren">(</span><em>namespace</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.archive.NamespaceArchive.add" title="Permalink to this definition">¶</a></dt>
<dd><p>Add the given namespace to the set that is to be stored in this archive.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.namespace.archive.NamespaceArchive.archivePath">
<code class="descname">archivePath</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.archive.NamespaceArchive.archivePath" title="Permalink to this definition">¶</a></dt>
<dd><p>Path to the file in which this namespace archive is stored.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.namespace.archive.NamespaceArchive.discard">
<code class="descname">discard</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.archive.NamespaceArchive.discard" title="Permalink to this definition">¶</a></dt>
<dd><p>Remove this archive from the set of available archives.</p>
<p>This is invoked when an archive contains a namespace that the user has
specified should not be loaded.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.namespace.archive.NamespaceArchive.generationUID">
<code class="descname">generationUID</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.archive.NamespaceArchive.generationUID" title="Permalink to this definition">¶</a></dt>
<dd><p>The unique identifier for the generation that produced this archive.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.namespace.archive.NamespaceArchive.isLoadable">
<code class="descname">isLoadable</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.archive.NamespaceArchive.isLoadable" 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 it is permissible to load the archive.
Archives created for output cannot be loaded.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.namespace.archive.NamespaceArchive.moduleRecords">
<code class="descname">moduleRecords</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.archive.NamespaceArchive.moduleRecords" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the set of <a class="reference internal" href="#pyxb.namespace.archive.ModuleRecord" title="pyxb.namespace.archive.ModuleRecord"><code class="xref py py-obj docutils literal"><span class="pre">module</span> <span class="pre">records</span></code></a> stored in this
archive.</p>
<p>Each module record represents</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.namespace.archive.NamespaceArchive.namespaces">
<code class="descname">namespaces</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.archive.NamespaceArchive.namespaces" title="Permalink to this definition">¶</a></dt>
<dd><p>Set of namespaces that can be read from this archive.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.namespace.archive.NamespaceArchive.readNamespaces">
<code class="descname">readNamespaces</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.archive.NamespaceArchive.readNamespaces" title="Permalink to this definition">¶</a></dt>
<dd><p>Read all the components from this archive, integrating them into
their respective namespaces.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.namespace.archive.NamespaceArchive.update">
<code class="descname">update</code><span class="sig-paren">(</span><em>namespace_set</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.archive.NamespaceArchive.update" title="Permalink to this definition">¶</a></dt>
<dd><p>Add the given namespaces to the set that is to be stored in this archive.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.namespace.archive.NamespaceArchive.writeNamespaces">
<code class="descname">writeNamespaces</code><span class="sig-paren">(</span><em>output</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.archive.NamespaceArchive.writeNamespaces" title="Permalink to this definition">¶</a></dt>
<dd><p>Store the namespaces into the archive.</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>output</strong> – An instance substitutable for a writable file, or the</td>
</tr>
</tbody>
</table>
<p>name of a file to write to.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="pyxb.namespace.archive.NamespaceDependencies">
<em class="property">class </em><code class="descclassname">pyxb.namespace.archive.</code><code class="descname">NamespaceDependencies</code><span class="sig-paren">(</span><em>**kw</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.archive.NamespaceDependencies" 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="attribute">
<dt id="pyxb.namespace.archive.NamespaceDependencies._NamespaceDependencies__componentGraph">
<code class="descname">_NamespaceDependencies__componentGraph</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.namespace.archive.NamespaceDependencies._NamespaceDependencies__componentGraph" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.namespace.archive.NamespaceDependencies._NamespaceDependencies__namespaceGraph">
<code class="descname">_NamespaceDependencies__namespaceGraph</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.namespace.archive.NamespaceDependencies._NamespaceDependencies__namespaceGraph" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.namespace.archive.NamespaceDependencies._NamespaceDependencies__rootNamespaces">
<code class="descname">_NamespaceDependencies__rootNamespaces</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.namespace.archive.NamespaceDependencies._NamespaceDependencies__rootNamespaces" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.namespace.archive.NamespaceDependencies._NamespaceDependencies__siblingNamespaces">
<code class="descname">_NamespaceDependencies__siblingNamespaces</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.namespace.archive.NamespaceDependencies._NamespaceDependencies__siblingNamespaces" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.namespace.archive.NamespaceDependencies.componentGraph">
<code class="descname">componentGraph</code><span class="sig-paren">(</span><em>reset=False</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.archive.NamespaceDependencies.componentGraph" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.namespace.archive.NamespaceDependencies.componentOrder">
<code class="descname">componentOrder</code><span class="sig-paren">(</span><em>reset=False</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.archive.NamespaceDependencies.componentOrder" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.namespace.archive.NamespaceDependencies.dependentNamespaces">
<code class="descname">dependentNamespaces</code><span class="sig-paren">(</span><em>reset=False</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.archive.NamespaceDependencies.dependentNamespaces" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.namespace.archive.NamespaceDependencies.namespaceGraph">
<code class="descname">namespaceGraph</code><span class="sig-paren">(</span><em>reset=False</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.archive.NamespaceDependencies.namespaceGraph" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.namespace.archive.NamespaceDependencies.namespaceOrder">
<code class="descname">namespaceOrder</code><span class="sig-paren">(</span><em>reset=False</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.archive.NamespaceDependencies.namespaceOrder" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.namespace.archive.NamespaceDependencies.rootNamespaces">
<code class="descname">rootNamespaces</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.archive.NamespaceDependencies.rootNamespaces" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.namespace.archive.NamespaceDependencies.setSiblingNamespaces">
<code class="descname">setSiblingNamespaces</code><span class="sig-paren">(</span><em>sibling_namespaces</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.archive.NamespaceDependencies.setSiblingNamespaces" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.namespace.archive.NamespaceDependencies.siblingNamespaces">
<code class="descname">siblingNamespaces</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.archive.NamespaceDependencies.siblingNamespaces" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.namespace.archive.NamespaceDependencies.siblingsFromGraph">
<code class="descname">siblingsFromGraph</code><span class="sig-paren">(</span><em>reset=False</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.archive.NamespaceDependencies.siblingsFromGraph" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="data">
<dt id="pyxb.namespace.archive.PathEnvironmentVariable">
<code class="descclassname">pyxb.namespace.archive.</code><code class="descname">PathEnvironmentVariable</code><em class="property"> = 'PYXB_ARCHIVE_PATH'</em><a class="headerlink" href="#pyxb.namespace.archive.PathEnvironmentVariable" title="Permalink to this definition">¶</a></dt>
<dd><p>Environment variable from which default path to pre-loaded namespaces is
read. The value should be a colon-separated list of absolute paths. The
character <code class="xref py py-obj docutils literal"><span class="pre">&</span></code> at the start of a member of the list is replaced by the path to
the directory where the %{pyxb} modules are found, including a trailing <code class="xref py py-obj docutils literal"><span class="pre">/</span></code>.
For example, use <code class="xref py py-obj docutils literal"><span class="pre">&pyxb/bundles//</span></code> to enable search of any archive bundled
with PyXB.</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 you put a path separator between <code class="xref py py-obj docutils literal"><span class="pre">&</span></code> and the following path, this</td>
</tr>
</tbody>
</table>
<p>will cause the substitution to be ignored.</p>
</dd></dl>
<dl class="class">
<dt id="pyxb.namespace.archive._ArchivableObject_mixin">
<em class="property">class </em><code class="descclassname">pyxb.namespace.archive.</code><code class="descname">_ArchivableObject_mixin</code><span class="sig-paren">(</span><em>*args</em>, <em>**kw</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.archive._ArchivableObject_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>Mix-in to any object that can be stored in a namespace within an archive.</p>
<dl class="attribute">
<dt id="pyxb.namespace.archive._ArchivableObject_mixin._ArchivableObject_mixin__objectOrigin">
<code class="descname">_ArchivableObject_mixin__objectOrigin</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.namespace.archive._ArchivableObject_mixin._ArchivableObject_mixin__objectOrigin" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.namespace.archive._ArchivableObject_mixin._allowUpdateFromOther">
<code class="descname">_allowUpdateFromOther</code><span class="sig-paren">(</span><em>other</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.archive._ArchivableObject_mixin._allowUpdateFromOther" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.namespace.archive._ArchivableObject_mixin._objectOrigin">
<code class="descname">_objectOrigin</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.archive._ArchivableObject_mixin._objectOrigin" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.namespace.archive._ArchivableObject_mixin._prepareForArchive">
<code class="descname">_prepareForArchive</code><span class="sig-paren">(</span><em>archive</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.archive._ArchivableObject_mixin._prepareForArchive" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.namespace.archive._ArchivableObject_mixin._setObjectOrigin">
<code class="descname">_setObjectOrigin</code><span class="sig-paren">(</span><em>object_origin</em>, <em>override=False</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.archive._ArchivableObject_mixin._setObjectOrigin" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.namespace.archive._ArchivableObject_mixin._updateFromOther">
<code class="descname">_updateFromOther</code><span class="sig-paren">(</span><em>other</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.archive._ArchivableObject_mixin._updateFromOther" title="Permalink to this definition">¶</a></dt>
<dd><p>Update this instance with additional information provided by the other instance.</p>
<p>This is used, for example, when a built-in type is already registered
in the namespace, but we’ve processed the corresponding schema and
have obtained more details.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.namespace.archive._ArchivableObject_mixin._updateFromOther_csc">
<code class="descname">_updateFromOther_csc</code><span class="sig-paren">(</span><em>other</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.archive._ArchivableObject_mixin._updateFromOther_csc" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="pyxb.namespace.archive._NamespaceArchivable_mixin">
<em class="property">class </em><code class="descclassname">pyxb.namespace.archive.</code><code class="descname">_NamespaceArchivable_mixin</code><span class="sig-paren">(</span><em>*args</em>, <em>**kw</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.archive._NamespaceArchivable_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>Encapsulate the operations and data relevant to archiving namespaces.</p>
<p>This class mixes-in to <a class="reference internal" href="#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>
<dl class="attribute">
<dt id="pyxb.namespace.archive._NamespaceArchivable_mixin._NamespaceArchivable_mixin__isActive">
<code class="descname">_NamespaceArchivable_mixin__isActive</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.namespace.archive._NamespaceArchivable_mixin._NamespaceArchivable_mixin__isActive" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.namespace.archive._NamespaceArchivable_mixin._NamespaceArchivable_mixin__isImportAugmentable">
<code class="descname">_NamespaceArchivable_mixin__isImportAugmentable</code><em class="property"> = False</em><a class="headerlink" href="#pyxb.namespace.archive._NamespaceArchivable_mixin._NamespaceArchivable_mixin__isImportAugmentable" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.namespace.archive._NamespaceArchivable_mixin._NamespaceArchivable_mixin__loadedFromArchive">
<code class="descname">_NamespaceArchivable_mixin__loadedFromArchive</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.namespace.archive._NamespaceArchivable_mixin._NamespaceArchivable_mixin__loadedFromArchive" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.namespace.archive._NamespaceArchivable_mixin._NamespaceArchivable_mixin__moduleRecordMap">
<code class="descname">_NamespaceArchivable_mixin__moduleRecordMap</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.namespace.archive._NamespaceArchivable_mixin._NamespaceArchivable_mixin__moduleRecordMap" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.namespace.archive._NamespaceArchivable_mixin._NamespaceArchivable_mixin__wroteToArchive">
<code class="descname">_NamespaceArchivable_mixin__wroteToArchive</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.namespace.archive._NamespaceArchivable_mixin._NamespaceArchivable_mixin__wroteToArchive" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.namespace.archive._NamespaceArchivable_mixin._activate">
<code class="descname">_activate</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.archive._NamespaceArchivable_mixin._activate" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.namespace.archive._NamespaceArchivable_mixin._loadedFromArchive">
<code class="descname">_loadedFromArchive</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.archive._NamespaceArchivable_mixin._loadedFromArchive" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.namespace.archive._NamespaceArchivable_mixin._removeArchive">
<code class="descname">_removeArchive</code><span class="sig-paren">(</span><em>archive</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.archive._NamespaceArchivable_mixin._removeArchive" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.namespace.archive._NamespaceArchivable_mixin._reset">
<code class="descname">_reset</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.archive._NamespaceArchivable_mixin._reset" title="Permalink to this definition">¶</a></dt>
<dd><p>CSC extension to reset fields of a Namespace.</p>
<p>This one handles category-related data.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.namespace.archive._NamespaceArchivable_mixin._setLoadedFromArchive">
<code class="descname">_setLoadedFromArchive</code><span class="sig-paren">(</span><em>archive</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.archive._NamespaceArchivable_mixin._setLoadedFromArchive" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.namespace.archive._NamespaceArchivable_mixin._setState_csc">
<code class="descname">_setState_csc</code><span class="sig-paren">(</span><em>kw</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.archive._NamespaceArchivable_mixin._setState_csc" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.namespace.archive._NamespaceArchivable_mixin._setWroteToArchive">
<code class="descname">_setWroteToArchive</code><span class="sig-paren">(</span><em>archive</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.archive._NamespaceArchivable_mixin._setWroteToArchive" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.namespace.archive._NamespaceArchivable_mixin.addModuleRecord">
<code class="descname">addModuleRecord</code><span class="sig-paren">(</span><em>module_record</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.archive._NamespaceArchivable_mixin.addModuleRecord" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.namespace.archive._NamespaceArchivable_mixin.isActive">
<code class="descname">isActive</code><span class="sig-paren">(</span><em>empty_inactive=False</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.archive._NamespaceArchivable_mixin.isActive" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.namespace.archive._NamespaceArchivable_mixin.isImportAugmentable">
<code class="descname">isImportAugmentable</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.archive._NamespaceArchivable_mixin.isImportAugmentable" 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 component model for this namespace may be
extended by import directives.</p>
<p>This is the case if the namespace has been marked with
<a class="reference internal" href="#pyxb.namespace.archive._NamespaceArchivable_mixin.setImportAugmentable" title="pyxb.namespace.archive._NamespaceArchivable_mixin.setImportAugmentable"><code class="xref py py-obj docutils literal"><span class="pre">setImportAugmentable</span></code></a>, or if there is no archive or built-in that
provides a component model for the namespace.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.namespace.archive._NamespaceArchivable_mixin.isLoadable">
<code class="descname">isLoadable</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.archive._NamespaceArchivable_mixin.isLoadable" 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 component model for this namespace can be
loaded from a namespace archive.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.namespace.archive._NamespaceArchivable_mixin.loadableFrom">
<code class="descname">loadableFrom</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.archive._NamespaceArchivable_mixin.loadableFrom" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the list of archives from which components for this
namespace can be loaded.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.namespace.archive._NamespaceArchivable_mixin.lookupModuleRecordByUID">
<code class="descname">lookupModuleRecordByUID</code><span class="sig-paren">(</span><em>generation_uid</em>, <em>create_if_missing=False</em>, <em>*args</em>, <em>**kw</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.archive._NamespaceArchivable_mixin.lookupModuleRecordByUID" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.namespace.archive._NamespaceArchivable_mixin.markNotLoadable">
<code class="descname">markNotLoadable</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.archive._NamespaceArchivable_mixin.markNotLoadable" title="Permalink to this definition">¶</a></dt>
<dd><p>Prevent loading this namespace from an archive.</p>
<p>This marks all archives in which the namespace appears, whether
publically or privately, as not loadable.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.namespace.archive._NamespaceArchivable_mixin.moduleRecords">
<code class="descname">moduleRecords</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.archive._NamespaceArchivable_mixin.moduleRecords" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.namespace.archive._NamespaceArchivable_mixin.setImportAugmentable">
<code class="descname">setImportAugmentable</code><span class="sig-paren">(</span><em>value=True</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.archive._NamespaceArchivable_mixin.setImportAugmentable" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="pyxb.namespace.archive._ObjectOrigin">
<em class="property">class </em><code class="descclassname">pyxb.namespace.archive.</code><code class="descname">_ObjectOrigin</code><span class="sig-paren">(</span><em>namespace</em>, <em>generation_uid</em>, <em>**kw</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.archive._ObjectOrigin" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="pyxb.utils.html#pyxb.utils.utility.PrivateTransient_mixin" title="pyxb.utils.utility.PrivateTransient_mixin"><code class="xref py py-class docutils literal"><span class="pre">pyxb.utils.utility.PrivateTransient_mixin</span></code></a>, <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>Marker class for objects that can serve as an origin for an object in a
namespace.</p>
<dl class="attribute">
<dt id="pyxb.namespace.archive._ObjectOrigin._ObjectOrigin__PrivateTransient">
<code class="descname">_ObjectOrigin__PrivateTransient</code><em class="property"> = set(['categoryObjectMap', 'originatedObjects'])</em><a class="headerlink" href="#pyxb.namespace.archive._ObjectOrigin._ObjectOrigin__PrivateTransient" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.namespace.archive._ObjectOrigin._ObjectOrigin__categoryMembers">
<code class="descname">_ObjectOrigin__categoryMembers</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.namespace.archive._ObjectOrigin._ObjectOrigin__categoryMembers" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.namespace.archive._ObjectOrigin._ObjectOrigin__categoryObjectMap">
<code class="descname">_ObjectOrigin__categoryObjectMap</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.namespace.archive._ObjectOrigin._ObjectOrigin__categoryObjectMap" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.namespace.archive._ObjectOrigin._ObjectOrigin__moduleRecord">
<code class="descname">_ObjectOrigin__moduleRecord</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.namespace.archive._ObjectOrigin._ObjectOrigin__moduleRecord" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.namespace.archive._ObjectOrigin._ObjectOrigin__originatedObjects">
<code class="descname">_ObjectOrigin__originatedObjects</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.namespace.archive._ObjectOrigin._ObjectOrigin__originatedObjects" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.namespace.archive._ObjectOrigin._ObjectOrigin__signature">
<code class="descname">_ObjectOrigin__signature</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.namespace.archive._ObjectOrigin._ObjectOrigin__signature" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.namespace.archive._ObjectOrigin.addCategoryMember">
<code class="descname">addCategoryMember</code><span class="sig-paren">(</span><em>category</em>, <em>name</em>, <em>obj</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.archive._ObjectOrigin.addCategoryMember" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.namespace.archive._ObjectOrigin.categoryMembers">
<code class="descname">categoryMembers</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.archive._ObjectOrigin.categoryMembers" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.namespace.archive._ObjectOrigin.generationUID">
<code class="descname">generationUID</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.archive._ObjectOrigin.generationUID" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.namespace.archive._ObjectOrigin.moduleRecord">
<code class="descname">moduleRecord</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.archive._ObjectOrigin.moduleRecord" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.namespace.archive._ObjectOrigin.namespace">
<code class="descname">namespace</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.archive._ObjectOrigin.namespace" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.namespace.archive._ObjectOrigin.originatedObjects">
<code class="descname">originatedObjects</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.archive._ObjectOrigin.originatedObjects" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.namespace.archive._ObjectOrigin.resetCategoryMembers">
<code class="descname">resetCategoryMembers</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.archive._ObjectOrigin.resetCategoryMembers" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.namespace.archive._ObjectOrigin.signature">
<code class="descname">signature</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.archive._ObjectOrigin.signature" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="pyxb.namespace.archive._SchemaOrigin">
<em class="property">class </em><code class="descclassname">pyxb.namespace.archive.</code><code class="descname">_SchemaOrigin</code><span class="sig-paren">(</span><em>**kw</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.archive._SchemaOrigin" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#pyxb.namespace.archive._ObjectOrigin" title="pyxb.namespace.archive._ObjectOrigin"><code class="xref py py-class docutils literal"><span class="pre">pyxb.namespace.archive._ObjectOrigin</span></code></a></p>
<p>Holds the data regarding components derived from a single schema.</p>
<p>Coupled to a particular namespace through the
<code class="xref py py-obj docutils literal"><span class="pre">_NamespaceComponentAssociation_mixin</span></code>.</p>
<dl class="attribute">
<dt id="pyxb.namespace.archive._SchemaOrigin._SchemaOrigin__PrivateTransient">
<code class="descname">_SchemaOrigin__PrivateTransient</code><em class="property"> = set(['schema'])</em><a class="headerlink" href="#pyxb.namespace.archive._SchemaOrigin._SchemaOrigin__PrivateTransient" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.namespace.archive._SchemaOrigin._SchemaOrigin__location">
<code class="descname">_SchemaOrigin__location</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.namespace.archive._SchemaOrigin._SchemaOrigin__location" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.namespace.archive._SchemaOrigin._SchemaOrigin__schema">
<code class="descname">_SchemaOrigin__schema</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.namespace.archive._SchemaOrigin._SchemaOrigin__schema" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.namespace.archive._SchemaOrigin._SchemaOrigin__setDefaultKW">
<code class="descname">_SchemaOrigin__setDefaultKW</code><span class="sig-paren">(</span><em>kw</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.archive._SchemaOrigin._SchemaOrigin__setDefaultKW" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.namespace.archive._SchemaOrigin._SchemaOrigin__version">
<code class="descname">_SchemaOrigin__version</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.namespace.archive._SchemaOrigin._SchemaOrigin__version" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.namespace.archive._SchemaOrigin.location">
<code class="descname">location</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.archive._SchemaOrigin.location" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.namespace.archive._SchemaOrigin.match">
<code class="descname">match</code><span class="sig-paren">(</span><em>**kw</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.archive._SchemaOrigin.match" title="Permalink to this definition">¶</a></dt>
<dd><p>Determine whether this record matches the parameters.</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>schema</strong> – a <a class="reference internal" href="pyxb.xmlschema.html#pyxb.xmlschema.structures.Schema" title="pyxb.xmlschema.structures.Schema"><code class="xref py py-obj docutils literal"><span class="pre">pyxb.xmlschema.structures.Schema</span></code></a> instance from</td>
</tr>
</tbody>
</table>
<p>which the other parameters are obtained.
:keyword location: a schema location (URI)
:keyword signature: a schema signature
:return: <code class="xref py py-obj docutils literal"><span class="pre">True</span></code> iff I{either} <a class="reference internal" href="#pyxb.namespace.archive._SchemaOrigin.location" title="pyxb.namespace.archive._SchemaOrigin.location"><code class="xref py py-obj docutils literal"><span class="pre">location</span></code></a> or <code class="xref py py-obj docutils literal"><span class="pre">signature</span></code> matches.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.namespace.archive._SchemaOrigin.schema">
<code class="descname">schema</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.archive._SchemaOrigin.schema" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.namespace.archive._SchemaOrigin.version">
<code class="descname">version</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.archive._SchemaOrigin.version" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
</div>
<div class="section" id="module-pyxb.namespace.builtin">
<span id="pyxb-namespace-builtin-module"></span><h2>pyxb.namespace.builtin module<a class="headerlink" href="#module-pyxb.namespace.builtin" title="Permalink to this headline">¶</a></h2>
<p>Classes and global objects related to built-in XML Namespaces<<a class="reference external" href="http://www.w3.org/TR/2006/REC-xml-names-20060816/index.html">http://www.w3.org/TR/2006/REC-xml-names-20060816/index.html</a>>.</p>
<dl class="data">
<dt id="pyxb.namespace.builtin.XHTML">
<code class="descclassname">pyxb.namespace.builtin.</code><code class="descname">XHTML</code><em class="property"> = <pyxb.namespace.Namespace object></em><a class="headerlink" href="#pyxb.namespace.builtin.XHTML" title="Permalink to this definition">¶</a></dt>
<dd><p>There really isn’t a schema for this, but it’s used as the default
namespace in the XML schema, so define it.</p>
</dd></dl>
<dl class="data">
<dt id="pyxb.namespace.builtin.XML">
<code class="descclassname">pyxb.namespace.builtin.</code><code class="descname">XML</code><em class="property"> = <pyxb.namespace.builtin._XML object></em><a class="headerlink" href="#pyxb.namespace.builtin.XML" title="Permalink to this definition">¶</a></dt>
<dd><p>Namespace and URI for XML itself (always available as <code class="xref py py-obj docutils literal"><span class="pre">xml</span></code>)</p>
</dd></dl>
<dl class="data">
<dt id="pyxb.namespace.builtin.XMLNamespaces">
<code class="descclassname">pyxb.namespace.builtin.</code><code class="descname">XMLNamespaces</code><em class="property"> = <pyxb.namespace.Namespace object></em><a class="headerlink" href="#pyxb.namespace.builtin.XMLNamespaces" title="Permalink to this definition">¶</a></dt>
<dd><p>Namespaces in XML. Not really a namespace, but is always available as <code class="xref py py-obj docutils literal"><span class="pre">xmlns</span></code>.</p>
</dd></dl>
<dl class="data">
<dt id="pyxb.namespace.builtin.XMLSchema">
<code class="descclassname">pyxb.namespace.builtin.</code><code class="descname">XMLSchema</code><em class="property"> = <pyxb.namespace.builtin._XMLSchema object></em><a class="headerlink" href="#pyxb.namespace.builtin.XMLSchema" title="Permalink to this definition">¶</a></dt>
<dd><p>Namespace and URI for the XMLSchema namespace (often <code class="xref py py-obj docutils literal"><span class="pre">xs</span></code>, or <code class="xref py py-obj docutils literal"><span class="pre">xsd</span></code>)</p>
</dd></dl>
<dl class="data">
<dt id="pyxb.namespace.builtin.XMLSchema_hfp">
<code class="descclassname">pyxb.namespace.builtin.</code><code class="descname">XMLSchema_hfp</code><em class="property"> = <pyxb.namespace.Namespace object></em><a class="headerlink" href="#pyxb.namespace.builtin.XMLSchema_hfp" title="Permalink to this definition">¶</a></dt>
<dd><p>Elements appearing in appinfo elements to support data types.</p>
</dd></dl>
<dl class="data">
<dt id="pyxb.namespace.builtin.XMLSchema_instance">
<code class="descclassname">pyxb.namespace.builtin.</code><code class="descname">XMLSchema_instance</code><em class="property"> = <pyxb.namespace.builtin._XMLSchema_instance object></em><a class="headerlink" href="#pyxb.namespace.builtin.XMLSchema_instance" title="Permalink to this definition">¶</a></dt>
<dd><p>Namespace and URI for the XMLSchema Instance namespace. This is always
built-in, and does not (cannot) have an associated schema.</p>
</dd></dl>
<dl class="function">
<dt id="pyxb.namespace.builtin._InitializeBuiltinNamespaces">
<code class="descclassname">pyxb.namespace.builtin.</code><code class="descname">_InitializeBuiltinNamespaces</code><span class="sig-paren">(</span><em>structures_module</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.builtin._InitializeBuiltinNamespaces" title="Permalink to this definition">¶</a></dt>
<dd><p>Invoked at the end of the <a class="reference internal" href="pyxb.xmlschema.html#module-pyxb.xmlschema.structures" title="pyxb.xmlschema.structures"><code class="xref py py-obj docutils literal"><span class="pre">pyxb.xmlschema.structures</span></code></a> module to
initialize the component models of the built-in namespaces.</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>structures_module</strong> – The <a class="reference internal" href="pyxb.xmlschema.html#module-pyxb.xmlschema.structures" title="pyxb.xmlschema.structures"><code class="xref py py-obj docutils literal"><span class="pre">pyxb.xmlschema.structures</span></code></a> module may not</td>
</tr>
</tbody>
</table>
<p>be importable by that name at the time this is invoked (because it is
still being processed), so it gets passed in as a parameter.</p>
</dd></dl>
<dl class="class">
<dt id="pyxb.namespace.builtin._XML">
<em class="property">class </em><code class="descclassname">pyxb.namespace.builtin.</code><code class="descname">_XML</code><span class="sig-paren">(</span><em>uri</em>, <em>description=None</em>, <em>builtin_namespace=None</em>, <em>builtin_module_path=None</em>, <em>is_undeclared_namespace=False</em>, <em>is_loaded_namespace=False</em>, <em>bound_prefix=None</em>, <em>default_namespace=None</em>, <em>in_scope_namespaces=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.builtin._XML" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#pyxb.namespace.Namespace" title="pyxb.namespace.Namespace"><code class="xref py py-class docutils literal"><span class="pre">pyxb.namespace.Namespace</span></code></a></p>
<p>Extension of <code class="xref py py-obj docutils literal"><span class="pre">Namespace</span></code> that pre-defines components available in the
XML (xml) namespace. Specifically those are the attribute declarations:</p>
<blockquote>
<div><ul class="simple">
<li><code class="xref py py-obj docutils literal"><span class="pre">xml:space</span></code></li>
<li><code class="xref py py-obj docutils literal"><span class="pre">xml:lang</span></code></li>
<li><code class="xref py py-obj docutils literal"><span class="pre">xml:base</span></code></li>
<li><code class="xref py py-obj docutils literal"><span class="pre">xml:id</span></code></li>
</ul>
</div></blockquote>
<p>the encompassing attribute group declaration:</p>
<blockquote>
<div><ul class="simple">
<li><code class="xref py py-obj docutils literal"><span class="pre">xml:specialAttrs</span></code></li>
</ul>
</div></blockquote>
<p>and the anonymous types that support these.</p>
<dl class="method">
<dt id="pyxb.namespace.builtin._XML._defineBuiltins_ox">
<code class="descname">_defineBuiltins_ox</code><span class="sig-paren">(</span><em>structures_module</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.builtin._XML._defineBuiltins_ox" title="Permalink to this definition">¶</a></dt>
<dd><p>Ensure this namespace is ready for use.</p>
<p>Overrides base class implementation, since there is no schema
for this namespace.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="pyxb.namespace.builtin._XMLSchema">
<em class="property">class </em><code class="descclassname">pyxb.namespace.builtin.</code><code class="descname">_XMLSchema</code><span class="sig-paren">(</span><em>uri</em>, <em>description=None</em>, <em>builtin_namespace=None</em>, <em>builtin_module_path=None</em>, <em>is_undeclared_namespace=False</em>, <em>is_loaded_namespace=False</em>, <em>bound_prefix=None</em>, <em>default_namespace=None</em>, <em>in_scope_namespaces=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.builtin._XMLSchema" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#pyxb.namespace.Namespace" title="pyxb.namespace.Namespace"><code class="xref py py-class docutils literal"><span class="pre">pyxb.namespace.Namespace</span></code></a></p>
<p>Extension of <code class="xref py py-obj docutils literal"><span class="pre">Namespace</span></code> that pre-defines components available in the
XMLSchema namespace.</p>
<p>The types are defined when <a class="reference internal" href="pyxb.xmlschema.html#module-pyxb.xmlschema.structures" title="pyxb.xmlschema.structures"><code class="xref py py-obj docutils literal"><span class="pre">pyxb.xmlschema.structures</span></code></a> is imported.</p>
<dl class="method">
<dt id="pyxb.namespace.builtin._XMLSchema._defineBuiltins_ox">
<code class="descname">_defineBuiltins_ox</code><span class="sig-paren">(</span><em>structures_module</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.builtin._XMLSchema._defineBuiltins_ox" title="Permalink to this definition">¶</a></dt>
<dd><p>Register the built-in types into the XMLSchema namespace.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="pyxb.namespace.builtin._XMLSchema_instance">
<em class="property">class </em><code class="descclassname">pyxb.namespace.builtin.</code><code class="descname">_XMLSchema_instance</code><span class="sig-paren">(</span><em>*args</em>, <em>**kw</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.builtin._XMLSchema_instance" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#pyxb.namespace.Namespace" title="pyxb.namespace.Namespace"><code class="xref py py-class docutils literal"><span class="pre">pyxb.namespace.Namespace</span></code></a></p>
<p>Extension of <code class="xref py py-obj docutils literal"><span class="pre">Namespace</span></code> that pre-defines components available in the
XMLSchema Instance namespace.</p>
<dl class="attribute">
<dt id="pyxb.namespace.builtin._XMLSchema_instance.PT_lax">
<code class="descname">PT_lax</code><em class="property"> = 'lax'</em><a class="headerlink" href="#pyxb.namespace.builtin._XMLSchema_instance.PT_lax" title="Permalink to this definition">¶</a></dt>
<dd><p>xsi:type supersedes the declared type without validation. If
no xsi:type is present, or it is present and fails to resolve to a
type, the declared element type will be used. If xsi:type is
present and resolves to valid type, that type will be used for the
binding, even if it is not a subclass of the declared type.</p>
</dd></dl>
<dl class="attribute">
<dt id="pyxb.namespace.builtin._XMLSchema_instance.PT_skip">
<code class="descname">PT_skip</code><em class="property"> = 'skip'</em><a class="headerlink" href="#pyxb.namespace.builtin._XMLSchema_instance.PT_skip" title="Permalink to this definition">¶</a></dt>
<dd><p>xsi:type attributes are ignored. The declared element type
will be used.</p>
</dd></dl>
<dl class="attribute">
<dt id="pyxb.namespace.builtin._XMLSchema_instance.PT_strict">
<code class="descname">PT_strict</code><em class="property"> = 'strict'</em><a class="headerlink" href="#pyxb.namespace.builtin._XMLSchema_instance.PT_strict" title="Permalink to this definition">¶</a></dt>
<dd><p>xsi:type is validated and supersedes the declared type. If no xsi:type is
present, the declared element type will be used. If xsi:type is
present, it must resolve to valid type. The resolved type must be
a subclass of the declared type (if available), and will be used
for the binding.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.namespace.builtin._XMLSchema_instance.ProcessTypeAttribute">
<code class="descname">ProcessTypeAttribute</code><span class="sig-paren">(</span><em>value=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.builtin._XMLSchema_instance.ProcessTypeAttribute" title="Permalink to this definition">¶</a></dt>
<dd><p>Specify how PyXB should interpret U{xsi:type
<http://www.w3.org/TR/xmlschema-1/#xsi_type>} attributes when
converting a document to a binding instance.</p>
<p>The default value is <a class="reference internal" href="#pyxb.namespace.builtin._XMLSchema_instance.PT_strict" title="pyxb.namespace.builtin._XMLSchema_instance.PT_strict"><code class="xref py py-obj docutils literal"><span class="pre">PT_strict</span></code></a>.</p>
<p>xsi:type should only be provided when using an abstract class,
or a concrete class that happens to be the same as the
xsi:type value, or when accepting a wildcard that has an
unrecognized element name. In practice, web services tend to
set it on nodes just to inform their lax-processing clients
how to interpret the value.</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> – One of <a class="reference internal" href="#pyxb.namespace.builtin._XMLSchema_instance.PT_strict" title="pyxb.namespace.builtin._XMLSchema_instance.PT_strict"><code class="xref py py-obj docutils literal"><span class="pre">PT_strict</span></code></a>, <a class="reference internal" href="#pyxb.namespace.builtin._XMLSchema_instance.PT_lax" title="pyxb.namespace.builtin._XMLSchema_instance.PT_lax"><code class="xref py py-obj docutils literal"><span class="pre">PT_lax</span></code></a>, <a class="reference internal" href="#pyxb.namespace.builtin._XMLSchema_instance.PT_skip" title="pyxb.namespace.builtin._XMLSchema_instance.PT_skip"><code class="xref py py-obj docutils literal"><span class="pre">PT_skip</span></code></a>, or <code class="xref py py-obj docutils literal"><span class="pre">None</span></code> (no change)</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The current configuration for processing xsi:type attributes</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="pyxb.namespace.builtin._XMLSchema_instance._InterpretTypeAttribute">
<code class="descname">_InterpretTypeAttribute</code><span class="sig-paren">(</span><em>type_name</em>, <em>ns_ctx</em>, <em>fallback_namespace</em>, <em>type_class</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.builtin._XMLSchema_instance._InterpretTypeAttribute" title="Permalink to this definition">¶</a></dt>
<dd><p>Interpret the value of an xsi:type attribute as configured
by <a class="reference internal" href="#pyxb.namespace.builtin._XMLSchema_instance.ProcessTypeAttribute" title="pyxb.namespace.builtin._XMLSchema_instance.ProcessTypeAttribute"><code class="xref py py-obj docutils literal"><span class="pre">ProcessTypeAttribute</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>type_name</strong> – The QName value from U{xsi:type</td>
</tr>
</tbody>
</table>
<p><<a class="reference external" href="http://www.w3.org/TR/xmlschema-1/#xsi_type">http://www.w3.org/TR/xmlschema-1/#xsi_type</a>>}. If this is
<code class="xref py py-obj docutils literal"><span class="pre">None</span></code>, <code class="xref py py-obj docutils literal"><span class="pre">type_class</span></code> is used as <code class="xref py py-obj docutils literal"><span class="pre">ret_type_class</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>ns_ctx</strong> – The NamespaceContext within which <code class="xref py py-obj docutils literal"><span class="pre">type_name</span></code></td>
</tr>
</tbody>
</table>
<p>should be resolved</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 that should be used</td>
</tr>
</tbody>
</table>
<p>if <code class="xref py py-obj docutils literal"><span class="pre">type_name</span></code> has no 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>type_class</strong> – The value to return if <code class="xref py py-obj docutils literal"><span class="pre">type_name</span></code> is</td>
</tr>
</tbody>
</table>
<p>missing or acceptably invalid (viz., due to <a class="reference internal" href="#pyxb.namespace.builtin._XMLSchema_instance.PT_skip" title="pyxb.namespace.builtin._XMLSchema_instance.PT_skip"><code class="xref py py-obj docutils literal"><span class="pre">PT_skip</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 tuple <code class="xref py py-obj docutils literal"><span class="pre">(did_replace,</span> <span class="pre">ret_type_class)</span></code> where</td>
</tr>
</tbody>
</table>
<p><code class="xref py py-obj docutils literal"><span class="pre">did_replace</span></code> is <code class="xref py py-obj docutils literal"><span class="pre">True</span></code> iff the <code class="xref py py-obj docutils literal"><span class="pre">ret_type_class</span></code> is not the
same as <code class="xref py py-obj docutils literal"><span class="pre">type_class</span></code>, and <code class="xref py py-obj docutils literal"><span class="pre">ret_type_class</span></code> is the class that
should be 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">Raises:</th><td class="field-body"><strong>pyxb.BadDocumentError</strong> – if the processing type</td>
</tr>
</tbody>
</table>
<p>configuration is <a class="reference internal" href="#pyxb.namespace.builtin._XMLSchema_instance.PT_strict" title="pyxb.namespace.builtin._XMLSchema_instance.PT_strict"><code class="xref py py-obj docutils literal"><span class="pre">PT_strict</span></code></a> and <code class="xref py py-obj docutils literal"><span class="pre">type_name</span></code> fails to
resolve to a type definition that is consistent with any
provided <code class="xref py py-obj docutils literal"><span class="pre">type_class</span></code>.</p>
</dd></dl>
<dl class="attribute">
<dt id="pyxb.namespace.builtin._XMLSchema_instance._XMLSchema_instance__processType">
<code class="descname">_XMLSchema_instance__processType</code><em class="property"> = 'strict'</em><a class="headerlink" href="#pyxb.namespace.builtin._XMLSchema_instance._XMLSchema_instance__processType" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.namespace.builtin._XMLSchema_instance._defineBuiltins_ox">
<code class="descname">_defineBuiltins_ox</code><span class="sig-paren">(</span><em>structures_module</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.builtin._XMLSchema_instance._defineBuiltins_ox" title="Permalink to this definition">¶</a></dt>
<dd><p>Ensure this namespace is ready for use.</p>
<p>Overrides base class implementation, since there is no schema
for this namespace.</p>
</dd></dl>
<dl class="attribute">
<dt id="pyxb.namespace.builtin._XMLSchema_instance.nil">
<code class="descname">nil</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.namespace.builtin._XMLSchema_instance.nil" title="Permalink to this definition">¶</a></dt>
<dd><p>An expanded name for {<a class="reference external" href="http://www.w3.org/2001/XMLSchema-instance">http://www.w3.org/2001/XMLSchema-instance</a>}nil.</p>
</dd></dl>
<dl class="attribute">
<dt id="pyxb.namespace.builtin._XMLSchema_instance.type">
<code class="descname">type</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.namespace.builtin._XMLSchema_instance.type" title="Permalink to this definition">¶</a></dt>
<dd><p>An expanded name for {<a class="reference external" href="http://www.w3.org/2001/XMLSchema-instance">http://www.w3.org/2001/XMLSchema-instance</a>}type.</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="pyxb-namespace-resolution-module">
<h2>pyxb.namespace.resolution module<a class="headerlink" href="#pyxb-namespace-resolution-module" title="Permalink to this headline">¶</a></h2>
<span class="target" id="module-pyxb.namespace.resolution"></span><p>Classes and global objects related to resolving U{XML
Namespaces<<a class="reference external" href="http://www.w3.org/TR/2006/REC-xml-names-20060816/index.html">http://www.w3.org/TR/2006/REC-xml-names-20060816/index.html</a>>}.</p>
<dl class="class">
<dt id="pyxb.namespace.resolution.NamespaceContext">
<em class="property">class </em><code class="descclassname">pyxb.namespace.resolution.</code><code class="descname">NamespaceContext</code><span class="sig-paren">(</span><em>dom_node=None</em>, <em>parent_context=None</em>, <em>including_context=None</em>, <em>recurse=True</em>, <em>default_namespace=None</em>, <em>target_namespace=None</em>, <em>in_scope_namespaces=None</em>, <em>expanded_name=None</em>, <em>finalize_target_namespace=True</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.resolution.NamespaceContext" 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 information associated with namespaces at a DOM node.</p>
<dl class="classmethod">
<dt id="pyxb.namespace.resolution.NamespaceContext.Current">
<em class="property">classmethod </em><code class="descname">Current</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.resolution.NamespaceContext.Current" title="Permalink to this definition">¶</a></dt>
<dd><p>Access the currently active namespace context.</p>
<p>If no context is active, <code class="xref py py-obj docutils literal"><span class="pre">None</span></code> is returned. This probably
represents mis-use of the infrastructure (viz., failure to record the
context within which a QName must be resolved).</p>
</dd></dl>
<dl class="classmethod">
<dt id="pyxb.namespace.resolution.NamespaceContext.GetNodeContext">
<em class="property">classmethod </em><code class="descname">GetNodeContext</code><span class="sig-paren">(</span><em>node</em>, <em>**kw</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.resolution.NamespaceContext.GetNodeContext" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the <a class="reference internal" href="#pyxb.namespace.resolution.NamespaceContext" title="pyxb.namespace.resolution.NamespaceContext"><code class="xref py py-obj docutils literal"><span class="pre">NamespaceContext</span></code></a> instance that was assigned to the node.</p>
<p>If none has been assigned and keyword parameters are present, create
one treating this as the root node and the keyword parameters as
configuration information (e.g., default_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">Raises:</th><td class="field-body"><strong>pyxb.LogicError</strong> – no context is available and the keywords</td>
</tr>
</tbody>
</table>
<p>required to create one were not provided</p>
</dd></dl>
<dl class="classmethod">
<dt id="pyxb.namespace.resolution.NamespaceContext.PopContext">
<em class="property">classmethod </em><code class="descname">PopContext</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.resolution.NamespaceContext.PopContext" title="Permalink to this definition">¶</a></dt>
<dd><p>Discard the currently active namespace context, restoring its
predecessor.</p>
<p>The discarded context is returned.</p>
</dd></dl>
<dl class="classmethod">
<dt id="pyxb.namespace.resolution.NamespaceContext.PushContext">
<em class="property">classmethod </em><code class="descname">PushContext</code><span class="sig-paren">(</span><em>ctx</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.resolution.NamespaceContext.PushContext" title="Permalink to this definition">¶</a></dt>
<dd><p>Make <code class="xref py py-obj docutils literal"><span class="pre">ctx</span></code> the currently active namespace context.</p>
<p>Prior contexts are retained on a LIFO stack.</p>
</dd></dl>
<dl class="classmethod">
<dt id="pyxb.namespace.resolution.NamespaceContext._AddTargetNamespaceAttribute">
<em class="property">classmethod </em><code class="descname">_AddTargetNamespaceAttribute</code><span class="sig-paren">(</span><em>expanded_name</em>, <em>attribute_name</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.resolution.NamespaceContext._AddTargetNamespaceAttribute" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="classmethod">
<dt id="pyxb.namespace.resolution.NamespaceContext._NamespaceContext__BuildInitialPrefixMap">
<em class="property">classmethod </em><code class="descname">_NamespaceContext__BuildInitialPrefixMap</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.resolution.NamespaceContext._NamespaceContext__BuildInitialPrefixMap" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.namespace.resolution.NamespaceContext._NamespaceContext__ContextStack">
<code class="descname">_NamespaceContext__ContextStack</code><em class="property"> = []</em><a class="headerlink" href="#pyxb.namespace.resolution.NamespaceContext._NamespaceContext__ContextStack" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.namespace.resolution.NamespaceContext._NamespaceContext__InitialScopeNamespaces">
<code class="descname">_NamespaceContext__InitialScopeNamespaces</code><em class="property"> = {'xml': <pyxb.namespace.builtin._XML object>, 'xmlns': <pyxb.namespace.Namespace object>}</em><a class="headerlink" href="#pyxb.namespace.resolution.NamespaceContext._NamespaceContext__InitialScopeNamespaces" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.namespace.resolution.NamespaceContext._NamespaceContext__InitialScopePrefixes">
<code class="descname">_NamespaceContext__InitialScopePrefixes</code><em class="property"> = {<pyxb.namespace.builtin._XML object>: set(['xml']), <pyxb.namespace.Namespace object>: set(['xmlns'])}</em><a class="headerlink" href="#pyxb.namespace.resolution.NamespaceContext._NamespaceContext__InitialScopePrefixes" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.namespace.resolution.NamespaceContext._NamespaceContext__TargetNamespaceAttributes">
<code class="descname">_NamespaceContext__TargetNamespaceAttributes</code><em class="property"> = {<pyxb.namespace.ExpandedName object>: <pyxb.namespace.ExpandedName object>}</em><a class="headerlink" href="#pyxb.namespace.resolution.NamespaceContext._NamespaceContext__TargetNamespaceAttributes" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.namespace.resolution.NamespaceContext._NamespaceContext__addPrefixMap">
<code class="descname">_NamespaceContext__addPrefixMap</code><span class="sig-paren">(</span><em>pfx</em>, <em>ns</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.resolution.NamespaceContext._NamespaceContext__addPrefixMap" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.namespace.resolution.NamespaceContext._NamespaceContext__clonePrefixMap">
<code class="descname">_NamespaceContext__clonePrefixMap</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.resolution.NamespaceContext._NamespaceContext__clonePrefixMap" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.namespace.resolution.NamespaceContext._NamespaceContext__defaultNamespace">
<code class="descname">_NamespaceContext__defaultNamespace</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.namespace.resolution.NamespaceContext._NamespaceContext__defaultNamespace" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.namespace.resolution.NamespaceContext._NamespaceContext__fallbackToTargetNamespace">
<code class="descname">_NamespaceContext__fallbackToTargetNamespace</code><em class="property"> = False</em><a class="headerlink" href="#pyxb.namespace.resolution.NamespaceContext._NamespaceContext__fallbackToTargetNamespace" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.namespace.resolution.NamespaceContext._NamespaceContext__inScopeNamespaces">
<code class="descname">_NamespaceContext__inScopeNamespaces</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.namespace.resolution.NamespaceContext._NamespaceContext__inScopeNamespaces" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.namespace.resolution.NamespaceContext._NamespaceContext__inScopePrefixes">
<code class="descname">_NamespaceContext__inScopePrefixes</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.namespace.resolution.NamespaceContext._NamespaceContext__inScopePrefixes" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.namespace.resolution.NamespaceContext._NamespaceContext__initialScopeNamespaces">
<code class="descname">_NamespaceContext__initialScopeNamespaces</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.namespace.resolution.NamespaceContext._NamespaceContext__initialScopeNamespaces" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.namespace.resolution.NamespaceContext._NamespaceContext__initialScopePrefixes">
<code class="descname">_NamespaceContext__initialScopePrefixes</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.namespace.resolution.NamespaceContext._NamespaceContext__initialScopePrefixes" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.namespace.resolution.NamespaceContext._NamespaceContext__namespacePrefixCounter">
<code class="descname">_NamespaceContext__namespacePrefixCounter</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.namespace.resolution.NamespaceContext._NamespaceContext__namespacePrefixCounter" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.namespace.resolution.NamespaceContext._NamespaceContext__pendingReferencedNamespaces">
<code class="descname">_NamespaceContext__pendingReferencedNamespaces</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.namespace.resolution.NamespaceContext._NamespaceContext__pendingReferencedNamespaces" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.namespace.resolution.NamespaceContext._NamespaceContext__removePrefixMap">
<code class="descname">_NamespaceContext__removePrefixMap</code><span class="sig-paren">(</span><em>pfx</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.resolution.NamespaceContext._NamespaceContext__removePrefixMap" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.namespace.resolution.NamespaceContext._NamespaceContext__targetNamespace">
<code class="descname">_NamespaceContext__targetNamespace</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.namespace.resolution.NamespaceContext._NamespaceContext__targetNamespace" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="classmethod">
<dt id="pyxb.namespace.resolution.NamespaceContext._TargetNamespaceAttribute">
<em class="property">classmethod </em><code class="descname">_TargetNamespaceAttribute</code><span class="sig-paren">(</span><em>expanded_name</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.resolution.NamespaceContext._TargetNamespaceAttribute" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.namespace.resolution.NamespaceContext.declareNamespace">
<code class="descname">declareNamespace</code><span class="sig-paren">(</span><em>namespace</em>, <em>prefix=None</em>, <em>add_to_map=False</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.resolution.NamespaceContext.declareNamespace" title="Permalink to this definition">¶</a></dt>
<dd><p>Record the given namespace as one to be used in 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"><ul class="first last simple">
<li><strong>namespace</strong> (<a class="reference internal" href="#pyxb.namespace.Namespace" title="pyxb.namespace.Namespace"><code class="xref py py-obj docutils literal"><span class="pre">pyxb.namespace.Namespace</span></code></a>) – The namespace to be associated with the document.</li>
<li><strong>prefix</strong> – Optional prefix to be used with this namespace. If</li>
</ul>
</td>
</tr>
</tbody>
</table>
<p>not provided, a unique prefix is generated or a standard prefix is
used, depending on the 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">Returns:</th><td class="field-body">a prefix that may be used with the namespace. If <code class="xref py py-obj docutils literal"><span class="pre">prefix</span></code></td>
</tr>
</tbody>
</table>
<p>was <code class="xref py py-obj docutils literal"><span class="pre">None</span></code> the return value may be a previously-assigned 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">Todo:</th><td class="field-body">ensure multiple namespaces do not share the same prefix</td>
</tr>
<tr class="field-even field"><th class="field-name">Todo:</th><td class="field-body">provide default prefix in <a class="reference internal" href="#pyxb.namespace.Namespace" title="pyxb.namespace.Namespace"><code class="xref py py-obj docutils literal"><span class="pre">pyxb.namespace.Namespace</span></code></a></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="pyxb.namespace.resolution.NamespaceContext.defaultNamespace">
<code class="descname">defaultNamespace</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.resolution.NamespaceContext.defaultNamespace" title="Permalink to this definition">¶</a></dt>
<dd><p>The default namespace in effect at this node. E.g., <code class="xref py py-obj docutils literal"><span class="pre">xmlns="URN:default"</span></code>.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.namespace.resolution.NamespaceContext.finalizeTargetNamespace">
<code class="descname">finalizeTargetNamespace</code><span class="sig-paren">(</span><em>tns_uri=None</em>, <em>including_context=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.resolution.NamespaceContext.finalizeTargetNamespace" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.namespace.resolution.NamespaceContext.inScopeNamespaces">
<code class="descname">inScopeNamespaces</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.resolution.NamespaceContext.inScopeNamespaces" title="Permalink to this definition">¶</a></dt>
<dd><p>Map from prefix strings to <code class="xref py py-obj docutils literal"><span class="pre">Namespace</span></code> instances associated with those
prefixes. The prefix <code class="xref py py-obj docutils literal"><span class="pre">None</span></code> identifies the default namespace.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.namespace.resolution.NamespaceContext.interpretQName">
<code class="descname">interpretQName</code><span class="sig-paren">(</span><em>name</em>, <em>namespace=None</em>, <em>default_no_namespace=False</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.resolution.NamespaceContext.interpretQName" title="Permalink to this definition">¶</a></dt>
<dd><p>Convert the provided name into an <code class="xref py py-obj docutils literal"><span class="pre">ExpandedName</span></code>, i.e. a tuple of
<code class="xref py py-obj docutils literal"><span class="pre">Namespace</span></code> and local name.</p>
<p>If the name includes a prefix, that prefix must map to an in-scope
namespace in this context. Absence of a prefix maps to
<a class="reference internal" href="#pyxb.namespace.resolution.NamespaceContext.defaultNamespace" title="pyxb.namespace.resolution.NamespaceContext.defaultNamespace"><code class="xref py py-obj docutils literal"><span class="pre">defaultNamespace()</span></code></a>, which must be provided (or defaults to the
target namespace, if that is not absent).</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>name</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>) – A QName.</li>
<li><strong>name</strong> – Optional namespace to use for unqualified names when</li>
</ul>
</td>
</tr>
</tbody>
</table>
<p>there is no default namespace. Note that a defined default namespace,
even if absent, supersedes this value.
:keyword default_no_namespace: If <code class="xref py py-obj docutils literal"><span class="pre">False</span></code> (default), an NCName in a
context where <code class="xref py py-obj docutils literal"><span class="pre">namespace</span></code> is <code class="xref py py-obj docutils literal"><span class="pre">None</span></code> and no default or fallback
namespace can be identified produces an exception. If <code class="xref py py-obj docutils literal"><span class="pre">True</span></code>, such an
NCName is implicitly placed in no namespace.
:return: An <code class="xref py py-obj docutils literal"><span class="pre">ExpandedName</span></code> tuple: ( <code class="xref py py-obj docutils literal"><span class="pre">Namespace</span></code>, <code class="xref py py-obj docutils literal"><span class="pre">str</span></code> )
:raise pyxb.QNameResolutionError: The prefix is not in scope
:raise pyxb.QNameResolutionError: No prefix is given and the default namespace is absent</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.namespace.resolution.NamespaceContext.prefixForNamespace">
<code class="descname">prefixForNamespace</code><span class="sig-paren">(</span><em>namespace</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.resolution.NamespaceContext.prefixForNamespace" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a prefix associated with the given namespace in this
context, or None if the namespace is the default or is not in
scope.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.namespace.resolution.NamespaceContext.processXMLNS">
<code class="descname">processXMLNS</code><span class="sig-paren">(</span><em>prefix</em>, <em>uri</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.resolution.NamespaceContext.processXMLNS" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.namespace.resolution.NamespaceContext.queueForResolution">
<code class="descname">queueForResolution</code><span class="sig-paren">(</span><em>component</em>, <em>depends_on=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.resolution.NamespaceContext.queueForResolution" title="Permalink to this definition">¶</a></dt>
<dd><p>Forwards to <code class="xref py py-obj docutils literal"><span class="pre">queueForResolution()</span></code> in <a class="reference internal" href="#pyxb.namespace.resolution.NamespaceContext.targetNamespace" title="pyxb.namespace.resolution.NamespaceContext.targetNamespace"><code class="xref py py-obj docutils literal"><span class="pre">targetNamespace()</span></code></a>.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.namespace.resolution.NamespaceContext.reset">
<code class="descname">reset</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.resolution.NamespaceContext.reset" title="Permalink to this definition">¶</a></dt>
<dd><p>Reset this instance to the state it was when created, exclusive of
XMLNS directives passed in a constructor <code class="xref py py-obj docutils literal"><span class="pre">dom_node</span></code> parameter.</p>
<p>This preserves parent context and constructor-specified prefix maps,
but clears the namespace-prefix mapping of any additions made while
processing namespace directives in DOM nodes, or manually added
post-construction.</p>
<p>The defaultNamespace is also retained.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.namespace.resolution.NamespaceContext.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.namespace.resolution.NamespaceContext.setDefaultNamespace" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the default namespace for the generated document.</p>
<p>Even if invoked post construction, the default namespace will affect
the entire document, as all namespace declarations are placed in the
document root.</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_namespace</strong> – The namespace to be defined as the default</td>
</tr>
</tbody>
</table>
<p>namespace in the top-level element of the document. May be provided
as a real namespace, or just its URI.
:type default_namespace: <a class="reference internal" href="#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>.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.namespace.resolution.NamespaceContext.setNodeContext">
<code class="descname">setNodeContext</code><span class="sig-paren">(</span><em>node</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.resolution.NamespaceContext.setNodeContext" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.namespace.resolution.NamespaceContext.targetNamespace">
<code class="descname">targetNamespace</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.resolution.NamespaceContext.targetNamespace" title="Permalink to this definition">¶</a></dt>
<dd><p>The target namespace in effect at this node. Usually from the
<a class="reference internal" href="#pyxb.namespace.resolution.NamespaceContext.targetNamespace" title="pyxb.namespace.resolution.NamespaceContext.targetNamespace"><code class="xref py py-obj docutils literal"><span class="pre">targetNamespace</span></code></a> attribute. If no namespace is specified for the
schema, an absent namespace was assigned upon creation and will be
returned.</p>
</dd></dl>
</dd></dl>
<dl class="function">
<dt id="pyxb.namespace.resolution.ResolveSiblingNamespaces">
<code class="descclassname">pyxb.namespace.resolution.</code><code class="descname">ResolveSiblingNamespaces</code><span class="sig-paren">(</span><em>sibling_namespaces</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.resolution.ResolveSiblingNamespaces" title="Permalink to this definition">¶</a></dt>
<dd><p>Resolve all components in the sibling_namespaces.</p>
<p>:param sibling_namespaces : A set of namespaces expected to be closed
under dependency.</p>
</dd></dl>
<dl class="class">
<dt id="pyxb.namespace.resolution._NamespaceResolution_mixin">
<em class="property">class </em><code class="descclassname">pyxb.namespace.resolution.</code><code class="descname">_NamespaceResolution_mixin</code><span class="sig-paren">(</span><em>*args</em>, <em>**kw</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.resolution._NamespaceResolution_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>Mix-in that aggregates those aspects of XMLNamespaces relevant to
resolving component references.</p>
<dl class="attribute">
<dt id="pyxb.namespace.resolution._NamespaceResolution_mixin._NamespaceResolution_mixin__importedNamespaces">
<code class="descname">_NamespaceResolution_mixin__importedNamespaces</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.namespace.resolution._NamespaceResolution_mixin._NamespaceResolution_mixin__importedNamespaces" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.namespace.resolution._NamespaceResolution_mixin._NamespaceResolution_mixin__referencedNamespaces">
<code class="descname">_NamespaceResolution_mixin__referencedNamespaces</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.namespace.resolution._NamespaceResolution_mixin._NamespaceResolution_mixin__referencedNamespaces" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.namespace.resolution._NamespaceResolution_mixin._NamespaceResolution_mixin__unresolvedComponents">
<code class="descname">_NamespaceResolution_mixin__unresolvedComponents</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.namespace.resolution._NamespaceResolution_mixin._NamespaceResolution_mixin__unresolvedComponents" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.namespace.resolution._NamespaceResolution_mixin._NamespaceResolution_mixin__unresolvedDependents">
<code class="descname">_NamespaceResolution_mixin__unresolvedDependents</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.namespace.resolution._NamespaceResolution_mixin._NamespaceResolution_mixin__unresolvedDependents" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.namespace.resolution._NamespaceResolution_mixin._getState_csc">
<code class="descname">_getState_csc</code><span class="sig-paren">(</span><em>kw</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.resolution._NamespaceResolution_mixin._getState_csc" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.namespace.resolution._NamespaceResolution_mixin._referenceNamespace">
<code class="descname">_referenceNamespace</code><span class="sig-paren">(</span><em>namespace</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.resolution._NamespaceResolution_mixin._referenceNamespace" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.namespace.resolution._NamespaceResolution_mixin._replaceComponent_csc">
<code class="descname">_replaceComponent_csc</code><span class="sig-paren">(</span><em>existing_def</em>, <em>replacement_def</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.resolution._NamespaceResolution_mixin._replaceComponent_csc" title="Permalink to this definition">¶</a></dt>
<dd><p>Replace a component definition if present in the list of unresolved components.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.namespace.resolution._NamespaceResolution_mixin._reset">
<code class="descname">_reset</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.resolution._NamespaceResolution_mixin._reset" title="Permalink to this definition">¶</a></dt>
<dd><p>CSC extension to reset fields of a Namespace.</p>
<p>This one handles component-resolution–related data.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.namespace.resolution._NamespaceResolution_mixin._setState_csc">
<code class="descname">_setState_csc</code><span class="sig-paren">(</span><em>kw</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.resolution._NamespaceResolution_mixin._setState_csc" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.namespace.resolution._NamespaceResolution_mixin._transferReferencedNamespaces">
<code class="descname">_transferReferencedNamespaces</code><span class="sig-paren">(</span><em>module_record</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.resolution._NamespaceResolution_mixin._transferReferencedNamespaces" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.namespace.resolution._NamespaceResolution_mixin._unresolvedComponents">
<code class="descname">_unresolvedComponents</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.resolution._NamespaceResolution_mixin._unresolvedComponents" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns a reference to the list of unresolved components.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.namespace.resolution._NamespaceResolution_mixin._unresolvedDependents">
<code class="descname">_unresolvedDependents</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.resolution._NamespaceResolution_mixin._unresolvedDependents" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns a map from unresolved components to sets of components that
must be resolved first.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.namespace.resolution._NamespaceResolution_mixin.importNamespace">
<code class="descname">importNamespace</code><span class="sig-paren">(</span><em>namespace</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.resolution._NamespaceResolution_mixin.importNamespace" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.namespace.resolution._NamespaceResolution_mixin.importedNamespaces">
<code class="descname">importedNamespaces</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.resolution._NamespaceResolution_mixin.importedNamespaces" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the set of namespaces which some schema imported while
processing with this namespace as target.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.namespace.resolution._NamespaceResolution_mixin.needsResolution">
<code class="descname">needsResolution</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.resolution._NamespaceResolution_mixin.needsResolution" 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 this namespace has not been resolved.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.namespace.resolution._NamespaceResolution_mixin.queueForResolution">
<code class="descname">queueForResolution</code><span class="sig-paren">(</span><em>resolvable</em>, <em>depends_on=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.resolution._NamespaceResolution_mixin.queueForResolution" title="Permalink to this definition">¶</a></dt>
<dd><p>Invoked to note that a component may have references that will need
to be resolved.</p>
<p>Newly created named components are often unresolved, as are components
which, in the course of resolution, are found to depend on another
unresolved component.</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>resolvable</strong> – An instance of <a class="reference internal" href="#pyxb.namespace.resolution._Resolvable_mixin" title="pyxb.namespace.resolution._Resolvable_mixin"><code class="xref py py-obj docutils literal"><span class="pre">_Resolvable_mixin</span></code></a> that is later to</td>
</tr>
</tbody>
</table>
<p>be resolved.</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>depends_on</strong> – <code class="xref py py-obj docutils literal"><span class="pre">None</span></code>, or an instance of <a class="reference internal" href="#pyxb.namespace.resolution._Resolvable_mixin" title="pyxb.namespace.resolution._Resolvable_mixin"><code class="xref py py-obj docutils literal"><span class="pre">_Resolvable_mixin</span></code></a></td>
</tr>
</tbody>
</table>
<p>which <code class="xref py py-obj docutils literal"><span class="pre">resolvable</span></code> requires to be resolved in order to resolve
itself.</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">resolvable</span></code></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="pyxb.namespace.resolution._NamespaceResolution_mixin.referencedNamespaces">
<code class="descname">referencedNamespaces</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.resolution._NamespaceResolution_mixin.referencedNamespaces" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the set of namespaces which appear in namespace declarations
of schema with this namespace as target.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.namespace.resolution._NamespaceResolution_mixin.resolveDefinitions">
<code class="descname">resolveDefinitions</code><span class="sig-paren">(</span><em>allow_unresolved=False</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.resolution._NamespaceResolution_mixin.resolveDefinitions" title="Permalink to this definition">¶</a></dt>
<dd><p>Loop until all references within the associated resolvable objects
have been resolved.</p>
<p>This method iterates through all components on the unresolved list,
invoking the _resolve method of each. If the component could not be
resolved in this pass, it iis placed back on the list for the next
iteration. If an iteration completes without resolving any of the
unresolved components, a pyxb.NotInNamespaceError 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">Note:</th><td class="field-body">Do not invoke this until all top-level definitions for the</td>
</tr>
</tbody>
</table>
<p>namespace have been provided. The resolution routines are entitled to
raise a validation exception if a reference to an unrecognized
component is encountered.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="pyxb.namespace.resolution._Resolvable_mixin">
<em class="property">class </em><code class="descclassname">pyxb.namespace.resolution.</code><code class="descname">_Resolvable_mixin</code><span class="sig-paren">(</span><em>*args</em>, <em>**kw</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.resolution._Resolvable_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>Mix-in indicating that this object may have references to unseen named components.</p>
<p>This class is mixed-in to those XMLSchema components that have a reference
to another component that is identified by a QName. Resolution of that
component may need to be delayed if the definition of the component has
not yet been read.</p>
<dl class="attribute">
<dt id="pyxb.namespace.resolution._Resolvable_mixin._TraceResolution">
<code class="descname">_TraceResolution</code><em class="property"> = False</em><a class="headerlink" href="#pyxb.namespace.resolution._Resolvable_mixin._TraceResolution" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.namespace.resolution._Resolvable_mixin._queueForResolution">
<code class="descname">_queueForResolution</code><span class="sig-paren">(</span><em>why=None</em>, <em>depends_on=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.resolution._Resolvable_mixin._queueForResolution" title="Permalink to this definition">¶</a></dt>
<dd><p>Short-hand to requeue an object if the class implements _namespaceContext().</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.namespace.resolution._Resolvable_mixin._resolve">
<code class="descname">_resolve</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.resolution._Resolvable_mixin._resolve" title="Permalink to this definition">¶</a></dt>
<dd><p>Perform whatever steps are required to resolve this component.</p>
<p>Resolution is performed in the context of the namespace to which the
component belongs. Invoking this method may fail to complete the
resolution process if the component itself depends on unresolved
components. The sole caller of this should be
<a class="reference internal" href="#pyxb.namespace.resolution._NamespaceResolution_mixin.resolveDefinitions" title="pyxb.namespace.resolution._NamespaceResolution_mixin.resolveDefinitions"><code class="xref py py-obj docutils literal"><span class="pre">_NamespaceResolution_mixin.resolveDefinitions</span></code></a>.</p>
<p>This method is permitted (nay, encouraged) to raise an exception if
resolution requires interpreting a QName and the named component
cannot be found.</p>
<p>Override this in the child class. In the prefix, if <a class="reference internal" href="#pyxb.namespace.resolution._Resolvable_mixin.isResolved" title="pyxb.namespace.resolution._Resolvable_mixin.isResolved"><code class="xref py py-obj docutils literal"><span class="pre">isResolved</span></code></a> is
true, return right away. If something prevents you from completing
resolution, invoke <code class="xref py py-obj docutils literal"><span class="pre">self._queueForResolution()</span></code> (so it is retried
later) and immediately return self. Prior to leaving after successful
resolution discard any cached dom node by setting <code class="xref py py-obj docutils literal"><span class="pre">self.__domNode=None</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">Returns:</th><td class="field-body"><code class="xref py py-obj docutils literal"><span class="pre">self</span></code>, whether or not resolution succeeds.</td>
</tr>
<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><strong>pyxb.SchemaValidationError</strong> – if resolution requlres a reference to an unknown component</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="pyxb.namespace.resolution._Resolvable_mixin.isResolved">
<code class="descname">isResolved</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.resolution._Resolvable_mixin.isResolved" title="Permalink to this definition">¶</a></dt>
<dd><p>Determine whether this named component is resolved.</p>
<p>Override this in the child class.</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="module-pyxb.namespace.utility">
<span id="pyxb-namespace-utility-module"></span><h2>pyxb.namespace.utility module<a class="headerlink" href="#module-pyxb.namespace.utility" title="Permalink to this headline">¶</a></h2>
<p>Utility functions related to XML Namespaces<<a class="reference external" href="http://www.w3.org/TR/2006/REC-xml-names-20060816/index.html">http://www.w3.org/TR/2006/REC-xml-names-20060816/index.html</a>>.</p>
<dl class="function">
<dt id="pyxb.namespace.utility.AvailableNamespaces">
<code class="descclassname">pyxb.namespace.utility.</code><code class="descname">AvailableNamespaces</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.utility.AvailableNamespaces" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the complete set of Namespace instances known to the system.</p>
</dd></dl>
<dl class="function">
<dt id="pyxb.namespace.utility.CreateAbsentNamespace">
<code class="descclassname">pyxb.namespace.utility.</code><code class="descname">CreateAbsentNamespace</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.utility.CreateAbsentNamespace" title="Permalink to this definition">¶</a></dt>
<dd><p>Create an absent namespace.</p>
<p>Use this when you need a namespace for declarations in a schema with no
target namespace. Absent namespaces are not stored in the infrastructure;
it is your responsibility to hold on to the reference you get from this,
because you won’t be able to look it up.</p>
</dd></dl>
<dl class="function">
<dt id="pyxb.namespace.utility.NamespaceForURI">
<code class="descclassname">pyxb.namespace.utility.</code><code class="descname">NamespaceForURI</code><span class="sig-paren">(</span><em>uri</em>, <em>create_if_missing=False</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.utility.NamespaceForURI" title="Permalink to this definition">¶</a></dt>
<dd><p>Given a URI, provide the <code class="xref py py-obj docutils literal"><span class="pre">Namespace</span></code> instance corresponding to it.</p>
<p>This can only be used to lookup or create real namespaces. To create
absent namespaces, use <a class="reference internal" href="#pyxb.namespace.utility.CreateAbsentNamespace" title="pyxb.namespace.utility.CreateAbsentNamespace"><code class="xref py py-obj docutils literal"><span class="pre">CreateAbsentNamespace</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>uri</strong> (A non-empty <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> string) – The URI that identifies the namespace</li>
<li><strong>create_if_missing</strong> – If <code class="xref py py-obj docutils literal"><span class="pre">True</span></code>, a namespace for the given URI is</li>
</ul>
</td>
</tr>
</tbody>
</table>
<p>created if one has not already been registered. Default is <code class="xref py py-obj docutils literal"><span class="pre">False</span></code>.
:type create_if_missing: <code class="xref py py-obj docutils literal"><span class="pre">bool</span></code>
:return: The Namespace corresponding to <code class="xref py py-obj docutils literal"><span class="pre">uri</span></code>, if available
:rtype: <code class="xref py py-obj docutils literal"><span class="pre">Namespace</span></code> or <code class="xref py py-obj docutils literal"><span class="pre">None</span></code>
:raise pyxb.LogicError: The uri is not a non-empty string</p>
</dd></dl>
<dl class="function">
<dt id="pyxb.namespace.utility.NamespaceInstance">
<code class="descclassname">pyxb.namespace.utility.</code><code class="descname">NamespaceInstance</code><span class="sig-paren">(</span><em>namespace</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.utility.NamespaceInstance" title="Permalink to this definition">¶</a></dt>
<dd><p>Get a namespace instance for the given namespace.</p>
<p>This is used when it is unclear whether the namespace is specified by URI
or by instance or by any other mechanism we might dream up in the
future.</p>
</dd></dl>
</div>
<div class="section" id="module-pyxb.namespace">
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-pyxb.namespace" title="Permalink to this headline">¶</a></h2>
<p>Classes and global objects related to XML Namespaces<<a class="reference external" href="http://www.w3.org/TR/2006/REC-xml-names-20060816/index.html">http://www.w3.org/TR/2006/REC-xml-names-20060816/index.html</a>>.</p>
<p>Since namespaces hold all referenceable objects, this module also defines the
infrastructure for resolving named object references, such as schema
components.</p>
<dl class="class">
<dt id="pyxb.namespace.ExpandedName">
<em class="property">class </em><code class="descclassname">pyxb.namespace.</code><code class="descname">ExpandedName</code><span class="sig-paren">(</span><em>*args</em>, <em>**kw</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.ExpandedName" 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>Represent an U{expanded name
<<a class="reference external" href="http://www.w3.org/TR/REC-xml-names/#dt-expname">http://www.w3.org/TR/REC-xml-names/#dt-expname</a>>}, which pairs a
namespace with a local name.</p>
<p>Because a large number of local elements, and most attributes, have no
namespace associated with them, this is optimized for representing names
with an absent namespace. The hash and equality test methods are set so
that a plain string is equivalent to a tuple of <code class="xref py py-obj docutils literal"><span class="pre">None</span></code> and that string.</p>
<p>Note that absent namespaces can be represented in two ways: with a
namespace of <code class="xref py py-obj docutils literal"><span class="pre">None</span></code> (the name “has no namespace”), and with a namespace
that is an <a class="reference internal" href="#pyxb.namespace.Namespace.CreateAbsentNamespace" title="pyxb.namespace.Namespace.CreateAbsentNamespace"><code class="xref py py-obj docutils literal"><span class="pre">absent</span> <span class="pre">namespace</span></code></a> (the name
“has an absent namespace”). Hash code calculations are done so that the
two alternatives produce the same hash; however, comparison is done so
that the two are distinguished. The latter is the intended behavior; the
former should not be counted upon.</p>
<p>This class allows direct lookup of the named object within a category by
using the category name as an accessor function. That is, if the
namespace of the expanded name <code class="xref py py-obj docutils literal"><span class="pre">en</span></code> has a category ‘typeDefinition’, then
the following two expressions are equivalent:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">en</span><span class="o">.</span><span class="n">typeDefinition</span><span class="p">()</span>
<span class="n">en</span><span class="o">.</span><span class="n">namespace</span><span class="p">()</span><span class="o">.</span><span class="n">categoryMap</span><span class="p">(</span><span class="s1">'typeDefinition'</span><span class="p">)</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">en</span><span class="o">.</span><span class="n">localName</span><span class="p">())</span>
</pre></div>
</div>
<p>This class descends from <code class="xref py py-obj docutils literal"><span class="pre">tuple</span></code> so that its values can be used as
dictionary keys without concern for pointer equivalence.</p>
<dl class="attribute">
<dt id="pyxb.namespace.ExpandedName._ExpandedName__expandedName">
<code class="descname">_ExpandedName__expandedName</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.namespace.ExpandedName._ExpandedName__expandedName" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.namespace.ExpandedName._ExpandedName__localName">
<code class="descname">_ExpandedName__localName</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.namespace.ExpandedName._ExpandedName__localName" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.namespace.ExpandedName._ExpandedName__namespace">
<code class="descname">_ExpandedName__namespace</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.namespace.ExpandedName._ExpandedName__namespace" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.namespace.ExpandedName._ExpandedName__namespaceURI">
<code class="descname">_ExpandedName__namespaceURI</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.namespace.ExpandedName._ExpandedName__namespaceURI" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.namespace.ExpandedName._ExpandedName__otherForCompare">
<code class="descname">_ExpandedName__otherForCompare</code><span class="sig-paren">(</span><em>other</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.ExpandedName._ExpandedName__otherForCompare" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.namespace.ExpandedName.adoptName">
<code class="descname">adoptName</code><span class="sig-paren">(</span><em>name</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.ExpandedName.adoptName" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the input name, except if the input name has no namespace,
return a name that uses the namespace from this name with the local
name from the input name.</p>
<p>Use this when the XML document has an unqualified name and we’re
processing using an absent default 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">Warning:</th><td class="field-body">Be careful when using a global name to adopt a name from a</td>
</tr>
</tbody>
</table>
<p>local element: if the local element (with no namespace) has the same
localName as but is different from the global element (with a
namespace), this will improperly provide a namespace when one should
not be present. See the comments in
<a class="reference internal" href="pyxb.binding.html#pyxb.binding.basis.element.elementForName" title="pyxb.binding.basis.element.elementForName"><code class="xref py py-obj docutils literal"><span class="pre">pyxb.binding.basis.element.elementForName</span></code></a>.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.namespace.ExpandedName.createName">
<code class="descname">createName</code><span class="sig-paren">(</span><em>local_name</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.ExpandedName.createName" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a new expanded name in the namespace of this name.</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>local_name</strong> – The local name portion of an expanded name.</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">An instance of <a class="reference internal" href="#pyxb.namespace.ExpandedName" title="pyxb.namespace.ExpandedName"><code class="xref py py-obj docutils literal"><span class="pre">ExpandedName</span></code></a>.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="pyxb.namespace.ExpandedName.getAttribute">
<code class="descname">getAttribute</code><span class="sig-paren">(</span><em>dom_node</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.ExpandedName.getAttribute" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the value of the attribute identified by this name in the given 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">Returns:</th><td class="field-body">An instance of <code class="xref py py-obj docutils literal"><span class="pre">xml.dom.Attr</span></code>, or <code class="xref py py-obj docutils literal"><span class="pre">None</span></code> if the node does</td>
</tr>
</tbody>
</table>
<p>not have an attribute with this name.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.namespace.ExpandedName.localName">
<code class="descname">localName</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.ExpandedName.localName" title="Permalink to this definition">¶</a></dt>
<dd><p>The local part of the expanded name.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.namespace.ExpandedName.namespace">
<code class="descname">namespace</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.ExpandedName.namespace" title="Permalink to this definition">¶</a></dt>
<dd><p>The <a class="reference internal" href="#pyxb.namespace.Namespace" title="pyxb.namespace.Namespace"><code class="xref py py-obj docutils literal"><span class="pre">Namespace</span></code></a> part of the expanded name.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.namespace.ExpandedName.namespaceURI">
<code class="descname">namespaceURI</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.ExpandedName.namespaceURI" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the URI of the namespace, or <code class="xref py py-obj docutils literal"><span class="pre">None</span></code> if the namespace is absent.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.namespace.ExpandedName.nodeMatches">
<code class="descname">nodeMatches</code><span class="sig-paren">(</span><em>dom_node</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.ExpandedName.nodeMatches" 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 dom node expanded name matches this expanded name.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.namespace.ExpandedName.uriTuple">
<code class="descname">uriTuple</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.ExpandedName.uriTuple" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a tuple consisting of the namespace URI and the local name.</p>
<p>This presents the expanded name as base Python types for persistent
storage. Be aware, though, that it will lose the association of the
name with an absent namespace, if that matters to you.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.namespace.ExpandedName.validateComponentModel">
<code class="descname">validateComponentModel</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.ExpandedName.validateComponentModel" title="Permalink to this definition">¶</a></dt>
<dd><p>Pass model validation through to namespace part.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="pyxb.namespace.NamedObjectMap">
<em class="property">class </em><code class="descclassname">pyxb.namespace.</code><code class="descname">NamedObjectMap</code><span class="sig-paren">(</span><em>category</em>, <em>namespace</em>, <em>*args</em>, <em>**kw</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.NamedObjectMap" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">dict</span></code></p>
<p>An extended dictionary intended to assist with QName resolution.</p>
<p>These dictionaries have an attribute that identifies a category of named
objects within a Namespace; the specifications for various documents
require that certain groups of objects must be unique, while uniqueness is
not required between groups. The dictionary also retains a pointer to the
Namespace instance for which it holds objects.</p>
<dl class="attribute">
<dt id="pyxb.namespace.NamedObjectMap._NamedObjectMap__category">
<code class="descname">_NamedObjectMap__category</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.namespace.NamedObjectMap._NamedObjectMap__category" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.namespace.NamedObjectMap._NamedObjectMap__namespace">
<code class="descname">_NamedObjectMap__namespace</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.namespace.NamedObjectMap._NamedObjectMap__namespace" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.namespace.NamedObjectMap.category">
<code class="descname">category</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.NamedObjectMap.category" title="Permalink to this definition">¶</a></dt>
<dd><p>The category of objects (e.g., typeDefinition, elementDeclaration).</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.namespace.NamedObjectMap.namespace">
<code class="descname">namespace</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.NamedObjectMap.namespace" title="Permalink to this definition">¶</a></dt>
<dd><p>The namespace to which the object map belongs.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="pyxb.namespace.Namespace">
<em class="property">class </em><code class="descclassname">pyxb.namespace.</code><code class="descname">Namespace</code><span class="sig-paren">(</span><em>uri</em>, <em>description=None</em>, <em>builtin_namespace=None</em>, <em>builtin_module_path=None</em>, <em>is_undeclared_namespace=False</em>, <em>is_loaded_namespace=False</em>, <em>bound_prefix=None</em>, <em>default_namespace=None</em>, <em>in_scope_namespaces=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.Namespace" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#pyxb.namespace._NamespaceCategory_mixin" title="pyxb.namespace._NamespaceCategory_mixin"><code class="xref py py-class docutils literal"><span class="pre">pyxb.namespace._NamespaceCategory_mixin</span></code></a>, <a class="reference internal" href="#pyxb.namespace.resolution._NamespaceResolution_mixin" title="pyxb.namespace.resolution._NamespaceResolution_mixin"><code class="xref py py-class docutils literal"><span class="pre">pyxb.namespace.resolution._NamespaceResolution_mixin</span></code></a>, <a class="reference internal" href="#pyxb.namespace._NamespaceComponentAssociation_mixin" title="pyxb.namespace._NamespaceComponentAssociation_mixin"><code class="xref py py-class docutils literal"><span class="pre">pyxb.namespace._NamespaceComponentAssociation_mixin</span></code></a>, <a class="reference internal" href="#pyxb.namespace.archive._NamespaceArchivable_mixin" title="pyxb.namespace.archive._NamespaceArchivable_mixin"><code class="xref py py-class docutils literal"><span class="pre">pyxb.namespace.archive._NamespaceArchivable_mixin</span></code></a></p>
<p>Represents an XML namespace (a URI).</p>
<p>There is at most one <a class="reference internal" href="#pyxb.namespace.Namespace" title="pyxb.namespace.Namespace"><code class="xref py py-obj docutils literal"><span class="pre">Namespace</span></code></a> class instance per namespace (URI). The
instance also supports associating arbitrary <a class="reference internal" href="#pyxb.namespace.NamedObjectMap" title="pyxb.namespace.NamedObjectMap"><code class="xref py py-obj docutils literal"><span class="pre">maps</span></code></a> from
names to objects, in separate categories. The default categories are
configured externally; for example, the
<a class="reference internal" href="pyxb.xmlschema.html#pyxb.xmlschema.structures.Schema" title="pyxb.xmlschema.structures.Schema"><code class="xref py py-obj docutils literal"><span class="pre">Schema</span></code></a> component defines a category
for each named component in XMLSchema, and the customizing subclass for
WSDL definitions adds categories for the service bindings, messages, etc.</p>
<p>Namespaces can be written to and loaded from pickled files. See
<code class="xref py py-obj docutils literal"><span class="pre">NamespaceArchive</span></code> for information.</p>
<dl class="classmethod">
<dt id="pyxb.namespace.Namespace.AvailableNamespaces">
<em class="property">classmethod </em><code class="descname">AvailableNamespaces</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.Namespace.AvailableNamespaces" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a set of all Namespace instances defined so far.</p>
</dd></dl>
<dl class="classmethod">
<dt id="pyxb.namespace.Namespace.CreateAbsentNamespace">
<em class="property">classmethod </em><code class="descname">CreateAbsentNamespace</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.Namespace.CreateAbsentNamespace" title="Permalink to this definition">¶</a></dt>
<dd><p>Create an absent namespace.</p>
<p>Use this instead of the standard constructor, in case we need
to augment it with a uuid or the like.</p>
</dd></dl>
<dl class="classmethod">
<dt id="pyxb.namespace.Namespace._NamespaceForURI">
<em class="property">classmethod </em><code class="descname">_NamespaceForURI</code><span class="sig-paren">(</span><em>uri</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.Namespace._NamespaceForURI" title="Permalink to this definition">¶</a></dt>
<dd><p>If a Namespace instance for the given URI exists, return it; otherwise return None.</p>
<p>Note: Absent namespaces are not stored in the registry. If you use
one (e.g., for a schema with no target namespace), don’t lose hold of
it.</p>
</dd></dl>
<dl class="attribute">
<dt id="pyxb.namespace.Namespace._Namespace__AbsentNamespaceRegistry">
<code class="descname">_Namespace__AbsentNamespaceRegistry</code><em class="property"> = {}</em><a class="headerlink" href="#pyxb.namespace.Namespace._Namespace__AbsentNamespaceRegistry" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.namespace.Namespace._Namespace__AbsentNamespaces">
<code class="descname">_Namespace__AbsentNamespaces</code><em class="property"> = set([])</em><a class="headerlink" href="#pyxb.namespace.Namespace._Namespace__AbsentNamespaces" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.namespace.Namespace._Namespace__Registry">
<code class="descname">_Namespace__Registry</code><em class="property"> = {'http://www.w3.org/1999/xhtml': <pyxb.namespace.Namespace object>, 'http://www.w3.org/2000/xmlns/': <pyxb.namespace.Namespace object>, 'http://www.w3.org/2001/XMLSchema': <pyxb.namespace.builtin._XMLSchema object>, 'http://www.w3.org/2001/XMLSchema-instance': <pyxb.namespace.builtin._XMLSchema_instance object>, 'http://www.w3.org/2001/XMLSchema-hasFacetAndProperty': <pyxb.namespace.Namespace object>, 'http://www.w3.org/XML/1998/namespace': <pyxb.namespace.builtin._XML object>}</em><a class="headerlink" href="#pyxb.namespace.Namespace._Namespace__Registry" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.namespace.Namespace._Namespace__SerializedVariantAbsent">
<code class="descname">_Namespace__SerializedVariantAbsent</code><em class="property"> = 'absent'</em><a class="headerlink" href="#pyxb.namespace.Namespace._Namespace__SerializedVariantAbsent" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.namespace.Namespace._Namespace__absentNamespaceID">
<code class="descname">_Namespace__absentNamespaceID</code><em class="property"> = 0</em><a class="headerlink" href="#pyxb.namespace.Namespace._Namespace__absentNamespaceID" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.namespace.Namespace._Namespace__absentSerializedUUID">
<code class="descname">_Namespace__absentSerializedUUID</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.namespace.Namespace._Namespace__absentSerializedUUID" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.namespace.Namespace._Namespace__bindingConfiguration">
<code class="descname">_Namespace__bindingConfiguration</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.namespace.Namespace._Namespace__bindingConfiguration" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.namespace.Namespace._Namespace__boundPrefix">
<code class="descname">_Namespace__boundPrefix</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.namespace.Namespace._Namespace__boundPrefix" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.namespace.Namespace._Namespace__builtinModulePath">
<code class="descname">_Namespace__builtinModulePath</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.namespace.Namespace._Namespace__builtinModulePath" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.namespace.Namespace._Namespace__contextDefaultNamespace">
<code class="descname">_Namespace__contextDefaultNamespace</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.namespace.Namespace._Namespace__contextDefaultNamespace" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.namespace.Namespace._Namespace__contextInScopeNamespaces">
<code class="descname">_Namespace__contextInScopeNamespaces</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.namespace.Namespace._Namespace__contextInScopeNamespaces" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.namespace.Namespace._Namespace__definedBuiltins">
<code class="descname">_Namespace__definedBuiltins</code><em class="property"> = False</em><a class="headerlink" href="#pyxb.namespace.Namespace._Namespace__definedBuiltins" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.namespace.Namespace._Namespace__description">
<code class="descname">_Namespace__description</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.namespace.Namespace._Namespace__description" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.namespace.Namespace._Namespace__didValidation">
<code class="descname">_Namespace__didValidation</code><em class="property"> = False</em><a class="headerlink" href="#pyxb.namespace.Namespace._Namespace__didValidation" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.namespace.Namespace._Namespace__hasBeenArchived">
<code class="descname">_Namespace__hasBeenArchived</code><em class="property"> = False</em><a class="headerlink" href="#pyxb.namespace.Namespace._Namespace__hasBeenArchived" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.namespace.Namespace._Namespace__identifyNamespace">
<code class="descname">_Namespace__identifyNamespace</code><span class="sig-paren">(</span><em>nsval</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.Namespace._Namespace__identifyNamespace" title="Permalink to this definition">¶</a></dt>
<dd><p>Identify the specified namespace, which should be a built-in.</p>
<p>Normally we can just use a reference to the Namespace module instance,
but when creating those instances we sometimes need to refer to ones
for which the instance has not yet been created. In that case, we use
the name of the instance, and resolve the namespace when we need to
create the initial context.</p>
</dd></dl>
<dl class="attribute">
<dt id="pyxb.namespace.Namespace._Namespace__inValidation">
<code class="descname">_Namespace__inValidation</code><em class="property"> = False</em><a class="headerlink" href="#pyxb.namespace.Namespace._Namespace__inValidation" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.namespace.Namespace._Namespace__initialNamespaceContext">
<code class="descname">_Namespace__initialNamespaceContext</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.namespace.Namespace._Namespace__initialNamespaceContext" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.namespace.Namespace._Namespace__isBuiltinNamespace">
<code class="descname">_Namespace__isBuiltinNamespace</code><em class="property"> = False</em><a class="headerlink" href="#pyxb.namespace.Namespace._Namespace__isBuiltinNamespace" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.namespace.Namespace._Namespace__isLoadedNamespace">
<code class="descname">_Namespace__isLoadedNamespace</code><em class="property"> = False</em><a class="headerlink" href="#pyxb.namespace.Namespace._Namespace__isLoadedNamespace" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.namespace.Namespace._Namespace__isUndeclaredNamespace">
<code class="descname">_Namespace__isUndeclaredNamespace</code><em class="property"> = False</em><a class="headerlink" href="#pyxb.namespace.Namespace._Namespace__isUndeclaredNamespace" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.namespace.Namespace._Namespace__namespaceArchive">
<code class="descname">_Namespace__namespaceArchive</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.namespace.Namespace._Namespace__namespaceArchive" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.namespace.Namespace._Namespace__prefix">
<code class="descname">_Namespace__prefix</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.namespace.Namespace._Namespace__prefix" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.namespace.Namespace._Namespace__uri">
<code class="descname">_Namespace__uri</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.namespace.Namespace._Namespace__uri" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.namespace.Namespace._defineBuiltins">
<code class="descname">_defineBuiltins</code><span class="sig-paren">(</span><em>structures_module</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.Namespace._defineBuiltins" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.namespace.Namespace._defineBuiltins_ox">
<code class="descname">_defineBuiltins_ox</code><span class="sig-paren">(</span><em>structures_module</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.Namespace._defineBuiltins_ox" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.namespace.Namespace._loadComponentsFromArchives">
<code class="descname">_loadComponentsFromArchives</code><span class="sig-paren">(</span><em>structures_module</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.Namespace._loadComponentsFromArchives" title="Permalink to this definition">¶</a></dt>
<dd><p>Attempts to load the named objects held in this namespace.</p>
<p>The base class implementation looks at the set of available archived
namespaces, and if one contains this namespace unserializes its named
object maps.</p>
<p>Sub-classes may choose to look elsewhere, if this version fails or
before attempting it.</p>
<p>There is no guarantee that any particular category of named object has
been located when this returns. Caller must check.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.namespace.Namespace._overrideAbsentNamespace">
<code class="descname">_overrideAbsentNamespace</code><span class="sig-paren">(</span><em>uri</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.Namespace._overrideAbsentNamespace" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.namespace.Namespace._replaceComponent">
<code class="descname">_replaceComponent</code><span class="sig-paren">(</span><em>existing_def</em>, <em>replacement_def</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.Namespace._replaceComponent" title="Permalink to this definition">¶</a></dt>
<dd><p>Replace the existing definition with another.</p>
<p>This is used in a situation where building the component model
resulted in a new component instance being created and registered, but
for which an existing component is to be preferred. An example is
when parsing the schema for XMLSchema itself: the built-in datatype
components should be retained instead of the simple type definition
components dynamically created from the schema.</p>
<p>By providing the value <code class="xref py py-obj docutils literal"><span class="pre">None</span></code> as the replacement definition, this can
also be used to remove components.</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">Invoking this requires scans of every item in every category</td>
</tr>
</tbody>
</table>
<p>map in the 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">Returns:</th><td class="field-body"><code class="xref py py-obj docutils literal"><span class="pre">replacement_def</span></code></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="pyxb.namespace.Namespace._reset">
<code class="descname">_reset</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.Namespace._reset" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.namespace.Namespace.boundPrefix">
<code class="descname">boundPrefix</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.Namespace.boundPrefix" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the standard prefix to be used for this namespace.</p>
<p>Only a few namespace prefixes are bound to namespaces: xml and xmlns
are two. In all other cases, this method should return None. The
infrastructure attempts to prevent user creation of Namespace
instances that have bound prefixes.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.namespace.Namespace.builtinModulePath">
<code class="descname">builtinModulePath</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.Namespace.builtinModulePath" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.namespace.Namespace.builtinNamespaceRepresentation">
<code class="descname">builtinNamespaceRepresentation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.Namespace.builtinNamespaceRepresentation" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.namespace.Namespace.createExpandedName">
<code class="descname">createExpandedName</code><span class="sig-paren">(</span><em>local_name</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.Namespace.createExpandedName" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.namespace.Namespace.description">
<code class="descname">description</code><span class="sig-paren">(</span><em>description=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.Namespace.description" title="Permalink to this definition">¶</a></dt>
<dd><p>Get, or set, a textual description of the namespace.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.namespace.Namespace.fallbackNamespace">
<code class="descname">fallbackNamespace</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.Namespace.fallbackNamespace" title="Permalink to this definition">¶</a></dt>
<dd><p>When known to be operating in this namespace, provide the Namespace
instance to be used when names are associated with no namespace.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.namespace.Namespace.hasBeenArchived">
<code class="descname">hasBeenArchived</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.Namespace.hasBeenArchived" 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 this namespace has been saved to a namespace archive.
See also <a class="reference internal" href="#pyxb.namespace.Namespace.isLoadedNamespace" title="pyxb.namespace.Namespace.isLoadedNamespace"><code class="xref py py-obj docutils literal"><span class="pre">isLoadedNamespace</span></code></a>.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.namespace.Namespace.initialNamespaceContext">
<code class="descname">initialNamespaceContext</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.Namespace.initialNamespaceContext" title="Permalink to this definition">¶</a></dt>
<dd><p>Obtain the namespace context to be used when creating components in this namespace.</p>
<p>Usually applies only to built-in namespaces, but is also used in the
autotests when creating a namespace without a xs:schema element. .
Note that we must create the instance dynamically, since the
information that goes into it has cross-dependencies that can’t be
resolved until this module has been completely loaded.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.namespace.Namespace.isAbsentNamespace">
<code class="descname">isAbsentNamespace</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.Namespace.isAbsentNamespace" title="Permalink to this definition">¶</a></dt>
<dd><p>Return True iff this namespace is an absent namespace.</p>
<p>Absent namespaces have no namespace URI; they exist only to
hold components created from schemas with no target
namespace.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.namespace.Namespace.isBuiltinNamespace">
<code class="descname">isBuiltinNamespace</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.Namespace.isBuiltinNamespace" title="Permalink to this definition">¶</a></dt>
<dd><p>Return True iff this namespace was defined by the infrastructure.</p>
<p>That is the case for all namespaces in the Namespace module.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.namespace.Namespace.isLoadedNamespace">
<code class="descname">isLoadedNamespace</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.Namespace.isLoadedNamespace" 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 this namespace was loaded from a namespace archive.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.namespace.Namespace.isUndeclaredNamespace">
<code class="descname">isUndeclaredNamespace</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.Namespace.isUndeclaredNamespace" title="Permalink to this definition">¶</a></dt>
<dd><p>Return True iff this namespace is always available
regardless of whether there is a declaration for it.</p>
<p>This is the case only for the
xml(<a class="reference external" href="http://www.w3.org/XML/1998/namespace">http://www.w3.org/XML/1998/namespace</a>) and
xmlns(<a class="reference external" href="http://www.w3.org/2000/xmlns/">http://www.w3.org/2000/xmlns/</a>) namespaces.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.namespace.Namespace.nodeIsNamed">
<code class="descname">nodeIsNamed</code><span class="sig-paren">(</span><em>node</em>, <em>*local_names</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.Namespace.nodeIsNamed" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.namespace.Namespace.prefix">
<code class="descname">prefix</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.Namespace.prefix" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.namespace.Namespace.setPrefix">
<code class="descname">setPrefix</code><span class="sig-paren">(</span><em>prefix</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.Namespace.setPrefix" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.namespace.Namespace.uri">
<code class="descname">uri</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.Namespace.uri" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the URI for the namespace represented by this instance.</p>
<p>If the URI is None, this is an absent namespace, used to hold
declarations not associated with a namespace (e.g., from schema with
no target namespace).</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.namespace.Namespace.validateComponentModel">
<code class="descname">validateComponentModel</code><span class="sig-paren">(</span><em>structures_module=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace.Namespace.validateComponentModel" title="Permalink to this definition">¶</a></dt>
<dd><p>Ensure this namespace is ready for use.</p>
<p>If the namespace does not have a map of named objects, the system will
attempt to load one.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="pyxb.namespace._ComponentDependency_mixin">
<em class="property">class </em><code class="descclassname">pyxb.namespace.</code><code class="descname">_ComponentDependency_mixin</code><span class="sig-paren">(</span><em>*args</em>, <em>**kw</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace._ComponentDependency_mixin" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="pyxb.utils.html#pyxb.utils.utility.PrivateTransient_mixin" title="pyxb.utils.utility.PrivateTransient_mixin"><code class="xref py py-class docutils literal"><span class="pre">pyxb.utils.utility.PrivateTransient_mixin</span></code></a>, <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>Mix-in for components that can depend on other components.</p>
<dl class="attribute">
<dt id="pyxb.namespace._ComponentDependency_mixin._ComponentDependency_mixin__PrivateTransient">
<code class="descname">_ComponentDependency_mixin__PrivateTransient</code><em class="property"> = set(['bindingRequires'])</em><a class="headerlink" href="#pyxb.namespace._ComponentDependency_mixin._ComponentDependency_mixin__PrivateTransient" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.namespace._ComponentDependency_mixin._ComponentDependency_mixin__bindingRequires">
<code class="descname">_ComponentDependency_mixin__bindingRequires</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.namespace._ComponentDependency_mixin._ComponentDependency_mixin__bindingRequires" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.namespace._ComponentDependency_mixin._bindingRequires_vx">
<code class="descname">_bindingRequires_vx</code><span class="sig-paren">(</span><em>include_lax</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace._ComponentDependency_mixin._bindingRequires_vx" title="Permalink to this definition">¶</a></dt>
<dd><p>Placeholder for subclass method that identifies the necessary components.</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">Override in subclasses.</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The component instances on which this component depends</td>
</tr>
<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">frozenset</span></code></td>
</tr>
<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><a class="reference internal" href="pyxb.html#pyxb.exceptions_.LogicError" title="pyxb.exceptions_.LogicError"><strong>LogicError</strong></a> – A subclass failed to implement this method</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="pyxb.namespace._ComponentDependency_mixin._resetClone_csc">
<code class="descname">_resetClone_csc</code><span class="sig-paren">(</span><em>**kw</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace._ComponentDependency_mixin._resetClone_csc" title="Permalink to this definition">¶</a></dt>
<dd><p>CSC extension to reset fields of a component. This one clears
dependency-related data, since the clone will have to revise its
dependencies.
:rtype: <code class="xref py py-obj docutils literal"><span class="pre">None</span></code></p>
</dd></dl>
<dl class="method">
<dt id="pyxb.namespace._ComponentDependency_mixin.bindingRequires">
<code class="descname">bindingRequires</code><span class="sig-paren">(</span><em>reset=False</em>, <em>include_lax=False</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace._ComponentDependency_mixin.bindingRequires" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a set of components upon whose bindings this component’s
bindings depend.</p>
<p>For example, bindings that are extensions or restrictions depend on
their base types. Complex type definition bindings require that the
types of their attribute declarations be available at the class
definition, and the types of their element declarations in the
postscript.</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>include_lax</strong> – if <code class="xref py py-obj docutils literal"><span class="pre">False</span></code> (default), only the requirements of</td>
</tr>
</tbody>
</table>
<p>the class itself are returned. If <code class="xref py py-obj docutils literal"><span class="pre">True</span></code>, all requirements are
returned.
:rtype: <code class="xref py py-obj docutils literal"><span class="pre">set(L{pyxb.xmlschema.structures._SchemaComponent_mixin</span></code>)}</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="pyxb.namespace._NamespaceCategory_mixin">
<em class="property">class </em><code class="descclassname">pyxb.namespace.</code><code class="descname">_NamespaceCategory_mixin</code><span class="sig-paren">(</span><em>*args</em>, <em>**kw</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace._NamespaceCategory_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>Mix-in that aggregates those aspects of XMLNamespaces that hold
references to categories of named objects.</p>
<p>Arbitrary groups of named objects, each requiring unique names within
themselves, can be saved. Unless configured otherwise, the Namespace
instance is extended with accessors that provide direct access to
individual category maps. The name of the method is the category name
with a suffix of “s”; e.g., if a category “typeDefinition” exists, it can
be accessed from the namespace using the syntax <code class="xref py py-obj docutils literal"><span class="pre">ns.typeDefinitions()</span></code>.</p>
<p>Note that the returned value from the accessor is a live reference to
the category map; changes made to the map are reflected in the
namespace.</p>
<dl class="attribute">
<dt id="pyxb.namespace._NamespaceCategory_mixin._NamespaceCategory_mixin__categoryMap">
<code class="descname">_NamespaceCategory_mixin__categoryMap</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.namespace._NamespaceCategory_mixin._NamespaceCategory_mixin__categoryMap" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.namespace._NamespaceCategory_mixin._NamespaceCategory_mixin__checkCategoriesEmpty">
<code class="descname">_NamespaceCategory_mixin__checkCategoriesEmpty</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace._NamespaceCategory_mixin._NamespaceCategory_mixin__checkCategoriesEmpty" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.namespace._NamespaceCategory_mixin._NamespaceCategory_mixin__defineCategoryAccessors">
<code class="descname">_NamespaceCategory_mixin__defineCategoryAccessors</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace._NamespaceCategory_mixin._NamespaceCategory_mixin__defineCategoryAccessors" title="Permalink to this definition">¶</a></dt>
<dd><p>Define public methods on the Namespace which provide access to
individual NamedObjectMaps based on their category.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.namespace._NamespaceCategory_mixin._associateOrigins">
<code class="descname">_associateOrigins</code><span class="sig-paren">(</span><em>module_record</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace._NamespaceCategory_mixin._associateOrigins" title="Permalink to this definition">¶</a></dt>
<dd><p>Add links from <a class="reference internal" href="#pyxb.namespace.archive._ObjectOrigin" title="pyxb.namespace.archive._ObjectOrigin"><code class="xref py py-obj docutils literal"><span class="pre">pyxb.namespace.archive._ObjectOrigin</span></code></a> instances.</p>
<p>For any resolvable item in this namespace from an origin managed by
the module_record, ensure that item can be found via a lookup through
that origin.</p>
<p>This allows these items to be found when a single namespace comprises
items translated from different schema at different times using
archives to maintain consistency.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.namespace._NamespaceCategory_mixin._categoryMap">
<code class="descname">_categoryMap</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace._NamespaceCategory_mixin._categoryMap" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the whole map from categories to named objects.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.namespace._NamespaceCategory_mixin._loadNamedObjects">
<code class="descname">_loadNamedObjects</code><span class="sig-paren">(</span><em>category_map</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace._NamespaceCategory_mixin._loadNamedObjects" title="Permalink to this definition">¶</a></dt>
<dd><p>Add the named objects from the given map into the set held by this namespace.
It is an error to name something which is already present.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.namespace._NamespaceCategory_mixin._namedObjects">
<code class="descname">_namedObjects</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace._NamespaceCategory_mixin._namedObjects" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.namespace._NamespaceCategory_mixin._replaceComponent_csc">
<code class="descname">_replaceComponent_csc</code><span class="sig-paren">(</span><em>existing_def</em>, <em>replacement_def</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace._NamespaceCategory_mixin._replaceComponent_csc" title="Permalink to this definition">¶</a></dt>
<dd><p>Replace a component definition where present in the category maps.</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">This is a high-cost operation, as every item in every category</td>
</tr>
</tbody>
</table>
<p>map must be examined to see whether its value field matches
<code class="xref py py-obj docutils literal"><span class="pre">existing_def</span></code>.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.namespace._NamespaceCategory_mixin._reset">
<code class="descname">_reset</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace._NamespaceCategory_mixin._reset" title="Permalink to this definition">¶</a></dt>
<dd><p>CSC extension to reset fields of a Namespace.</p>
<p>This one handles category-related data.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.namespace._NamespaceCategory_mixin.addCategoryObject">
<code class="descname">addCategoryObject</code><span class="sig-paren">(</span><em>category</em>, <em>local_name</em>, <em>named_object</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace._NamespaceCategory_mixin.addCategoryObject" title="Permalink to this definition">¶</a></dt>
<dd><p>Allow access to the named_object by looking up the local_name in
the given category.</p>
<p>Raises pyxb.NamespaceUniquenessError if an object with the same name
already exists in the category.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.namespace._NamespaceCategory_mixin.categories">
<code class="descname">categories</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace._NamespaceCategory_mixin.categories" title="Permalink to this definition">¶</a></dt>
<dd><p>The list of individual categories held in this namespace.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.namespace._NamespaceCategory_mixin.categoryMap">
<code class="descname">categoryMap</code><span class="sig-paren">(</span><em>category</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace._NamespaceCategory_mixin.categoryMap" title="Permalink to this definition">¶</a></dt>
<dd><p>Map from local names to NamedObjectMap instances for the given category.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.namespace._NamespaceCategory_mixin.configureCategories">
<code class="descname">configureCategories</code><span class="sig-paren">(</span><em>categories</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace._NamespaceCategory_mixin.configureCategories" title="Permalink to this definition">¶</a></dt>
<dd><p>Ensure there is a map for each of the given categories.</p>
<p>Category configuration
<a class="reference internal" href="#pyxb.namespace.archive._NamespaceArchivable_mixin.isActive" title="pyxb.namespace.archive._NamespaceArchivable_mixin.isActive"><code class="xref py py-obj docutils literal"><span class="pre">activates</span></code></a> a namespace.</p>
<p>Existing maps are not affected.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.namespace._NamespaceCategory_mixin.hasSchemaComponents">
<code class="descname">hasSchemaComponents</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace._NamespaceCategory_mixin.hasSchemaComponents" 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 schema components have been associated with this namespace.</p>
<p>This only checks whether the corresponding categories have been added,
not whether there are any entries in those categories. It is useful
for identifying namespaces that were incorporated through a
declaration but never actually referenced.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.namespace._NamespaceCategory_mixin.replaceCategoryObject">
<code class="descname">replaceCategoryObject</code><span class="sig-paren">(</span><em>category</em>, <em>local_name</em>, <em>old_object</em>, <em>new_object</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace._NamespaceCategory_mixin.replaceCategoryObject" title="Permalink to this definition">¶</a></dt>
<dd><p>Replace the referenced object in the category.</p>
<p>The new object will be added only if the old_object matches the
current entry for local_name in the category.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="pyxb.namespace._NamespaceComponentAssociation_mixin">
<em class="property">class </em><code class="descclassname">pyxb.namespace.</code><code class="descname">_NamespaceComponentAssociation_mixin</code><span class="sig-paren">(</span><em>*args</em>, <em>**kw</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace._NamespaceComponentAssociation_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>Mix-in for managing components defined within this namespace.</p>
<p>The component set includes not only top-level named components (such as
those accessible through category maps), but internal anonymous
components, such as those involved in representing the content model of a
complex type definition. We need to be able to get a list of these
components, sorted in dependency order, so that generated bindings do not
attempt to refer to a binding that has not yet been generated.</p>
<dl class="attribute">
<dt id="pyxb.namespace._NamespaceComponentAssociation_mixin._NamespaceComponentAssociation_mixin__components">
<code class="descname">_NamespaceComponentAssociation_mixin__components</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.namespace._NamespaceComponentAssociation_mixin._NamespaceComponentAssociation_mixin__components" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pyxb.namespace._NamespaceComponentAssociation_mixin._NamespaceComponentAssociation_mixin__origins">
<code class="descname">_NamespaceComponentAssociation_mixin__origins</code><em class="property"> = None</em><a class="headerlink" href="#pyxb.namespace._NamespaceComponentAssociation_mixin._NamespaceComponentAssociation_mixin__origins" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.namespace._NamespaceComponentAssociation_mixin._associateComponent">
<code class="descname">_associateComponent</code><span class="sig-paren">(</span><em>component</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace._NamespaceComponentAssociation_mixin._associateComponent" title="Permalink to this definition">¶</a></dt>
<dd><p>Record that the responsibility for the component belongs to this namespace.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.namespace._NamespaceComponentAssociation_mixin._releaseNamespaceContexts">
<code class="descname">_releaseNamespaceContexts</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace._NamespaceComponentAssociation_mixin._releaseNamespaceContexts" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.namespace._NamespaceComponentAssociation_mixin._replaceComponent_csc">
<code class="descname">_replaceComponent_csc</code><span class="sig-paren">(</span><em>existing_def</em>, <em>replacement_def</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace._NamespaceComponentAssociation_mixin._replaceComponent_csc" title="Permalink to this definition">¶</a></dt>
<dd><p>Replace a component definition in the set of associated components.</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"><strong>KeyError</strong> – <code class="xref py py-obj docutils literal"><span class="pre">existing_def</span></code> is not in the set of components.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="pyxb.namespace._NamespaceComponentAssociation_mixin._reset">
<code class="descname">_reset</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace._NamespaceComponentAssociation_mixin._reset" title="Permalink to this definition">¶</a></dt>
<dd><p>CSC extension to reset fields of a Namespace.</p>
<p>This one handles data related to component association with a
namespace.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.namespace._NamespaceComponentAssociation_mixin.addSchema">
<code class="descname">addSchema</code><span class="sig-paren">(</span><em>schema</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace._NamespaceComponentAssociation_mixin.addSchema" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.namespace._NamespaceComponentAssociation_mixin.components">
<code class="descname">components</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace._NamespaceComponentAssociation_mixin.components" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a frozenset of all components, named or unnamed, belonging
to this namespace.</p>
</dd></dl>
<dl class="method">
<dt id="pyxb.namespace._NamespaceComponentAssociation_mixin.lookupSchemaByLocation">
<code class="descname">lookupSchemaByLocation</code><span class="sig-paren">(</span><em>schema_location</em><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace._NamespaceComponentAssociation_mixin.lookupSchemaByLocation" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyxb.namespace._NamespaceComponentAssociation_mixin.schemas">
<code class="descname">schemas</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyxb.namespace._NamespaceComponentAssociation_mixin.schemas" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
</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.namespace package</a><ul>
<li><a class="reference internal" href="#submodules">Submodules</a></li>
<li><a class="reference internal" href="#pyxb-namespace-archive-module">pyxb.namespace.archive module</a></li>
<li><a class="reference internal" href="#module-pyxb.namespace.builtin">pyxb.namespace.builtin module</a></li>
<li><a class="reference internal" href="#pyxb-namespace-resolution-module">pyxb.namespace.resolution module</a></li>
<li><a class="reference internal" href="#module-pyxb.namespace.utility">pyxb.namespace.utility module</a></li>
<li><a class="reference internal" href="#module-pyxb.namespace">Module contents</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="pyxb.binding.html"
title="previous chapter">pyxb.binding package</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="pyxb.utils.html"
title="next chapter">pyxb.utils package</a></p>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/pyxb.namespace.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.utils.html" title="pyxb.utils package"
>next</a> |</li>
<li class="right" >
<a href="pyxb.binding.html" title="pyxb.binding 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>
