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

><a href=".">index</a> <a href="file:/home/jcgregorio/projects/apiary/oauth2client/client.py">/home/jcgregorio/projects/apiary/oauth2client/client.py</a></td></tr></table>

Joe Gregorio

6e53703

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

[diff] [blame]

12

<tt>An OAuth 2.0 client

13

14

Tools for interacting with OAuth 2.0 protected

resources.</tt>

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

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

25

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

26

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

27

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

28

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

29

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

30

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

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

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

39

</dt><dd>

40

<dl>

41

<dt><a href="oauth2client.client.html#Credentials">Credentials</a>

42

</dt><dd>

43

<dl>

44

<dt><a href="oauth2client.client.html#OAuth2Credentials">OAuth2Credentials</a>

Joe Gregorio

3b79fa8

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

[diff] [blame]

45

</dt><dd>

46

<dl>

47

<dt><a href="oauth2client.client.html#AccessTokenCredentials">AccessTokenCredentials</a>

Joe Gregorio

6e53703

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

[diff] [blame]

48

</dt></dl>

49

</dd>

Joe Gregorio

3b79fa8

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

[diff] [blame]

50

</dl>

51

</dd>

Joe Gregorio

6e53703

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

[diff] [blame]

</dt><dd>

<dl>

<dt><a href="oauth2client.client.html#OAuth2WebServerFlow">OAuth2WebServerFlow</a>

56

</dt></dl>

57

</dd>

Joe Gregorio

3b79fa8

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

[diff] [blame]

58

<dt><a href="oauth2client.client.html#Storage">Storage</a>

59

</dt></dl>

Joe Gregorio

6e53703

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

[diff] [blame]

60

</dd>

61

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

62

</dt><dd>

63

<dl>

64

<dt><a href="oauth2client.client.html#Error">Error</a>

65

</dt><dd>

66

<dl>

Joe Gregorio

3b79fa8

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

[diff] [blame]

67

<dt><a href="oauth2client.client.html#AccessTokenCredentialsError">AccessTokenCredentialsError</a>

Joe Gregorio

6e53703

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

[diff] [blame]

68

</dt><dt><a href="oauth2client.client.html#RequestError">RequestError</a>

</dt></dl>

</dd>

</dl>

</dd>

</dl>

Joe Gregorio

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

[diff] [blame]

78

<a name="AccessTokenCredentials">class AccessTokenCredentials</a>(<a href="oauth2client.client.html#OAuth2Credentials">OAuth2Credentials</a>)</td></tr>

79

80

81

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

82

83

<a href="#Credentials">Credentials</a> can be applied to an httplib2.Http <a href="__builtin__.html#object">object</a> using the <a href="#AccessTokenCredentials-authorize">authorize</a>()

84

method, which then signs each request from that <a href="__builtin__.html#object">object</a> with the OAuth 2.0

85

access token.  This set of credentials is for the use case where you have

86

acquired an OAuth 2.0 access_token from another place such as a JavaScript

87

client or another web application, and wish to use it from Python. Because

88

only the access_token is present it can not be refreshed and will in time

89

expire.

90

Joe Gregorio

fffa7d7

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

[diff] [blame]

91

<a href="#AccessTokenCredentials">AccessTokenCredentials</a> objects may be safely pickled and unpickled.

Joe Gregorio

3b79fa8

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

[diff] [blame]

92

93

Usage:

94

credentials = <a href="#AccessTokenCredentials">AccessTokenCredentials</a>('<an access token>',

95

'my-user-agent/1.0')

96

http = httplib2.Http()

97

http = credentials.<a href="#AccessTokenCredentials-authorize">authorize</a>(http)

98

99

Exceptions:

100

AccessTokenCredentialsExpired: raised when the access_token expires or is

101

revoked.  </tt></td></tr>

102

103

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

104

<dd><a href="oauth2client.client.html#AccessTokenCredentials">AccessTokenCredentials</a></dd>

105

<dd><a href="oauth2client.client.html#OAuth2Credentials">OAuth2Credentials</a></dd>

