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

2012-04-13 07:50:04 -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.html">google.appengine.api.app_identity</a>

Joe Gregorio

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

[diff] [blame]

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-04-13 07:50:04 -0400

[diff] [blame]

72

<dt><a href="google.appengine.ext.webapp._webapp25.html#RequestHandler">google.appengine.ext.webapp._webapp25.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

Joe Gregorio

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

[diff] [blame]

103

Engine application itself.

Joe Gregorio

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

[diff] [blame]

104

105

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

106

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

Joe Gregorio

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

[diff] [blame]

107

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

Joe Gregorio

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

[diff] [blame]

108

109

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

110

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

111

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

112

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

113

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

114

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

115

</dl>

116

<hr>

117

Methods defined here:

Joe Gregorio

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

[diff] [blame]

118

<dl><dt><a name="AppAssertionCredentials-__init__">__init__</a>(self, scope, **kwargs)</dt><dd><tt>Constructor for <a href="#AppAssertionCredentials">AppAssertionCredentials</a>

Joe Gregorio

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

[diff] [blame]

119

120

Args:

Joe Gregorio

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

[diff] [blame]

121

scope: string or list of strings, scope(s) of the credentials being requested.</tt></dd></dl>

Joe Gregorio

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

[diff] [blame]

122

123

<hr>

Joe Gregorio

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

[diff] [blame]

124

Class methods defined here:

125

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

126

127

<hr>

Joe Gregorio

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

[diff] [blame]

128

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

129

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

130

131

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

132

Joe Gregorio

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

[diff] [blame]

133

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

134

135

Args:

136

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

137

Joe Gregorio

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

[diff] [blame]

138

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

139

Joe Gregorio

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

[diff] [blame]

140

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

141

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

142

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

143

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

144

it.

145

Joe Gregorio

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

[diff] [blame]

146

Args:

147

http: An instance of httplib2.Http

148

or something that acts like it.

149

150

Returns:

151

A modified instance of http that was passed in.

Example:

h = httplib2.Http()

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

157

Joe Gregorio

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

[diff] [blame]

158

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

159

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

160

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

161

that adds in the Authorization header and then calls the original

162

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

Joe Gregorio

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

[diff] [blame]

163

Joe Gregorio

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

[diff] [blame]

164

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

165

166

Args:

167

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

168

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

169

Joe Gregorio

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

[diff] [blame]

170

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

171

172

Args:

Joe Gregorio

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

[diff] [blame]

173

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]

174

This is needed to store the latest access_token if it

Joe Gregorio

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

[diff] [blame]

175

has expired and been refreshed.  This implementation uses

176

locking to check for updates before updating the

177

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

178

179

Joe Gregorio

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

[diff] [blame]

180

181

<hr>

182

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]

183

<dl><dt>access_token_expired</dt>

184

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

185

186

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]

187

</dl>

188

<hr>

Joe Gregorio

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

[diff] [blame]

189

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

190

<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

191

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

192

193

Args:

194

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

195

196

Returns:

197

An instance of the subclass of Credentials that was serialized with

198

199

200

<hr>

Joe Gregorio

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

[diff] [blame]

201

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

202

203

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

204

</dl>

205

<dl><dt>__weakref__</dt>

206

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

207

</dl>

Joe Gregorio

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

[diff] [blame]

208

<hr>

209

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

210

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

211

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>

217

218

219

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

220

221

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

222

223

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

224

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

225

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

226

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

227

</dl>

228

<hr>

229

Data descriptors defined here:

230

<dl><dt>credentials</dt>

231

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

232

233

Utility property that allows easy storage and retrieval of

234

oath2client.Credentials</tt></dd>

235

</dl>

236

<hr>

237

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

238

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

239

240

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

241

which saves the entity to the datastore:

person = Person()

person.name = 'Bret'

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

246

247

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

248

arguments:

249

250

person = Person(name='Bret')

251

252

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

253

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-

258

level instance.

259

key_name: Name for new model instance.

260

_from_entity: Intentionally undocumented.

261

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

262

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

263

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

264

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

265

266

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

267

268

Args:

269

config: datastore_rpc.Configuration to use for this request.

270

271

Raises:

272

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

273

274

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

275

276

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

277

278

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

279

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

284

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

285

286

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

287

288

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

289

290

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

291

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

292

293

Returns:

294

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

295

296

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

297

298

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

