Blame - docs/apiclient.oauth.html - platform/external/python/google-api-python-client

2010-12-09 16:34:22 -0500

[diff] [blame]

12

<tt>Utilities for OAuth.

13

14

Utilities for making it easier to work with OAuth.</tt>

<big>Modules</big></td></tr>

Joe Gregorio

2011-02-17 11:47:17 -0500

[diff] [blame]

23

<a href="httplib2.html">httplib2</a>

24

</td><td width="25%" valign=top><a href="logging.html">logging</a>

25

<a href="oauth2.html">oauth2</a>

26

</td><td width="25%" valign=top><a href="simplejson.html">simplejson</a>

27

<a href="urllib.html">urllib</a>

28

</td><td width="25%" valign=top><a href="urlparse.html">urlparse</a>

Joe Gregorio

2011-02-09 23:04:26 -0500

[diff] [blame]

29

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

Joe Gregorio

2010-12-09 16:34:22 -0500

[diff] [blame]

<big>Classes</big></td></tr>

<dt><a href="__builtin__.html#object">__builtin__.object</a>

38

</dt><dd>

39

<dl>

40

<dt><a href="apiclient.oauth.html#Credentials">Credentials</a>

41

</dt><dd>

42

<dl>

43

<dt><a href="apiclient.oauth.html#OAuthCredentials">OAuthCredentials</a>

44

</dt></dl>

45

</dd>

Joe Gregorio

2011-02-09 23:04:26 -0500

[diff] [blame]

46

47

</dt><dd>

48

<dl>

Joe Gregorio

2010-12-09 16:34:22 -0500

[diff] [blame]

49

<dt><a href="apiclient.oauth.html#FlowThreeLegged">FlowThreeLegged</a>

50

</dt></dl>

51

</dd>

Joe Gregorio

2011-02-18 17:20:39 -0500

[diff] [blame]

52

<dt><a href="apiclient.oauth.html#Storage">Storage</a>

53

</dt></dl>

Joe Gregorio

2011-02-09 23:04:26 -0500

[diff] [blame]

54

</dd>

Joe Gregorio

2010-12-09 16:34:22 -0500

[diff] [blame]

55

<dt><a href="exceptions.html#Exception">exceptions.Exception</a>(<a href="exceptions.html#BaseException">exceptions.BaseException</a>)

56

</dt><dd>

57

<dl>

58

<dt><a href="apiclient.oauth.html#Error">Error</a>

59

</dt><dd>

60

<dl>

Joe Gregorio

2011-02-18 17:20:39 -0500

[diff] [blame]

61

<dt><a href="apiclient.oauth.html#CredentialsInvalidError">CredentialsInvalidError</a>

62

</dt><dt><a href="apiclient.oauth.html#MissingParameter">MissingParameter</a>

Joe Gregorio

2010-12-09 16:34:22 -0500

[diff] [blame]

63

</dt><dt><a href="apiclient.oauth.html#RequestError">RequestError</a>

</dt></dl>

</dd>

</dl>

</dd>

</dl>

<a name="Credentials">class Credentials</a>(<a href="__builtin__.html#object">__builtin__.object</a>)</td></tr>

74

75

76

<td colspan=2><tt>Base class for all <a href="#Credentials">Credentials</a> objects.

77

78

Subclasses must define an <a href="#Credentials-authorize">authorize</a>() method

79

that applies the credentials to an HTTP transport.  </tt></td></tr>

80

81

<td width="100%">Methods defined here:

82

<dl><dt><a name="Credentials-authorize">authorize</a>(self, http)</dt><dd><tt>Take an httplib2.Http instance (or equivalent) and

83

authorizes it for the set of credentials, usually by

84

replacing http.request() with a method that adds in

85

the appropriate headers and then delegates to the original

86

Http.request() method.</tt></dd></dl>

87

88

<hr>

89

Data descriptors defined here:

90

91

<dd><tt>dictionary for instance variables (if defined)</tt></dd>

92

</dl>

93

<dl><dt>__weakref__</dt>

94

<dd><tt>list of weak references to the object (if defined)</tt></dd>

</dl>

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

Joe Gregorio

2011-02-18 17:20:39 -0500

[diff] [blame]

100

<a name="CredentialsInvalidError">class CredentialsInvalidError</a>(<a href="apiclient.oauth.html#Error">Error</a>)</td></tr>

101

102

103

<td width="100%"><dl><dt>Method resolution order:</dt>

104

