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/apiary/apiclient/oauth.py">/usr/local/google/home/jcgregorio/projects/apiary/apiclient/oauth.py</a></td></tr></table>

12

<tt>Utilities for OAuth.

13

14

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

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

<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="urllib.html">urllib</a>

27

</td><td width="25%" valign=top></td></tr></table></td></tr></table>

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

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

36

</dt><dd>

37

<dl>

38

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

39

</dt><dd>

40

<dl>

41

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

42

</dt></dl>

43

</dd>

44

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

45

</dt></dl>

46

</dd>

47

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

48

</dt><dd>

49

<dl>

50

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

51

</dt><dd>

52

<dl>

53

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

54

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

65

66

67

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

68

69

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

70

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

71

72

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

73

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

74

authorizes it for the set of credentials, usually by

75

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

76

the appropriate headers and then delegates to the original

77

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

78

79

<hr>

80

Data descriptors defined here:

81

82

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

83

</dl>

84

<dl><dt>__weakref__</dt>

85

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

92

93

94

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

95

96

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

97

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

98

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

99

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

100

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

101

</dl>

102

<hr>

103

Data descriptors defined here:

104

<dl><dt>__weakref__</dt>

105

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

106

</dl>

107

<hr>

108

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

109

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

110

111

<hr>

112

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

113

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

114

115

<hr>

116

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

117

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

118

119

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

120

121

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

122

123

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

124

125

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

126

127

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

132

133

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

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

138

139

<hr>

140

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

</dl>

</dl>

<dl><dt>message</dt>

</dl>

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

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

152

153

154

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

155

156

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

157

<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

158

the OAuth endpoints.

159

consumer_key    - OAuth consumer key

160

consumer_secret - OAuth consumer secret

161

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

162

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

163

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

164

165

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

166

167

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

168

or a URI that handles the callback from the authorization

169

server.

170

171

If oauth_callback is 'oob' then pass in the

172

generated verification code to step2_exchange,

173

otherwise pass in the query parameters received

174

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

175

176

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

177

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

178

179

verifier - either the verifier token, or a dictionary

180

of the query parameters to the callback, which contains

181

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

182

183

<hr>

184

Data descriptors defined here:

185

186

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

187

</dl>

188

<dl><dt>__weakref__</dt>

189

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

196

197

198

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

199

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

200

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

201

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

202

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

203

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

204

</dl>

205

<hr>

206

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

207

<dl><dt>__weakref__</dt>

208

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

209

</dl>

210

<hr>

211

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

212

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

213

214

<hr>

215

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

216

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

217

218

<hr>

219

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

220

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

221

222

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

223

224

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

225

226

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

227

228

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

229

230

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

235

236

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

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

241

242

<hr>

243

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>

255

256

257

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

258

259

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

260

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

261

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

262

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

263

</dl>

264

<hr>

265

Methods defined here:

266

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

267

token      - An instance of oauth.Token constructed with

268

the access token and secret.

269

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

270

271

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

272

http - An instance of httplib2.Http

273

or something that acts like it.

274

275

Returns:

276

A modified instance of http that was passed in.

Example:

h = httplib2.Http()

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

282

283

You can't create a new OAuth

284

subclass of httplib2.Authenication because

285

it never gets passed the absolute URI, which is

286

needed for signing. So instead we have to overload

287

'request' with a closure that adds in the

288

Authorization header and then calls the original version

289

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

290

291

<hr>

292

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

293

294

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

295

</dl>

296

<dl><dt>__weakref__</dt>

297

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

304

305

306

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

307

308

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

309

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

310

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

311

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

312

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

313

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

314

</dl>

315

<hr>

316

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

317

<dl><dt>__weakref__</dt>

318

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

319

</dl>

320

<hr>

321

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

322

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

323

324

<hr>

325

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

326

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

327

328

<hr>

329

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

330

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

331

332

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

333

334

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

335

336

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

337

338

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

339

340

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

345

346

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

347

348