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

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

Joe Gregorio

3b79fa8

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

[diff] [blame]

12

<tt><a href="#Model">Model</a> objects for requests and responses.

Joe Gregorio

30dfdc3

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

[diff] [blame]

13

14

Each API may support one or more serializations, such

15

as JSON, Atom, etc. The model classes are responsible

16

for converting between the wire format and the Python

17

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

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

23

24

25

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

26

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

27

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

28

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

37

</dt><dd>

38

<dl>

Joe Gregorio

abda96f

2011-02-11 20:19:33 -0500

[diff] [blame]

39

<dt><a href="apiclient.model.html#Model">Model</a>

40

</dt><dd>

41

<dl>

Joe Gregorio

30dfdc3

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

[diff] [blame]

42

<dt><a href="apiclient.model.html#JsonModel">JsonModel</a>

43

</dt></dl>

44

</dd>

45

</dl>

Joe Gregorio

abda96f

2011-02-11 20:19:33 -0500

[diff] [blame]

46

</dd>

47

</dl>

Joe Gregorio

30dfdc3

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

[diff] [blame]

Joe Gregorio

2011-02-11 20:19:33 -0500

[diff] [blame]

52

<a name="JsonModel">class JsonModel</a>(<a href="apiclient.model.html#Model">Model</a>)</td></tr>

Joe Gregorio

30dfdc3

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

[diff] [blame]

53

54

Joe Gregorio

abda96f

2011-02-11 20:19:33 -0500

[diff] [blame]

55

<td colspan=2><tt><a href="#Model">Model</a> class for JSON.

Joe Gregorio

30dfdc3

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

[diff] [blame]

56

57

Serializes and de-serializes between JSON and the Python

58

<a href="__builtin__.html#object">object</a> representation of HTTP request and response bodies.  </tt></td></tr>

59

Joe Gregorio

abda96f

2011-02-11 20:19:33 -0500

[diff] [blame]

60

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

61

<dd><a href="apiclient.model.html#JsonModel">JsonModel</a></dd>

62

<dd><a href="apiclient.model.html#Model">Model</a></dd>

63

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

64

</dl>

65

<hr>

66

Methods defined here:

Joe Gregorio

ad258e2

2011-02-22 22:53:30 -0500

[diff] [blame^]

67

<dl><dt><a name="JsonModel-__init__">__init__</a>(self, data_wrapper)</dt><dd><tt>Construct a <a href="#JsonModel">JsonModel</a>

68

69

Args:

70

data_wrapper: boolean, wrap requests and responses in a data wrapper</tt></dd></dl>

71

Joe Gregorio

30dfdc3

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

[diff] [blame]

72

<dl><dt><a name="JsonModel-request">request</a>(self, headers, path_params, query_params, body_value)</dt><dd><tt>Updates outgoing requests with JSON bodies.

73

74

Args:

75

headers: dict, request headers

76

path_params: dict, parameters that appear in the request path

77

query_params: dict, parameters that appear in the query

78

body_value: <a href="__builtin__.html#object">object</a>, the request body as a Python <a href="__builtin__.html#object">object</a>, which must be

79

serializable by simplejson.

80

Returns:

81

A tuple of (headers, path_params, query, body)

82

83

headers: dict, request headers

84

path_params: dict, parameters that appear in the request path

85

query: string, query part of the request URI

86

body: string, the body serialized as JSON</tt></dd></dl>

87

88

<dl><dt><a name="JsonModel-response">response</a>(self, resp, content)</dt><dd><tt>Convert the response wire format into a Python <a href="__builtin__.html#object">object</a>.

89

90

Args:

91

resp: httplib2.Response, the HTTP response headers and status

92

content: string, the body of the HTTP response

93

94

Returns:

95

The body de-serialized as a Python <a href="__builtin__.html#object">object</a>.

96

97

Raises:

98

apiclient.errors.HttpError if a non 2xx response is received.</tt></dd></dl>

99

100

<hr>

Joe Gregorio

abda96f

2011-02-11 20:19:33 -0500

[diff] [blame]

101

Data descriptors inherited from <a href="apiclient.model.html#Model">Model</a>:

102

103

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

104

</dl>

105

<dl><dt>__weakref__</dt>

106

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

</dl>

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

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

113

114

115

<td colspan=2><tt><a href="#Model">Model</a> base class.

116

117

All <a href="#Model">Model</a> classes should implement this interface.

118

The <a href="#Model">Model</a> serializes and de-serializes between a wire

119

format such as JSON and a Python <a href="__builtin__.html#object">object</a> representation.  </tt></td></tr>

120

121

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

122

<dl><dt><a name="Model-request">request</a>(self, headers, path_params, query_params, body_value)</dt><dd><tt>Updates outgoing requests with a deserialized body.

123

124

Args:

125

headers: dict, request headers

126

path_params: dict, parameters that appear in the request path

127

query_params: dict, parameters that appear in the query

128

body_value: <a href="__builtin__.html#object">object</a>, the request body as a Python <a href="__builtin__.html#object">object</a>, which must be

129

serializable.

130

Returns:

131

A tuple of (headers, path_params, query, body)

132

133

headers: dict, request headers

134

path_params: dict, parameters that appear in the request path

135

query: string, query part of the request URI

136

body: string, the body serialized in the desired wire format.</tt></dd></dl>

137

138

<dl><dt><a name="Model-response">response</a>(self, resp, content)</dt><dd><tt>Convert the response wire format into a Python <a href="__builtin__.html#object">object</a>.

139

140

Args:

141

resp: httplib2.Response, the HTTP response headers and status

142

content: string, the body of the HTTP response

143

144

Returns:

145

The body de-serialized as a Python <a href="__builtin__.html#object">object</a>.