299

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

300

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

301

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

302

303

Returns:

304

Datastore key of persisted entity.

305

306

Raises:

307

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

308

309

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

310

311

Returns:

312

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

313

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

314

315

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

316

317

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

318

but still get information about the instances parent.

319

320

Returns:

321

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

322

323

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

324

325

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

326

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

same.

Args:

config: datastore_rpc.Configuration to use for this request.

331

332

Returns:

333

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

334

335

Raises:

336

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

337

338

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

339

340

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

341

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

same.

Args:

config: datastore_rpc.Configuration to use for this request.

346

347

Returns:

348

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

349

350

Raises:

351

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

352

353

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

354

355

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

356

respective schemas. For more information, see:

357

358

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

359

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

360

361

<hr>

362

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

363

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

364

365

Returns:

366

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

367

368

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

369

370

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

371

372

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

373

374

Converts datastore.Entity instance to an instance of cls.

375

376

Args:

377

entity: Entity loaded directly from datastore.

378

379

Raises:

380

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

381

382

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

383

384

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

385

automatically).

386

387

Useful for ensuring that specific instance types are retrieved from the

388

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

389

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

390

391

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

392

393

Args:

394

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

395

or list of Keys or string keys.

396

config: datastore_rpc.Configuration to use for this request.

397

398

Returns:

399

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

400

for provided class if it exists in the datastore, otherwise

401

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

402

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

403

404

Raises:

405

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

406

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

407

408

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

409

410

Args:

411

key_names: A single id or a list of ids.

412

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

413

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

414

415

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

416

417

Args:

418

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

419

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

420

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

421

422

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

423

424

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

425

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

426

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

427

supplied) and insert that with the supplied key name.

428

429

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

430

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

431

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

432

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

433

return it.

434

435

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

436

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

437

one is created.

438

439

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

440

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

441

guarantees uniqueness.

Example usage:

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

446

creation_date = db.DatetimeProperty(auto_now_add=True)

447

body = db.TextProperty(required=True)

448

449

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

450

wiki_word = 'CommonIdioms'

451

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

452

body='This topic is totally new!')

453

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

454

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

455

456

# The second time through will just retrieve the entity.

457

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

458

body='A totally different message!')

459

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

460

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

461

462

Args:

463

key_name: Key name to retrieve or create.

464

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

465

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

466

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

467

rest of these arguments will be discarded.

468

469

Returns:

470

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

471

or a new one that has just been created.

472

473

Raises:

474

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

475

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

476

477

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

478

479

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

480

481

Args:

482

query_string: properly formatted GQL query string with the

483

'SELECT * FROM <entity>' part omitted

484

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

485

in the query.

486

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

487

488

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

489

490

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

491

492

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

493

494

<hr>

495

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

496

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

497

498

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

499

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

500

will complain about multiple argument values for 'cls'.

501

502

Raises:

503

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

504

505

<hr>

506

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

507

508

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

509

</dl>

510

<dl><dt>__weakref__</dt>

511

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

512

</dl>

513

<hr>

514

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

515

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

516

517

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

518

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

519

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

520

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

521

belong to and what attribute they are associated with and can

522

do appropriate initialization via __property_config__.

523

524

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

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

Joe Gregorio

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

[diff] [blame]

530

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

531

532

Joe Gregorio

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

[diff] [blame]

533

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

534

535

Utility property that allows easy storage and retrieval of

Joe Gregorio

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

[diff] [blame]

536

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

537

538

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

539

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

540

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

541

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

542

</dl>

543

<hr>

544

Methods defined here:

Joe Gregorio

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

[diff] [blame]

545

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

546

547

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

548

549

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

550

551

<hr>

552

Data and other attributes defined here:

553

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

554

Joe Gregorio

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

[diff] [blame]

555

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

556

an HTTP transport.

557

558

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

Joe Gregorio

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

[diff] [blame]

559

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

Joe Gregorio

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

[diff] [blame]

560

561

<hr>

562

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

563

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

564

565

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

566

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

567

568

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

569

570

Args:

571

verbose_name: User friendly name of property.

Joe Gregorio

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

[diff] [blame]

572

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]

573

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]

574

default: Default value for property if none is assigned.

575

required: Whether property is required.

576

validator: User provided method used for validation.

577

choices: User provided set of valid property values.

578

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

579

580

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

581

582

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

583

it belongs to.

584

585

