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

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>

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

27

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

28

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

29

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

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

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

38

</dt><dd>

39

<dl>

40

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

41

</dt><dd>

42

<dl>

43

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

Joe Gregorio

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

[diff] [blame]

44

</dt><dd>

45

<dl>

46

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

Joe Gregorio

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

[diff] [blame]

47

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

Joe Gregorio

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

[diff] [blame]

48

</dt></dl>

49

</dd>

Joe Gregorio

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

[diff] [blame]

50

</dl>

51

</dd>

Joe Gregorio

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

[diff] [blame]

</dt><dd>

<dl>

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

56

</dt></dl>

57

</dd>

Joe Gregorio

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

[diff] [blame]

58

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

59

</dt></dl>

Joe Gregorio

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

[diff] [blame]

60

</dd>

61

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

62

</dt><dd>

63

<dl>

64

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

65

</dt><dd>

66

<dl>

Joe Gregorio

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

[diff] [blame]

67

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

Joe Gregorio

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

[diff] [blame]

68

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

69

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

79

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

80

81

Joe Gregorio

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

[diff] [blame]

82

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

83

Joe Gregorio

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

[diff] [blame]

84

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

85

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

86

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

87

use case where you have acquired an OAuth 2.0 access_token from

88

another place such as a JavaScript client or another web

89

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

90

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

Joe Gregorio

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

[diff] [blame]

91

expire.

92

Joe Gregorio

fffa7d7

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

[diff] [blame]

93

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

Joe Gregorio

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

[diff] [blame]

94

95

Usage:

96

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

97

'my-user-agent/1.0')

98

http = httplib2.Http()

99

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

100

101

Exceptions:

102

AccessTokenCredentialsExpired: raised when the access_token expires or is

103

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

104

105

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

106

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

107

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

108

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

109

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

110

</dl>

111

<hr>

112

Methods defined here:

113

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

114

115

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

116

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

117

118

Args:

Joe Gregorio

9384170

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

[diff] [blame]

119

access_token: string, access token.

Joe Gregorio

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

[diff] [blame]

120

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

121

122

Notes:

123

store: callable, a callable that when passed a Credential

124

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

125

126

<hr>

Joe Gregorio

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

[diff] [blame]

127

Class methods defined here:

128

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

129

130

<hr>

Joe Gregorio

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

[diff] [blame]

131

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

132

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

133

134

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

135

136

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

137

138

Args:

139

http: An instance of httplib2.Http

140

or something that acts like it.

141

142

Returns:

143

A modified instance of http that was passed in.

Example:

h = httplib2.Http()

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

149

Joe Gregorio

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

[diff] [blame]

150

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

151

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

152

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

153

that adds in the Authorization header and then calls the original

154

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

Joe Gregorio

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

[diff] [blame]

155

Joe Gregorio

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

[diff] [blame]

156

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

157

158

Args:

Joe Gregorio

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

[diff] [blame]

159

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]

160

This is needed to store the latest access_token if it

Joe Gregorio

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

[diff] [blame]

161

has expired and been refreshed.  This implementation uses

162

locking to check for updates before updating the

163

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

164

165

Joe Gregorio

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

[diff] [blame]

166

167

<hr>

Joe Gregorio

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

[diff] [blame]

168

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

Joe Gregorio

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

[diff] [blame]

169

<dl><dt>access_token_expired</dt>

170

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

171

172

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]

173

</dl>

174

<hr>

Joe Gregorio

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

[diff] [blame]

175

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

176

<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

177

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

178

179

Args:

180

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

181

182

Returns:

183

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

184

185

186

<hr>

Joe Gregorio

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

[diff] [blame]

187

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

188

189

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

190

</dl>

191

<dl><dt>__weakref__</dt>

192

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

193

</dl>

Joe Gregorio

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

[diff] [blame]

194

<hr>

195

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

196

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

197

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>

203

204

205

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

