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

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

[diff] [blame]

48

</dt></dl>

49

</dd>

Joe Gregorio

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

[diff] [blame]

50

</dl>

51

</dd>

Joe Gregorio

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

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

[diff] [blame]

58

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

59

</dt></dl>

Joe Gregorio

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

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

[diff] [blame]

67

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

Joe Gregorio

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

[diff] [blame]

68

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

69

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

79

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

80

81

82

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

83

84

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

85

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

86

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

87

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

88

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

89

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

90

expire.

91

Joe Gregorio

fffa7d7

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

[diff] [blame]

92

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

Joe Gregorio

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

[diff] [blame]

93

94

Usage:

95

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

96

'my-user-agent/1.0')

97

http = httplib2.Http()

98

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

99

100

Exceptions:

101

AccessTokenCredentialsExpired: raised when the access_token expires or is

102

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

103

104

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

105

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

106

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

107

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

108

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

109

</dl>

110

<hr>

111

Methods defined here:

112

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

113

114

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

115

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

116

117

Args:

Joe Gregorio

9384170

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

[diff] [blame]

118

access_token: string, access token.

Joe Gregorio

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

[diff] [blame]

119

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

120

121

Notes:

122

store: callable, a callable that when passed a Credential

123

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

124

125

<hr>

126

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

127

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

128

129

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

130

131

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

132

133

Args:

134

http: An instance of httplib2.Http

135

or something that acts like it.

136

137

Returns:

138

A modified instance of http that was passed in.

Example:

h = httplib2.Http()

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

144

145

You can't create a new OAuth

146

subclass of httplib2.Authenication because

147

it never gets passed the absolute URI, which is

148

needed for signing. So instead we have to overload

149

'request' with a closure that adds in the

150

Authorization header and then calls the original version

151

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

152

153

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

154

155

Args:

156

store: callable, a callable that when passed a Credential

157

will store the credential back to where it came from.

158

This is needed to store the latest access_token if it

159

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

160

161

<hr>

Joe Gregorio

9ce4b62

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

[diff] [blame]

162

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

163

<dl><dt>invalid</dt>

164

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

165

</dl>

166

<hr>

Joe Gregorio

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

[diff] [blame]

167

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

168

169

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

170

</dl>

171

<dl><dt>__weakref__</dt>

172

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

179

180

181

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

182

183

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

184

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

185

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

186

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

187

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

188

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

189

</dl>

190

<hr>

191

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

192

<dl><dt>__weakref__</dt>

193

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

194

</dl>

195

<hr>

196

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

Joe Gregorio

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

[diff] [blame]

197

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

Joe Gregorio

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

[diff] [blame]

198

199

<hr>

200

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

201

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

202

203

<hr>

204

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

205

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

206

207

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

208

209

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

210

211

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

212

213

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

214

215

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

220

221

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

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

226

227

<hr>

228

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]

239

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

240

241

Joe Gregorio

ad258e2

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

[diff] [blame]

242

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

243

244

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

245

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

246

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

247

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

248

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

249

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

250

</dl>

251

<hr>

252

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

253

<dl><dt>__weakref__</dt>

254

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

255

</dl>

256

<hr>

257

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

Joe Gregorio

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

[diff] [blame]

258

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

Joe Gregorio

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

[diff] [blame]

259

260

<hr>

261

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

262

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

263

264

<hr>

265

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

266

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

267

268

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

269

270

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

271

272

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

273

274

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

275

276

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

281

282

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

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

287

288

<hr>

289

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]

300

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

301

302

303

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

304

305

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

306

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

307

308

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

309

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

310

authorizes it for the set of credentials, usually by

311

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

312

the appropriate headers and then delegates to the original

313

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

314

315

<hr>

316

Data descriptors defined here:

317

318

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

319

</dl>

320

<dl><dt>__weakref__</dt>

321

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

328

329

330

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

331

332

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

333

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

334

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

335

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

336

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

337

</dl>

338

<hr>

339

Data descriptors defined here:

340

<dl><dt>__weakref__</dt>

341

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

342

</dl>

343

<hr>

344

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

Joe Gregorio

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

