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

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

[diff] [blame]

12

<tt>Utilities for Google App Engine

13

Joe Gregorio

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

[diff] [blame]

14

Utilities for making it easier to use OAuth 2.0 on Google App Engine.</tt>

Joe Gregorio

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

[diff] [blame]

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

20

21

Joe Gregorio

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

[diff] [blame]

22

<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="google.appengine.api.app_identity.app_identity.html">google.appengine.api.app_identity.app_identity</a>

23

Joe Gregorio

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

[diff] [blame]

24

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

25

</td><td width="25%" valign=top><a href="google.appengine.ext.db.html">google.appengine.ext.db</a>

26

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

27

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

28

</td><td width="25%" valign=top><a href="google.appengine.api.memcache.html">google.appengine.api.memcache</a>

Joe Gregorio

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

[diff] [blame]

29

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

Joe Gregorio

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

[diff] [blame]

30

Joe Gregorio

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

[diff] [blame]

31

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

Joe Gregorio

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

[diff] [blame]

32

<a href="google.appengine.api.users.html">google.appengine.api.users</a>

Joe Gregorio

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

[diff] [blame]

33

<a href="google.appengine.ext.webapp.html">google.appengine.ext.webapp</a>

Joe Gregorio

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

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

Joe Gregorio

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

[diff] [blame]

42

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

43

</dt><dd>

44

<dl>

45

<dt><a href="oauth2client.appengine.html#OAuth2Decorator">OAuth2Decorator</a>

Joe Gregorio

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

[diff] [blame]

46

</dt><dd>

47

<dl>

48

<dt><a href="oauth2client.appengine.html#OAuth2DecoratorFromClientSecrets">OAuth2DecoratorFromClientSecrets</a>

</dt></dl>

</dd>

</dl>

</dd>

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

54

</dt><dd>

55

<dl>

56

<dt><a href="oauth2client.appengine.html#InvalidClientSecretsError">InvalidClientSecretsError</a>

Joe Gregorio

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

[diff] [blame]

57

</dt></dl>

58

</dd>

59

<dt><a href="google.appengine.ext.db.html#Model">google.appengine.ext.db.Model</a>(<a href="__builtin__.html#object">__builtin__.object</a>)

60

</dt><dd>

61

<dl>

62

<dt><a href="oauth2client.appengine.html#CredentialsModel">CredentialsModel</a>

63

</dt></dl>

64

</dd>

Joe Gregorio

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

[diff] [blame]

65

<dt><a href="google.appengine.ext.db.html#Property">google.appengine.ext.db.Property</a>(<a href="__builtin__.html#object">__builtin__.object</a>)

66

</dt><dd>

67

<dl>

68

<dt><a href="oauth2client.appengine.html#CredentialsProperty">CredentialsProperty</a>

69

</dt><dt><a href="oauth2client.appengine.html#FlowProperty">FlowProperty</a>

70

</dt></dl>

71

</dd>

Joe Gregorio

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

[diff] [blame]

72

<dt><a href="google.appengine.ext.webapp.html#RequestHandler">google.appengine.ext.webapp.RequestHandler</a>(<a href="__builtin__.html#object">__builtin__.object</a>)

Joe Gregorio

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

[diff] [blame]

73

</dt><dd>

74

<dl>

75

<dt><a href="oauth2client.appengine.html#OAuth2Handler">OAuth2Handler</a>

76

</dt></dl>

77

</dd>

78

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

79

</dt><dd>

80

<dl>

81

<dt><a href="oauth2client.appengine.html#AppAssertionCredentials">AppAssertionCredentials</a>

82

</dt></dl>

83

</dd>

Joe Gregorio

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

[diff] [blame]

84

<dt><a href="oauth2client.client.html#Storage">oauth2client.client.Storage</a>(<a href="__builtin__.html#object">__builtin__.object</a>)

85

</dt><dd>

86

<dl>

87

<dt><a href="oauth2client.appengine.html#StorageByKeyName">StorageByKeyName</a>

88

</dt></dl>

89

</dd>

Joe Gregorio

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

[diff] [blame]

</dl>

Joe Gregorio

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

[diff] [blame]

95

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

96

97

98

<td colspan=2><tt>Credentials <a href="__builtin__.html#object">object</a> for App Engine Assertion Grants

99

100

This <a href="__builtin__.html#object">object</a> will allow an App Engine application to identify itself to Google

101

and other OAuth 2.0 servers that can verify assertions. It can be used for

102

the purpose of accessing data stored under an account assigned to the App

103

Engine application itself. The algorithm used for generating the assertion is

104

the Signed JSON Web Token (JWT) algorithm. Additional details can be found at

105

the following link:

106

107

<a href="http://self-issued.info/docs/draft-jones-json-web-token.html">http://self-issued.info/docs/draft-jones-json-web-token.html</a>

108

109

This credential does not require a flow to instantiate because it represents

110

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

Joe Gregorio

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

[diff] [blame]

111

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

Joe Gregorio

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

[diff] [blame]

112

113

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

114

<dd><a href="oauth2client.appengine.html#AppAssertionCredentials">AppAssertionCredentials</a></dd>

115

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

116

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

117

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

118

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

119

</dl>

120

<hr>

121

Methods defined here:

Joe Gregorio

0250385

2011-08-31 09:07:55 -0400

[diff] [blame]

122

<dl><dt><a name="AppAssertionCredentials-__init__">__init__</a>(self, scope, audience='https://accounts.google.com/o/oauth2/token', assertion_type='http://oauth.net/grant_type/jwt/1.0/bearer', token_uri='https://accounts.google.com/o/oauth2/token', **kwargs)</dt><dd><tt>Constructor for <a href="#AppAssertionCredentials">AppAssertionCredentials</a>

Joe Gregorio

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

[diff] [blame]

123

124

Args:

125

scope: string, scope of the credentials being requested.

Joe Gregorio

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

[diff] [blame]

126

audience: string, The audience, or verifier of the assertion.  For

127

convenience defaults to Google's audience.

128

assertion_type: string, Type name that will identify the format of the

129

assertion string.  For convience, defaults to the JSON Web Token (JWT)

130

assertion type string.

131

token_uri: string, URI for token endpoint. For convenience

132

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

133

134

<hr>

Joe Gregorio

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

[diff] [blame]

135

Class methods defined here:

136

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

137

138

<hr>

Joe Gregorio

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

[diff] [blame]

139

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

140

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

141

142

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

143

Joe Gregorio

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

[diff] [blame]

144

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

145

146

Args:

147

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

148

Joe Gregorio

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

[diff] [blame]

149

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

150

Joe Gregorio

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

[diff] [blame]

151

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

152

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

153

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

154

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

155

it.

156

Joe Gregorio

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

[diff] [blame]

157

Args:

158

http: An instance of httplib2.Http

159

or something that acts like it.

160

161

Returns:

162

A modified instance of http that was passed in.

Example:

h = httplib2.Http()

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

168

Joe Gregorio

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

[diff] [blame]

169

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

170

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

171

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

172

that adds in the Authorization header and then calls the original

173

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

Joe Gregorio

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

[diff] [blame]

174

Joe Gregorio

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

[diff] [blame]

175

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

176

177

Args:

178

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

179

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

180

Joe Gregorio

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

[diff] [blame]

181

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

Joe Gregorio

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

[diff] [blame]

182

183

Args:

Joe Gregorio

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

[diff] [blame]

184

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

Joe Gregorio

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

