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>

Joe Gregorio

2012-02-21 10:11:19 -0500

[diff] [blame]

29

Joe Gregorio

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

[diff] [blame]

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

2012-02-21 10:11:19 -0500

[diff] [blame]

68

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

69

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

Joe Gregorio

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

[diff] [blame]

70

</dt></dl>

Joe Gregorio

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

[diff] [blame]

71

</dd>

72

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

73

</dt><dd>

74

<dl>

75

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

76

</dt><dd>

77

<dl>

Joe Gregorio

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

[diff] [blame]

78

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

Joe Gregorio

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

[diff] [blame]

79

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

80

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

Joe Gregorio

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

[diff] [blame]

81

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

Joe Gregorio

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

[diff] [blame]

82

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

92

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

93

94

Joe Gregorio

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

[diff] [blame]

95

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

96

Joe Gregorio

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

[diff] [blame]

97

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

98

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

99

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

100

use case where you have acquired an OAuth 2.0 access_token from

101

another place such as a JavaScript client or another web

102

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

103

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

Joe Gregorio

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

[diff] [blame]

104

expire.

105

Joe Gregorio

fffa7d7

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

[diff] [blame]

106

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

Joe Gregorio

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

[diff] [blame]

107

108

Usage:

109

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

110

'my-user-agent/1.0')

111

http = httplib2.Http()

112

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

113

114

Exceptions:

115

AccessTokenCredentialsExpired: raised when the access_token expires or is

116

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

117

118

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

119

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

120

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

121

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

122

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

123

</dl>

124

<hr>

125

Methods defined here:

126

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

127

128

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

129

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

130

131

Args:

Joe Gregorio

9384170

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

[diff] [blame]

132

access_token: string, access token.

Joe Gregorio

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

[diff] [blame]

133

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

134

135

Notes:

136

store: callable, a callable that when passed a Credential

137

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

138

139

<hr>

Joe Gregorio

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

[diff] [blame]

140

Class methods defined here:

141

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

142

143

<hr>

Joe Gregorio

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

[diff] [blame]

144

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

145

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

146

147

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

148

Joe Gregorio

2012-02-21 10:11:19 -0500

[diff] [blame]

149

<dl><dt><a name="AccessTokenCredentials-apply">apply</a>(self, headers)</dt><dd><tt>Add the authorization to the headers.

150

151

Args:

152

headers: dict, the headers to add the Authorization header to.</tt></dd></dl>

153

Joe Gregorio

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

[diff] [blame]

154

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

155

Joe Gregorio

2012-02-21 10:11:19 -0500

[diff] [blame]

156

The modified http.request method will add authentication headers to each

157

request and will refresh access_tokens when a 401 is received on a

158

request. In addition the http.request method has a credentials property,

159

http.request.credentials, which is the <a href="#Credentials">Credentials</a> <a href="__builtin__.html#object">object</a> that authorized

160

it.

161

Joe Gregorio

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

[diff] [blame]

162

Args:

163

http: An instance of httplib2.Http

164

or something that acts like it.

165

166

Returns:

167

A modified instance of http that was passed in.

Example:

h = httplib2.Http()

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

173

Joe Gregorio

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

[diff] [blame]

174

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

175

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

176

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

177

that adds in the Authorization header and then calls the original

178

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

Joe Gregorio

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

[diff] [blame]

179

Joe Gregorio

2012-02-21 10:11:19 -0500

[diff] [blame]

180

<dl><dt><a name="AccessTokenCredentials-refresh">refresh</a>(self, http)</dt><dd><tt>Forces a refresh of the access_token.

181

182

Args:

183

http: httplib2.Http, an http <a href="__builtin__.html#object">object</a> to be used to make the refresh

184

request.</tt></dd></dl>

185

Joe Gregorio

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

[diff] [blame]

186

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

187

188

Args:

Joe Gregorio

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

[diff] [blame]

189

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]

190

This is needed to store the latest access_token if it

Joe Gregorio

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

[diff] [blame]

191

has expired and been refreshed.  This implementation uses

192

locking to check for updates before updating the

193

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

194

195

Joe Gregorio

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

[diff] [blame]

196

197

<hr>

Joe Gregorio

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

[diff] [blame]

198

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

Joe Gregorio

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

[diff] [blame]

199

<dl><dt>access_token_expired</dt>

200

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

201

202

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]

203

</dl>

204

<hr>

Joe Gregorio

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