<dd><a href="apiclient.oauth.html#CredentialsInvalidError">CredentialsInvalidError</a></dd>

105

<dd><a href="apiclient.oauth.html#Error">Error</a></dd>

106

<dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd>

107

<dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd>

108

<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>

109

</dl>

110

<hr>

111

Data descriptors inherited from <a href="apiclient.oauth.html#Error">Error</a>:

112

<dl><dt>__weakref__</dt>

113

<dd><tt>list of weak references to the object (if defined)</tt></dd>

114

</dl>

115

<hr>

116

Methods inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:

Joe Gregorio

2011-03-18 10:20:16 -0400

[diff] [blame]

117

<dl><dt><a name="CredentialsInvalidError-__init__">__init__</a>(...)</dt><dd><tt>x.<a href="#CredentialsInvalidError-__init__">__init__</a>(...) initializes x; see help(type(x)) for signature</tt></dd></dl>

Joe Gregorio

2011-02-18 17:20:39 -0500

[diff] [blame]

118

119

<hr>

120

Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:

121

<dl><dt>__new__ = <built-in method __new__ of type object><dd><tt>T.<a href="#CredentialsInvalidError-__new__">__new__</a>(S, ...) -> a new <a href="__builtin__.html#object">object</a> with type S, a subtype of T</tt></dl>

122

123

<hr>

124

Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:

125

<dl><dt><a name="CredentialsInvalidError-__delattr__">__delattr__</a>(...)</dt><dd><tt>x.<a href="#CredentialsInvalidError-__delattr__">__delattr__</a>('name') <==> del x.name</tt></dd></dl>

126

127

<dl><dt><a name="CredentialsInvalidError-__getattribute__">__getattribute__</a>(...)</dt><dd><tt>x.<a href="#CredentialsInvalidError-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl>

128

129

<dl><dt><a name="CredentialsInvalidError-__getitem__">__getitem__</a>(...)</dt><dd><tt>x.<a href="#CredentialsInvalidError-__getitem__">__getitem__</a>(y) <==> x[y]</tt></dd></dl>

130

131

<dl><dt><a name="CredentialsInvalidError-__getslice__">__getslice__</a>(...)</dt><dd><tt>x.<a href="#CredentialsInvalidError-__getslice__">__getslice__</a>(i, j) <==> x[i:j]

132

133

Use of negative indices is not supported.</tt></dd></dl>

134

135

<dl><dt><a name="CredentialsInvalidError-__reduce__">__reduce__</a>(...)</dt></dl>

<dl><dt><a name="CredentialsInvalidError-__setattr__">__setattr__</a>(...)</dt><dd><tt>x.<a href="#CredentialsInvalidError-__setattr__">__setattr__</a>('name', value) <==> x.name = value</tt></dd></dl>

140

141

<dl><dt><a name="CredentialsInvalidError-__setstate__">__setstate__</a>(...)</dt></dl>

<dl><dt><a name="CredentialsInvalidError-__unicode__">__unicode__</a>(...)</dt></dl>

146

147

<hr>

148

Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:

</dl>

</dl>

<dl><dt>message</dt>

</dl>

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

Joe Gregorio

2010-12-09 16:34:22 -0500

[diff] [blame]

159

<a name="Error">class Error</a>(<a href="exceptions.html#Exception">exceptions.Exception</a>)</td></tr>

160

161

162

<td colspan=2><tt>Base error for this module.  </tt></td></tr>

163

164

<td width="100%"><dl><dt>Method resolution order:</dt>

165

<dd><a href="apiclient.oauth.html#Error">Error</a></dd>

166

<dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd>

167

<dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd>

168

<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>

169

</dl>

170

<hr>

171

Data descriptors defined here:

172

<dl><dt>__weakref__</dt>

173

<dd><tt>list of weak references to the object (if defined)</tt></dd>

174

</dl>

175

<hr>

176

Methods inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:

Joe Gregorio

2011-03-18 10:20:16 -0400

[diff] [blame]

177

<dl><dt><a name="Error-__init__">__init__</a>(...)</dt><dd><tt>x.<a href="#Error-__init__">__init__</a>(...) initializes x; see help(type(x)) for signature</tt></dd></dl>

Joe Gregorio

2010-12-09 16:34:22 -0500

[diff] [blame]

178

179

<hr>

180

Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:

181

<dl><dt>__new__ = <built-in method __new__ of type object><dd><tt>T.<a href="#Error-__new__">__new__</a>(S, ...) -> a new <a href="__builtin__.html#object">object</a> with type S, a subtype of T</tt></dl>

