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

24

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

25

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

26

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

27

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

Joe Gregorio

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

[diff] [blame]

28

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

Joe Gregorio

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

[diff] [blame]

29

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

30

31

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

32

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

33

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

41

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

42

</dt><dd>

43

<dl>

44

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

45

</dt></dl>

46

</dd>

47

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

48

</dt><dd>

49

<dl>

50

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

51

</dt></dl>

52

</dd>

Joe Gregorio

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

[diff] [blame]

53

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

54

</dt><dd>

55

<dl>

56

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

57

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

58

</dt></dl>

59

</dd>

Joe Gregorio

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

[diff] [blame]

60

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

61

</dt><dd>

62

<dl>

63

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

64

</dt></dl>

65

</dd>

66

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

67

</dt><dd>

68

<dl>

69

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

70

</dt></dl>

71

</dd>

Joe Gregorio

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

[diff] [blame]

72

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

73

</dt><dd>

74

<dl>

75

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

76

</dt></dl>

77

</dd>

Joe Gregorio

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

[diff] [blame]

</dl>

Joe Gregorio

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

[diff] [blame]

83

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

84

85

86

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

87

88

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

89

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

90

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

91

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

92

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

93

the following link:

94

95

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

96

97

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

98

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

99

generate and refresh its own access tokens.

100

101

AssertionFlowCredentials objects may be safely pickled and unpickled.  </tt></td></tr>

102

103

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

104

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

105

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

106

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

107

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

108

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

109

</dl>

110

<hr>

111

Methods defined here:

Joe Gregorio

0250385

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

[diff] [blame]

112

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

113

114

Args:

115

scope: string, scope of the credentials being requested.

Joe Gregorio

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

[diff] [blame]

116

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

117

convenience defaults to Google's audience.

118

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

119

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

120

assertion type string.

121

token_uri: string, URI for token endpoint. For convenience

122

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

123

124

<hr>

125

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

126

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

127

128

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

129

130

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

131

132

Args:

133

http: An instance of httplib2.Http

134

or something that acts like it.

135

136

Returns:

137

A modified instance of http that was passed in.

Example:

h = httplib2.Http()

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

143

144

You can't create a new OAuth

145

subclass of httplib2.Authenication because

146

it never gets passed the absolute URI, which is

147

needed for signing. So instead we have to overload

148

'request' with a closure that adds in the

149

Authorization header and then calls the original version

150

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

151

152

<dl><dt><a name="AppAssertionCredentials-set_store">set_store</a>(self, store)</dt><dd><tt>Set the storage for the credential.

153

154

Args:

155

store: callable, a callable that when passed a Credential

156

will store the credential back to where it came from.

157

This is needed to store the latest access_token if it

158

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

159

160

<hr>

161

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

162

<dl><dt>invalid</dt>

163

<dd><tt>True if the credentials are invalid, such as being revoked.</tt></dd>

164

</dl>

165

<hr>

166

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

167

168

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

169

</dl>

170

<dl><dt>__weakref__</dt>

171

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

</dl>

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

178

179

180

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

181

182

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

183

184

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

185

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

186

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

187

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

188

</dl>

189

<hr>

190

Data descriptors defined here:

191

<dl><dt>credentials</dt>

192

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

193

194

Utility property that allows easy storage and retrieval of

195

oath2client.Credentials</tt></dd>

196

</dl>

197

<hr>

198

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

199

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

200

201

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

202

which saves the entity to the datastore:

person = Person()

person.name = 'Bret'

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

207

208

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

209

arguments:

210

211

person = Person(name='Bret')

212

213

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

214

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-

219

level instance.

220

key_name: Name for new model instance.

221

_from_entity: Intentionally undocumented.

222

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

223

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

224

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

225

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

226

227

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

228

229

Args:

230

config: datastore_rpc.Configuration to use for this request.

231

232

Raises:

233

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

234

235

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

236

237

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

238

239

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

240

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

245

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

246

247

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

248

249

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

250

251

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

252

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

253

254

Returns:

255

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

256

257

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

258

259

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

260

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

261

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

262

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

263

264

Returns:

265

Datastore key of persisted entity.

266

267

Raises:

268

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

269

270

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

271

272

Returns:

273

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

274

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

275

276

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

277

278

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

279

but still get information about the instances parent.

280

281

Returns:

282

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

283

284

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

285

286

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

287

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

same.

Args:

config: datastore_rpc.Configuration to use for this request.

292

293

Returns:

294

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

295

296

Raises:

297

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

298

299

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

300

301

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

302

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

same.

Args:

config: datastore_rpc.Configuration to use for this request.

