Skip to content

Commit

Permalink
Clarified API change on connection handlers.
Browse files Browse the repository at this point in the history
  • Loading branch information
aaugustin committed Nov 6, 2021
1 parent b240c04 commit b4d9a2a
Showing 1 changed file with 17 additions and 3 deletions.
20 changes: 17 additions & 3 deletions docs/project/changelog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,16 +30,30 @@ They may change at any time.

*In development*

Improvements
New features
............

* Added wheels for Python 3.10, PyPy 3.7, and for more platforms.

* Made the second parameter of connection handlers optional. It will be
deprecated in the next major release. The request path is available in
the :attr:`~legacy.protocol.WebSocketCommonProtocol.path` attribute of
the first argument.

If you implemented the connection handler of a server as::

async def handler(request, path):
...

You should replace it by::

async def handler(request):
path = request.path # if handler() uses the path argument
...

Improvements
............

* Added wheels for Python 3.10, PyPy 3.7, and for more platforms.

* Reverted optimization of default compression settings for clients, mainly to
avoid triggering bugs in poorly implemented servers like `AWS API Gateway`_.

Expand Down

0 comments on commit b4d9a2a

Please sign in to comment.