Skip to main content

Async http client/server framework (asyncio)

Project description

Async http client/server framework

aiohttp logo

Travis status for master branch AppVeyor status for master branch codecov.io status for master branch Latest PyPI package version Latest Read The Docs Chat on Gitter

Key Features

  • Supports both client and server side of HTTP protocol.

  • Supports both client and server Web-Sockets out-of-the-box and avoids Callback Hell.

  • Provides Web-server with middlewares and pluggable routing.

Getting started

Client

To get something from the web:

import aiohttp
import asyncio

async def fetch(session, url):
    async with session.get(url) as response:
        return await response.text()

async def main():
    async with aiohttp.ClientSession() as session:
        html = await fetch(session, 'http://python.org')
        print(html)

if __name__ == '__main__':
    loop = asyncio.get_event_loop()
    loop.run_until_complete(main())

Server

An example using a simple server:

# examples/server_simple.py
from aiohttp import web

async def handle(request):
    name = request.match_info.get('name', "Anonymous")
    text = "Hello, " + name
    return web.Response(text=text)

async def wshandle(request):
    ws = web.WebSocketResponse()
    await ws.prepare(request)

    async for msg in ws:
        if msg.type == web.WSMsgType.text:
            await ws.send_str("Hello, {}".format(msg.data))
        elif msg.type == web.WSMsgType.binary:
            await ws.send_bytes(msg.data)
        elif msg.type == web.WSMsgType.close:
            break

    return ws


app = web.Application()
app.add_routes([web.get('/', handle),
                web.get('/echo', wshandle),
                web.get('/{name}', handle)])

if __name__ == '__main__':
    web.run_app(app)

Documentation

https://aiohttp.readthedocs.io/

Demos

https://github.com/aio-libs/aiohttp-demos

Communication channels

aio-libs google group: https://groups.google.com/forum/#!forum/aio-libs

Feel free to post your questions and ideas here.

gitter chat https://gitter.im/aio-libs/Lobby

We support Stack Overflow. Please add aiohttp tag to your question there.

Requirements

Optionally you may install the cChardet and aiodns libraries (highly recommended for sake of speed).

License

aiohttp is offered under the Apache 2 license.

Keepsafe

