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

</table></td>

</tr></table>

<h2 class="class">Type SRegResponse</h2>

<a href="__builtin__.object-class.html"><code>object</code></a> --+

<a href="openid.extension.Extension-class.html"><code>Extension</code></a> --+

<b>SRegResponse</b>

</pre><br />

<hr/>

Represents the data returned in a simple registration response inside

of an OpenID <code>id_res</code> response. This object will be created by

the OpenID server, added to the <code>id_res</code> response object, and

then extracted from the <code>id_res</code> message by the Consumer.

<hr/>

<th colspan="2">Method Summary</th></tr>

<td><code><a name="__init__"></a><span class="summary-sig"><span class="summary-sig-name">__init__</span>(<span class=summary-sig-arg>self</span>,

<span class=summary-sig-arg>data</span>,

</td></tr>

<td><code><a name="__contains__"></a><span class="summary-sig"><span class="summary-sig-name">__contains__</span>(<span class=summary-sig-arg>self</span>,

<span class=summary-sig-arg>field_name</span>)</span></code>

</td></tr>

<td><code><a name="__nonzero__"></a><span class="summary-sig"><span class="summary-sig-name">__nonzero__</span>(<span class=summary-sig-arg>self</span>)</span></code>

</td></tr>

<td><code><span class="summary-sig"><a href="openid.sreg.SRegResponse-class.html#getExtensionArgs" class="summary-sig-name"><code>getExtensionArgs</code></a>(<span class=summary-sig-arg>self</span>)</span></code>

<br />

Get the fields to put in the simple registration namespace when adding

them to an id_res message.</td></tr>

<b>Inherited from <a href="openid.extension.Extension-class.html"><code>Extension</code></a>:</b>

<a href="openid.extension.Extension-class.html#toMessage"><code>toMessage</code></a>

<br />

<b>Inherited from <a href="__builtin__.object-class.html"><code>object</code></a>:</b>

<a href="__builtin__.object-class.html#__delattr__"><code>__delattr__</code></a>,

<a href="__builtin__.object-class.html#__getattribute__"><code>__getattribute__</code></a>,

<a href="__builtin__.object-class.html#__hash__"><code>__hash__</code></a>,

<a href="__builtin__.object-class.html#__new__"><code>__new__</code></a>,

<a href="__builtin__.object-class.html#__reduce__"><code>__reduce__</code></a>,

<a href="__builtin__.object-class.html#__reduce_ex__"><code>__reduce_ex__</code></a>,

<a href="__builtin__.object-class.html#__repr__"><code>__repr__</code></a>,

<a href="__builtin__.object-class.html#__setattr__"><code>__setattr__</code></a>,

</td></tr>

<th colspan="2">    Server</th></tr>

100

<tr><td align="right" valign="top" width="15%"><font size="-1"> SRegResponse

101

</font></td>

102

<td><code><span class="summary-sig"><a href="openid.sreg.SRegResponse-class.html#extractResponse" class="summary-sig-name"><code>extractResponse</code></a>(<span class=summary-sig-arg>cls</span>,

103

<span class=summary-sig-arg>request</span>,

104

105

<br />

106

Take a <code><a href="openid.sreg.SRegRequest-class.html"

107

class="link"><code>SRegRequest</code></a></code> and a dictionary of

108

simple registration values and create a <code><a

109

href="openid.sreg.SRegResponse-class.html"

110

class="link"><code>SRegResponse</code></a></code> object containing that

111

data. <i>(Class method)</i>

112

</td></tr>

113

114

<th colspan="2">    Consumer</th></tr>

115

<tr><td align="right" valign="top" width="15%"><font size="-1"> SRegResponse

116

</font></td>

117

<td><code><span class="summary-sig"><a href="openid.sreg.SRegResponse-class.html#fromSuccessResponse" class="summary-sig-name"><code>fromSuccessResponse</code></a>(<span class=summary-sig-arg>cls</span>,

118

<span class=summary-sig-arg>success_response</span>,

119

<span class=summary-sig-arg>signed_only</span>)</span></code>

120

<br />

121

Create a <code><a href="openid.sreg.SRegResponse-class.html"

122

class="link"><code>SRegResponse</code></a></code> object from a

123

successful OpenID library response (<code><a

124

href="openid.consumer.consumer.SuccessResponse-class.html"

125

class="link"><code>openid.consumer.consumer.SuccessResponse</code></a></code>)

126

response message <i>(Class method)</i>

127

</td></tr>

128

129

<th colspan="2">    Read-only dictionary interface</th></tr>

130

131

132

</td></tr>

133

134

<td><code><a name="iterkeys"></a><span class="summary-sig"><span class="summary-sig-name">iterkeys</span>(<span class=summary-sig-arg>self</span>)</span></code>

135

</td></tr>

136

137

<td><code><span class="summary-sig"><a href="openid.sreg.SRegResponse-class.html#items" class="summary-sig-name"><code>items</code></a>(<span class=summary-sig-arg>self</span>)</span></code>

138

<br />

139

All of the data values in this simple registration response</td></tr>

140

141

<td><code><a name="iteritems"></a><span class="summary-sig"><span class="summary-sig-name">iteritems</span>(<span class=summary-sig-arg>self</span>)</span></code>

142

</td></tr>

143

144

145

</td></tr>

146

147

<td><code><span class="summary-sig"><a href="openid.sreg.SRegResponse-class.html#get" class="summary-sig-name"><code>get</code></a>(<span class=summary-sig-arg>self</span>,

148

<span class=summary-sig-arg>field_name</span>,

149

<span class=summary-sig-arg>default</span>)</span></code>

150

<br />

151

Like dict.get, except that it checks that the field name is defined by

152

the simple registration specification</td></tr>

153

154

<td><code><a name="__getitem__"></a><span class="summary-sig"><span class="summary-sig-name">__getitem__</span>(<span class=summary-sig-arg>self</span>,

155

<span class=summary-sig-arg>field_name</span>)</span></code>

156

</td></tr>

157

158

<td><code><a name="has_key"></a><span class="summary-sig"><span class="summary-sig-name">has_key</span>(<span class=summary-sig-arg>self</span>,

159

160

</td></tr>

161

</table><br />

162

163

164

165

166

167

<th colspan="2">Instance Variable Summary</th></tr>

168

169

<td><b><a href="openid.sreg.SRegResponse-class.html#data"><code>data</code></a></b>: The simple registration data, keyed by the unqualified simple

170

registration name of the field (i.e.</td></tr>

171

172

<td><b><a href="openid.sreg.SRegResponse-class.html#ns_uri"><code>ns_uri</code></a></b>: The URI under which the simple registration data was stored in the

173

response message.</td></tr>

174

</table><br />

175

176

177

178

179

180

<th colspan="2">Class Variable Summary</th></tr>

181

182

<td><b><a href="openid.sreg.SRegResponse-class.html#ns_alias"><code>ns_alias</code></a></b> = <span title="'sreg'"><code><span class="variable-quote">'</span>sreg<span class="variable-quote">'</span> </code>

183

</span></td></tr>

184

</table><br />

185

186

187

188

189

190

<th colspan="2">Instance Method Details</th></tr>

191

</table>

192

193

194

195

<h3><span class="sig"><span class="sig-name">items</span>(<span class=sig-arg>self</span>)</span>

196

</h3>

197

All of the data values in this simple registration response

198

199

</dd></dl>

200

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

201

202

203

204

<h3><span class="sig"><span class="sig-name">get</span>(<span class=sig-arg>self</span>,

205

<span class=sig-arg>field_name</span>,

206

<span class=sig-arg>default</span>=<span class=sig-default>None</span>)</span>

207

</h3>

208

Like dict.get, except that it checks that the field name is defined

209

by the simple registration specification

210

211

</dd></dl>

212

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

213

214

215

216

<h3><span class="sig"><span class="sig-name">getExtensionArgs</span>(<span class=sig-arg>self</span>)</span>

217

</h3>

218

Get the fields to put in the simple registration namespace when

219

adding them to an id_res message.

220

221

<dl><dt><b>Overrides:</b></dt>

222

<dd><a href="openid.extension.Extension-class.html#getExtensionArgs"><code>openid.extension.Extension.getExtensionArgs</code></a></dd>

223

</dl>

224

<p><b>See Also:</b> openid.extension

225

</p>

226

227

</dd></dl>

228

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

229

<br />

230

231

232

233

234

235

<th colspan="2">Class Method Details</th></tr>

236

</table>

237

238

239

240

<h3><span class="sig"><span class="sig-name">extractResponse</span>(<span class=sig-arg>cls</span>,

241

<span class=sig-arg>request</span>,

242

243

</h3>

244

Take a <code><a href="openid.sreg.SRegRequest-class.html"

245

class="link"><code>SRegRequest</code></a></code> and a dictionary of

246

simple registration values and create a <code><a

247

href="openid.sreg.SRegResponse-class.html"

248

class="link"><code>SRegResponse</code></a></code> object containing

249

that data.

250

251

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

252

<dd><code><b>request</b></code> -

253

The simple registration request object

254

255

(type=SRegRequest)</i>

256

<dd><code><b>data</b></code> -

257

The simple registration data for this response, as a

258

dictionary from unqualified simple registration field name to

259

string (unicode) value. For instance, the nickname should be

260

stored under the key 'nickname'.

261

262

(type={str:str})</i>

263

</dd>

264

</dl>

265

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

266

<dd>

267

a simple registration response object

268

269

(type=SRegResponse)</i>

270

</dd>

271

</dl>

272

</dd></dl>

273

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

274

275

276

277

<h3><span class="sig"><span class="sig-name">fromSuccessResponse</span>(<span class=sig-arg>cls</span>,

278

<span class=sig-arg>success_response</span>,

279

<span class=sig-arg>signed_only</span>=<span class=sig-default>True</span>)</span>

280

</h3>

281

Create a <code><a href="openid.sreg.SRegResponse-class.html"

282

class="link"><code>SRegResponse</code></a></code> object from a

283

successful OpenID library response (<code><a

284

href="openid.consumer.consumer.SuccessResponse-class.html"

285

class="link"><code>openid.consumer.consumer.SuccessResponse</code></a></code>)

286

response message

287

288

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

289

<dd><code><b>success_response</b></code> -

290

A SuccessResponse from consumer.complete()

291

292

(type=<code><a

293

href="openid.consumer.consumer.SuccessResponse-class.html"

294

class="link"><code>openid.consumer.consumer.SuccessResponse</code></a></code>)</i>

295

<dd><code><b>signed_only</b></code> -

296

Whether to process only data that was signed in the id_res

297

message from the server.

298

299

(type=bool)</i>

300

</dd>

301

</dl>

302

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

303

<dd>

304

A simple registration response containing the data that was

305

supplied with the <code>id_res</code> response.

306

307

(type=SRegResponse)</i>

308

</dd>

309

</dl>

310

</dd></dl>

311

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

312

<br />

313

314

315

316

317

318

<th colspan="2">Instance Variable Details</th></tr>

319

</table>

320

321

322

323

The simple registration data, keyed by the unqualified simple

324

registration name of the field (i.e. nickname is keyed by

325

<code>'nickname'</code>)

326

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

327

328

329

330

The URI under which the simple registration data was stored in the

331

response message.

332

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

333

<br />

334

335

336

337

338

339

<th colspan="2">Class Variable Details</th></tr>

340

</table>

341

342

343

<h3>ns_alias</h3>

344

<dl>

345

346

<dd>

347

<dl>

348

349

<dd>

350

351

352

</dd>

353

<span title="'sreg'"> <dt><b>Value:</b></dt>

354

355

356

357

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

358

</span> </dl>

359

</dd>

360

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

361

<br />

362

363

364

365

366

367

368

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

369

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

370

371

372

373

374

375

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

376

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

377

</th>

378

</tr>

379

</table>

380

381

382

<tr>

383

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

384

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

385

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

386

</tr>

387

</table>

388

</body>

389

</html>

Older »