<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>pyxb.namespace.utility</title>
<link rel="stylesheet" href="epydoc.css" type="text/css" />
<script type="text/javascript" src="epydoc.js"></script>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th> <a
href="pyxb-module.html">Home</a> </th>
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
>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></th>
</tr></table></th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<span class="breadcrumbs">
<a href="pyxb-module.html">Package pyxb</a> ::
<a href="pyxb.namespace-module.html">Package namespace</a> ::
Module utility
</span>
</td>
<td>
<table cellpadding="0" cellspacing="0">
<!-- hide/show private -->
<tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
onclick="toggle_private();">hide private</a>]</span></td></tr>
<tr><td align="right"><span class="options"
>[<a href="frames.html" target="_top">frames</a
>] | <a href="pyxb.namespace.utility-module.html"
target="_top">no frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<!-- ==================== MODULE DESCRIPTION ==================== -->
<h1 class="epydoc">Module utility</h1><p class="nomargin-top"><span class="codelink"><a href="pyxb.namespace.utility-pysrc.html">source code</a></span></p>
<p>Utility functions related to <a
href="http://www.w3.org/TR/2006/REC-xml-names-20060816/index.html"
target="_top">XML Namespaces</a>.</p>
<!-- ==================== FUNCTIONS ==================== -->
<a name="section-Functions"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Functions</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-Functions"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="pyxb.namespace.utility-module.html#NamespaceInstance" class="summary-sig-name">NamespaceInstance</a>(<span class="summary-sig-arg">namespace</span>)</span><br />
Get a namespace instance for the given namespace.</td>
<td align="right" valign="top">
<span class="codelink"><a href="pyxb.namespace.utility-pysrc.html#NamespaceInstance">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><a href="pyxb.namespace.Namespace-class.html"
class="link">Namespace</a> or <code>None</code></span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="pyxb.namespace.utility-module.html#NamespaceForURI" class="summary-sig-name">NamespaceForURI</a>(<span class="summary-sig-arg">uri</span>,
<span class="summary-sig-arg">create_if_missing</span>=<span class="summary-sig-default">False</span>)</span><br />
Given a URI, provide the <a
href="pyxb.namespace.Namespace-class.html" class="link">Namespace</a>
instance corresponding to it.</td>
<td align="right" valign="top">
<span class="codelink"><a href="pyxb.namespace.utility-pysrc.html#NamespaceForURI">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="pyxb.namespace.utility-module.html#CreateAbsentNamespace" class="summary-sig-name">CreateAbsentNamespace</a>()</span><br />
Create an absent namespace.</td>
<td align="right" valign="top">
<span class="codelink"><a href="pyxb.namespace.utility-pysrc.html#CreateAbsentNamespace">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="AvailableNamespaces"></a><span class="summary-sig-name">AvailableNamespaces</span>()</span><br />
Return the complete set of Namespace instances known to the system.</td>
<td align="right" valign="top">
<span class="codelink"><a href="pyxb.namespace.utility-pysrc.html#AvailableNamespaces">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
</table>
<!-- ==================== VARIABLES ==================== -->
<a name="section-Variables"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Variables</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-Variables"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a name="__package__"></a><span class="summary-name">__package__</span> = <code title="'pyxb.namespace'"><code class="variable-quote">'</code><code class="variable-string">pyxb.namespace</code><code class="variable-quote">'</code></code>
</td>
</tr>
</table>
<!-- ==================== FUNCTION DETAILS ==================== -->
<a name="section-FunctionDetails"></a>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Function Details</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-FunctionDetails"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
</table>
<a name="NamespaceInstance"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">NamespaceInstance</span>(<span class="sig-arg">namespace</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="pyxb.namespace.utility-pysrc.html#NamespaceInstance">source code</a></span>
</td>
</tr></table>
<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>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="NamespaceForURI"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">NamespaceForURI</span>(<span class="sig-arg">uri</span>,
<span class="sig-arg">create_if_missing</span>=<span class="sig-default">False</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="pyxb.namespace.utility-pysrc.html#NamespaceForURI">source code</a></span>
</td>
</tr></table>
<p>Given a URI, provide the <a href="pyxb.namespace.Namespace-class.html"
class="link">Namespace</a> instance corresponding to it.</p>
<p>This can only be used to lookup or create real namespaces. To create
absent namespaces, use <a
href="pyxb.namespace.utility-module.html#CreateAbsentNamespace"
class="link">CreateAbsentNamespace</a>.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>uri</code></strong> (A non-empty <code>str</code> or <code>unicode</code> string) - The URI that identifies the namespace</li>
<li><strong class="pname"><code>create_if_missing</code></strong> (<code>bool</code>) - If <code>True</code>, a namespace for the given URI is created if
one has not already been registered. Default is
<code>False</code>.</li>
</ul></dd>
<dt>Returns: <a href="pyxb.namespace.Namespace-class.html"
class="link">Namespace</a> or <code>None</code></dt>
<dd>The Namespace corresponding to <code>uri</code>, if available</dd>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'><a href="pyxb.exceptions_.LogicError-class.html">pyxb.LogicError</a></strong></code> - The uri is not a non-empty string</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="CreateAbsentNamespace"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">CreateAbsentNamespace</span>()</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="pyxb.namespace.utility-pysrc.html#CreateAbsentNamespace">source code</a></span>
</td>
</tr></table>
<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>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th> <a
href="pyxb-module.html">Home</a> </th>
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
>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></th>
</tr></table></th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
Generated by Epydoc 3.0.1 on Sun May 30 12:40:27 2010
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
>http://epydoc.sourceforge.net</a>
</td>
</tr>
</table>
<script type="text/javascript">
<!--
// Private objects are initially displayed (because if
// javascript is turned off then we want them to be
// visible); but by default, we want to hide them. So hide
// them unless we have a cookie that says to show them.
checkCookie();
// -->
</script>
</body>
</html>
