Skip to main content

HTTP Client Mixin for Tornado RequestHandlers

Project description

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

Version Travis CodeCov Docs

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

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)


if __name__ == "__main__":
   app = web.Application([(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)


if __name__ == "__main__":
   app = web.Application([(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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sprockets.mixins.http-1.1.1.tar.gz (7.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

sprockets.mixins.http-1.1.1-py2.py3-none-any.whl (8.3 kB view details)

Uploaded Python 2Python 3

File details

Details for the file sprockets.mixins.http-1.1.1.tar.gz.

File metadata

  • Download URL: sprockets.mixins.http-1.1.1.tar.gz
  • Upload date:
  • Size: 7.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.6.3 requests-toolbelt/0.8.0 tqdm/4.29.0 CPython/3.5.6

File hashes

Hashes for sprockets.mixins.http-1.1.1.tar.gz
Algorithm Hash digest
SHA256 4fbc55dd7013a26e2659027b86240796f00870e07adfdb3c9a9ac6624321b247
MD5 87955aac59e0d7fa2d3c586d9e1041f9
BLAKE2b-256 51b3341c09b48ad1a7b83106e8b2072939d7a54698b923686a584fa65e3c37ff

See more details on using hashes here.

File details

Details for the file sprockets.mixins.http-1.1.1-py2.py3-none-any.whl.

File metadata

  • Download URL: sprockets.mixins.http-1.1.1-py2.py3-none-any.whl
  • Upload date:
  • Size: 8.3 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.6.3 requests-toolbelt/0.8.0 tqdm/4.29.0 CPython/3.5.6

File hashes

Hashes for sprockets.mixins.http-1.1.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 017e91248cda77ba86518650e4433df0933ed7d1b4ddd433fcad83ea23387fbe
MD5 3f775c8d424d7bf5cfe6117a1c64c882
BLAKE2b-256 79bde0da4a76ede9eea807984e3e434b69f536bbe18ae21f3e5742fb22cf7a82

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page