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

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

Joe Gregorio

30dfdc3

2010-12-09 16:34:22 -0500

[diff] [blame]

12

<tt>Utilities for OAuth.

13

14

Utilities for making it easier to work with OAuth.</tt>

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

Joe Gregorio

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

[diff] [blame]

23

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

24

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

25

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

26

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

27

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

Joe Gregorio

30dfdc3

2010-12-09 16:34:22 -0500

[diff] [blame]

28

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

Joe Gregorio

6e53703

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

[diff] [blame]

29

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

30

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

Joe Gregorio

30dfdc3

2010-12-09 16:34:22 -0500

[diff] [blame]

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

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

39

</dt><dd>

40

<dl>

41

<dt><a href="apiclient.oauth.html#Credentials">Credentials</a>

42

</dt><dd>

43

<dl>

44

<dt><a href="apiclient.oauth.html#OAuthCredentials">OAuthCredentials</a>

45

</dt></dl>

46

</dd>

Joe Gregorio

6e53703

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

[diff] [blame]

47

48

</dt><dd>

49

<dl>

Joe Gregorio

30dfdc3

2010-12-09 16:34:22 -0500

[diff] [blame]

50

<dt><a href="apiclient.oauth.html#FlowThreeLegged">FlowThreeLegged</a>

51

</dt></dl>

52

</dd>

Joe Gregorio

6e53703

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

[diff] [blame]

53

</dl>

54

</dd>

Joe Gregorio

30dfdc3

2010-12-09 16:34:22 -0500

[diff] [blame]

55

<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="apiclient.oauth.html#Error">Error</a>

59

</dt><dd>

60

<dl>

61

<dt><a href="apiclient.oauth.html#MissingParameter">MissingParameter</a>

62

</dt><dt><a href="apiclient.oauth.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="apiclient.oauth.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>

Joe Gregorio

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

[diff] [blame]

159

<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="FlowThreeLegged">class FlowThreeLegged</a>(<a href="apiclient.oauth.html#Flow">Flow</a>)</td></tr>

Joe Gregorio

30dfdc3

2010-12-09 16:34:22 -0500

[diff] [blame]

176

177

178

<td colspan=2><tt>Does the Three Legged Dance for OAuth 1.0a.  </tt></td></tr>

179

Joe Gregorio

6e53703

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

[diff] [blame]

180

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

181

<dd><a href="apiclient.oauth.html#FlowThreeLegged">FlowThreeLegged</a></dd>

182

183

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

184

</dl>

185

<hr>

186

Methods defined here:

Joe Gregorio

30dfdc3

2010-12-09 16:34:22 -0500

[diff] [blame]

187

<dl><dt><a name="FlowThreeLegged-__init__">__init__</a>(self, discovery, consumer_key, consumer_secret, user_agent, **kwargs)</dt><dd><tt>discovery       - Section of the API discovery document that describes

188

the OAuth endpoints.

189

consumer_key    - OAuth consumer key

190

consumer_secret - OAuth consumer secret

191

user_agent      - The HTTP User-Agent that identifies the application.

192

**kwargs        - The keyword arguments are all optional and required

193

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

194

195

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

196

197

oauth_callback - Either the string 'oob' for a non-web-based application,

198

or a URI that handles the callback from the authorization

199

server.

200

201

If oauth_callback is 'oob' then pass in the

202

generated verification code to step2_exchange,

203

otherwise pass in the query parameters received

204

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

205

206

<dl><dt><a name="FlowThreeLegged-step2_exchange">step2_exchange</a>(self, verifier)</dt><dd><tt>Exhanges an authorized request token

207

for <a href="#OAuthCredentials">OAuthCredentials</a>.

208

209

verifier - either the verifier token, or a dictionary

210

of the query parameters to the callback, which contains

211

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

212

213

<hr>

Joe Gregorio

6e53703

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

[diff] [blame]

214

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

Joe Gregorio

30dfdc3

2010-12-09 16:34:22 -0500

[diff] [blame]

215

216

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

217

</dl>

218

<dl><dt>__weakref__</dt>

219

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

226

227

228

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

229

<dd><a href="apiclient.oauth.html#MissingParameter">MissingParameter</a></dd>

230

<dd><a href="apiclient.oauth.html#Error">Error</a></dd>

231

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

232

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

233

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

234

</dl>

235

<hr>

236

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

237

<dl><dt>__weakref__</dt>

238

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

239

</dl>

240

<hr>

241

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

242

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

243

244

<hr>

245

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

246

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

247

248

<hr>

249

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

250

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

251

252

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

253

254

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

255

256

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

257

258

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

259

260

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

265

266

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

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

271

272

<hr>

273

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

</dl>

</dl>

<dl><dt>message</dt>

</dl>

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

<a name="OAuthCredentials">class OAuthCredentials</a>(<a href="apiclient.oauth.html#Credentials">Credentials</a>)</td></tr>

285

286

287

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

288

289

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

290

<dd><a href="apiclient.oauth.html#OAuthCredentials">OAuthCredentials</a></dd>

291

<dd><a href="apiclient.oauth.html#Credentials">Credentials</a></dd>

292

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

293

</dl>

294

<hr>

295

Methods defined here:

296

<dl><dt><a name="OAuthCredentials-__init__">__init__</a>(self, consumer, token, user_agent)</dt><dd><tt>consumer   - An instance of oauth.Consumer.

297

token      - An instance of oauth.Token constructed with

298

the access token and secret.

299

user_agent - The HTTP User-Agent to provide for this application.</tt></dd></dl>

300

301

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

302

http - An instance of httplib2.Http

303

or something that acts like it.

304

305

Returns:

306

A modified instance of http that was passed in.

Example:

h = httplib2.Http()

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

312

313

You can't create a new OAuth

314

subclass of httplib2.Authenication because

315

it never gets passed the absolute URI, which is

316

needed for signing. So instead we have to overload

317

'request' with a closure that adds in the

318

Authorization header and then calls the original version

319

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

320

321

<hr>

322

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

323

324

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

325

</dl>

326

<dl><dt>__weakref__</dt>

327

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

334

335

336

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

337

338

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

339

<dd><a href="apiclient.oauth.html#RequestError">RequestError</a></dd>

340

<dd><a href="apiclient.oauth.html#Error">Error</a></dd>

341

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

342

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

343

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

344

</dl>

345

<hr>

346

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

347

<dl><dt>__weakref__</dt>

348

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

349

</dl>

350

<hr>

351

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

352

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

353

354

<hr>

355

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

356

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

357

358

<hr>

359

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

360

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

361

362

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

363

364

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

365

366

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

367

368

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

369

370

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

375

376

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

377

378