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-12-08 12:04:24 -0500

[diff] [blame]

22

23

<a href="oauth2client.clientsecrets.html">oauth2client.clientsecrets</a>

Joe Gregorio

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

[diff] [blame]

24

Joe Gregorio

2011-12-08 12:04:24 -0500

[diff] [blame]

25

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

26

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

Joe Gregorio

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

[diff] [blame]

27

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

Joe Gregorio

2011-12-08 12:04:24 -0500

[diff] [blame]

28

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

29

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

30

31

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

Joe Gregorio

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

[diff] [blame]

32

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

Joe Gregorio

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

[diff] [blame]

33

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

Joe Gregorio

2011-12-08 12:04:24 -0500

[diff] [blame]

34

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

43

</dt><dd>

44

<dl>

45

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

46

</dt><dd>

47

<dl>

48

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

Joe Gregorio

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

[diff] [blame]

49

</dt><dd>

50

<dl>

51

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

Joe Gregorio

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

[diff] [blame]

52

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

Joe Gregorio

2011-12-08 12:04:24 -0500

[diff] [blame]

53

</dt><dd>

54

<dl>

55

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

Joe Gregorio

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

[diff] [blame]

56

</dt></dl>

57

</dd>

Joe Gregorio

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

[diff] [blame]

58

</dl>

59

</dd>

Joe Gregorio

2011-12-08 12:04:24 -0500

[diff] [blame]

60

</dl>

61

</dd>

Joe Gregorio

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

[diff] [blame]

</dt><dd>

<dl>

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

66

</dt></dl>

67

</dd>

Joe Gregorio

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

[diff] [blame]

68

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

69

</dt></dl>

Joe Gregorio

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

[diff] [blame]

70

</dd>

71

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

72

</dt><dd>

73

<dl>

74

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

75

</dt><dd>

76

<dl>

Joe Gregorio

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

[diff] [blame]

77

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

Joe Gregorio

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

[diff] [blame]

78

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

79

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

Joe Gregorio

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

[diff] [blame]

80

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

Joe Gregorio

2011-12-08 12:04:24 -0500

[diff] [blame]

81

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

91

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

92

93

Joe Gregorio

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

[diff] [blame]

94

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

95

Joe Gregorio

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

[diff] [blame]

96

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

97

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

98

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

99

use case where you have acquired an OAuth 2.0 access_token from

100

another place such as a JavaScript client or another web

101

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

102

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

Joe Gregorio

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

[diff] [blame]

103

expire.

104

Joe Gregorio

fffa7d7

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

[diff] [blame]

105

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

Joe Gregorio

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

[diff] [blame]

106

107

Usage:

108

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

109

'my-user-agent/1.0')

110

http = httplib2.Http()

111

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

112

113

Exceptions:

114

AccessTokenCredentialsExpired: raised when the access_token expires or is

115

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

116

117

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

118

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

119

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

120

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

121

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

122

</dl>

123

<hr>

124

Methods defined here:

125

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

126

127

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

128

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

129

130

Args:

Joe Gregorio

9384170

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

[diff] [blame]

131

access_token: string, access token.

Joe Gregorio

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

[diff] [blame]

132

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

133

134

Notes:

135

store: callable, a callable that when passed a Credential

136

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

137

138

<hr>

Joe Gregorio

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

[diff] [blame]

139

Class methods defined here:

140

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

141

142

<hr>

Joe Gregorio

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

[diff] [blame]

143

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

144

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

145

146

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

147

148

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

149

150

Args:

151

http: An instance of httplib2.Http

152

or something that acts like it.

153

154

Returns:

155

A modified instance of http that was passed in.

Example:

h = httplib2.Http()

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

161

Joe Gregorio

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

[diff] [blame]

162

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

163

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

164

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

165

that adds in the Authorization header and then calls the original

166

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

Joe Gregorio

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

[diff] [blame]

167

Joe Gregorio

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

[diff] [blame]

168

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

169

170

Args:

Joe Gregorio

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

[diff] [blame]

171

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]

172

This is needed to store the latest access_token if it

Joe Gregorio

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

[diff] [blame]

173

has expired and been refreshed.  This implementation uses

174

locking to check for updates before updating the

175

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

176

177

Joe Gregorio

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

[diff] [blame]

178

179

<hr>

Joe Gregorio

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

[diff] [blame]

180

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

Joe Gregorio

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

[diff] [blame]

181

<dl><dt>access_token_expired</dt>

