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

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

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

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

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

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

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

2012-04-13 07:58:30 -0400

[diff] [blame^]

47

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

48

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

49

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

50

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

51

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

52

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

53

</dt><dd>

54

<dl>

55

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

56

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

57

</dt></dl>

58

</dd>

59

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

Joe Gregorio

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

[diff] [blame]

60

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

</dt></dl>

</dd>

</dl>

Joe Gregorio

2012-04-13 07:58:30 -0400

[diff] [blame^]

68

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

69

70

71

<td colspan=2><tt>Batches multiple <a href="#HttpRequest">HttpRequest</a> objects into a single HTTP request.  </tt></td></tr>

72

73

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

74

<dl><dt><a name="BatchHttpRequest-__init__">__init__</a>(self, callback=None, batch_uri=None)</dt><dd><tt>Constructor for a <a href="#BatchHttpRequest">BatchHttpRequest</a>.

75

76

Args:

77

callback: callable, A callback to be called for each response, of the

78

form callback(id, response). The first parameter is the request id, and

79

the second is the deserialized response <a href="__builtin__.html#object">object</a>.

80

batch_uri: string, URI to send batch requests to.</tt></dd></dl>

81

82

<dl><dt><a name="BatchHttpRequest-add">add</a>(self, request, callback=None, request_id=None)</dt><dd><tt>Add a new request.

83

84

Every callback added will be paired with a unique id, the request_id. That

85

unique id will be passed back to the callback when the response comes back

86

from the server. The default behavior is to have the library generate it's

87

own unique id. If the caller passes in a request_id then they must ensure

88

uniqueness for each request_id, and if they are not an exception is

89

raised. Callers should either supply all request_ids or nevery supply a

90

request id, to avoid such an error.

91

92

Args:

93

request: <a href="#HttpRequest">HttpRequest</a>, Request to add to the batch.

94

callback: callable, A callback to be called for this response, of the

95

form callback(id, response). The first parameter is the request id, and

96

the second is the deserialized response <a href="__builtin__.html#object">object</a>.

97

request_id: string, A unique id for the request. The id will be passed to

98

the callback with the response.

Returns:

None

Raises:

BatchError if a resumable request is added to a batch.

105

KeyError is the request_id is not unique.</tt></dd></dl>

106

107

<dl><dt><a name="BatchHttpRequest-execute">execute</a>(self, http=None)</dt><dd><tt>Execute all the requests as a single batched HTTP request.

108

109

Args:

110

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

111

<a href="#HttpRequest">HttpRequest</a> request <a href="__builtin__.html#object">object</a> was constructed with.  If one isn't supplied

112

then use a http <a href="__builtin__.html#object">object</a> from the requests in this batch.

Returns:

None

Raises:

httplib2.Error if a transport error has occured.

119

apiclient.errors.BatchError if the response is the wrong format.</tt></dd></dl>

120

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="HttpMock">class HttpMock</a>(<a href="__builtin__.html#object">__builtin__.object</a>)</td></tr>

134

135

136

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

137

138

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

139

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

140

filename: string, absolute filename to read response from

141

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

142

143

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

144

145

<hr>

146

Data descriptors defined here:

147

148

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

149

</dl>

150

<dl><dt>__weakref__</dt>

151

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

</dl>

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

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

158

159

160

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

161

162

Mocks a sequence of calls to request returning different responses for each

163

call. Create an instance initialized with the desired response headers

164

and content and then use as if an httplib2.Http instance.

165

166

http = <a href="#HttpMockSequence">HttpMockSequence</a>([

167

({'status': '401'}, ''),

168

({'status': '200'}, '{"access_token":"1/3w","expires_in":3600}'),

169

({'status': '200'}, 'echo_request_headers'),

170

])

171