106

<dd><a href="oauth2client.client.html#Credentials">Credentials</a></dd>

107

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

108

</dl>

109

<hr>

110

Methods defined here:

111

<dl><dt><a name="AccessTokenCredentials-__init__">__init__</a>(self, access_token, user_agent)</dt><dd><tt>Create an instance of <a href="#OAuth2Credentials">OAuth2Credentials</a>

112

113

This is one of the few types if <a href="#Credentials">Credentials</a> that you should contrust,

114

<a href="#Credentials">Credentials</a> objects are usually instantiated by a <a href="#Flow">Flow</a>.

115

116

Args:

117

token_uri: string, URI of token endpoint.

118

user_agent: string, The HTTP User-Agent to provide for this application.

119

120

Notes:

121

store: callable, a callable that when passed a Credential

122

will store the credential back to where it came from.</tt></dd></dl>

123

124

<hr>

125

Methods inherited from <a href="oauth2client.client.html#OAuth2Credentials">OAuth2Credentials</a>:

126

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

127

128

<dl><dt><a name="AccessTokenCredentials-__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>

129

130

<dl><dt><a name="AccessTokenCredentials-authorize">authorize</a>(self, http)</dt><dd><tt>Authorize an httplib2.Http instance with these credentials.

131

132

Args:

133

http: An instance of httplib2.Http

134

or something that acts like it.

135

136

Returns:

137

A modified instance of http that was passed in.

Example:

h = httplib2.Http()

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

143

144

You can't create a new OAuth

145

subclass of httplib2.Authenication because

146

it never gets passed the absolute URI, which is

147

needed for signing. So instead we have to overload

148

'request' with a closure that adds in the

149

Authorization header and then calls the original version

150

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

151

152

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

153

154

Args:

155

store: callable, a callable that when passed a Credential

156

will store the credential back to where it came from.

157

This is needed to store the latest access_token if it

158

has expired and been refreshed.</tt></dd></dl>

159

160

<hr>

Joe Gregorio

9ce4b62

2011-02-17 15:32:11 -0500

[diff] [blame]

161

Data descriptors inherited from <a href="oauth2client.client.html#OAuth2Credentials">OAuth2Credentials</a>:

162

<dl><dt>invalid</dt>

163

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

164

</dl>

165

<hr>

Joe Gregorio

3b79fa8

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

[diff] [blame]

166

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

167

168

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

169

</dl>

170

<dl><dt>__weakref__</dt>

171

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

</dl>

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

<a name="AccessTokenCredentialsError">class AccessTokenCredentialsError</a>(<a href="oauth2client.client.html#Error">Error</a>)</td></tr>

178

179

180

<td colspan=2><tt>Having only the access_token means no refresh is possible.  </tt></td></tr>

181

182

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

183

<dd><a href="oauth2client.client.html#AccessTokenCredentialsError">AccessTokenCredentialsError</a></dd>

184

<dd><a href="oauth2client.client.html#Error">Error</a></dd>

185

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

186

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

187

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

188

</dl>

189

<hr>

190

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

191

<dl><dt>__weakref__</dt>

192

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

193

</dl>

194

<hr>

195

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

196

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

197

198

<hr>

199

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

200

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

201

202

<hr>

203

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

204

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

205

206

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

207

208

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

209

210

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

211

212

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

213

214

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

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

219

220

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

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

225

226

<hr>

227

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]

238

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

239

240

241

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

242

243

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

244

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

245

246

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

247

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

248

authorizes it for the set of credentials, usually by

249

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

250

the appropriate headers and then delegates to the original

251

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

252

253

<hr>

254

Data descriptors defined here:

255

256

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

257

</dl>

258

<dl><dt>__weakref__</dt>

259

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

</dl>

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

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

266

267

268

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

269

270

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

271

<dd><a href="oauth2client.client.html#Error">Error</a></dd>

272

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

273

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

274

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

275

</dl>

276

<hr>

277

Data descriptors defined here:

278

