1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
|
<?xml version="1.0" encoding="iso-8859-1"?>
<!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>openid.yadis.xri</title>
<link rel="stylesheet" href="epydoc.css" type="text/css"></link>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- =========== START OF NAVBAR =========== -->
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
<tr valign="center">
<th class="navbar"> <a class="navbar" href="openid-module.html">Home</a> </th>
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center">
<p class="nomargin">
<a class="navbar" target="_top" href="http://openidenabled.com/python-openid/">Python-OpenID</a>
</p></th></tr></table>
</th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<font size="-1"><b class="breadcrumbs">
<a href="openid-module.html">Package openid</a> ::
<a href="openid.yadis-module.html">Package yadis</a> ::
Module xri
</b></font></br>
</td>
<td><table cellpadding="0" cellspacing="0">
<tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="openid.yadis.xri-module.html" target="_top">no frames</a>]</font></td></tr>
</table></td>
</tr></table>
<!-- =========== START OF MODULE DESCRIPTION =========== -->
<h2 class="module">Module openid.yadis.xri</h2>
Utility functions for handling XRIs.
<hr/>
<p><b>See Also:</b> XRI Syntax v2.0 at the <a
href="http://www.oasis-open.org/committees/tc_home.php?wg_abbrev=xri">OASIS
XRI Technical Committee</a>
</p>
<!-- =========== START OF FUNCTION SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Function Summary</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="openid.yadis.xri-module.html#escapeForIRI" class="summary-sig-name"><code>escapeForIRI</code></a>(<span class=summary-sig-arg>xri</span>)</span></code>
<br />
Escape things that need to be escaped when transforming to an IRI.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="openid.yadis.xri-module.html#identifierScheme" class="summary-sig-name"><code>identifierScheme</code></a>(<span class=summary-sig-arg>identifier</span>)</span></code>
<br />
Determine if this identifier is an XRI or URI.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="openid.yadis.xri-module.html#iriToURI" class="summary-sig-name"><code>iriToURI</code></a>(<span class=summary-sig-arg>iri</span>)</span></code>
<br />
Transform an IRI to a URI by escaping unicode.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> bool
</font></td>
<td><code><span class="summary-sig"><a href="openid.yadis.xri-module.html#providerIsAuthoritative" class="summary-sig-name"><code>providerIsAuthoritative</code></a>(<span class=summary-sig-arg>providerID</span>,
<span class=summary-sig-arg>canonicalID</span>)</span></code>
<br />
Is this provider ID authoritative for this XRI?</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> unicode
</font></td>
<td><code><span class="summary-sig"><a href="openid.yadis.xri-module.html#rootAuthority" class="summary-sig-name"><code>rootAuthority</code></a>(<span class=summary-sig-arg>xri</span>)</span></code>
<br />
Return the root authority for an XRI.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="openid.yadis.xri-module.html#toIRINormal" class="summary-sig-name"><code>toIRINormal</code></a>(<span class=summary-sig-arg>xri</span>)</span></code>
<br />
Transform an XRI to IRI-normal form.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="openid.yadis.xri-module.html#toURINormal" class="summary-sig-name"><code>toURINormal</code></a>(<span class=summary-sig-arg>xri</span>)</span></code>
<br />
Transform an XRI to URI normal form.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="openid.yadis.xri-module.html#XRI" class="summary-sig-name"><code>XRI</code></a>(<span class=summary-sig-arg>xri</span>)</span></code>
<br />
An XRI object allowing comparison of XRI.</td></tr>
</table><br />
<!-- =========== START OF FUNCTION DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
<th colspan="2">Function Details</th></tr>
</table>
<a name="escapeForIRI"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">escapeForIRI</span>(<span class=sig-arg>xri</span>)</span>
</h3>
Escape things that need to be escaped when transforming to an
IRI.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="identifierScheme"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">identifierScheme</span>(<span class=sig-arg>identifier</span>)</span>
</h3>
Determine if this identifier is an XRI or URI.
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
<code>"XRI"</code> or
<code>"URI"</code>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="iriToURI"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">iriToURI</span>(<span class=sig-arg>iri</span>)</span>
</h3>
Transform an IRI to a URI by escaping unicode.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="providerIsAuthoritative"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">providerIsAuthoritative</span>(<span class=sig-arg>providerID</span>,
<span class=sig-arg>canonicalID</span>)</span>
</h3>
Is this provider ID authoritative for this XRI?
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
bool
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="rootAuthority"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">rootAuthority</span>(<span class=sig-arg>xri</span>)</span>
</h3>
<p>Return the root authority for an XRI.</p>
Example:
<pre class="literalblock">
rootAuthority("xri://@example") == "xri://@"
</pre>
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>xri</b></code>
<br /><i>
(type=unicode)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
unicode
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="toIRINormal"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">toIRINormal</span>(<span class=sig-arg>xri</span>)</span>
</h3>
Transform an XRI to IRI-normal form.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="toURINormal"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">toURINormal</span>(<span class=sig-arg>xri</span>)</span>
</h3>
Transform an XRI to URI normal form.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="XRI"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">XRI</span>(<span class=sig-arg>xri</span>)</span>
</h3>
<p>An XRI object allowing comparison of XRI.</p>
Ideally, this would do full normalization and provide comparsion
operators as per XRI Syntax. Right now, it just does a bit of
canonicalization by ensuring the xri scheme is present.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>xri</b></code> -
an xri string
<br /><i>
(type=unicode)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<br />
<!-- =========== START OF NAVBAR =========== -->
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
<tr valign="center">
<th class="navbar"> <a class="navbar" href="openid-module.html">Home</a> </th>
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center">
<p class="nomargin">
<a class="navbar" target="_top" href="http://openidenabled.com/python-openid/">Python-OpenID</a>
</p></th></tr></table>
</th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td align="left"><font size="-2">Generated by Epydoc 2.1 on Wed Apr 22 16:14:20 2009</font></td>
<td align="right"><a href="http://epydoc.sourceforge.net"
><font size="-2">http://epydoc.sf.net</font></a></td>
</tr>
</table>
</body>
</html>
|