182

183

<hr>

184

Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:

185

<dl><dt><a name="Error-__delattr__">__delattr__</a>(...)</dt><dd><tt>x.<a href="#Error-__delattr__">__delattr__</a>('name') <==> del x.name</tt></dd></dl>

186

187

<dl><dt><a name="Error-__getattribute__">__getattribute__</a>(...)</dt><dd><tt>x.<a href="#Error-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl>

188

189

<dl><dt><a name="Error-__getitem__">__getitem__</a>(...)</dt><dd><tt>x.<a href="#Error-__getitem__">__getitem__</a>(y) <==> x[y]</tt></dd></dl>

190

191

<dl><dt><a name="Error-__getslice__">__getslice__</a>(...)</dt><dd><tt>x.<a href="#Error-__getslice__">__getslice__</a>(i, j) <==> x[i:j]

192

193

Use of negative indices is not supported.</tt></dd></dl>

194

195

<dl><dt><a name="Error-__reduce__">__reduce__</a>(...)</dt></dl>

<dl><dt><a name="Error-__setattr__">__setattr__</a>(...)</dt><dd><tt>x.<a href="#Error-__setattr__">__setattr__</a>('name', value) <==> x.name = value</tt></dd></dl>

200

201

<dl><dt><a name="Error-__setstate__">__setstate__</a>(...)</dt></dl>

<dl><dt><a name="Error-__unicode__">__unicode__</a>(...)</dt></dl>

206

207

<hr>

208

Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:

</dl>

</dl>

<dl><dt>message</dt>

</dl>

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

Joe Gregorio

2011-02-09 23:04:26 -0500

[diff] [blame]

219

<a name="Flow">class Flow</a>(<a href="__builtin__.html#object">__builtin__.object</a>)</td></tr>

220

221

222

<td colspan=2><tt>Base class for all <a href="#Flow">Flow</a> objects.  </tt></td></tr>

223

224

<td width="100%">Data descriptors defined here:

225

226

<dd><tt>dictionary for instance variables (if defined)</tt></dd>

227

</dl>

228

<dl><dt>__weakref__</dt>

229

<dd><tt>list of weak references to the object (if defined)</tt></dd>

</dl>

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

<a name="FlowThreeLegged">class FlowThreeLegged</a>(<a href="apiclient.oauth.html#Flow">Flow</a>)</td></tr>

Joe Gregorio

2010-12-09 16:34:22 -0500

[diff] [blame]

236

237

238

<td colspan=2><tt>Does the Three Legged Dance for OAuth 1.0a.  </tt></td></tr>

239

Joe Gregorio

2011-02-09 23:04:26 -0500

[diff] [blame]

240

<td width="100%"><dl><dt>Method resolution order:</dt>

241

<dd><a href="apiclient.oauth.html#FlowThreeLegged">FlowThreeLegged</a></dd>

242

243

<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>

244

</dl>

245

<hr>

246

Methods defined here:

Joe Gregorio

2010-12-09 16:34:22 -0500

[diff] [blame]

247

<dl><dt><a name="FlowThreeLegged-__init__">__init__</a>(self, discovery, consumer_key, consumer_secret, user_agent, **kwargs)</dt><dd><tt>discovery       - Section of the API discovery document that describes

248

the OAuth endpoints.

249

consumer_key    - OAuth consumer key

250

consumer_secret - OAuth consumer secret

251

user_agent      - The HTTP User-Agent that identifies the application.

252

**kwargs        - The keyword arguments are all optional and required

253

parameters for the OAuth calls.</tt></dd></dl>

254

255

<dl><dt><a name="FlowThreeLegged-step1_get_authorize_url">step1_get_authorize_url</a>(self, oauth_callback='oob')</dt><dd><tt>Returns a URI to redirect to the provider.

256

257

oauth_callback - Either the string 'oob' for a non-web-based application,

258

or a URI that handles the callback from the authorization

259

server.

260

261

If oauth_callback is 'oob' then pass in the

262

generated verification code to step2_exchange,

263

otherwise pass in the query parameters received

264

at the callback uri to step2_exchange.</tt></dd></dl>

265

266

<dl><dt><a name="FlowThreeLegged-step2_exchange">step2_exchange</a>(self, verifier)</dt><dd><tt>Exhanges an authorized request token

267

for <a href="#OAuthCredentials">OAuthCredentials</a>.

268

Joe Gregorio

2011-03-18 10:20:16 -0400

[diff] [blame]

269

Args:

270

