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

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

Joe Gregorio

30dfdc3

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

[diff] [blame]

12

<tt>Classes to encapsulate a single HTTP request.

13

14

The classes implement a command pattern, with every

15

<a href="__builtin__.html#object">object</a> supporting an execute() method that does the

16

actuall HTTP request.</tt>

<big>Classes</big></td></tr>

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

26

</dt><dd>

27

<dl>

28

<dt><a href="apiclient.http.html#HttpRequest">HttpRequest</a>

29

</dt><dt><a href="apiclient.http.html#RequestMockBuilder">RequestMockBuilder</a>

</dt></dl>

</dd>

</dl>

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

38

39

40

<td colspan=2><tt>Encapsulates a single HTTP request.  </tt></td></tr>

41

42

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

43

<dl><dt><a name="HttpRequest-__init__">__init__</a>(self, http, uri, method='GET', body=None, headers=None, postproc=None, methodId=None)</dt><dd><tt>Constructor for an <a href="#HttpRequest">HttpRequest</a>.

44

45

Only http and uri are required.

46

47

Args:

48

http: httplib2.Http, the transport <a href="__builtin__.html#object">object</a> to use to make a request

49

uri: string, the absolute URI to send the request to

50

method: string, the HTTP method to use

51

body: string, the request body of the HTTP request

52

headers: dict, the HTTP request headers

53

postproc: callable, called on the HTTP response and content to transform

54

it into a data <a href="__builtin__.html#object">object</a> before returning, or raising an exception

55

on an error.

56

methodId: string, a unique identifier for the API method being called.</tt></dd></dl>

57

58

<dl><dt><a name="HttpRequest-execute">execute</a>(self, http=None)</dt><dd><tt>Execute the request.

59

60

Args:

61

http: httplib2.Http, an http <a href="__builtin__.html#object">object</a> to be used in place of the

62

one the <a href="#HttpRequest">HttpRequest</a> request <a href="__builtin__.html#object">object</a> was constructed with.

63

64

Returns:

65

A deserialized <a href="__builtin__.html#object">object</a> model of the response body as determined

by the postproc.

Raises:

apiclient.errors.HttpError if the response was not a 2xx.

70

httplib2.Error if a transport error has occured.</tt></dd></dl>

71

72

<hr>

73

Data descriptors defined here:

74

75

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

76

</dl>

77

<dl><dt>__weakref__</dt>

78

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

</dl>

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

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

85

86

87

<td colspan=2><tt>A simple mock of <a href="#HttpRequest">HttpRequest</a>

88

89

Pass in a dictionary to the constructor that maps request methodIds to

90

tuples of (httplib2.Response, content) that should be returned when that

91

method is called. None may also be passed in for the httplib2.Response, in

92

which case a 200 OK response will be generated.

93

94

Example:

95

response = '{"data": {"id": "tag:google.c...'

96

requestBuilder = <a href="#RequestMockBuilder">RequestMockBuilder</a>(

97

{

98

'chili.activities.get': (None, response),

99

}

100

)

101

apiclient.discovery.build("buzz", "v1", requestBuilder=requestBuilder)

102

103

Methods that you do not supply a response for will return a

104

200 OK with an empty string as the response content. The methodId

105

is taken from the rpcName in the discovery document.

106

107

For more details see the project wiki.  </tt></td></tr>

108

109

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

110

<dl><dt><a name="RequestMockBuilder-__call__">__call__</a>(self, http, uri, method='GET', body=None, headers=None, postproc=None, methodId=None)</dt><dd><tt>Implements the callable interface that discovery.build() expects

111

of requestBuilder, which is to build an <a href="__builtin__.html#object">object</a> compatible with

112

<a href="#HttpRequest">HttpRequest</a>.execute(). See that method for the description of the

113

parameters and the expected response.</tt></dd></dl>

114

115

<dl><dt><a name="RequestMockBuilder-__init__">__init__</a>(self, responses)</dt><dd><tt>Constructor for <a href="#RequestMockBuilder">RequestMockBuilder</a>

116

117