← Back to branch summary

~gary/python-openid/python-openid-2.2.1-patched

« back to all changes in this revision

Viewing changes to doc/openid.message.NamespaceMap-class.html

  • Committer: Launchpad Patch Queue Manager
  • Date: 2007-11-30 02:46:28 UTC
  • mfrom: (1.1.1 pyopenid-2.0)
  • Revision ID: launchpad@pqm.canonical.com-20071130024628-qktwsew3383iawmq
[rs=SteveA] upgrade to python-openid-2.0.1

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/openid.message.NamespaceMap-class.html
 
1
<?xml version="1.0" encoding="iso-8859-1"?>
 
2
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
 
3
          "DTD/xhtml1-transitional.dtd">
 
4
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
 
5
<head>
 
6
  <title>openid.message.NamespaceMap</title>
 
7
  <link rel="stylesheet" href="epydoc.css" type="text/css"></link>
 
8
</head>
 
9
<body bgcolor="white" text="black" link="blue" vlink="#204080"
 
10
      alink="#204080">
 
11
 
 
12
<!-- =========== START OF NAVBAR =========== -->
 
13
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
 
14
  <tr valign="center">
 
15
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="openid-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
 
16
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 
17
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>
 
18
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 
19
    <th class="navbar" align="right" width="100%">
 
20
      <table border="0" cellpadding="0" cellspacing="0">
 
21
      <tr><th class="navbar" align="center">
 
22
        <p class="nomargin">
 
23
          <a class="navbar" target="_top" href="http://www.openidenabled.com/">Python-OpenID</a>
 
24
      </p></th></tr></table>
 
25
    </th>
 
26
  </tr>
 
27
</table>
 
28
<table width="100%" cellpadding="0" cellspacing="0">
 
29
  <tr valign="top">
 
30
    <td width="100%">
 
31
      <font size="-1"><b class="breadcrumbs">
 
32
        <a href="openid-module.html">Package&nbsp;openid</a> ::
 
33
        <a href="openid.message-module.html">Module&nbsp;message</a> ::
 
34
        Class&nbsp;NamespaceMap
 
35
      </b></font></br>
 
36
    </td>
 
37
    <td><table cellpadding="0" cellspacing="0">
 
38
      <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a>&nbsp;|&nbsp;<a href="openid.message.NamespaceMap-class.html" target="_top">no&nbsp;frames</a>]</font></td></tr>
 
39
    </table></td>
 
40
</tr></table>
 
41
 
 
42
<!-- =========== START OF CLASS DESCRIPTION =========== -->
 
43
<h2 class="class">Type NamespaceMap</h2>
 
44
 
 
45
<pre class="base-tree">
 
46
<a href="__builtin__.object-class.html"><code>object</code></a> --+
 
47
         |
 
48
        <b>NamespaceMap</b>
 
49
</pre><br />
 
50
 
 
51
<hr/>
 
52
 
 
53
Maintains a bijective map between namespace uris and aliases.
 
54
<hr/>
 
55
 
 
56
 
 
57
<!-- =========== START OF METHOD SUMMARY =========== -->
 
58
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
 
59
<tr bgcolor="#70b0f0" class="summary">
 
60
  <th colspan="2">Method Summary</th></tr>
 
61
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
62
  <td><code><a name="__init__"></a><span class="summary-sig"><span class="summary-sig-name">__init__</span>(<span class=summary-sig-arg>self</span>)</span></code>
 
63
</td></tr>
 
64
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
65
  <td><code><a name="__contains__"></a><span class="summary-sig"><span class="summary-sig-name">__contains__</span>(<span class=summary-sig-arg>self</span>,
 
66
          <span class=summary-sig-arg>namespace_uri</span>)</span></code>
 
67
</td></tr>
 
68
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
69
  <td><code><span class="summary-sig"><a href="openid.message.NamespaceMap-class.html#add" class="summary-sig-name"><code>add</code></a>(<span class=summary-sig-arg>self</span>,
 
70
          <span class=summary-sig-arg>namespace_uri</span>)</span></code>
 
71
<br />
 
72
Add this namespace URI to the mapping, without caring what alias it 
 
73
ends up with</td></tr>
 
74
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
75
  <td><code><span class="summary-sig"><a href="openid.message.NamespaceMap-class.html#addAlias" class="summary-sig-name"><code>addAlias</code></a>(<span class=summary-sig-arg>self</span>,
 
76
          <span class=summary-sig-arg>namespace_uri</span>,
 
77
          <span class=summary-sig-arg>desired_alias</span>)</span></code>
 
78
<br />
 
79
Add an alias from this namespace URI to the desired alias</td></tr>
 
80
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
81
  <td><code><a name="getAlias"></a><span class="summary-sig"><span class="summary-sig-name">getAlias</span>(<span class=summary-sig-arg>self</span>,
 
82
          <span class=summary-sig-arg>namespace_uri</span>)</span></code>
 
83
</td></tr>
 
84
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
85
  <td><code><a name="getNamespaceURI"></a><span class="summary-sig"><span class="summary-sig-name">getNamespaceURI</span>(<span class=summary-sig-arg>self</span>,
 
86
          <span class=summary-sig-arg>alias</span>)</span></code>
 
87
</td></tr>
 
88
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
89
  <td><code><a name="isDefined"></a><span class="summary-sig"><span class="summary-sig-name">isDefined</span>(<span class=summary-sig-arg>self</span>,
 
90
          <span class=summary-sig-arg>namespace_uri</span>)</span></code>
 
91
</td></tr>
 
92
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
93
  <td><code><span class="summary-sig"><a href="openid.message.NamespaceMap-class.html#iterAliases" class="summary-sig-name"><code>iterAliases</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
 