182

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

183

184

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]

185

</dl>

186

<hr>

Joe Gregorio

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

[diff] [blame]

187

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

188

<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

189

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

190

191

Args:

192

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

193

194

Returns:

195

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

196

197

198

<hr>

Joe Gregorio

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

[diff] [blame]

199

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

200

201

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

202

</dl>

203

<dl><dt>__weakref__</dt>

204

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

205

</dl>

Joe Gregorio

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

[diff] [blame]

206

<hr>

207

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

208

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

209

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>

215

216

217

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

218

219

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

220

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

221

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

222

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

223

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

224

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

225

</dl>

226

<hr>

227

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

228

<dl><dt>__weakref__</dt>

229

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

230

</dl>

231

<hr>

232

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

Joe Gregorio

2011-12-08 12:04:24 -0500

[diff] [blame]

233

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

234

235

<hr>

236

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

237

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

238

239

<hr>

240

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

241

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

242

243

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

244

245

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

246

247

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

248

249

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

250

251

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

256

257

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

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

262

263

<hr>

264

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]

275

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

276

277

Joe Gregorio

ad258e2

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

[diff] [blame]

278

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

279

280

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

281

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

282

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

283

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

284

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

285

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

286

</dl>

287

<hr>

288

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

289

<dl><dt>__weakref__</dt>

290

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

291

</dl>

292

<hr>

293

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

Joe Gregorio

2011-12-08 12:04:24 -0500

[diff] [blame]

294

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

295

296

<hr>

297

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

298

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

299

300

<hr>

301

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

302

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

303

304

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

305

306

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

307

308

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

309

310

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

311

312

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

317

318

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

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

323

324

<hr>

325

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]

336

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

337

338

Joe Gregorio

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

[diff] [blame]

339

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

340

Joe Gregorio

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

[diff] [blame]

341

This credential does not require a flow to instantiate because it

342

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

343

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

344

be subclassed to generate the appropriate assertion string.

Joe Gregorio

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

[diff] [blame]

345

346

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

347

348

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

349

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

350

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

351

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

352

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

353

</dl>

354

<hr>

355

Methods defined here:

Joe Gregorio

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

[diff] [blame]

356

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

357

358

Args:

359

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

360

server

361

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

362

token_uri: string, URI for token endpoint. For convenience

363

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

364

365

<hr>

366

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

367

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

368

369

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

370

371

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

372

373

Args:

374

http: An instance of httplib2.Http

375

or something that acts like it.

376

377

Returns:

378

A modified instance of http that was passed in.

Example:

h = httplib2.Http()

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

384

Joe Gregorio

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

[diff] [blame]

385

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

386

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

387

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

388

that adds in the Authorization header and then calls the original

389

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

Joe Gregorio

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

[diff] [blame]

390

Joe Gregorio

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

[diff] [blame]

391

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

392

393

Args:

Joe Gregorio

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

[diff] [blame]

394

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]

395

This is needed to store the latest access_token if it

Joe Gregorio

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

[diff] [blame]

396

has expired and been refreshed.  This implementation uses

397

locking to check for updates before updating the

398

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

<hr>

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

404

<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

405

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

406

407

Args:

408

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

409

410

Returns:

411

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

Joe Gregorio

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

[diff] [blame]

412

413

<hr>

414

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

Joe Gregorio

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

[diff] [blame]

415

<dl><dt>access_token_expired</dt>

416

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

417

418

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]

419

</dl>

420

<hr>

Joe Gregorio

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

[diff] [blame]

421

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

422

<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

423

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

424

425

Args:

426

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

427

428

Returns:

429

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

430

431

432

<hr>

Joe Gregorio

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

[diff] [blame]

433

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

434

435

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

436

</dl>

437

<dl><dt>__weakref__</dt>

438

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

439

</dl>

Joe Gregorio

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

[diff] [blame]

440

<hr>

441

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

442

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

443

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]

448

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

449

450

451

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

452

Joe Gregorio

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

[diff] [blame]

453

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

454

an HTTP transport.

455

456

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

457

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]

458

459

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

460

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

461

authorizes it for the set of credentials, usually by

462

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

463

the appropriate headers and then delegates to the original

464

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

465

Joe Gregorio

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

[diff] [blame]

466

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

467

468

Returns:

469

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

470

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

471

472

<hr>

473

Class methods defined here:

474

<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

475

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

476

477

Args:

478

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

479

480

