Asynchronous HTTP client/server framework for asyncio and Python
Clone or download
Permalink
Failed to load latest commit information.
.github Fix pull request template (#2866) Mar 21, 2018
CHANGES Force Host header to be first in ClientRequest (#3342) Oct 16, 2018
aiohttp Annotate payload_streamer.py Oct 17, 2018
docs Maintain cleanup context and startup insertion order (#3191) (#3194) Oct 16, 2018
examples Improve grammar in README and add example file Sep 16, 2018
requirements Update mypy version Oct 17, 2018
tests Force Host header to be first in ClientRequest (#3342) Oct 16, 2018
tools Require cython when building from git clone only (#3189) Aug 20, 2018
vendor Bump vendored http-parser to v 77310ee commit Aug 23, 2018
.appveyor.yml Require cython when building from git clone only (#3189) Aug 20, 2018
.cherry_picker.toml Fix cherry-picker config Apr 13, 2018
.editorconfig Add editorconfig Mar 27, 2018
.gitattributes Mark more test files as binary Mar 7, 2018
.gitignore Micro-optimization (#3095) Jun 22, 2018
.gitmodules Turn vendored Node.js' http-parser into a git submodule (#3011) May 18, 2018
.pyup.yml Run pyup bot every week Aug 30, 2017
.readthedocs.yml Disable installing deps in RTD (#3226) Aug 28, 2018
.travis.yml Lint that CONTRIBUTORS.txt is kept in alphabetical order Oct 8, 2018
CHANGES.rst Bump to 3.4.4 Sep 5, 2018
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md Mar 20, 2018
CONTRIBUTING.rst Turn vendored Node.js' http-parser into a git submodule (#3011) May 18, 2018
CONTRIBUTORS.txt Force Host header to be first in ClientRequest (#3342) Oct 16, 2018
HISTORY.rst Update CHANGES Aug 24, 2018
LICENSE.txt Mention 2018 year Jan 1, 2018
MANIFEST.in Type annotations (#3049) Jun 18, 2018
Makefile Fix makefile rules to not reinstall deps on every test run Oct 9, 2018
README.rst Improve grammar in README and add example file Sep 16, 2018
codecov.yml prevent codecov blames about reducing total lines in code, check PR only Jul 15, 2017
pyproject.toml Fix CHANGES name in towncrier config Oct 18, 2017
setup.cfg WIP: Add type hints everywhere (#3280) Sep 26, 2018
setup.py WIP: Add type hints everywhere (#3280) Sep 26, 2018
tox.ini Fix tox May 11, 2018

README.rst

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

web.run_app(app)

Documentation

https://aiohttp.readthedocs.io/

Demos

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

External links

Feel free to make a Pull Request for adding your link to these pages!

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 it's 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