You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
433 lines
17 KiB
433 lines
17 KiB
Metadata-Version: 2.1
|
|
Name: aiohttp
|
|
Version: 3.5.4
|
|
Summary: Async http client/server framework (asyncio)
|
|
Home-page: https://github.com/aio-libs/aiohttp
|
|
Author: Nikolay Kim
|
|
Author-email: fafhrd91@gmail.com
|
|
Maintainer: Nikolay Kim <fafhrd91@gmail.com>, Andrew Svetlov <andrew.svetlov@gmail.com>
|
|
Maintainer-email: aio-libs@googlegroups.com
|
|
License: Apache 2
|
|
Project-URL: CI: Travis, https://travis-ci.com/aio-libs/aiohttp
|
|
Project-URL: CI: Circle, https://circleci.com/gh/aio-libs/aiohttp
|
|
Project-URL: CI: Shippable, https://app.shippable.com/github/aio-libs/aiohttp
|
|
Project-URL: GitHub: issues, https://github.com/aio-libs/aiohttp/issues
|
|
Project-URL: Docs: RTD, https://docs.aiohttp.org
|
|
Project-URL: Coverage: codecov, https://codecov.io/github/aio-libs/aiohttp
|
|
Project-URL: CI: AppVeyor, https://ci.appveyor.com/project/aio-libs/aiohttp
|
|
Project-URL: GitHub: repo, https://github.com/aio-libs/aiohttp
|
|
Project-URL: Chat: Gitter, https://gitter.im/aio-libs/Lobby
|
|
Platform: UNKNOWN
|
|
Classifier: License :: OSI Approved :: Apache Software License
|
|
Classifier: Intended Audience :: Developers
|
|
Classifier: Programming Language :: Python
|
|
Classifier: Programming Language :: Python :: 3
|
|
Classifier: Programming Language :: Python :: 3.5
|
|
Classifier: Programming Language :: Python :: 3.6
|
|
Classifier: Programming Language :: Python :: 3.7
|
|
Classifier: Development Status :: 5 - Production/Stable
|
|
Classifier: Operating System :: POSIX
|
|
Classifier: Operating System :: MacOS :: MacOS X
|
|
Classifier: Operating System :: Microsoft :: Windows
|
|
Classifier: Topic :: Internet :: WWW/HTTP
|
|
Classifier: Framework :: AsyncIO
|
|
Requires-Python: >=3.5.3
|
|
Requires-Dist: attrs (>=17.3.0)
|
|
Requires-Dist: chardet (<4.0,>=2.0)
|
|
Requires-Dist: multidict (<5.0,>=4.0)
|
|
Requires-Dist: async-timeout (<4.0,>=3.0)
|
|
Requires-Dist: yarl (<2.0,>=1.0)
|
|
Requires-Dist: idna-ssl (>=1.0) ; python_version < "3.7"
|
|
Requires-Dist: typing-extensions (>=3.6.5) ; python_version < "3.7"
|
|
Provides-Extra: speedups
|
|
Requires-Dist: aiodns ; extra == 'speedups'
|
|
Requires-Dist: brotlipy ; extra == 'speedups'
|
|
Requires-Dist: cchardet ; extra == 'speedups'
|
|
|
|
==================================
|
|
Async http client/server framework
|
|
==================================
|
|
|
|
.. image:: https://raw.githubusercontent.com/aio-libs/aiohttp/master/docs/_static/aiohttp-icon-128x128.png
|
|
:height: 64px
|
|
:width: 64px
|
|
:alt: aiohttp logo
|
|
|
|
|
|
|
|
|
.. image:: https://travis-ci.com/aio-libs/aiohttp.svg?branch=master
|
|
:target: https://travis-ci.com/aio-libs/aiohttp
|
|
:align: right
|
|
:alt: Travis status for master branch
|
|
|
|
.. image:: https://ci.appveyor.com/api/projects/status/tnddy9k6pphl8w7k/branch/master?svg=true
|
|
:target: https://ci.appveyor.com/project/aio-libs/aiohttp
|
|
:align: right
|
|
:alt: AppVeyor 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://readthedocs.org/projects/aiohttp/badge/?version=latest
|
|
:target: https://docs.aiohttp.org/
|
|
:alt: Latest Read The Docs
|
|
|
|
.. image:: https://badges.gitter.im/Join%20Chat.svg
|
|
:target: https://gitter.im/aio-libs/Lobby
|
|
:alt: 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 pluggable routing.
|
|
|
|
|
|
Getting started
|
|
===============
|
|
|
|
Client
|
|
------
|
|
|
|
To get something from the web:
|
|
|
|
.. code-block:: python
|
|
|
|
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
|
|
------
|
|
|
|
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)])
|
|
|
|
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* 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
|
|
<https://stackoverflow.com/questions/tagged/aiohttp>`_.
|
|
Please add *aiohttp* tag to your question there.
|
|
|
|
Requirements
|
|
============
|
|
|
|
- Python >= 3.5.3
|
|
- async-timeout_
|
|
- attrs_
|
|
- chardet_
|
|
- multidict_
|
|
- yarl_
|
|
|
|
Optionally you may install the cChardet_ and aiodns_ libraries (highly
|
|
recommended for sake of speed).
|
|
|
|
.. _chardet: https://pypi.python.org/pypi/chardet
|
|
.. _aiodns: https://pypi.python.org/pypi/aiodns
|
|
.. _attrs: https://github.com/python-attrs/attrs
|
|
.. _multidict: https://pypi.python.org/pypi/multidict
|
|
.. _yarl: https://pypi.python.org/pypi/yarl
|
|
.. _async-timeout: https://pypi.python.org/pypi/async_timeout
|
|
.. _cChardet: https://pypi.python.org/pypi/cchardet
|
|
|
|
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
|
|
|
|
=========
|
|
Changelog
|
|
=========
|
|
|
|
..
|
|
You should *NOT* be adding new change log entries to this file, this
|
|
file is managed by towncrier. You *may* edit previous change logs to
|
|
fix problems like typo corrections or such.
|
|
To add a new change log entry, please see
|
|
https://pip.pypa.io/en/latest/development/#adding-a-news-entry
|
|
we named the news folder "changes".
|
|
|
|
WARNING: Don't drop the next directive!
|
|
|
|
.. towncrier release notes start
|
|
|
|
3.5.4 (2019-01-12)
|
|
==================
|
|
|
|
Bugfixes
|
|
--------
|
|
|
|
- Fix stream ``.read()`` / ``.readany()`` / ``.iter_any()`` which used to return a
|
|
partial content only in case of compressed content
|
|
`#3525 <https://github.com/aio-libs/aiohttp/issues/3525>`_
|
|
|
|
|
|
3.5.3 (2019-01-10)
|
|
==================
|
|
|
|
Bugfixes
|
|
--------
|
|
|
|
- Fix type stubs for ``aiohttp.web.run_app(access_log=True)`` and fix edge case of ``access_log=True`` and the event loop being in debug mode.
|
|
`#3504 <https://github.com/aio-libs/aiohttp/issues/3504>`_
|
|
- Fix ``aiohttp.ClientTimeout`` type annotations to accept ``None`` for fields
|
|
`#3511 <https://github.com/aio-libs/aiohttp/issues/3511>`_
|
|
- Send custom per-request cookies even if session jar is empty
|
|
`#3515 <https://github.com/aio-libs/aiohttp/issues/3515>`_
|
|
- Restore Linux binary wheels publishing on PyPI
|
|
|
|
----
|
|
|
|
|
|
3.5.2 (2019-01-08)
|
|
==================
|
|
|
|
Features
|
|
--------
|
|
|
|
- ``FileResponse`` from ``web_fileresponse.py`` uses a ``ThreadPoolExecutor`` to work with files asynchronously.
|
|
I/O based payloads from ``payload.py`` uses a ``ThreadPoolExecutor`` to work with I/O objects asynchronously.
|
|
`#3313 <https://github.com/aio-libs/aiohttp/issues/3313>`_
|
|
- Internal Server Errors in plain text if the browser does not support HTML.
|
|
`#3483 <https://github.com/aio-libs/aiohttp/issues/3483>`_
|
|
|
|
|
|
Bugfixes
|
|
--------
|
|
|
|
- Preserve MultipartWriter parts headers on write.
|
|
|
|
Refactor the way how ``Payload.headers`` are handled. Payload instances now always
|
|
have headers and Content-Type defined.
|
|
|
|
Fix Payload Content-Disposition header reset after initial creation.
|
|
`#3035 <https://github.com/aio-libs/aiohttp/issues/3035>`_
|
|
- Log suppressed exceptions in ``GunicornWebWorker``.
|
|
`#3464 <https://github.com/aio-libs/aiohttp/issues/3464>`_
|
|
- Remove wildcard imports.
|
|
`#3468 <https://github.com/aio-libs/aiohttp/issues/3468>`_
|
|
- Use the same task for app initialization and web server handling in gunicorn workers.
|
|
It allows to use Python3.7 context vars smoothly.
|
|
`#3471 <https://github.com/aio-libs/aiohttp/issues/3471>`_
|
|
- Fix handling of chunked+gzipped response when first chunk does not give uncompressed data
|
|
`#3477 <https://github.com/aio-libs/aiohttp/issues/3477>`_
|
|
- Replace ``collections.MutableMapping`` with ``collections.abc.MutableMapping`` to avoid a deprecation warning.
|
|
`#3480 <https://github.com/aio-libs/aiohttp/issues/3480>`_
|
|
- ``Payload.size`` type annotation changed from `Optional[float]` to `Optional[int]`.
|
|
`#3484 <https://github.com/aio-libs/aiohttp/issues/3484>`_
|
|
- Ignore done tasks when cancels pending activities on ``web.run_app`` finalization.
|
|
`#3497 <https://github.com/aio-libs/aiohttp/issues/3497>`_
|
|
|
|
|
|
Improved Documentation
|
|
----------------------
|
|
|
|
- Add documentation for ``aiohttp.web.HTTPException``.
|
|
`#3490 <https://github.com/aio-libs/aiohttp/issues/3490>`_
|
|
|
|
|
|
Misc
|
|
----
|
|
|
|
- `#3487 <https://github.com/aio-libs/aiohttp/issues/3487>`_
|
|
|
|
|
|
----
|
|
|
|
|
|
3.5.1 (2018-12-24)
|
|
====================
|
|
|
|
- Fix a regression about ``ClientSession._requote_redirect_url`` modification in debug
|
|
mode.
|
|
|
|
3.5.0 (2018-12-22)
|
|
====================
|
|
|
|
Features
|
|
--------
|
|
|
|
- The library type annotations are checked in strict mode now.
|
|
- Add support for setting cookies for individual request (`#2387 <https://github.com/aio-libs/aiohttp/pull/2387>`_)
|
|
- Application.add_domain implementation (`#2809 <https://github.com/aio-libs/aiohttp/pull/2809>`_)
|
|
- The default ``app`` in the request returned by ``test_utils.make_mocked_request``
|
|
can now have objects assigned to it and retrieved using the ``[]`` operator. (`#3174 <https://github.com/aio-libs/aiohttp/pull/3174>`_)
|
|
- Make ``request.url`` accessible when transport is closed. (`#3177 <https://github.com/aio-libs/aiohttp/pull/3177>`_)
|
|
- Add ``zlib_executor_size`` argument to ``Response`` constructor to allow compression to run in a background executor to avoid blocking the main thread and potentially triggering health check failures. (`#3205 <https://github.com/aio-libs/aiohttp/pull/3205>`_)
|
|
- Enable users to set `ClientTimeout` in `aiohttp.request` (`#3213 <https://github.com/aio-libs/aiohttp/pull/3213>`_)
|
|
- Don't raise a warning if ``NETRC`` environment variable is not set and ``~/.netrc`` file
|
|
doesn't exist. (`#3267 <https://github.com/aio-libs/aiohttp/pull/3267>`_)
|
|
- Add default logging handler to web.run_app
|
|
|
|
If the `Application.debug` flag is set and the default logger `aiohttp.access` is used, access logs will now be output using a `stderr` `StreamHandler` if no handlers are attached. Furthermore, if the default logger has no log level set, the log level will be set to `DEBUG`. (`#3324 <https://github.com/aio-libs/aiohttp/pull/3324>`_)
|
|
- Add method argument to ``session.ws_connect()``.
|
|
|
|
Sometimes server API requires a different HTTP method for WebSocket connection establishment.
|
|
|
|
For example, ``Docker exec`` needs POST. (`#3378 <https://github.com/aio-libs/aiohttp/pull/3378>`_)
|
|
- Create a task per request handling. (`#3406 <https://github.com/aio-libs/aiohttp/pull/3406>`_)
|
|
|
|
|
|
Bugfixes
|
|
--------
|
|
|
|
- Enable passing `access_log_class` via `handler_args` (`#3158 <https://github.com/aio-libs/aiohttp/pull/3158>`_)
|
|
- Return empty bytes with end-of-chunk marker in empty stream reader. (`#3186 <https://github.com/aio-libs/aiohttp/pull/3186>`_)
|
|
- Accept ``CIMultiDictProxy`` instances for ``headers`` argument in ``web.Response``
|
|
constructor. (`#3207 <https://github.com/aio-libs/aiohttp/pull/3207>`_)
|
|
- Don't uppercase HTTP method in parser (`#3233 <https://github.com/aio-libs/aiohttp/pull/3233>`_)
|
|
- Make method match regexp RFC-7230 compliant (`#3235 <https://github.com/aio-libs/aiohttp/pull/3235>`_)
|
|
- Add ``app.pre_frozen`` state to properly handle startup signals in sub-applications. (`#3237 <https://github.com/aio-libs/aiohttp/pull/3237>`_)
|
|
- Enhanced parsing and validation of helpers.BasicAuth.decode. (`#3239 <https://github.com/aio-libs/aiohttp/pull/3239>`_)
|
|
- Change imports from collections module in preparation for 3.8. (`#3258 <https://github.com/aio-libs/aiohttp/pull/3258>`_)
|
|
- Ensure Host header is added first to ClientRequest to better replicate browser (`#3265 <https://github.com/aio-libs/aiohttp/pull/3265>`_)
|
|
- Fix forward compatibility with Python 3.8: importing ABCs directly from the collections module will not be supported anymore. (`#3273 <https://github.com/aio-libs/aiohttp/pull/3273>`_)
|
|
- Keep the query string by `normalize_path_middleware`. (`#3278 <https://github.com/aio-libs/aiohttp/pull/3278>`_)
|
|
- Fix missing parameter ``raise_for_status`` for aiohttp.request() (`#3290 <https://github.com/aio-libs/aiohttp/pull/3290>`_)
|
|
- Bracket IPv6 addresses in the HOST header (`#3304 <https://github.com/aio-libs/aiohttp/pull/3304>`_)
|
|
- Fix default message for server ping and pong frames. (`#3308 <https://github.com/aio-libs/aiohttp/pull/3308>`_)
|
|
- Fix tests/test_connector.py typo and tests/autobahn/server.py duplicate loop def. (`#3337 <https://github.com/aio-libs/aiohttp/pull/3337>`_)
|
|
- Fix false-negative indicator end_of_HTTP_chunk in StreamReader.readchunk function (`#3361 <https://github.com/aio-libs/aiohttp/pull/3361>`_)
|
|
- Release HTTP response before raising status exception (`#3364 <https://github.com/aio-libs/aiohttp/pull/3364>`_)
|
|
- Fix task cancellation when ``sendfile()`` syscall is used by static file handling. (`#3383 <https://github.com/aio-libs/aiohttp/pull/3383>`_)
|
|
- Fix stack trace for ``asyncio.TimeoutError`` which was not logged, when it is caught
|
|
in the handler. (`#3414 <https://github.com/aio-libs/aiohttp/pull/3414>`_)
|
|
|
|
|
|
Improved Documentation
|
|
----------------------
|
|
|
|
- Improve documentation of ``Application.make_handler`` parameters. (`#3152 <https://github.com/aio-libs/aiohttp/pull/3152>`_)
|
|
- Fix BaseRequest.raw_headers doc. (`#3215 <https://github.com/aio-libs/aiohttp/pull/3215>`_)
|
|
- Fix typo in TypeError exception reason in ``web.Application._handle`` (`#3229 <https://github.com/aio-libs/aiohttp/pull/3229>`_)
|
|
- Make server access log format placeholder %b documentation reflect
|
|
behavior and docstring. (`#3307 <https://github.com/aio-libs/aiohttp/pull/3307>`_)
|
|
|
|
|
|
Deprecations and Removals
|
|
-------------------------
|
|
|
|
- Deprecate modification of ``session.requote_redirect_url`` (`#2278 <https://github.com/aio-libs/aiohttp/pull/2278>`_)
|
|
- Deprecate ``stream.unread_data()`` (`#3260 <https://github.com/aio-libs/aiohttp/pull/3260>`_)
|
|
- Deprecated use of boolean in ``resp.enable_compression()`` (`#3318 <https://github.com/aio-libs/aiohttp/pull/3318>`_)
|
|
- Encourage creation of aiohttp public objects inside a coroutine (`#3331 <https://github.com/aio-libs/aiohttp/pull/3331>`_)
|
|
- Drop dead ``Connection.detach()`` and ``Connection.writer``. Both methods were broken
|
|
for more than 2 years. (`#3358 <https://github.com/aio-libs/aiohttp/pull/3358>`_)
|
|
- Deprecate ``app.loop``, ``request.loop``, ``client.loop`` and ``connector.loop`` properties. (`#3374 <https://github.com/aio-libs/aiohttp/pull/3374>`_)
|
|
- Deprecate explicit debug argument. Use asyncio debug mode instead. (`#3381 <https://github.com/aio-libs/aiohttp/pull/3381>`_)
|
|
- Deprecate body parameter in HTTPException (and derived classes) constructor. (`#3385 <https://github.com/aio-libs/aiohttp/pull/3385>`_)
|
|
- Deprecate bare connector close, use ``async with connector:`` and ``await connector.close()`` instead. (`#3417 <https://github.com/aio-libs/aiohttp/pull/3417>`_)
|
|
- Deprecate obsolete ``read_timeout`` and ``conn_timeout`` in ``ClientSession`` constructor. (`#3438 <https://github.com/aio-libs/aiohttp/pull/3438>`_)
|
|
|
|
|
|
Misc
|
|
----
|
|
|
|
- #3341, #3351
|
|
|