[diff] [blame]

185

This is needed to store the latest access_token if it

Joe Gregorio

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

[diff] [blame]

186

has expired and been refreshed.  This implementation uses

187

locking to check for updates before updating the

188

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

189

190

Joe Gregorio

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

[diff] [blame]

191

192

<hr>

193

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

Joe Gregorio

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

[diff] [blame]

194

<dl><dt>access_token_expired</dt>

195

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

196

197

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

Joe Gregorio

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

[diff] [blame]

198

</dl>

199

<hr>

Joe Gregorio

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

[diff] [blame]

200

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

201

<dl><dt><a name="AppAssertionCredentials-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 Credentials subclass from a JSON

202

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

203

204

Args:

205

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

206

207

Returns:

208

An instance of the subclass of Credentials that was serialized with

209

210

211

<hr>

Joe Gregorio

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

[diff] [blame]

212

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

213

214

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

215

</dl>

216

<dl><dt>__weakref__</dt>

217

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

218

</dl>

Joe Gregorio

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

[diff] [blame]

219

<hr>

220

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

221

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

222

Joe Gregorio

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

[diff] [blame]

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

<a name="CredentialsModel">class CredentialsModel</a>(<a href="google.appengine.ext.db.html#Model">google.appengine.ext.db.Model</a>)</td></tr>

228

229

230

<td colspan=2><tt><a href="oauth2client.client.html#Storage">Storage</a> for OAuth 2.0 Credentials

231

232

<a href="oauth2client.client.html#Storage">Storage</a> of the model is keyed by the user.user_id().  </tt></td></tr>

233

234

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

235

<dd><a href="oauth2client.appengine.html#CredentialsModel">CredentialsModel</a></dd>

236

<dd><a href="google.appengine.ext.db.html#Model">google.appengine.ext.db.Model</a></dd>

237

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

238

</dl>

239

<hr>

240

Data descriptors defined here:

241

<dl><dt>credentials</dt>

242

<dd><tt>App Engine datastore Property for Credentials.

243

244

Utility property that allows easy storage and retrieval of

245

oath2client.Credentials</tt></dd>

246

</dl>

247

<hr>

248

Methods inherited from <a href="google.appengine.ext.db.html#Model">google.appengine.ext.db.Model</a>:

249

<dl><dt><a name="CredentialsModel-__init__">__init__</a>(self, parent=None, key_name=None, _app=None, _from_entity=False, **kwds)</dt><dd><tt>Creates a new instance of this model.

250

251

To create a new entity, you instantiate a model and then call <a href="#CredentialsModel-put">put</a>(),

252

which saves the entity to the datastore:

person = Person()

person.name = 'Bret'

person.<a href="#CredentialsModel-put">put</a>()

257

258

You can initialize properties in the model in the constructor with keyword

259

arguments:

260

261

person = Person(name='Bret')

262

263

We initialize all other properties to the default value (as defined by the

264

properties in the model definition) if they are not provided in the

constructor.

Args:

parent: Parent instance for this instance or None, indicating a top-

269

level instance.

270

key_name: Name for new model instance.

271

_from_entity: Intentionally undocumented.

272

kwds: Keyword arguments mapping to properties of model.  Also:

273

key: Key instance for this instance, if provided makes parent and

274

key_name redundant (they do not need to be set but if they are

275

they must match the key).</tt></dd></dl>

276

277

<dl><dt><a name="CredentialsModel-delete">delete</a>(self, **kwargs)</dt><dd><tt>Deletes this entity from the datastore.

278

279

Args:

280

config: datastore_rpc.Configuration to use for this request.

281

282

Raises:

283

TransactionFailedError if the data could not be committed.</tt></dd></dl>

284

285

<dl><dt><a name="CredentialsModel-dynamic_properties">dynamic_properties</a>(self)</dt><dd><tt>Returns a list of all dynamic properties defined for instance.</tt></dd></dl>

286

287

<dl><dt><a name="CredentialsModel-has_key">has_key</a>(self)</dt><dd><tt>Determine if this model instance has a complete key.

288

289

When not using a fully self-assigned Key, ids are not assigned until the

290

data is saved to the Datastore, but instances with a key name always have

a full key.

Returns:

True if the <a href="__builtin__.html#object">object</a> has been persisted to the datastore or has a key

295

or has a key_name, otherwise False.</tt></dd></dl>

296

297

<dl><dt><a name="CredentialsModel-instance_properties">instance_properties</a>(self)</dt><dd><tt>Alias for dyanmic_properties.</tt></dd></dl>

298

299

<dl><dt><a name="CredentialsModel-is_saved">is_saved</a>(self)</dt><dd><tt>Determine if entity is persisted in the datastore.

300

301

New instances of <a href="google.appengine.ext.db.html#Model">Model</a> do not start out saved in the data.  Objects which

302

are saved to or loaded from the Datastore will have a True saved state.

303

304

Returns:

305

True if <a href="__builtin__.html#object">object</a> has been persisted to the datastore, otherwise False.</tt></dd></dl>

306

307

<dl><dt><a name="CredentialsModel-key">key</a>(self)</dt><dd><tt>Unique key for this entity.

308

309

This property is only available if this entity is already stored in the

310

datastore or if it has a full key, so it is available if this entity was

311

fetched returned from a query, or after <a href="#CredentialsModel-put">put</a>() is called the first time

312

for new entities, or if a complete key was given when constructed.

313

314

Returns:

315

Datastore key of persisted entity.

316

317

Raises:

318

NotSavedError when entity is not persistent.</tt></dd></dl>

319

320

<dl><dt><a name="CredentialsModel-parent">parent</a>(self)</dt><dd><tt>Get the parent of the model instance.

321

322

Returns:

323

Parent of contained entity or parent provided in constructor, None if

324

instance has no parent.</tt></dd></dl>

325

326

<dl><dt><a name="CredentialsModel-parent_key">parent_key</a>(self)</dt><dd><tt>Get the parent's key.

327

328

This method is useful for avoiding a potential fetch from the datastore

329

but still get information about the instances parent.

330

331

Returns:

332

Parent key of entity, None if there is no parent.</tt></dd></dl>

333

334

<dl><dt><a name="CredentialsModel-put">put</a>(self, **kwargs)</dt><dd><tt>Writes this model instance to the datastore.

335

336

If this instance is new, we add an entity to the datastore.

337

Otherwise, we update this instance, and the key will remain the

same.

Args:

config: datastore_rpc.Configuration to use for this request.

342

343

Returns:

344

The key of the instance (either the existing key or a new key).

345

346

Raises:

347

TransactionFailedError if the data could not be committed.</tt></dd></dl>

348

349

<dl><dt><a name="CredentialsModel-save">save</a> = put(self, **kwargs)</dt><dd><tt>Writes this model instance to the datastore.

350

351

If this instance is new, we add an entity to the datastore.

352

Otherwise, we update this instance, and the key will remain the

same.

Args:

config: datastore_rpc.Configuration to use for this request.

357

358

Returns:

359

The key of the instance (either the existing key or a new key).

360

361

Raises:

362

TransactionFailedError if the data could not be committed.</tt></dd></dl>

363

364

<dl><dt><a name="CredentialsModel-to_xml">to_xml</a>(self, _entity_class=<class 'google.appengine.api.datastore.Entity'>)</dt><dd><tt>Generate an XML representation of this model instance.

365

366

atom and gd:namespace properties are converted to XML according to their

367