[diff] [blame]

205

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

206

<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

207

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

208

209

Args:

210

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

211

212

Returns:

213

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

214

215

216

<hr>

Joe Gregorio

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

[diff] [blame]

217

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

218

219

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

220

</dl>

221

<dl><dt>__weakref__</dt>

222

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

223

</dl>

Joe Gregorio

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

[diff] [blame]

224

<hr>

225

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

226

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

227

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>

233

234

235

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

236

237

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

238

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

239

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

240

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

241

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

242

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

243

</dl>

244

<hr>

245

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

246

<dl><dt>__weakref__</dt>

247

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

248

</dl>

249

<hr>

250

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

Joe Gregorio

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

[diff] [blame]

251

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

252

253

<hr>

254

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

255

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

256

257

<hr>

258

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

259

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

260

261

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

262

263

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

264

265

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

266

267

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

268

269

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

274

275

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

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

280

281

<hr>

282

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]

293

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

294

295

Joe Gregorio

ad258e2

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

[diff] [blame]

296

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

297

298

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

299

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

300

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

301

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

302

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

303

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

304

</dl>

305

<hr>

306

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

307

<dl><dt>__weakref__</dt>

308

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

309

</dl>

310

<hr>

311

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

Joe Gregorio

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

[diff] [blame]

312

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

313

314

<hr>

315

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

316

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

317

318

<hr>

319

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

320

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

321

322

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

323

324

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

325

326

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

327

328

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

329

330

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

335

336

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

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

341

342

<hr>

343

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]

354

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

355

356

Joe Gregorio

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

[diff] [blame]

357

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

358

Joe Gregorio

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

[diff] [blame]

359

This credential does not require a flow to instantiate because it

360

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

361

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

362

be subclassed to generate the appropriate assertion string.

Joe Gregorio

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

[diff] [blame]

363

364

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

365

366

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

367

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

368

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

369

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

370

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

371

</dl>

372

<hr>

373

Methods defined here:

Joe Gregorio

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

[diff] [blame]

374

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

375

376

Args:

377

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

378

server

379

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

380

token_uri: string, URI for token endpoint. For convenience

381

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

382

383

<hr>

384

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

385

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

386

387

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

388

Joe Gregorio

2012-02-21 10:11:19 -0500

[diff] [blame]

389

<dl><dt><a name="AssertionCredentials-apply">apply</a>(self, headers)</dt><dd><tt>Add the authorization to the headers.

390

391

Args:

392

headers: dict, the headers to add the Authorization header to.</tt></dd></dl>

393

Joe Gregorio

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

[diff] [blame]

394

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

395

Joe Gregorio

2012-02-21 10:11:19 -0500

[diff] [blame]

396

The modified http.request method will add authentication headers to each

397

request and will refresh access_tokens when a 401 is received on a

398

request. In addition the http.request method has a credentials property,

399

http.request.credentials, which is the <a href="#Credentials">Credentials</a> <a href="__builtin__.html#object">object</a> that authorized

400

it.

401

Joe Gregorio

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

[diff] [blame]

402

Args:

403

http: An instance of httplib2.Http

404

or something that acts like it.

405

406

Returns:

407

A modified instance of http that was passed in.

Example:

h = httplib2.Http()

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

413

Joe Gregorio

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

[diff] [blame]

414

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

415

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

416

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

417

that adds in the Authorization header and then calls the original

418

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

Joe Gregorio

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

[diff] [blame]

419

Joe Gregorio

2012-02-21 10:11:19 -0500

[diff] [blame]

420

<dl><dt><a name="AssertionCredentials-refresh">refresh</a>(self, http)</dt><dd><tt>Forces a refresh of the access_token.

421

422

Args:

423

http: httplib2.Http, an http <a href="__builtin__.html#object">object</a> to be used to make the refresh

424

request.</tt></dd></dl>

425

Joe Gregorio

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

[diff] [blame]

426

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

427

428

Args:

Joe Gregorio

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

[diff] [blame]

429

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]

430

This is needed to store the latest access_token if it

Joe Gregorio

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

[diff] [blame]

431

has expired and been refreshed.  This implementation uses

432

locking to check for updates before updating the

433

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

<hr>

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

439

<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

440

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

441

442

Args:

443

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

444

445

Returns:

446

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

Joe Gregorio

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

[diff] [blame]

447

448

<hr>

449

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

Joe Gregorio

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

[diff] [blame]