Args:

Joe Gregorio

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

[diff] [blame]

586

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.

587

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]

588

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

589

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

590

591

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

592

593

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

594

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

595

596

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

597

598

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

599

600

Returns:

601

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

602

Joe Gregorio

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

[diff] [blame]

603

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

604

605

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

606

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

611

612

Returns:

613

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

614

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

615

Joe Gregorio

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

[diff] [blame]

616

<dl><dt><a name="CredentialsProperty-get_updated_value_for_datastore">get_updated_value_for_datastore</a>(self, model_instance)</dt><dd><tt>Determine new value for auto-updated property.

617

618

Some properies (e.g. DateTimeProperty, UserProperty) optionally update their

619

value on every put(). This call must return the new desired value for such

620

properties. For all other properties, this call must return

621

AUTO_UPDATE_UNCHANGED.

622

623

Args:

624

model_instance: Instance to get new value for.

625

626

Returns:

627

Datastore representation of the new model value in a form that is

628

appropriate for storing in the datastore, or AUTO_UPDATE_UNCHANGED.</tt></dd></dl>

629

Joe Gregorio

6621203

2012-06-14 09:10:14 -0400

[diff] [blame]

630

<dl><dt><a name="CredentialsProperty-make_value_from_datastore_index_value">make_value_from_datastore_index_value</a>(self, index_value)</dt></dl>

631

Joe Gregorio

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

[diff] [blame]

632

<hr>

633

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

634

635

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

636

</dl>

637

<dl><dt>__weakref__</dt>

638

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

639

</dl>

640

<hr>

641

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]

642

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

649

650

Joe Gregorio

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

[diff] [blame]

651

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

652

653

Utility property that allows easy storage and retreival of an

Joe Gregorio

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

[diff] [blame]

654

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

655

656

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

657

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

658

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

659

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

660

</dl>

661

<hr>

662

Methods defined here:

663

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

664

665

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

666

667

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

668

669

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

670

671

<hr>

672

Data and other attributes defined here:

673

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

674

675

<hr>

676

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

677

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

678

679

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

680

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

681

682

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

683

684

Args:

685

verbose_name: User friendly name of property.

Joe Gregorio

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

[diff] [blame]

686

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]

687

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]

688

default: Default value for property if none is assigned.

689

required: Whether property is required.

690

validator: User provided method used for validation.

691

choices: User provided set of valid property values.

692

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

693

694

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

695

696

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

697

it belongs to.

698

699

Args:

Joe Gregorio

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

[diff] [blame]

700

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.

701

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]

702

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

703

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

704

705

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

706

707

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

708

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

709

710

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

711

712

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

713

714

Returns:

715

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

716

Joe Gregorio

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

[diff] [blame]

717

<dl><dt><a name="FlowProperty-get_updated_value_for_datastore">get_updated_value_for_datastore</a>(self, model_instance)</dt><dd><tt>Determine new value for auto-updated property.

718

719

Some properies (e.g. DateTimeProperty, UserProperty) optionally update their

720

value on every put(). This call must return the new desired value for such

721

properties. For all other properties, this call must return

722

AUTO_UPDATE_UNCHANGED.

723

724

Args:

725

model_instance: Instance to get new value for.

726

727

Returns:

728

Datastore representation of the new model value in a form that is

729

appropriate for storing in the datastore, or AUTO_UPDATE_UNCHANGED.</tt></dd></dl>

730

Joe Gregorio

6621203

2012-06-14 09:10:14 -0400

[diff] [blame]

731

<dl><dt><a name="FlowProperty-make_value_from_datastore_index_value">make_value_from_datastore_index_value</a>(self, index_value)</dt></dl>

732

Joe Gregorio

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

[diff] [blame]

733

<hr>

734

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

735

736

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

737

</dl>

738

<dl><dt>__weakref__</dt>

739

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

740

</dl>

741

<hr>

742

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]

743

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

749

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

750

751

752

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

753

754

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

755

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

756

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

757

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

758

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

759

</dl>

760

<hr>

761

Data descriptors defined here:

762

<dl><dt>__weakref__</dt>

763

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

764

</dl>

765

<hr>

766

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

767

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

768

769

<hr>

770

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

771

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

772

773

<hr>

774

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

775

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

776

777

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

778

779

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

780

781

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

782

783

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

784

785

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

790

791

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

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

796

797

<hr>