respective schemas. For more information, see:

368

369

<a href="http://www.atomenabled.org/developers/syndication/">http://www.atomenabled.org/developers/syndication/</a>

370

<a href="http://code.google.com/apis/gdata/common-elements.html">http://code.google.com/apis/gdata/common-elements.html</a></tt></dd></dl>

371

372

<hr>

373

Class methods inherited from <a href="google.appengine.ext.db.html#Model">google.appengine.ext.db.Model</a>:

374

<dl><dt><a name="CredentialsModel-all">all</a>(cls, **kwds) from <a href="google.appengine.ext.db.html#PropertiedClass">google.appengine.ext.db.PropertiedClass</a></dt><dd><tt>Returns a query over all instances of this model from the datastore.

375

376

Returns:

377

Query that will retrieve all instances from entity collection.</tt></dd></dl>

378

379

<dl><dt><a name="CredentialsModel-entity_type">entity_type</a>(cls) from <a href="google.appengine.ext.db.html#PropertiedClass">google.appengine.ext.db.PropertiedClass</a></dt><dd><tt>Soon to be removed alias for kind.</tt></dd></dl>

380

381

<dl><dt><a name="CredentialsModel-fields">fields</a>(cls) from <a href="google.appengine.ext.db.html#PropertiedClass">google.appengine.ext.db.PropertiedClass</a></dt><dd><tt>Soon to be removed alias for properties.</tt></dd></dl>

382

383

<dl><dt><a name="CredentialsModel-from_entity">from_entity</a>(cls, entity) from <a href="google.appengine.ext.db.html#PropertiedClass">google.appengine.ext.db.PropertiedClass</a></dt><dd><tt>Converts the entity representation of this model to an instance.

384

385

Converts datastore.Entity instance to an instance of cls.

386

387

Args:

388

entity: Entity loaded directly from datastore.

389

390

Raises:

391

KindError when cls is incorrect model for entity.</tt></dd></dl>

392

393

<dl><dt><a name="CredentialsModel-get">get</a>(cls, keys, **kwargs) from <a href="google.appengine.ext.db.html#PropertiedClass">google.appengine.ext.db.PropertiedClass</a></dt><dd><tt>Fetch instance from the datastore of a specific <a href="google.appengine.ext.db.html#Model">Model</a> type using key.

394

395

We support Key objects and string keys (we convert them to Key objects

396

automatically).

397

398

Useful for ensuring that specific instance types are retrieved from the

399

datastore.  It also helps that the source code clearly indicates what

400

kind of <a href="__builtin__.html#object">object</a> is being retreived.  Example:

401

402

story = Story.<a href="#CredentialsModel-get">get</a>(story_key)

403

404

Args:

405

keys: Key within datastore entity collection to find; or string key;

406

or list of Keys or string keys.

407

config: datastore_rpc.Configuration to use for this request.

408

409

Returns:

410

If a single key was given: a <a href="google.appengine.ext.db.html#Model">Model</a> instance associated with key

411

for provided class if it exists in the datastore, otherwise

412

None; if a list of keys was given: a list whose items are either

413

a <a href="google.appengine.ext.db.html#Model">Model</a> instance or None.

414

415

Raises:

416

KindError if any of the retreived objects are not instances of the

417

type associated with call to 'get'.</tt></dd></dl>

418

419

<dl><dt><a name="CredentialsModel-get_by_id">get_by_id</a>(cls, ids, parent=None, **kwargs) from <a href="google.appengine.ext.db.html#PropertiedClass">google.appengine.ext.db.PropertiedClass</a></dt><dd><tt>Get instance of <a href="google.appengine.ext.db.html#Model">Model</a> class by id.

420

421

Args:

422

key_names: A single id or a list of ids.

423

parent: Parent of instances to get.  Can be a model or key.

424

config: datastore_rpc.Configuration to use for this request.</tt></dd></dl>

425

426

<dl><dt><a name="CredentialsModel-get_by_key_name">get_by_key_name</a>(cls, key_names, parent=None, **kwargs) from <a href="google.appengine.ext.db.html#PropertiedClass">google.appengine.ext.db.PropertiedClass</a></dt><dd><tt>Get instance of <a href="google.appengine.ext.db.html#Model">Model</a> class by its key's name.

427

428

Args:

429

key_names: A single key-name or a list of key-names.

430

parent: Parent of instances to get.  Can be a model or key.

431

config: datastore_rpc.Configuration to use for this request.</tt></dd></dl>

432

433

<dl><dt><a name="CredentialsModel-get_or_insert">get_or_insert</a>(cls, key_name, **kwds) from <a href="google.appengine.ext.db.html#PropertiedClass">google.appengine.ext.db.PropertiedClass</a></dt><dd><tt>Transactionally retrieve or create an instance of <a href="google.appengine.ext.db.html#Model">Model</a> class.

434

435

This acts much like the Python dictionary setdefault() method, where we

436

first try to retrieve a <a href="google.appengine.ext.db.html#Model">Model</a> instance with the given key name and parent.

437

If it's not present, then we create a new instance (using the *kwds

438

supplied) and insert that with the supplied key name.

439

440

Subsequent calls to this method with the same key_name and parent will

441

always yield the same entity (though not the same actual <a href="__builtin__.html#object">object</a> instance),

442

regardless of the *kwds supplied. If the specified entity has somehow

443

been deleted separately, then the next call will create a new entity and

444

return it.

445

446

If the 'parent' keyword argument is supplied, it must be a <a href="google.appengine.ext.db.html#Model">Model</a> instance.

447

It will be used as the parent of the new instance of this <a href="google.appengine.ext.db.html#Model">Model</a> class if

448

one is created.

449

450

This method is especially useful for having just one unique entity for

451

a specific identifier. Insertion/retrieval is done transactionally, which

452

guarantees uniqueness.

Example usage:

class WikiTopic(db.<a href="google.appengine.ext.db.html#Model">Model</a>):

457

creation_date = db.DatetimeProperty(auto_now_add=True)

458

body = db.TextProperty(required=True)

459

460

# The first time through we'll create the new topic.

461

wiki_word = 'CommonIdioms'

462

topic = WikiTopic.<a href="#CredentialsModel-get_or_insert">get_or_insert</a>(wiki_word,

463

body='This topic is totally new!')

464

assert topic.<a href="#CredentialsModel-key">key</a>().name() == 'CommonIdioms'

465

assert topic.body == 'This topic is totally new!'

466

467

# The second time through will just retrieve the entity.

468

overwrite_topic = WikiTopic.<a href="#CredentialsModel-get_or_insert">get_or_insert</a>(wiki_word,

469

body='A totally different message!')

470

assert topic.<a href="#CredentialsModel-key">key</a>().name() == 'CommonIdioms'

471

assert topic.body == 'This topic is totally new!'

472

473

Args:

474

key_name: Key name to retrieve or create.

475

**kwds: Keyword arguments to pass to the constructor of the model class

476

if an instance for the specified key name does not already exist. If

477

an instance with the supplied key_name and parent already exists, the

478

rest of these arguments will be discarded.

479

480

Returns:

481

Existing instance of <a href="google.appengine.ext.db.html#Model">Model</a> class with the specified key_name and parent

482

or a new one that has just been created.

483

484

Raises:

485

TransactionFailedError if the specified <a href="google.appengine.ext.db.html#Model">Model</a> instance could not be

486

retrieved or created transactionally (due to high contention, etc).</tt></dd></dl>