resp, content = http.<a href="#HttpMockSequence-request">request</a>("<a href="http://examples.com">http://examples.com</a>")

172

173

There are special values you can pass in for content to trigger

174

behavours that are helpful in testing.

175

176

'echo_request_headers' means return the request headers in the response body

177

'echo_request_headers_as_json' means return the request headers in

178

the response body

179

'echo_request_body' means return the request body in the response body

180

'echo_request_uri' means return the request uri in the response body  </tt></td></tr>

181

182

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

183

<dl><dt><a name="HttpMockSequence-__init__">__init__</a>(self, iterable)</dt><dd><tt>Args:

184

iterable: iterable, a sequence of pairs of (headers, body)</tt></dd></dl>

185

186

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

187

188

<hr>

189

Data descriptors defined here:

190

191

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

192

</dl>

193

<dl><dt>__weakref__</dt>

194

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

200

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

201

202

203

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

204

205

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

Joe Gregorio

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

[diff] [blame]

206

<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

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

[diff] [blame]

207

208

Args:

209

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]

210

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

211

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

212

on an error.

Joe Gregorio

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

[diff] [blame]

213

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

214

method: string, the HTTP method to use

Joe Gregorio

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

[diff] [blame]

215

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

Joe Gregorio

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

[diff] [blame]

216

headers: dict, the HTTP request headers

Joe Gregorio

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

[diff] [blame]

217

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

Joe Gregorio

2012-04-13 07:58:30 -0400

[diff] [blame^]

218

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

Joe Gregorio

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

[diff] [blame]

219

220

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

221

222

Args:

223

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

224

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

225

226

Returns:

227

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.

232

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

233

Joe Gregorio

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

[diff] [blame]

234

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

235

236

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

Joe Gregorio

2012-04-13 07:58:30 -0400

[diff] [blame^]

237

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

Joe Gregorio

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

[diff] [blame]

Example:

Joe Gregorio

2012-04-13 07:58:30 -0400

[diff] [blame^]

241

media = <a href="#MediaFileUpload">MediaFileUpload</a>('smiley.png', mimetype='image/png',

Joe Gregorio

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

[diff] [blame]

242

chunksize=1000, resumable=True)

243

request = service.objects().insert(

244

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

name='smiley.png',

media_body=media)

response = None

while response is None:

250

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

251

if status:

252

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

Returns:

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

257

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

258

259

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

260

261

<hr>

262

Static methods defined here:

263

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

264

Joe Gregorio

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

[diff] [blame]

265

<hr>

266

Data descriptors defined here:

267

268

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

269

</dl>

270

<dl><dt>__weakref__</dt>

271

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

</dl>

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

Joe Gregorio

2012-04-13 07:58:30 -0400

[diff] [blame^]

277

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

278

279

280

<td colspan=2><tt>Mock of <a href="#HttpRequest">HttpRequest</a>.

281

282

Do not construct directly, instead use <a href="#RequestMockBuilder">RequestMockBuilder</a>.  </tt></td></tr>

283

284

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

285

<dl><dt><a name="HttpRequestMock-__init__">__init__</a>(self, resp, content, postproc)</dt><dd><tt>Constructor for <a href="#HttpRequestMock">HttpRequestMock</a>

286

287

Args:

288

resp: httplib2.Response, the response to emulate coming from the request

289

content: string, the response body

290

postproc: callable, the post processing function usually supplied by

291

the model class. See model.JsonModel.response() as an example.</tt></dd></dl>

292

293

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

294

295

Same behavior as <a href="#HttpRequest">HttpRequest</a>.<a href="#HttpRequestMock-execute">execute</a>(), but the response is

296

mocked and not really from an HTTP request/response.</tt></dd></dl>

297

298

<hr>

299

Data descriptors defined here:

300

301

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

302

</dl>

303

<dl><dt>__weakref__</dt>

304

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

</dl>

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

<a name="MediaFileUpload">class MediaFileUpload</a>(<a href="apiclient.http.html#MediaUpload">MediaUpload</a>)</td></tr>

311

312

313

<td colspan=2><tt>A <a href="#MediaUpload">MediaUpload</a> for a file.

314

315

Construct a <a href="#MediaFileUpload">MediaFileUpload</a> and pass as the media_body parameter of the

316

method. For example, if we had a service that allowed uploading images:

317

318

319

media = <a href="#MediaFileUpload">MediaFileUpload</a>('smiley.png', mimetype='image/png', chunksize=1000,

320

resumable=True)

321

service.objects().insert(

322

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

323

name='smiley.png',

324

media_body=media).execute()  </tt></td></tr>

325

326

<td width="100%"><dl><dt>Method resolution order:</dt>

327

<dd><a href="apiclient.http.html#MediaFileUpload">MediaFileUpload</a></dd>