206

207

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

208

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

209

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

210

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

211

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

212

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

213

</dl>

214

<hr>

215

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

216

<dl><dt>__weakref__</dt>

217

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

218

</dl>

219

<hr>

220

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

Joe Gregorio

2011-07-06 10:09:20 -0400

[diff] [blame]

221

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

Joe Gregorio

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

[diff] [blame]

222

223

<hr>

224

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

225

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

226

227

<hr>

228

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

229

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

230

231

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

232

233

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

234

235

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

236

237

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

238

239

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

244

245

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

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

250

251

<hr>

252

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]

263

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

264

265

Joe Gregorio

ad258e2

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

[diff] [blame]

266

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

267

268

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

269

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

270

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

271

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

272

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

273

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

274

</dl>

275

<hr>

276

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

277

<dl><dt>__weakref__</dt>

278

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

279

</dl>

280

<hr>

281

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

Joe Gregorio

2011-07-06 10:09:20 -0400

[diff] [blame]

282

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

Joe Gregorio

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

[diff] [blame]

283

284

<hr>

285

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

286

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

287

288

<hr>

289

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

290

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

291

292

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

293

294

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

295

296

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

297

298

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

299

300

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

305

306

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

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

311

312

<hr>

313

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]

324

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

325

326

Joe Gregorio

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

[diff] [blame]

327

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

328

Joe Gregorio

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

[diff] [blame]

329

This credential does not require a flow to instantiate because it

330

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

331

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

332

be subclassed to generate the appropriate assertion string.

Joe Gregorio

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

[diff] [blame]

333

334

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

335

336

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

337

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

338

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

339

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

340

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

341

</dl>

342

<hr>

343

Methods defined here:

Joe Gregorio

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

[diff] [blame]

344

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

345

346

Args:

347

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

348

server

349

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

350

token_uri: string, URI for token endpoint. For convenience

351

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

352

353

<hr>

354

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

355

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

356

357

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

358

359

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

360

361

Args:

362

http: An instance of httplib2.Http

363

or something that acts like it.

364

365

Returns:

366

A modified instance of http that was passed in.

Example:

h = httplib2.Http()

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

372

Joe Gregorio

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

[diff] [blame]

373

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

374

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

375

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

376

that adds in the Authorization header and then calls the original

377

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

Joe Gregorio

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

[diff] [blame]

378

Joe Gregorio

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

[diff] [blame]

379

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

380

381

Args:

Joe Gregorio

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

[diff] [blame]

382

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]

383

This is needed to store the latest access_token if it

Joe Gregorio

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

[diff] [blame]

384

has expired and been refreshed.  This implementation uses

385

locking to check for updates before updating the

386

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

<hr>

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

392

<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

393

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

394

395

Args:

396

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

397

398

Returns:

399

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

Joe Gregorio

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

[diff] [blame]

400

401

<hr>

402

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

Joe Gregorio

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

[diff] [blame]

403

<dl><dt>access_token_expired</dt>

404

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

405

406

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]

407

</dl>

408

<hr>

Joe Gregorio

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

[diff] [blame]

409

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

410

<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

411

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

412

413

Args:

414

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

415

416

Returns:

417

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

418

419

420

<hr>

Joe Gregorio

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

[diff] [blame]

421

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

422

423

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

424

</dl>

425

<dl><dt>__weakref__</dt>

426

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

427

</dl>

Joe Gregorio

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

[diff] [blame]

428

<hr>

429

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

430

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

431

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]

436

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

437

438

439

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

440

Joe Gregorio

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

[diff] [blame]

441

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

442

an HTTP transport.

443

444

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

445

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]

446

447

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

448

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

449

authorizes it for the set of credentials, usually by

450

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

451

the appropriate headers and then delegates to the original

452

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

453

Joe Gregorio

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

[diff] [blame]

454

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

455

456

Returns:

457

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

458

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

459

460