450

<dl><dt>access_token_expired</dt>

451

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

452

453

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]

454

</dl>

455

<hr>

Joe Gregorio

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

[diff] [blame]

456

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

457

<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

458

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

459

460

Args:

461

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

462

463

Returns:

464

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

465

466

467

<hr>

Joe Gregorio

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

[diff] [blame]

468

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

469

470

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

471

</dl>

472

<dl><dt>__weakref__</dt>

473

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

474

</dl>

Joe Gregorio

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

[diff] [blame]

475

<hr>

476

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

477

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

478

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]

483

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

484

485

486

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

487

Joe Gregorio

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

[diff] [blame]

488

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

489

an HTTP transport.

490

491

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

Joe Gregorio

d02bf5e

2012-03-02 13:21:32 -0800

[diff] [blame]

492

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

Joe Gregorio

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

[diff] [blame]

493

494

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

Joe Gregorio

2012-02-21 10:11:19 -0500

[diff] [blame]

495

<dl><dt><a name="Credentials-apply">apply</a>(self, headers)</dt><dd><tt>Add the authorization to the headers.

496

497

Args:

498

headers: dict, the headers to add the Authorization header to.</tt></dd></dl>

499

Joe Gregorio

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

[diff] [blame]

500

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

501

authorizes it for the set of credentials, usually by

502

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

503

the appropriate headers and then delegates to the original

504

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

505

Joe Gregorio

2012-02-21 10:11:19 -0500

[diff] [blame]

506

<dl><dt><a name="Credentials-refresh">refresh</a>(self, http)</dt><dd><tt>Forces a refresh of the access_token.

507

508

Args:

509

http: httplib2.Http, an http <a href="__builtin__.html#object">object</a> to be used to make the refresh

510

request.</tt></dd></dl>

511

Joe Gregorio

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

[diff] [blame]

512

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

513

514

Returns:

515

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

Joe Gregorio

6121dd9

2012-04-13 07:50:04 -0400

[diff] [blame]

516

Joe Gregorio

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

[diff] [blame]

517

518

<hr>

519

Class methods defined here:

Joe Gregorio

6121dd9

2012-04-13 07:50:04 -0400

[diff] [blame]

520

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

521

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

522

523

Args:

524

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

525

526

Returns:

527

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

528

Joe Gregorio

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

[diff] [blame]

529

<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

530

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

531

532

Args:

533

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

534

535

Returns:

536

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

537

538

Joe Gregorio

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

[diff] [blame]

539

<hr>

540

Data descriptors defined here:

541

542

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

543

</dl>

544

<dl><dt>__weakref__</dt>

545

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

546

</dl>

Joe Gregorio

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

[diff] [blame]

547

<hr>

548

Data and other attributes defined here:

549

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

550

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>

556

557

558

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

559

560

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

561

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

562

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

563

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

564

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

565

</dl>

566

<hr>

567

Data descriptors defined here:

568

<dl><dt>__weakref__</dt>

569

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

570

</dl>

571

<hr>

572

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

Joe Gregorio

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

[diff] [blame]

573

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

574

575

<hr>

576

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

577

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

578

579

<hr>

580

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

581

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

582

583

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

584

585

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

586

587

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

588

589

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

590

591

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

596

597

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

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

602

603

<hr>

604

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>

616

617

618

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

619

620

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

621

622

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

623

</dl>

624

<dl><dt>__weakref__</dt>

625

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

631

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

632

633

Joe Gregorio

ad258e2

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

[diff] [blame]

634

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

635

636

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

637

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

638

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

639

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

640

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

641

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

642

</dl>

643

<hr>

644

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

645

<dl><dt>__weakref__</dt>

646

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

647

</dl>

648

<hr>

649

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

Joe Gregorio

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

[diff] [blame]

650

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

651

652

<hr>

653

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

654

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

655

656

<hr>

657

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

658

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

659

660

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

661

662

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

663

664

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

665

666

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

667

668

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

673

674

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

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

679

680

<hr>

681

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

</dl>

</dl>

<dl><dt>message</dt>

</dl>

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

Joe Gregorio

2012-02-21 10:11:19 -0500

[diff] [blame]

692

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

693

694

695

<td colspan=2><tt>httplib2 Cache implementation which only caches locally.  </tt></td></tr>

696

697

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

698

699

700

<dl><dt><a name="MemoryCache-delete">delete</a>(self, key)</dt></dl>

