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
|
<?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.services</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 services
</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.services-module.html" target="_top">no frames</a>]</font></td></tr>
</table></td>
</tr></table>
<!-- =========== START OF MODULE DESCRIPTION =========== -->
<h2 class="module">Module openid.yadis.services</h2>
<!-- =========== 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.services-module.html#applyFilter" class="summary-sig-name"><code>applyFilter</code></a>(<span class=summary-sig-arg>normalized_uri</span>,
<span class=summary-sig-arg>xrd_data</span>,
<span class=summary-sig-arg>flt</span>)</span></code>
<br />
Generate an iterable of endpoint objects given this input data,
presumably from the result of performing the Yadis protocol.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> (str, [endpoint])
</font></td>
<td><code><span class="summary-sig"><a href="openid.yadis.services-module.html#getServiceEndpoints" class="summary-sig-name"><code>getServiceEndpoints</code></a>(<span class=summary-sig-arg>input_url</span>,
<span class=summary-sig-arg>flt</span>)</span></code>
<br />
Perform the Yadis protocol on the input URL and return an iterable of
resulting endpoint objects.</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="applyFilter"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">applyFilter</span>(<span class=sig-arg>normalized_uri</span>,
<span class=sig-arg>xrd_data</span>,
<span class=sig-arg>flt</span>=<span class=sig-default>None</span>)</span>
</h3>
Generate an iterable of endpoint objects given this input data,
presumably from the result of performing the Yadis protocol.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>normalized_uri</b></code> -
The input URL, after following redirects, as in the Yadis
protocol.
<dd><code><b>xrd_data</b></code> -
The XML text the XRDS file fetched from the normalized
URI.
<br /><i>
(type=str)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="getServiceEndpoints"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">getServiceEndpoints</span>(<span class=sig-arg>input_url</span>,
<span class=sig-arg>flt</span>=<span class=sig-default>None</span>)</span>
</h3>
Perform the Yadis protocol on the input URL and return an iterable
of resulting endpoint objects.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>input_url</b></code> -
The URL on which to perform the Yadis protocol
<dd><code><b>flt</b></code> -
A filter object or something that is convertable to a filter
object (using mkFilter) that will be used to generate endpoint
objects. This defaults to generating BasicEndpoint objects.
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
The normalized identity URL and an iterable of endpoint
objects generated by the filter function.
<br /><i>
(type=(str, [endpoint]))</i>
</dd>
</dl>
<dl><dt><b>Raises:</b></dt>
<dd><code><b>DiscoveryFailure</b></code> -
when Yadis fails to obtain an XRDS document.
</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>
|
