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

2011-09-15 09:53:21 -0400

[diff] [blame]

12

<tt>An OAuth 2.0 client.

Joe Gregorio

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

[diff] [blame]

13

Joe Gregorio

2011-09-15 09:53:21 -0400

[diff] [blame]

14

Tools for interacting with OAuth 2.0 protected resources.</tt>

Joe Gregorio

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

[diff] [blame]

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

20

21

Joe Gregorio

2011-10-28 14:36:24 -0400

[diff] [blame^]

22

<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="oauth2client.clientsecrets.html">oauth2client.clientsecrets</a>

23

Joe Gregorio

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

[diff] [blame]

24

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

Joe Gregorio

2011-10-28 14:36:24 -0400

[diff] [blame^]

27

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

28

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

Joe Gregorio

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

[diff] [blame]

29

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

Joe Gregorio

2011-10-28 14:36:24 -0400

[diff] [blame^]

30

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

31

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

Joe Gregorio

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

[diff] [blame]

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

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

40

</dt><dd>

41

<dl>

42

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

43

</dt><dd>

44

<dl>

45

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

Joe Gregorio

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

[diff] [blame]

46

</dt><dd>

47

<dl>

48

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

Joe Gregorio

2011-06-30 12:38:10 -0400

[diff] [blame]

49

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

Joe Gregorio

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

[diff] [blame]

50

</dt></dl>

51

</dd>

Joe Gregorio

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

[diff] [blame]

52

</dl>

53

</dd>

Joe Gregorio

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

[diff] [blame]

</dt><dd>

<dl>

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

58

</dt></dl>

59

</dd>

Joe Gregorio

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

[diff] [blame]

60

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

61

</dt></dl>

Joe Gregorio

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

[diff] [blame]

62

</dd>

63

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

64

</dt><dd>

65

<dl>

66

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

67

</dt><dd>

68

<dl>

Joe Gregorio

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

[diff] [blame]

69

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

Joe Gregorio

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

[diff] [blame]

70

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

71

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

Joe Gregorio

2011-10-28 14:36:24 -0400

[diff] [blame^]

72

</dt><dt><a href="oauth2client.client.html#UnknownClientSecretsFlowError">UnknownClientSecretsFlowError</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]

82

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

83

84

Joe Gregorio

2011-09-15 09:53:21 -0400

[diff] [blame]

85

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

Joe Gregorio

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

[diff] [blame]

86

Joe Gregorio

2011-09-15 09:53:21 -0400

[diff] [blame]

87

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

88

<a href="#AccessTokenCredentials-authorize">authorize</a>() method, which then signs each request from that <a href="__builtin__.html#object">object</a>

89

with the OAuth 2.0 access token.  This set of credentials is for the

90

use case where you have acquired an OAuth 2.0 access_token from

91

another place such as a JavaScript client or another web

92

application, and wish to use it from Python. Because only the

93

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

Joe Gregorio

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

[diff] [blame]

94

expire.

95

Joe Gregorio

fffa7d7

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

[diff] [blame]

96

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

Joe Gregorio

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

[diff] [blame]

97

98

Usage:

99

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

100

'my-user-agent/1.0')

101

http = httplib2.Http()

102

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

103

104

Exceptions:

105

AccessTokenCredentialsExpired: raised when the access_token expires or is

106

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

107

108

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

109

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

110

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

111

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

112

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

113

</dl>

114

<hr>

115

Methods defined here:

116

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

117

118

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

119

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

120

121

Args:

Joe Gregorio

9384170

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

[diff] [blame]

122

access_token: string, access token.

Joe Gregorio

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

[diff] [blame]

123

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

124

125

Notes:

126

store: callable, a callable that when passed a Credential

127

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

128

129

<hr>

Joe Gregorio

2011-09-15 09:53:21 -0400

[diff] [blame]

130

Class methods defined here:

131

<dl><dt><a name="AccessTokenCredentials-from_json">from_json</a>(cls, s) from <a href="__builtin__.html#type">__builtin__.type</a></dt></dl>

132

133

<hr>

