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

<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>

<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/>

<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>,

<br />

Append query arguments to a HTTP(s) URL.</td></tr>

<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>

<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>

<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 />

<th colspan="2">Function Details</th></tr>

</table>

<h3><span class="sig"><span class="sig-name">appendArgs</span>(<span class=sig-arg>url</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><b>Parameters:</b></dt>

<dd><code><b>url</b></code> -

The url to which the arguments will be appended

(type=str)</i>

<dd><code><b>args</b></code> -

The query arguments to add to the URL. If a dictionary is

100

passed, the items will be sorted before appending them to the

101

URL. If a sequence of pairs is passed, the order of the sequence

102

will be preserved.

103

104

(type=A dictionary from string to string, or a sequence of

105

pairs of strings.)</i>

106

</dd>

107

</dl>

108

<dl><dt><b>Returns:</b></dt>

109

<dd>

110

The URL with the parameters added

111

112

(type=str)</i>

113

</dd>

114

</dl>

115

</dd></dl>

116

</td></tr></table>

117

118

119

120

<h3><span class="sig"><span class="sig-name">log</span>(<span class=sig-arg>message</span>,

121

<span class=sig-arg>level</span>=<span class=sig-default>0</span>)</span>

122

</h3>

123

<p>Handle a log message from the OpenID library.</p>

124

<p>This implementation writes the string it to <code>sys.stderr</code>,

125

followed by a newline.</p>

126

<p>Currently, the library does not use the second parameter to this

127

function, but that may change in the future.</p>

128

To install your own logging hook:

129

130

from openid import oidutil

131

132

def myLoggingFunction(message, level):

133

...

134

135

oidutil.log = myLoggingFunction

136

</pre>

137

138

<dl><dt><b>Parameters:</b></dt>

139

<dd><code><b>message</b></code> -

140

A string containing a debugging message from the OpenID

141

library

142

143

(type=str)</i>

144

<dd><code><b>level</b></code> -

145

The severity of the log message. This parameter is currently

146

unused, but in the future, the library may indicate more

147

important information with a higher level value.

148

149

(type=int or None)</i>

150

</dd>

151

</dl>

152

<dl><dt><b>Returns:</b></dt>

153

<dd>

154

Nothing.

155

</dd>

156

</dl>

157

</dd></dl>

158

</td></tr></table>

159

160

161

162

<h3><span class="sig"><span class="sig-name">toBase64</span>(<span class=sig-arg>s</span>)</span>

163

</h3>

164

Represent string s as base64, omitting newlines

165

166

</dd></dl>

167

</td></tr></table>

168

<br />

169

170

171

172

173

174

175

<th class="navbar">   <a class="navbar" href="trees.html">Trees</a>   </th>

176

<th class="navbar">   <a class="navbar" href="indices.html">Index</a>   </th>

177

178

179

180

181

182

<a class="navbar" target="_top" href="http://www.openidenabled.com/">Python-OpenID</a>

183

</p></th></tr></table>

184

</th>

185

</tr>

186

</table>

187

188

189

<tr>

190

<td align="left"><font size="-2">Generated by Epydoc 2.1 on Mon Sep 10 13:00:12 2007</font></td>

191

<td align="right"><a href="http://epydoc.sourceforge.net"

192

><font size="-2">http://epydoc.sf.net</font></a></td>

193

</tr>

194

</table>

195

</body>

196

</html>

Older »