sprockets.mixins.http 1.0.5

HTTP Client Mixin for Tornado RequestHandlers

HTTP Client Mixin for Tornado RequestHandlers. Automatically retries on errors, sleep when rate limited, and handles content encoding and decoding using MsgPack and JSON.

Installation

sprockets.mixins.http is available on the Python Package Index and can be installed via pip or easy_install:

pip install sprockets.mixins.http

If you would like to use tornado.curl_httpclient.CurlAsyncHTTPClient, you can install pycurl with:

pip install sprockets.mixins.http[curl]

Documentation

http://pythonhosted.org/sprockets.mixins.http/

Requirements

• tornado >=4.2.0,<5

Example

This examples demonstrates the most basic usage of sprockets.mixins.http

from tornado import gen, ioloop, web
from sprockets.mixins import http


class RequestHandler(http.HTTPClientMixin, web.RequestHandler):

   @gen.coroutine
   def get(self, *args, **kwargs):
       response = yield self.http_fetch('https://api.github.com')
       if not response.ok:
           self.set_status(response.code)
       self.write(response.body)
       self.finish()


if __name__ == "__main__":
   app = web.Application([web.url(r'/', RequestHandler)])
   app.listen(8000)
   ioloop.IOLoop.current().start()

As with Tornado, to use the curl client which has numerous benefits:

from tornado import gen, httpclient, ioloop, web
from sprockets.mixins import http

httpclient.AsyncHTTPClient.configure(
    'tornado.curl_httpclient.CurlAsyncHTTPClient')


class RequestHandler(http.HTTPClientMixin, web.RequestHandler):

   @gen.coroutine
   def get(self, *args, **kwargs):
       response = yield self.http_fetch('https://api.github.com')
       if not response.ok:
           self.set_status(response.code)
       self.write(response.body)
       self.finish()


if __name__ == "__main__":
   app = web.Application([web.url(r'/', RequestHandler)])
   app.listen(8000)
   ioloop.IOLoop.current().start()

Environment Variables

HTTP_MAX_CLIENTS

An optional setting that specifies the maximum number of simultaneous asynchronous HTTP requests. If not specified, the default Tornado value of 10 will be used.

License

sprockets.mixins.http is released under the 3-Clause BSD license.