verifier: string, dict - either the verifier token, or a dictionary

Joe Gregorio

2010-12-09 16:34:22 -0500

[diff] [blame]

271

of the query parameters to the callback, which contains

Joe Gregorio

2011-03-18 10:20:16 -0400

[diff] [blame]

272

the oauth_verifier.

273

Returns:

274

The <a href="#Credentials">Credentials</a> <a href="__builtin__.html#object">object</a>.</tt></dd></dl>

Joe Gregorio

2010-12-09 16:34:22 -0500

[diff] [blame]

275

276

<hr>

Joe Gregorio

2011-02-09 23:04:26 -0500

[diff] [blame]

277

Data descriptors inherited from <a href="apiclient.oauth.html#Flow">Flow</a>:

Joe Gregorio

2010-12-09 16:34:22 -0500

[diff] [blame]

278

279

<dd><tt>dictionary for instance variables (if defined)</tt></dd>

280

</dl>

281

<dl><dt>__weakref__</dt>

282

<dd><tt>list of weak references to the object (if defined)</tt></dd>

</dl>

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

<a name="MissingParameter">class MissingParameter</a>(<a href="apiclient.oauth.html#Error">Error</a>)</td></tr>

289

290

291

<td width="100%"><dl><dt>Method resolution order:</dt>

292

<dd><a href="apiclient.oauth.html#MissingParameter">MissingParameter</a></dd>

293

<dd><a href="apiclient.oauth.html#Error">Error</a></dd>

294

<dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd>

295

<dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd>

296

<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>

297

</dl>

298

<hr>

299

Data descriptors inherited from <a href="apiclient.oauth.html#Error">Error</a>:

300

<dl><dt>__weakref__</dt>

301

<dd><tt>list of weak references to the object (if defined)</tt></dd>

302

</dl>

303

<hr>

304

Methods inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:

Joe Gregorio

2011-03-18 10:20:16 -0400

[diff] [blame]

305

<dl><dt><a name="MissingParameter-__init__">__init__</a>(...)</dt><dd><tt>x.<a href="#MissingParameter-__init__">__init__</a>(...) initializes x; see help(type(x)) for signature</tt></dd></dl>

Joe Gregorio

2010-12-09 16:34:22 -0500

[diff] [blame]

306

307

<hr>

308

Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:

309

<dl><dt>__new__ = <built-in method __new__ of type object><dd><tt>T.<a href="#MissingParameter-__new__">__new__</a>(S, ...) -> a new <a href="__builtin__.html#object">object</a> with type S, a subtype of T</tt></dl>

310

311

<hr>

312

Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:

313

<dl><dt><a name="MissingParameter-__delattr__">__delattr__</a>(...)</dt><dd><tt>x.<a href="#MissingParameter-__delattr__">__delattr__</a>('name') <==> del x.name</tt></dd></dl>

314

315

<dl><dt><a name="MissingParameter-__getattribute__">__getattribute__</a>(...)</dt><dd><tt>x.<a href="#MissingParameter-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl>

316

317

<dl><dt><a name="MissingParameter-__getitem__">__getitem__</a>(...)</dt><dd><tt>x.<a href="#MissingParameter-__getitem__">__getitem__</a>(y) <==> x[y]</tt></dd></dl>

318

319

<dl><dt><a name="MissingParameter-__getslice__">__getslice__</a>(...)</dt><dd><tt>x.<a href="#MissingParameter-__getslice__">__getslice__</a>(i, j) <==> x[i:j]

320

321

Use of negative indices is not supported.</tt></dd></dl>

322

323

<dl><dt><a name="MissingParameter-__reduce__">__reduce__</a>(...)</dt></dl>

<dl><dt><a name="MissingParameter-__setattr__">__setattr__</a>(...)</dt><dd><tt>x.<a href="#MissingParameter-__setattr__">__setattr__</a>('name', value) <==> x.name = value</tt></dd></dl>

328

329

<dl><dt><a name="MissingParameter-__setstate__">__setstate__</a>(...)</dt></dl>

<dl><dt><a name="MissingParameter-__unicode__">__unicode__</a>(...)</dt></dl>

334

335

<hr>

336

Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:

</dl>

</dl>

<dl><dt>message</dt>

</dl>

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

<a name="OAuthCredentials">class OAuthCredentials</a>(<a href="apiclient.oauth.html#Credentials">Credentials</a>)</td></tr>

348

349

350

<td colspan=2><tt><a href="#Credentials">Credentials</a> <a href="__builtin__.html#object">object</a> for OAuth 1.0a  </tt></td></tr>