Joe Gregorio

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

[diff] [blame]

134

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

135

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

136

137

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

138

139

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

140

141

Args:

142

http: An instance of httplib2.Http

143

or something that acts like it.

144

145

Returns:

146

A modified instance of http that was passed in.

Example:

h = httplib2.Http()

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

152

Joe Gregorio

2011-09-15 09:53:21 -0400

[diff] [blame]

153

You can't create a new OAuth subclass of httplib2.Authenication

154

because it never gets passed the absolute URI, which is needed for

155

signing. So instead we have to overload 'request' with a closure

156

that adds in the Authorization header and then calls the original

157

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

Joe Gregorio

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

[diff] [blame]

158

Joe Gregorio

2011-09-15 09:53:21 -0400

[diff] [blame]

159

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

Joe Gregorio

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

[diff] [blame]

160

161

Args:

Joe Gregorio

2011-09-15 09:53:21 -0400

[diff] [blame]

162

store: <a href="#Storage">Storage</a>, an implementation of Stroage <a href="__builtin__.html#object">object</a>.

Joe Gregorio

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

[diff] [blame]

163

This is needed to store the latest access_token if it

Joe Gregorio

2011-09-15 09:53:21 -0400

[diff] [blame]

164

has expired and been refreshed.  This implementation uses

165

locking to check for updates before updating the

166

access_token.</tt></dd></dl>

167

168

Joe Gregorio

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

[diff] [blame]

169

170

<hr>

Joe Gregorio

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

[diff] [blame]

171

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

Joe Gregorio

2011-09-15 09:53:21 -0400

[diff] [blame]

172

<dl><dt>access_token_expired</dt>

173

<dd><tt>True if the credential is expired or invalid.

174

175

If the token_expiry isn't set, we assume the token doesn't expire.</tt></dd>

Joe Gregorio

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

[diff] [blame]

176

</dl>

177

<hr>

Joe Gregorio

2011-09-15 09:53:21 -0400

[diff] [blame]

178

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

179

<dl><dt><a name="AccessTokenCredentials-new_from_json">new_from_json</a>(cls, s) from <a href="__builtin__.html#type">__builtin__.type</a></dt><dd><tt>Utility class method to instantiate a <a href="#Credentials">Credentials</a> subclass from a JSON

180

representation produced by <a href="#AccessTokenCredentials-to_json">to_json</a>().

181

182

Args:

183

s: string, JSON from <a href="#AccessTokenCredentials-to_json">to_json</a>().

184

185

Returns:

186

An instance of the subclass of <a href="#Credentials">Credentials</a> that was serialized with

187

188

189

<hr>

Joe Gregorio

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

[diff] [blame]

190

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

191

192

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

193

</dl>

194

<dl><dt>__weakref__</dt>

195

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

196

</dl>

Joe Gregorio

2011-09-15 09:53:21 -0400

[diff] [blame]

197

<hr>

198

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

199

<dl><dt>NON_SERIALIZED_MEMBERS = ['store']</dl>

200

Joe Gregorio

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

[diff] [blame]

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

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

206

207

208

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

209

210

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

211

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

212

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

213

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

214

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

215

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

216

</dl>

217

<hr>

218

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

219

<dl><dt>__weakref__</dt>

220

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

221

</dl>

222

<hr>

223

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

Joe Gregorio

2011-10-28 14:36:24 -0400

[diff] [blame^]

224

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

225

226

<hr>

227

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

228

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

229

230

<hr>

231

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

232

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

233

234

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

235

236

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

237

238

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

239

240

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

241

242

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

247

248

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

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

253

254

<hr>

255

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]

266

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

267

268

Joe Gregorio

ad258e2

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

[diff] [blame]

269

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

270

271

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

272

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

273

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

274

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

275

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

276

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

277

</dl>

278

<hr>

279

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

280

<dl><dt>__weakref__</dt>

281

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

282

</dl>

283

<hr>

284

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

Joe Gregorio

2011-10-28 14:36:24 -0400

[diff] [blame^]

285

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

286

287

<hr>

288

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

289

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

290