328

<dd><a href="apiclient.http.html#MediaUpload">MediaUpload</a></dd>

329

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

330

</dl>

331

<hr>

332

Methods defined here:

333

<dl><dt><a name="MediaFileUpload-__init__">__init__</a>(self, filename, mimetype=None, chunksize=262144, resumable=False)</dt><dd><tt>Constructor.

334

335

Args:

336

filename: string, Name of the file.

337

mimetype: string, Mime-type of the file. If None then a mime-type will be

338

guessed from the file extension.

339

chunksize: int, File will be uploaded in chunks of this many bytes. Only

340

used if resumable=True.

341

resumable: bool, True if this is a resumable upload. False means upload

342

in a single request.</tt></dd></dl>

343

344

<dl><dt><a name="MediaFileUpload-chunksize">chunksize</a>(self)</dt></dl>

345

346

<dl><dt><a name="MediaFileUpload-getbytes">getbytes</a>(self, begin, length)</dt><dd><tt>Get bytes from the media.

347

348

Args:

349

begin: int, offset from beginning of file.

350

length: int, number of bytes to read, starting at begin.

351

352

Returns:

353

A string of bytes read. May be shorted than length if EOF was reached

354

first.</tt></dd></dl>

355

356

<dl><dt><a name="MediaFileUpload-mimetype">mimetype</a>(self)</dt></dl>

357

358

<dl><dt><a name="MediaFileUpload-resumable">resumable</a>(self)</dt></dl>

<dl><dt><a name="MediaFileUpload-to_json">to_json</a>(self)</dt><dd><tt>Creating a JSON representation of an instance of Credentials.

363

364

Returns:

365

string, a JSON representation of this instance, suitable to pass to

<hr>

Static methods defined here:

<hr>

Class methods inherited from <a href="apiclient.http.html#MediaUpload">MediaUpload</a>:

374

<dl><dt><a name="MediaFileUpload-new_from_json">new_from_json</a>(cls, s) from <a href="__builtin__.html#type">__builtin__.type</a></dt><dd><tt>Utility class method to instantiate a <a href="#MediaUpload">MediaUpload</a> subclass from a JSON

375

representation produced by <a href="#MediaFileUpload-to_json">to_json</a>().

376

377

Args:

378

s: string, JSON from <a href="#MediaFileUpload-to_json">to_json</a>().

379

380

Returns:

381

An instance of the subclass of <a href="#MediaUpload">MediaUpload</a> that was serialized with

<hr>

Data descriptors inherited from <a href="apiclient.http.html#MediaUpload">MediaUpload</a>:

386

387

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

388

</dl>

389

<dl><dt>__weakref__</dt>

390

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

</dl>

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

<a name="MediaInMemoryUpload">class MediaInMemoryUpload</a>(<a href="apiclient.http.html#MediaUpload">MediaUpload</a>)</td></tr>

397

398

399

<td colspan=2><tt><a href="#MediaUpload">MediaUpload</a> for a chunk of bytes.

400

401

Construct a <a href="#MediaFileUpload">MediaFileUpload</a> and pass as the media_body parameter of the

402

method. For example, if we had a service that allowed plain text:  </tt></td></tr>

403

404

<td width="100%"><dl><dt>Method resolution order:</dt>

405

<dd><a href="apiclient.http.html#MediaInMemoryUpload">MediaInMemoryUpload</a></dd>

406

<dd><a href="apiclient.http.html#MediaUpload">MediaUpload</a></dd>

407

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

408

</dl>

409

<hr>

410

Methods defined here:

411

<dl><dt><a name="MediaInMemoryUpload-__init__">__init__</a>(self, body, mimetype='application/octet-stream', chunksize=262144, resumable=False)</dt><dd><tt>Create a new MediaBytesUpload.

412

413

Args:

414

body: string, Bytes of body content.

415

mimetype: string, Mime-type of the file or default of

416

'application/octet-stream'.

417

chunksize: int, File will be uploaded in chunks of this many bytes. Only

418

used if resumable=True.

419

resumable: bool, True if this is a resumable upload. False means upload

420

in a single request.</tt></dd></dl>

421

422

<dl><dt><a name="MediaInMemoryUpload-chunksize">chunksize</a>(self)</dt><dd><tt>Chunk size for resumable uploads.

