~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="help.html" target="_top">no frames</a>]</font></td></tr>

</table></td>

</tr></table>

<h1 class="epydoc"> API Documentation </h1>

<center><h2> API Documentation </h2></center>

<p> This document contains the API (Application Programming Interface)

documentation for Python-OpenID. Documentation for the Python

<h2> Object Documentation </h2>

<p>Each <strong>Package Documentation</strong> page contains: </p>

<p>Each <b>Package Documentation</b> page contains:

<ul>

<li> A description of the package. </li>

<li> A list of the modules and sub-packages contained by the

package. </li>

<li> A detailed description of each variable defined by the

package. </li>

</ul>

</ul></p>

<p>Each <strong>Module Documentation</strong> page contains:</p>

<p>Each <b>Module Documentation</b> page contains:

<ul>

<li> A description of the module. </li>

<li> A summary of the classes defined by the module. </li>

module. </li>

<li> A detailed description of each variable defined by the

module. </li>

</ul>

</ul></p>

<p>Each <strong>Class Documentation</strong> page contains: </p>

<p>Each <b>Class Documentation</b> page contains:

<ul>

<li> A class inheritance diagram. </li>

<li> A list of known subclasses. </li>

105

class. </li>

106

<li> A detailed description of each class (static) variable defined

107

by the class. </li>

108

</ul>

</ul></p>

109

110

<h2> Project Documentation </h2>

111

112

<p> The <strong>Trees</strong> page contains the module and class hierarchies: </p>

<p> The <b>Trees</b> page contains the module and class hierarchies:

113

<ul>

114

<li> The <em>module hierarchy</em> lists every package and module, with

<li> The <i>module hierarchy</i> lists every package and module, with

115

modules grouped into packages. At the top level, and within each

116

package, modules and sub-packages are listed alphabetically. </li>

117

<li> The <em>class hierarchy</em> lists every class, grouped by base

<li> The <i>class hierarchy</i> lists every class, grouped by base

118

class. If a class has more than one base class, then it will be

119

100

listed under each base class. At the top level, and under each base

120

101

class, classes are listed alphabetically. </li>

121

</ul>

102

</ul></p>

122

103

123

<p> The <strong>Index</strong> page contains indices of terms and

124

identifiers: </p>

104

<p> The <b>Index</b> page contains indices of terms and

105

identifiers:

125

106

<ul>

126

<li> The <em>term index</em> lists every term indexed by any object's

107

<li> The <i>term index</i> lists every term indexed by any object's

127

108

documentation. For each term, the index provides links to each

128

109

place where the term is indexed. </li>

129

<li> The <em>identifier index</em> lists the (short) name of every package,

110

<li> The <i>identifier index</i> lists the (short) name of every package,

130

111

module, class, method, function, variable, and parameter. For each

131

112

identifier, the index provides a short description, and a link to

132

113

its documentation. </li>

133

</ul>

114

</ul></p>

134

115

135

116

<h2> The Table of Contents </h2>

136

117

137

118

<p> The table of contents occupies the two frames on the left side of

138

the window. The upper-left frame displays the <em>project

139

contents</em>, and the lower-left frame displays the <em>module

140

contents</em>: </p>

119

the window. The upper-left frame displays the <i>project

120

contents</i>, and the lower-left frame displays the <i>module

121

contents</i>: </p>

141

122

142

143

144

145

Project<br />Contents<hr />...</td>

146

147

API<br />Documentation<br />Frame<br /><br /><br />

123

124

125

126

127

<font size="-1">Project<br>Contents<hr>...</font></td>

128

129

API<br>Documentation<br>Frame<br><br><br>

148

130

</td>

149

131

</tr>

150

132

<tr>

151

152

Module<br />Contents<hr /> <br />...<br /> 

133

134

<font size="-1">Module<br>Contents<hr> <br>...<br> </font>

153

135

</td>

154

136

</tr>

155

</table><br />

137

</table><br>

138

</center>

156

139

157

<p> The <strong>project contents frame</strong> contains a list of all packages

140

<p> The <b>project contents frame</b> contains a list of all packages

158

141

and modules that are defined by the project. Clicking on an entry

159

142

will display its contents in the module contents frame. Clicking on a

160

143

special entry, labeled "Everything," will display the contents of

161

144

the entire project. </p>

