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/apiary/apiclient/ext/appengine.py">/usr/local/google/home/jcgregorio/projects/apiary/apiclient/ext/appengine.py</a></td></tr></table>

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>

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

34

</dt><dd>

35

<dl>

36

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

37

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

46

47

48

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

49

storage and retreival of an

50

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

51

52

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

53

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

54

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

55

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

56

</dl>

57

<hr>

58

Methods defined here:

59

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

60

61

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

62

63

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

64

65

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

66

67

<hr>

68

Data and other attributes defined here:

69

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

70

71

<hr>

72

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

73

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

74

75

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

76

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

77

78

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

79

80

Args:

81

verbose_name: User friendly name of property.

82

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

83

as it is assigned in the Model sub-class.

84

default: Default value for property if none is assigned.

85

required: Whether property is required.

86

validator: User provided method used for validation.

87

choices: User provided set of valid property values.

88

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

89

90

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

91

92

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.

97

property_name: Name of property within Model instance to store property

98

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

99

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

100

101

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

102

103

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

104

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

105

106

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

107

108

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

109

110

Returns:

111

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

112

113

<hr>

114

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

115

116

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

117

</dl>

118

<dl><dt>__weakref__</dt>

119

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

120

</dl>

121

<hr>

122

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

123

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

130

131

132

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

133

storage and retrieval of

134

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

135

136

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

137

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

138

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

139

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

140

</dl>

141

<hr>

142

Methods defined here:

143

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

144

145

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

146

147

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

148

149

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

150

151

<hr>

152

Data and other attributes defined here:

153

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

154

155

<hr>

156

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

157

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

158

159

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

160

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

161

162

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

163

164

Args:

165

verbose_name: User friendly name of property.

166

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

167

as it is assigned in the Model sub-class.

168

default: Default value for property if none is assigned.

169

required: Whether property is required.

170

validator: User provided method used for validation.

171

choices: User provided set of valid property values.

172

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

173

174

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

175

176

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.

181

property_name: Name of property within Model instance to store property

182

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

183

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

184

185

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

186

187

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

188

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

189

190

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

191

192

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

193

194

Returns:

195

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

196

197

<hr>

198