| | Metadata-Version: 2.1 |
| | Name: aiohttp |
| | Version: 3.11.11 |
| | Summary: Async http client/server framework (asyncio) |
| | Home-page: https://github.com/aio-libs/aiohttp |
| | Maintainer: aiohttp team <team@aiohttp.org> |
| | Maintainer-email: team@aiohttp.org |
| | License: Apache-2.0 |
| | Project-URL: Chat: Matrix, https://matrix.to/#/#aio-libs:matrix.org |
| | Project-URL: Chat: Matrix Space, https://matrix.to/#/#aio-libs-space:matrix.org |
| | Project-URL: CI: GitHub Actions, https://github.com/aio-libs/aiohttp/actions?query=workflow%3ACI |
| | Project-URL: Coverage: codecov, https://codecov.io/github/aio-libs/aiohttp |
| | Project-URL: Docs: Changelog, https://docs.aiohttp.org/en/stable/changes.html |
| | Project-URL: Docs: RTD, https://docs.aiohttp.org |
| | Project-URL: GitHub: issues, https://github.com/aio-libs/aiohttp/issues |
| | Project-URL: GitHub: repo, https://github.com/aio-libs/aiohttp |
| | Classifier: Development Status :: 5 - Production/Stable |
| | Classifier: Framework :: AsyncIO |
| | Classifier: Intended Audience :: Developers |
| | Classifier: License :: OSI Approved :: Apache Software License |
| | Classifier: Operating System :: POSIX |
| | Classifier: Operating System :: MacOS :: MacOS X |
| | Classifier: Operating System :: Microsoft :: Windows |
| | Classifier: Programming Language :: Python |
| | Classifier: Programming Language :: Python :: 3 |
| | Classifier: Programming Language :: Python :: 3.9 |
| | Classifier: Programming Language :: Python :: 3.10 |
| | Classifier: Programming Language :: Python :: 3.11 |
| | Classifier: Programming Language :: Python :: 3.12 |
| | Classifier: Programming Language :: Python :: 3.13 |
| | Classifier: Topic :: Internet :: WWW/HTTP |
| | Requires-Python: >=3.9 |
| | Description-Content-Type: text/x-rst |
| | License-File: LICENSE.txt |
| | Requires-Dist: aiohappyeyeballs>=2.3.0 |
| | Requires-Dist: aiosignal>=1.1.2 |
| | Requires-Dist: async-timeout<6.0,>=4.0; python_version < "3.11" |
| | Requires-Dist: attrs>=17.3.0 |
| | Requires-Dist: frozenlist>=1.1.1 |
| | Requires-Dist: multidict<7.0,>=4.5 |
| | Requires-Dist: propcache>=0.2.0 |
| | Requires-Dist: yarl<2.0,>=1.17.0 |
| | Provides-Extra: speedups |
| | Requires-Dist: aiodns>=3.2.0; (sys_platform == "linux" or sys_platform == "darwin") and extra == "speedups" |
| | Requires-Dist: Brotli; platform_python_implementation == "CPython" and extra == "speedups" |
| | Requires-Dist: brotlicffi; platform_python_implementation != "CPython" and extra == "speedups" |
| |
|
| | ================================== |
| | 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://img.shields.io/endpoint?url=https://codspeed.io/badge.json |
| | :target: https://codspeed.io/aio-libs/aiohttp |
| | :alt: Codspeed.io status for aiohttp |
| |
|
| | .. image:: https://badge.fury.io/py/aiohttp.svg |
| | :target: https://pypi.org/project/aiohttp |
| | :alt: Latest PyPI package version |
| |
|
| | .. 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 |
| |
|
| | |
| | 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 |
| | ============ |
| |
|
| | - attrs_ |
| | - multidict_ |
| | - yarl_ |
| | - frozenlist_ |
| |
|
| | Optionally you may install the aiodns_ library (highly recommended for sake of speed). |
| |
|
| | .. _aiodns: https://pypi.python.org/pypi/aiodns |
| | .. _attrs: https://github.com/python-attrs/attrs |
| | .. _multidict: https://pypi.python.org/pypi/multidict |
| | .. _frozenlist: https://pypi.org/project/frozenlist/ |
| | .. _yarl: https://pypi.python.org/pypi/yarl |
| | .. _async-timeout: https://pypi.python.org/pypi/async_timeout |
| |
|
| | 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 |
| |
|
