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

516

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

517

518

<hr>

519

Class methods defined here:

520

<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

521

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

522

523

Args:

524

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

525

526

Returns:

527

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

528

529

Joe Gregorio

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

[diff] [blame]

530

<hr>

531

Data descriptors defined here:

532

533

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

534

</dl>

535

<dl><dt>__weakref__</dt>

536

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

537

</dl>

Joe Gregorio

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

[diff] [blame]

538

<hr>

539

Data and other attributes defined here:

540

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

541

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>

547

548

549

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

550

551

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

552

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

553

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

554

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

555

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

556

</dl>

557

<hr>

558

Data descriptors defined here:

559

<dl><dt>__weakref__</dt>

560

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

561

</dl>

562

<hr>

563

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

Joe Gregorio

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

[diff] [blame]

564

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

565

566

<hr>

567

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

568

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

569

570

<hr>

571

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

572

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

573

574

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

575

576

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

577

578

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

579

580

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

581

582

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

587

588

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

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

593

594

<hr>

595

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>

607

608

609

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

610

611

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

612

613

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

614

</dl>

615

<dl><dt>__weakref__</dt>

616

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

622

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

623

624

Joe Gregorio

ad258e2

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

[diff] [blame]

625

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

626

627

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

628

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

629

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

630

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

631

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

632

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

633

</dl>

634

<hr>

635

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

636

<dl><dt>__weakref__</dt>

637

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

638

</dl>

639

<hr>

640

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

Joe Gregorio

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

[diff] [blame]

641

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

642

643

<hr>

644

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

645

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

646

647

<hr>

648

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

649

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

650

651

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

652

653

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

654

655

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

656

657

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

658

659

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

664

665

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

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

670

671

<hr>

672

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]

683

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

684

685

686

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

687

688

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

689

690

691

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

696

697

<hr>

698

Data descriptors defined here:

699

700

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

701

</dl>

702

<dl><dt>__weakref__</dt>

703

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

709

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

710

711

Joe Gregorio

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

[diff] [blame]

712

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

713

Joe Gregorio

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

[diff] [blame]

714

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

715

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

Joe Gregorio

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

[diff] [blame]

716

717

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

718

719

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

720

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

721

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

722

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

723

</dl>

724

<hr>

725

Methods defined here:

726

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

727

Joe Gregorio

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

[diff] [blame]

728

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

729

730

This constructor is not usually called by the user, instead

Joe Gregorio

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

[diff] [blame]

731

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

732

733

Args:

Joe Gregorio

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

[diff] [blame]

734

access_token: string, access token.

Joe Gregorio

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

[diff] [blame]

735

client_id: string, client identifier.

736

client_secret: string, client secret.

Joe Gregorio

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

[diff] [blame]

737

refresh_token: string, refresh token.

Joe Gregorio

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

[diff] [blame]

738

token_expiry: datetime, when the access_token expires.

739

token_uri: string, URI of token endpoint.

Joe Gregorio

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

[diff] [blame]

740

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

Joe Gregorio

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

[diff] [blame]

741

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]

742

Joe Gregorio

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

[diff] [blame]

743

Notes:

Joe Gregorio

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

[diff] [blame]

744

store: callable, A callable that when passed a Credential

Joe Gregorio

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

[diff] [blame]

745

will store the credential back to where it came from.

746

This is needed to store the latest access_token if it

747

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

748

749

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

750

Joe Gregorio

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

[diff] [blame]

751

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

752

753

Args:

754

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

755

Joe Gregorio

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

[diff] [blame]

756

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

757

Joe Gregorio

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

[diff] [blame]

758

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

759

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

760

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

761

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

762

it.

763

Joe Gregorio

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

[diff] [blame]

764

Args:

Joe Gregorio

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

[diff] [blame]

765

http: An instance of httplib2.Http

766

or something that acts like it.

767

768

Returns:

769

A modified instance of http that was passed in.

Example:

h = httplib2.Http()

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

775

Joe Gregorio

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

[diff] [blame]

776

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

777

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

778

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

779

that adds in the Authorization header and then calls the original

780

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

Joe Gregorio

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