423

424

Returns:

425

Chunk size in bytes.</tt></dd></dl>

426

427

<dl><dt><a name="MediaInMemoryUpload-getbytes">getbytes</a>(self, begin, length)</dt><dd><tt>Get bytes from the media.

428

429

Args:

430

begin: int, offset from beginning of file.

431

length: int, number of bytes to read, starting at begin.

432

433

Returns:

434

A string of bytes read. May be shorter than length if EOF was reached

435

first.</tt></dd></dl>

436

437

<dl><dt><a name="MediaInMemoryUpload-mimetype">mimetype</a>(self)</dt><dd><tt>Mime type of the body.

438

439

Returns:

440

Mime type.</tt></dd></dl>

441

442

<dl><dt><a name="MediaInMemoryUpload-resumable">resumable</a>(self)</dt><dd><tt>Whether this upload is resumable.

443

444

Returns:

445

True if resumable upload or False.</tt></dd></dl>

446

447

<dl><dt><a name="MediaInMemoryUpload-size">size</a>(self)</dt><dd><tt>Size of upload.

448

449

Returns:

450

Size of the body.</tt></dd></dl>

451

452

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

453

454

Returns:

455

string, a JSON representation of this instance, suitable to pass to

<hr>

Static methods defined here:

<hr>

Class methods inherited from <a href="apiclient.http.html#MediaUpload">MediaUpload</a>:

464

<dl><dt><a name="MediaInMemoryUpload-new_from_json">new_from_json</a>(cls, s) from <a href="__builtin__.html#type">__builtin__.type</a></dt><dd><tt>Utility class method to instantiate a <a href="#MediaUpload">MediaUpload</a> subclass from a JSON

465

representation produced by <a href="#MediaInMemoryUpload-to_json">to_json</a>().

466

467

Args:

468

s: string, JSON from <a href="#MediaInMemoryUpload-to_json">to_json</a>().

469

470

Returns:

471

An instance of the subclass of <a href="#MediaUpload">MediaUpload</a> that was serialized with

<hr>

Data descriptors inherited from <a href="apiclient.http.html#MediaUpload">MediaUpload</a>:

476

477

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

478

</dl>

479

<dl><dt>__weakref__</dt>

480

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

</dl>

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

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

487

488

489

<td colspan=2><tt>Describes a media <a href="__builtin__.html#object">object</a> to upload.

490

491

Base class that defines the interface of <a href="#MediaUpload">MediaUpload</a> subclasses.  </tt></td></tr>

492

493

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

494

<dl><dt><a name="MediaUpload-chunksize">chunksize</a>(self)</dt></dl>

495

496

<dl><dt><a name="MediaUpload-getbytes">getbytes</a>(self, begin, end)</dt></dl>

497

498

<dl><dt><a name="MediaUpload-mimetype">mimetype</a>(self)</dt></dl>

499

500

<dl><dt><a name="MediaUpload-resumable">resumable</a>(self)</dt></dl>

<dl><dt><a name="MediaUpload-to_json">to_json</a>(self)</dt><dd><tt>Create a JSON representation of an instance of <a href="#MediaUpload">MediaUpload</a>.

505

506

Returns:

507

string, a JSON representation of this instance, suitable to pass to

508

from_json().</tt></dd></dl>

509

510

<hr>

511

Class methods defined here:

512

<dl><dt><a name="MediaUpload-new_from_json">new_from_json</a>(cls, s) from <a href="__builtin__.html#type">__builtin__.type</a></dt><dd><tt>Utility class method to instantiate a <a href="#MediaUpload">MediaUpload</a> subclass from a JSON

513

representation produced by <a href="#MediaUpload-to_json">to_json</a>().

514

515

Args:

516

s: string, JSON from <a href="#MediaUpload-to_json">to_json</a>().

517

518

Returns:

519

An instance of the subclass of <a href="#MediaUpload">MediaUpload</a> that was serialized with

<hr>

Data descriptors defined here:

524

525

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

526

</dl>

527

<dl><dt>__weakref__</dt>

528

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

</dl>

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

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

535

536

537

<td colspan=2><tt>Status of a resumable upload.  </tt></td></tr>

538

539

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

540