<dl><dt>__weakref__</dt>

279

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

280

</dl>

281

<hr>

282

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

283

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

284

285

<hr>

286

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

287

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

288

289

<hr>

290

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

291

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

292

293

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

294

295

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

296

297

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

298

299

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

300

301

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

306

307

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

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

312

313

<hr>

314

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

</dl>

</dl>

<dl><dt>message</dt>

</dl>

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

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

326

327

328

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

329

330

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

331

332

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

333

</dl>

334

<dl><dt>__weakref__</dt>

335

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

</dl>

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

Joe Gregorio

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

[diff] [blame]

341

<a name="OAuth2Credentials">class OAuth2Credentials</a>(<a href="oauth2client.client.html#Credentials">Credentials</a>)</td></tr>

342

343

344

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

345

Joe Gregorio

3b79fa8

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

[diff] [blame]

346

<a href="#Credentials">Credentials</a> can be applied to an httplib2.Http <a href="__builtin__.html#object">object</a> using the <a href="#OAuth2Credentials-authorize">authorize</a>()

347

method, which then signs each request from that <a href="__builtin__.html#object">object</a> with the OAuth 2.0

348

access token.

Joe Gregorio

6e53703

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

[diff] [blame]

349

350

<a href="#OAuth2Credentials">OAuth2Credentials</a> objects may be safely pickled and unpickled.  </tt></td></tr>

351

352

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

353

<dd><a href="oauth2client.client.html#OAuth2Credentials">OAuth2Credentials</a></dd>

354

<dd><a href="oauth2client.client.html#Credentials">Credentials</a></dd>

355

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

356

</dl>

357

<hr>

358

Methods defined here:

359

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

360

361

<dl><dt><a name="OAuth2Credentials-__init__">__init__</a>(self, access_token, client_id, client_secret, refresh_token, token_expiry, token_uri, user_agent)</dt><dd><tt>Create an instance of <a href="#OAuth2Credentials">OAuth2Credentials</a>

362

363

This constructor is not usually called by the user, instead

Joe Gregorio

3b79fa8

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

[diff] [blame]

364

<a href="#OAuth2Credentials">OAuth2Credentials</a> objects are instantiated by the <a href="#OAuth2WebServerFlow">OAuth2WebServerFlow</a>.

Joe Gregorio

6e53703

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

[diff] [blame]

365

366

Args:

Joe Gregorio

3b79fa8

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

[diff] [blame]

367

token_uri: string, URI of token endpoint.

368

client_id: string, client identifier.

369

client_secret: string, client secret.

370

access_token: string, access token.

371

token_expiry: datetime, when the access_token expires.

372

refresh_token: string, refresh token.

Joe Gregorio

6e53703

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

[diff] [blame]

373

user_agent: string, The HTTP User-Agent to provide for this application.

Notes:

store: callable, a callable that when passed a Credential

378

will store the credential back to where it came from.

379

This is needed to store the latest access_token if it

380

has expired and been refreshed.</tt></dd></dl>

381

382

<dl><dt><a name="OAuth2Credentials-__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>

383

Joe Gregorio

3b79fa8

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

[diff] [blame]

384

<dl><dt><a name="OAuth2Credentials-authorize">authorize</a>(self, http)</dt><dd><tt>Authorize an httplib2.Http instance with these credentials.

385

386

Args:

Joe Gregorio

6e53703

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

[diff] [blame]

387

http: An instance of httplib2.Http

388

or something that acts like it.

389

390

Returns:

391

A modified instance of http that was passed in.

Example:

h = httplib2.Http()

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

397

398

You can't create a new OAuth

399

subclass of httplib2.Authenication because

400

it never gets passed the absolute URI, which is

401

needed for signing. So instead we have to overload

402

'request' with a closure that adds in the

403

Authorization header and then calls the original version

404

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

405

406

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

407

408

Args:

409

store: callable, a callable that when passed a Credential

410

will store the credential back to where it came from.

411

This is needed to store the latest access_token if it

412