487

488

<dl><dt><a name="CredentialsModel-gql">gql</a>(cls, query_string, *args, **kwds) from <a href="google.appengine.ext.db.html#PropertiedClass">google.appengine.ext.db.PropertiedClass</a></dt><dd><tt>Returns a query using GQL query string.

489

490

See appengine/ext/gql for more information about GQL.

491

492

Args:

493

query_string: properly formatted GQL query string with the

494

'SELECT * FROM <entity>' part omitted

495

*args: rest of the positional arguments used to bind numeric references

496

in the query.

497

**kwds: dictionary-based arguments (for named parameters).</tt></dd></dl>

498

499

<dl><dt><a name="CredentialsModel-kind">kind</a>(cls) from <a href="google.appengine.ext.db.html#PropertiedClass">google.appengine.ext.db.PropertiedClass</a></dt><dd><tt>Returns the datastore kind we use for this model.

500

501

We just use the name of the model for now, ignoring potential collisions.</tt></dd></dl>

502

503

<dl><dt><a name="CredentialsModel-properties">properties</a>(cls) from <a href="google.appengine.ext.db.html#PropertiedClass">google.appengine.ext.db.PropertiedClass</a></dt><dd><tt>Returns a dictionary of all the properties defined for this model.</tt></dd></dl>

504

505

<hr>

506

Static methods inherited from <a href="google.appengine.ext.db.html#Model">google.appengine.ext.db.Model</a>:

507

<dl><dt><a name="CredentialsModel-__new__">__new__</a>(*args, **unused_kwds)</dt><dd><tt>Allow subclasses to call <a href="#CredentialsModel-__new__">__new__</a>() with arguments.

508

509

Do NOT list 'cls' as the first argument, or in the case when

510

the 'unused_kwds' dictionary contains the key 'cls', the function

511

will complain about multiple argument values for 'cls'.

512

513

Raises:

514

TypeError if there are no positional arguments.</tt></dd></dl>

515

516

<hr>

517

Data descriptors inherited from <a href="google.appengine.ext.db.html#Model">google.appengine.ext.db.Model</a>:

518

519

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

520

</dl>

521

<dl><dt>__weakref__</dt>

522

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

523

</dl>

524

<hr>

525

Data and other attributes inherited from <a href="google.appengine.ext.db.html#Model">google.appengine.ext.db.Model</a>:

526

<dl><dt>__metaclass__ = <class 'google.appengine.ext.db.PropertiedClass'><dd><tt>Meta-class for initializing <a href="google.appengine.ext.db.html#Model">Model</a> classes properties.

527

528

Used for initializing Properties defined in the context of a model.

529

By using a meta-class much of the configuration of a <a href="google.appengine.ext.db.html#Property">Property</a>

530

descriptor becomes implicit.  By using this meta-class, descriptors

531

that are of class <a href="google.appengine.ext.db.html#Model">Model</a> are notified about which class they

532

belong to and what attribute they are associated with and can

533

do appropriate initialization via __property_config__.

534

535

Duplicate properties are not permitted.</tt></dl>

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

Joe Gregorio

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

[diff] [blame]

541

<a name="CredentialsProperty">class CredentialsProperty</a>(<a href="google.appengine.ext.db.html#Property">google.appengine.ext.db.Property</a>)</td></tr>

542

543

Joe Gregorio

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

[diff] [blame]

544

<td colspan=2><tt>App Engine datastore <a href="google.appengine.ext.db.html#Property">Property</a> for Credentials.

545

546

Utility property that allows easy storage and retrieval of

Joe Gregorio

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

[diff] [blame]

547

oath2client.Credentials  </tt></td></tr>

548

549

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

550

<dd><a href="oauth2client.appengine.html#CredentialsProperty">CredentialsProperty</a></dd>

551

<dd><a href="google.appengine.ext.db.html#Property">google.appengine.ext.db.Property</a></dd>

552

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

553

</dl>

554

<hr>

555

Methods defined here:

Joe Gregorio

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

[diff] [blame]

556

<dl><dt><a name="CredentialsProperty-get_value_for_datastore">get_value_for_datastore</a>(self, model_instance)</dt><dd><tt># For writing to datastore.</tt></dd></dl>

557

558

<dl><dt><a name="CredentialsProperty-make_value_from_datastore">make_value_from_datastore</a>(self, value)</dt><dd><tt># For reading from datastore.</tt></dd></dl>

559

560

<dl><dt><a name="CredentialsProperty-validate">validate</a>(self, value)</dt></dl>

561

562

<hr>

563

Data and other attributes defined here:

564

<dl><dt>data_type = <class 'oauth2client.client.Credentials'><dd><tt>Base class for all Credentials objects.

565

Joe Gregorio

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

[diff] [blame]

566

Subclasses must define an authorize() method that applies the credentials to

567

an HTTP transport.

568

569

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

570

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

Joe Gregorio

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

[diff] [blame]

571

572

<hr>

573

Methods inherited from <a href="google.appengine.ext.db.html#Property">google.appengine.ext.db.Property</a>:

574

<dl><dt><a name="CredentialsProperty-__get__">__get__</a>(self, model_instance, model_class)</dt><dd><tt>Returns the value for this property on the given model instance.

575

576

See <a href="http://docs.python.org/ref/descriptors.html">http://docs.python.org/ref/descriptors.html</a> for a description of

577

the arguments to this class and what they mean.</tt></dd></dl>

578

579

<dl><dt><a name="CredentialsProperty-__init__">__init__</a>(self, verbose_name=None, name=None, default=None, required=False, validator=None, choices=None, indexed=True)</dt><dd><tt>Initializes this <a href="google.appengine.ext.db.html#Property">Property</a> with the given options.

580

581

Args:

582

verbose_name: User friendly name of property.

Joe Gregorio

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

[diff] [blame]

583

name: <a href="oauth2client.client.html#Storage">Storage</a> name for property.  By default, uses attribute name

Joe Gregorio

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

[diff] [blame]

584

as it is assigned in the <a href="google.appengine.ext.db.html#Model">Model</a> sub-class.

Joe Gregorio

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

[diff] [blame]

585

default: Default value for property if none is assigned.

586

required: Whether property is required.

587

validator: User provided method used for validation.

588

choices: User provided set of valid property values.

589

indexed: Whether property is indexed.</tt></dd></dl>

590

591

<dl><dt><a name="CredentialsProperty-__property_config__">__property_config__</a>(self, model_class, property_name)</dt><dd><tt>Configure property, connecting it to its model.

592

593

Configure the property so that it knows its property name and what class

594

it belongs to.

595

596

Args:

Joe Gregorio

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

[diff] [blame]

597

model_class: <a href="google.appengine.ext.db.html#Model">Model</a> class which <a href="google.appengine.ext.db.html#Property">Property</a> will belong to.

598

property_name: Name of property within <a href="google.appengine.ext.db.html#Model">Model</a> instance to store property

Joe Gregorio

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

[diff] [blame]

599

values in.  By default this will be the property name preceded by

600

an underscore, but may change for different subclasses.</tt></dd></dl>

601

602

<dl><dt><a name="CredentialsProperty-__set__">__set__</a>(self, model_instance, value)</dt><dd><tt>Sets the value for this property on the given model instance.

603

604

See <a href="http://docs.python.org/ref/descriptors.html">http://docs.python.org/ref/descriptors.html</a> for a description of

605

the arguments to this class and what they mean.</tt></dd></dl>