94
<br />
 
95
Return an iterator over the aliases</td></tr>
 
96
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
97
  <td><code><span class="summary-sig"><a href="openid.message.NamespaceMap-class.html#iteritems" class="summary-sig-name"><code>iteritems</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
 
98
<br />
 
99
Iterate over the mapping</td></tr>
 
100
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
101
  <td><code><span class="summary-sig"><a href="openid.message.NamespaceMap-class.html#iterNamespaceURIs" class="summary-sig-name"><code>iterNamespaceURIs</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
 
102
<br />
 
103
Return an iterator over the namespace URIs</td></tr>
 
104
  <tr><td colspan="2">
 
105
    <b>Inherited from <a href="__builtin__.object-class.html"><code>object</code></a>:</b>
 
106
      <a href="__builtin__.object-class.html#__delattr__"><code>__delattr__</code></a>, 
 
107
      <a href="__builtin__.object-class.html#__getattribute__"><code>__getattribute__</code></a>, 
 
108
      <a href="__builtin__.object-class.html#__hash__"><code>__hash__</code></a>, 
 
109
      <a href="__builtin__.object-class.html#__new__"><code>__new__</code></a>, 
 
110
      <a href="__builtin__.object-class.html#__reduce__"><code>__reduce__</code></a>, 
 
111
      <a href="__builtin__.object-class.html#__reduce_ex__"><code>__reduce_ex__</code></a>, 
 
112
      <a href="__builtin__.object-class.html#__repr__"><code>__repr__</code></a>, 
 
113
      <a href="__builtin__.object-class.html#__setattr__"><code>__setattr__</code></a>, 
 
114
      <a href="__builtin__.object-class.html#__str__"><code>__str__</code></a>
 
115
    </td></tr>
 
116
</table><br />
 
117
 
 
118
 
 
119
<!-- =========== START OF METHOD DETAILS =========== -->
 
120
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
 
121
<tr bgcolor="#70b0f0" class="details">
 
122
  <th colspan="2">Method Details</th></tr>
 
123
</table>
 
124
 
 
125
<a name="add"></a>
 
126
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
 
127
  <h3><span class="sig"><span class="sig-name">add</span>(<span class=sig-arg>self</span>,
 
128
          <span class=sig-arg>namespace_uri</span>)</span>
 
129
  </h3>
 
130
  Add this namespace URI to the mapping, without caring what alias it 
 
131
  ends up with
 
132
  <dl><dt></dt><dd>
 
133
  </dd></dl>
 
134
</td></tr></table>
 
135
 
 
136
<a name="addAlias"></a>
 
137
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
 
138
  <h3><span class="sig"><span class="sig-name">addAlias</span>(<span class=sig-arg>self</span>,
 
139
          <span class=sig-arg>namespace_uri</span>,
 
140
          <span class=sig-arg>desired_alias</span>)</span>
 
141
  </h3>
 
142
  Add an alias from this namespace URI to the desired alias
 
143
  <dl><dt></dt><dd>
 
144
  </dd></dl>
 
145
</td></tr></table>
 
146
 
 
147
<a name="iterAliases"></a>
 
148
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
 
149
  <h3><span class="sig"><span class="sig-name">iterAliases</span>(<span class=sig-arg>self</span>)</span>
 
150
  </h3>
 
151
  Return an iterator over the aliases
 
152
  <dl><dt></dt><dd>
 
153
  </dd></dl>
 
154
</td></tr></table>
 
155
 
 
156
<a name="iteritems"></a>
 
157
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
 
158
  <h3><span class="sig"><span class="sig-name">iteritems</span>(<span class=sig-arg>self</span>)</span>
 
159
  </h3>
 
160
  Iterate over the mapping
 
161
  <dl><dt></dt><dd>
 
162
    <dl><dt><b>Returns:</b></dt>
 
163
      <dd>
 
164
        iterator of (namespace_uri, alias)
 
165
      </dd>
 
166
    </dl>
 
167
  </dd></dl>
 
168
</td></tr></table>
 
169
 
 
170
<a name="iterNamespaceURIs"></a>
 
171
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
 
172
  <h3><span class="sig"><span class="sig-name">iterNamespaceURIs</span>(<span class=sig-arg>self</span>)</span>
 
173
  </h3>
 
174
  Return an iterator over the namespace URIs
 
175
  <dl><dt></dt><dd>
 
176
  </dd></dl>
 
177
</td></tr></table>
 
178
<br />
 
179
 
 
180
 
 
181
<!-- =========== START OF NAVBAR =========== -->
 
182
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
 
183
  <tr valign="center">
 
184
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="openid-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
 
185
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 
186
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>
 
187
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 
188
    <th class="navbar" align="right" width="100%">
 
189
      <table border="0" cellpadding="0" cellspacing="0">
 
190
      <tr><th class="navbar" align="center">
 
191
        <p class="nomargin">
 
192
          <a class="navbar" target="_top" href="http://www.openidenabled.com/">Python-OpenID</a>
 
193
      </p></th></tr></table>
 
194
    </th>
 
195
  </tr>
 
196
</table>
 
197
 
 
198
<table border="0" cellpadding="0" cellspacing="0" width="100%">
 
199
  <tr>
 
200
    <td align="left"><font size="-2">Generated by Epydoc 2.1 on Mon Sep 10 13:00:13 2007</font></td>
 
201
    <td align="right"><a href="http://epydoc.sourceforge.net"
 
202
                      ><font size="-2">http://epydoc.sf.net</font></a></td>
 
203
  </tr>
 
204
</table>
 
205
</body>
 
206
</html>