has expired and been refreshed.</tt></dd></dl>

413

414

<hr>

Joe Gregorio

9ce4b62

2011-02-17 15:32:11 -0500

[diff] [blame]

415

Data descriptors defined here:

416

<dl><dt>invalid</dt>

417

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

418

</dl>

419

<hr>

Joe Gregorio

6e53703

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

[diff] [blame]

420

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

421

422

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

423

</dl>

424

<dl><dt>__weakref__</dt>

425

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

</dl>

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

<a name="OAuth2WebServerFlow">class OAuth2WebServerFlow</a>(<a href="oauth2client.client.html#Flow">Flow</a>)</td></tr>

432

433

434

<td colspan=2><tt>Does the Web Server <a href="#Flow">Flow</a> for OAuth 2.0.

435

436

<a href="#OAuth2Credentials">OAuth2Credentials</a> objects may be safely pickled and unpickled.  </tt></td></tr>

437

438

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

439

<dd><a href="oauth2client.client.html#OAuth2WebServerFlow">OAuth2WebServerFlow</a></dd>

440

441

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

442

</dl>

443

<hr>

444

Methods defined here:

Joe Gregorio

3b79fa8

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

[diff] [blame]

445

<dl><dt><a name="OAuth2WebServerFlow-__init__">__init__</a>(self, client_id, client_secret, scope, user_agent, auth_uri='https://www.google.com/accounts/o8/oauth2/authorization', token_uri='https://www.google.com/accounts/o8/oauth2/token', **kwargs)</dt><dd><tt>Constructor for <a href="#OAuth2WebServerFlow">OAuth2WebServerFlow</a>

Joe Gregorio

6e53703

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

[diff] [blame]

446

447

Args:

Joe Gregorio

3b79fa8

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

[diff] [blame]

448

client_id: string, client identifier.

449

client_secret: string client secret.

450

scope: string, scope of the credentials being requested.

Joe Gregorio

6e53703

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

[diff] [blame]

451

user_agent: string, HTTP User-Agent to provide for this application.

Joe Gregorio

3b79fa8

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

[diff] [blame]

452

auth_uri: string, URI for authorization endpoint. For convenience

453

defaults to Google's endpoints but any OAuth 2.0 provider can be used.

454

token_uri: string, URI for token endpoint. For convenience

455

defaults to Google's endpoints but any OAuth 2.0 provider can be used.

Joe Gregorio

6e53703

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

[diff] [blame]

456

**kwargs: dict, The keyword arguments are all optional and required

457

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

458

459

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

460

461

Args:

462

redirect_uri: string, Either the string 'oob' for a non-web-based

463

application, or a URI that handles the callback from

464

the authorization server.

465

466

If redirect_uri is 'oob' then pass in the

467

generated verification code to step2_exchange,

468

otherwise pass in the query parameters received

469

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

470

471

<dl><dt><a name="OAuth2WebServerFlow-step2_exchange">step2_exchange</a>(self, code)</dt><dd><tt>Exhanges a code for <a href="#OAuth2Credentials">OAuth2Credentials</a>.

472

473

Args:

474

code: string or dict, either the code as a string, or a dictionary

475

of the query parameters to the redirect_uri, which contains

476

the code.</tt></dd></dl>

477

478

<hr>

479

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

480

481

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

482

</dl>

483

<dl><dt>__weakref__</dt>

484

<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="oauth2client.client.html#Error">Error</a>)</td></tr>

491

492

493

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

494

495

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

496

<dd><a href="oauth2client.client.html#RequestError">RequestError</a></dd>

497

<dd><a href="oauth2client.client.html#Error">Error</a></dd>

498

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

499

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

500

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

501

</dl>

502

<hr>

503

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

504

<dl><dt>__weakref__</dt>

505

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

506

</dl>

507

<hr>

508

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

509

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

510

511

<hr>

512

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

513

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

514

515

<hr>

516

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

517

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

518

519

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

520

521

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

522

523

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

524

525

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

526

527

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

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

532

533

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

534

535