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

><a href=".">index</a> <a href="file:/home/jcgregorio/projects/apiary/apiclient/http.py">/home/jcgregorio/projects/apiary/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>

17

18

Joe Gregorio

6e53703

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

[diff] [blame]

19

20

21

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

22

23

24

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

Joe Gregorio

cb8103d

2011-02-11 23:20:52 -0500

[diff] [blame^]

25

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

26

</td><td width="25%" valign=top></td><td width="25%" valign=top></td></tr></table></td></tr></table>

Joe Gregorio

6e53703

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

[diff] [blame]

27

Joe Gregorio

30dfdc3

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

[diff] [blame]

28

29

30

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

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

35

</dt><dd>

36

<dl>

Joe Gregorio

cb8103d

2011-02-11 23:20:52 -0500

[diff] [blame^]

37

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

38

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

Joe Gregorio

30dfdc3

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

[diff] [blame]

39

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

</dt></dl>

</dd>

</dl>

Joe Gregorio

2011-02-11 23:20:52 -0500

[diff] [blame^]

47

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

48

49

50

<td colspan=2><tt>Mock of httplib2.Http  </tt></td></tr>

51

52

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

53

<dl><dt><a name="HttpMock-__init__">__init__</a>(self, filename, headers)</dt><dd><tt>Args:

54

filename: string, absolute filename to read response from

55

headers: dict, header to return with response</tt></dd></dl>

56

57

<dl><dt><a name="HttpMock-request">request</a>(self, uri, method='GET', body=None, headers=None, redirections=1, connection_type=None)</dt></dl>

58

59

<hr>

60

Data descriptors defined here:

61

62

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

63

</dl>

64

<dl><dt>__weakref__</dt>

65

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

</dl>

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

Joe Gregorio

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

[diff] [blame]

71

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

72

73

74

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

75

76

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

Joe Gregorio

abda96f

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

[diff] [blame]

77

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

Joe Gregorio

30dfdc3

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

[diff] [blame]

78

79

Args:

80

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

Joe Gregorio

abda96f

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

[diff] [blame]

81

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

82

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

83

on an error.

Joe Gregorio

30dfdc3

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

[diff] [blame]

84

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

85

method: string, the HTTP method to use

86

body: string, the request body of the HTTP request

87

headers: dict, the HTTP request headers

Joe Gregorio

30dfdc3

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

[diff] [blame]

88

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

89

90

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

91

92

Args:

93

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

94

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

95

96

Returns:

97

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.

102

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

103

104

<hr>

105

Data descriptors defined here:

106

107

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

108

</dl>

109

<dl><dt>__weakref__</dt>

110

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

117

118

119

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

120

121

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

122

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

123

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

124

which case a 200 OK response will be generated.

125

126

Example:

127

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

128

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

129

{

130

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

131

}

132

)

133

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

134

135

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

136

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

137

is taken from the rpcName in the discovery document.

138

139

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

140

141

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

Joe Gregorio

abda96f

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

[diff] [blame]

142

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

Joe Gregorio

30dfdc3

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

[diff] [blame]

143

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

144

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

145

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

146

147

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

148

149