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:

112

<dl><dt><a name="AppAssertionCredentials-__init__">__init__</a>(self, scope, user_agent, 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>

113

114

Args:

115

scope: string, scope of the credentials being requested.

116

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

117

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

118

convenience defaults to Google's audience.

119

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

120

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

121

assertion type string.

122

token_uri: string, URI for token endpoint. For convenience

123

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

124

125

<hr>

126

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

127

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

128

129

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

130

131

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

132

133

Args:

134

http: An instance of httplib2.Http

135

or something that acts like it.

136

137

Returns:

138

A modified instance of http that was passed in.

Example:

h = httplib2.Http()

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

144

145

You can't create a new OAuth

146

subclass of httplib2.Authenication because

147

it never gets passed the absolute URI, which is

148

needed for signing. So instead we have to overload

149

'request' with a closure that adds in the

150

Authorization header and then calls the original version

151

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

152

153

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

154

155

Args:

156

store: callable, a callable that when passed a Credential

157

will store the credential back to where it came from.

158

This is needed to store the latest access_token if it

159

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

160

161

<hr>

162

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

163

<dl><dt>invalid</dt>

164

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

165

</dl>

166

<hr>

167

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

168

169

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

170

</dl>

171

<dl><dt>__weakref__</dt>

172

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

179

180

181

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

182

183

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

184

185

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

186

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

187

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

188

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

189

</dl>

190

<hr>

191

Data descriptors defined here:

192

<dl><dt>credentials</dt>

193

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

194

195

Utility property that allows easy storage and retrieval of

196

oath2client.Credentials</tt></dd>

197

</dl>

198

<hr>

199

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

200

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

201

202

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

203

which saves the entity to the datastore:

person = Person()

person.name = 'Bret'

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

208

209

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

210

arguments:

211

212

person = Person(name='Bret')

213

214

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

215

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-

220

level instance.

221

key_name: Name for new model instance.

222

_from_entity: Intentionally undocumented.

223

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

224

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

225

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

226

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

227

228

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

229

230

Args:

231

config: datastore_rpc.Configuration to use for this request.

232

233

Raises:

234

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

235

236

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

237

238

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

239

240

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

241

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

246

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

247

248

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

249

250

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

251

252

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

253

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

254

255

Returns:

256

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

257

258

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

259

260

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

261

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

262

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

263

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

264

265

Returns:

266

Datastore key of persisted entity.

267

268

Raises:

269

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

270

271

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

272

273

Returns:

274

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

275

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

276

277

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

278

279

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

280

but still get information about the instances parent.

281

282

Returns:

283

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

284

285

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

286

287

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

288

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

same.

Args:

config: datastore_rpc.Configuration to use for this request.

293

294

Returns:

295

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

296

297

Raises:

298

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

299

300

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

301

302

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

303

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

same.

Args:

config: datastore_rpc.Configuration to use for this request.

308

309

Returns:

310

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

311

312

Raises:

313

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

314

315

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

316

317

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

318

respective schemas. For more information, see:

319

320

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

321

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

322

323

<hr>

324

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

325

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

326

327

Returns:

328

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

329

330

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

331

332

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

333

334

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

335

336

Converts datastore.Entity instance to an instance of cls.

337

338

Args:

339

entity: Entity loaded directly from datastore.

340

341

Raises:

342

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

343

344

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

345

346

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

347

automatically).

348

349

Useful for ensuring that specific instance types are retrieved from the

350

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

351

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

352

353

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

354

355

Args:

356

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

357

or list of Keys or string keys.

358

config: datastore_rpc.Configuration to use for this request.

359

360

Returns:

361

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

362

for provided class if it exists in the datastore, otherwise

363

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

364

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

365

366

Raises:

367

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

368

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

369

370

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

371

372

Args:

373

key_names: A single id or a list of ids.

374

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

375

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

376

377

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

378

379

Args:

380

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

381

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