307

308

Returns:

309

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

310

311

Raises:

312

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

313

314

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

315

316

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

317

respective schemas. For more information, see:

318

319

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

320

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

321

322

<hr>

323

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

324

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

325

326

Returns:

327

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

328

329

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

330

331

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

332

333

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

334

335

Converts datastore.Entity instance to an instance of cls.

336

337

Args:

338

entity: Entity loaded directly from datastore.

339

340

Raises:

341

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

342

343

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

344

345

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

346

automatically).

347

348

Useful for ensuring that specific instance types are retrieved from the

349

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

350

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

351

352

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

353

354

Args:

355

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

356

or list of Keys or string keys.

357

config: datastore_rpc.Configuration to use for this request.

358

359

Returns:

360

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

361

for provided class if it exists in the datastore, otherwise

362

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

363

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

364

365

Raises:

366

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

367

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

368

369

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

370

371

Args:

372

key_names: A single id or a list of ids.

373

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

374

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

375

376

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

377

378

Args:

379

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

380

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

381

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

382

383

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

384

385

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

386

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

387

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

388

supplied) and insert that with the supplied key name.

389

390

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

391

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

392

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

393

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

394

return it.

395

396

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

397

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

398

one is created.

399

400

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

401

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

402

guarantees uniqueness.

Example usage:

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

407

creation_date = db.DatetimeProperty(auto_now_add=True)

408

body = db.TextProperty(required=True)

409

410

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

411

wiki_word = 'CommonIdioms'

412

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

413

body='This topic is totally new!')

414

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

415

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

416

417

# The second time through will just retrieve the entity.

418

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

419

body='A totally different message!')

420

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

421

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

422

423

Args:

424

key_name: Key name to retrieve or create.

425

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

426

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

427

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

428

rest of these arguments will be discarded.

429

430

Returns:

431

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

432

or a new one that has just been created.

433

434

Raises:

435

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

436

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

437

438

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

439

440

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

441

442

Args:

443

query_string: properly formatted GQL query string with the

444

'SELECT * FROM <entity>' part omitted

445

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

446

in the query.

447

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

448

449

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

450

451

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

452

453

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

454

455

<hr>

456

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

457

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

458

459

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

460

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

461

will complain about multiple argument values for 'cls'.

462

463

Raises:

464

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

465

466

<hr>

467

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

468

469

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

470

</dl>

471

<dl><dt>__weakref__</dt>

472

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

473

</dl>

474

<hr>

475

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

476

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

477

478

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

479

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

480

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

481

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

482

belong to and what attribute they are associated with and can

483

do appropriate initialization via __property_config__.

484

485

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

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

Joe Gregorio

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

[diff] [blame]

491

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

492

493

Joe Gregorio

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

[diff] [blame]

494

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

495

496

Utility property that allows easy storage and retrieval of

Joe Gregorio

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

[diff] [blame]

497

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

498

499

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

500

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

501

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

502

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

503

</dl>

504

<hr>

505

Methods defined here:

506

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

507

508

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

509

510

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

511

512

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

513

514

<hr>

515

Data and other attributes defined here:

516

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

517

518

Subclasses must define an authorize() method

519

that applies the credentials to an HTTP transport.</tt></dl>

520

521

<hr>

522

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

523

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

524

525

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

526

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

527

528

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

529

530

Args:

531

verbose_name: User friendly name of property.

Joe Gregorio

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

[diff] [blame]

532

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]

533

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]

534

default: Default value for property if none is assigned.

535

required: Whether property is required.

536

validator: User provided method used for validation.

537

choices: User provided set of valid property values.

538

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

539

540

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

541

542

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

543

it belongs to.

544

545

Args:

Joe Gregorio

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

[diff] [blame]

546

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.

547

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]

548

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

549

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

550

551

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

552

553

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

554

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

555

556

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

557

558

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

559

560

Returns:

561

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

562

563

<hr>

564

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

565

566

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

567

</dl>

568

<dl><dt>__weakref__</dt>

569

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

570

</dl>

571

<hr>

572

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]

573

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

580

581

Joe Gregorio

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

[diff] [blame]

582

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

583

584

Utility property that allows easy storage and retreival of an

Joe Gregorio

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

[diff] [blame]

585

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

586

587

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

588

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

589

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

590

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

591

</dl>

592

<hr>

593

Methods defined here:

594

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

595

596

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

597

598

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

599

600

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

601

602

<hr>

603

Data and other attributes defined here:

604

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

605

606

<hr>

607

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

608

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

609

610

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

611

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

612

613

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

614

615

Args:

616

