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

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

[diff] [blame]

12

<tt>Utilities for Google App Engine

13

Joe Gregorio

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

[diff] [blame]

14

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

Joe Gregorio

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

[diff] [blame]

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

20

21

Joe Gregorio

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

[diff] [blame]

22

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

23

Joe Gregorio

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

[diff] [blame]

24

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

25

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

26

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

27

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

28

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

Joe Gregorio

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

[diff] [blame]

29

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

Joe Gregorio

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

[diff] [blame]

30

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

31

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

Joe Gregorio

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

[diff] [blame]

32

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

Joe Gregorio

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

[diff] [blame]

33

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

Joe Gregorio

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

[diff] [blame]

34

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

Joe Gregorio

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

[diff] [blame]

<big>Classes</big></td></tr>

Joe Gregorio

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

[diff] [blame]

42

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

43

</dt><dd>

44

<dl>

45

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

Joe Gregorio

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

[diff] [blame]

46

</dt><dd>

47

<dl>

48

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

</dt></dl>

</dd>

</dl>

</dd>

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

54

</dt><dd>

55

<dl>

56

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

Joe Gregorio

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

[diff] [blame]

57

</dt></dl>

58

</dd>

59

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

60

</dt><dd>

61

<dl>

62

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

63

</dt></dl>

64

</dd>

Joe Gregorio

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

[diff] [blame]

65

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

66

</dt><dd>

67

<dl>

68

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

69

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

70

</dt></dl>

71

</dd>

Joe Gregorio

2011-12-15 09:18:49 -0500

[diff] [blame]

72

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

Joe Gregorio

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

[diff] [blame]

73

</dt><dd>

74

<dl>

75

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

76

</dt></dl>

77

</dd>

78

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

79

</dt><dd>

80

<dl>

81

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

82

</dt></dl>

83

</dd>

Joe Gregorio

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

[diff] [blame]

84

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

85

</dt><dd>

86

<dl>

87

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

88

</dt></dl>

89

</dd>

Joe Gregorio

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

[diff] [blame]

</dl>

Joe Gregorio

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

[diff] [blame]

95

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

96

97

98

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

99

100

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

101

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

102

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

103

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

104

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

105

the following link:

106

107

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

108

109

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

110

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

Joe Gregorio

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

[diff] [blame]

111

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

Joe Gregorio

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

[diff] [blame]

112

113

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

114

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

115

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

116

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

117

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

118

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

119

</dl>

120

<hr>

121

Methods defined here:

Joe Gregorio

0250385

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

[diff] [blame]

122

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

Joe Gregorio

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

[diff] [blame]

123

124

Args:

125

scope: string, scope of the credentials being requested.

Joe Gregorio

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

[diff] [blame]

126

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

127

convenience defaults to Google's audience.

128

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

129

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

130

assertion type string.

131

token_uri: string, URI for token endpoint. For convenience

132

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

133

134

<hr>

Joe Gregorio

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

[diff] [blame]

135

Class methods defined here:

136

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

137

138

<hr>

Joe Gregorio

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

[diff] [blame]

139

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

140

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

141

142

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

143

144

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

145

146

Args:

147

http: An instance of httplib2.Http

148

or something that acts like it.

149

150

Returns:

151

A modified instance of http that was passed in.

Example:

h = httplib2.Http()

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

157

Joe Gregorio

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

[diff] [blame]

158

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

159

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

160

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

161

that adds in the Authorization header and then calls the original

162

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

Joe Gregorio

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

[diff] [blame]

163

Joe Gregorio

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

[diff] [blame]

164

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

165

166

Args:

Joe Gregorio

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

[diff] [blame]

167

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]

168

This is needed to store the latest access_token if it

Joe Gregorio

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

[diff] [blame]

169

has expired and been refreshed.  This implementation uses

170

locking to check for updates before updating the

171

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

172

173

Joe Gregorio

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

[diff] [blame]

174

175

<hr>

176

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]

177

<dl><dt>access_token_expired</dt>

178

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

179

180

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]

181

</dl>

182

<hr>

Joe Gregorio

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

[diff] [blame]

183

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

184

<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

185

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

186

187

Args:

188

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

189

190

Returns:

191

An instance of the subclass of Credentials that was serialized with

192

193

194

<hr>

Joe Gregorio

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

[diff] [blame]

195

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

196

197

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

198

</dl>

199

<dl><dt>__weakref__</dt>

