Convert Figma logo to code with AI

aio-libs logoaiohttp

Asynchronous HTTP client/server framework for asyncio and Python

15,061
2,011
15,061
254

Top Related Projects

Requests + Gevent = <3

10,027

The little ASGI framework that shines. 🌟

2,887

An async Python micro framework for building web applications.

Quick Overview

aiohttp is an asynchronous HTTP client/server framework for Python, built on top of asyncio. It provides both client and server implementations for making and handling HTTP requests asynchronously, making it ideal for high-performance web applications and microservices.

Pros

  • Asynchronous architecture allows for efficient handling of many concurrent connections
  • Supports both client and server-side HTTP implementations
  • Extensive feature set, including WebSockets, multipart request handling, and streaming
  • Active community and regular updates

Cons

  • Steeper learning curve compared to synchronous alternatives, especially for developers new to async programming
  • Debugging can be more challenging due to the asynchronous nature of the code
  • Some third-party libraries may not be compatible with asyncio, requiring additional adapters or workarounds

Code Examples

  1. Making a simple GET request:
import aiohttp
import asyncio

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

asyncio.run(fetch('https://api.github.com'))
  1. Creating a basic HTTP server:
from aiohttp import web

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

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

if __name__ == '__main__':
    web.run_app(app)
  1. WebSocket example:
import aiohttp
from aiohttp import web

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

    async for msg in ws:
        if msg.type == aiohttp.WSMsgType.TEXT:
            if msg.data == 'close':
                await ws.close()
            else:
                await ws.send_str(f'Echo: {msg.data}')

    return ws

app = web.Application()
app.add_routes([web.get('/ws', websocket_handler)])

Getting Started

To get started with aiohttp, first install it using pip:

pip install aiohttp

Then, you can create a simple client or server application. Here's a basic client example:

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], "...")

asyncio.run(main())

This example creates a client session, makes a GET request to python.org, and prints some information about the response.

Competitor Comparisons

Requests + Gevent = <3

Pros of grequests

  • Simpler API, easier to use for developers familiar with the requests library
  • Lightweight and focused specifically on asynchronous HTTP requests
  • Can be used with existing requests code with minimal changes

Cons of grequests

  • Less actively maintained compared to aiohttp
  • Limited to HTTP requests, while aiohttp offers a more comprehensive set of features
  • May not perform as well as aiohttp for large-scale applications

Code Comparison

grequests:

import grequests

urls = ['http://example.com', 'http://example.org']
rs = (grequests.get(u) for u in urls)
responses = grequests.map(rs)

aiohttp:

import aiohttp
import asyncio

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

async def main():
    urls = ['http://example.com', 'http://example.org']
    async with aiohttp.ClientSession() as session:
        tasks = [fetch(session, url) for url in urls]
        responses = await asyncio.gather(*tasks)

asyncio.run(main())

The code comparison shows that grequests offers a more straightforward approach, similar to the synchronous requests library. aiohttp, on the other hand, requires more explicit use of async/await syntax but provides greater flexibility and control over the asynchronous operations.

10,027

The little ASGI framework that shines. 🌟

Pros of Starlette

  • Lightweight and minimalist design, focusing on ASGI compatibility
  • Built-in support for WebSocket handling
  • Excellent performance, often outperforming aiohttp in benchmarks

Cons of Starlette

  • Less mature ecosystem compared to aiohttp
  • Fewer built-in features, requiring additional libraries for some functionalities
  • Steeper learning curve for developers new to ASGI

Code Comparison

Starlette

from starlette.applications import Starlette
from starlette.responses import JSONResponse
from starlette.routing import Route

async def homepage(request):
    return JSONResponse({"message": "Hello, World!"})

app = Starlette(routes=[Route("/", homepage)])

aiohttp

from aiohttp import web

async def homepage(request):
    return web.json_response({"message": "Hello, World!"})

app = web.Application()
app.add_routes([web.get('/', homepage)])

Both frameworks offer similar functionality for creating web applications, but Starlette's approach is more focused on ASGI compatibility and routing, while aiohttp provides a more traditional web framework structure. Starlette's code tends to be more concise, while aiohttp offers more built-in features out of the box.

2,887

An async Python micro framework for building web applications.

Pros of Quart

  • Flask-like API, making it easier for Flask developers to transition
  • Built-in WebSocket support
  • Supports ASGI, allowing for easier deployment on modern servers

Cons of Quart

  • Smaller community and ecosystem compared to aiohttp
  • Less mature and potentially less stable
  • Fewer built-in features for complex HTTP client operations

