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

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

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

b9e63ff

2011-06-30 12:38:10 -0400

[diff] [blame]

48

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

Joe Gregorio

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

[diff] [blame]

49

</dt></dl>

50

</dd>

Joe Gregorio

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

[diff] [blame]

51

</dl>

52

</dd>

Joe Gregorio

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

[diff] [blame]

</dt><dd>

<dl>

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

57

</dt></dl>

58

</dd>

Joe Gregorio

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

[diff] [blame]

59

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

60

</dt></dl>

Joe Gregorio

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

[diff] [blame]

61

</dd>

62

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

63

</dt><dd>

64

<dl>

65

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

66

</dt><dd>

67

<dl>

Joe Gregorio

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

[diff] [blame]

68

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

Joe Gregorio

2011-02-19 14:51:56 -0500

[diff] [blame]

69

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

70

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

Joe Gregorio

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

[diff] [blame]

</dt></dl>

</dd>

</dl>

</dd>

</dl>

Joe Gregorio

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

[diff] [blame]

80

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

81

82

83

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

84

85

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

86

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

87

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

88

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

89

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

90

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

91

expire.

92

Joe Gregorio

fffa7d7

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

[diff] [blame]

93

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

Joe Gregorio

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

[diff] [blame]

94

95

Usage:

96

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

97

'my-user-agent/1.0')

98

http = httplib2.Http()

99

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

100

101

Exceptions:

102

AccessTokenCredentialsExpired: raised when the access_token expires or is

103

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

104

105

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

106

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

107

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

108

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

109

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

110

</dl>

111

<hr>

112

Methods defined here:

113

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

114

115

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

116

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

117

118

Args:

Joe Gregorio

9384170

2011-03-02 16:12:05 -0800

[diff] [blame]

119

access_token: string, access token.

Joe Gregorio

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

[diff] [blame]

120

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

121

122

Notes:

123

store: callable, a callable that when passed a Credential

124

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

125

126

<hr>

127

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

128

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

129

130

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

131

132

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

133

134

Args:

135

http: An instance of httplib2.Http

136

or something that acts like it.

137

138

Returns:

139

A modified instance of http that was passed in.

Example:

h = httplib2.Http()

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

145

146

You can't create a new OAuth

147

subclass of httplib2.Authenication because

148

it never gets passed the absolute URI, which is

149

needed for signing. So instead we have to overload

150

'request' with a closure that adds in the

151

Authorization header and then calls the original version

152

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

153

154

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

155

156

Args:

157

store: callable, a callable that when passed a Credential

158

will store the credential back to where it came from.

159

This is needed to store the latest access_token if it

160

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

161

162

<hr>

Joe Gregorio

9ce4b62

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

[diff] [blame]

163

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

164

<dl><dt>invalid</dt>

165

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

166

</dl>

167

<hr>

Joe Gregorio

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

[diff] [blame]

168

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

169

170

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

171

</dl>

172

<dl><dt>__weakref__</dt>

173

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

180

181

182

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

183

184

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

185

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

186

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

187

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

188

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

189

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

190

</dl>

191

<hr>

192

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

193

<dl><dt>__weakref__</dt>

194

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

195

</dl>

196

<hr>

197

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

Joe Gregorio

2011-07-06 10:09:20 -0400

[diff] [blame]

198

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

Joe Gregorio

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

[diff] [blame]

199

200

<hr>

201

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

202

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

203

204

<hr>

205

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

206

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

207

208

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

209

210

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

211

212

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

213

214

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

215

216

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

221

222

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

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

227

228

<hr>

229

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-19 14:51:56 -0500

[diff] [blame]

240

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

241

242

Joe Gregorio

ad258e2

2011-02-22 22:53:30 -0500

[diff] [blame]

243

<td colspan=2><tt><a href="#Error">Error</a> trying to refresh an expired access token.  </tt></td></tr>

Joe Gregorio

2011-02-19 14:51:56 -0500

[diff] [blame]

244