382

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

383

384

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

385

386

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

387

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

388

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

389

supplied) and insert that with the supplied key name.

390

391

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

392

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

393

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

394

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

395

return it.

396

397

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

398

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

399

one is created.

400

401

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

402

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

403

guarantees uniqueness.

Example usage:

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

408

creation_date = db.DatetimeProperty(auto_now_add=True)

409

body = db.TextProperty(required=True)

410

411

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

412

wiki_word = 'CommonIdioms'

413

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

414

body='This topic is totally new!')

415

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

416

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

417

418

# The second time through will just retrieve the entity.

419

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

420

body='A totally different message!')

421

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

422

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

423

424

Args:

425

key_name: Key name to retrieve or create.

426

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

427

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

428

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

429

rest of these arguments will be discarded.

430

431

Returns:

432

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

433

or a new one that has just been created.

434

435

Raises:

436

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

437

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

438

439

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

440

441

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

442

443

Args:

444

query_string: properly formatted GQL query string with the

445

'SELECT * FROM <entity>' part omitted

446

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

447

in the query.

448

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

449

450

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

451

452

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

453

454

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

455

456

<hr>

457

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

458

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

459

460

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

461

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

462

will complain about multiple argument values for 'cls'.

463

464

Raises:

465

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

466

467

<hr>

468

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

469

470

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

471

</dl>

472

<dl><dt>__weakref__</dt>

473

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

474

</dl>

475

<hr>

476

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

477

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

478

479

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

480

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

481

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

482

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

483

belong to and what attribute they are associated with and can

484

do appropriate initialization via __property_config__.

485

486

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

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

Joe Gregorio

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

[diff] [blame]

492

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

493

494

Joe Gregorio

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

[diff] [blame]

495

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

496

497

Utility property that allows easy storage and retrieval of

Joe Gregorio

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

[diff] [blame]

498

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

499

500

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

501

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

502

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

503

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

504

</dl>

505

<hr>

506

Methods defined here:

507

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

508

509

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

510

511

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

512

513

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

514

515

<hr>

516

Data and other attributes defined here:

517

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

518

519

Subclasses must define an authorize() method

520

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

521

522

<hr>

523

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

524

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

525

526

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

527

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

528

529

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

530

531

Args:

532

verbose_name: User friendly name of property.

Joe Gregorio

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

[diff] [blame]

533

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

534

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]

535

default: Default value for property if none is assigned.

536

required: Whether property is required.

537

validator: User provided method used for validation.

538

choices: User provided set of valid property values.

539

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

540

541

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

542

543

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

544

it belongs to.

545

546

Args:

Joe Gregorio

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

[diff] [blame^]

547

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.

548

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]

549

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

550

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

551

552

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

553

554

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

555

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

556

557

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

558

559

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

560

561

Returns:

562

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

563

564

<hr>

565

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

566

567

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

568

</dl>

569

<dl><dt>__weakref__</dt>

570

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

571

</dl>

572

<hr>

573

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

574

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

581

582

Joe Gregorio

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

[diff] [blame]

583

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

584

585

Utility property that allows easy storage and retreival of an

Joe Gregorio

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

[diff] [blame]

586

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

587

588

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

589

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

590

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

591

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

592

</dl>

593

<hr>

594

Methods defined here:

595

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

596

597

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

598

599

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

600

601

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

602

603

<hr>

604

Data and other attributes defined here:

605

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

606

607

<hr>

608

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

609

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

610

611

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

612

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

613

614

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

615

616

Args:

617

verbose_name: User friendly name of property.

Joe Gregorio

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

[diff] [blame]

618

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

619

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]

620

default: Default value for property if none is assigned.

621

required: Whether property is required.

622

validator: User provided method used for validation.

623

choices: User provided set of valid property values.

624

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

625

626

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

627

628

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

629

it belongs to.

630

631

Args:

Joe Gregorio

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

[diff] [blame^]