606

607

<dl><dt><a name="CredentialsProperty-datastore_type">datastore_type</a>(self)</dt><dd><tt>Deprecated backwards-compatible accessor method for self.data_type.</tt></dd></dl>

608

609

<dl><dt><a name="CredentialsProperty-default_value">default_value</a>(self)</dt><dd><tt>Default value for unassigned values.

610

611

Returns:

612

Default value as provided by <a href="#CredentialsProperty-__init__">__init__</a>(default).</tt></dd></dl>

613

Joe Gregorio

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

[diff] [blame]

614

<dl><dt><a name="CredentialsProperty-empty">empty</a>(self, value)</dt><dd><tt>Determine if value is empty in the context of this property.

615

616

For most kinds, this is equivalent to "not value", but for kinds like

617

bool, the test is more subtle, so subclasses can override this method

if necessary.

Args:

value: Value to validate against this <a href="google.appengine.ext.db.html#Property">Property</a>.

622

623

Returns:

624

True if this value is considered empty in the context of this <a href="google.appengine.ext.db.html#Property">Property</a>

625

type, otherwise False.</tt></dd></dl>

626

Joe Gregorio

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

[diff] [blame]

627

<hr>

628

Data descriptors inherited from <a href="google.appengine.ext.db.html#Property">google.appengine.ext.db.Property</a>:

629

630

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

631

</dl>

632

<dl><dt>__weakref__</dt>

633

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

634

</dl>

635

<hr>

636

Data and other attributes inherited from <a href="google.appengine.ext.db.html#Property">google.appengine.ext.db.Property</a>:

Joe Gregorio

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

[diff] [blame]

637

<dl><dt>creation_counter = 1</dl>

Joe Gregorio

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

[diff] [blame]

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

<a name="FlowProperty">class FlowProperty</a>(<a href="google.appengine.ext.db.html#Property">google.appengine.ext.db.Property</a>)</td></tr>

644

645

Joe Gregorio

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

[diff] [blame]

646

<td colspan=2><tt>App Engine datastore <a href="google.appengine.ext.db.html#Property">Property</a> for Flow.

647

648

Utility property that allows easy storage and retreival of an

Joe Gregorio

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

[diff] [blame]

649

oauth2client.Flow  </tt></td></tr>

650

651

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

652

<dd><a href="oauth2client.appengine.html#FlowProperty">FlowProperty</a></dd>

653

<dd><a href="google.appengine.ext.db.html#Property">google.appengine.ext.db.Property</a></dd>

654

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

655

</dl>

656

<hr>

657

Methods defined here:

658

<dl><dt><a name="FlowProperty-empty">empty</a>(self, value)</dt></dl>

659

660

<dl><dt><a name="FlowProperty-get_value_for_datastore">get_value_for_datastore</a>(self, model_instance)</dt><dd><tt># For writing to datastore.</tt></dd></dl>

661

662

<dl><dt><a name="FlowProperty-make_value_from_datastore">make_value_from_datastore</a>(self, value)</dt><dd><tt># For reading from datastore.</tt></dd></dl>

663

664

<dl><dt><a name="FlowProperty-validate">validate</a>(self, value)</dt></dl>

665

666

<hr>

667

Data and other attributes defined here:

668

<dl><dt>data_type = <class 'oauth2client.client.Flow'><dd><tt>Base class for all Flow objects.</tt></dl>

669

670

<hr>

671

Methods inherited from <a href="google.appengine.ext.db.html#Property">google.appengine.ext.db.Property</a>:

672

<dl><dt><a name="FlowProperty-__get__">__get__</a>(self, model_instance, model_class)</dt><dd><tt>Returns the value for this property on the given model instance.

673

674

See <a href="http://docs.python.org/ref/descriptors.html">http://docs.python.org/ref/descriptors.html</a> for a description of

675

the arguments to this class and what they mean.</tt></dd></dl>

676

677

<dl><dt><a name="FlowProperty-__init__">__init__</a>(self, verbose_name=None, name=None, default=None, required=False, validator=None, choices=None, indexed=True)</dt><dd><tt>Initializes this <a href="google.appengine.ext.db.html#Property">Property</a> with the given options.

678

679

Args:

680

verbose_name: User friendly name of property.

Joe Gregorio

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

[diff] [blame]

681

name: <a href="oauth2client.client.html#Storage">Storage</a> name for property.  By default, uses attribute name

Joe Gregorio

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

[diff] [blame]

682

as it is assigned in the <a href="google.appengine.ext.db.html#Model">Model</a> sub-class.

Joe Gregorio

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

[diff] [blame]

683

default: Default value for property if none is assigned.

684

required: Whether property is required.

685

validator: User provided method used for validation.

686

choices: User provided set of valid property values.

687

indexed: Whether property is indexed.</tt></dd></dl>

688

689

<dl><dt><a name="FlowProperty-__property_config__">__property_config__</a>(self, model_class, property_name)</dt><dd><tt>Configure property, connecting it to its model.

690

691

Configure the property so that it knows its property name and what class

692

it belongs to.

693

694

Args:

Joe Gregorio

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

[diff] [blame]

695

model_class: <a href="google.appengine.ext.db.html#Model">Model</a> class which <a href="google.appengine.ext.db.html#Property">Property</a> will belong to.

696

property_name: Name of property within <a href="google.appengine.ext.db.html#Model">Model</a> instance to store property

Joe Gregorio

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

[diff] [blame]

697

values in.  By default this will be the property name preceded by

698

an underscore, but may change for different subclasses.</tt></dd></dl>

699

700

<dl><dt><a name="FlowProperty-__set__">__set__</a>(self, model_instance, value)</dt><dd><tt>Sets the value for this property on the given model instance.

701

702

See <a href="http://docs.python.org/ref/descriptors.html">http://docs.python.org/ref/descriptors.html</a> for a description of

703

the arguments to this class and what they mean.</tt></dd></dl>

704

705

<dl><dt><a name="FlowProperty-datastore_type">datastore_type</a>(self)</dt><dd><tt>Deprecated backwards-compatible accessor method for self.data_type.</tt></dd></dl>

706

707

<dl><dt><a name="FlowProperty-default_value">default_value</a>(self)</dt><dd><tt>Default value for unassigned values.

708

709

Returns:

710

Default value as provided by <a href="#FlowProperty-__init__">__init__</a>(default).</tt></dd></dl>

711

712

<hr>

713

Data descriptors inherited from <a href="google.appengine.ext.db.html#Property">google.appengine.ext.db.Property</a>:

714

715

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

716

</dl>

717

<dl><dt>__weakref__</dt>

718

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

719

</dl>

720

<hr>

721

Data and other attributes inherited from <a href="google.appengine.ext.db.html#Property">google.appengine.ext.db.Property</a>:

Joe Gregorio

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

[diff] [blame]

722

<dl><dt>creation_counter = 1</dl>

Joe Gregorio

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

[diff] [blame]

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

Joe Gregorio

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

[diff] [blame]

728

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

729

730

731

<td colspan=2><tt>The client_secrets.json file is malformed or missing required fields.  </tt></td></tr>

732

733

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

734

<dd><a href="oauth2client.appengine.html#InvalidClientSecretsError">InvalidClientSecretsError</a></dd>

735

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

736

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

737

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

738

</dl>

739

<hr>

740

Data descriptors defined here:

741

<dl><dt>__weakref__</dt>

742

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

743

</dl>

744

<hr>

745

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

746

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