798

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]

809

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

810

811

812

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

813

814

Instantiate and then use with oauth_required or oauth_aware

Joe Gregorio

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

[diff] [blame]

815

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

Joe Gregorio

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

[diff] [blame]

Example:

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

820

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

821

client_secret='Qh...wwI',

Joe Gregorio

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

[diff] [blame]

822

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

Joe Gregorio

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

[diff] [blame]

823

824

Joe Gregorio

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

[diff] [blame]

825

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

Joe Gregorio

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

[diff] [blame]

826

827

@decorator.oauth_required

828

def get(self):

829

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

830

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

831

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

832

833

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

Joe Gregorio

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

[diff] [blame]

834

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

835

836

Args:

837

client_id: string, client identifier.

838

client_secret: string client secret.

Joe Gregorio

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

[diff] [blame]

839

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

840

requested.

Joe Gregorio

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

[diff] [blame]

841

auth_uri: string, URI for authorization endpoint. For convenience

842

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

843

token_uri: string, URI for token endpoint. For convenience

Joe Gregorio

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

[diff] [blame]

844

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]

845

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

Joe Gregorio

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

[diff] [blame]

846

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

847

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

Joe Gregorio

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

[diff] [blame]

848

web interface for any method that uses the decorator.

849

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

850

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

Joe Gregorio

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

[diff] [blame]

851

852

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

853

Joe Gregorio

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

[diff] [blame]

854

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

Joe Gregorio

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

[diff] [blame]

855

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

856

857

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

858

Joe Gregorio

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

[diff] [blame]

859

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

Joe Gregorio

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

[diff] [blame]

860

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

861

862

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

863

864

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

865

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

866

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

867

868

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

869

870

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

871

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

872

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

873

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

874

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

875

876

Args:

Joe Gregorio

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

[diff] [blame]

877

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

Joe Gregorio

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

[diff] [blame]

878

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

879

880

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

881

882

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

883

granted access for this application.

884

885

Args:

Joe Gregorio

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

[diff] [blame]

886

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

Joe Gregorio

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

[diff] [blame]

887

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

888

889

<hr>

890

Data descriptors defined here:

891

892

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

893

</dl>

894

<dl><dt>__weakref__</dt>

895

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

901

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

902

903

904

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

905

906

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

907

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

Example:

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

912

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

913

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

914

915

Joe Gregorio

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

[diff] [blame]

916

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

Joe Gregorio

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

[diff] [blame]

917

918

@decorator.oauth_required

919

def get(self):

920

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

921

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

922

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

923

924

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

925

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

926

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

927

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

928

</dl>

929

<hr>

930

Methods defined here:

931

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

932

933

Args:

934

filename: string, File name of client secrets.

Joe Gregorio

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

[diff] [blame]

935

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

936

requested.

Joe Gregorio

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

[diff] [blame]

937

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

938

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

939

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

940

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

941

942

<hr>

943

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

944

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

945

Joe Gregorio

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

[diff] [blame]

946

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

Joe Gregorio

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

[diff] [blame]

947

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

948

949

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

950

Joe Gregorio

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

[diff] [blame]

951

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

Joe Gregorio

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

[diff] [blame]

952

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

953

954

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

955

956

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

957

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

958

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

959

960

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

961

962

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

963

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

964

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

965

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

966

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

967

968

Args:

Joe Gregorio

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

[diff] [blame]

969

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

Joe Gregorio

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

[diff] [blame]

970

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

971

972

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

973

974

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

975

granted access for this application.

976

977

Args:

Joe Gregorio

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

[diff] [blame]

978

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

Joe Gregorio

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

[diff] [blame]

979

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

980

981

<hr>

982

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

983

984

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

985

</dl>

986

<dl><dt>__weakref__</dt>

987

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

</dl>

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

Joe Gregorio

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

[diff] [blame]

993

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

Joe Gregorio

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

[diff] [blame]

994

995

996

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

997

998

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

999

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

Joe Gregorio

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

[diff] [blame]

1000

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

Joe Gregorio

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

[diff] [blame]

1001

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

1002

</dl>

1003

<hr>

1004

Methods defined here:

1005

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

1006

1007

<hr>

Joe Gregorio

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

[diff] [blame]

1008

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

Joe Gregorio

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

[diff] [blame]

1009

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

1010

1011

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

1012

1013

Args:

1014

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

1015

1016

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