291

<hr>

292

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

293

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

294

295

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

296

297

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

298

299

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

300

301

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

302

303

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

308

309

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

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

314

315

<hr>

316

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-06-30 12:38:10 -0400

[diff] [blame]

327

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

328

329

Joe Gregorio

2011-09-15 09:53:21 -0400

[diff] [blame]

330

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

Joe Gregorio

2011-06-30 12:38:10 -0400

[diff] [blame]

331

Joe Gregorio

2011-09-15 09:53:21 -0400

[diff] [blame]

332

This credential does not require a flow to instantiate because it

333

represents a two legged flow, and therefore has all of the required

334

information to generate and refresh its own access tokens.  It must

335

be subclassed to generate the appropriate assertion string.

Joe Gregorio

2011-06-30 12:38:10 -0400

[diff] [blame]

336

337

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

338

339

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

340

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

341

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

342

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

343

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

344

</dl>

345

<hr>

346

Methods defined here:

Joe Gregorio

2011-09-15 09:53:21 -0400

[diff] [blame]

347

<dl><dt><a name="AssertionCredentials-__init__">__init__</a>(self, assertion_type, user_agent, token_uri='https://accounts.google.com/o/oauth2/token', **unused_kwargs)</dt><dd><tt>Constructor for AssertionFlowCredentials.

Joe Gregorio

2011-06-30 12:38:10 -0400

[diff] [blame]

348

349

Args:

350

assertion_type: string, assertion type that will be declared to the auth

351

server

352

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

353

token_uri: string, URI for token endpoint. For convenience

354

defaults to Google's endpoints but any OAuth 2.0 provider can be used.</tt></dd></dl>

355

356

<hr>

357

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

358

<dl><dt><a name="AssertionCredentials-__getstate__">__getstate__</a>(self)</dt><dd><tt>Trim the state down to something that can be pickled.</tt></dd></dl>

359

360

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

361

362

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

363

364

Args:

365

http: An instance of httplib2.Http

366

or something that acts like it.

367

368

Returns:

369

A modified instance of http that was passed in.

Example:

h = httplib2.Http()

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

375

Joe Gregorio

2011-09-15 09:53:21 -0400

[diff] [blame]

376

You can't create a new OAuth subclass of httplib2.Authenication

377

because it never gets passed the absolute URI, which is needed for

378

signing. So instead we have to overload 'request' with a closure

379

that adds in the Authorization header and then calls the original

380

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

Joe Gregorio

2011-06-30 12:38:10 -0400

[diff] [blame]

381

Joe Gregorio

2011-09-15 09:53:21 -0400

[diff] [blame]

382

<dl><dt><a name="AssertionCredentials-set_store">set_store</a>(self, store)</dt><dd><tt>Set the <a href="#Storage">Storage</a> for the credential.

Joe Gregorio

2011-06-30 12:38:10 -0400

[diff] [blame]

383

384

Args:

Joe Gregorio

2011-09-15 09:53:21 -0400

[diff] [blame]

385

store: <a href="#Storage">Storage</a>, an implementation of Stroage <a href="__builtin__.html#object">object</a>.

Joe Gregorio

2011-06-30 12:38:10 -0400

[diff] [blame]

386

This is needed to store the latest access_token if it

Joe Gregorio

2011-09-15 09:53:21 -0400

[diff] [blame]

387

has expired and been refreshed.  This implementation uses

388

locking to check for updates before updating the

389

access_token.</tt></dd></dl>

<hr>

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

395

<dl><dt><a name="AssertionCredentials-from_json">from_json</a>(cls, s) from <a href="__builtin__.html#type">__builtin__.type</a></dt><dd><tt>Instantiate a <a href="#Credentials">Credentials</a> <a href="__builtin__.html#object">object</a> from a JSON description of it. The JSON

396

should have been produced by calling .<a href="#AssertionCredentials-to_json">to_json</a>() on the <a href="__builtin__.html#object">object</a>.

397

398

Args:

399

data: dict, A deserialized JSON <a href="__builtin__.html#object">object</a>.

400

401