200

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

201

</dl>

Joe Gregorio

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

[diff] [blame]

202

<hr>

203

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

204

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

205

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>

211

212

213

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

214

215

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

216

217

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

218

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

219

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

220

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

221

</dl>

222

<hr>

223

Data descriptors defined here:

224

<dl><dt>credentials</dt>

225

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

226

227

Utility property that allows easy storage and retrieval of

228

oath2client.Credentials</tt></dd>

229

</dl>

230

<hr>

231

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

232

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

233

234

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

235

which saves the entity to the datastore:

person = Person()

person.name = 'Bret'

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

240

241

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

242

arguments:

243

244

person = Person(name='Bret')

245

246

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

247

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-

252

level instance.

253

key_name: Name for new model instance.

254

_from_entity: Intentionally undocumented.

255

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

256

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

257

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

258

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

259

260

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

261

262

Args:

263

config: datastore_rpc.Configuration to use for this request.

264

265

Raises:

266

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

267

268

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

269

270

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

271

272

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

273

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

278

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

279

280

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

281

282

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

283

284

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

285

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

286

287

Returns:

288

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

289

290

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

291

292

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

293

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

294

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

295

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

296

297

Returns:

298

Datastore key of persisted entity.

299

300

Raises:

301

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

302

303

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

304

305

Returns:

306

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

307

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

308

309

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

310

311

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

312

but still get information about the instances parent.

313

314

Returns:

315

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

316

317

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

318

319

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

320

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

same.

Args:

config: datastore_rpc.Configuration to use for this request.

325

326

Returns:

327

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

328

329

Raises:

330

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

331

332

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

333

334

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

335

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

same.

Args:

config: datastore_rpc.Configuration to use for this request.

340

341

Returns:

342

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

343

344

Raises:

345

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

346

347

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

348

349

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

350

respective schemas. For more information, see:

351

352

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

353

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

354

355

<hr>

356

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

357

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

358

359

Returns:

360

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

361

362

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

363

364

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

365

366

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

367

368

Converts datastore.Entity instance to an instance of cls.

369

370

Args:

371

entity: Entity loaded directly from datastore.

372

373

Raises:

374

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

375

376

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

377

378

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

379

automatically).

380

381

Useful for ensuring that specific instance types are retrieved from the

382

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

383

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

384

385

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

386

387

Args:

388

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

389

or list of Keys or string keys.

390

config: datastore_rpc.Configuration to use for this request.

391

392

Returns:

393

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

394

for provided class if it exists in the datastore, otherwise

395

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

396

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

397

398

Raises:

399

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

400

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

401

402

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

403

404

Args:

405

key_names: A single id or a list of ids.

406

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

407

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

408

409

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

410

411

Args:

412

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

413

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

414

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

415

416

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

417

418

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

419

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

420

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

421

supplied) and insert that with the supplied key name.

422

423

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

424

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

425

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

426

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

427

return it.

428

429

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

430

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

431

one is created.

432

433

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

434

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

435

guarantees uniqueness.

Example usage:

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

440

creation_date = db.DatetimeProperty(auto_now_add=True)

441

body = db.TextProperty(required=True)

442

443

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

444

wiki_word = 'CommonIdioms'

445

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

446

body='This topic is totally new!')

447

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

448

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

449

450

# The second time through will just retrieve the entity.

451

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

452

body='A totally different message!')

453

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

454

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

455

456

Args:

457

key_name: Key name to retrieve or create.

458

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

459

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

460

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

461

rest of these arguments will be discarded.

462

463

Returns:

464

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

465

or a new one that has just been created.

466

467

Raises:

468

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

469

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

470

471

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

472

473

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

474

475

Args:

476

query_string: properly formatted GQL query string with the

477

'SELECT * FROM <entity>' part omitted

478

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

479

in the query.

480

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

481

482

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

483

484

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

485

486

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

487

488

<hr>

489

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

490

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

491

492

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

493

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

494

will complain about multiple argument values for 'cls'.

495

496

Raises:

497

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

498

499

<hr>

500

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

501

502

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

503

</dl>

504

<dl><dt>__weakref__</dt>

505

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

506

</dl>

507

<hr>

508

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

509

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

510

511

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

512

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

513

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

514

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

515

belong to and what attribute they are associated with and can

516

do appropriate initialization via __property_config__.

517

518

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

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

Joe Gregorio

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

[diff] [blame]

524

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

525