verbose_name: User friendly name of property.

Joe Gregorio

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

[diff] [blame]

617

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]

618

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]

619

default: Default value for property if none is assigned.

620

required: Whether property is required.

621

validator: User provided method used for validation.

622

choices: User provided set of valid property values.

623

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

624

625

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

626

627

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

628

it belongs to.

629

630

Args:

Joe Gregorio

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

[diff] [blame]

631

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.

632

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]

633

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

634

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

635

636

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

637

638

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

639

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

640

641

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

642

643

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

644

645

Returns:

646

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

647

648

<hr>

649

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

650

651

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

652

</dl>

653

<dl><dt>__weakref__</dt>

654

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

655

</dl>

656

<hr>

657

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]

658

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

Joe Gregorio

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

[diff] [blame]

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

Joe Gregorio

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

[diff] [blame]

664

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

665

666

667

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

668

669

Instantiate and then use with oauth_required or oauth_aware

670

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

Example:

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

675

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

676

client_secret='Qh...wwI',

Joe Gregorio

0250385

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

[diff] [blame]

677

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

Joe Gregorio

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

[diff] [blame]

678

679

680

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

681

682

@decorator.oauth_required

683

def get(self):

684

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

685

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

686

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

687

688

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

Joe Gregorio

0250385

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

[diff] [blame]

689

<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')</dt><dd><tt>Constructor for <a href="#OAuth2Decorator">OAuth2Decorator</a>

Joe Gregorio

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

[diff] [blame]

690

691

Args:

692

client_id: string, client identifier.

693

client_secret: string client secret.

694

scope: string, scope of the credentials being requested.

Joe Gregorio

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

[diff] [blame]

695

auth_uri: string, URI for authorization endpoint. For convenience

696

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

697

token_uri: string, URI for token endpoint. For convenience

698

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

699

700

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

701

702

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

703

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

704

705

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

706

707

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

708

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

709

710

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

711

712

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

713

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

714

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

715

716

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

717

718

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

719

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

720

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

721

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

722

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

723

724

Args:

725

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

726

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

727

728

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

729

730

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

731

granted access for this application.

732

733

Args:

734

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

735

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

736

737

<hr>

738

Data descriptors defined here:

739

740

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

741

</dl>

742

<dl><dt>__weakref__</dt>

743

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

</dl>

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

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

750

751

752

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

753

754

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

755

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

756

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

757

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

758

</dl>

759

<hr>

760

Methods defined here:

761

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

762

763

<hr>

764

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

765

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

766

767

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

768

769

Args:

770

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

771

772

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

773

774

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

775

if debug_mode is True.

776

777

Args:

778

exception: the exception that was thrown

779

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

780

781

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

782

783

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

784

785

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

786

787

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

788

789

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

790

791

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

792

793

Args:

794

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

795

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

796

797

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

798

799

<hr>

800

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

801

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

802

803

The default implementation uses the patterns passed to the active

804

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

805

urlresolvers.reverse() in the following ways:

806

- It does not try to resolve handlers via module loading

807

- It does not support named arguments

808

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

809

operators.

810

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

811

used in the active request.

812

813

Args:

814

args: Parameters for the url pattern's groups.

815

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

816

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

817

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

818

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

819

will use the tuple as the implicit arguments.

820

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

821

822

Returns:

823

The url for this handler/args combination.

824

825

Raises:

826

NoUrlFoundError: No url pattern for this handler has the same

827

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

828

829

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

830

831

Use factory method to create reusable request handlers that just

832

require a few configuration parameters to construct.  Also useful

833

for injecting shared state between multiple request handler

834

instances without relying on global variables.  For example, to

835

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

836

you can write:

837

838

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

839

840

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

841

self.transform = transform

842

843

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

844

response_text = transform(

845

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

846

self.response.out.write(response_text)

847

848

application = webapp.WSGIApplication(

849

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

850

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

],

debug=True)

Text POSTed to /to_lower will be lower cased.

855

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

856

857

<hr>

858

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

859

860

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

861

</dl>

862

<dl><dt>__weakref__</dt>

863

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

869

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

870

871

872

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

873

the App Engine datastore.

874

Joe Gregorio

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

[diff] [blame]

875

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

Joe Gregorio

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

[diff] [blame]

876

have been stored as a CredenialsProperty

877

on a datastore model class, and that entities

878

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

879

Joe Gregorio

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

[diff] [blame]

880

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

881

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

882

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

883

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

884

</dl>

885

<hr>

886

Methods defined here:

Joe Gregorio

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

[diff] [blame]

887

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

888

889

Args:

Joe Gregorio