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>

Joe Gregorio

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

[diff] [blame]

26

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

Joe Gregorio

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

[diff] [blame^]

27

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

28

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

Joe Gregorio

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

[diff] [blame]

29

Joe Gregorio

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

[diff] [blame^]

30

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

31

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

Joe Gregorio

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

[diff] [blame]

32

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

40

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

41

</dt><dd>

42

<dl>

43

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

44

</dt></dl>

45

</dd>

46

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

47

</dt><dd>

48

<dl>

49

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

50

</dt></dl>

51

</dd>

Joe Gregorio

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

[diff] [blame]

52

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

53

</dt><dd>

54

<dl>

55

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

56

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

57

</dt></dl>

58

</dd>

Joe Gregorio

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

[diff] [blame]

59

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

60

</dt><dd>

61

<dl>

62

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

63

</dt></dl>

64

</dd>

65

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

66

</dt><dd>

67

<dl>

68

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

69

</dt></dl>

70

</dd>

Joe Gregorio

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

[diff] [blame]

71

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

72

</dt><dd>

73

<dl>

74

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

75

</dt></dl>

76

</dd>

Joe Gregorio

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

[diff] [blame]

</dl>

Joe Gregorio

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

[diff] [blame]

82

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

83

84

85

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

86

87

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

88

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

89

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

90

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

91

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

92

the following link:

93

94

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

95

96

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

97

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

98

generate and refresh its own access tokens.

99

100

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

101

102

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

103

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

104

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

105

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

106

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

107

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

108

</dl>

109

<hr>

110

Methods defined here:

Joe Gregorio

0250385

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

[diff] [blame]

111

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

112

113

Args:

114

scope: string, scope of the credentials being requested.

Joe Gregorio

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

[diff] [blame]

115

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

116

convenience defaults to Google's audience.

117

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

118

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

119

assertion type string.

120

token_uri: string, URI for token endpoint. For convenience

121

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

122

123

<hr>

Joe Gregorio

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

[diff] [blame^]

124

Class methods defined here:

125

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

126

127

<hr>

Joe Gregorio

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

[diff] [blame]

128

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

129

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

130

131

<dl><dt><a name="AppAssertionCredentials-__setstate__">__setstate__</a>(self, state)</dt><dd><tt>Reconstitute the state of the <a href="__builtin__.html#object">object</a> from being pickled.</tt></dd></dl>

132

133

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

134

135

Args:

136

http: An instance of httplib2.Http

137

or something that acts like it.

138

139

Returns:

140

A modified instance of http that was passed in.

Example:

h = httplib2.Http()

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

146

Joe Gregorio

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

[diff] [blame^]

147

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

148

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

149

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

150

that adds in the Authorization header and then calls the original

151

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

Joe Gregorio

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

[diff] [blame]

152

Joe Gregorio

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

[diff] [blame^]

153

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

Joe Gregorio

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

[diff] [blame]

154

155

Args:

Joe Gregorio

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

[diff] [blame^]

156

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

Joe Gregorio

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

[diff] [blame]

157

This is needed to store the latest access_token if it

Joe Gregorio

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

[diff] [blame^]

158

has expired and been refreshed.  This implementation uses

159

locking to check for updates before updating the

160

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

161

162

Joe Gregorio

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

[diff] [blame]

163

164

<hr>

165

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

Joe Gregorio

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

[diff] [blame^]

166

<dl><dt>access_token_expired</dt>

167

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

168

169

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

Joe Gregorio

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

[diff] [blame]

170

</dl>

171

<hr>

Joe Gregorio

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

[diff] [blame^]

172

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

173

<dl><dt><a name="AppAssertionCredentials-new_from_json">new_from_json</a>(cls, s) from <a href="__builtin__.html#type">__builtin__.type</a></dt><dd><tt>Utility class method to instantiate a Credentials subclass from a JSON

174

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

175

176

Args:

177

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

178

179

Returns:

180

An instance of the subclass of Credentials that was serialized with

181

182

183

<hr>

Joe Gregorio

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

[diff] [blame]

184

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

185

186

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

187

</dl>

188

<dl><dt>__weakref__</dt>

189

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

190

</dl>

Joe Gregorio

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

[diff] [blame^]

191

<hr>

192

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

193

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

194

Joe Gregorio

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

[diff] [blame]

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

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

200

201

202

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

203

204

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

205

206

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

207

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

208

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

209

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

210

</dl>

211

<hr>

212

Data descriptors defined here:

213

<dl><dt>credentials</dt>

214

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

215

216

Utility property that allows easy storage and retrieval of

217

oath2client.Credentials</tt></dd>

218

</dl>

219

<hr>

220

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

221

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

222

223

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

224

which saves the entity to the datastore:

person = Person()

person.name = 'Bret'

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

229

230

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

231

arguments:

232

233

person = Person(name='Bret')

234

235

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

236

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-

241

level instance.

242

key_name: Name for new model instance.

243

_from_entity: Intentionally undocumented.

244

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

245

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

246

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

247

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

248

249

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

250

251

Args:

252

config: datastore_rpc.Configuration to use for this request.

253

254

Raises:

255

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

256

257

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