162

145

163

<p> The <strong>module contents frame</strong> contains a list of every

146

<p> The <b>module contents frame</b> contains a list of every

164

147

submodule, class, type, exception, function, and variable defined by a

165

148

module or package. Clicking on an entry will display its

166

149

documentation in the API documentation frame. Clicking on the name of

167

150

the module, at the top of the frame, will display the documentation

168

151

for the module itself. </p>

169

152

170

<p> The "<strong>frames</strong>" and "<strong>no frames</strong>" buttons below the top

153

<p> The "<b>frames</b>" and "<b>no frames</b>" buttons below the top

171

154

navigation bar can be used to control whether the table of contents is

172

155

displayed or not. </p>

173

156

185

168

<th>Highlighted when...</th>

186

169

<th>Links to...</th>

187

170

</tr>

188

<tr><td valign="top"><strong>[Parent]</strong></td>

189

<td valign="top"><em>(never highlighted)</em></td>

171

<tr><td valign="top"><b>[Parent]</b></td>

172

<td valign="top"><i>(never highlighted)</i></td>

190

173

<td valign="top"> the parent of the current package </td></tr>

191

<tr><td valign="top"><strong>[Package]</strong></td>

174

<tr><td valign="top"><b>[Package]</b></td>

192

175

<td valign="top">viewing a package</td>

193

176

<td valign="top">the package containing the current object

194

177

</td></tr>

195

<tr><td valign="top"><strong>[Module]</strong></td>

178

<tr><td valign="top"><b>[Module]</b></td>

196

179

<td valign="top">viewing a module</td>

197

180

<td valign="top">the module containing the current object

198

181

</td></tr>

199

<tr><td valign="top"><strong>[Class]</strong></td>

182

<tr><td valign="top"><b>[Class]</b></td>

200

183

<td valign="top">viewing a class </td>

201

184

<td valign="top">the class containing the current object</td></tr>

202

<tr><td valign="top"><strong>[Trees]</strong></td>

185

<tr><td valign="top"><b>[Trees]</b></td>

203

186

<td valign="top">viewing the trees page</td>

204

187

<td valign="top"> the trees page </td></tr>

205

<tr><td valign="top"><strong>[Index]</strong></td>

188

<tr><td valign="top"><b>[Index]</b></td>

206

189

<td valign="top">viewing the index page</td>

207

190

<td valign="top"> the index page </td></tr>

208

191

209

192

<td valign="top">viewing the help page</td>

210

193

211

194

</table>

212

195

213

<p> The "<strong>show private</strong>" and "<strong>hide private</strong>" buttons below

196

<p> The "<b>show private</b>" and "<b>hide private</b>" buttons below

214

197

the top navigation bar can be used to control whether documentation

215

198

for private objects is displayed. Private objects are usually defined

216

199

as objects whose (short) names begin with a single underscore, but do

223

206

224

207

<p> A timestamp below the bottom navigation bar indicates when each

225

208

page was last updated. </p>

226

227

<table class="navbar" border="0" width="100%" cellpadding="0"

228

bgcolor="#a0c0ff" cellspacing="0">

229

230

231

<th>   <a

232

href="openid-module.html">Home</a>   </th>

233

234

235

<th>   <a

236

href="module-tree.html">Trees</a>   </th>

237

238

239

<th>   <a

240

href="identifier-index.html">Indices</a>   </th>

241

242

243

<th bgcolor="#70b0f0" class="navbar-select"

244

>   Help   </th>

245

246

247

248

249

<tr><th class="navbar" align="center"

250

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

251

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

209

210

211

212

213

214

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

215

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

216

217

218

219

220

221

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

222

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

223

</th>

252

224

</tr>

253

225

</table>

254

226

227

255

228

<tr>

256

<td align="left" class="footer">Generated by Epydoc

257

3.0alpha3 on Fri Dec 8 13:26:20 2006</td>

258

259

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

260

</td>

229

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

230

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

231

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

261

232

</tr>

262

233

</table>

263

264

265

<!--

266

// Private objects are initially displayed (because if

267

// javascript is turned off then we want them to be

268

// visible); but by default, we want to hide them. So hide

269

// them unless we have a cookie that says to show them.

270

checkCookie()

271

// -->

272

</script>

273

274

234

</body>

275

235

</html>

Older »