Returns:

402

An instance of a <a href="#Credentials">Credentials</a> subclass.</tt></dd></dl>

Joe Gregorio

2011-06-30 12:38:10 -0400

[diff] [blame]

403

404

<hr>

405

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

Joe Gregorio

2011-09-15 09:53:21 -0400

[diff] [blame]

406

<dl><dt>access_token_expired</dt>

407

<dd><tt>True if the credential is expired or invalid.

408

409

If the token_expiry isn't set, we assume the token doesn't expire.</tt></dd>

Joe Gregorio

2011-06-30 12:38:10 -0400

[diff] [blame]

410

</dl>

411

<hr>

Joe Gregorio

2011-09-15 09:53:21 -0400

[diff] [blame]

412

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

413

<dl><dt><a name="AssertionCredentials-new_from_json">new_from_json</a>(cls, s) from <a href="__builtin__.html#type">__builtin__.type</a></dt><dd><tt>Utility class method to instantiate a <a href="#Credentials">Credentials</a> subclass from a JSON

414

representation produced by <a href="#AssertionCredentials-to_json">to_json</a>().

415

416

Args:

417

s: string, JSON from <a href="#AssertionCredentials-to_json">to_json</a>().

418

419

Returns:

420

An instance of the subclass of <a href="#Credentials">Credentials</a> that was serialized with

421

422

423

<hr>

Joe Gregorio

2011-06-30 12:38:10 -0400

[diff] [blame]

424

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

425

426

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

427

</dl>

428

<dl><dt>__weakref__</dt>

429

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

430

</dl>

Joe Gregorio

2011-09-15 09:53:21 -0400

[diff] [blame]

431

<hr>

432

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

433

<dl><dt>NON_SERIALIZED_MEMBERS = ['store']</dl>

434

Joe Gregorio

2011-06-30 12:38:10 -0400

[diff] [blame]

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

Joe Gregorio

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

[diff] [blame]

439

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

440

441

442

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

443

Joe Gregorio

2011-09-15 09:53:21 -0400

[diff] [blame]

444

Subclasses must define an <a href="#Credentials-authorize">authorize</a>() method that applies the credentials to

445

an HTTP transport.

446

447

Subclasses must also specify a classmethod named 'from_json' that takes a JSON

448

string as input and returns an instaniated Crentials <a href="__builtin__.html#object">object</a>.  </tt></td></tr>

Joe Gregorio

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

[diff] [blame]

449

450

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

451

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

452

authorizes it for the set of credentials, usually by

453

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

454

the appropriate headers and then delegates to the original

455

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

456

Joe Gregorio

2011-09-15 09:53:21 -0400

[diff] [blame]

457

<dl><dt><a name="Credentials-to_json">to_json</a>(self)</dt><dd><tt>Creating a JSON representation of an instance of <a href="#Credentials">Credentials</a>.

458

459

Returns:

460

string, a JSON representation of this instance, suitable to pass to

461

from_json().</tt></dd></dl>

462

463

<hr>

464

Class methods defined here:

465

<dl><dt><a name="Credentials-new_from_json">new_from_json</a>(cls, s) from <a href="__builtin__.html#type">__builtin__.type</a></dt><dd><tt>Utility class method to instantiate a <a href="#Credentials">Credentials</a> subclass from a JSON

466

representation produced by <a href="#Credentials-to_json">to_json</a>().

467

468

Args:

469

s: string, JSON from <a href="#Credentials-to_json">to_json</a>().

470

471

Returns:

472

An instance of the subclass of <a href="#Credentials">Credentials</a> that was serialized with

473

474

Joe Gregorio

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

[diff] [blame]

475

<hr>

476

Data descriptors defined here:

477

478

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

479

</dl>

480

<dl><dt>__weakref__</dt>

481

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

482

</dl>

Joe Gregorio

2011-09-15 09:53:21 -0400

[diff] [blame]

483

<hr>

484

Data and other attributes defined here:

485

<dl><dt>NON_SERIALIZED_MEMBERS = ['store']</dl>

486

Joe Gregorio

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