526

Joe Gregorio

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

[diff] [blame]

527

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

528

529

Utility property that allows easy storage and retrieval of

Joe Gregorio

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

[diff] [blame]

530

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

531

532

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

533

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

534

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

535

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

536

</dl>

537

<hr>

538

Methods defined here:

Joe Gregorio

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

[diff] [blame]

539

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

540

541

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

542

543

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

544

545

<hr>

546

Data and other attributes defined here:

547

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

548

Joe Gregorio

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

[diff] [blame]

549

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

550

an HTTP transport.

551

552

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

553

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]

554

555

<hr>

556

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

557

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

558

559

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

560

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

561

562

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

563

564

Args:

565

verbose_name: User friendly name of property.

Joe Gregorio

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

[diff] [blame]

566

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]

567

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]

568

default: Default value for property if none is assigned.

569

required: Whether property is required.

570

validator: User provided method used for validation.

571

choices: User provided set of valid property values.

572

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

573

574

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

575

576

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

577

it belongs to.

578

579

Args:

Joe Gregorio

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

[diff] [blame]

580

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.

581

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]

582

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

583

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

584

585

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

586

587

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

588

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

589

590

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

591

592

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

593

594

Returns:

595

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

596

Joe Gregorio

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

[diff] [blame]

597

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

598

599

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

600

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

if necessary.

Args:

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

605

606

Returns:

607

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

608

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

609

Joe Gregorio

2011-12-15 09:18:49 -0500

[diff] [blame]

610

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

611

612

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

613

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

614

properties. For all other properties, this call must return

615

AUTO_UPDATE_UNCHANGED.

616

617

Args:

618

model_instance: Instance to get new value for.

619

620

Returns:

621

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

622

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

623

Joe Gregorio

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

[diff] [blame]

624

<hr>

625

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

626

627

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

628

</dl>

629

<dl><dt>__weakref__</dt>

630

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

631

</dl>

632

<hr>

633

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]

634

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

641

642

Joe Gregorio

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

[diff] [blame]

643

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

644

645

Utility property that allows easy storage and retreival of an

Joe Gregorio

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

[diff] [blame]

646

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

647

648

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

649

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

650

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

651

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

652

</dl>

653

<hr>

654

Methods defined here:

655

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

656

657

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

658

659

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

660

661

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

662

663

<hr>

664

Data and other attributes defined here:

665

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

666

667

<hr>

668

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

669

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

670

671

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

672

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

673

674

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

675

676

Args:

677

verbose_name: User friendly name of property.

Joe Gregorio

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

[diff] [blame]

678

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]

679

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]

680

default: Default value for property if none is assigned.

681

required: Whether property is required.

682

validator: User provided method used for validation.

683

choices: User provided set of valid property values.

684

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

685

686

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

687

688

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

689

it belongs to.

690

691

Args:

Joe Gregorio

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

[diff] [blame]

692

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.

693

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]

694

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

695

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

696

697

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

698

699

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

700

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

701

702

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

703

704

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

705

706

Returns:

707

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

708

Joe Gregorio

2011-12-15 09:18:49 -0500

[diff] [blame]

709

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

710

711

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

712

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

713

properties. For all other properties, this call must return

714

AUTO_UPDATE_UNCHANGED.

715

716

Args:

717

model_instance: Instance to get new value for.

718

719

Returns:

720

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

721

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

722

Joe Gregorio

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

[diff] [blame]

723

<hr>

724

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

725

726

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

727

</dl>

728

<dl><dt>__weakref__</dt>

729

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

730

</dl>

731

<hr>

732

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]

733

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

Joe Gregorio

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

[diff] [blame]

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

Joe Gregorio

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

[diff] [blame]

739

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

740

741

742

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

743

744

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

745

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

746

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

747

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

748

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

749

</dl>

750

<hr>

751

Data descriptors defined here:

752

<dl><dt>__weakref__</dt>

753

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

754

</dl>

755

<hr>

756

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

757

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

758

759

<hr>

760

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

761

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

762

763

<hr>

764

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

765

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

766

767

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

768

769

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

770

771

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

772

773

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

774

775

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

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

780

781

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

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

786

787

<hr>

788

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

</dl>

</dl>

<dl><dt>message</dt>

</dl>

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

Joe Gregorio

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

[diff] [blame]

799

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

800

801

802

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

803

804

Instantiate and then use with oauth_required or oauth_aware