<hr>

461

Class methods defined here:

462

<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

463

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

464

465

Args:

466

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

467

468

Returns:

469

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

470

471

Joe Gregorio

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

[diff] [blame]

472

<hr>

473

Data descriptors defined here:

474

475

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

476

</dl>

477

<dl><dt>__weakref__</dt>

478

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

479

</dl>

Joe Gregorio

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

[diff] [blame]

480

<hr>

481

Data and other attributes defined here:

482

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

483

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>

489

490

491

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

492

493

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

494

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

495

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

496

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

497

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

498

</dl>

499

<hr>

500

Data descriptors defined here:

501

<dl><dt>__weakref__</dt>

502

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

503

</dl>

504

<hr>

505

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

Joe Gregorio

2011-07-06 10:09:20 -0400

[diff] [blame]

506

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

Joe Gregorio

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

[diff] [blame]

507

508

<hr>

509

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

510

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

511

512

<hr>

513

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

514

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

515

516

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

517

518

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

519

520

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

521

522

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

523

524

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

529

530

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

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

535

536

<hr>

537

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>

549

550

551

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

552

553

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

554

555

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

556

</dl>

557

<dl><dt>__weakref__</dt>

558

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

564

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

565

566

Joe Gregorio

ad258e2

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

[diff] [blame]

567

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

568

569

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

570

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

571

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

572

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

573

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

574

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

575

</dl>

576

<hr>

577

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

578

<dl><dt>__weakref__</dt>

579

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

580

</dl>

581

<hr>

582

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

Joe Gregorio

2011-07-06 10:09:20 -0400

[diff] [blame]

583

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

Joe Gregorio

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

[diff] [blame]

584

585

<hr>

586

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

587

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

588

589

<hr>

590

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

591

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

592

593

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

594

595

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

596

597

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

598

599

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

600

601

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

606

607

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

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

612

613

<hr>

614

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]

625

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

626

627

Joe Gregorio

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

[diff] [blame]

628

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

629

Joe Gregorio

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

[diff] [blame]

630

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

631

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

632

access token.

Joe Gregorio

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

[diff] [blame]

633

634

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

635

636

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

637

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

638

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

639

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

640

</dl>

641

<hr>

642

Methods defined here:

643

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

644

Joe Gregorio

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

[diff] [blame]

645

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

646

647

This constructor is not usually called by the user, instead

Joe Gregorio

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

[diff] [blame]

648

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

649

650

Args:

Joe Gregorio

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

[diff] [blame]

651

access_token: string, access token.

Joe Gregorio

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

[diff] [blame]

652

client_id: string, client identifier.

653

client_secret: string, client secret.

Joe Gregorio

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

[diff] [blame]

654

refresh_token: string, refresh token.

Joe Gregorio

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

[diff] [blame]

655

token_expiry: datetime, when the access_token expires.

656

token_uri: string, URI of token endpoint.

Joe Gregorio

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

[diff] [blame]

657

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

658

Joe Gregorio

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

[diff] [blame]

659

Notes:

660

store: callable, a callable that when passed a Credential

661

will store the credential back to where it came from.

662

This is needed to store the latest access_token if it

663

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

664

665

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

666

Joe Gregorio

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

[diff] [blame]

667

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

668

669

Args:

Joe Gregorio

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

[diff] [blame]

670

http: An instance of httplib2.Http

671

or something that acts like it.

672

673

Returns:

674

A modified instance of http that was passed in.

Example:

h = httplib2.Http()

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

680

Joe Gregorio

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

[diff] [blame]

681

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

682

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

683

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

684

that adds in the Authorization header and then calls the original

685

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

Joe Gregorio

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

[diff] [blame]

686

Joe Gregorio

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

[diff] [blame]

687

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

688

689

Args:

Joe Gregorio

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

[diff] [blame]

690

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]

691

This is needed to store the latest access_token if it

Joe Gregorio

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