258

259

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

260

261

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

262

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

267

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

268

269

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

270

271

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

272

273

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

274

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

275

276

Returns:

277

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

278

279

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

280

281

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

282

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

283

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

284

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

285

286

Returns:

287

Datastore key of persisted entity.

288

289

Raises:

290

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

291

292

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

293

294

Returns:

295

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

296

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

297

298

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

299

300

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

301

but still get information about the instances parent.

302

303

Returns:

304

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

305

306

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

307

308

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

309

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

same.

Args:

config: datastore_rpc.Configuration to use for this request.

314

315

Returns:

316

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

317

318

Raises:

319

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

320

321

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

322

323

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

324

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

same.

Args:

config: datastore_rpc.Configuration to use for this request.

329

330

Returns:

331

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

332

333

Raises:

334

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

335

336

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

337

338

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

339

respective schemas. For more information, see:

340

341

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

342

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

343

344

<hr>

345

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

346

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

347

348

Returns:

349

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

350

351

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

352

353

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

354

355

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

356

357

Converts datastore.Entity instance to an instance of cls.

358

359

Args:

360

entity: Entity loaded directly from datastore.

361

362

Raises:

363

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

364

365

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

366

367

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

368

automatically).

369

370

Useful for ensuring that specific instance types are retrieved from the

371

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

372

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

373

374

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

375

376

Args:

377

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

378

or list of Keys or string keys.

379

config: datastore_rpc.Configuration to use for this request.

380

381

Returns:

382

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

383

for provided class if it exists in the datastore, otherwise

384

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

385

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

386

387

Raises:

388

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

389

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

390

391

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

392

393

Args:

394

key_names: A single id or a list of ids.

395

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

396

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

397

398

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

399

400

Args:

401

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

402

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

403

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

404

405

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

406

407

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

408

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

409

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

410

supplied) and insert that with the supplied key name.

411

412

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

413

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

414

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

415

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

416

return it.

417

418

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

419

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

420

one is created.

421

422

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

423

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

424

guarantees uniqueness.

Example usage:

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

429

creation_date = db.DatetimeProperty(auto_now_add=True)

430

body = db.TextProperty(required=True)

431

432

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

433

wiki_word = 'CommonIdioms'

434

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

435

body='This topic is totally new!')

436

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

437

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

438

439

# The second time through will just retrieve the entity.

440

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

441

body='A totally different message!')

442

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

443

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

444

445

Args:

446

key_name: Key name to retrieve or create.

447

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

448

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

449

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

450

rest of these arguments will be discarded.

451

452

Returns:

453

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

454

or a new one that has just been created.

455

456

Raises:

457

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

458

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

459

460

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

461

462

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

463

464

Args:

465

query_string: properly formatted GQL query string with the

466

'SELECT * FROM <entity>' part omitted

467

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

468

in the query.

469

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

470

471

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

472

473

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

474

475

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

476

477

<hr>

478

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

479

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

480

481

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

482

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

483

will complain about multiple argument values for 'cls'.

484

485

Raises:

486

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

487

488

<hr>

489

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

490

491

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

492

</dl>

493

<dl><dt>__weakref__</dt>

494

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

495

</dl>

496

<hr>

497

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

498

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

499

500

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

501

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

502

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

503

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

504

belong to and what attribute they are associated with and can

505

do appropriate initialization via __property_config__.

506

507

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

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

Joe Gregorio

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

[diff] [blame]

513

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

514

515

Joe Gregorio

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

[diff] [blame]

516

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

517

518

Utility property that allows easy storage and retrieval of

Joe Gregorio

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

[diff] [blame]

519

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

520

521

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

522

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

523

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

524

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

525

</dl>

526

<hr>

527

Methods defined here:

528

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

529

530

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

531

532

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

533

534

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

535

536

<hr>

537

Data and other attributes defined here:

538

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

539

Joe Gregorio

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

[diff] [blame^]

540

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

541

an HTTP transport.

542

543

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

544

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

Joe Gregorio

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

[diff] [blame]

545

546

<hr>

547

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

548

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

549

550

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

551

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

552

553

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

554

555

Args:

556

verbose_name: User friendly name of property.

Joe Gregorio

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

[diff] [blame]

557

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]

558

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]

559

default: Default value for property if none is assigned.

560

required: Whether property is required.

561

validator: User provided method used for validation.

562

choices: User provided set of valid property values.

563

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

564

565

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

566

567

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

568

it belongs to.

569

570

Args:

Joe Gregorio

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

[diff] [blame]

571

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.

572

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]

573

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

574

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

575

576

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

577

578

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

579

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

580

581

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

582

583

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

584

585

Returns:

586

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

587

588

<hr>

589

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

590

591

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

592

</dl>

593

<dl><dt>__weakref__</dt>

594

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

595

</dl>

596

<hr>

597

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]

598

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

605

606

Joe Gregorio

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

[diff] [blame]

607

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

608

609

Utility property that allows easy storage and retreival of an

Joe Gregorio

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

[diff] [blame]

610

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

611

612

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

613

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

614

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

615

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

616

</dl>

617

<hr>

618

Methods defined here:

619

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

620