[diff] [blame]

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

<a name="Error">class Error</a>(<a href="exceptions.html#Exception">exceptions.Exception</a>)</td></tr>

492

493

494

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

495

496

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

497

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

498

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

499

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

500

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

501

</dl>

502

<hr>

503

Data descriptors defined here:

504

<dl><dt>__weakref__</dt>

505

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

506

</dl>

507

<hr>

508

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

Joe Gregorio

2011-10-28 14:36:24 -0400

[diff] [blame^]

509

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

510

511

<hr>

512

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

513

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

514

515

<hr>

516

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

517

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

518

519

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

520

521

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

522

523

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

524

525

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

526

527

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

532

533

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

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

538

539

<hr>

540

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>

552

553

554

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

555

556

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

557

558

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

559

</dl>

560

<dl><dt>__weakref__</dt>

561

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

567

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

568

569

Joe Gregorio

ad258e2

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

[diff] [blame]

570

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

571

572

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

573

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

574

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

575

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

576

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

577

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

578

</dl>

579

<hr>

580

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

581

<dl><dt>__weakref__</dt>

582

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

583

</dl>

584

<hr>

585

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

Joe Gregorio

2011-10-28 14:36:24 -0400

[diff] [blame^]

586

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

587

588

<hr>

589

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

590

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

591

592

<hr>

593

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

594

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

595

596

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

597

598

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

599

600

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

601

602

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

603

604

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

609

610

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

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

615

616

<hr>

617

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]

628

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

629

630

Joe Gregorio

2011-09-15 09:53:21 -0400

[diff] [blame]

631

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

Joe Gregorio

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

[diff] [blame]

632

Joe Gregorio

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

[diff] [blame]

633

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

634

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

635

access token.

Joe Gregorio

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

[diff] [blame]

636

637

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

638

639

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

640

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

641

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

642

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

643

</dl>

644

<hr>

645

Methods defined here:

646

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

647

Joe Gregorio

2011-09-15 09:53:21 -0400

[diff] [blame]

648

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

Joe Gregorio

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

[diff] [blame]

649

650

This constructor is not usually called by the user, instead

Joe Gregorio

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

[diff] [blame]

651

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

652

653

Args:

Joe Gregorio

2011-09-15 09:53:21 -0400

[diff] [blame]

654

access_token: string, access token.

Joe Gregorio

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

[diff] [blame]

655

client_id: string, client identifier.

656

client_secret: string, client secret.

Joe Gregorio

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

[diff] [blame]

657

refresh_token: string, refresh token.

Joe Gregorio

2011-09-15 09:53:21 -0400

[diff] [blame]

658

token_expiry: datetime, when the access_token expires.

659

token_uri: string, URI of token endpoint.

Joe Gregorio

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

[diff] [blame]

660

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

661

Joe Gregorio

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

[diff] [blame]

662

Notes:

663

store: callable, a callable that when passed a Credential

664

will store the credential back to where it came from.

665

This is needed to store the latest access_token if it

666

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

667

668

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

669

Joe Gregorio

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

[diff] [blame]

670

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

671

672

Args:

Joe Gregorio

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

[diff] [blame]

673

http: An instance of httplib2.Http

674

or something that acts like it.

675

676

Returns:

677

A modified instance of http that was passed in.

Example:

h = httplib2.Http()

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

683

Joe Gregorio

2011-09-15 09:53:21 -0400

[diff] [blame]

684

You can't create a new OAuth subclass of httplib2.Authenication

685

because it never gets passed the absolute URI, which is needed for

686

signing. So instead we have to overload 'request' with a closure

687

that adds in the Authorization header and then calls the original

688

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

Joe Gregorio

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

[diff] [blame]

689

Joe Gregorio

2011-09-15 09:53:21 -0400

[diff] [blame]

690

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

Joe Gregorio

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

[diff] [blame]

691

692

Args:

Joe Gregorio

2011-09-15 09:53:21 -0400

[diff] [blame]

693

store: <a href="#Storage">Storage</a>, an implementation of Stroage <a href="__builtin__.html#object">object</a>.