Joe Gregorio

2011-12-15 09:18:49 -0500

[diff] [blame]

805

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

Joe Gregorio

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

[diff] [blame]

Example:

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

810

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

811

client_secret='Qh...wwI',

Joe Gregorio

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

[diff] [blame]

812

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

Joe Gregorio

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

[diff] [blame]

813

814

Joe Gregorio

2011-12-15 09:18:49 -0500

[diff] [blame]

815

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

Joe Gregorio

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

[diff] [blame]

816

817

@decorator.oauth_required

818

def get(self):

819

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

820

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

821

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

822

823

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

Joe Gregorio

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

[diff] [blame]

824

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

Joe Gregorio

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

[diff] [blame]

825

826

Args:

827

client_id: string, client identifier.

828

client_secret: string client secret.

Joe Gregorio

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

[diff] [blame]

829

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

830

requested.

Joe Gregorio

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

[diff] [blame]

831

auth_uri: string, URI for authorization endpoint. For convenience

832

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

833

token_uri: string, URI for token endpoint. For convenience

Joe Gregorio

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

[diff] [blame]

834

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

835

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

836

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

837

web interface for any method that uses the decorator.</tt></dd></dl>

Joe Gregorio

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

[diff] [blame]

838

839

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

840

Joe Gregorio

2011-12-15 09:18:49 -0500

[diff] [blame]

841

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

Joe Gregorio

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

[diff] [blame]

842

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

843

844

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

845

Joe Gregorio

2011-12-15 09:18:49 -0500

[diff] [blame]

846

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

Joe Gregorio

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

[diff] [blame]

847

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

848

849

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

850

851

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

852

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

853

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

854

855

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

856

857

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

858

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

859

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

860

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

861

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

862

863

Args:

Joe Gregorio

2011-12-15 09:18:49 -0500

[diff] [blame]

864

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

Joe Gregorio

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

[diff] [blame]

865

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

866

867

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

868

869

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

870

granted access for this application.

871

872

Args:

Joe Gregorio

2011-12-15 09:18:49 -0500

[diff] [blame]

873

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

Joe Gregorio

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

[diff] [blame]

874

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

875

876

<hr>

877

Data descriptors defined here:

878

879

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

880

</dl>

881

<dl><dt>__weakref__</dt>

882

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

</dl>

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

Joe Gregorio

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

[diff] [blame]

888

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

889

890

891

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

892

893

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

894

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

Example:

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

899

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

900

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

901

902

Joe Gregorio

2011-12-15 09:18:49 -0500

[diff] [blame]

903

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

Joe Gregorio

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

[diff] [blame]

904

905

@decorator.oauth_required

906

def get(self):

907

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

908

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

909

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

910

911

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

912

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

913

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

914

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

915

</dl>

916

<hr>

917

Methods defined here:

918

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

919

920

Args:

921

filename: string, File name of client secrets.

922

scope: string, Space separated list of scopes.

923

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

924

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

925

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

926

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

927

928

<hr>

929

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

930

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

931

Joe Gregorio

2011-12-15 09:18:49 -0500

[diff] [blame]

932

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

Joe Gregorio

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

[diff] [blame]

933

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

934

935

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

936

Joe Gregorio

2011-12-15 09:18:49 -0500

[diff] [blame]

937

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

Joe Gregorio

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

[diff] [blame]

938

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

939

940

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

941

942

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

943

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

944

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

945

946

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

947

948

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

949

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

950

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

951

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

952

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

953

954

Args:

Joe Gregorio

2011-12-15 09:18:49 -0500

[diff] [blame]

955

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

Joe Gregorio

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

[diff] [blame]

956

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

957

958

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

959

960

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

961

granted access for this application.

962

963

Args:

Joe Gregorio

2011-12-15 09:18:49 -0500

[diff] [blame]

964

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

Joe Gregorio

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

[diff] [blame]

965

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

966

967

<hr>

968

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

969

970

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

971

</dl>

972

<dl><dt>__weakref__</dt>

973

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

</dl>

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

Joe Gregorio

2011-12-15 09:18:49 -0500

[diff] [blame]

979

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

Joe Gregorio

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

[diff] [blame]

980

981

982

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

983

984

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

985

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

Joe Gregorio

2011-12-15 09:18:49 -0500

[diff] [blame]

986

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

Joe Gregorio

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

[diff] [blame]

987

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

988

</dl>

989

<hr>

990

