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
|
<?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.oidutil</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> ::
Module oidutil
</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.oidutil-module.html" target="_top">no frames</a>]</font></td></tr>
</table></td>
</tr></table>
<!-- =========== START OF MODULE DESCRIPTION =========== -->
<h2 class="module">Module openid.oidutil</h2>
<p>This module contains general utility code that is used throughout the
library.</p>
For users of this library, the <code><a
href="openid.oidutil-module.html#log"
class="link"><code>log</code></a></code> function is probably the most
interesting.
<hr/>
<!-- =========== 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"> str
</font></td>
<td><code><span class="summary-sig"><a href="openid.oidutil-module.html#appendArgs" class="summary-sig-name"><code>appendArgs</code></a>(<span class=summary-sig-arg>url</span>,
<span class=summary-sig-arg>args</span>)</span></code>
<br />
Append query arguments to a HTTP(s) URL.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="autoSubmitHTML"></a><span class="summary-sig"><span class="summary-sig-name">autoSubmitHTML</span>(<span class=summary-sig-arg>form</span>,
<span class=summary-sig-arg>title</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="fromBase64"></a><span class="summary-sig"><span class="summary-sig-name">fromBase64</span>(<span class=summary-sig-arg>s</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="openid.oidutil-module.html#log" class="summary-sig-name"><code>log</code></a>(<span class=summary-sig-arg>message</span>,
<span class=summary-sig-arg>level</span>)</span></code>
<br />
Handle a log message from the OpenID library.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="openid.oidutil-module.html#toBase64" class="summary-sig-name"><code>toBase64</code></a>(<span class=summary-sig-arg>s</span>)</span></code>
<br />
Represent string s as base64, omitting newlines</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="appendArgs"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">appendArgs</span>(<span class=sig-arg>url</span>,
<span class=sig-arg>args</span>)</span>
</h3>
Append query arguments to a HTTP(s) URL. If the URL already has
query arguemtns, these arguments will be added, and the existing
arguments will be preserved. Duplicate arguments will not be detected
or collapsed (both will appear in the output).
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>url</b></code> -
The url to which the arguments will be appended
<br /><i>
(type=str)</i>
<dd><code><b>args</b></code> -
The query arguments to add to the URL. If a dictionary is
passed, the items will be sorted before appending them to the
URL. If a sequence of pairs is passed, the order of the sequence
will be preserved.
<br /><i>
(type=A dictionary from string to string, or a sequence of
pairs of strings.)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
The URL with the parameters added
<br /><i>
(type=str)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="log"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">log</span>(<span class=sig-arg>message</span>,
<span class=sig-arg>level</span>=<span class=sig-default>0</span>)</span>
</h3>
<p>Handle a log message from the OpenID library.</p>
<p>This implementation writes the string it to <code>sys.stderr</code>,
followed by a newline.</p>
<p>Currently, the library does not use the second parameter to this
function, but that may change in the future.</p>
To install your own logging hook:
<pre class="literalblock">
from openid import oidutil
def myLoggingFunction(message, level):
...
oidutil.log = myLoggingFunction
</pre>
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>message</b></code> -
A string containing a debugging message from the OpenID
library
<br /><i>
(type=str)</i>
<dd><code><b>level</b></code> -
The severity of the log message. This parameter is currently
unused, but in the future, the library may indicate more
important information with a higher level value.
<br /><i>
(type=int or None)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
Nothing.
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="toBase64"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">toBase64</span>(<span class=sig-arg>s</span>)</span>
</h3>
Represent string s as base64, omitting newlines
<dl><dt></dt><dd>
</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>
|