245

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

246

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

247

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

248

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

249

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

250

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

251

</dl>

252

<hr>

253

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

254

<dl><dt>__weakref__</dt>

255

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

256

</dl>

257

<hr>

258

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

Joe Gregorio

2011-07-06 10:09:20 -0400

[diff] [blame]

259

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

Joe Gregorio

2011-02-19 14:51:56 -0500

[diff] [blame]

260

261

<hr>

262

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

263

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

264

265

<hr>

266

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

267

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

268

269

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

270

271

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

272

273

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

274

275

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

276

277

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

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

282

283

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

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

288

289

<hr>

290

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-06-30 12:38:10 -0400

[diff] [blame]

301

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

302

303

304

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

305

306

This credential does not require a flow to instantiate because it represents

307

a two legged flow, and therefore has all of the required information to

308

generate and refresh its own access tokens.  It must be subclassed to

309

generate the appropriate assertion string.

310

311

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

312

313

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

314

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

315

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

316

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

317

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

318

</dl>

319

<hr>

320

Methods defined here:

321

<dl><dt><a name="AssertionCredentials-__init__">__init__</a>(self, assertion_type, user_agent, token_uri='https://accounts.google.com/o/oauth2/token', **kwargs)</dt><dd><tt>Constructor for AssertionFlowCredentials

322

323

Args:

324

assertion_type: string, assertion type that will be declared to the auth

325

server

326

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

327

token_uri: string, URI for token endpoint. For convenience

328

defaults to Google's endpoints but any OAuth 2.0 provider can be used.</tt></dd></dl>

329

330

<hr>

331

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

332

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

333

334

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

335

336

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

337

338

Args:

339

http: An instance of httplib2.Http

340

or something that acts like it.

341

342

Returns:

343

A modified instance of http that was passed in.

Example:

h = httplib2.Http()

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

349

350

You can't create a new OAuth

351

subclass of httplib2.Authenication because

352

it never gets passed the absolute URI, which is

353

needed for signing. So instead we have to overload

354

'request' with a closure that adds in the

355

Authorization header and then calls the original version

356

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

357

358

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

359

360

Args:

361

store: callable, a callable that when passed a Credential

362

will store the credential back to where it came from.

363

This is needed to store the latest access_token if it

364

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

365

366

<hr>

367

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

368

<dl><dt>invalid</dt>

369

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

370

</dl>

371

<hr>

372

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

373

374

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

375

</dl>

376

<dl><dt>__weakref__</dt>

377

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

383

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

384

385

386

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

387

388

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

389

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

390

391

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

392

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

393

authorizes it for the set of credentials, usually by

394

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

395

the appropriate headers and then delegates to the original

396

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

397

398

<hr>

399

Data descriptors defined here:

400

401

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

402

</dl>

403

<dl><dt>__weakref__</dt>

404

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

411

412

413

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

414

415

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

416

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

417

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

418

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

419

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

420

</dl>

421

<hr>

422

Data descriptors defined here:

423

<dl><dt>__weakref__</dt>

424

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

425

</dl>

426

<hr>

427

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

Joe Gregorio

2011-07-06 10:09:20 -0400

[diff] [blame]

428

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

Joe Gregorio

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

[diff] [blame]

429

430

<hr>

431

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

432

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

433

434

<hr>

435

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

436

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

437

438

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

439

440

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

441

442

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

443

444

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

445

446

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

451

452

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

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

457

458

<hr>

459

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>

471

472

473

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

474

475

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

476

477

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

478

</dl>

479

<dl><dt>__weakref__</dt>

480

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

</dl>

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

Joe Gregorio

2011-02-19 14:51:56 -0500

[diff] [blame]

486

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

487

488

Joe Gregorio

ad258e2

2011-02-22 22:53:30 -0500

[diff] [blame]

489

<td colspan=2><tt><a href="#Error">Error</a> trying to exchange an authorization grant for an access token.  </tt></td></tr>

Joe Gregorio