Joe Gregorio

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

[diff] [blame]

694

This is needed to store the latest access_token if it

Joe Gregorio

2011-09-15 09:53:21 -0400

[diff] [blame]

695

has expired and been refreshed.  This implementation uses

696

locking to check for updates before updating the

697

access_token.</tt></dd></dl>

<hr>

Class methods defined here:

703

<dl><dt><a name="OAuth2Credentials-from_json">from_json</a>(cls, s) from <a href="__builtin__.html#type">__builtin__.type</a></dt><dd><tt>Instantiate a <a href="#Credentials">Credentials</a> <a href="__builtin__.html#object">object</a> from a JSON description of it. The JSON

704

should have been produced by calling .<a href="#OAuth2Credentials-to_json">to_json</a>() on the <a href="__builtin__.html#object">object</a>.

705

706

Args:

707

data: dict, A deserialized JSON <a href="__builtin__.html#object">object</a>.

708

709

Returns:

710

An instance of a <a href="#Credentials">Credentials</a> subclass.</tt></dd></dl>

Joe Gregorio

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

[diff] [blame]

711

712

<hr>

Joe Gregorio

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

[diff] [blame]

713

Data descriptors defined here:

Joe Gregorio

2011-09-15 09:53:21 -0400

[diff] [blame]

714

<dl><dt>access_token_expired</dt>

715

<dd><tt>True if the credential is expired or invalid.

716

717

If the token_expiry isn't set, we assume the token doesn't expire.</tt></dd>

Joe Gregorio

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

[diff] [blame]

718

</dl>

719

<hr>

Joe Gregorio

2011-09-15 09:53:21 -0400

[diff] [blame]

720

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

721

<dl><dt><a name="OAuth2Credentials-new_from_json">new_from_json</a>(cls, s) from <a href="__builtin__.html#type">__builtin__.type</a></dt><dd><tt>Utility class method to instantiate a <a href="#Credentials">Credentials</a> subclass from a JSON

722

representation produced by <a href="#OAuth2Credentials-to_json">to_json</a>().

723

724

Args:

725

s: string, JSON from <a href="#OAuth2Credentials-to_json">to_json</a>().

726

727

Returns:

728

An instance of the subclass of <a href="#Credentials">Credentials</a> that was serialized with

729

730

731

<hr>

Joe Gregorio

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

[diff] [blame]

732

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

733

734

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

735

</dl>

736

<dl><dt>__weakref__</dt>

737

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

738

</dl>

Joe Gregorio

2011-09-15 09:53:21 -0400

[diff] [blame]

739

<hr>

740

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

741

<dl><dt>NON_SERIALIZED_MEMBERS = ['store']</dl>

742

Joe Gregorio

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

[diff] [blame]

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

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

748

749

750

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

751

752

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

753

754

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

755

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

756

757

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

758

</dl>

759

<hr>

760

Methods defined here:

Joe Gregorio

2011-10-28 14:36:24 -0400

[diff] [blame^]

761

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

762

763

Args:

Joe Gregorio

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

[diff] [blame]

764

client_id: string, client identifier.

765

client_secret: string client secret.

Joe Gregorio

2011-10-28 14:36:24 -0400

[diff] [blame^]

766

scope: string or list of strings, scope(s) of the credentials being

767

requested.

Joe Gregorio

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

[diff] [blame]

768

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

Joe Gregorio

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

[diff] [blame]

769

auth_uri: string, URI for authorization endpoint. For convenience

770

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

771

token_uri: string, URI for token endpoint. For convenience

772

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]

773

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

774

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

775

776

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

777

778

Args:

779

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

780

application, or a URI that handles the callback from

781

the authorization server.

782

783

If redirect_uri is 'oob' then pass in the

784

generated verification code to step2_exchange,

785

otherwise pass in the query parameters received

786

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

787

Joe Gregorio

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

[diff] [blame]

788

<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

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

[diff] [blame]

789

790

Args:

791

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

792

of the query parameters to the redirect_uri, which contains

Joe Gregorio

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

[diff] [blame]

