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

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

Joe Gregorio

20a5aa9

2011-04-01 17:44:25 -0400

[diff] [blame]

26

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

27

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

Joe Gregorio

6e53703

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

[diff] [blame]

28

Joe Gregorio

30dfdc3

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

[diff] [blame]

29

30

31

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

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

36

</dt><dd>

37

<dl>

Joe Gregorio

20a5aa9

2011-04-01 17:44:25 -0400

[diff] [blame]

38

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

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

48

49

50

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

51

52

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

Joe Gregorio

abda96f

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

[diff] [blame]

53

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

54

55

Args:

56

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]

57

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

58

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

59

on an error.

Joe Gregorio

30dfdc3

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

[diff] [blame]

60

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

61

method: string, the HTTP method to use

62

body: string, the request body of the HTTP request

63

headers: dict, the HTTP request headers

Joe Gregorio

30dfdc3

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

[diff] [blame]

64

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

65

66

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

67

68

Args:

69

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

70

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

71

72

Returns:

73

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.

78

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

79

80

<hr>

81

Data descriptors defined here:

82

83

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

84

</dl>

85

<dl><dt>__weakref__</dt>

86

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

93

94

95

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

96

97

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

98

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

99

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

100

which case a 200 OK response will be generated.

101

102

Example:

103

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

104

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

105

{

106

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

107

}

108

)

109

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

110

111

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

112

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

113

is taken from the rpcName in the discovery document.

114

115

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

116

117

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

Joe Gregorio

abda96f

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

[diff] [blame]

118

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

119

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

120

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

121

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

122

123

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

124

125