Returns:

481

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

482

483

Joe Gregorio

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

[diff] [blame]

484

<hr>

485

Data descriptors defined here:

486

487

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

488

</dl>

489

<dl><dt>__weakref__</dt>

490

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

491

</dl>

Joe Gregorio

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

[diff] [blame]

492

<hr>

493

Data and other attributes defined here:

494

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

495

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>

501

502

503

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

504

505

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

506

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

507

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

508

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

509

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

510

</dl>

511

<hr>

512

Data descriptors defined here:

513

<dl><dt>__weakref__</dt>

514

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

515

</dl>

516

<hr>

517

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

Joe Gregorio

2011-12-08 12:04:24 -0500

[diff] [blame]

518

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

519

520

<hr>

521

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

522

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

523

524

<hr>

525

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

526

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

527

528

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

529

530

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

531

532

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

533

534

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

535

536

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

541

542

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

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

547

548

<hr>

549

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>

561

562

563

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

564

565

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

566

567

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

568

</dl>

569

<dl><dt>__weakref__</dt>

570

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

576

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

577

578

Joe Gregorio

ad258e2

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

[diff] [blame]

579

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

580

581

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

582

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

583

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

584

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

585

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

586

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

587

</dl>

588

<hr>

589

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

590

<dl><dt>__weakref__</dt>

591

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

592

</dl>

593

<hr>

594

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

Joe Gregorio

2011-12-08 12:04:24 -0500

[diff] [blame]

595

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

596

597

<hr>

598

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

599

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

600

601

<hr>

602

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

603

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

604

605

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

606

607

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

608

609

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

610

611

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

612

613

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

618

619

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

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

624

625

<hr>

626

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]

637

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

638

639

Joe Gregorio

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

[diff] [blame]

640

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

641

Joe Gregorio

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

[diff] [blame]

642

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

Joe Gregorio

2011-12-08 12:04:24 -0500

[diff] [blame]

643

method, which then adds the OAuth 2.0 access token to each request.

Joe Gregorio

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

[diff] [blame]

644

645

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

646

647

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

648

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

649

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

650

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

651

</dl>

652

<hr>

653

Methods defined here:

654

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

655

Joe Gregorio

2011-12-08 12:04:24 -0500

[diff] [blame]

656

<dl><dt><a name="OAuth2Credentials-__init__">__init__</a>(self, access_token, client_id, client_secret, refresh_token, token_expiry, token_uri, user_agent, id_token=None)</dt><dd><tt>Create an instance of <a href="#OAuth2Credentials">OAuth2Credentials</a>.

Joe Gregorio

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

[diff] [blame]

657

658

This constructor is not usually called by the user, instead

Joe Gregorio

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

[diff] [blame]

659

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

660

661

Args:

Joe Gregorio

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

[diff] [blame]

662

access_token: string, access token.

Joe Gregorio

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

[diff] [blame]

663

client_id: string, client identifier.

664

client_secret: string, client secret.

Joe Gregorio

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

[diff] [blame]

665

refresh_token: string, refresh token.

Joe Gregorio

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

[diff] [blame]

666

token_expiry: datetime, when the access_token expires.

667

token_uri: string, URI of token endpoint.

Joe Gregorio

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

[diff] [blame]

668

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

Joe Gregorio

2011-12-08 12:04:24 -0500

[diff] [blame]

669

id_token: <a href="__builtin__.html#object">object</a>, The identity of the resource owner.

Joe Gregorio

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

[diff] [blame]

670

Joe Gregorio

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

[diff] [blame]

671

Notes:

Joe Gregorio

2011-12-08 12:04:24 -0500

[diff] [blame]

672

store: callable, A callable that when passed a Credential

Joe Gregorio

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

[diff] [blame]

673

will store the credential back to where it came from.

674

This is needed to store the latest access_token if it

675

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

676

677

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

678

Joe Gregorio

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

[diff] [blame]

679

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

680

681

Args:

Joe Gregorio

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

[diff] [blame]

682

http: An instance of httplib2.Http

683

or something that acts like it.

684

685

Returns:

686

A modified instance of http that was passed in.

Example:

h = httplib2.Http()

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

692

Joe Gregorio

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

[diff] [blame]

693

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

694

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

695

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

696

that adds in the Authorization header and then calls the original

697

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

Joe Gregorio

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

[diff] [blame]

698

Joe Gregorio

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

[diff] [blame]

699

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

700

701

Args:

