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

30dfdc3

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

[diff] [blame]

12

<tt>Model objects for requests and responses

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>

39

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

</dt></dl>

</dd>

</dl>

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

48

49

50

<td colspan=2><tt>Model class for JSON.

51

52

Serializes and de-serializes between JSON and the Python

53

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

54

55

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

56

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

57

58

Args:

59

headers: dict, request headers

60

path_params: dict, parameters that appear in the request path

61

query_params: dict, parameters that appear in the query

62

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

63

serializable by simplejson.

64

Returns:

65

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

66

67

headers: dict, request headers

68

path_params: dict, parameters that appear in the request path

69

query: string, query part of the request URI

70

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

71

72

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

73

74

Args:

75

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

76

content: string, the body of the HTTP response

77

78

Returns:

79

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