[diff] [blame]

781

Joe Gregorio

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

[diff] [blame]

782

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

783

784

Args:

785

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

786

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

787

Joe Gregorio

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

[diff] [blame]

788

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

789

790

Args:

Joe Gregorio

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

[diff] [blame]

791

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]

792

This is needed to store the latest access_token if it

Joe Gregorio

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

[diff] [blame]

793

has expired and been refreshed.  This implementation uses

794

locking to check for updates before updating the

795

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

<hr>

Class methods defined here:

801

<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

802

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

803

804

Args:

805

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

806

807

Returns:

808

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

Joe Gregorio

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

[diff] [blame]

809

810

<hr>

Joe Gregorio

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

[diff] [blame]

811

Data descriptors defined here:

Joe Gregorio

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

[diff] [blame]

812

<dl><dt>access_token_expired</dt>

813

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

814

815

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]

816

</dl>

817

<hr>

Joe Gregorio

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

[diff] [blame]

818

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

819

<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

820

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

821

822

Args:

823

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

824

825

Returns:

826

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

827

828

829

<hr>

Joe Gregorio

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

[diff] [blame]

830

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

831

832

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

833

</dl>

834

<dl><dt>__weakref__</dt>

835

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

836

</dl>

Joe Gregorio

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

[diff] [blame]

837

<hr>

838

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

839

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

840

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>

846

847

848

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

849

850

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

851

852

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

853

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

854

855

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

856

</dl>

857

<hr>

858

Methods defined here:

Joe Gregorio

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

[diff] [blame]

859

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

860

861

Args:

Joe Gregorio

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

[diff] [blame]

862

client_id: string, client identifier.

863

client_secret: string client secret.

Joe Gregorio

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

[diff] [blame]

864

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

865

requested.

Joe Gregorio

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

[diff] [blame]

866

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

Joe Gregorio

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

[diff] [blame]

867

auth_uri: string, URI for authorization endpoint. For convenience

868

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

869

token_uri: string, URI for token endpoint. For convenience

870

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]

871

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

872

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

873

Joe Gregorio

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

[diff] [blame]

874

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

875

876

Args:

Joe Gregorio

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

[diff] [blame]

877

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

878

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

879

the authorization server.

Joe Gregorio

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

[diff] [blame]

880

Joe Gregorio

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

[diff] [blame]

881

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]

882

generated verification code to step2_exchange,

883

otherwise pass in the query parameters received

884

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

885

Joe Gregorio

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

[diff] [blame]

886

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

887

888

Args:

889

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

890

of the query parameters to the redirect_uri, which contains

Joe Gregorio

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

[diff] [blame]

891

the code.

892

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]

893

894

<hr>

895

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

896

897

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

898

</dl>

899

<dl><dt>__weakref__</dt>

900

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

906

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

907

908

909

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

910

911

This credential does not require a flow to instantiate because it

912

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

913

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

914

915

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

916

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

917

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

918

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

919

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

920

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

921

</dl>

922

<hr>

923

Methods defined here:

924

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

925

926

Args:

927

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

928

private_key: string, private key in P12 format.

929

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

930

requested.

931

private_key_password: string, password for private_key.

932

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

933

token_uri: string, URI for token endpoint. For convenience

934

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

935

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

936

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

937

938

<hr>

939

Class methods defined here:

940

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

941

942

<hr>

943

Data and other attributes defined here:

944

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

945

946

<hr>

947

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

948

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

949

950

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

951

Joe Gregorio

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

[diff] [blame]

952

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

953

954

Args:

955

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

956

Joe Gregorio

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

[diff] [blame]

957

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

958

Joe Gregorio

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

[diff] [blame]

959

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

960

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

961

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

962

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

963

it.

964

Joe Gregorio

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

[diff] [blame]

965

Args:

966

http: An instance of httplib2.Http

967

or something that acts like it.

968

969

Returns:

970

A modified instance of http that was passed in.

Example:

h = httplib2.Http()

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

976

977

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

978

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

979

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

980

that adds in the Authorization header and then calls the original

981

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

982

Joe Gregorio

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