Methods defined here:

991

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

992

993

<hr>

Joe Gregorio

2011-12-15 09:18:49 -0500

[diff] [blame]

994

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

Joe Gregorio

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

[diff] [blame]

995

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

996

997

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

998

999

Args:

1000

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

1001

1002

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

1003

1004

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

1005

if debug_mode is True.

1006

1007

Args:

1008

exception: the exception that was thrown

1009

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

1010

1011

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

1012

1013

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

1014

1015

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

1016

1017

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

1018

1019

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

1020

1021

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

1022

1023

Args:

1024

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

1025

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

1026

1027

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

1028

1029

<hr>

Joe Gregorio

2011-12-15 09:18:49 -0500

[diff] [blame]

1030

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

Joe Gregorio

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

[diff] [blame]

1031

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

1032

1033

The default implementation uses the patterns passed to the active

1034

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

1035

urlresolvers.reverse() in the following ways:

1036

- It does not try to resolve handlers via module loading

1037

- It does not support named arguments

1038

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

1039

operators.

1040

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

1041

used in the active request.

1042

1043

Args:

1044

args: Parameters for the url pattern's groups.

1045

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

1046

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

1047

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

1048

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

1049

will use the tuple as the implicit arguments.

1050

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

1051

1052

Returns:

1053

The url for this handler/args combination.

1054

1055

Raises:

1056

NoUrlFoundError: No url pattern for this handler has the same

1057

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

1058

1059

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

1060

1061

Use factory method to create reusable request handlers that just

1062

require a few configuration parameters to construct.  Also useful

1063

for injecting shared state between multiple request handler

1064

instances without relying on global variables.  For example, to

1065

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

1066

you can write:

1067

Joe Gregorio

2011-12-15 09:18:49 -0500

[diff] [blame]

1068

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

Joe Gregorio

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

[diff] [blame]

1069

1070

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

1071

self.transform = transform

1072

1073

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

1074

response_text = transform(

1075

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

1076

self.response.out.write(response_text)

1077

1078

application = webapp.WSGIApplication(

1079

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

1080

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

],

debug=True)

Text POSTed to /to_lower will be lower cased.

1085

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

1086

1087

<hr>

Joe Gregorio

2011-12-15 09:18:49 -0500

[diff] [blame]

1088

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

Joe Gregorio

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

[diff] [blame]

1089

1090

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

1091

</dl>

1092

<dl><dt>__weakref__</dt>

1093

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

1099

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

1100

1101

1102

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

1103

the App Engine datastore.

1104

Joe Gregorio

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

[diff] [blame]

1105

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

Joe Gregorio

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

[diff] [blame]

1106

have been stored as a CredenialsProperty

1107

on a datastore model class, and that entities

1108

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

1109

Joe Gregorio

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

[diff] [blame]

1110

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

1111

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

1112

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

1113

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

1114

</dl>

1115

<hr>

1116

Methods defined here:

Joe Gregorio

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

[diff] [blame]

1117

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

1118

1119

Args:

Joe Gregorio

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

[diff] [blame]

1120

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]

1121

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

Joe Gregorio

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

[diff] [blame]

1122

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

1123

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]

1124

Joe Gregorio

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

[diff] [blame]

1125

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

Joe Gregorio

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

[diff] [blame]

1126

1127

Returns:

1128

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

1129

Joe Gregorio

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

[diff] [blame]

1130

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

Joe Gregorio

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

[diff] [blame]

1131

1132

Args:

1133

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

1134

1135

<hr>

Joe Gregorio

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

[diff] [blame]

1136

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

1137

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

1138

1139

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

1140

Joe Gregorio

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

[diff] [blame]

1141

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

Joe Gregorio

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

[diff] [blame]

1142

Joe Gregorio

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

[diff] [blame]

1143

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

Joe Gregorio

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

[diff] [blame]

1144

1145

Returns:

1146

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

1147

Joe Gregorio

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

[diff] [blame]

1148

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

Joe Gregorio

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

[diff] [blame]

1149

1150

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

1151

1152

Args:

1153

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

1154

1155

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

1156

1157

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

1158

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

1159

1160

<hr>

Joe Gregorio

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

[diff] [blame]

1161

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

Joe Gregorio

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

[diff] [blame]

1162

1163

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

1164

</dl>

1165

<dl><dt>__weakref__</dt>

1166

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

1167

</dl>

1168

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

1169

Joe Gregorio