1017

1018

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

1019

if debug_mode is True.

1020

1021

Args:

1022

exception: the exception that was thrown

1023

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

1024

1025

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

1026

1027

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

1028

1029

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

1030

1031

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

1032

1033

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

1034

1035

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

1036

1037

Args:

1038

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

1039

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

1040

1041

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

1042

1043

<hr>

Joe Gregorio

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

[diff] [blame]

1044

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

Joe Gregorio

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

[diff] [blame]

1045

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

1046

1047

The default implementation uses the patterns passed to the active

1048

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

1049

urlresolvers.reverse() in the following ways:

1050

- It does not try to resolve handlers via module loading

1051

- It does not support named arguments

1052

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

1053

operators.

1054

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

1055

used in the active request.

1056

1057

Args:

1058

args: Parameters for the url pattern's groups.

1059

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

1060

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

1061

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

1062

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

1063

will use the tuple as the implicit arguments.

1064

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

1065

1066

Returns:

1067

The url for this handler/args combination.

1068

1069

Raises:

1070

NoUrlFoundError: No url pattern for this handler has the same

1071

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

1072

1073

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

1074

1075

Use factory method to create reusable request handlers that just

1076

require a few configuration parameters to construct.  Also useful

1077

for injecting shared state between multiple request handler

1078

instances without relying on global variables.  For example, to

1079

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

1080

you can write:

1081

Joe Gregorio

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

[diff] [blame]

1082

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

Joe Gregorio

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

[diff] [blame]

1083

1084

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

1085

self.transform = transform

1086

1087

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

1088

response_text = transform(

1089

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

1090

self.response.out.write(response_text)

1091

1092

application = webapp.WSGIApplication(

1093

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

1094

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

],

debug=True)

Text POSTed to /to_lower will be lower cased.

1099

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

1100

1101

<hr>

Joe Gregorio

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

[diff] [blame]

1102

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

Joe Gregorio

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

[diff] [blame]

1103

1104

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

1105

</dl>

1106

<dl><dt>__weakref__</dt>

1107

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

1113

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

1114

1115

1116

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

1117

the App Engine datastore.

1118

Joe Gregorio

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

[diff] [blame]

1119

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

Joe Gregorio

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

[diff] [blame]

1120

have been stored as a CredenialsProperty

1121

on a datastore model class, and that entities

1122

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

1123

Joe Gregorio

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

[diff] [blame]

1124

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

1125

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

1126

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

1127

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

1128

</dl>

1129

<hr>

1130

Methods defined here:

Joe Gregorio

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

[diff] [blame]

1131

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

1132

1133

Args:

Joe Gregorio

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

[diff] [blame]

1134

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]

1135

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

Joe Gregorio

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

[diff] [blame]

1136

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

1137

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]

1138

Joe Gregorio

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

[diff] [blame]

1139

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

1140

Joe Gregorio

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

[diff] [blame]

1141

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

1142

1143

Returns:

1144

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

1145

Joe Gregorio

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

[diff] [blame]

1146

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

1147

1148

Args:

1149

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

1150

1151

<hr>

Joe Gregorio

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

[diff] [blame]

1152

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

1153

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

1154

1155

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

1156

Joe Gregorio

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

[diff] [blame]

1157

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

1158

1159

Frees any resources associated with storing the credential.

1160

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]

1165

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

1166

Joe Gregorio

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

[diff] [blame]

1167

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]

1168

1169

Returns:

1170

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

1171

Joe Gregorio

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

[diff] [blame]

1172

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

1173

1174

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

1175

1176

Args:

1177

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

1178

1179

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

1180

1181

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

1182

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

1183

1184

<hr>

Joe Gregorio

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

[diff] [blame]

1185

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]

1186

1187

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

1188

</dl>

1189

<dl><dt>__weakref__</dt>

1190

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

1191

</dl>

1192

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

1193

Joe Gregorio

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

[diff] [blame]

1194

1195

1196

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

Joe Gregorio

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

[diff] [blame]

1200

<dl><dt><a name="-oauth2decorator_from_clientsecrets">oauth2decorator_from_clientsecrets</a>(filename, scope, message=None)</dt><dd><tt>Creates an <a href="#OAuth2Decorator">OAuth2Decorator</a> populated from a clientsecrets file.

1201

1202

Args:

1203

filename: string, File name of client secrets.

Joe Gregorio