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

><a href=".">index</a> <a href="file:/usr/local/google/home/jcgregorio/projects/apiclient/apiclient/oauth.py">/usr/local/google/home/jcgregorio/projects/apiclient/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-17 11:47:17 -0500

[diff] [blame]

23

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

24

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

25

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

26

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

27

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

28

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

Joe Gregorio

6e53703

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

[diff] [blame]

29

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

38

</dt><dd>

39

<dl>

40

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

41

</dt><dd>

42

<dl>

43

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

44

</dt></dl>

45

</dd>

Joe Gregorio

6e53703

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

[diff] [blame]

46

47

</dt><dd>

48

<dl>

Joe Gregorio

30dfdc3

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

[diff] [blame]

49

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

50

</dt></dl>

51

</dd>

Joe Gregorio

6e53703

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

[diff] [blame]

52

</dl>

53

</dd>

Joe Gregorio

30dfdc3

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

[diff] [blame]

54

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

55

</dt><dd>

56

<dl>

57

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

58

</dt><dd>

59

<dl>

60

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

61

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

72

73

74

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

75

76

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

77

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

78

79

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

80

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

81

authorizes it for the set of credentials, usually by

82

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

83

the appropriate headers and then delegates to the original

84

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

85

86

<hr>

87

Data descriptors defined here:

88

89

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

90

</dl>

91

<dl><dt>__weakref__</dt>

92

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

99

100

101

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

102

103

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

104

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

105

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

106

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

107

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

108

</dl>

109

<hr>

110

Data descriptors defined here:

111

<dl><dt>__weakref__</dt>

112

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

113

</dl>

114

<hr>

115

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

116

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

117

118

<hr>

119

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

120

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

121

122

<hr>

123

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

124

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

125

126

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

127

128

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

129

130

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

131

132

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

133

134

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

139

140

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

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

145

146

<hr>

147

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]

158

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

159

160

161

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

162

163

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

164

165

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

166

</dl>

167

<dl><dt>__weakref__</dt>

168

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

175

176

177

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

178

Joe Gregorio

6e53703

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

[diff] [blame]

179

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

180

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

181

182

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

183

</dl>

184

<hr>

185

Methods defined here:

Joe Gregorio

30dfdc3

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

[diff] [blame]

186

<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

187

the OAuth endpoints.

188

consumer_key    - OAuth consumer key

189

consumer_secret - OAuth consumer secret

190

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

191

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

192

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

193

194

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

195

196

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

197

or a URI that handles the callback from the authorization

198

server.

199

200

If oauth_callback is 'oob' then pass in the

201

generated verification code to step2_exchange,

202

otherwise pass in the query parameters received

203

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

204

205

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

206

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

207

208

verifier - either the verifier token, or a dictionary

209

of the query parameters to the callback, which contains

210

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

211

212

<hr>

Joe Gregorio

6e53703

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

[diff] [blame]

213

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

Joe Gregorio

30dfdc3

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

[diff] [blame]

214

215

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

216

</dl>

217

<dl><dt>__weakref__</dt>

218

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

225

226

227

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

228

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

229

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

230

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

231

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

232

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

233

</dl>

234

<hr>

235

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

236

<dl><dt>__weakref__</dt>

237

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

238

</dl>

239

<hr>

240

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

241

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

242

243

<hr>

244

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

245

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

246

247

<hr>

248

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

249

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

250

251

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

252

253

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

254

255

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

256

257

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

258

259

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

264

265

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

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

270

271

<hr>

272

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>

284

285

286

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

287

288

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

289

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

290

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

291

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

292

</dl>

293

<hr>

294

Methods defined here:

295

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

296

token      - An instance of oauth.Token constructed with

297

the access token and secret.

298

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

299

300

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

301

http - An instance of httplib2.Http

302

or something that acts like it.

303

304

Returns:

305

A modified instance of http that was passed in.

Example:

h = httplib2.Http()

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

311

312

You can't create a new OAuth

313

subclass of httplib2.Authenication because

314

it never gets passed the absolute URI, which is

315

needed for signing. So instead we have to overload

316

'request' with a closure that adds in the

317

Authorization header and then calls the original version

318

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

319

320

<hr>

321

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

322

323

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

324

</dl>

325

<dl><dt>__weakref__</dt>

326

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

333

334

335

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

336

337

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

338

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

339

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

340

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

341

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

342

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

343

</dl>

344

<hr>

345

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

346

<dl><dt>__weakref__</dt>

347

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

348

</dl>

349

<hr>

350

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

351

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

352

353

<hr>

354

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

355

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

356

357

<hr>

358

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

359

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

360

361

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

362

363

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

364

365

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

366

367

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

368

369

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

374

375

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

376

377