747

748

<hr>

749

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

750

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

751

752

<hr>

753

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

754

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

755

756

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

757

758

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

759

760

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

761

762

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

763

764

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

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

769

770

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

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

775

776

<hr>

777

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-07-06 10:09:20 -0400

[diff] [blame]

788

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

789

790

791

<td colspan=2><tt>Utility for making OAuth 2.0 easier.

792

793

Instantiate and then use with oauth_required or oauth_aware

Joe Gregorio

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

[diff] [blame]

794

as decorators on webapp.<a href="google.appengine.ext.webapp.html#RequestHandler">RequestHandler</a> methods.

Joe Gregorio

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

[diff] [blame]

Example:

decorator = <a href="#OAuth2Decorator">OAuth2Decorator</a>(

799

client_id='837...ent.com',

800

client_secret='Qh...wwI',

Joe Gregorio

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

[diff] [blame]

801

scope='https://www.googleapis.com/auth/plus')

Joe Gregorio

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

[diff] [blame]

802

803

Joe Gregorio

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

[diff] [blame]

804

class MainHandler(webapp.<a href="google.appengine.ext.webapp.html#RequestHandler">RequestHandler</a>):

Joe Gregorio

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

[diff] [blame]

805

806

@decorator.oauth_required

807

def get(self):

808

http = decorator.<a href="#OAuth2Decorator-http">http</a>()

809

# http is authorized with the user's Credentials and can be used

810

# in API calls  </tt></td></tr>

811

812

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

Joe Gregorio

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

[diff] [blame]

813

<dl><dt><a name="OAuth2Decorator-__init__">__init__</a>(self, client_id, client_secret, scope, auth_uri='https://accounts.google.com/o/oauth2/auth', token_uri='https://accounts.google.com/o/oauth2/token', user_agent=None, message=None, **kwargs)</dt><dd><tt>Constructor for <a href="#OAuth2Decorator">OAuth2Decorator</a>

Joe Gregorio

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

[diff] [blame]

814

815

Args:

816

client_id: string, client identifier.

817

client_secret: string client secret.

Joe Gregorio

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

[diff] [blame]

818

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

819

requested.

Joe Gregorio

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

[diff] [blame]

820

auth_uri: string, URI for authorization endpoint. For convenience

821

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

822

token_uri: string, URI for token endpoint. For convenience

Joe Gregorio

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

[diff] [blame]

823

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

Joe Gregorio

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

[diff] [blame]

824

user_agent: string, User agent of your application, default to None.

Joe Gregorio

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

[diff] [blame]

825

message: Message to display if there are problems with the OAuth 2.0

826

configuration. The message may contain HTML and will be presented on the

Joe Gregorio

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

[diff] [blame]

827

web interface for any method that uses the decorator.

828

**kwargs: dict, Keyword arguments are be passed along as kwargs to the

829

OAuth2WebServerFlow constructor.</tt></dd></dl>

Joe Gregorio

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

[diff] [blame]

830

831

<dl><dt><a name="OAuth2Decorator-authorize_url">authorize_url</a>(self)</dt><dd><tt>Returns the URL to start the OAuth dance.

832

Joe Gregorio

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

[diff] [blame]

833

Must only be called from with a webapp.<a href="google.appengine.ext.webapp.html#RequestHandler">RequestHandler</a> subclassed method

Joe Gregorio

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

[diff] [blame]

834

that had been decorated with either @oauth_required or @oauth_aware.</tt></dd></dl>

835

836

<dl><dt><a name="OAuth2Decorator-has_credentials">has_credentials</a>(self)</dt><dd><tt>True if for the logged in user there are valid access Credentials.

837

Joe Gregorio

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

[diff] [blame]

838

Must only be called from with a webapp.<a href="google.appengine.ext.webapp.html#RequestHandler">RequestHandler</a> subclassed method

Joe Gregorio

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

[diff] [blame]

839

that had been decorated with either @oauth_required or @oauth_aware.</tt></dd></dl>

840

841

<dl><dt><a name="OAuth2Decorator-http">http</a>(self)</dt><dd><tt>Returns an authorized http instance.

842

843

Must only be called from within an @oauth_required decorated method, or

844

from within an @oauth_aware decorated method where <a href="#OAuth2Decorator-has_credentials">has_credentials</a>()

845

returns True.</tt></dd></dl>

846

847

<dl><dt><a name="OAuth2Decorator-oauth_aware">oauth_aware</a>(self, method)</dt><dd><tt>Decorator that sets up for OAuth 2.0 dance, but doesn't do it.

848

849

Does all the setup for the OAuth dance, but doesn't initiate it.

850

This decorator is useful if you want to create a page that knows

851

whether or not the user has granted access to this application.

852

From within a method decorated with @oauth_aware the <a href="#OAuth2Decorator-has_credentials">has_credentials</a>()

853

and <a href="#OAuth2Decorator-authorize_url">authorize_url</a>() methods can be called.

854

855

Args:

Joe Gregorio

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

[diff] [blame]

856

method: callable, to be decorated method of a webapp.<a href="google.appengine.ext.webapp.html#RequestHandler">RequestHandler</a>

Joe Gregorio

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

[diff] [blame]

857

instance.</tt></dd></dl>

858

859

<dl><dt><a name="OAuth2Decorator-oauth_required">oauth_required</a>(self, method)</dt><dd><tt>Decorator that starts the OAuth 2.0 dance.

860

861

Starts the OAuth dance for the logged in user if they haven't already

862

granted access for this application.

863

864

Args:

Joe Gregorio

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

[diff] [blame]

865

method: callable, to be decorated method of a webapp.<a href="google.appengine.ext.webapp.html#RequestHandler">RequestHandler</a>

Joe Gregorio

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

[diff] [blame]

866

instance.</tt></dd></dl>

867

868

<hr>

869

Data descriptors defined here:

870

871

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

872

</dl>

873

<dl><dt>__weakref__</dt>

874

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

880

<a name="OAuth2DecoratorFromClientSecrets">class OAuth2DecoratorFromClientSecrets</a>(<a href="oauth2client.appengine.html#OAuth2Decorator">OAuth2Decorator</a>)</td></tr>

881

882

883

<td colspan=2><tt>An <a href="#OAuth2Decorator">OAuth2Decorator</a> that builds from a clientsecrets file.

884

885

Uses a clientsecrets file as the source for all the information when

886

constructing an <a href="#OAuth2Decorator">OAuth2Decorator</a>.

Example:

decorator = <a href="#OAuth2DecoratorFromClientSecrets">OAuth2DecoratorFromClientSecrets</a>(

891

os.path.join(os.path.dirname(__file__), 'client_secrets.json')

892

scope='https://www.googleapis.com/auth/plus')

893

894

Joe Gregorio

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

[diff] [blame]

895

class MainHandler(webapp.<a href="google.appengine.ext.webapp.html#RequestHandler">RequestHandler</a>):

Joe Gregorio

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

[diff] [blame]

896

897

@decorator.oauth_required

898

def get(self):

899

http = decorator.<a href="#OAuth2DecoratorFromClientSecrets-http">http</a>()

900

# http is authorized with the user's Credentials and can be used

901

# in API calls  </tt></td></tr>

902

903

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

904

<dd><a href="oauth2client.appengine.html#OAuth2DecoratorFromClientSecrets">OAuth2DecoratorFromClientSecrets</a></dd>

905

<dd><a href="oauth2client.appengine.html#OAuth2Decorator">OAuth2Decorator</a></dd>