351

352

<td width="100%"><dl><dt>Method resolution order:</dt>

353

<dd><a href="apiclient.oauth.html#OAuthCredentials">OAuthCredentials</a></dd>

354

<dd><a href="apiclient.oauth.html#Credentials">Credentials</a></dd>

355

<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>

356

</dl>

357

<hr>

358

Methods defined here:

Joe Gregorio

2011-02-18 17:20:39 -0500

[diff] [blame]

359

<dl><dt><a name="OAuthCredentials-__getstate__">__getstate__</a>(self)</dt><dd><tt>Trim the state down to something that can be pickled.</tt></dd></dl>

360

Joe Gregorio

2010-12-09 16:34:22 -0500

[diff] [blame]

361

<dl><dt><a name="OAuthCredentials-__init__">__init__</a>(self, consumer, token, user_agent)</dt><dd><tt>consumer   - An instance of oauth.Consumer.

362

token      - An instance of oauth.Token constructed with

363

the access token and secret.

364

user_agent - The HTTP User-Agent to provide for this application.</tt></dd></dl>

365

Joe Gregorio

2011-02-18 17:20:39 -0500

[diff] [blame]

366

<dl><dt><a name="OAuthCredentials-__setstate__">__setstate__</a>(self, state)</dt><dd><tt>Reconstitute the state of the <a href="__builtin__.html#object">object</a> from being pickled.</tt></dd></dl>

367

Joe Gregorio

2010-12-09 16:34:22 -0500

[diff] [blame]

368

<dl><dt><a name="OAuthCredentials-authorize">authorize</a>(self, http)</dt><dd><tt>Args:

369

http - An instance of httplib2.Http

370

or something that acts like it.

371

372

Returns:

373

A modified instance of http that was passed in.

Example:

h = httplib2.Http()

h = credentials.<a href="#OAuthCredentials-authorize">authorize</a>(h)

379

380

You can't create a new OAuth

381

subclass of httplib2.Authenication because

382

it never gets passed the absolute URI, which is

383

needed for signing. So instead we have to overload

384

'request' with a closure that adds in the

385

Authorization header and then calls the original version

386

of 'request()'.</tt></dd></dl>

387

Joe Gregorio

2011-02-18 17:20:39 -0500

[diff] [blame]

388

<dl><dt><a name="OAuthCredentials-set_store">set_store</a>(self, store)</dt><dd><tt>Set the storage for the credential.

389

390

Args:

391

store: callable, a callable that when passed a Credential

392

will store the credential back to where it came from.

393

This is needed to store the latest access_token if it

394

has been revoked.</tt></dd></dl>

395

396

<hr>

397

Data descriptors defined here:

398

<dl><dt>invalid</dt>

399

<dd><tt>True if the credentials are invalid, such as being revoked.</tt></dd>

400

</dl>

Joe Gregorio

2010-12-09 16:34:22 -0500

[diff] [blame]

401

<hr>

402

Data descriptors inherited from <a href="apiclient.oauth.html#Credentials">Credentials</a>:

403

404

<dd><tt>dictionary for instance variables (if defined)</tt></dd>

405

</dl>

406

<dl><dt>__weakref__</dt>

407

<dd><tt>list of weak references to the object (if defined)</tt></dd>

</dl>

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

<a name="RequestError">class RequestError</a>(<a href="apiclient.oauth.html#Error">Error</a>)</td></tr>

414

415

416

<td colspan=2><tt><a href="#Error">Error</a> occurred during request.  </tt></td></tr>

417

418

<td width="100%"><dl><dt>Method resolution order:</dt>

419

<dd><a href="apiclient.oauth.html#RequestError">RequestError</a></dd>

420

<dd><a href="apiclient.oauth.html#Error">Error</a></dd>

421

<dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd>

422

<dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd>

423

<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>

424

</dl>

425

<hr>

426

Data descriptors inherited from <a href="apiclient.oauth.html#Error">Error</a>:

427

<dl><dt>__weakref__</dt>

428

<dd><tt>list of weak references to the object (if defined)</tt></dd>

429

</dl>

430

<hr>

431

Methods inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:

Joe Gregorio

2011-03-18 10:20:16 -0400

[diff] [blame]

432

<dl><dt><a name="RequestError-__init__">__init__</a>(...)</dt><dd><tt>x.<a href="#RequestError-__init__">__init__</a>(...) initializes x; see help(type(x)) for signature</tt></dd></dl>

Joe Gregorio