621

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

622

623

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

624

625

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

626

627

<hr>

628

Data and other attributes defined here:

629

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

630

631

<hr>

632

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

633

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

634

635

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

636

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

637

638

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

639

640

Args:

641

verbose_name: User friendly name of property.

Joe Gregorio

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

[diff] [blame]

642

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]

643

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]

644

default: Default value for property if none is assigned.

645

required: Whether property is required.

646

validator: User provided method used for validation.

647

choices: User provided set of valid property values.

648

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

649

650

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

651

652

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

653

it belongs to.

654

655

Args:

Joe Gregorio

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

[diff] [blame]

656

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.

657

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]

658

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

659

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

660

661

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

662

663

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

664

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

665

666

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

667

668

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

669

670

Returns:

671

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

672

673

<hr>

674

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

675

676

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

677

</dl>

678

<dl><dt>__weakref__</dt>

679

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

680

</dl>

681

<hr>

682

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]

683

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

689

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

690

691

692

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

693

694

Instantiate and then use with oauth_required or oauth_aware

695

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

Example:

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

700

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

701

client_secret='Qh...wwI',

Joe Gregorio

0250385

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

[diff] [blame]

702

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

Joe Gregorio

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

[diff] [blame]

703

704

705

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

706

707

@decorator.oauth_required

708

def get(self):

709

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

710

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

711

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

712

713

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

Joe Gregorio

0250385

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

[diff] [blame]

714

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

715

716

Args:

717

client_id: string, client identifier.

718

client_secret: string client secret.

719

scope: string, scope of the credentials being requested.

Joe Gregorio

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

[diff] [blame]

720

auth_uri: string, URI for authorization endpoint. For convenience

721

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

722

token_uri: string, URI for token endpoint. For convenience

723

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

724

725

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

726

727

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

728

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

729

730

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

731

732

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

733

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

734

735

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

736

737

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

738

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

739

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

740

741

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

742

743

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

744

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

745

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

746

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

747

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

748

749

Args:

750

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

751

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

752

753

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

754

755

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

756

granted access for this application.

757

758

Args:

759

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

760

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

761

762

<hr>

763

Data descriptors defined here:

764

765

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

766

</dl>

767

<dl><dt>__weakref__</dt>

768

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

775

776

777

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

778

779

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

780

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

781

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

782

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

783

</dl>

784

<hr>

785

Methods defined here:

786

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

787

788

<hr>

789

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

790

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

791

792

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

793

794

Args:

795

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

796

797

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

798

799

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

800

if debug_mode is True.

801

802

Args:

803

exception: the exception that was thrown

804

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

805

806

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

807

808

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

809

810

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

811

812

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

813

814

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

815

816

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

817

818

Args:

819

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

820

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

821

822

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

823

824

<hr>

825

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

826

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

827

828

The default implementation uses the patterns passed to the active

829

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

830

urlresolvers.reverse() in the following ways:

831

- It does not try to resolve handlers via module loading

832

- It does not support named arguments

833

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

834

operators.

835

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

836

used in the active request.

837

838

Args:

839

args: Parameters for the url pattern's groups.

840

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

841

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

842

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

843

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

844

will use the tuple as the implicit arguments.

845

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

846

847

Returns:

848

The url for this handler/args combination.

849

850

Raises:

851

NoUrlFoundError: No url pattern for this handler has the same

852

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

853

854

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

855

856

Use factory method to create reusable request handlers that just

857

require a few configuration parameters to construct.  Also useful

858

for injecting shared state between multiple request handler

859

instances without relying on global variables.  For example, to

860

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

861

you can write:

862

863

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

864

865

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

866

self.transform = transform

867

868

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

869

response_text = transform(

870

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

871

self.response.out.write(response_text)

872

873

application = webapp.WSGIApplication(

874

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

875

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

],

debug=True)

Text POSTed to /to_lower will be lower cased.

880

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

881

882

<hr>

883

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

884

885

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

886

</dl>

887

<dl><dt>__weakref__</dt>

888

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

894

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

895

896

897

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

898

the App Engine datastore.

899

Joe Gregorio

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

[diff] [blame]

900

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

Joe Gregorio

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

[diff] [blame]

901

have been stored as a CredenialsProperty

902

on a datastore model class, and that entities

903

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

904

Joe Gregorio

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

[diff] [blame]

905

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

906

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

907

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

908

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

909

</dl>

910

<hr>

911

Methods defined here:

Joe Gregorio

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

[diff] [blame]

912

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

913

914

Args:

Joe Gregorio

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

[diff] [blame]

915

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

Joe Gregorio

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

[diff] [blame]

916

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

Joe Gregorio

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

[diff] [blame]

917

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

918

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

Joe Gregorio

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

[diff] [blame]

919

920

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

921

922

Returns:

923

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

924

925

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

926

927

Args:

928

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

929

930

<hr>

Joe Gregorio

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

[diff] [blame^]

931

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

932

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

933

934

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

935

936

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

937

938

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

939

940

Returns:

941

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

942

943

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

944

945

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

946

947

Args:

948

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

949

950

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

951

952

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

953

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

954

955

<hr>

Joe Gregorio