<dl><dt><a name="MemoryCache-set">set</a>(self, key, value)</dt></dl>

705

706

<hr>

707

Data descriptors defined here:

708

709

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

710

</dl>

711

<dl><dt>__weakref__</dt>

712

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

</dl>

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

Joe Gregorio

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

[diff] [blame]

718

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

719

720

Joe Gregorio

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

[diff] [blame]

721

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

722

Joe Gregorio

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

[diff] [blame]

723

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

724

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

Joe Gregorio

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

[diff] [blame]

725

726

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

727

728

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

729

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

730

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

731

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

732

</dl>

733

<hr>

734

Methods defined here:

735

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

736

Joe Gregorio

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

[diff] [blame]

737

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

738

739

This constructor is not usually called by the user, instead

Joe Gregorio

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

[diff] [blame]

740

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

741

742

Args:

Joe Gregorio

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

[diff] [blame]

743

access_token: string, access token.

Joe Gregorio

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

[diff] [blame]

744

client_id: string, client identifier.

745

client_secret: string, client secret.

Joe Gregorio

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

[diff] [blame]

746

refresh_token: string, refresh token.

Joe Gregorio

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

[diff] [blame]

747

token_expiry: datetime, when the access_token expires.

748

token_uri: string, URI of token endpoint.

Joe Gregorio

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

[diff] [blame]

749

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

Joe Gregorio

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

[diff] [blame]

750

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]

751

Joe Gregorio

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

[diff] [blame]

752

Notes:

Joe Gregorio

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

[diff] [blame]

753

store: callable, A callable that when passed a Credential

Joe Gregorio

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

[diff] [blame]

754

will store the credential back to where it came from.

755

This is needed to store the latest access_token if it

756

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

757

758

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

759

Joe Gregorio

2012-02-21 10:11:19 -0500

[diff] [blame]

760

<dl><dt><a name="OAuth2Credentials-apply">apply</a>(self, headers)</dt><dd><tt>Add the authorization to the headers.

761

762

Args:

763

headers: dict, the headers to add the Authorization header to.</tt></dd></dl>

764

Joe Gregorio

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

[diff] [blame]

765

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

766

Joe Gregorio

2012-02-21 10:11:19 -0500

[diff] [blame]

767

The modified http.request method will add authentication headers to each

768

request and will refresh access_tokens when a 401 is received on a

769

request. In addition the http.request method has a credentials property,

770

http.request.credentials, which is the <a href="#Credentials">Credentials</a> <a href="__builtin__.html#object">object</a> that authorized

771

it.

772

Joe Gregorio

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

[diff] [blame]

773

Args:

Joe Gregorio

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

[diff] [blame]

774

http: An instance of httplib2.Http

775

or something that acts like it.

776

777

Returns:

778

A modified instance of http that was passed in.

Example:

h = httplib2.Http()

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

784

Joe Gregorio

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

[diff] [blame]

785

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

786

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

787

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

788

that adds in the Authorization header and then calls the original

789

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

Joe Gregorio

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

[diff] [blame]

790

Joe Gregorio

2012-02-21 10:11:19 -0500

[diff] [blame]

791

<dl><dt><a name="OAuth2Credentials-refresh">refresh</a>(self, http)</dt><dd><tt>Forces a refresh of the access_token.

792

793

Args:

794

http: httplib2.Http, an http <a href="__builtin__.html#object">object</a> to be used to make the refresh

795

request.</tt></dd></dl>

796

Joe Gregorio

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

[diff] [blame]

797

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

798

799

Args:

Joe Gregorio

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

[diff] [blame]

800

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]

801

This is needed to store the latest access_token if it

Joe Gregorio

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

[diff] [blame]

802

has expired and been refreshed.  This implementation uses

803

locking to check for updates before updating the

804

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

<hr>

Class methods defined here:

810

<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

811

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

812

813

Args:

814

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

815

816

Returns:

817

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

Joe Gregorio

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

[diff] [blame]

818

819

<hr>

Joe Gregorio

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

[diff] [blame]

820

Data descriptors defined here:

Joe Gregorio

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

[diff] [blame]

821

<dl><dt>access_token_expired</dt>

822

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

823

824

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]

825

</dl>

826

<hr>

Joe Gregorio

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

[diff] [blame]

827

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

828

<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

829

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

830

831

Args:

832

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

833

834

Returns:

835

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

836

837

838

<hr>

Joe Gregorio

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

