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

><a href=".">index</a> <a href="file:/home/jcgregorio/projects/apiclient-release/apiclient/ext/appengine.py">/home/jcgregorio/projects/apiclient-release/apiclient/ext/appengine.py</a></td></tr></table>

Joe Gregorio

30dfdc3

2010-12-09 16:34:22 -0500

[diff] [blame]

12

<tt>Utilities for Google App Engine

13

14

Utilities for making it easier to use the

15

Google API Client for Python on Google App Engine.</tt>

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

21

22

23

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

24

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

25

</td><td width="25%" valign=top></td><td width="25%" valign=top></td></tr></table></td></tr></table>

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

Joe Gregorio

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

[diff] [blame]

33

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

34

</dt><dd>

35

<dl>

36

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

37

</dt></dl>

38

</dd>

Joe Gregorio

30dfdc3

2010-12-09 16:34:22 -0500

[diff] [blame]

39

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

40

</dt><dd>

41

<dl>

42

<dt><a href="apiclient.ext.appengine.html#FlowThreeLeggedProperty">FlowThreeLeggedProperty</a>

43

</dt><dt><a href="apiclient.ext.appengine.html#OAuthCredentialsProperty">OAuthCredentialsProperty</a>

</dt></dl>

</dd>

</dl>

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

52

53

54

<td colspan=2><tt>Utility property that allows easy

55

storage and retreival of an

56

apiclient.oauth.FlowThreeLegged  </tt></td></tr>

57

58

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

59

<dd><a href="apiclient.ext.appengine.html#FlowThreeLeggedProperty">FlowThreeLeggedProperty</a></dd>

60

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

61

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

62

</dl>

63

<hr>

64

Methods defined here:

65

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

66

67

<dl><dt><a name="FlowThreeLeggedProperty-get_value_for_datastore">get_value_for_datastore</a>(self, model_instance)</dt><dd><tt># For writing to datastore.</tt></dd></dl>

68

69

<dl><dt><a name="FlowThreeLeggedProperty-make_value_from_datastore">make_value_from_datastore</a>(self, value)</dt><dd><tt># For reading from datastore.</tt></dd></dl>

70

71

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

72

73

<hr>

74

Data and other attributes defined here:

75

<dl><dt>data_type = <class 'apiclient.oauth.FlowThreeLegged'><dd><tt>Does the Three Legged Dance for OAuth 1.0a.</tt></dl>

76

77

<hr>

78

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

79

<dl><dt><a name="FlowThreeLeggedProperty-__get__">__get__</a>(self, model_instance, model_class)</dt><dd><tt>Returns the value for this property on the given model instance.

80

81

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

82

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

83

84

<dl><dt><a name="FlowThreeLeggedProperty-__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.

85

86

Args:

87

verbose_name: User friendly name of property.

88

name: Storage name for property.  By default, uses attribute name

89

as it is assigned in the Model sub-class.

90

default: Default value for property if none is assigned.

91

required: Whether property is required.

92

validator: User provided method used for validation.

93

choices: User provided set of valid property values.

94

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

95

96

<dl><dt><a name="FlowThreeLeggedProperty-__property_config__">__property_config__</a>(self, model_class, property_name)</dt><dd><tt>Configure property, connecting it to its model.

97

98

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

it belongs to.

Args:

model_class: Model class which <a href="google.appengine.ext.db.html#Property">Property</a> will belong to.

103

property_name: Name of property within Model instance to store property

104

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

105

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

106

107

<dl><dt><a name="FlowThreeLeggedProperty-__set__">__set__</a>(self, model_instance, value)</dt><dd><tt>Sets the value for this property on the given model instance.

108

109

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

110

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

111

112

<dl><dt><a name="FlowThreeLeggedProperty-datastore_type">datastore_type</a>(self)</dt><dd><tt>Deprecated backwards-compatible accessor method for self.data_type.</tt></dd></dl>

113

114

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

115

116

Returns:

117

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

118

Joe Gregorio

2401bd6

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

[diff] [blame]

119

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

120

121

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

122

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

123

properties. For all other properties, this call must return

124

AUTO_UPDATE_UNCHANGED.

125

126

Args:

127

model_instance: Instance to get new value for.

128

129

Returns:

130

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

131

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

132

Joe Gregorio

30dfdc3

2010-12-09 16:34:22 -0500

[diff] [blame]

133

<hr>

134

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

135

136

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

137

</dl>

138

<dl><dt>__weakref__</dt>

139

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

140

</dl>

141

<hr>

142

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

143

<dl><dt>creation_counter = 0</dl>

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

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

150

151

152

<td colspan=2><tt>Utility property that allows easy