793

the code.

794

http: httplib2.Http, optional http instance to use to do the fetch</tt></dd></dl>

Joe Gregorio

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

[diff] [blame]

795

796

<hr>

797

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

798

799

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

800

</dl>

801

<dl><dt>__weakref__</dt>

802

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

</dl>

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

Joe Gregorio

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

[diff] [blame]

808

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

809

810

811

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

812

Joe Gregorio

2011-09-15 09:53:21 -0400

[diff] [blame]

813

Store and retrieve a single credential.  This class supports locking

814

such that multiple processes and threads can operate on a single

815

store.  </tt></td></tr>

Joe Gregorio

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

[diff] [blame]

816

817

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

Joe Gregorio

2011-09-15 09:53:21 -0400

[diff] [blame]

818

<dl><dt><a name="Storage-acquire_lock">acquire_lock</a>(self)</dt><dd><tt>Acquires any lock necessary to access this <a href="#Storage">Storage</a>.

819

820

This lock is not reentrant.</tt></dd></dl>

821

Joe Gregorio

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

[diff] [blame]

822

<dl><dt><a name="Storage-get">get</a>(self)</dt><dd><tt>Retrieve credential.

823

Joe Gregorio

2011-09-15 09:53:21 -0400

[diff] [blame]

824

The <a href="#Storage">Storage</a> lock must *not* be held when this is called.

825

Joe Gregorio

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

[diff] [blame]

826

Returns:

Joe Gregorio

20a5aa9

2011-04-01 17:44:25 -0400

[diff] [blame]

827

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

Joe Gregorio

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

[diff] [blame]

828

Joe Gregorio

2011-09-15 09:53:21 -0400

[diff] [blame]

829

<dl><dt><a name="Storage-locked_get">locked_get</a>(self)</dt><dd><tt>Retrieve credential.

830

831

The <a href="#Storage">Storage</a> lock must be held when this is called.

832

833

Returns:

834

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

835

836

<dl><dt><a name="Storage-locked_put">locked_put</a>(self, credentials)</dt><dd><tt>Write a credential.

837

838

The <a href="#Storage">Storage</a> lock must be held when this is called.

Joe Gregorio

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

[diff] [blame]

839

840

Args:

841

credentials: <a href="#Credentials">Credentials</a>, the credentials to store.</tt></dd></dl>

842

Joe Gregorio

2011-09-15 09:53:21 -0400

[diff] [blame]

843

<dl><dt><a name="Storage-put">put</a>(self, credentials)</dt><dd><tt>Write a credential.

844

845

The <a href="#Storage">Storage</a> lock must be held when this is called.

846

847

Args:

848

credentials: <a href="#Credentials">Credentials</a>, the credentials to store.</tt></dd></dl>

849

850

<dl><dt><a name="Storage-release_lock">release_lock</a>(self)</dt><dd><tt>Release the <a href="#Storage">Storage</a> lock.

851

852

Trying to release a lock that isn't held will result in a

853

RuntimeError.</tt></dd></dl>

854

Joe Gregorio

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

[diff] [blame]

855

<hr>

856

Data descriptors defined here:

857

858

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

859

</dl>

860

<dl><dt>__weakref__</dt>

861

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

862

</dl>

Joe Gregorio

2011-10-28 14:36:24 -0400

[diff] [blame^]

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

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

868

869

870

<td colspan=2><tt>The client secrets file called for an unknown type of OAuth 2.0 flow.  </tt></td></tr>

871

872

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

873

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

874

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

875

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

876

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

877

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

878

</dl>

879

<hr>

880

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

881

<dl><dt>__weakref__</dt>

882

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

883

</dl>

884

<hr>

885

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

886

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

887

888

<hr>

889

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

890

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

891

892

<hr>

893

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

894

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

895

896

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

897

898

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

899

900

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

901

902

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

903

904

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

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

909

910

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

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

915

916

<hr>

917

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

</dl>

</dl>

<dl><dt>message</dt>

</dl>

Joe Gregorio

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

[diff] [blame]

924

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

925

Joe Gregorio