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

><a href=".">index</a> <a href="file:/usr/local/google/home/jcgregorio/projects/apiclient/apiclient/ext/appengine.py">/usr/local/google/home/jcgregorio/projects/apiclient/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

119

<hr>

120

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

121

122

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

123

</dl>

124

<dl><dt>__weakref__</dt>

125

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

126

</dl>

127

<hr>

128

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

129

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

136

137

138

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

139

storage and retrieval of

140

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

141

142

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

143

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

144

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

145

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

146

</dl>

147

<hr>

148

Methods defined here:

149

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

150

151

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

152

153

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

154

155

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

156

157

<hr>

158

Data and other attributes defined here:

Joe Gregorio

6e53703

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

[diff] [blame]

159

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

160

161

<hr>

162

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

163

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

164

165

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

166

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

167

168

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

169

170

Args:

171

verbose_name: User friendly name of property.

172

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

173

as it is assigned in the Model sub-class.

174

default: Default value for property if none is assigned.

175

required: Whether property is required.

176

validator: User provided method used for validation.

177

choices: User provided set of valid property values.

178

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

179

180

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

181

182

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.

187

property_name: Name of property within Model instance to store property

188

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

189

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

190

191

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

192

193

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

194

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

195

196

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

197

198

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

199

200

Returns:

201

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

202

203

<hr>

204

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

205

206

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

207

</dl>

208

<dl><dt>__weakref__</dt>

209

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

210

</dl>

211

<hr>

212

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

213

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

214

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>

220

221

222

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

223

the App Engine datastore.

224

225

This Storage helper presumes the Credentials

226

have been stored as a CredenialsProperty

227

on a datastore model class, and that entities

228

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

229

230

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

231

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

232

233

Args:

234

model: db.Model, model class

235

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

236

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

237

238

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

239

240

Returns:

241

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

242

243

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

244

245

Args:

246

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

247

248

<hr>

249

Data descriptors defined here:

250

251

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

252

</dl>

253

<dl><dt>__weakref__</dt>

254

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

255

</dl>

Joe Gregorio

30dfdc3

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

[diff] [blame]

256

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

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

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

268

269

270

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

271

</body></html>