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

><a href=".">index</a> <a href="file:/usr/local/google/home/jcgregorio/projects/apiclient/oauth2client/client.py">/usr/local/google/home/jcgregorio/projects/apiclient/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

91

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

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>

161

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

162

163

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

164

</dl>

165

<dl><dt>__weakref__</dt>

166

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

173

174

175

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

176

177

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

178

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

179

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

180

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

181

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

182

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

183

</dl>

184

<hr>

185

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

186

<dl><dt>__weakref__</dt>

187

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

188

</dl>

189

<hr>

190

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

191

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

192

193

<hr>

194

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

195

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

196

197

<hr>

198

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

199

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

200

201

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

202

203

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

204

205

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

206

207

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

208

209

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

214

215

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

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

220

221

<hr>

222

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]

233

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

234

235

236

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

237

238

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

239

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

240

241

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

242

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

243

authorizes it for the set of credentials, usually by

244

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

245

the appropriate headers and then delegates to the original

246

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

247

248

<hr>

249

Data descriptors defined here:

250

251

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

252

</dl>

253

<dl><dt>__weakref__</dt>

254

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

261

262

263

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

264

265

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

266

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

267

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

268

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

269

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

270

</dl>

271

<hr>

272

Data descriptors defined here:

273

<dl><dt>__weakref__</dt>

274

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

275

</dl>

276

<hr>

277

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

278

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

279

280

<hr>

281

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

282

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

283

284

<hr>

285

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

286

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

287

288

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

289

290

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

291

292

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

293

294

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

295

296

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

301

302

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

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

307

308

<hr>

309

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>

321

322

323

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

324

325

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

326

327

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

328

</dl>

329

<dl><dt>__weakref__</dt>

330

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

336

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

337

338

339

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

340

Joe Gregorio

3b79fa8

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

[diff] [blame^]

341

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

342

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

343

access token.

Joe Gregorio

6e53703

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

[diff] [blame]

344

345

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

346

347

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

348

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

349

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

350

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

351

</dl>

352

<hr>

353

Methods defined here:

354

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

355

356

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

357

358

This constructor is not usually called by the user, instead

Joe Gregorio

3b79fa8

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

[diff] [blame^]

359

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

360

361

Args:

Joe Gregorio

3b79fa8

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

[diff] [blame^]

362

token_uri: string, URI of token endpoint.

363

client_id: string, client identifier.

364

client_secret: string, client secret.

365

access_token: string, access token.

366

token_expiry: datetime, when the access_token expires.

367

refresh_token: string, refresh token.

Joe Gregorio

6e53703

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

[diff] [blame]

368

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

Notes:

store: callable, a callable that when passed a Credential

373

will store the credential back to where it came from.

374

This is needed to store the latest access_token if it

375

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

376

377

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

378

Joe Gregorio

3b79fa8

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

[diff] [blame^]

379

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

380

381

Args:

Joe Gregorio

6e53703

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

[diff] [blame]

382

http: An instance of httplib2.Http

383

or something that acts like it.

384

385

Returns:

386

A modified instance of http that was passed in.

Example:

h = httplib2.Http()

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

392

393

You can't create a new OAuth

394

subclass of httplib2.Authenication because

395

it never gets passed the absolute URI, which is

396

needed for signing. So instead we have to overload

397

'request' with a closure that adds in the

398

Authorization header and then calls the original version

399

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

400

401

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

402

403

Args:

404

store: callable, a callable that when passed a Credential

405

will store the credential back to where it came from.

406

This is needed to store the latest access_token if it

407

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

408

409

<hr>

410

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

411

412

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

413

</dl>

414

<dl><dt>__weakref__</dt>

415

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

422

423

424

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

425

426

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

427

428

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

429

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

430

431

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

432

</dl>

433

<hr>

434

Methods defined here:

Joe Gregorio

3b79fa8

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

[diff] [blame^]

435

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

436

437

Args:

Joe Gregorio

3b79fa8

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

[diff] [blame^]

438

client_id: string, client identifier.

439

client_secret: string client secret.

440

scope: string, scope of the credentials being requested.

Joe Gregorio

6e53703

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

[diff] [blame]

441

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

Joe Gregorio

3b79fa8

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

[diff] [blame^]

442

auth_uri: string, URI for authorization endpoint. For convenience

443

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

444

token_uri: string, URI for token endpoint. For convenience

445

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]

446

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

447

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

448

449

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

450

451

Args:

452

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

453

application, or a URI that handles the callback from

454

the authorization server.

455

456

If redirect_uri is 'oob' then pass in the

457

generated verification code to step2_exchange,

458

otherwise pass in the query parameters received

459

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

460

461

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

462

463

Args:

464

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

465

of the query parameters to the redirect_uri, which contains

466

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

467

468

<hr>

469

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

470

471

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

472

</dl>

473

<dl><dt>__weakref__</dt>

474

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

481

482

483

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

484

485

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

486

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

487

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

488

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

489

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

490

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

491

</dl>

492

<hr>

493

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

494

<dl><dt>__weakref__</dt>

495

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

496

</dl>

497

<hr>

498

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

499

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

500

501

<hr>

502

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

503

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

504

505

<hr>

506

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

507

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

508

509

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

510

511

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

512

513

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

514

515

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

516

517

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

522

523

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

524

525