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

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

Joe Gregorio

6e53703

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

[diff] [blame]

12

<tt>Utilities for Google App Engine

13

Joe Gregorio

3b79fa8

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

6e53703

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

[diff] [blame]

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

20

21

22

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

23

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

24

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

32

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

33

</dt><dd>

34

<dl>

35

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

36

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

37

</dt></dl>

38

</dd>

Joe Gregorio

3b79fa8

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

[diff] [blame^]

39

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

40

</dt><dd>

41

<dl>

42

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

43

</dt></dl>

44

</dd>

Joe Gregorio

6e53703

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

[diff] [blame]

</dl>

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

51

52

Joe Gregorio

3b79fa8

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

[diff] [blame^]

53

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

54

55

Utility property that allows easy storage and retrieval of

Joe Gregorio

6e53703

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

[diff] [blame]

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.

Joe Gregorio

3b79fa8

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

[diff] [blame^]

91

name: <a href="oauth2client.client.html#Storage">Storage</a> name for property.  By default, uses attribute name

Joe Gregorio

6e53703

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

[diff] [blame]

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

Joe Gregorio

3b79fa8

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

[diff] [blame^]

141

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

142

143

Utility property that allows easy storage and retreival of an

Joe Gregorio

6e53703

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

[diff] [blame]

144

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

145

146

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

147

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

148

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

149

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

150

</dl>

151

<hr>

152

Methods defined here:

153

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

154

155

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

156

157

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

158

159

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

160

161

<hr>

162

Data and other attributes defined here:

163

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

164

165

<hr>

166

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

167

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

168

169

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

170

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

171

172

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

173

174

Args:

175

verbose_name: User friendly name of property.

Joe Gregorio

3b79fa8

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

[diff] [blame^]

176

name: <a href="oauth2client.client.html#Storage">Storage</a> name for property.  By default, uses attribute name

Joe Gregorio

6e53703

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

[diff] [blame]

177

as it is assigned in the Model sub-class.

178

default: Default value for property if none is assigned.

179

required: Whether property is required.

180

validator: User provided method used for validation.

181

choices: User provided set of valid property values.

182

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

183

184

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

185

186

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.

191

property_name: Name of property within Model instance to store property

192

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

193

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

194

195

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

196

197

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

198

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

199

200

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

201

202

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

203

204

Returns:

205

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

206

207

<hr>

208

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

209

210

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

211

</dl>

212

<dl><dt>__weakref__</dt>

213

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

214

</dl>

215

<hr>

216

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

217

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

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

Joe Gregorio

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

[diff] [blame^]

223

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

Joe Gregorio

6e53703

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

[diff] [blame]

224

225

226

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

227

the App Engine datastore.

228

Joe Gregorio

3b79fa8

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

[diff] [blame^]

229

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

Joe Gregorio

6e53703

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

[diff] [blame]

230

have been stored as a CredenialsProperty

231

on a datastore model class, and that entities

232

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

233

Joe Gregorio

3b79fa8

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

[diff] [blame^]

234

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

235

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

236

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

237

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

238

</dl>

239

<hr>

240

Methods defined here:

241

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

Joe Gregorio

6e53703

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

[diff] [blame]

242

243

Args:

244

model: db.Model, model class

245

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

246