632

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.

633

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]

634

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

635

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

636

637

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

638

639

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

640

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

641

642

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

643

644

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

645

646

Returns:

647

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

648

649

<hr>

650

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

651

652

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

653

</dl>

654

<dl><dt>__weakref__</dt>

655

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

656

</dl>

657

<hr>

658

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

659

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

665

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

666

667

668

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

669

670

Instantiate and then use with oauth_required or oauth_aware

671

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

Example:

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

676

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

677

client_secret='Qh...wwI',

678

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

679

user_agent='my-sample-app/1.0')

680

681

682

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

683

684

@decorator.oauth_required

685

def get(self):

686

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

687

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

688

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

689

690

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

691

<dl><dt><a name="OAuth2Decorator-__init__">__init__</a>(self, client_id, client_secret, scope, user_agent, 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>

692

693

Args:

694

client_id: string, client identifier.

695

client_secret: string client secret.

696

scope: string, scope of the credentials being requested.

697

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

698

auth_uri: string, URI for authorization endpoint. For convenience

699

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

700

token_uri: string, URI for token endpoint. For convenience

701

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

702

703

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

704

705

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

706

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

707

708

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

709

710

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

711

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

712

713

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

714

715

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

716

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

717

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

718

719

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

720

721

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

722

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

723

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

724

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

725

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

726

727

Args:

728

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

729

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

730

731

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

732

733

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

734

granted access for this application.

735

736

Args:

737

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

738

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

739

740

<hr>

741

Data descriptors defined here:

742

743

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

744

</dl>

745

<dl><dt>__weakref__</dt>

746

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

753

754

755

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

756

757

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

758

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

759

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

760

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

761

</dl>

762

<hr>

763

Methods defined here:

764

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

765

766

<hr>

767

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

768

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

769

770

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

771

772

Args:

773

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

774

775

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

776

777

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

778

if debug_mode is True.

779

780

Args:

781

exception: the exception that was thrown

782

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

783

784

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

785

786

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

787

788

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

789

790

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

791

792

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

793

794

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

795

796

Args:

797

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

798

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

799

800

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

801

802

<hr>

803

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

804

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

805

806

The default implementation uses the patterns passed to the active

807

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

808

urlresolvers.reverse() in the following ways:

809

- It does not try to resolve handlers via module loading

810

- It does not support named arguments

811

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

812

operators.

813

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

814

used in the active request.

815

816

Args:

817

args: Parameters for the url pattern's groups.

818

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

819

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

820

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

821

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

822

will use the tuple as the implicit arguments.

823

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

824

825

Returns:

826

The url for this handler/args combination.

827

828

Raises:

829

NoUrlFoundError: No url pattern for this handler has the same

830

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

831

832

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

833

834

Use factory method to create reusable request handlers that just

835

require a few configuration parameters to construct.  Also useful

836

for injecting shared state between multiple request handler

837

instances without relying on global variables.  For example, to

838

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

839

you can write:

840

841

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

842

843

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

844

self.transform = transform

845

846

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

847

response_text = transform(

848

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

849

self.response.out.write(response_text)

850

851

application = webapp.WSGIApplication(

852

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

853

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

],

debug=True)

Text POSTed to /to_lower will be lower cased.

858

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

859

860

<hr>

861

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

862

863

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

864

</dl>

865

<dl><dt>__weakref__</dt>

866

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

872

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

873

874

875

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

876

the App Engine datastore.

877

Joe Gregorio

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

[diff] [blame]

878

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

Joe Gregorio

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

[diff] [blame]

879

have been stored as a CredenialsProperty

880

on a datastore model class, and that entities

881

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

882

Joe Gregorio

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

[diff] [blame]

883

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

884

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

885

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

886

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

887

</dl>

888

<hr>

889

Methods defined here:

Joe Gregorio

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

[diff] [blame^]

890

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

891

892

Args:

Joe Gregorio