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-release/apiclient/http.py">/usr/local/google/home/jcgregorio/projects/apiclient-release/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

Joe Gregorio

b417caf

2011-12-08 12:04:24 -0500

[diff] [blame]

24

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

Joe Gregorio

3d55ac5

2012-02-21 10:11:19 -0500

[diff] [blame^]

25

Joe Gregorio

b417caf

2011-12-08 12:04:24 -0500

[diff] [blame]

26

Joe Gregorio

3d55ac5

2012-02-21 10:11:19 -0500

[diff] [blame^]

27

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

28

<a href="httplib2.html">httplib2</a>

Joe Gregorio

b417caf

2011-12-08 12:04:24 -0500

[diff] [blame]

29

<a href="apiclient.mimeparse.html">apiclient.mimeparse</a>

Joe Gregorio

3d55ac5

2012-02-21 10:11:19 -0500

[diff] [blame^]

30

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

31

32

33

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

34

<a href="urlparse.html">urlparse</a>

Joe Gregorio

b417caf

2011-12-08 12:04:24 -0500

[diff] [blame]

35

36

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

Joe Gregorio

6e53703

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

[diff] [blame]

37

Joe Gregorio

30dfdc3

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

[diff] [blame]

38

39

40

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

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

45

</dt><dd>

46

<dl>

Joe Gregorio

20a5aa9

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

[diff] [blame]

47

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

Joe Gregorio

30dfdc3

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

[diff] [blame]

48

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

57

58

59

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

60

61

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

Joe Gregorio

b417caf

2011-12-08 12:04:24 -0500

[diff] [blame]

62

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

Joe Gregorio

30dfdc3

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

[diff] [blame]

63

64

Args:

65

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]

66

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

67

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

68

on an error.

Joe Gregorio

30dfdc3

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

[diff] [blame]

69

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

70

method: string, the HTTP method to use

Joe Gregorio

b417caf

2011-12-08 12:04:24 -0500

[diff] [blame]

71

body: string, the request body of the HTTP request,

Joe Gregorio

30dfdc3

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

[diff] [blame]

72

headers: dict, the HTTP request headers

Joe Gregorio

b417caf

2011-12-08 12:04:24 -0500

[diff] [blame]

73

methodId: string, a unique identifier for the API method being called.

74

resumable: MediaUpload, None if this is not a resumbale request.</tt></dd></dl>

Joe Gregorio

30dfdc3

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

[diff] [blame]

75

76

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

77

78

Args:

79

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

80

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

81

82

Returns:

83

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.

88

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

89

Joe Gregorio

b417caf

2011-12-08 12:04:24 -0500

[diff] [blame]

90

<dl><dt><a name="HttpRequest-next_chunk">next_chunk</a>(self, http=None)</dt><dd><tt>Execute the next step of a resumable upload.

91

92

Can only be used if the method being executed supports media uploads and

93

the MediaUpload <a href="__builtin__.html#object">object</a> passed in was flagged as using resumable upload.

Example:

media = MediaFileUpload('smiley.png', mimetype='image/png',

98

chunksize=1000, resumable=True)

99

request = service.objects().insert(

100

bucket=buckets['items'][0]['id'],

name='smiley.png',

media_body=media)

response = None

while response is None:

106

status, response = request.<a href="#HttpRequest-next_chunk">next_chunk</a>()

107

if status:

108

print "Upload %d%% complete." % int(status.progress() * 100)

Returns:

(status, body): (ResumableMediaStatus, <a href="__builtin__.html#object">object</a>)

113

The body will be None until the resumable media is fully uploaded.</tt></dd></dl>

114

115

<dl><dt><a name="HttpRequest-to_json">to_json</a>(self)</dt><dd><tt>Returns a JSON representation of the <a href="#HttpRequest">HttpRequest</a>.</tt></dd></dl>

116

117

<hr>

118

Static methods defined here:

119

<dl><dt><a name="HttpRequest-from_json">from_json</a>(s, http, postproc)</dt><dd><tt>Returns an <a href="#HttpRequest">HttpRequest</a> populated with info from a JSON <a href="__builtin__.html#object">object</a>.</tt></dd></dl>

120

Joe Gregorio

30dfdc3

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

[diff] [blame]

121

<hr>

122

Data descriptors defined here:

123

124

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

125

</dl>

126

<dl><dt>__weakref__</dt>

127

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

134

135

136

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

137

138

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

Joe Gregorio

a845167

2011-09-15 09:53:21 -0400

[diff] [blame]

139

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

140

returned when that method is called. None may also be passed in for the

141

httplib2.Response, in which case a 200 OK response will be generated.

142

If an opt_expected_body (str or dict) is provided, it will be compared to

143

the body and UnexpectedBodyError will be raised on inequality.

Joe Gregorio

30dfdc3

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

[diff] [blame]

144

145

Example:

146

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

147

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

148

{

Joe Gregorio

c4fc095

2011-11-09 12:21:11 -0500

[diff] [blame]

149

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

Joe Gregorio

30dfdc3

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

[diff] [blame]

150

}

151

)

Joe Gregorio

c4fc095

2011-11-09 12:21:11 -0500

[diff] [blame]

152

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

Joe Gregorio

30dfdc3

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

[diff] [blame]

153

154

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

Joe Gregorio

b417caf

2011-12-08 12:04:24 -0500

[diff] [blame]

155

200 OK with an empty string as the response content or raise an excpetion

156

if check_unexpected is set to True. The methodId is taken from the rpcName

Joe Gregorio

a845167

2011-09-15 09:53:21 -0400

[diff] [blame]

157

in the discovery document.

Joe Gregorio

30dfdc3

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

[diff] [blame]

158

159

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

160

161

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

Joe Gregorio

b417caf

2011-12-08 12:04:24 -0500

[diff] [blame]

162

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

Joe Gregorio

30dfdc3

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

[diff] [blame]

163

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

164

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

165

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

166

Joe Gregorio

a845167

2011-09-15 09:53:21 -0400

[diff] [blame]

167

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

Joe Gregorio

30dfdc3

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

[diff] [blame]

168

169