Joe Gregorio

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

[diff] [blame]

702

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]

703

This is needed to store the latest access_token if it

Joe Gregorio

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

[diff] [blame]

704

has expired and been refreshed.  This implementation uses

705

locking to check for updates before updating the

706

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

<hr>

Class methods defined here:

712

<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

713

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

714

715

Args:

716

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

717

718

Returns:

719

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

Joe Gregorio

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

[diff] [blame]

720

721

<hr>

Joe Gregorio

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

[diff] [blame]

722

Data descriptors defined here:

Joe Gregorio

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

[diff] [blame]

723

<dl><dt>access_token_expired</dt>

724

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

725

726

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]

727

</dl>

728

<hr>

Joe Gregorio

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

[diff] [blame]

729

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

730

<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

731

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

732

733

Args:

734

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

735

736

Returns:

737

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

738

739

740

<hr>

Joe Gregorio

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

[diff] [blame]

741

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

742

743

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

744

</dl>

745

<dl><dt>__weakref__</dt>

746

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

747

</dl>

Joe Gregorio

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

[diff] [blame]

748

<hr>

749

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

750

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

751

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>

757

758

759

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

760

761

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

762

763

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

764

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

765

766

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

767

</dl>

768

<hr>

769

Methods defined here:

Joe Gregorio

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

[diff] [blame]

770

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

771

772

Args:

Joe Gregorio

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

[diff] [blame]

773

client_id: string, client identifier.

774

client_secret: string client secret.

Joe Gregorio

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

[diff] [blame]

775

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

776

requested.

Joe Gregorio

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

[diff] [blame]

777

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

Joe Gregorio

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

[diff] [blame]

778

auth_uri: string, URI for authorization endpoint. For convenience

779

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

780

token_uri: string, URI for token endpoint. For convenience

781

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]

782

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

783

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

784

785

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

786

787

Args:

788

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

789

application, or a URI that handles the callback from

790

the authorization server.

791

792

If redirect_uri is 'oob' then pass in the

793

generated verification code to step2_exchange,

794

otherwise pass in the query parameters received

795

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

796

Joe Gregorio

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

[diff] [blame]

797

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

798

799

Args:

800

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

801

of the query parameters to the redirect_uri, which contains

Joe Gregorio

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

[diff] [blame]

802

the code.

803

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]

804

805

<hr>

806

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

807

808

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

809

</dl>

810

<dl><dt>__weakref__</dt>

811

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

</dl>

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

Joe Gregorio

2011-12-08 12:04:24 -0500

[diff] [blame]

817

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

818

819

820

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

821

822

This credential does not require a flow to instantiate because it

823

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

824

information to generate and refresh its own access tokens.  </tt></td></tr>

825

826

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

827

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

828

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

829

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

830

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

831

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

832

</dl>

833

<hr>

834

Methods defined here:

835

<dl><dt><a name="SignedJwtAssertionCredentials-__init__">__init__</a>(self, service_account_name, private_key, scope, private_key_password='notasecret', user_agent=None, token_uri='https://accounts.google.com/o/oauth2/token', **kwargs)</dt><dd><tt>Constructor for <a href="#SignedJwtAssertionCredentials">SignedJwtAssertionCredentials</a>.

836

837

Args:

838

service_account_name: string, id for account, usually an email address.

839

private_key: string, private key in P12 format.

840

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

841

requested.

842

private_key_password: string, password for private_key.

843

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

844

token_uri: string, URI for token endpoint. For convenience

845

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

846

kwargs: kwargs, Additional parameters to add to the JWT token, for

847

example prn=joe@xample.org.</tt></dd></dl>

848

849

<hr>

850

Class methods defined here:

851

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

852

853

<hr>

854

Data and other attributes defined here:

855

<dl><dt>MAX_TOKEN_LIFETIME_SECS = 3600</dl>

856

857

<hr>

858

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

859

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

860

861

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

862

863

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

864

865

Args:

866

http: An instance of httplib2.Http

867

or something that acts like it.

868

869

Returns:

870

A modified instance of http that was passed in.

Example:

h = httplib2.Http()

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

876

877

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

878

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

879

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

880

that adds in the Authorization header and then calls the original

881

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

882

883

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

884

885

Args:

886

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

887

This is needed to store the latest access_token if it

888

has expired and been refreshed.  This implementation uses

889

locking to check for updates before updating the

890

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

<hr>

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

896

<dl><dt>access_token_expired</dt>