[diff] [blame]

983

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

984

985

Args:

986

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

987

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

988

Joe Gregorio

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

[diff] [blame]

989

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

990

991

Args:

992

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

993

This is needed to store the latest access_token if it

994

has expired and been refreshed.  This implementation uses

995

locking to check for updates before updating the

996

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

<hr>

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

1002

<dl><dt>access_token_expired</dt>

1003

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

1004

1005

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

1006

</dl>

1007

<hr>

1008

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

1009

<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

1010

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

1011

1012

Args:

1013

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

1014

1015

Returns:

1016

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

1021

1022

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

1023

</dl>

1024

<dl><dt>__weakref__</dt>

1025

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

1026

</dl>

1027

<hr>

1028

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

1029

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

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

Joe Gregorio

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

[diff] [blame]

1035

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

1036

1037

1038

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

1039

Joe Gregorio

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

[diff] [blame]

1040

Store and retrieve a single credential.  This class supports locking

1041

such that multiple processes and threads can operate on a single

1042

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

Joe Gregorio

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

[diff] [blame]

1043

1044

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

Joe Gregorio

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

[diff] [blame]

1045

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

1046

1047

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

1048

Joe Gregorio

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

[diff] [blame]

1049

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

1050

1051

Frees any resources associated with storing the credential.

1052

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]

1057

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

1058

Joe Gregorio

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

[diff] [blame]

1059

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

1060

Joe Gregorio

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

[diff] [blame]

1061

Returns:

Joe Gregorio

20a5aa9

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

[diff] [blame]

1062

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

Joe Gregorio

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

[diff] [blame]

1063

Joe Gregorio

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

[diff] [blame]

1064

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

1065

1066

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

1067

Joe Gregorio

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

[diff] [blame]

1068

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

1069

1070

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

1071

1072

Returns:

1073

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

1074

1075

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

1076

1077

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]

1078

1079

Args:

1080

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

1081

Joe Gregorio

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

[diff] [blame]

1082

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

1083

1084

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

1085

1086

Args:

1087

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

1088

1089

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

1090

1091

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

1092

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

1093

Joe Gregorio

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

[diff] [blame]

1094

<hr>

1095

Data descriptors defined here:

1096

1097

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

1098

</dl>

1099

<dl><dt>__weakref__</dt>

1100

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

1101

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

1107

1108

1109

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

1110

1111

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

1112

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

1113

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

1114

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

1115

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

1116

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

1117

</dl>

1118

<hr>

1119

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

1120

<dl><dt>__weakref__</dt>

1121

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

1122

</dl>

1123

<hr>

1124

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

Joe Gregorio

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

[diff] [blame]

1125

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

1126

1127

<hr>

1128

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

1129

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

1130

1131

<hr>

1132

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

1133

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

1134

1135

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

1136

1137

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

1138

1139

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

1140

1141

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

1142

1143

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

1148

1149

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

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

1154

1155

<hr>

1156

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>

1168

1169

1170

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

1171

1172

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

1173

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

1174

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

1175

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

1176

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

1177

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

1178

</dl>

1179

<hr>

1180

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

1181

<dl><dt>__weakref__</dt>

1182

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

1183

</dl>

1184

<hr>

1185

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

1186

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

1187

1188

<hr>

1189

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

1190

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

1191

1192

<hr>

1193

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

1194

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

1195

1196

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

1197

1198

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

1199

1200

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

1201

1202

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

1203

1204

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

1209

1210

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

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

1215

1216

<hr>

1217

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]

1224

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

1225

Joe Gregorio

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

[diff] [blame]

1226

1227

1228

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

1229

1230

1231

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

1232

1233

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

1234

file or will raise InvalidClientSecretsError for unknown types of Flows.

1235

1236

Args:

1237

filename: string, File name of client secrets.

1238

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

1239

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

1240

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

1241

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

1242

provided then clientsecrets.InvalidClientSecretsError will be raised.

1243

1244

Returns:

1245

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

1246

1247

Raises:

1248

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

1249

clientsecrets.InvalidClientSecretsError if the clientsecrets file is

1250

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

Joe Gregorio