<dl><dt><a name="MediaUploadProgress-__init__">__init__</a>(self, resumable_progress, total_size)</dt><dd><tt>Constructor.

541

542

Args:

543

resumable_progress: int, bytes sent so far.

544

total_size: int, total bytes in complete upload.</tt></dd></dl>

545

546

<dl><dt><a name="MediaUploadProgress-progress">progress</a>(self)</dt><dd><tt>Percent of upload completed, as a float.</tt></dd></dl>

547

548

<hr>

549

Data descriptors defined here:

550

551

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

552

</dl>

553

<dl><dt>__weakref__</dt>

554

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

560

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

561

562

563

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

564

565

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

Joe Gregorio

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

[diff] [blame]

566

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

567

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

568

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

569

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

570

the body and UnexpectedBodyError will be raised on inequality.

Joe Gregorio

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

[diff] [blame]

571

572

Example:

573

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

574

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

575

{

Joe Gregorio

c4fc095

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

[diff] [blame]

576

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

Joe Gregorio

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

[diff] [blame]

577

}

578

)

Joe Gregorio

c4fc095

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

[diff] [blame]

579

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

Joe Gregorio

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

[diff] [blame]

580

581

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

Joe Gregorio

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

[diff] [blame]

582

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

583

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

Joe Gregorio

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

[diff] [blame]

584

in the discovery document.

Joe Gregorio

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

[diff] [blame]

585

586

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

587

588

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

Joe Gregorio

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

[diff] [blame]

589

<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

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

[diff] [blame]

590

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

591

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

592

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

593

Joe Gregorio

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

[diff] [blame]

594

<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

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

[diff] [blame]

595

596

The constructed <a href="__builtin__.html#object">object</a> should be a callable <a href="__builtin__.html#object">object</a>

597

that can replace the class HttpResponse.

598

599

responses - A dictionary that maps methodIds into tuples

600

of (httplib2.Response, content). The methodId

601

comes from the 'rpcName' field in the discovery

Joe Gregorio

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

[diff] [blame]

602

document.

603

check_unexpected - A boolean setting whether or not UnexpectedMethodError

604

should be raised on unsupplied method.</tt></dd></dl>

Joe Gregorio

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

[diff] [blame]

605

606

<hr>

607

Data descriptors defined here:

608

609

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

610

</dl>

611

<dl><dt>__weakref__</dt>

612

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

613

</dl>

614

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

615

Joe Gregorio

20a5aa9

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

[diff] [blame]

616

617

618

<big>Functions</big></td></tr>

619

620

Joe Gregorio

2012-04-13 07:58:30 -0400

[diff] [blame^]

621

<td width="100%"><dl><dt><a name="-set_user_agent">set_user_agent</a>(http, user_agent)</dt><dd><tt>Set the user-agent on every request.

622

623

Args:

624

http - An instance of httplib2.Http

625

or something that acts like it.

626

user_agent: string, the value for the user-agent header.

627

628

Returns:

629

A modified instance of http that was passed in.

Example:

h = httplib2.Http()

h = <a href="#-set_user_agent">set_user_agent</a>(h, "my-app-name/6.0")

635

636

Most of the time the user-agent will be set doing auth, this is for the rare

637

cases where you are accessing an unauthenticated endpoint.</tt></dd></dl>

638

<dl><dt><a name="-tunnel_patch">tunnel_patch</a>(http)</dt><dd><tt>Tunnel PATCH requests over POST.

Joe Gregorio

20a5aa9

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

[diff] [blame]

639

Args:

640

http - An instance of httplib2.Http

641

or something that acts like it.

642

643

Returns:

644

A modified instance of http that was passed in.

Example:

h = httplib2.Http()

h = <a href="#-tunnel_patch">tunnel_patch</a>(h, "my-app-name/6.0")

650

651

Useful if you are running on a platform that doesn't support PATCH.

652

Apply this last if you are using OAuth 1.0, as changing the method

653

will result in a different signature.</tt></dd></dl>

654

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

655

Joe Gregorio

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

[diff] [blame]

Joe Gregorio

2012-04-13 07:58:30 -0400

[diff] [blame^]

661

<td width="100%">__author__ = 'jcgregorio@google.com (Joe Gregorio)'</td></tr></table>

Joe Gregorio