[diff] [blame]

839

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

840

841

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

842

</dl>

843

<dl><dt>__weakref__</dt>

844

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

845

</dl>

Joe Gregorio

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

[diff] [blame]

846

<hr>

847

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

848

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

849

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>

855

856

857

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

858

859

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

860

861

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

862

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

863

864

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

865

</dl>

866

<hr>

867

Methods defined here:

Joe Gregorio

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

[diff] [blame]

868

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

869

870

Args:

Joe Gregorio

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

[diff] [blame]

871

client_id: string, client identifier.

872

client_secret: string client secret.

Joe Gregorio

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

[diff] [blame]

873

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

874

requested.

Joe Gregorio

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

[diff] [blame]

875

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

Joe Gregorio

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

[diff] [blame]

876

auth_uri: string, URI for authorization endpoint. For convenience

877

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

878

token_uri: string, URI for token endpoint. For convenience

879

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]

880

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

881

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

882

Joe Gregorio

2012-02-21 10:11:19 -0500

[diff] [blame]

883

<dl><dt><a name="OAuth2WebServerFlow-step1_get_authorize_url">step1_get_authorize_url</a>(self, redirect_uri='urn:ietf:wg:oauth:2.0:oob')</dt><dd><tt>Returns a URI to redirect to the provider.

Joe Gregorio

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

[diff] [blame]

884

885

Args:

Joe Gregorio

2012-02-21 10:11:19 -0500

[diff] [blame]

886

redirect_uri: string, Either the string 'urn:ietf:wg:oauth:2.0:oob' for

887

a non-web-based application, or a URI that handles the callback from

888

the authorization server.

Joe Gregorio

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

[diff] [blame]

889

Joe Gregorio

2012-02-21 10:11:19 -0500

[diff] [blame]

890

If redirect_uri is 'urn:ietf:wg:oauth:2.0:oob' then pass in the

Joe Gregorio

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

[diff] [blame]

891

generated verification code to step2_exchange,

892

otherwise pass in the query parameters received

893

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

894

Joe Gregorio

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

[diff] [blame]

895

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

896

897

Args:

898

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

899

of the query parameters to the redirect_uri, which contains

Joe Gregorio

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

[diff] [blame]

900

the code.

901

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]

902

903

<hr>

904

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

905

906

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

907

</dl>

908

<dl><dt>__weakref__</dt>

909

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

915

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

916

917

918

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

919

920

This credential does not require a flow to instantiate because it

921

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

922

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

923

924

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

925

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

926

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

927

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

928

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

929

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

930

</dl>

931

<hr>

932

Methods defined here:

933

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

934

935

Args:

936

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

937

private_key: string, private key in P12 format.

938

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

939

requested.

940

private_key_password: string, password for private_key.

941

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

942

token_uri: string, URI for token endpoint. For convenience

943

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

944

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

945

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

946

947

<hr>

948

Class methods defined here:

949

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

950

951

<hr>

952

Data and other attributes defined here:

953

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

954

955

<hr>

956

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

957

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

958

959

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

960

Joe Gregorio

2012-02-21 10:11:19 -0500

[diff] [blame]

961

<dl><dt><a name="SignedJwtAssertionCredentials-apply">apply</a>(self, headers)</dt><dd><tt>Add the authorization to the headers.

962

963

Args:

964

headers: dict, the headers to add the Authorization header to.</tt></dd></dl>

965

Joe Gregorio

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

[diff] [blame]

966

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

967

Joe Gregorio

2012-02-21 10:11:19 -0500

[diff] [blame]

968

The modified http.request method will add authentication headers to each

969

request and will refresh access_tokens when a 401 is received on a

970

request. In addition the http.request method has a credentials property,

971

http.request.credentials, which is the <a href="#Credentials">Credentials</a> <a href="__builtin__.html#object">object</a> that authorized

972

it.

973

Joe Gregorio

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

[diff] [blame]

974

Args:

975

http: An instance of httplib2.Http

976

or something that acts like it.

977

978

Returns:

979

A modified instance of http that was passed in.

Example:

h = httplib2.Http()

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

985

986

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

987

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

988

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

989

that adds in the Authorization header and then calls the original

990

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

991

Joe Gregorio

2012-02-21 10:11:19 -0500

[diff] [blame]

992

<dl><dt><a name="SignedJwtAssertionCredentials-refresh">refresh</a>(self, http)</dt><dd><tt>Forces a refresh of the access_token.

