Skip to content

Latest commit

 

History

History
220 lines (142 loc) · 4.92 KB

index.rst

File metadata and controls

220 lines (142 loc) · 4.92 KB
Raw

Welcome to AIOHTTP

Asynchronous HTTP Client/Server for asyncio and Python.

Current version is .

Key Features

  • Supports both aiohttp-client and HTTP Server <aiohttp-web>.
  • Supports both Server WebSockets <aiohttp-web-websockets> and Client WebSockets <aiohttp-client-websockets> out-of-the-box without the Callback Hell.
  • Web-server has aiohttp-web-middlewares, aiohttp-web-signals and pluggable routing.

Library Installation

$ pip install aiohttp

You may want to install optional cchardet library as faster replacement for chardet:

$ pip install cchardet

For speeding up DNS resolving by client API you may install aiodns as well. This option is highly recommended:

$ pip install aiodns

Installing speedups altogether

The following will get you aiohttp along with chardet, aiodns and Brotli in one bundle. No need to type separate commands anymore!

$ pip install aiohttp[speedups]

Getting Started

Client example:

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 example:

from aiohttp import web

async def handle(request):
    name = request.match_info.get('name', "Anonymous")
    text = "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)

For more information please visit aiohttp-client and aiohttp-web pages.

What's new in aiohttp 3?

Go to aiohttp_whats_new_3_0 page for aiohttp 3.0 major release changes.

Tutorial

Polls tutorial <aiohttp-demos-polls-beginning>

Source code

The project is hosted on GitHub

Please feel free to file an issue on the bug tracker if you have found a bug or have some suggestion in order to improve the library.

The library uses Travis for Continuous Integration.

Dependencies

  • Python 3.5.3+
  • async_timeout
  • attrs
  • chardet
  • multidict
  • yarl

  • Optional cchardet as faster replacement for chardet.

    Install it explicitly via:

    $ pip install cchardet

  • Optional aiodns for fast DNS resolving. The library is highly recommended.

    $ pip install aiodns

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.

Contributing

Please read the instructions for contributors<aiohttp-contributing> before making a Pull Request.

Authors and License

The aiohttp package is written mostly by Nikolay Kim and Andrew Svetlov.

It's Apache 2 licensed and freely available.

Feel free to improve this package and send a pull request to GitHub.

Policy for Backward Incompatible Changes

aiohttp keeps backward compatibility.

After deprecating some Public API (method, class, function argument, etc.) the library guarantees the usage of deprecated API is still allowed at least for a year and half after publishing new release with deprecation.

All deprecations are reflected in documentation and raises DeprecationWarning.

Sometimes we are forced to break our own rule for the sake of very strong reason. Most likely the reason is a critical bug which cannot be solved without major API change, but we are working hard for keeping these changes as rare as possible.

Table Of Contents

client web utilities faq misc external contributing