897

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

898

899

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

900

</dl>

901

<hr>

902

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

903

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

904

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

905

906

Args:

907

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

908

909

Returns:

910

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

<hr>

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

915

916

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

917

</dl>

918

<dl><dt>__weakref__</dt>

919

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

920

</dl>

921

<hr>

922

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

923

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

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

Joe Gregorio

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

[diff] [blame]

929

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

930

931

932

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

933

Joe Gregorio

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

[diff] [blame]

934

Store and retrieve a single credential.  This class supports locking

935

such that multiple processes and threads can operate on a single

936

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

Joe Gregorio

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

[diff] [blame]

937

938

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

Joe Gregorio

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

[diff] [blame]

939

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

940

941

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

942

Joe Gregorio

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

[diff] [blame]

943

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

944

Joe Gregorio

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

[diff] [blame]

945

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

946

Joe Gregorio

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

[diff] [blame]

947

Returns:

Joe Gregorio

20a5aa9

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

[diff] [blame]

948

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

Joe Gregorio

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

[diff] [blame]

949

Joe Gregorio

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

[diff] [blame]

950

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

951

952

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

953

954

Returns:

955

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

956

957

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

958

959

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]

960

961

Args:

962

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

963

Joe Gregorio

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

[diff] [blame]

964

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

965

966

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

967

968

Args:

969

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

970

971

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

972

973

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

974

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

975

Joe Gregorio

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

[diff] [blame]

976

<hr>

977

Data descriptors defined here:

978

979

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

980

</dl>

981

<dl><dt>__weakref__</dt>

982

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

983

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

989

990

991

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

992

993

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

994

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

995

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

996

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

997

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

998

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

999

</dl>

1000

<hr>

1001

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

1002

<dl><dt>__weakref__</dt>

1003

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

1004

</dl>

1005

<hr>

1006

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

Joe Gregorio

2011-12-08 12:04:24 -0500

[diff] [blame]

1007

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

Joe Gregorio

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

[diff] [blame]

1008

1009

<hr>

1010

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

1011

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

1012

1013

<hr>

1014

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

1015

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

1016

1017

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

1018

1019

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

1020

1021

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

1022

1023

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

1024

1025

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

1030

1031

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

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

1036

1037

<hr>

1038

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

</dl>

</dl>

<dl><dt>message</dt>

</dl>

Joe Gregorio

2011-12-08 12:04:24 -0500

[diff] [blame]

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

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

1050

1051

1052

<td colspan=2><tt>Could on retrieve certificates for validation.  </tt></td></tr>

1053

1054

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

1055

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

1056

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

1057

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

1058

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

1059

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

1060

</dl>

1061

<hr>

1062

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

1063

<dl><dt>__weakref__</dt>

1064

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

1065

</dl>

1066

<hr>

1067

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

1068

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

1069

1070

<hr>

1071

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

1072

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

1073

1074

<hr>

1075

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

1076

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

1077

1078

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

1079

1080

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

1081

1082

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

1083

1084

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

1085

1086

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

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

1091

1092

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

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

1097

1098

<hr>

1099

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]

1106

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

1107

Joe Gregorio

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

[diff] [blame]

1108

1109

1110

<big>Functions</big></td></tr>

1111

1112

1113

<td width="100%"><dl><dt><a name="-flow_from_clientsecrets">flow_from_clientsecrets</a>(filename, scope, message=None)</dt><dd><tt>Create a <a href="#Flow">Flow</a> from a clientsecrets file.

1114

1115

Will create the right kind of <a href="#Flow">Flow</a> based on the contents of the clientsecrets

1116

file or will raise InvalidClientSecretsError for unknown types of Flows.

1117

1118

Args:

1119

filename: string, File name of client secrets.

1120

scope: string or list of strings, scope(s) to request.

1121

message: string, A friendly string to display to the user if the

1122

clientsecrets file is missing or invalid. If message is provided then

1123

sys.exit will be called in the case of an error. If message in not

1124

provided then clientsecrets.InvalidClientSecretsError will be raised.

1125

1126

Returns:

1127

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

1128

1129

Raises:

1130

<a href="#UnknownClientSecretsFlowError">UnknownClientSecretsFlowError</a> if the file describes an unknown kind of <a href="#Flow">Flow</a>.

1131

clientsecrets.InvalidClientSecretsError if the clientsecrets file is

1132

invalid.</tt></dd></dl>

Joe Gregorio