906

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

907

</dl>

908

<hr>

909

Methods defined here:

910

<dl><dt><a name="OAuth2DecoratorFromClientSecrets-__init__">__init__</a>(self, filename, scope, message=None)</dt><dd><tt>Constructor

911

912

Args:

913

filename: string, File name of client secrets.

914

scope: string, Space separated list of scopes.

915

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

916

clientsecrets file is missing or invalid. The message may contain HTML and

917

will be presented on the web interface for any method that uses the

918

decorator.</tt></dd></dl>

919

920

<hr>

921

Methods inherited from <a href="oauth2client.appengine.html#OAuth2Decorator">OAuth2Decorator</a>:

922

<dl><dt><a name="OAuth2DecoratorFromClientSecrets-authorize_url">authorize_url</a>(self)</dt><dd><tt>Returns the URL to start the OAuth dance.

923

Joe Gregorio

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

[diff] [blame]

924

Must only be called from with a webapp.<a href="google.appengine.ext.webapp.html#RequestHandler">RequestHandler</a> subclassed method

Joe Gregorio

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

[diff] [blame]

925

that had been decorated with either @oauth_required or @oauth_aware.</tt></dd></dl>

926

927

<dl><dt><a name="OAuth2DecoratorFromClientSecrets-has_credentials">has_credentials</a>(self)</dt><dd><tt>True if for the logged in user there are valid access Credentials.

928

Joe Gregorio

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

[diff] [blame]

929

Must only be called from with a webapp.<a href="google.appengine.ext.webapp.html#RequestHandler">RequestHandler</a> subclassed method

Joe Gregorio

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

[diff] [blame]

930

that had been decorated with either @oauth_required or @oauth_aware.</tt></dd></dl>

931

932

<dl><dt><a name="OAuth2DecoratorFromClientSecrets-http">http</a>(self)</dt><dd><tt>Returns an authorized http instance.

933

934

Must only be called from within an @oauth_required decorated method, or

935

from within an @oauth_aware decorated method where <a href="#OAuth2DecoratorFromClientSecrets-has_credentials">has_credentials</a>()

936

returns True.</tt></dd></dl>

937

938

<dl><dt><a name="OAuth2DecoratorFromClientSecrets-oauth_aware">oauth_aware</a>(self, method)</dt><dd><tt>Decorator that sets up for OAuth 2.0 dance, but doesn't do it.

939

940

Does all the setup for the OAuth dance, but doesn't initiate it.

941

This decorator is useful if you want to create a page that knows

942

whether or not the user has granted access to this application.

943

From within a method decorated with @oauth_aware the <a href="#OAuth2DecoratorFromClientSecrets-has_credentials">has_credentials</a>()

944

and <a href="#OAuth2DecoratorFromClientSecrets-authorize_url">authorize_url</a>() methods can be called.

945

946

Args:

Joe Gregorio

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

[diff] [blame]

947

method: callable, to be decorated method of a webapp.<a href="google.appengine.ext.webapp.html#RequestHandler">RequestHandler</a>

Joe Gregorio

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

[diff] [blame]

948

instance.</tt></dd></dl>

949

950

<dl><dt><a name="OAuth2DecoratorFromClientSecrets-oauth_required">oauth_required</a>(self, method)</dt><dd><tt>Decorator that starts the OAuth 2.0 dance.

951

952

Starts the OAuth dance for the logged in user if they haven't already

953

granted access for this application.

954

955

Args:

Joe Gregorio

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

[diff] [blame]

956

method: callable, to be decorated method of a webapp.<a href="google.appengine.ext.webapp.html#RequestHandler">RequestHandler</a>

Joe Gregorio

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

[diff] [blame]

957

instance.</tt></dd></dl>

958

959

<hr>

960

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

961

962

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

963

</dl>

964

<dl><dt>__weakref__</dt>

965

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

</dl>

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

Joe Gregorio

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

[diff] [blame]

971

<a name="OAuth2Handler">class OAuth2Handler</a>(<a href="google.appengine.ext.webapp.html#RequestHandler">google.appengine.ext.webapp.RequestHandler</a>)</td></tr>

Joe Gregorio

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

[diff] [blame]

972

973

974

<td colspan=2><tt>Handler for the redirect_uri of the OAuth 2.0 dance.  </tt></td></tr>

975

976

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

977

<dd><a href="oauth2client.appengine.html#OAuth2Handler">OAuth2Handler</a></dd>

Joe Gregorio

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

[diff] [blame]

978

<dd><a href="google.appengine.ext.webapp.html#RequestHandler">google.appengine.ext.webapp.RequestHandler</a></dd>

Joe Gregorio

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

[diff] [blame]

979

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

980

</dl>

981

<hr>

982

Methods defined here:

983

<dl><dt><a name="OAuth2Handler-get">get</a> = check_login(self, *args)</dt></dl>

984

985

<hr>

Joe Gregorio

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

[diff] [blame]

986

Methods inherited from <a href="google.appengine.ext.webapp.html#RequestHandler">google.appengine.ext.webapp.RequestHandler</a>:

Joe Gregorio

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

[diff] [blame]

987

<dl><dt><a name="OAuth2Handler-delete">delete</a>(self, *args)</dt><dd><tt>Handler method for DELETE requests.</tt></dd></dl>

988

989

<dl><dt><a name="OAuth2Handler-error">error</a>(self, code)</dt><dd><tt>Clears the response output stream and sets the given HTTP error code.

990

991

Args:

992

code: the HTTP status error code (e.g., 501)</tt></dd></dl>

993

994

<dl><dt><a name="OAuth2Handler-handle_exception">handle_exception</a>(self, exception, debug_mode)</dt><dd><tt>Called if this handler throws an exception during execution.

995

996

The default behavior is to call <a href="#OAuth2Handler-error">error</a>(500) and print a stack trace

997

if debug_mode is True.

998

999

Args:

1000

exception: the exception that was thrown

1001

debug_mode: True if the web application is running in debug mode</tt></dd></dl>

1002

1003

<dl><dt><a name="OAuth2Handler-head">head</a>(self, *args)</dt><dd><tt>Handler method for HEAD requests.</tt></dd></dl>

1004

1005

<dl><dt><a name="OAuth2Handler-initialize">initialize</a>(self, request, response)</dt><dd><tt>Initializes this request handler with the given Request and Response.</tt></dd></dl>

1006

1007

<dl><dt><a name="OAuth2Handler-options">options</a>(self, *args)</dt><dd><tt>Handler method for OPTIONS requests.</tt></dd></dl>

1008

1009

<dl><dt><a name="OAuth2Handler-post">post</a>(self, *args)</dt><dd><tt>Handler method for POST requests.</tt></dd></dl>

1010

1011

<dl><dt><a name="OAuth2Handler-put">put</a>(self, *args)</dt><dd><tt>Handler method for PUT requests.</tt></dd></dl>

1012

1013

<dl><dt><a name="OAuth2Handler-redirect">redirect</a>(self, uri, permanent=False)</dt><dd><tt>Issues an HTTP redirect to the given relative URL.

1014

1015

Args:

1016

uri: a relative or absolute URI (e.g., '../flowers.html')

1017

permanent: if true, we use a 301 redirect instead of a 302 redirect</tt></dd></dl>

1018

1019

<dl><dt><a name="OAuth2Handler-trace">trace</a>(self, *args)</dt><dd><tt>Handler method for TRACE requests.</tt></dd></dl>