[diff] [blame]

692

has expired and been refreshed.  This implementation uses

693

locking to check for updates before updating the

694

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

<hr>

Class methods defined here:

700

<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

701

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

702

703

Args:

704

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

705

706

Returns:

707

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

Joe Gregorio

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

[diff] [blame]

708

709

<hr>

Joe Gregorio

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

[diff] [blame]

710

Data descriptors defined here:

Joe Gregorio

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

[diff] [blame]

711

<dl><dt>access_token_expired</dt>

712

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

713

714

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]

715

</dl>

716

<hr>

Joe Gregorio

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

[diff] [blame]

717

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

718

<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

719

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

720

721

Args:

722

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

723

724

Returns:

725

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

726

727

728

<hr>

Joe Gregorio

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

[diff] [blame]

729

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

730

731

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

732

</dl>

733

<dl><dt>__weakref__</dt>

734

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

735

</dl>

Joe Gregorio

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

[diff] [blame]

736

<hr>

737

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

738

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

739

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>

745

746

747

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

748

749

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

750

751

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

752

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

753

754

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

755

</dl>

756

<hr>

757

Methods defined here:

Joe Gregorio

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

[diff] [blame]

758

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

759

760

Args:

Joe Gregorio

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

[diff] [blame]

761

client_id: string, client identifier.

762

client_secret: string client secret.

763

scope: string, scope of the credentials being requested.

Joe Gregorio

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

[diff] [blame]

764

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

Joe Gregorio

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

[diff] [blame]

765

auth_uri: string, URI for authorization endpoint. For convenience

766

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

767

token_uri: string, URI for token endpoint. For convenience

768

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]

769

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

770

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

771

772

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

773

774

Args:

775

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

776

application, or a URI that handles the callback from

777

the authorization server.

778

779

If redirect_uri is 'oob' then pass in the

780

generated verification code to step2_exchange,

781

otherwise pass in the query parameters received

782

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

783

Joe Gregorio

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

[diff] [blame]

784

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

785

786

Args:

787

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

788

of the query parameters to the redirect_uri, which contains

Joe Gregorio

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

[diff] [blame]

789

the code.

790

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]

791

792

<hr>

793

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

794

795

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

796

</dl>

797

<dl><dt>__weakref__</dt>

798

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

804

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

805

806

807

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

808

Joe Gregorio

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

[diff] [blame]

809

Store and retrieve a single credential.  This class supports locking

810

such that multiple processes and threads can operate on a single

811

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

Joe Gregorio

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

[diff] [blame]

812

813

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

Joe Gregorio

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

[diff] [blame]

814

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

815

816

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

817

Joe Gregorio

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

[diff] [blame]

818

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

819

Joe Gregorio

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

[diff] [blame]

820

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

821

Joe Gregorio

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

[diff] [blame]

822

Returns:

Joe Gregorio

20a5aa9

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

[diff] [blame]

823

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

Joe Gregorio

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

[diff] [blame]

824

Joe Gregorio

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

[diff] [blame]

825

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

826

827

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

828

829

Returns:

830

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

831

832

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

833

834

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]

835

836

Args:

837

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

838

Joe Gregorio

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

[diff] [blame]

839

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

840

841

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

842

843

Args:

844

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

845

846

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

847

848

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

849

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

850

Joe Gregorio

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

[diff] [blame]

851

<hr>

852

Data descriptors defined here:

853

854

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

855

</dl>

856

<dl><dt>__weakref__</dt>

857

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

858

</dl>

Joe Gregorio

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

[diff] [blame]

859

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

Joe Gregorio

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

[diff] [blame]

866

<td width="100%">EXPIRY_FORMAT = '%Y-%m-%dT%H:%M:%S.%fZ'

867

__author__ = 'jcgregorio@google.com (Joe Gregorio)'

868

logger = <logging.Logger instance></td></tr></table>

Joe Gregorio