2011-02-19 14:51:56 -0500

[diff] [blame]

490

491

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

492

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

493

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

494

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

495

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

496

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

497

</dl>

498

<hr>

499

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

500

<dl><dt>__weakref__</dt>

501

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

502

</dl>

503

<hr>

504

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

Joe Gregorio

2011-07-06 10:09:20 -0400

[diff] [blame]

505

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

Joe Gregorio

2011-02-19 14:51:56 -0500

[diff] [blame]

506

507

<hr>

508

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

509

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

510

511

<hr>

512

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

513

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

514

515

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

516

517

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

518

519

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

520

521

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

522

523

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

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

528

529

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

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

534

535

<hr>

536

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]

547

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

548

549

550

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

551

Joe Gregorio

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

[diff] [blame]

552

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

553

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

554

access token.

Joe Gregorio

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

[diff] [blame]

555

556

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

557

558

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

559

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

560

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

561

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

562

</dl>

563

<hr>

564

Methods defined here:

565

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

566

567

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

568

569

This constructor is not usually called by the user, instead

Joe Gregorio

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

[diff] [blame]

570

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

Joe Gregorio

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

[diff] [blame]

571

572

Args:

Joe Gregorio

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

[diff] [blame]

573

token_uri: string, URI of token endpoint.

574

client_id: string, client identifier.

575

client_secret: string, client secret.

576

access_token: string, access token.

577

token_expiry: datetime, when the access_token expires.

578

refresh_token: string, refresh token.

Joe Gregorio

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

[diff] [blame]

579

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

Notes:

store: callable, a callable that when passed a Credential

584

will store the credential back to where it came from.

585

This is needed to store the latest access_token if it

586

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

587

588

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

589

Joe Gregorio

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

[diff] [blame]

590

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

591

592

Args:

Joe Gregorio

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

[diff] [blame]

593

http: An instance of httplib2.Http

594

or something that acts like it.

595

596

Returns:

597

A modified instance of http that was passed in.

Example:

h = httplib2.Http()

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

603

604

You can't create a new OAuth

605

subclass of httplib2.Authenication because

606

it never gets passed the absolute URI, which is

607

needed for signing. So instead we have to overload

608

'request' with a closure that adds in the

609

Authorization header and then calls the original version

610

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

611

612

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

613

614

Args:

615

store: callable, a callable that when passed a Credential

616

will store the credential back to where it came from.

617

This is needed to store the latest access_token if it

618

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

619

620

<hr>

Joe Gregorio

9ce4b62

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

[diff] [blame]

621

Data descriptors defined here:

622

<dl><dt>invalid</dt>

623

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

624

</dl>

625

<hr>

Joe Gregorio

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

[diff] [blame]

626

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

627

628

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

629

</dl>

630

<dl><dt>__weakref__</dt>

631

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

638

639

640

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

641

642

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

643

644

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

645

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

646

647

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

648

</dl>

649

<hr>

650

Methods defined here:

Joe Gregorio

4258d6b

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

[diff] [blame]

651

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

Joe Gregorio

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

[diff] [blame]

652

653

Args:

Joe Gregorio

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

[diff] [blame]

654

client_id: string, client identifier.

655

client_secret: string client secret.

656

scope: string, scope of the credentials being requested.

Joe Gregorio

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

[diff] [blame]

657

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

Joe Gregorio

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

[diff] [blame]

658

auth_uri: string, URI for authorization endpoint. For convenience

659

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

660

token_uri: string, URI for token endpoint. For convenience

661

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

Joe Gregorio

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

[diff] [blame]

662

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

663

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

664

665

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

666

667

Args:

668

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

669

application, or a URI that handles the callback from

670

the authorization server.

671

672

If redirect_uri is 'oob' then pass in the

673

generated verification code to step2_exchange,

674

otherwise pass in the query parameters received

675

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

676

Joe Gregorio

2011-02-19 14:51:56 -0500

[diff] [blame]

677

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

Joe Gregorio