993

994

Args:

995

http: httplib2.Http, an http <a href="__builtin__.html#object">object</a> to be used to make the refresh

996

request.</tt></dd></dl>

997

Joe Gregorio

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

[diff] [blame]

998

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

999

1000

Args:

1001

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

1002

This is needed to store the latest access_token if it

1003

has expired and been refreshed.  This implementation uses

1004

locking to check for updates before updating the

1005

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

<hr>

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

1011

<dl><dt>access_token_expired</dt>

1012

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

1013

1014

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

1015

</dl>

1016

<hr>

1017

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

1018

<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

1019

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

1020

1021

Args:

1022

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

1023

1024

Returns:

1025

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

1030

1031

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

1032

</dl>

1033

<dl><dt>__weakref__</dt>

1034

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

1035

</dl>

1036

<hr>

1037

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

1038

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

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

Joe Gregorio

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

[diff] [blame]

1044

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

1045

1046

1047

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

1048

Joe Gregorio

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

[diff] [blame]

1049

Store and retrieve a single credential.  This class supports locking

1050

such that multiple processes and threads can operate on a single

1051

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

Joe Gregorio

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

[diff] [blame]

1052

1053

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

Joe Gregorio

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

[diff] [blame]

1054

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

1055

1056

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

1057

Joe Gregorio

2012-02-21 10:11:19 -0500

[diff] [blame]

1058

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

1059

1060

Frees any resources associated with storing the credential.

1061

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

Returns:

None</tt></dd></dl>

Joe Gregorio

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

[diff] [blame]

1066

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

1067

Joe Gregorio

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

[diff] [blame]

1068

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

1069

Joe Gregorio

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

[diff] [blame]

1070

Returns:

Joe Gregorio

20a5aa9

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

[diff] [blame]

1071

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

Joe Gregorio

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

[diff] [blame]

1072

Joe Gregorio

2012-02-21 10:11:19 -0500

[diff] [blame]

1073

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

1074

1075

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

1076

Joe Gregorio

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

[diff] [blame]

1077

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

1078

1079

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

1080

1081

Returns:

1082

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

1083

1084

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

1085

1086

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]

1087

1088

Args:

1089

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

1090

Joe Gregorio

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

[diff] [blame]

1091

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

1092

1093

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

1094

1095

Args:

1096

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

1097

1098

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

1099

1100

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

1101

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

1102

Joe Gregorio

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

[diff] [blame]

1103

<hr>

1104

Data descriptors defined here:

1105

1106

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

1107

</dl>

1108

<dl><dt>__weakref__</dt>

1109

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

1110

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

1116

1117

1118

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

1119

1120

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

1121

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

1122

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

1123

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

1124

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

1125

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

1126

</dl>

1127

<hr>

1128

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

1129

<dl><dt>__weakref__</dt>

1130

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

1131

</dl>

1132

<hr>

1133

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

Joe Gregorio

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

[diff] [blame]

1134

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

1135

1136

<hr>

1137

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

1138

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

1139

1140

<hr>

1141

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

1142

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

1143

1144

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

1145

1146

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

1147

1148

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

1149

1150

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

1151

1152

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

1157

1158

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

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

1163

1164

<hr>

1165

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>

1177

1178

1179

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

1180

1181

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

1182

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

1183

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

1184

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

1185

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

1186

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

1187

</dl>

1188

<hr>

1189

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

1190

<dl><dt>__weakref__</dt>

1191

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

1192

</dl>

1193

<hr>

1194

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

1195

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

1196

1197

<hr>

1198

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

1199

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

1200

1201

<hr>

1202

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

1203

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

1204

1205

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

1206

1207

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

1208

1209

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

1210

1211

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

1212

1213

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

1218

1219

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

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

1224

1225

<hr>

1226

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]

1233

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

1234

Joe Gregorio

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

[diff] [blame]

1235

1236

1237

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

1238

1239

1240

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

1241

1242

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

1243

file or will raise InvalidClientSecretsError for unknown types of Flows.

1244

1245

Args:

1246

filename: string, File name of client secrets.

1247

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

1248

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

1249

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

1250

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

1251

provided then clientsecrets.InvalidClientSecretsError will be raised.

1252

1253

Returns:

1254

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

1255

1256

Raises:

1257

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

1258

clientsecrets.InvalidClientSecretsError if the clientsecrets file is

1259

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

Joe Gregorio