[diff] [blame]

345

<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

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

[diff] [blame]

346

347

<hr>

348

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

349

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

350

351

<hr>

352

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

353

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

354

355

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

356

357

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

358

359

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

360

361

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

362

363

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

368

369

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

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

374

375

<hr>

376

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>

388

389

390

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

391

392

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

393

394

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

395

</dl>

396

<dl><dt>__weakref__</dt>

397

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

403

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

404

405

Joe Gregorio

ad258e2

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

[diff] [blame]

406

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

407

408

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

409

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

410

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

411

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

412

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

413

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

414

</dl>

415

<hr>

416

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

417

<dl><dt>__weakref__</dt>

418

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

419

</dl>

420

<hr>

421

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

Joe Gregorio

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

[diff] [blame]

422

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

Joe Gregorio

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

[diff] [blame]

423

424

<hr>

425

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

426

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

427

428

<hr>

429

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

430

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

431

432

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

433

434

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

435

436

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

437

438

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

439

440

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

445

446

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

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

451

452

<hr>

453

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]

464

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

465

466

467

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

468

Joe Gregorio

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

[diff] [blame]

469

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

470

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

471

access token.

Joe Gregorio

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

[diff] [blame]

472

473

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

474

475

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

476

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

477

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

478

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

479

</dl>

480

<hr>

481

Methods defined here:

482

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

483

484

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

485

486

This constructor is not usually called by the user, instead

Joe Gregorio

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

[diff] [blame]

487

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

488

489

Args:

Joe Gregorio

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

[diff] [blame]

490

token_uri: string, URI of token endpoint.

491

client_id: string, client identifier.

492

client_secret: string, client secret.

493

access_token: string, access token.

494

token_expiry: datetime, when the access_token expires.

495

refresh_token: string, refresh token.

Joe Gregorio

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

[diff] [blame]

496

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

Notes:

store: callable, a callable that when passed a Credential

501

will store the credential back to where it came from.

502

This is needed to store the latest access_token if it

503

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

504

505

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

506

Joe Gregorio

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

[diff] [blame]

507

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

508

509

Args:

Joe Gregorio

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

[diff] [blame]

510

http: An instance of httplib2.Http

511

or something that acts like it.

512

513

Returns:

514

A modified instance of http that was passed in.

Example:

h = httplib2.Http()

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

520

521

You can't create a new OAuth

522

subclass of httplib2.Authenication because

523

it never gets passed the absolute URI, which is

524

needed for signing. So instead we have to overload

525

'request' with a closure that adds in the

526

Authorization header and then calls the original version

527

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

528

529

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

530

531

Args:

532

store: callable, a callable that when passed a Credential

533

will store the credential back to where it came from.

534

This is needed to store the latest access_token if it

535

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

536

537

<hr>

Joe Gregorio

9ce4b62

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

[diff] [blame]

538

Data descriptors defined here:

539

<dl><dt>invalid</dt>

540

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

541

</dl>

542

<hr>

Joe Gregorio

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

[diff] [blame]

543

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

544

545

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

546

</dl>

547

<dl><dt>__weakref__</dt>

548

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

555

556

557

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

558

559

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

560

561

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

562

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

563

564

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

565

</dl>

566

<hr>

567

Methods defined here:

Joe Gregorio

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

[diff] [blame]

568

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

569

570

Args:

Joe Gregorio

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

[diff] [blame]

571

client_id: string, client identifier.

572

client_secret: string client secret.

573

scope: string, scope of the credentials being requested.

Joe Gregorio

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

[diff] [blame]

574

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

Joe Gregorio

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

[diff] [blame]

575

auth_uri: string, URI for authorization endpoint. For convenience

576

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

577

token_uri: string, URI for token endpoint. For convenience

578

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]

579

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

580

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

581

582

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

583

584

Args:

585

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

586

application, or a URI that handles the callback from

587

the authorization server.

588

589

If redirect_uri is 'oob' then pass in the

590

generated verification code to step2_exchange,

591

otherwise pass in the query parameters received

592

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

593

Joe Gregorio

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

[diff] [blame]

594

<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