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">
6
<title>openid.yadis.services</title>
7
<link rel="stylesheet" href="epydoc.css" type="text/css"></link>
9
<body bgcolor="white" text="black" link="blue" vlink="#204080"
12
<!-- =========== START OF NAVBAR =========== -->
13
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
15
<th class="navbar"> <a class="navbar" href="openid-module.html">Home</a> </th>
16
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
17
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
18
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
19
<th class="navbar" align="right" width="100%">
20
<table border="0" cellpadding="0" cellspacing="0">
21
<tr><th class="navbar" align="center">
23
<a class="navbar" target="_top" href="http://www.openidenabled.com/">Python-OpenID</a>
24
</p></th></tr></table>
28
<table width="100%" cellpadding="0" cellspacing="0">
31
<font size="-1"><b class="breadcrumbs">
32
<a href="openid-module.html">Package openid</a> ::
33
<a href="openid.yadis-module.html">Package yadis</a> ::
37
<td><table cellpadding="0" cellspacing="0">
38
<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>
42
<!-- =========== START OF MODULE DESCRIPTION =========== -->
43
<h2 class="module">Module openid.yadis.services</h2>
46
<!-- =========== START OF FUNCTION SUMMARY =========== -->
47
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
48
<tr bgcolor="#70b0f0" class="summary">
49
<th colspan="2">Function Summary</th></tr>
50
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
51
<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>,
52
<span class=summary-sig-arg>xrd_data</span>,
53
<span class=summary-sig-arg>flt</span>)</span></code>
55
Generate an iterable of endpoint objects given this input data,
56
presumably from the result of performing the Yadis protocol.</td></tr>
57
<tr><td align="right" valign="top" width="15%"><font size="-1"> (str, [endpoint])
59
<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>,
60
<span class=summary-sig-arg>flt</span>)</span></code>
62
Perform the Yadis protocol on the input URL and return an iterable of
63
resulting endpoint objects.</td></tr>
67
<!-- =========== START OF FUNCTION DETAILS =========== -->
68
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
69
<tr bgcolor="#70b0f0" class="details">
70
<th colspan="2">Function Details</th></tr>
73
<a name="applyFilter"></a>
74
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
75
<h3><span class="sig"><span class="sig-name">applyFilter</span>(<span class=sig-arg>normalized_uri</span>,
76
<span class=sig-arg>xrd_data</span>,
77
<span class=sig-arg>flt</span>=<span class=sig-default>None</span>)</span>
79
Generate an iterable of endpoint objects given this input data,
80
presumably from the result of performing the Yadis protocol.
82
<dl><dt><b>Parameters:</b></dt>
83
<dd><code><b>normalized_uri</b></code> -
84
The input URL, after following redirects, as in the Yadis
86
<dd><code><b>xrd_data</b></code> -
87
The XML text the XRDS file fetched from the normalized
89
<br /><i>
96
<a name="getServiceEndpoints"></a>
97
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
98
<h3><span class="sig"><span class="sig-name">getServiceEndpoints</span>(<span class=sig-arg>input_url</span>,
99
<span class=sig-arg>flt</span>=<span class=sig-default>None</span>)</span>
101
Perform the Yadis protocol on the input URL and return an iterable
102
of resulting endpoint objects.
104
<dl><dt><b>Parameters:</b></dt>
105
<dd><code><b>input_url</b></code> -
106
The URL on which to perform the Yadis protocol
107
<dd><code><b>flt</b></code> -
108
A filter object or something that is convertable to a filter
109
object (using mkFilter) that will be used to generate endpoint
110
objects. This defaults to generating BasicEndpoint objects.
113
<dl><dt><b>Returns:</b></dt>
115
The normalized identity URL and an iterable of endpoint
116
objects generated by the filter function.
117
<br /><i>
118
(type=(str, [endpoint]))</i>
126
<!-- =========== START OF NAVBAR =========== -->
127
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
129
<th class="navbar"> <a class="navbar" href="openid-module.html">Home</a> </th>
130
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
131
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
132
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
133
<th class="navbar" align="right" width="100%">
134
<table border="0" cellpadding="0" cellspacing="0">
135
<tr><th class="navbar" align="center">
137
<a class="navbar" target="_top" href="http://www.openidenabled.com/">Python-OpenID</a>
138
</p></th></tr></table>
143
<table border="0" cellpadding="0" cellspacing="0" width="100%">
145
<td align="left"><font size="-2">Generated by Epydoc 2.1 on Mon Sep 10 13:00:13 2007</font></td>
146
<td align="right"><a href="http://epydoc.sourceforge.net"
147
><font size="-2">http://epydoc.sf.net</font></a></td>