1020

1021

<hr>

Joe Gregorio

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

[diff] [blame]

1022

Class methods inherited from <a href="google.appengine.ext.webapp.html#RequestHandler">google.appengine.ext.webapp.RequestHandler</a>:

Joe Gregorio

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

[diff] [blame]

1023

<dl><dt><a name="OAuth2Handler-get_url">get_url</a>(cls, *args, **kargs) from <a href="__builtin__.html#type">__builtin__.type</a></dt><dd><tt>Returns the url for the given handler.

1024

1025

The default implementation uses the patterns passed to the active

1026

WSGIApplication to create a url. However, it is different from Django's

1027

urlresolvers.reverse() in the following ways:

1028

- It does not try to resolve handlers via module loading

1029

- It does not support named arguments

1030

- It performs some post-prosessing on the url to remove some regex

1031

operators.

1032

- It will try to fill in the left-most missing arguments with the args

1033

used in the active request.

1034

1035

Args:

1036

args: Parameters for the url pattern's groups.

1037

kwargs: Optionally contains 'implicit_args' that can either be a boolean

1038

or a tuple. When it is True, it will use the arguments to the

1039

active request as implicit arguments. When it is False (default),

1040

it will not use any implicit arguments. When it is a tuple, it

1041

will use the tuple as the implicit arguments.

1042

the left-most args if some are missing from args.

1043

1044

Returns:

1045

The url for this handler/args combination.

1046

1047

Raises:

1048

NoUrlFoundError: No url pattern for this handler has the same

1049

number of args that were passed in.</tt></dd></dl>

1050

1051

<dl><dt><a name="OAuth2Handler-new_factory">new_factory</a>(cls, *args, **kwargs) from <a href="__builtin__.html#type">__builtin__.type</a></dt><dd><tt>Create new request handler factory.

1052

1053

Use factory method to create reusable request handlers that just

1054

require a few configuration parameters to construct.  Also useful

1055

for injecting shared state between multiple request handler

1056

instances without relying on global variables.  For example, to

1057

create a set of post handlers that will do simple text transformations

1058

you can write:

1059

Joe Gregorio

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

[diff] [blame]

1060

class ChangeTextHandler(webapp.<a href="google.appengine.ext.webapp.html#RequestHandler">RequestHandler</a>):

Joe Gregorio

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

[diff] [blame]

1061

1062

def <a href="#OAuth2Handler-__init__">__init__</a>(self, transform):

1063

self.transform = transform

1064

1065

def <a href="#OAuth2Handler-post">post</a>(self):

1066

response_text = transform(

1067

self.request.request.body_file.getvalue())

1068

self.response.out.write(response_text)

1069

1070

application = webapp.WSGIApplication(

1071

[('/to_lower', ChangeTextHandler.<a href="#OAuth2Handler-new_factory">new_factory</a>(str.lower)),

1072

('/to_upper', ChangeTextHandler.<a href="#OAuth2Handler-new_factory">new_factory</a>(str.upper)),

],

debug=True)

Text POSTed to /to_lower will be lower cased.

1077

Text POSTed to /to_upper will be upper cased.</tt></dd></dl>

1078

1079

<hr>

Joe Gregorio

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

[diff] [blame]

1080

Data descriptors inherited from <a href="google.appengine.ext.webapp.html#RequestHandler">google.appengine.ext.webapp.RequestHandler</a>:

Joe Gregorio

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

[diff] [blame]

1081

1082

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

1083

</dl>

1084

<dl><dt>__weakref__</dt>

1085

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

</dl>

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

Joe Gregorio

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

[diff] [blame]

1091

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

Joe Gregorio

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

[diff] [blame]

1092

1093

1094

<td colspan=2><tt>Store and retrieve a single credential to and from

1095

the App Engine datastore.

1096

Joe Gregorio

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

[diff] [blame]

1097

This <a href="oauth2client.client.html#Storage">Storage</a> helper presumes the Credentials

Joe Gregorio

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

[diff] [blame]

1098

have been stored as a CredenialsProperty

1099

on a datastore model class, and that entities

1100

are stored by key_name.  </tt></td></tr>

1101

Joe Gregorio

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

[diff] [blame]

1102

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

1103

<dd><a href="oauth2client.appengine.html#StorageByKeyName">StorageByKeyName</a></dd>

1104

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

1105

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

1106

</dl>

1107

<hr>

1108

Methods defined here:

Joe Gregorio

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

[diff] [blame]

1109

<dl><dt><a name="StorageByKeyName-__init__">__init__</a>(self, model, key_name, property_name, cache=None)</dt><dd><tt>Constructor for <a href="oauth2client.client.html#Storage">Storage</a>.

Joe Gregorio

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

[diff] [blame]

1110

1111

Args:

Joe Gregorio

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

[diff] [blame]

1112

model: db.<a href="google.appengine.ext.db.html#Model">Model</a>, model class

Joe Gregorio

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

[diff] [blame]

1113

key_name: string, key name for the entity that has the credentials

Joe Gregorio

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

[diff] [blame]

1114

property_name: string, name of the property that is a <a href="#CredentialsProperty">CredentialsProperty</a>

1115

cache: memcache, a write-through cache to put in front of the datastore</tt></dd></dl>

Joe Gregorio

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

[diff] [blame]

1116

Joe Gregorio

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

[diff] [blame]

1117

<dl><dt><a name="StorageByKeyName-locked_delete">locked_delete</a>(self)</dt><dd><tt>Delete Credential from datastore.</tt></dd></dl>

1118

Joe Gregorio

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

[diff] [blame]

1119

<dl><dt><a name="StorageByKeyName-locked_get">locked_get</a>(self)</dt><dd><tt>Retrieve Credential from datastore.

Joe Gregorio

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

[diff] [blame]

1120

1121

Returns:

1122

oauth2client.Credentials</tt></dd></dl>

1123

Joe Gregorio

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

[diff] [blame]

1124

<dl><dt><a name="StorageByKeyName-locked_put">locked_put</a>(self, credentials)</dt><dd><tt>Write a Credentials to the datastore.

Joe Gregorio

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

[diff] [blame]

1125

1126

Args:

1127

credentials: Credentials, the credentials to store.</tt></dd></dl>

1128

1129

<hr>

Joe Gregorio

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

[diff] [blame]

1130

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

1131

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

1132

1133

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

1134

Joe Gregorio

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

[diff] [blame]

1135

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

1136

1137

Frees any resources associated with storing the credential.

1138

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

Returns:

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

Joe Gregorio

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

[diff] [blame]

1143

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

Joe Gregorio

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

[diff] [blame]

1144

Joe Gregorio

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

[diff] [blame]

1145

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

Joe Gregorio

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

[diff] [blame]

1146

1147

Returns:

1148

oauth2client.client.Credentials</tt></dd></dl>

1149

Joe Gregorio

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

[diff] [blame]

1150

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

Joe Gregorio

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

[diff] [blame]

1151

1152

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

1153

1154

Args:

1155

credentials: Credentials, the credentials to store.</tt></dd></dl>

1156

1157

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

1158

1159

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

1160

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

1161

1162

<hr>

Joe Gregorio

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

[diff] [blame]

1163

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

Joe Gregorio

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

[diff] [blame]

1164

1165

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

1166

</dl>

1167

<dl><dt>__weakref__</dt>

1168

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

1169

</dl>

1170

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

1171

Joe Gregorio