The aiohttp community would like to thank Keepsafe (https://www.getkeepsafe.com) for its support in the early days of the project.

Source code

The latest developer version is available in a GitHub repository: https://github.com/aio-libs/aiohttp

Benchmarks

If you are interested in efficiency, the AsyncIO community maintains a list of benchmarks on the official wiki: https://github.com/python/asyncio/wiki/Benchmarks

Changelog

3.5.4 (2019-01-12)

Bugfixes

  • Fix stream .read() / .readany() / .iter_any() which used to return a partial content only in case of compressed content #3525

3.5.3 (2019-01-10)

Bugfixes

  • Fix type stubs for aiohttp.web.run_app(access_log=True) and fix edge case of access_log=True and the event loop being in debug mode. #3504

  • Fix aiohttp.ClientTimeout type annotations to accept None for fields #3511

  • Send custom per-request cookies even if session jar is empty #3515

  • Restore Linux binary wheels publishing on PyPI


3.5.2 (2019-01-08)

Features

  • FileResponse from web_fileresponse.py uses a ThreadPoolExecutor to work with files asynchronously. I/O based payloads from payload.py uses a ThreadPoolExecutor to work with I/O objects asynchronously. #3313

  • Internal Server Errors in plain text if the browser does not support HTML. #3483

Bugfixes

  • Preserve MultipartWriter parts headers on write.

    Refactor the way how Payload.headers are handled. Payload instances now always have headers and Content-Type defined.

    Fix Payload Content-Disposition header reset after initial creation. #3035

  • Log suppressed exceptions in GunicornWebWorker. #3464

  • Remove wildcard imports. #3468

  • Use the same task for app initialization and web server handling in gunicorn workers. It allows to use Python3.7 context vars smoothly. #3471

  • Fix handling of chunked+gzipped response when first chunk does not give uncompressed data #3477

  • Replace collections.MutableMapping with collections.abc.MutableMapping to avoid a deprecation warning. #3480

  • Payload.size type annotation changed from Optional[float] to Optional[int]. #3484

  • Ignore done tasks when cancels pending activities on web.run_app finalization. #3497

Improved Documentation

  • Add documentation for aiohttp.web.HTTPException. #3490

Misc


3.5.1 (2018-12-24)

  • Fix a regression about ClientSession._requote_redirect_url modification in debug mode.

3.5.0 (2018-12-22)

Features

  • The library type annotations are checked in strict mode now.

  • Add support for setting cookies for individual request (#2387)

  • Application.add_domain implementation (#2809)

  • The default app in the request returned by test_utils.make_mocked_request can now have objects assigned to it and retrieved using the [] operator. (#3174)

  • Make request.url accessible when transport is closed. (#3177)

  • Add zlib_executor_size argument to Response constructor to allow compression to run in a background executor to avoid blocking the main thread and potentially triggering health check failures. (#3205)

  • Enable users to set ClientTimeout in aiohttp.request (#3213)

  • Don’t raise a warning if NETRC environment variable is not set and ~/.netrc file doesn’t exist. (#3267)

  • Add default logging handler to web.run_app

    If the Application.debug flag is set and the default logger aiohttp.access is used, access logs will now be output using a stderr StreamHandler if no handlers are attached. Furthermore, if the default logger has no log level set, the log level will be set to DEBUG. (#3324)

  • Add method argument to session.ws_connect().

    Sometimes server API requires a different HTTP method for WebSocket connection establishment.

    For example, Docker exec needs POST. (#3378)

  • Create a task per request handling. (#3406)

Bugfixes

  • Enable passing access_log_class via handler_args (#3158)

  • Return empty bytes with end-of-chunk marker in empty stream reader. (#3186)

  • Accept CIMultiDictProxy instances for headers argument in web.Response constructor. (#3207)

  • Don’t uppercase HTTP method in parser (#3233)

  • Make method match regexp RFC-7230 compliant (#3235)

  • Add app.pre_frozen state to properly handle startup signals in sub-applications. (#3237)

  • Enhanced parsing and validation of helpers.BasicAuth.decode. (#3239)

  • Change imports from collections module in preparation for 3.8. (#3258)

  • Ensure Host header is added first to ClientRequest to better replicate browser (#3265)

  • Fix forward compatibility with Python 3.8: importing ABCs directly from the collections module will not be supported anymore. (#3273)

  • Keep the query string by normalize_path_middleware. (#3278)

  • Fix missing parameter raise_for_status for aiohttp.request() (#3290)

  • Bracket IPv6 addresses in the HOST header (#3304)

  • Fix default message for server ping and pong frames. (#3308)

  • Fix tests/test_connector.py typo and tests/autobahn/server.py duplicate loop def. (#3337)

  • Fix false-negative indicator end_of_HTTP_chunk in StreamReader.readchunk function (#3361)

  • Release HTTP response before raising status exception (#3364)

  • Fix task cancellation when sendfile() syscall is used by static file handling. (#3383)

  • Fix stack trace for asyncio.TimeoutError which was not logged, when it is caught in the handler. (#3414)

Improved Documentation

  • Improve documentation of Application.make_handler parameters. (#3152)

  • Fix BaseRequest.raw_headers doc. (#3215)

  • Fix typo in TypeError exception reason in web.Application._handle (#3229)

  • Make server access log format placeholder %b documentation reflect behavior and docstring. (#3307)

Deprecations and Removals

  • Deprecate modification of session.requote_redirect_url (#2278)

  • Deprecate stream.unread_data() (#3260)

  • Deprecated use of boolean in resp.enable_compression() (#3318)

  • Encourage creation of aiohttp public objects inside a coroutine (#3331)

  • Drop dead Connection.detach() and Connection.writer. Both methods were broken for more than 2 years. (#3358)

  • Deprecate app.loop, request.loop, client.loop and connector.loop properties. (#3374)

  • Deprecate explicit debug argument. Use asyncio debug mode instead. (#3381)

  • Deprecate body parameter in HTTPException (and derived classes) constructor. (#3385)

  • Deprecate bare connector close, use async with connector: and await connector.close() instead. (#3417)

  • Deprecate obsolete read_timeout and conn_timeout in ClientSession constructor. (#3438)

Misc

  • #3341, #3351

Release history Release notifications | RSS feed

Download files

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

Source Distribution

aiohttp-3.6.0a9.tar.gz (1.1 MB view details)

Uploaded Source

Built Distributions

aiohttp-3.6.0a9-py3-none-any.whl (189.5 kB view details)

Uploaded Python 3

aiohttp-3.6.0a9-cp37-cp37m-win_amd64.whl (615.8 kB view details)

Uploaded CPython 3.7m Windows x86-64

aiohttp-3.6.0a9-cp37-cp37m-win32.whl (588.1 kB view details)

Uploaded CPython 3.7m Windows x86

aiohttp-3.6.0a9-cp36-cp36m-win_amd64.whl (615.7 kB view details)

Uploaded CPython 3.6m Windows x86-64

aiohttp-3.6.0a9-cp36-cp36m-win32.whl (588.0 kB view details)

Uploaded CPython 3.6m Windows x86

aiohttp-3.6.0a9-cp35-cp35m-win_amd64.whl (610.1 kB view details)

Uploaded CPython 3.5m Windows x86-64

aiohttp-3.6.0a9-cp35-cp35m-win32.whl (582.1 kB view details)

Uploaded CPython 3.5m Windows x86

File details

Details for the file aiohttp-3.6.0a9.tar.gz.

File metadata

  • Download URL: aiohttp-3.6.0a9.tar.gz
  • Upload date:
  • Size: 1.1 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.35.0 CPython/3.5.4

File hashes

Hashes for aiohttp-3.6.0a9.tar.gz
Algorithm Hash digest
SHA256 660b6935b7b14f4853592c4cfaa62fe42657d26bb663465b82ea160af688bf91
MD5 c4f81f7d6f9115762997d0257e12bb3c
BLAKE2b-256 9f63c86f0a8cc03c1110ab650f78b31865fcbdafc5c664e2f111ab7b8b39fe57

See more details on using hashes here.

Provenance

File details

Details for the file aiohttp-3.6.0a9-py3-none-any.whl.

File metadata

  • Download URL: aiohttp-3.6.0a9-py3-none-any.whl
  • Upload date:
  • Size: 189.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.35.0 CPython/3.5.3

File hashes

Hashes for aiohttp-3.6.0a9-py3-none-any.whl
Algorithm Hash digest
SHA256 77d037816abbe847ad3ed4c28e69d35ccffc12be6bafb507cfbf9219390a5eca
MD5 67914b098b966deac9725d32889d85cf
BLAKE2b-256 0b18121b108d192348b690e9cb227273b5a3a360315531a6de362d78a6a054ff

See more details on using hashes here.

Provenance

File details

Details for the file aiohttp-3.6.0a9-cp37-cp37m-win_amd64.whl.

File metadata

  • Download URL: aiohttp-3.6.0a9-cp37-cp37m-win_amd64.whl
  • Upload date:
  • Size: 615.8 kB
  • Tags: CPython 3.7m, Windows x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.35.0 CPython/3.7.4

File hashes

Hashes for aiohttp-3.6.0a9-cp37-cp37m-win_amd64.whl
Algorithm Hash digest
SHA256 41a0479dc259586af6ac315f440226eb8fa0498a2af1bd101054bbd5284b54b1
MD5 93fc3cf28cbe4f19520eda518e0db27d
BLAKE2b-256 83e62477445b3b5da069d5eab548e11b060845615d84146dd0f6706487d05d4e

See more details on using hashes here.

Provenance

File details

Details for the file aiohttp-3.6.0a9-cp37-cp37m-win32.whl.

File metadata

  • Download URL: aiohttp-3.6.0a9-cp37-cp37m-win32.whl
  • Upload date:
  • Size: 588.1 kB
  • Tags: CPython 3.7m, Windows x86
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.35.0 CPython/3.7.4

File hashes

Hashes for aiohttp-3.6.0a9-cp37-cp37m-win32.whl
Algorithm Hash digest
SHA256 85d54f0c2cc026a8841e554526f2ab5a85eb746192ef665aeedb934e0aa3f21f
MD5 2212d833cf0b7df65fbc60fc37d2fc54
BLAKE2b-256 508fc769ae2806953226c54bdfb77b3ef43df5091ea7264ada4c87b14fadc04e

See more details on using hashes here.

Provenance

File details

Details for the file aiohttp-3.6.0a9-cp36-cp36m-win_amd64.whl.

File metadata

  • Download URL: aiohttp-3.6.0a9-cp36-cp36m-win_amd64.whl
  • Upload date:
  • Size: 615.7 kB
  • Tags: CPython 3.6m, Windows x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.35.0 CPython/3.6.8

File hashes

Hashes for aiohttp-3.6.0a9-cp36-cp36m-win_amd64.whl
Algorithm Hash digest
SHA256 02df8a8b04d52eee3aa07247f3b9850a21cb9aa9455da72c351727dcd6ffe9a0
MD5 e9412ac65d9b97d3d6db938e0db86e85
BLAKE2b-256 85b72408354cc2cc3a548e52daa1d86fdf946308217703cb088709a835172c0e

See more details on using hashes here.

Provenance

File details

Details for the file aiohttp-3.6.0a9-cp36-cp36m-win32.whl.

File metadata

  • Download URL: aiohttp-3.6.0a9-cp36-cp36m-win32.whl
  • Upload date:
  • Size: 588.0 kB
  • Tags: CPython 3.6m, Windows x86
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.35.0 CPython/3.6.8

File hashes

Hashes for aiohttp-3.6.0a9-cp36-cp36m-win32.whl
Algorithm Hash digest
SHA256 5b3ba43b858fdbd4605e9d8c3f28a2d4de206fc11b4025c212ec6664bb3c4464
MD5 d2f33df66f7e1de7e753ca029207677e
BLAKE2b-256 5df370f2dbcde6cb9244abf0e418d32c8020f91dc5c21ad1258e63471ce3d967

See more details on using hashes here.

Provenance

File details

Details for the file aiohttp-3.6.0a9-cp35-cp35m-win_amd64.whl.

File metadata

  • Download URL: aiohttp-3.6.0a9-cp35-cp35m-win_amd64.whl
  • Upload date:
  • Size: 610.1 kB
  • Tags: CPython 3.5m, Windows x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.35.0 CPython/3.5.4

File hashes

Hashes for aiohttp-3.6.0a9-cp35-cp35m-win_amd64.whl
Algorithm Hash digest
SHA256 287f068dd5554c3ace00be3b51e8c59fc11f4842f6b01b0034d6e71b3c22576b
MD5 33abc1a823b37278becac5ceeb159b20
BLAKE2b-256 2f46f6a30353ed36a2dce41341a4f948679f4cbf4e53fd298b259301406b840f

See more details on using hashes here.

Provenance

File details

Details for the file aiohttp-3.6.0a9-cp35-cp35m-win32.whl.

File metadata

  • Download URL: aiohttp-3.6.0a9-cp35-cp35m-win32.whl
  • Upload date:
  • Size: 582.1 kB
  • Tags: CPython 3.5m, Windows x86
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.35.0 CPython/3.5.4

File hashes

Hashes for aiohttp-3.6.0a9-cp35-cp35m-win32.whl
Algorithm Hash digest
SHA256 46931d1d2f65bd394adff7385a122789ca3fae2788018667616ad98951133783
MD5 7aba9129cd6c408aab607e6a21951622
BLAKE2b-256 d7ac55596c1823841923ba377563b97bbbac54a46a6e09458afa237bf6b9daaa

See more details on using hashes here.

Provenance

Supported by

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