Code Comparison

Quart example:

from quart import Quart

app = Quart(__name__)

@app.route('/')
async def hello():
    return 'Hello, World!'

aiohttp example:

from aiohttp import web

async def hello(request):
    return web.Response(text='Hello, World!')

app = web.Application()
app.add_routes([web.get('/', hello)])

Both aiohttp and Quart are asynchronous web frameworks for Python, but they have different focuses and design philosophies. aiohttp is a more general-purpose library that includes both client and server functionalities, while Quart is specifically designed to be an asynchronous alternative to Flask.

aiohttp offers more flexibility and control over low-level details, making it suitable for complex applications that require fine-tuning. It has a larger community and more extensive documentation, which can be beneficial for troubleshooting and finding resources.

Quart, on the other hand, provides a more familiar API for Flask developers, potentially easing the transition to asynchronous programming. Its built-in WebSocket support and ASGI compatibility make it attractive for developers working on real-time applications or looking to deploy on modern server setups.

Convert Figma logo designs to code with AI

Visual Copilot

Introducing Visual Copilot: A new AI model to turn Figma designs to high quality code using your components.

Try Visual Copilot

README

================================== Async http client/server framework

.. image:: https://raw.githubusercontent.com/aio-libs/aiohttp/master/docs/aiohttp-plain.svg :height: 64px :width: 64px :alt: aiohttp logo

|

.. image:: https://github.com/aio-libs/aiohttp/workflows/CI/badge.svg :target: https://github.com/aio-libs/aiohttp/actions?query=workflow%3ACI :alt: GitHub Actions status for master branch

.. image:: https://codecov.io/gh/aio-libs/aiohttp/branch/master/graph/badge.svg :target: https://codecov.io/gh/aio-libs/aiohttp :alt: codecov.io status for master branch

.. image:: https://badge.fury.io/py/aiohttp.svg :target: https://pypi.org/project/aiohttp :alt: Latest PyPI package version

.. image:: https://img.shields.io/pypi/dm/aiohttp :target: https://pypistats.org/packages/aiohttp :alt: Downloads count

.. image:: https://readthedocs.org/projects/aiohttp/badge/?version=latest :target: https://docs.aiohttp.org/ :alt: Latest Read The Docs

.. image:: https://img.shields.io/matrix/aio-libs:matrix.org?label=Discuss%20on%20Matrix%20at%20%23aio-libs%3Amatrix.org&logo=matrix&server_fqdn=matrix.org&style=flat :target: https://matrix.to/#/%23aio-libs:matrix.org :alt: Matrix Room — #aio-libs:matrix.org

.. image:: https://img.shields.io/matrix/aio-libs-space:matrix.org?label=Discuss%20on%20Matrix%20at%20%23aio-libs-space%3Amatrix.org&logo=matrix&server_fqdn=matrix.org&style=flat :target: https://matrix.to/#/%23aio-libs-space:matrix.org :alt: Matrix Space — #aio-libs-space:matrix.org

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 middleware and pluggable routing.

Getting started

Client

To get something from the web:

.. code-block:: python

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], "...")

asyncio.run(main())

This prints:

.. code-block::

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

Coming from requests <https://requests.readthedocs.io/>_ ? Read why we need so many lines <https://aiohttp.readthedocs.io/en/latest/http_request_lifecycle.html>_.

Server

An example using a simple server:

.. code-block:: python

# 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

External links

  • Third party libraries <http://aiohttp.readthedocs.io/en/latest/third_party.html>_
  • Built with aiohttp <http://aiohttp.readthedocs.io/en/latest/built_with.html>_
  • Powered by aiohttp <http://aiohttp.readthedocs.io/en/latest/powered_by.html>_

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

Communication channels

aio-libs Discussions: https://github.com/aio-libs/aiohttp/discussions

Matrix: #aio-libs:matrix.org <https://matrix.to/#/#aio-libs:matrix.org>_

We support Stack Overflow <https://stackoverflow.com/questions/tagged/aiohttp>_. Please add aiohttp tag to your question there.

Requirements

  • multidict_
  • yarl_
  • frozenlist_

Optionally you may install the aiodns_ library (highly recommended for sake of speed).

.. _aiodns: https://pypi.python.org/pypi/aiodns .. _multidict: https://pypi.python.org/pypi/multidict .. _frozenlist: https://pypi.org/project/frozenlist/ .. _yarl: https://pypi.python.org/pypi/yarl

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