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>

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>

</dt></dl>

</dd>

</dt><dd>

<dl>

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

</dt></dl>

</dd>

</dl>

</dd>

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

56

</dt><dd>

57

<dl>

58

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

59

</dt><dd>

60

<dl>

61

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

62

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

</dt></dl>

</dd>

</dl>

</dd>

</dl>

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

73

74

75

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

76

77

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

78

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

79

80

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

81

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

82

authorizes it for the set of credentials, usually by

83

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

84

the appropriate headers and then delegates to the original

85

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

86

87

<hr>

88

Data descriptors defined here:

89

90

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

91

</dl>

92

<dl><dt>__weakref__</dt>

93

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

100

101

102

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

103

104

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

105

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

106

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

107

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

108

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

109

</dl>

110

<hr>

111

Data descriptors defined here:

112

<dl><dt>__weakref__</dt>

113

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

114

</dl>

115

<hr>

116

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

117

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

118

119

<hr>

120

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

121

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

122

123

<hr>

124

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

125

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

126

127

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

128

129

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

130

131

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

132

133

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

134

135

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

140

141

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

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

146

147

<hr>

148

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

</dl>

</dl>

<dl><dt>message</dt>

</dl>

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

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

160

161

162

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

163

164

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

165

166

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

167

</dl>

168

<dl><dt>__weakref__</dt>

169

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

</dl>

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

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

176

177

178

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

179

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

180

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

181

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

182

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

183

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

184

</dl>

185

<hr>

186

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

187

<dl><dt>__weakref__</dt>

188

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

189

</dl>

190

<hr>

191

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

192

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

193

194

<hr>

195

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

196

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

197

198

<hr>

199

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

200

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

201

202

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

203

204

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

205

206

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

207

208

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

209

210

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

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

215

216

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

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

221

222

<hr>

223

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

</dl>

</dl>

<dl><dt>message</dt>

</dl>

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

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

235

236

237

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

238

239

<a href="#Credentials">Credentials</a> can be applied to an httplib2.Http <a href="__builtin__.html#object">object</a>

240

using the <a href="#OAuth2Credentials-authorize">authorize</a>() method, which then signs each

241

request from that <a href="__builtin__.html#object">object</a> with the OAuth 2.0 access token.

242

243

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

244

245

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

246

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

247

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

248

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

249

</dl>

250

<hr>

251

Methods defined here:

252

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

253

254

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

255

256

This constructor is not usually called by the user, instead

257

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

258

the <a href="#OAuth2WebServerFlow">OAuth2WebServerFlow</a>.

259

260

Args:

261

token_uri: string, URI of token endpoint

262

client_id: string, client identifier

263

client_secret: string, client secret

264

access_token: string, access token

265

token_expiry: datetime, when the access_token expires

266

refresh_token: string, refresh token

267

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

Notes:

store: callable, a callable that when passed a Credential

272

will store the credential back to where it came from.

273

This is needed to store the latest access_token if it

274

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

275

276

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

277

278

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

279

http: An instance of httplib2.Http

280

or something that acts like it.

281

282

Returns:

283

A modified instance of http that was passed in.

Example:

h = httplib2.Http()

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

289

290

You can't create a new OAuth

291

subclass of httplib2.Authenication because

292

it never gets passed the absolute URI, which is

293

needed for signing. So instead we have to overload

294

'request' with a closure that adds in the

295

Authorization header and then calls the original version

296

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

297

298

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

299

300

Args:

301

store: callable, a callable that when passed a Credential

302

will store the credential back to where it came from.

303

This is needed to store the latest access_token if it

304

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

305

306

<hr>

307

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

308

309

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

310

</dl>

311

<dl><dt>__weakref__</dt>

312

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

319

320

321

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

322

323

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

324

325

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

326

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

327

328

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

329

</dl>

330

<hr>

331

Methods defined here:

332

<dl><dt><a name="OAuth2WebServerFlow-__init__">__init__</a>(self, client_id, client_secret, scope, user_agent, authorization_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>

333

334

Args:

335

client_id: string, client identifier

336

client_secret: string client secret

337

scope: string, scope of the credentials being requested

338

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

339

authorization_uri: string, URI for authorization endpoint

340

token_uri: string, URI for token endpoint

341

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

342

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

343

344

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

345

346

Args:

347

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

348

application, or a URI that handles the callback from

349

the authorization server.

350

351

If redirect_uri is 'oob' then pass in the

352

generated verification code to step2_exchange,

353

otherwise pass in the query parameters received

354

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

355

356

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

357

358

Args:

359

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

360

of the query parameters to the redirect_uri, which contains

361

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

362

363

<hr>

364

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

365

366

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

367

</dl>

368

<dl><dt>__weakref__</dt>

369

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

376

377

378

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

379

380

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

381

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

382

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

383

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

384

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

385

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

386

</dl>

387

<hr>

388

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

389

<dl><dt>__weakref__</dt>

390

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

391

</dl>

392

<hr>

393

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

394

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

395

396

<hr>

397

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

398

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

399

400

<hr>

401

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

402

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

403

404

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

405

406

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

407

408

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

409

410

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

411

412

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

417

418

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

419

420