153

storage and retrieval of

154

apiclient.oath.OAuthCredentials  </tt></td></tr>

155

156

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

157

<dd><a href="apiclient.ext.appengine.html#OAuthCredentialsProperty">OAuthCredentialsProperty</a></dd>

158

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

159

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

160

</dl>

161

<hr>

162

Methods defined here:

163

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

164

165

<dl><dt><a name="OAuthCredentialsProperty-get_value_for_datastore">get_value_for_datastore</a>(self, model_instance)</dt><dd><tt># For writing to datastore.</tt></dd></dl>

166

167

<dl><dt><a name="OAuthCredentialsProperty-make_value_from_datastore">make_value_from_datastore</a>(self, value)</dt><dd><tt># For reading from datastore.</tt></dd></dl>

168

169

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

170

171

<hr>

172

Data and other attributes defined here:

Joe Gregorio

6e53703

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

[diff] [blame]

173

<dl><dt>data_type = <class 'apiclient.oauth.OAuthCredentials'><dd><tt>Credentials <a href="__builtin__.html#object">object</a> for OAuth 1.0a</tt></dl>

Joe Gregorio

30dfdc3

2010-12-09 16:34:22 -0500

[diff] [blame]

174

175

<hr>

176

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

177

<dl><dt><a name="OAuthCredentialsProperty-__get__">__get__</a>(self, model_instance, model_class)</dt><dd><tt>Returns the value for this property on the given model instance.

178

179

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

180

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

181

182

<dl><dt><a name="OAuthCredentialsProperty-__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.

183

184

Args:

185

verbose_name: User friendly name of property.

186

name: Storage name for property.  By default, uses attribute name

187

as it is assigned in the Model sub-class.

188

default: Default value for property if none is assigned.

189

required: Whether property is required.

190

validator: User provided method used for validation.

191

choices: User provided set of valid property values.

192

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

193

194

<dl><dt><a name="OAuthCredentialsProperty-__property_config__">__property_config__</a>(self, model_class, property_name)</dt><dd><tt>Configure property, connecting it to its model.

195

196

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

it belongs to.

Args:

model_class: Model class which <a href="google.appengine.ext.db.html#Property">Property</a> will belong to.

201

property_name: Name of property within Model instance to store property

202

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

203

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

204

205

<dl><dt><a name="OAuthCredentialsProperty-__set__">__set__</a>(self, model_instance, value)</dt><dd><tt>Sets the value for this property on the given model instance.

206

207

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

208

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

209

210

<dl><dt><a name="OAuthCredentialsProperty-datastore_type">datastore_type</a>(self)</dt><dd><tt>Deprecated backwards-compatible accessor method for self.data_type.</tt></dd></dl>

211

212

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

213

214

Returns:

215

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

216

Joe Gregorio

2401bd6

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

[diff] [blame]

217

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

218

219

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

220

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

221

properties. For all other properties, this call must return

222

AUTO_UPDATE_UNCHANGED.

223

224

Args:

225

model_instance: Instance to get new value for.

226

227

Returns:

228

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

229

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

230

Joe Gregorio

30dfdc3

2010-12-09 16:34:22 -0500

[diff] [blame]

231

<hr>

232

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

233

234

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

235

</dl>

236

<dl><dt>__weakref__</dt>

237

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

238

</dl>

239

<hr>

240

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

241

<dl><dt>creation_counter = 0</dl>

242

Joe Gregorio

6e53703

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

[diff] [blame]

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

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

248

249

250

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

251

the App Engine datastore.

252

253

This Storage helper presumes the Credentials

254

have been stored as a CredenialsProperty

255

on a datastore model class, and that entities

256

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

257

258

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

259

<dl><dt><a name="StorageByKeyName-__init__">__init__</a>(self, model, key_name, property_name)</dt><dd><tt>Constructor for Storage.

260

261

Args:

262

model: db.Model, model class

263

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

264

property_name: string, name of the property that is a CredentialsProperty</tt></dd></dl>

265

266

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

267

268

Returns:

269

Credentials</tt></dd></dl>

270

271

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

272

273

Args:

274

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

275

276

<hr>

277

Data descriptors defined here:

278

279

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

280

</dl>

281

<dl><dt>__weakref__</dt>

282

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

283

</dl>

Joe Gregorio

30dfdc3

2010-12-09 16:34:22 -0500

[diff] [blame]

284

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

<td width="100%">__author__ = 'jcgregorio@google.com (Joe Gregorio)'</td></tr></table>

<big>Author</big></td></tr>

296

297

298

<td width="100%">jcgregorio@google.com (Joe Gregorio)</td></tr></table>

299

</body></html>