Skip to content

aiohttp

14,607 30 492 Apache 2
3.9.5 (16 Apr 2024) Jul 26 2019 111.6 million (month)

aiohttp is an asynchronous HTTP client/server framework for asyncio and Python. It provides a simple API for making HTTP requests and handling both client and server functionality. Like the requests package, aiohttp is designed to be easy to use and handle many of the low-level details of working with HTTP.

The main benefit of aiohttp over requests is that it is built on top of the asyncio library, which means that it can handle many requests at the same time without blocking the execution of your program. This can lead to significant performance improvements when making many small requests, or when dealing with slow or unreliable network connections.

aiohttp provides both client and server side functionality, so you can use it to create web servers and handle client requests in a non-blocking manner. It also supports WebSocket protocol, so it can be used for building real-time application like chat, game, etc.

aiohttp also provide several features for handling connection errors, managing timeouts, and client sessions. It also provide similar features like requests package like redirect handling, cookies, and support for several authentication modules.

You can install aiohttp via pip package manager:

pip install aiohttp

In terms of API design, aiohttp is similar to requests and thus should be familiar to anyone who has used the requests library, but it provides an async with block to manage the context of the connection and used await statement to wait for the result.

It''s worth noting that aiohttp is built on top of asyncio and is designed to be used in Python 3.5 and above. It provides the same functionality as httpx but it is specifically built for the asyncio framework.

Highlights


asynciowebsocketshttp2http-servermulti-partresponse-streaminghttp-proxy

Example Use


import asyncio
from aiohttp import ClientSession, WSMsgType

# aiohttp only provides async client so we must use a coroutine:
async def run():
    async with ClientSession(headers={"User-Agent": "webscraping.fyi"}) as session:
        # we can use the session to make requests:
        response = await session.get("http://httpbin.org/headers")
        print(response.status)
        # note: to read the response body we must use await:
        print(await response.text())

        # aiohttp also comes with convenience methods for common requests:
        # POST json
        resp = await session.post("http://httpbin.org/post", json={"key": "value"})
        # POST form data
        resp = await session.post("http://httpbin.org/post", data={"key": "value"})
        # decode response as json
        resp = await session.get("http://httpbin.org/json")
        data = await resp.json()
        print(data)

        # aiohttp also supports websocket connections
        # which can be used to scrape websites that use websockets:
        async with session.ws_connect("http://example.org/ws") as ws:
            async for msg in ws:
                if msg.type == WSMsgType.TEXT:
                    if msg.data == "close cmd":
                        await ws.close()
                        break
                    else:
                        await ws.send_str(msg.data + "/answer")
                elif msg.type == WSMsgType.ERROR:
                    break


asyncio.run(run())

Alternatives / Similar


51,415 2.31.0 (11 months ago) Feb 14 2011 compare
12,422 0.27.0 (2 months ago) Jul 26 2019 compare
1,041 7.45.3 (2 months ago) Feb 25 2003 compare
583 23.11.0 (6 months ago) Dec 28 2012 compare

Other Languages

8,650 3.3.2 (5 months ago) Dec 28 2012 compare
104,139 1.6.8 (4 days ago) Aug 29 2014 compare
got
13,956 14.2.1 (2 months ago) Mar 27 2014 compare
16,538 9.0.2 (12 days ago) Aug 22 2011 compare
1,617 3.3.1 (4 months ago) Dec 11 2011 compare
5,665 2.9.0 (4 months ago) Dec 19 2009 compare
698 2.8.3 (7 years ago) Jul 25 2009 compare
1,154 0.110.0 (a month ago) Oct 31 2009 compare
5,761 0.22.0 (12 days ago) Jul 25 2009 compare
4,063 1.4.1 (5 months ago) Oct 06 2009 compare
981 1.4.7 (1 year, 4 days ago) May 06 2012 compare
1,476 1.0.4 (1 year, 8 months ago) Nov 22 2014 compare
22,795 7.8.0 (8 months ago) Nov 14 2011 compare
1,219 1.1.7 (3 years ago) Oct 25 2009 compare
383 18.1.0 (4 months ago) Aug 06 2011 compare
1,885 v7.1.0-BETA1 (9 days ago) Apr 28 2019 compare
877 0.11.0 (3 years ago) Sep 25 2013 compare
101 1.4.2 (11 months ago) Nov 09 2016 compare
req
4,023 v3.43.4 (4 days ago) Jun 16 2023 compare
9,408 v2.13.1 (a day ago) Oct 28 2018 compare
506 1.1.4 (4 years ago) Apr 20 2010 compare
3,560 v2.0.11 (a month ago) Oct 06 2013 compare
1,921 1.2.1 (2 years ago) Nov 11 2011 compare
1,736 1.0.0 (10 days ago) Apr 14 2012 compare
152 2.2.4 (3 years ago) Dec 22 2019 compare
2,988 0.12.0 (6 years ago) Mar 20 2015 compare