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

><a href=".">index</a> <a href="file:/home/jcgregorio/projects/apiary/oauth2client/appengine.py">/home/jcgregorio/projects/apiary/oauth2client/appengine.py</a></td></tr></table>

12

<tt>Utilities for Google App Engine

13

14

Utilities for making it easier to use OAuth 2.0

15

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>

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

34

</dt><dd>

35

<dl>

36

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

37

</dt></dl>

38

</dd>

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="oauth2client.appengine.html#CredentialsProperty">CredentialsProperty</a>

43

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

</dt></dl>

</dd>

</dl>

<a name="CredentialsProperty">class CredentialsProperty</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 retrieval of

56

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

57

58

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

59

<dd><a href="oauth2client.appengine.html#CredentialsProperty">CredentialsProperty</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="CredentialsProperty-empty">empty</a>(self, value)</dt></dl>

66

67

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

68

69

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

70

71

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

72

73

<hr>

74

Data and other attributes defined here:

75

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

76

77

Subclasses must define an authorize() method

78

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

79

80

<hr>

81

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

82

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

83

84

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

85

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

86

87

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

88

89

Args:

90

verbose_name: User friendly name of property.

91

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

92

as it is assigned in the Model sub-class.

93

default: Default value for property if none is assigned.

94

required: Whether property is required.

95

validator: User provided method used for validation.

96

choices: User provided set of valid property values.

97

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

98

99

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

100

101

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.

106

property_name: Name of property within Model instance to store property

107

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

108

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

109

110

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

111

112

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

113

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

114

115

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

116

117

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

118

119

Returns:

120

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

121

122

<hr>

123

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

124

125

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

126

</dl>

127

<dl><dt>__weakref__</dt>

128

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

129

</dl>

130

<hr>

131

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

132

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

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

139

140

141

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

142

storage and retreival of an

143

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

144

145

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

146

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

147

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

148

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

149

</dl>

150

<hr>

151

Methods defined here:

152

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

153

154

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

155

156

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

157

158

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

159

160

<hr>

161

Data and other attributes defined here:

162

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

163

164

<hr>

165

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

166

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

167

168

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

169

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

170

171

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

172

173

Args:

174

verbose_name: User friendly name of property.

175

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

176

as it is assigned in the Model sub-class.

177

default: Default value for property if none is assigned.

178

required: Whether property is required.

179

validator: User provided method used for validation.

180

choices: User provided set of valid property values.

181

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

182

183

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

184

185

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.

190

property_name: Name of property within Model instance to store property

191

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

192

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

193

194

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

195

196

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

197

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

198

199

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

200

201

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

202

203

Returns:

204

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

205

206

<hr>

207

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

208

209

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

210

</dl>

211

<dl><dt>__weakref__</dt>

212

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

213

</dl>

214

<hr>

215

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

216

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

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

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

223

224

225

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

226

the App Engine datastore.

227

228

This Storage helper presumes the Credentials

229

have been stored as a CredenialsProperty

230

on a datastore model class, and that entities

231

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

232

233

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

234

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

235

236

Args:

237

model: db.Model, model class

238

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

239

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

240

241

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

242

243

Returns:

244

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

245

246

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

247

248

Args:

249

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

250

251

<hr>

252

Data descriptors defined here:

253

254

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

255

</dl>

256

<dl><dt>__weakref__</dt>

257

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

258

</dl>

259

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

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

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

271

272

273

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

274

</body></html>