Skip to main content

Async http client/server framework (asyncio)

Project description

aiohttp logo

GitHub Actions status for master branch codecov.io status for master branch Latest PyPI package version Latest Read The Docs Discourse status 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 plugable routing.

Getting started

Client

To get something from the web:

import aiohttp
import asyncio

async def main():

    async with aiohttp.ClientSession() as session:
        async with session.get('http://python.org') as response:

            print("Status:", response.status)
            print("Content-type:", response.headers['content-type'])

            html = await response.text()
            print("Body:", html[:15], "...")

loop = asyncio.get_event_loop()
loop.run_until_complete(main())

This prints:

Status: 200
Content-type: text/html; charset=utf-8
Body: <!doctype html> ...

Coming from requests ? Read why we need so many lines.

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 discourse group: https://aio-libs.discourse.group

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

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.8.0a7.tar.gz (7.3 MB view hashes)

Uploaded source

Built Distributions

aiohttp-3.8.0a7-cp310-cp310-win_amd64.whl (571.2 kB view hashes)

Uploaded cp310

aiohttp-3.8.0a7-cp310-cp310-win32.whl (550.6 kB view hashes)

Uploaded cp310

aiohttp-3.8.0a7-cp39-cp39-win_amd64.whl (571.0 kB view hashes)

Uploaded cp39

aiohttp-3.8.0a7-cp39-cp39-win32.whl (550.6 kB view hashes)

Uploaded cp39

aiohttp-3.8.0a7-cp38-cp38-win_amd64.whl (572.1 kB view hashes)

Uploaded cp38

aiohttp-3.8.0a7-cp38-cp38-win32.whl (551.5 kB view hashes)

Uploaded cp38

aiohttp-3.8.0a7-cp37-cp37m-win_amd64.whl (568.0 kB view hashes)

Uploaded cp37

aiohttp-3.8.0a7-cp37-cp37m-win32.whl (548.0 kB view hashes)

Uploaded cp37

aiohttp-3.8.0a7-cp36-cp36m-win_amd64.whl (567.2 kB view hashes)

Uploaded cp36

aiohttp-3.8.0a7-cp36-cp36m-win32.whl (547.6 kB view hashes)

Uploaded cp36

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page