PageRenderTime 65ms CodeModel.GetById 28ms RepoModel.GetById 1ms app.codeStats 0ms

/PyXB-1.1.2/doc/html/api/pyxb.namespace.utility-module.html

#
HTML | 337 lines | 291 code | 22 blank | 24 comment | 0 complexity | 6272e7be15ad81f8194410945b94afaa MD5 | raw file
Possible License(s): Apache-2.0, MPL-2.0-no-copyleft-exception 
    

  1. <?xml version="1.0" encoding="ascii"?>
    2. 

  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    3. 

  3.           "DTD/xhtml1-transitional.dtd">
    4. 

  4. <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
    5. 

  5. <head>
    6. 

  6.   <title>pyxb.namespace.utility</title>
    7. 

  7.   <link rel="stylesheet" href="epydoc.css" type="text/css" />
    8. 

  8.   <script type="text/javascript" src="epydoc.js"></script>
    9. 

  9. </head>
    10. 

  10. 

  11. <body bgcolor="white" text="black" link="blue" vlink="#204080"
    12. 

  12.       alink="#204080">
    13. 

  13. <!-- ==================== NAVIGATION BAR ==================== -->
    14. 

  14. <table class="navbar" border="0" width="100%" cellpadding="0"
    15. 

  15.        bgcolor="#a0c0ff" cellspacing="0">
    16. 

  16.   <tr valign="middle">
    17. 

  17.   <!-- Home link -->
    18. 

  18.       <th>&nbsp;&nbsp;&nbsp;<a
    19. 

  19.         href="pyxb-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
    20. 

  20. 

  21.   <!-- Tree link -->
    22. 

  22.       <th>&nbsp;&nbsp;&nbsp;<a
    23. 

  23.         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
    24. 

  24. 

  25.   <!-- Index link -->
    26. 

  26.       <th>&nbsp;&nbsp;&nbsp;<a
    27. 

  27.         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
    28. 

  28. 

  29.   <!-- Help link -->
    30. 

  30.       <th>&nbsp;&nbsp;&nbsp;<a
    31. 

  31.         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
    32. 

  32. 

  33.   <!-- Project homepage -->
    34. 

  34.       <th class="navbar" align="right" width="100%">
    35. 

  35.         <table border="0" cellpadding="0" cellspacing="0">
    36. 

  36.           <tr><th class="navbar" align="center"
    37. 

  37.             >PyXB hosted on <a href="http://sourceforge.net/projects/pyxb"><img src="http://sflogo.sourceforge.net/sflogo.php?group_id=263147&amp;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>
    38. 

  38.           </tr></table></th>
    39. 

  39.   </tr>
    40. 

  40. </table>
    41. 

  41. <table width="100%" cellpadding="0" cellspacing="0">
    42. 

  42.   <tr valign="top">
    43. 

  43.     <td width="100%">
    44. 

  44.       <span class="breadcrumbs">
    45. 

  45.         <a href="pyxb-module.html">Package&nbsp;pyxb</a> ::
    46. 

  46.         <a href="pyxb.namespace-module.html">Package&nbsp;namespace</a> ::
    47. 

  47.         Module&nbsp;utility
    48. 

  48.       </span>
    49. 

  49.     </td>
    50. 

  50.     <td>
    51. 

  51.       <table cellpadding="0" cellspacing="0">
    52. 

  52.         <!-- hide/show private -->
    53. 

  53.         <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
    54. 

  54.     onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
    55. 

  55.         <tr><td align="right"><span class="options"
    56. 

  56.             >[<a href="frames.html" target="_top">frames</a
    57. 

  57.             >]&nbsp;|&nbsp;<a href="pyxb.namespace.utility-module.html"
    58. 

  58.             target="_top">no&nbsp;frames</a>]</span></td></tr>
    59. 

  59.       </table>
    60. 

  60.     </td>
    61. 

  61.   </tr>
    62. 

  62. </table>
    63. 

  63. <!-- ==================== MODULE DESCRIPTION ==================== -->
    64. 

  64. <h1 class="epydoc">Module utility</h1><p class="nomargin-top"><span class="codelink"><a href="pyxb.namespace.utility-pysrc.html">source&nbsp;code</a></span></p>
    65. 

  65. <p>Utility functions related to <a 
    66. 

  66.   href="http://www.w3.org/TR/2006/REC-xml-names-20060816/index.html" 
    67. 

  67.   target="_top">XML Namespaces</a>.</p>
    68. 

  68. 

  69. <!-- ==================== FUNCTIONS ==================== -->
    70. 

  70. <a name="section-Functions"></a>
    71. 

  71. <table class="summary" border="1" cellpadding="3"
    72. 

  72.        cellspacing="0" width="100%" bgcolor="white">
    73. 

  73. <tr bgcolor="#70b0f0" class="table-header">
    74. 

  74.   <td colspan="2" class="table-header">
    75. 

  75.     <table border="0" cellpadding="0" cellspacing="0" width="100%">
    76. 

  76.       <tr valign="top">
    77. 

  77.         <td align="left"><span class="table-header">Functions</span></td>
    78. 

  78.         <td align="right" valign="top"
    79. 

  79.          ><span class="options">[<a href="#section-Functions"
    80. 

  80.          class="privatelink" onclick="toggle_private();"
    81. 

  81.          >hide private</a>]</span></td>
    82. 

  82.       </tr>
    83. 

  83.     </table>
    84. 

  84.   </td>
    85. 

  85. </tr>
    86. 

  86. <tr>
    87. 

  87.     <td width="15%" align="right" valign="top" class="summary">
    88. 

  88.       <span class="summary-type">&nbsp;</span>
    89. 

  89.     </td><td class="summary">
    90. 

  90.       <table width="100%" cellpadding="0" cellspacing="0" border="0">
    91. 

  91.         <tr>
    92. 

  92.           <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 />
    93. 

  93.       Get a namespace instance for the given namespace.</td>
    94. 

  94.           <td align="right" valign="top">
    95. 

  95.             <span class="codelink"><a href="pyxb.namespace.utility-pysrc.html#NamespaceInstance">source&nbsp;code</a></span>
    96. 

  96.             
    97. 

  97.           </td>
    98. 

  98.         </tr>
    99. 

  99.       </table>
    100. 

  100.       
    101. 

  101.     </td>
    102. 

  102.   </tr>
    103. 

  103. <tr>
    104. 

  104.     <td width="15%" align="right" valign="top" class="summary">
    105. 

  105.       <span class="summary-type"><a href="pyxb.namespace.Namespace-class.html" 
    106. 

  106.       class="link">Namespace</a> or <code>None</code></span>
    107. 

  107.     </td><td class="summary">
    108. 

  108.       <table width="100%" cellpadding="0" cellspacing="0" border="0">
    109. 

  109.         <tr>
    110. 

  110.           <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>,
    111. 

  111.         <span class="summary-sig-arg">create_if_missing</span>=<span class="summary-sig-default">False</span>)</span><br />
    112. 

  112.       Given a URI, provide the <a 
    113. 

  113.       href="pyxb.namespace.Namespace-class.html" class="link">Namespace</a>
    114. 

  114.       instance corresponding to it.</td>
    115. 

  115.           <td align="right" valign="top">
    116. 

  116.             <span class="codelink"><a href="pyxb.namespace.utility-pysrc.html#NamespaceForURI">source&nbsp;code</a></span>
    117. 

  117.             
    118. 

  118.           </td>
    119. 

  119.         </tr>
    120. 

  120.       </table>
    121. 

  121.       
    122. 

  122.     </td>
    123. 

  123.   </tr>
    124. 

  124. <tr>
    125. 

  125.     <td width="15%" align="right" valign="top" class="summary">
    126. 

  126.       <span class="summary-type">&nbsp;</span>
    127. 

  127.     </td><td class="summary">
    128. 

  128.       <table width="100%" cellpadding="0" cellspacing="0" border="0">
    129. 

  129.         <tr>
    130. 

  130.           <td><span class="summary-sig"><a href="pyxb.namespace.utility-module.html#CreateAbsentNamespace" class="summary-sig-name">CreateAbsentNamespace</a>()</span><br />
    131. 

  131.       Create an absent namespace.</td>
    132. 

  132.           <td align="right" valign="top">
    133. 

  133.             <span class="codelink"><a href="pyxb.namespace.utility-pysrc.html#CreateAbsentNamespace">source&nbsp;code</a></span>
    134. 

  134.             
    135. 

  135.           </td>
    136. 

  136.         </tr>
    137. 

  137.       </table>
    138. 

  138.       
    139. 

  139.     </td>
    140. 

  140.   </tr>
    141. 

  141. <tr>
    142. 

  142.     <td width="15%" align="right" valign="top" class="summary">
    143. 

  143.       <span class="summary-type">&nbsp;</span>
    144. 

  144.     </td><td class="summary">
    145. 

  145.       <table width="100%" cellpadding="0" cellspacing="0" border="0">
    146. 

  146.         <tr>
    147. 

  147.           <td><span class="summary-sig"><a name="AvailableNamespaces"></a><span class="summary-sig-name">AvailableNamespaces</span>()</span><br />
    148. 

  148.       Return the complete set of Namespace instances known to the system.</td>
    149. 

  149.           <td align="right" valign="top">
    150. 

  150.             <span class="codelink"><a href="pyxb.namespace.utility-pysrc.html#AvailableNamespaces">source&nbsp;code</a></span>
    151. 

  151.             
    152. 

  152.           </td>
    153. 

  153.         </tr>
    154. 

  154.       </table>
    155. 

  155.       
    156. 

  156.     </td>
    157. 

  157.   </tr>
    158. 

  158. </table>
    159. 

  159. <!-- ==================== VARIABLES ==================== -->
    160. 

  160. <a name="section-Variables"></a>
    161. 

  161. <table class="summary" border="1" cellpadding="3"
    162. 

  162.        cellspacing="0" width="100%" bgcolor="white">
    163. 

  163. <tr bgcolor="#70b0f0" class="table-header">
    164. 

  164.   <td colspan="2" class="table-header">
    165. 

  165.     <table border="0" cellpadding="0" cellspacing="0" width="100%">
    166. 

  166.       <tr valign="top">
    167. 

  167.         <td align="left"><span class="table-header">Variables</span></td>
    168. 

  168.         <td align="right" valign="top"
    169. 

  169.          ><span class="options">[<a href="#section-Variables"
    170. 

  170.          class="privatelink" onclick="toggle_private();"
    171. 

  171.          >hide private</a>]</span></td>
    172. 

  172.       </tr>
    173. 

  173.     </table>
    174. 

  174.   </td>
    175. 

  175. </tr>
    176. 

  176. <tr>
    177. 

  177.     <td width="15%" align="right" valign="top" class="summary">
    178. 

  178.       <span class="summary-type">&nbsp;</span>
    179. 

  179.     </td><td class="summary">
    180. 

  180.         <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>
    181. 

  181.     </td>
    182. 

  182.   </tr>
    183. 

  183. </table>
    184. 

  184. <!-- ==================== FUNCTION DETAILS ==================== -->
    185. 

  185. <a name="section-FunctionDetails"></a>
    186. 

  186. <table class="details" border="1" cellpadding="3"
    187. 

  187.        cellspacing="0" width="100%" bgcolor="white">
    188. 

  188. <tr bgcolor="#70b0f0" class="table-header">
    189. 

  189.   <td colspan="2" class="table-header">
    190. 

  190.     <table border="0" cellpadding="0" cellspacing="0" width="100%">
    191. 

  191.       <tr valign="top">
    192. 

  192.         <td align="left"><span class="table-header">Function Details</span></td>
    193. 

  193.         <td align="right" valign="top"
    194. 

  194.          ><span class="options">[<a href="#section-FunctionDetails"
    195. 

  195.          class="privatelink" onclick="toggle_private();"
    196. 

  196.          >hide private</a>]</span></td>
    197. 

  197.       </tr>
    198. 

  198.     </table>
    199. 

  199.   </td>
    200. 

  200. </tr>
    201. 

  201. </table>
    202. 

  202. <a name="NamespaceInstance"></a>
    203. 

  203. <div>
    204. 

  204. <table class="details" border="1" cellpadding="3"
    205. 

  205.        cellspacing="0" width="100%" bgcolor="white">
    206. 

  206. <tr><td>
    207. 

  207.   <table width="100%" cellpadding="0" cellspacing="0" border="0">
    208. 

  208.   <tr valign="top"><td>
    209. 

  209.   <h3 class="epydoc"><span class="sig"><span class="sig-name">NamespaceInstance</span>(<span class="sig-arg">namespace</span>)</span>
    210. 

  210.   </h3>
    211. 

  211.   </td><td align="right" valign="top"
    212. 

  212.     ><span class="codelink"><a href="pyxb.namespace.utility-pysrc.html#NamespaceInstance">source&nbsp;code</a></span>&nbsp;
    213. 

  213.     </td>
    214. 

  214.   </tr></table>
    215. 

  215.   
    216. 

  216.   <p>Get a namespace instance for the given namespace.</p>
    217. 

  217.   <p>This is used when it is unclear whether the namespace is specified by 
    218. 

  218.   URI or by instance or by any other mechanism we might dream up in the 
    219. 

  219.   future.</p>
    220. 

  220.   <dl class="fields">
    221. 

  221.   </dl>
    222. 

  222. </td></tr></table>
    223. 

  223. </div>
    224. 

  224. <a name="NamespaceForURI"></a>
    225. 

  225. <div>
    226. 

  226. <table class="details" border="1" cellpadding="3"
    227. 

  227.        cellspacing="0" width="100%" bgcolor="white">
    228. 

  228. <tr><td>
    229. 

  229.   <table width="100%" cellpadding="0" cellspacing="0" border="0">
    230. 

  230.   <tr valign="top"><td>
    231. 

  231.   <h3 class="epydoc"><span class="sig"><span class="sig-name">NamespaceForURI</span>(<span class="sig-arg">uri</span>,
    232. 

  232.         <span class="sig-arg">create_if_missing</span>=<span class="sig-default">False</span>)</span>
    233. 

  233.   </h3>
    234. 

  234.   </td><td align="right" valign="top"
    235. 

  235.     ><span class="codelink"><a href="pyxb.namespace.utility-pysrc.html#NamespaceForURI">source&nbsp;code</a></span>&nbsp;
    236. 

  236.     </td>
    237. 

  237.   </tr></table>
    238. 

  238.   
    239. 

  239.   <p>Given a URI, provide the <a href="pyxb.namespace.Namespace-class.html"
    240. 

  240.   class="link">Namespace</a> instance corresponding to it.</p>
    241. 

  241.   <p>This can only be used to lookup or create real namespaces.  To create 
    242. 

  242.   absent namespaces, use <a 
    243. 

  243.   href="pyxb.namespace.utility-module.html#CreateAbsentNamespace" 
    244. 

  244.   class="link">CreateAbsentNamespace</a>.</p>
    245. 

  245.   <dl class="fields">
    246. 

  246.     <dt>Parameters:</dt>
    247. 

  247.     <dd><ul class="nomargin-top">
    248. 

  248.         <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>
    249. 

  249.         <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
    250. 

  250.           one has not already been registered.  Default is 
    251. 

  251.           <code>False</code>.</li>
    252. 

  252.     </ul></dd>
    253. 

  253.     <dt>Returns: <a href="pyxb.namespace.Namespace-class.html" 
    254. 

  254.       class="link">Namespace</a> or <code>None</code></dt>
    255. 

  255.         <dd>The Namespace corresponding to <code>uri</code>, if available</dd>
    256. 

  256.     <dt>Raises:</dt>
    257. 

  257.     <dd><ul class="nomargin-top">
    258. 

  258.         <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>
    259. 

  259.     </ul></dd>
    260. 

  260.   </dl>
    261. 

  261. </td></tr></table>
    262. 

  262. </div>
    263. 

  263. <a name="CreateAbsentNamespace"></a>
    264. 

  264. <div>
    265. 

  265. <table class="details" border="1" cellpadding="3"
    266. 

  266.        cellspacing="0" width="100%" bgcolor="white">
    267. 

  267. <tr><td>
    268. 

  268.   <table width="100%" cellpadding="0" cellspacing="0" border="0">
    269. 

  269.   <tr valign="top"><td>
    270. 

  270.   <h3 class="epydoc"><span class="sig"><span class="sig-name">CreateAbsentNamespace</span>()</span>
    271. 

  271.   </h3>
    272. 

  272.   </td><td align="right" valign="top"
    273. 

  273.     ><span class="codelink"><a href="pyxb.namespace.utility-pysrc.html#CreateAbsentNamespace">source&nbsp;code</a></span>&nbsp;
    274. 

  274.     </td>
    275. 

  275.   </tr></table>
    276. 

  276.   
    277. 

  277.   <p>Create an absent namespace.</p>
    278. 

  278.   <p>Use this when you need a namespace for declarations in a schema with 
    279. 

  279.   no target namespace.  Absent namespaces are not stored in the 
    280. 

  280.   infrastructure; it is your responsibility to hold on to the reference you
    281. 

  281.   get from this, because you won't be able to look it up.</p>
    282. 

  282.   <dl class="fields">
    283. 

  283.   </dl>
    284. 

  284. </td></tr></table>
    285. 

  285. </div>
    286. 

  286. <br />
    287. 

  287. <!-- ==================== NAVIGATION BAR ==================== -->
    288. 

  288. <table class="navbar" border="0" width="100%" cellpadding="0"
    289. 

  289.        bgcolor="#a0c0ff" cellspacing="0">
    290. 

  290.   <tr valign="middle">
    291. 

  291.   <!-- Home link -->
    292. 

  292.       <th>&nbsp;&nbsp;&nbsp;<a
    293. 

  293.         href="pyxb-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
    294. 

  294. 

  295.   <!-- Tree link -->
    296. 

  296.       <th>&nbsp;&nbsp;&nbsp;<a
    297. 

  297.         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
    298. 

  298. 

  299.   <!-- Index link -->
    300. 

  300.       <th>&nbsp;&nbsp;&nbsp;<a
    301. 

  301.         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
    302. 

  302. 

  303.   <!-- Help link -->
    304. 

  304.       <th>&nbsp;&nbsp;&nbsp;<a
    305. 

  305.         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
    306. 

  306. 

  307.   <!-- Project homepage -->
    308. 

  308.       <th class="navbar" align="right" width="100%">
    309. 

  309.         <table border="0" cellpadding="0" cellspacing="0">
    310. 

  310.           <tr><th class="navbar" align="center"
    311. 

  311.             >PyXB hosted on <a href="http://sourceforge.net/projects/pyxb"><img src="http://sflogo.sourceforge.net/sflogo.php?group_id=263147&amp;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>
    312. 

  312.           </tr></table></th>
    313. 

  313.   </tr>
    314. 

  314. </table>
    315. 

  315. <table border="0" cellpadding="0" cellspacing="0" width="100%%">
    316. 

  316.   <tr>
    317. 

  317.     <td align="left" class="footer">
    318. 

  318.     Generated by Epydoc 3.0.1 on Sun May 30 12:40:27 2010
    319. 

  319.     </td>
    320. 

  320.     <td align="right" class="footer">
    321. 

  321.       <a target="mainFrame" href="http://epydoc.sourceforge.net"
    322. 

  322.         >http://epydoc.sourceforge.net</a>
    323. 

  323.     </td>
    324. 

  324.   </tr>
    325. 

  325. </table>
    326. 

  326. 

  327. <script type="text/javascript">
    328. 

  328.   <!--
    329. 

  329.   // Private objects are initially displayed (because if
    330. 

  330.   // javascript is turned off then we want them to be
    331. 

  331.   // visible); but by default, we want to hide them.  So hide
    332. 

  332.   // them unless we have a cookie that says to show them.
    333. 

  333.   checkCookie();
    334. 

  334.   // -->
    335. 

  335. </script>
    336. 

  336. </body>
    337. 

  337. </html>
    338. 

  338.