`_
-.. _Start here: https://websockets.readthedocs.io/en/stable/intro.html
+.. raw:: html
+
+ websockets for enterprise Available as part of the Tidelift Subscription
+ The maintainers of websockets and thousands of other packages are working with Tidelift to deliver commercial support and maintenance for the open source dependencies you use to build your applications. Save time, reduce risk, and improve code health, while paying the maintainers of the exact dependencies you use. Learn more.
+ (If you contribute to websockets and would like to become an official support provider, let me know .)
Why should I use ``websockets``?
--------------------------------
@@ -99,16 +110,9 @@ The development of ``websockets`` is shaped by four principles:
Documentation is a first class concern in the project. Head over to `Read the
Docs`_ and see for yourself.
-Professional support is available if you — or your company — are so inclined.
-`Get in touch`_.
-
-(If you contribute to ``websockets`` and would like to become an official
-support provider, let me know.)
-
.. _Read the Docs: https://websockets.readthedocs.io/
.. _handle backpressure correctly: https://vorpus.org/blog/some-thoughts-on-asynchronous-api-design-in-a-post-asyncawait-world/#websocket-servers
.. _Autobahn Testsuite: https://github.com/aaugustin/websockets/blob/master/compliance/README.rst
-.. _Get in touch: https://fractalideas.com/
Why shouldn't I use ``websockets``?
-----------------------------------
@@ -121,17 +125,27 @@ Why shouldn't I use ``websockets``?
and :rfc:`7692`: Compression Extensions for WebSocket. Its support for HTTP
is minimal — just enough for a HTTP health check.
* If you want to use Python 2: ``websockets`` builds upon ``asyncio`` which
- only works on Python 3. ``websockets`` requires Python ≥ 3.4.
+ only works on Python 3. ``websockets`` requires Python ≥ 3.6.1.
What else?
----------
-Bug reports, patches and suggestions welcome! Just open an issue_ or send a
-`pull request`_.
+Bug reports, patches and suggestions are welcome!
+
+To report a security vulnerability, please use the `Tidelift security
+contact`_. Tidelift will coordinate the fix and disclosure.
+
+.. _Tidelift security contact: https://tidelift.com/security
+
+For anything else, please open an issue_ or send a `pull request`_.
.. _issue: https://github.com/aaugustin/websockets/issues/new
.. _pull request: https://github.com/aaugustin/websockets/compare/
+Participants must uphold the `Contributor Covenant code of conduct`_.
+
+.. _Contributor Covenant code of conduct: https://github.com/aaugustin/websockets/blob/master/CODE_OF_CONDUCT.md
+
``websockets`` is released under the `BSD license`_.
-.. _BSD license: https://websockets.readthedocs.io/en/stable/license.html
+.. _BSD license: https://github.com/aaugustin/websockets/blob/master/LICENSE
diff --git a/compliance/README.rst b/compliance/README.rst
index cbb4ca2c7..8570f9176 100644
--- a/compliance/README.rst
+++ b/compliance/README.rst
@@ -30,8 +30,8 @@ Then kill the first one with Ctrl-C.
The test client or server shouldn't display any exceptions. The results are
stored in reports/clients/index.html.
-Note that the Autobahn software only supports Python 2, while websockets only
-supports Python 3; you need two different environments.
+Note that the Autobahn software only supports Python 2, while ``websockets``
+only supports Python 3; you need two different environments.
Conformance notes
-----------------
diff --git a/compliance/test_client.py b/compliance/test_client.py
index 382d06a05..5fd0f4b4f 100644
--- a/compliance/test_client.py
+++ b/compliance/test_client.py
@@ -12,46 +12,37 @@
# logging.getLogger('websockets').setLevel(logging.DEBUG)
-SERVER = 'ws://127.0.0.1:8642'
-AGENT = 'websockets'
+SERVER = "ws://127.0.0.1:8642"
+AGENT = "websockets"
-@asyncio.coroutine
-def get_case_count(server):
- uri = server + '/getCaseCount'
- ws = yield from websockets.connect(uri)
- msg = yield from ws.recv()
- yield from ws.close()
+async def get_case_count(server):
+ uri = f"{server}/getCaseCount"
+ async with websockets.connect(uri) as ws:
+ msg = ws.recv()
return json.loads(msg)
-@asyncio.coroutine
-def run_case(server, case, agent):
- uri = server + '/runCase?case={}&agent={}'.format(case, agent)
- ws = yield from websockets.connect(uri, max_size=2 ** 25, max_queue=1)
- while True:
- try:
- msg = yield from ws.recv()
- yield from ws.send(msg)
- except websockets.ConnectionClosed:
- break
+async def run_case(server, case, agent):
+ uri = f"{server}/runCase?case={case}&agent={agent}"
+ async with websockets.connect(uri, max_size=2 ** 25, max_queue=1) as ws:
+ async for msg in ws:
+ await ws.send(msg)
-@asyncio.coroutine
-def update_reports(server, agent):
- uri = server + '/updateReports?agent={}'.format(agent)
- ws = yield from websockets.connect(uri)
- yield from ws.close()
+async def update_reports(server, agent):
+ uri = f"{server}/updateReports?agent={agent}"
+ async with websockets.connect(uri):
+ pass
-@asyncio.coroutine
-def run_tests(server, agent):
- cases = yield from get_case_count(server)
+async def run_tests(server, agent):
+ cases = await get_case_count(server)
for case in range(1, cases + 1):
- print("Running test case {} out of {}".format(case, cases), end="\r")
- yield from run_case(server, case, agent)
- print("Ran {} test cases ".format(cases))
- yield from update_reports(server, agent)
+ print(f"Running test case {case} out of {cases}", end="\r")
+ await run_case(server, case, agent)
+ print(f"Ran {cases} test cases ")
+ await update_reports(server, agent)
main = run_tests(SERVER, urllib.parse.quote(AGENT))
diff --git a/compliance/test_server.py b/compliance/test_server.py
index 75e0e3044..8020f68d3 100644
--- a/compliance/test_server.py
+++ b/compliance/test_server.py
@@ -10,18 +10,15 @@
# logging.getLogger('websockets').setLevel(logging.DEBUG)
-@asyncio.coroutine
-def echo(ws, path):
- while True:
- try:
- msg = yield from ws.recv()
- yield from ws.send(msg)
- except websockets.ConnectionClosed:
- break
-
-
-start_server = websockets.serve(
- echo, '127.0.0.1', 8642, max_size=2 ** 25, max_queue=1)
+HOST, PORT = "127.0.0.1", 8642
+
+
+async def echo(ws, path):
+ async for msg in ws:
+ await ws.send(msg)
+
+
+start_server = websockets.serve(echo, HOST, PORT, max_size=2 ** 25, max_queue=1)
try:
asyncio.get_event_loop().run_until_complete(start_server)
diff --git a/docs/_static/tidelift.png b/docs/_static/tidelift.png
new file mode 120000
index 000000000..2d1ed4a2c
--- /dev/null
+++ b/docs/_static/tidelift.png
@@ -0,0 +1 @@
+../../logo/tidelift.png
\ No newline at end of file
diff --git a/docs/_static/websockets.svg b/docs/_static/websockets.svg
deleted file mode 100644
index 409afb71d..000000000
--- a/docs/_static/websockets.svg
+++ /dev/null
@@ -1,16 +0,0 @@
-
-
-
-
-
-
diff --git a/docs/_static/websockets.svg b/docs/_static/websockets.svg
new file mode 120000
index 000000000..84c316758
--- /dev/null
+++ b/docs/_static/websockets.svg
@@ -0,0 +1 @@
+../../logo/vertical.svg
\ No newline at end of file
diff --git a/docs/api.rst b/docs/api.rst
deleted file mode 100644
index 3971ff8b4..000000000
--- a/docs/api.rst
+++ /dev/null
@@ -1,119 +0,0 @@
-API
-===
-
-Design
-------
-
-``websockets`` provides complete client and server implementations, as shown
-in the :doc:`getting started guide `. These functions are built on top
-of low-level APIs reflecting the two phases of the WebSocket protocol:
-
-1. An opening handshake, in the form of an HTTP Upgrade request;
-
-2. Data transfer, as framed messages, ending with a closing handshake.
-
-The first phase is designed to integrate with existing HTTP software.
-``websockets`` provides functions to build and validate the request and
-response headers.
-
-The second phase is the core of the WebSocket protocol. ``websockets``
-provides a standalone implementation on top of ``asyncio`` with a very simple
-API.
-
-For convenience, public APIs can be imported directly from the
-:mod:`websockets` package, unless noted otherwise. Anything that isn't listed
-in this document is a private API.
-
-High-level
-----------
-
-Server
-......
-
-.. automodule:: websockets.server
-
- .. autofunction:: serve(ws_handler, host=None, port=None, *, create_protocol=None, ping_interval=20, ping_timeout=20, close_timeout=10, max_size=2 ** 20, max_queue=2 ** 5, read_limit=2 ** 16, write_limit=2 ** 16, loop=None, compression='deflate', origins=None, extensions=None, subprotocols=None, extra_headers=None, process_request=None, select_subprotocol=None, **kwds)
-
- .. autofunction:: unix_serve(ws_handler, path, *, create_protocol=None, ping_interval=20, ping_timeout=20, close_timeout=10, max_size=2 ** 20, max_queue=2 ** 5, read_limit=2 ** 16, write_limit=2 ** 16, loop=None, compression='deflate', origins=None, extensions=None, subprotocols=None, extra_headers=None, process_request=None, select_subprotocol=None, **kwds)
-
-
- .. autoclass:: WebSocketServer
-
- .. automethod:: close()
- .. automethod:: wait_closed()
- .. autoattribute:: sockets
-
- .. autoclass:: WebSocketServerProtocol(ws_handler, ws_server, *, host=None, port=None, secure=None, ping_interval=20, ping_timeout=20, close_timeout=10, max_size=2 ** 20, max_queue=2 ** 5, read_limit=2 ** 16, write_limit=2 ** 16, loop=None, origins=None, extensions=None, subprotocols=None, extra_headers=None, process_request=None, select_subprotocol=None)
-
- .. automethod:: handshake(origins=None, available_extensions=None, available_subprotocols=None, extra_headers=None)
- .. automethod:: process_request(path, request_headers)
- .. automethod:: select_subprotocol(client_subprotocols, server_subprotocols)
-
-Client
-......
-
-.. automodule:: websockets.client
-
- .. autofunction:: connect(uri, *, create_protocol=None, ping_interval=20, ping_timeout=20, close_timeout=10, max_size=2 ** 20, max_queue=2 ** 5, read_limit=2 ** 16, write_limit=2 ** 16, loop=None, compression='deflate', origin=None, extensions=None, subprotocols=None, extra_headers=None, **kwds)
-
- .. autoclass:: WebSocketClientProtocol(*, host=None, port=None, secure=None, ping_interval=20, ping_timeout=20, close_timeout=10, max_size=2 ** 20, max_queue=2 ** 5, read_limit=2 ** 16, write_limit=2 ** 16, loop=None, origin=None, extensions=None, subprotocols=None, extra_headers=None)
-
- .. automethod:: handshake(wsuri, origin=None, available_extensions=None, available_subprotocols=None, extra_headers=None)
-
-Shared
-......
-
-.. automodule:: websockets.protocol
-
- .. autoclass:: WebSocketCommonProtocol(*, host=None, port=None, secure=None, ping_interval=20, ping_timeout=20, close_timeout=10, max_size=2 ** 20, max_queue=2 ** 5, read_limit=2 ** 16, write_limit=2 ** 16, loop=None)
-
- .. automethod:: close(code=1000, reason='')
- .. automethod:: wait_closed(code=1000, reason='')
-
- .. automethod:: recv()
- .. automethod:: send(data)
-
- .. automethod:: ping(data=None)
- .. automethod:: pong(data=b'')
-
- .. autoattribute:: local_address
- .. autoattribute:: remote_address
-
- .. autoattribute:: open
- .. autoattribute:: closed
-
-Exceptions
-..........
-
-.. automodule:: websockets.exceptions
- :members:
-
-Low-level
----------
-
-Opening handshake
-.................
-
-.. automodule:: websockets.handshake
- :members:
-
-Data transfer
-.............
-
-.. automodule:: websockets.framing
- :members:
-
-URI parser
-..........
-
-.. automodule:: websockets.uri
- :members:
-
-Utilities
-.........
-
-.. automodule:: websockets.headers
- :members:
-
-.. automodule:: websockets.http
- :members:
diff --git a/docs/api/client.rst b/docs/api/client.rst
new file mode 100644
index 000000000..db8cbc914
--- /dev/null
+++ b/docs/api/client.rst
@@ -0,0 +1,74 @@
+Client
+======
+
+.. automodule:: websockets.client
+
+ Opening a connection
+ --------------------
+
+ .. autofunction:: connect(uri, *, create_protocol=None, ping_interval=20, ping_timeout=20, close_timeout=10, max_size=2 ** 20, max_queue=2 ** 5, read_limit=2 ** 16, write_limit=2 ** 16, loop=None, compression='deflate', origin=None, extensions=None, subprotocols=None, extra_headers=None, **kwds)
+ :async:
+
+ .. autofunction:: unix_connect(path, uri="ws://localhost/", *, create_protocol=None, ping_interval=20, ping_timeout=20, close_timeout=10, max_size=2 ** 20, max_queue=2 ** 5, read_limit=2 ** 16, write_limit=2 ** 16, loop=None, compression='deflate', origin=None, extensions=None, subprotocols=None, extra_headers=None, **kwds)
+ :async:
+
+ Using a connection
+ ------------------
+
+ .. autoclass:: WebSocketClientProtocol(*, ping_interval=20, ping_timeout=20, close_timeout=10, max_size=2 ** 20, max_queue=2 ** 5, read_limit=2 ** 16, write_limit=2 ** 16, loop=None, origin=None, extensions=None, subprotocols=None, extra_headers=None)
+
+ .. autoattribute:: local_address
+
+ .. autoattribute:: remote_address
+
+ .. autoattribute:: open
+
+ .. autoattribute:: closed
+
+ .. attribute:: path
+
+ Path of the HTTP request.
+
+ Available once the connection is open.
+
+ .. attribute:: request_headers
+
+ HTTP request headers as a :class:`~websockets.http.Headers` instance.
+
+ Available once the connection is open.
+
+ .. attribute:: response_headers
+
+ HTTP response headers as a :class:`~websockets.http.Headers` instance.
+
+ Available once the connection is open.
+
+ .. attribute:: subprotocol
+
+ Subprotocol, if one was negotiated.
+
+ Available once the connection is open.
+
+ .. attribute:: close_code
+
+ WebSocket close code.
+
+ Available once the connection is closed.
+
+ .. attribute:: close_reason
+
+ WebSocket close reason.
+
+ Available once the connection is closed.
+
+ .. automethod:: recv
+
+ .. automethod:: send
+
+ .. automethod:: ping
+
+ .. automethod:: pong
+
+ .. automethod:: close
+
+ .. automethod:: wait_closed
diff --git a/docs/api/extensions.rst b/docs/api/extensions.rst
new file mode 100644
index 000000000..71f015bb2
--- /dev/null
+++ b/docs/api/extensions.rst
@@ -0,0 +1,26 @@
+Extensions
+==========
+
+Per-Message Deflate
+-------------------
+
+.. automodule:: websockets.extensions.permessage_deflate
+
+ .. autoclass:: ClientPerMessageDeflateFactory
+
+ .. autoclass:: ServerPerMessageDeflateFactory
+
+Abstract classes
+----------------
+
+.. automodule:: websockets.extensions
+
+ .. autoclass:: Extension
+ :members:
+
+ .. autoclass:: ClientExtensionFactory
+ :members:
+
+ .. autoclass:: ServerExtensionFactory
+ :members:
+
diff --git a/docs/api/index.rst b/docs/api/index.rst
new file mode 100644
index 000000000..0a616cbce
--- /dev/null
+++ b/docs/api/index.rst
@@ -0,0 +1,55 @@
+API
+===
+
+``websockets`` provides complete client and server implementations, as shown
+in the :doc:`getting started guide <../intro>`.
+
+The process for opening and closing a WebSocket connection depends on which
+side you're implementing.
+
+* On the client side, connecting to a server with :class:`~websockets.connect`
+ yields a connection object that provides methods for interacting with the
+ connection. Your code can open a connection, then send or receive messages.
+
+ If you use :class:`~websockets.connect` as an asynchronous context manager,
+ then websockets closes the connection on exit. If not, then your code is
+ responsible for closing the connection.
+
+* On the server side, :class:`~websockets.serve` starts listening for client
+ connections and yields an server object that supports closing the server.
+
+ Then, when clients connects, the server initializes a connection object and
+ passes it to a handler coroutine, which is where your code can send or
+ receive messages. This pattern is called `inversion of control`_. It's
+ common in frameworks implementing servers.
+
+ When the handler coroutine terminates, websockets closes the connection. You
+ may also close it in the handler coroutine if you'd like.
+
+.. _inversion of control: https://en.wikipedia.org/wiki/Inversion_of_control
+
+Once the connection is open, the WebSocket protocol is symmetrical, except for
+low-level details that websockets manages under the hood. The same methods are
+available on client connections created with :class:`~websockets.connect` and
+on server connections passed to the connection handler in the arguments.
+
+At this point, websockets provides the same API — and uses the same code — for
+client and server connections. For convenience, common methods are documented
+both in the client API and server API.
+
+.. toctree::
+ :maxdepth: 2
+
+ client
+ server
+ extensions
+ utilities
+
+All public APIs can be imported from the :mod:`websockets` package, unless
+noted otherwise. This convenience feature is incompatible with static code
+analysis tools such as mypy_, though.
+
+.. _mypy: https://github.com/python/mypy
+
+Anything that isn't listed in this API documentation is a private API. There's
+no guarantees of behavior or backwards-compatibility for private APIs.
diff --git a/docs/api/server.rst b/docs/api/server.rst
new file mode 100644
index 000000000..9e7b801a9
--- /dev/null
+++ b/docs/api/server.rst
@@ -0,0 +1,105 @@
+Server
+======
+
+.. automodule:: websockets.server
+
+ Starting a server
+ -----------------
+
+ .. autofunction:: serve(ws_handler, host=None, port=None, *, create_protocol=None, ping_interval=20, ping_timeout=20, close_timeout=10, max_size=2 ** 20, max_queue=2 ** 5, read_limit=2 ** 16, write_limit=2 ** 16, loop=None, compression='deflate', origins=None, extensions=None, subprotocols=None, extra_headers=None, process_request=None, select_subprotocol=None, **kwds)
+ :async:
+
+ .. autofunction:: unix_serve(ws_handler, path, *, create_protocol=None, ping_interval=20, ping_timeout=20, close_timeout=10, max_size=2 ** 20, max_queue=2 ** 5, read_limit=2 ** 16, write_limit=2 ** 16, loop=None, compression='deflate', origins=None, extensions=None, subprotocols=None, extra_headers=None, process_request=None, select_subprotocol=None, **kwds)
+ :async:
+
+ Stopping a server
+ -----------------
+
+ .. autoclass:: WebSocketServer
+
+ .. autoattribute:: sockets
+
+ .. automethod:: close
+ .. automethod:: wait_closed
+
+ Using a connection
+ ------------------
+
+ .. autoclass:: WebSocketServerProtocol(ws_handler, ws_server, *, ping_interval=20, ping_timeout=20, close_timeout=10, max_size=2 ** 20, max_queue=2 ** 5, read_limit=2 ** 16, write_limit=2 ** 16, loop=None, origins=None, extensions=None, subprotocols=None, extra_headers=None, process_request=None, select_subprotocol=None)
+
+ .. autoattribute:: local_address
+
+ .. autoattribute:: remote_address
+
+ .. autoattribute:: open
+
+ .. autoattribute:: closed
+
+ .. attribute:: path
+
+ Path of the HTTP request.
+
+ Available once the connection is open.
+
+ .. attribute:: request_headers
+
+ HTTP request headers as a :class:`~websockets.http.Headers` instance.
+
+ Available once the connection is open.
+
+ .. attribute:: response_headers
+
+ HTTP response headers as a :class:`~websockets.http.Headers` instance.
+
+ Available once the connection is open.
+
+ .. attribute:: subprotocol
+
+ Subprotocol, if one was negotiated.
+
+ Available once the connection is open.
+
+ .. attribute:: close_code
+
+ WebSocket close code.
+
+ Available once the connection is closed.
+
+ .. attribute:: close_reason
+
+ WebSocket close reason.
+
+ Available once the connection is closed.
+
+ .. automethod:: process_request
+
+ .. automethod:: select_subprotocol
+
+ .. automethod:: recv
+
+ .. automethod:: send
+
+ .. automethod:: ping
+
+ .. automethod:: pong
+
+ .. automethod:: close
+
+ .. automethod:: wait_closed
+
+Basic authentication
+--------------------
+
+.. automodule:: websockets.auth
+
+ .. autofunction:: basic_auth_protocol_factory
+
+ .. autoclass:: BasicAuthWebSocketServerProtocol
+
+ .. automethod:: process_request
+
+ .. attribute:: username
+
+ Username of the authenticated user.
+
+
diff --git a/docs/api/utilities.rst b/docs/api/utilities.rst
new file mode 100644
index 000000000..198e928b0
--- /dev/null
+++ b/docs/api/utilities.rst
@@ -0,0 +1,20 @@
+Utilities
+=========
+
+Data structures
+---------------
+
+.. automodule:: websockets.datastructures
+ :members:
+
+Exceptions
+----------
+
+.. automodule:: websockets.exceptions
+ :members:
+
+Types
+-----
+
+.. automodule:: websockets.typing
+ :members:
diff --git a/docs/changelog.rst b/docs/changelog.rst
index eea0693e0..a82008a49 100644
--- a/docs/changelog.rst
+++ b/docs/changelog.rst
@@ -3,28 +3,266 @@ Changelog
.. currentmodule:: websockets
-7.1
+.. _backwards-compatibility policy:
+
+Backwards-compatibility policy
+..............................
+
+``websockets`` is intended for production use. Therefore, stability is a goal.
+
+``websockets`` also aims at providing the best API for WebSocket in Python.
+
+While we value stability, we value progress more. When an improvement requires
+changing a public API, we make the change and document it in this changelog.
+
+When possible with reasonable effort, we preserve backwards-compatibility for
+five years after the release that introduced the change.
+
+When a release contains backwards-incompatible API changes, the major version
+is increased, else the minor version is increased. Patch versions are only for
+fixing regressions shortly after a release.
+
+Only documented APIs are public. Undocumented APIs are considered private.
+They may change at any time.
+
+9.1
...
-*In development*
+*May 27, 2021*
-7.0
+.. note::
+
+ **Version 9.1 fixes a security issue introduced in version 8.0.**
+
+ Version 8.0 was vulnerable to timing attacks on HTTP Basic Auth passwords.
+
+9.0.2
+.....
+
+*May 15, 2021*
+
+* Restored compatibility of ``python -m websockets`` with Python < 3.9.
+
+* Restored compatibility with mypy.
+
+9.0.1
+.....
+
+*May 2, 2021*
+
+* Fixed issues with the packaging of the 9.0 release.
+
+9.0
+...
+
+*May 1, 2021*
+
+.. note::
+
+ **Version 9.0 moves or deprecates several APIs.**
+
+ Aliases provide backwards compatibility for all previously public APIs.
+
+ * :class:`~datastructures.Headers` and
+ :exc:`~datastructures.MultipleValuesError` were moved from
+ ``websockets.http`` to :mod:`websockets.datastructures`. If you're using
+ them, you should adjust the import path.
+
+ * The ``client``, ``server``, ``protocol``, and ``auth`` modules were
+ moved from the ``websockets`` package to ``websockets.legacy``
+ sub-package, as part of an upcoming refactoring. Despite the name,
+ they're still fully supported. The refactoring should be a transparent
+ upgrade for most uses when it's available. The legacy implementation
+ will be preserved according to the `backwards-compatibility policy`_.
+
+ * The ``framing``, ``handshake``, ``headers``, ``http``, and ``uri``
+ modules in the ``websockets`` package are deprecated. These modules
+ provided low-level APIs for reuse by other WebSocket implementations,
+ but that never happened. Keeping these APIs public makes it more
+ difficult to improve websockets for no actual benefit.
+
+.. note::
+
+ **Version 9.0 may require changes if you use static code analysis tools.**
+
+ Convenience imports from the ``websockets`` module are performed lazily.
+ While this is supported by Python, static code analysis tools such as mypy
+ are unable to understand the behavior.
+
+ If you depend on such tools, use the real import path, which can be found
+ in the API documentation::
+
+ from websockets.client import connect
+ from websockets.server import serve
+
+* Added compatibility with Python 3.9.
+
+* Added support for IRIs in addition to URIs.
+
+* Added close codes 1012, 1013, and 1014.
+
+* Raised an error when passing a :class:`dict` to
+ :meth:`~legacy.protocol.WebSocketCommonProtocol.send`.
+
+* Fixed sending fragmented, compressed messages.
+
+* Fixed ``Host`` header sent when connecting to an IPv6 address.
+
+* Fixed creating a client or a server with an existing Unix socket.
+
+* Aligned maximum cookie size with popular web browsers.
+
+* Ensured cancellation always propagates, even on Python versions where
+ :exc:`~asyncio.CancelledError` inherits :exc:`Exception`.
+
+* Improved error reporting.
+
+
+8.1
+...
+
+*November 1, 2019*
+
+* Added compatibility with Python 3.8.
+
+8.0.2
+.....
+
+*July 31, 2019*
+
+* Restored the ability to pass a socket with the ``sock`` parameter of
+ :func:`~legacy.server.serve`.
+
+* Removed an incorrect assertion when a connection drops.
+
+8.0.1
+.....
+
+*July 21, 2019*
+
+* Restored the ability to import ``WebSocketProtocolError`` from
+ ``websockets``.
+
+8.0
...
+*July 7, 2019*
+
.. warning::
- **Version 7.0 renames the** ``timeout`` **argument of**
- :func:`~server.serve()` **and** :func:`~client.connect()` **to**
- ``close_timeout`` **.**
+ **Version 8.0 drops compatibility with Python 3.4 and 3.5.**
- This prevents confusion with ``ping_timeout``.
+.. note::
- For backwards compatibility, ``timeout`` is still supported.
+ **Version 8.0 expects** ``process_request`` **to be a coroutine.**
+
+ Previously, it could be a function or a coroutine.
+
+ If you're passing a ``process_request`` argument to
+ :func:`~legacy.server.serve`
+ or :class:`~legacy.server.WebSocketServerProtocol`, or if you're overriding
+ :meth:`~legacy.server.WebSocketServerProtocol.process_request` in a subclass,
+ define it with ``async def`` instead of ``def``.
+
+ For backwards compatibility, functions are still mostly supported, but
+ mixing functions and coroutines won't work in some inheritance scenarios.
+
+.. note::
+
+ **Version 8.0 changes the behavior of the** ``max_queue`` **parameter.**
+
+ If you were setting ``max_queue=0`` to make the queue of incoming messages
+ unbounded, change it to ``max_queue=None``.
+
+.. note::
+
+ **Version 8.0 deprecates the** ``host`` **,** ``port`` **, and** ``secure``
+ **attributes of** :class:`~legacy.protocol.WebSocketCommonProtocol`.
+
+ Use :attr:`~legacy.protocol.WebSocketCommonProtocol.local_address` in
+ servers and
+ :attr:`~legacy.protocol.WebSocketCommonProtocol.remote_address` in clients
+ instead of ``host`` and ``port``.
+
+.. note::
+
+ **Version 8.0 renames the** ``WebSocketProtocolError`` **exception**
+ to :exc:`~exceptions.ProtocolError` **.**
+
+ A ``WebSocketProtocolError`` alias provides backwards compatibility.
+
+.. note::
+
+ **Version 8.0 adds the reason phrase to the return type of the low-level
+ API** ``read_response()`` **.**
+
+Also:
+
+* :meth:`~legacy.protocol.WebSocketCommonProtocol.send`,
+ :meth:`~legacy.protocol.WebSocketCommonProtocol.ping`, and
+ :meth:`~legacy.protocol.WebSocketCommonProtocol.pong` support bytes-like
+ types :class:`bytearray` and :class:`memoryview` in addition to
+ :class:`bytes`.
+
+* Added :exc:`~exceptions.ConnectionClosedOK` and
+ :exc:`~exceptions.ConnectionClosedError` subclasses of
+ :exc:`~exceptions.ConnectionClosed` to tell apart normal connection
+ termination from errors.
+
+* Added :func:`~legacy.auth.basic_auth_protocol_factory` to enforce HTTP
+ Basic Auth on the server side.
+
+* :func:`~legacy.client.connect` handles redirects from the server during the
+ handshake.
+
+* :func:`~legacy.client.connect` supports overriding ``host`` and ``port``.
+
+* Added :func:`~legacy.client.unix_connect` for connecting to Unix sockets.
+
+* Improved support for sending fragmented messages by accepting asynchronous
+ iterators in :meth:`~legacy.protocol.WebSocketCommonProtocol.send`.
+
+* Prevented spurious log messages about :exc:`~exceptions.ConnectionClosed`
+ exceptions in keepalive ping task. If you were using ``ping_timeout=None``
+ as a workaround, you can remove it.
+
+* Changed :meth:`WebSocketServer.close()
+ ` to perform a proper closing handshake
+ instead of failing the connection.
+
+* Avoided a crash when a ``extra_headers`` callable returns ``None``.
+
+* Improved error messages when HTTP parsing fails.
+
+* Enabled readline in the interactive client.
+
+* Added type hints (:pep:`484`).
+
+* Added a FAQ to the documentation.
+
+* Added documentation for extensions.
+
+* Documented how to optimize memory usage.
+
+* Improved API documentation.
+
+7.0
+...
+
+*November 1, 2018*
.. warning::
- **Version 7.0 changes how a server terminates connections when it's
- closed with :meth:`~websockets.server.WebSocketServer.close`.**
+ ``websockets`` **now sends Ping frames at regular intervals and closes the
+ connection if it doesn't receive a matching Pong frame.**
+
+ See :class:`~legacy.protocol.WebSocketCommonProtocol` for details.
+
+.. warning::
+
+ **Version 7.0 changes how a server terminates connections when it's closed
+ with** :meth:`WebSocketServer.close()
+ ` **.**
Previously, connections handlers were canceled. Now, connections are
closed with close code 1001 (going away). From the perspective of the
@@ -39,47 +277,57 @@ Changelog
closed = asyncio.ensure_future(websocket.wait_closed())
closed.add_done_callback(lambda task: task.cancel())
-.. warning::
+.. note::
+
+ **Version 7.0 renames the** ``timeout`` **argument of**
+ :func:`~legacy.server.serve` **and** :func:`~legacy.client.connect` **to**
+ ``close_timeout`` **.**
+
+ This prevents confusion with ``ping_timeout``.
+
+ For backwards compatibility, ``timeout`` is still supported.
+
+.. note::
- **Version 7.0 changes how a** :meth:`~protocol.WebSocketCommonProtocol.ping`
- **that hasn't received a pong yet behaves when the connection is closed.**
+ **Version 7.0 changes how a**
+ :meth:`~legacy.protocol.WebSocketCommonProtocol.ping` **that hasn't
+ received a pong yet behaves when the connection is closed.**
The ping — as in ``ping = await websocket.ping()`` — used to be canceled
when the connection is closed, so that ``await ping`` raised
:exc:`~asyncio.CancelledError`. Now ``await ping`` raises
:exc:`~exceptions.ConnectionClosed` like other public APIs.
-.. warning::
+.. note::
**Version 7.0 raises a** :exc:`RuntimeError` **exception if two coroutines
- call** :meth:`~protocol.WebSocketCommonProtocol.recv` **concurrently.**
+ call** :meth:`~legacy.protocol.WebSocketCommonProtocol.recv`
+ **concurrently.**
Concurrent calls lead to non-deterministic behavior because there are no
guarantees about which coroutine will receive which message.
Also:
-* websockets sends Ping frames at regular intervals and closes the connection
- if it doesn't receive a matching Pong frame. See
- :class:`~protocol.WebSocketCommonProtocol` for details.
-
* Added ``process_request`` and ``select_subprotocol`` arguments to
- :func:`~server.serve()` and :class:`~server.WebSocketServerProtocol` to
- customize :meth:`~server.WebSocketServerProtocol.process_request` and
- :meth:`~server.WebSocketServerProtocol.select_subprotocol` without
- subclassing :class:`~server.WebSocketServerProtocol`
+ :func:`~legacy.server.serve` and
+ :class:`~legacy.server.WebSocketServerProtocol` to customize
+ :meth:`~legacy.server.WebSocketServerProtocol.process_request` and
+ :meth:`~legacy.server.WebSocketServerProtocol.select_subprotocol` without
+ subclassing :class:`~legacy.server.WebSocketServerProtocol`.
* Added support for sending fragmented messages.
-* Added the :meth:`~protocol.WebSocketCommonProtocol.wait_closed` method to
- protocols.
+* Added the :meth:`~legacy.protocol.WebSocketCommonProtocol.wait_closed`
+ method to protocols.
* Added an interactive client: ``python -m websockets ``.
* Changed the ``origins`` argument to represent the lack of an origin with
``None`` rather than ``''``.
-* Fixed a data loss bug in :meth:`~protocol.WebSocketCommonProtocol.recv`:
+* Fixed a data loss bug in
+ :meth:`~legacy.protocol.WebSocketCommonProtocol.recv`:
canceling it at the wrong time could result in messages being dropped.
* Improved handling of multiple HTTP headers with the same name.
@@ -89,62 +337,77 @@ Also:
6.0
...
+*July 16, 2018*
+
.. warning::
- **Version 6.0 introduces the** :class:`~http.Headers` **class for managing
- HTTP headers and changes several public APIs:**
+ **Version 6.0 introduces the** :class:`~datastructures.Headers` **class
+ for managing HTTP headers and changes several public APIs:**
- * :meth:`~server.WebSocketServerProtocol.process_request` now receives a
- :class:`~http.Headers` instead of a :class:`~http.client.HTTPMessage` in
- the ``request_headers`` argument.
+ * :meth:`~legacy.server.WebSocketServerProtocol.process_request` now
+ receives a :class:`~datastructures.Headers` instead of a
+ ``http.client.HTTPMessage`` in the ``request_headers`` argument.
- * The :attr:`~protocol.WebSocketCommonProtocol.request_headers` and
- :attr:`~protocol.WebSocketCommonProtocol.response_headers` attributes of
- :class:`~protocol.WebSocketCommonProtocol` are :class:`~http.Headers`
- instead of :class:`~http.client.HTTPMessage`.
+ * The ``request_headers`` and ``response_headers`` attributes of
+ :class:`~legacy.protocol.WebSocketCommonProtocol` are
+ :class:`~datastructures.Headers` instead of ``http.client.HTTPMessage``.
- * The :attr:`~protocol.WebSocketCommonProtocol.raw_request_headers` and
- :attr:`~protocol.WebSocketCommonProtocol.raw_response_headers`
- attributes of :class:`~protocol.WebSocketCommonProtocol` are removed.
- Use :meth:`~http.Headers.raw_items` instead.
+ * The ``raw_request_headers`` and ``raw_response_headers`` attributes of
+ :class:`~legacy.protocol.WebSocketCommonProtocol` are removed. Use
+ :meth:`~datastructures.Headers.raw_items` instead.
- * Functions defined in the :mod:`~handshake` module now receive
- :class:`~http.Headers` in argument instead of ``get_header`` or
- ``set_header`` functions. This affects libraries that rely on
+ * Functions defined in the ``handshake`` module now receive
+ :class:`~datastructures.Headers` in argument instead of ``get_header``
+ or ``set_header`` functions. This affects libraries that rely on
low-level APIs.
- * Functions defined in the :mod:`~http` module now return HTTP headers as
- :class:`~http.Headers` instead of lists of ``(name, value)`` pairs.
+ * Functions defined in the ``http`` module now return HTTP headers as
+ :class:`~datastructures.Headers` instead of lists of ``(name, value)``
+ pairs.
+
+ Since :class:`~datastructures.Headers` and ``http.client.HTTPMessage``
+ provide similar APIs, this change won't affect most of the code dealing
+ with HTTP headers.
- Note that :class:`~http.Headers` and :class:`~http.client.HTTPMessage`
- provide similar APIs.
Also:
* Added compatibility with Python 3.7.
+5.0.1
+.....
+
+*May 24, 2018*
+
+* Fixed a regression in 5.0 that broke some invocations of
+ :func:`~legacy.server.serve` and :func:`~legacy.client.connect`.
+
5.0
...
+*May 22, 2018*
+
.. note::
**Version 5.0 fixes a security issue introduced in version 4.0.**
- websockets 4.0 was vulnerable to denial of service by memory exhaustion
+ Version 4.0 was vulnerable to denial of service by memory exhaustion
because it didn't enforce ``max_size`` when decompressing compressed
- messages (CVE-2018-1000518).
+ messages (`CVE-2018-1000518`_).
-.. warning::
+ .. _CVE-2018-1000518: https://nvd.nist.gov/vuln/detail/CVE-2018-1000518
+
+.. note::
**Version 5.0 adds a** ``user_info`` **field to the return value of**
:func:`~uri.parse_uri` **and** :class:`~uri.WebSocketURI` **.**
- If you're unpacking :class:`~websockets.WebSocketURI` into four variables,
- adjust your code to account for that fifth field.
+ If you're unpacking :class:`~uri.WebSocketURI` into four variables, adjust
+ your code to account for that fifth field.
Also:
-* :func:`~client.connect()` performs HTTP Basic Auth when the URI contains
+* :func:`~legacy.client.connect` performs HTTP Basic Auth when the URI contains
credentials.
* Iterating on incoming messages no longer raises an exception when the
@@ -153,13 +416,14 @@ Also:
* A plain HTTP request now receives a 426 Upgrade Required response and
doesn't log a stack trace.
-* :func:`~server.unix_serve` can be used as an asynchronous context manager on
- Python ≥ 3.5.1.
+* :func:`~legacy.server.unix_serve` can be used as an asynchronous context
+ manager on Python ≥ 3.5.1.
-* Added :meth:`~protocol.WebSocketCommonProtocol.closed` property.
+* Added the :attr:`~legacy.protocol.WebSocketCommonProtocol.closed` property
+ to protocols.
-* If a :meth:`~protocol.WebSocketCommonProtocol.ping` doesn't receive a pong,
- it's canceled when the connection is closed.
+* If a :meth:`~legacy.protocol.WebSocketCommonProtocol.ping` doesn't receive a
+ pong, it's canceled when the connection is closed.
* Reported the cause of :exc:`~exceptions.ConnectionClosed` exceptions.
@@ -182,11 +446,24 @@ Also:
* Prevented processing of incoming frames after failing the connection.
+4.0.1
+.....
+
+*November 2, 2017*
+
+* Fixed issues with the packaging of the 4.0 release.
+
4.0
...
+*November 2, 2017*
+
.. warning::
+ **Version 4.0 drops compatibility with Python 3.3.**
+
+.. note::
+
**Version 4.0 enables compression with the permessage-deflate extension.**
In August 2017, Firefox and Chrome support it, but not Safari and IE.
@@ -194,9 +471,9 @@ Also:
Compression should improve performance but it increases RAM and CPU use.
If you want to disable compression, add ``compression=None`` when calling
- :func:`~server.serve()` or :func:`~client.connect()`.
+ :func:`~legacy.server.serve` or :func:`~legacy.client.connect`.
-.. warning::
+.. note::
**Version 4.0 removes the** ``state_name`` **attribute of protocols.**
@@ -204,12 +481,13 @@ Also:
Also:
-* :class:`~protocol.WebSocketCommonProtocol` instances can be used as
+* :class:`~legacy.protocol.WebSocketCommonProtocol` instances can be used as
asynchronous iterators on Python ≥ 3.6. They yield incoming messages.
-* Added :func:`~server.unix_serve` for listening on Unix sockets.
+* Added :func:`~legacy.server.unix_serve` for listening on Unix sockets.
-* Added the :attr:`~server.WebSocketServer.sockets` attribute.
+* Added the :attr:`~legacy.server.WebSocketServer.sockets` attribute to the
+ return value of :func:`~legacy.server.serve`.
* Reorganized and extended documentation.
@@ -227,31 +505,35 @@ Also:
3.4
...
-* Renamed :func:`~server.serve()` and :func:`~client.connect()`'s ``klass``
- argument to ``create_protocol`` to reflect that it can also be a callable.
- For backwards compatibility, ``klass`` is still supported.
+*August 20, 2017*
+
+* Renamed :func:`~legacy.server.serve` and :func:`~legacy.client.connect`'s
+ ``klass`` argument to ``create_protocol`` to reflect that it can also be a
+ callable. For backwards compatibility, ``klass`` is still supported.
-* :func:`~server.serve` can be used as an asynchronous context manager on
- Python ≥ 3.5.1.
+* :func:`~legacy.server.serve` can be used as an asynchronous context manager
+ on Python ≥ 3.5.1.
* Added support for customizing handling of incoming connections with
- :meth:`~server.WebSocketServerProtocol.process_request()`.
+ :meth:`~legacy.server.WebSocketServerProtocol.process_request`.
* Made read and write buffer sizes configurable.
* Rewrote HTTP handling for simplicity and performance.
-* Added an optional C extension to speed up low level operations.
+* Added an optional C extension to speed up low-level operations.
-* An invalid response status code during :func:`~client.connect()` now raises
- :class:`~exceptions.InvalidStatusCode` with a ``code`` attribute.
+* An invalid response status code during :func:`~legacy.client.connect` now
+ raises :class:`~exceptions.InvalidStatusCode` with a ``code`` attribute.
-* Providing a ``sock`` argument to :func:`~client.connect()` no longer
+* Providing a ``sock`` argument to :func:`~legacy.client.connect` no longer
crashes.
3.3
...
+*March 29, 2017*
+
* Ensured compatibility with Python 3.6.
* Reduced noise in logs caused by connection resets.
@@ -261,14 +543,18 @@ Also:
3.2
...
+*August 17, 2016*
+
* Added ``timeout``, ``max_size``, and ``max_queue`` arguments to
- :func:`~client.connect()` and :func:`~server.serve()`.
+ :func:`~legacy.client.connect` and :func:`~legacy.server.serve`.
* Made server shutdown more robust.
3.1
...
+*April 21, 2016*
+
* Avoided a warning when closing a connection before the opening handshake.
* Added flow control for incoming data.
@@ -276,16 +562,18 @@ Also:
3.0
...
+*December 25, 2015*
+
.. warning::
**Version 3.0 introduces a backwards-incompatible change in the**
- :meth:`~protocol.WebSocketCommonProtocol.recv` **API.**
+ :meth:`~legacy.protocol.WebSocketCommonProtocol.recv` **API.**
**If you're upgrading from 2.x or earlier, please read this carefully.**
- :meth:`~protocol.WebSocketCommonProtocol.recv` used to return ``None``
- when the connection was closed. This required checking the return value of
- every call::
+ :meth:`~legacy.protocol.WebSocketCommonProtocol.recv` used to return
+ ``None`` when the connection was closed. This required checking the return
+ value of every call::
message = await websocket.recv()
if message is None:
@@ -302,23 +590,24 @@ Also:
In order to avoid stranding projects built upon an earlier version, the
previous behavior can be restored by passing ``legacy_recv=True`` to
- :func:`~server.serve`, :func:`~client.connect`,
- :class:`~server.WebSocketServerProtocol`, or
- :class:`~client.WebSocketClientProtocol`. ``legacy_recv`` isn't documented
- in their signatures but isn't scheduled for deprecation either.
+ :func:`~legacy.server.serve`, :func:`~legacy.client.connect`,
+ :class:`~legacy.server.WebSocketServerProtocol`, or
+ :class:`~legacy.client.WebSocketClientProtocol`. ``legacy_recv`` isn't
+ documented in their signatures but isn't scheduled for deprecation either.
Also:
-* :func:`~client.connect` can be used as an asynchronous context manager on
- Python ≥ 3.5.1.
+* :func:`~legacy.client.connect` can be used as an asynchronous context
+ manager on Python ≥ 3.5.1.
* Updated documentation with ``await`` and ``async`` syntax from Python 3.5.
-* :meth:`~protocol.WebSocketCommonProtocol.ping` and
- :meth:`~protocol.WebSocketCommonProtocol.pong` support data passed as
+* :meth:`~legacy.protocol.WebSocketCommonProtocol.ping` and
+ :meth:`~legacy.protocol.WebSocketCommonProtocol.pong` support data passed as
:class:`str` in addition to :class:`bytes`.
-* Worked around an asyncio bug affecting connection termination under load.
+* Worked around an :mod:`asyncio` bug affecting connection termination under
+ load.
* Made ``state_name`` attribute on protocols a public API.
@@ -327,6 +616,8 @@ Also:
2.7
...
+*November 18, 2015*
+
* Added compatibility with Python 3.5.
* Refreshed documentation.
@@ -334,6 +625,8 @@ Also:
2.6
...
+*August 18, 2015*
+
* Added ``local_address`` and ``remote_address`` attributes on protocols.
* Closed open connections with code 1001 when a server shuts down.
@@ -343,19 +636,21 @@ Also:
2.5
...
+*July 28, 2015*
+
* Improved documentation.
* Provided access to handshake request and response HTTP headers.
* Allowed customizing handshake request and response HTTP headers.
-* Supported running on a non-default event loop.
+* Added support for running on a non-default event loop.
* Returned a 403 status code instead of 400 when the request Origin isn't
allowed.
-* Canceling :meth:`~protocol.WebSocketCommonProtocol.recv` no longer drops
- the next message.
+* Canceling :meth:`~legacy.protocol.WebSocketCommonProtocol.recv` no longer
+ drops the next message.
* Clarified that the closing handshake can be initiated by the client.
@@ -368,26 +663,32 @@ Also:
2.4
...
-* Added support for subprotocols.
+*January 31, 2015*
-* Supported non-default event loop.
+* Added support for subprotocols.
-* Added ``loop`` argument to :func:`~client.connect` and
- :func:`~server.serve`.
+* Added ``loop`` argument to :func:`~legacy.client.connect` and
+ :func:`~legacy.server.serve`.
2.3
...
+*November 3, 2014*
+
* Improved compliance of close codes.
2.2
...
+*July 28, 2014*
+
* Added support for limiting message size.
2.1
...
+*April 26, 2014*
+
* Added ``host``, ``port`` and ``secure`` attributes on protocols.
* Added support for providing and checking Origin_.
@@ -397,12 +698,14 @@ Also:
2.0
...
+*February 16, 2014*
+
.. warning::
**Version 2.0 introduces a backwards-incompatible change in the**
- :meth:`~protocol.WebSocketCommonProtocol.send`,
- :meth:`~protocol.WebSocketCommonProtocol.ping`, and
- :meth:`~protocol.WebSocketCommonProtocol.pong` **APIs.**
+ :meth:`~legacy.protocol.WebSocketCommonProtocol.send`,
+ :meth:`~legacy.protocol.WebSocketCommonProtocol.ping`, and
+ :meth:`~legacy.protocol.WebSocketCommonProtocol.pong` **APIs.**
**If you're upgrading from 1.x or earlier, please read this carefully.**
@@ -423,4 +726,6 @@ Also:
1.0
...
+*November 14, 2013*
+
* Initial public release.
diff --git a/docs/cheatsheet.rst b/docs/cheatsheet.rst
index 3b8993a8c..a71f08d74 100644
--- a/docs/cheatsheet.rst
+++ b/docs/cheatsheet.rst
@@ -9,58 +9,58 @@ Server
* Write a coroutine that handles a single connection. It receives a WebSocket
protocol instance and the URI path in argument.
- * Call :meth:`~protocol.WebSocketCommonProtocol.recv` and
- :meth:`~protocol.WebSocketCommonProtocol.send` to receive and send
+ * Call :meth:`~legacy.protocol.WebSocketCommonProtocol.recv` and
+ :meth:`~legacy.protocol.WebSocketCommonProtocol.send` to receive and send
messages at any time.
- * When :meth:`~protocol.WebSocketCommonProtocol.recv` or
- :meth:`~protocol.WebSocketCommonProtocol.send` raises
+ * When :meth:`~legacy.protocol.WebSocketCommonProtocol.recv` or
+ :meth:`~legacy.protocol.WebSocketCommonProtocol.send` raises
:exc:`~exceptions.ConnectionClosed`, clean up and exit. If you started
other :class:`asyncio.Task`, terminate them before exiting.
- * If you aren't awaiting :meth:`~protocol.WebSocketCommonProtocol.recv`,
- consider awaiting :meth:`~protocol.WebSocketCommonProtocol.wait_closed`
+ * If you aren't awaiting :meth:`~legacy.protocol.WebSocketCommonProtocol.recv`,
+ consider awaiting :meth:`~legacy.protocol.WebSocketCommonProtocol.wait_closed`
to detect quickly when the connection is closed.
- * You may :meth:`~protocol.WebSocketCommonProtocol.ping` or
- :meth:`~protocol.WebSocketCommonProtocol.pong` if you wish but it isn't
+ * You may :meth:`~legacy.protocol.WebSocketCommonProtocol.ping` or
+ :meth:`~legacy.protocol.WebSocketCommonProtocol.pong` if you wish but it isn't
needed in general.
-* Create a server with :func:`~server.serve` which is similar to asyncio's
- :meth:`~asyncio.AbstractEventLoop.create_server`.
-
- * On Python ≥ 3.5.1, you can also use it as an asynchronous context manager.
+* Create a server with :func:`~legacy.server.serve` which is similar to asyncio's
+ :meth:`~asyncio.AbstractEventLoop.create_server`. You can also use it as an
+ asynchronous context manager.
* The server takes care of establishing connections, then lets the handler
execute the application logic, and finally closes the connection after the
handler exits normally or with an exception.
* For advanced customization, you may subclass
- :class:`~server.WebSocketServerProtocol` and pass either this subclass or
+ :class:`~legacy.server.WebSocketServerProtocol` and pass either this subclass or
a factory function as the ``create_protocol`` argument.
Client
------
-* Create a client with :func:`~client.connect` which is similar to asyncio's
- :meth:`~asyncio.BaseEventLoop.create_connection`.
-
- * On Python ≥ 3.5.1, you can also use it as an asynchronous context manager.
+* Create a client with :func:`~legacy.client.connect` which is similar to asyncio's
+ :meth:`~asyncio.BaseEventLoop.create_connection`. You can also use it as an
+ asynchronous context manager.
* For advanced customization, you may subclass
- :class:`~server.WebSocketClientProtocol` and pass either this subclass or
+ :class:`~legacy.server.WebSocketClientProtocol` and pass either this subclass or
a factory function as the ``create_protocol`` argument.
-* Call :meth:`~protocol.WebSocketCommonProtocol.recv` and
- :meth:`~protocol.WebSocketCommonProtocol.send` to receive and send messages
+* Call :meth:`~legacy.protocol.WebSocketCommonProtocol.recv` and
+ :meth:`~legacy.protocol.WebSocketCommonProtocol.send` to receive and send messages
at any time.
-* You may :meth:`~protocol.WebSocketCommonProtocol.ping` or
- :meth:`~protocol.WebSocketCommonProtocol.pong` if you wish but it isn't
+* You may :meth:`~legacy.protocol.WebSocketCommonProtocol.ping` or
+ :meth:`~legacy.protocol.WebSocketCommonProtocol.pong` if you wish but it isn't
needed in general.
-* If you aren't using :func:`~client.connect` as a context manager, call
- :meth:`~protocol.WebSocketCommonProtocol.close` to terminate the connection.
+* If you aren't using :func:`~legacy.client.connect` as a context manager, call
+ :meth:`~legacy.protocol.WebSocketCommonProtocol.close` to terminate the connection.
+
+.. _debugging:
Debugging
---------
@@ -85,25 +85,3 @@ in particular. Fortunately Python's official documentation provides advice to
.. _develop with asyncio: https://docs.python.org/3/library/asyncio-dev.html
-Passing additional arguments to the connection handler
-------------------------------------------------------
-
-When writing a server, if you need to pass additional arguments to the
-connection handler, you can bind them with :func:`functools.partial`::
-
- import asyncio
- import functools
- import websockets
-
- async def handler(websocket, path, extra_argument):
- ...
-
- bound_handler = functools.partial(handler, extra_argument='spam')
- start_server = websockets.serve(bound_handler, '127.0.0.1', 8765)
-
- asyncio.get_event_loop().run_until_complete(start_server)
- asyncio.get_event_loop().run_forever()
-
-Another way to achieve this result is to define the ``handler`` coroutine in
-a scope where the ``extra_argument`` variable exists instead of injecting it
-through an argument.
diff --git a/docs/conf.py b/docs/conf.py
index 1a5448f7b..2246c0287 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -25,7 +25,13 @@
# Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = ['sphinx.ext.autodoc', 'sphinx.ext.intersphinx', 'sphinx.ext.viewcode']
+extensions = [
+ 'sphinx.ext.autodoc',
+ 'sphinx.ext.intersphinx',
+ 'sphinx.ext.viewcode',
+ 'sphinx_autodoc_typehints',
+ 'sphinxcontrib_trio',
+ ]
# Spelling check needs an additional module that is not installed by default.
# Add it only if spelling check is requested so docs can be generated without it.
@@ -46,16 +52,16 @@
# General information about the project.
project = 'websockets'
-copyright = '2013-{}, Aymeric Augustin'.format(datetime.date.today().year)
+copyright = f'2013-{datetime.date.today().year}, Aymeric Augustin and contributors'
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
-version = '7.0'
+version = '9.1'
# The full version, including alpha/beta/rc tags.
-release = '7.0'
+release = '9.1'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
@@ -105,8 +111,10 @@
'logo': 'websockets.svg',
'description': 'A library for building WebSocket servers and clients in Python with a focus on correctness and simplicity.',
'github_button': True,
+ 'github_type': 'star',
'github_user': 'aaugustin',
'github_repo': 'websockets',
+ 'tidelift_url': 'https://tidelift.com/subscription/pkg/pypi-websockets?utm_source=pypi-websockets&utm_medium=referral&utm_campaign=docs',
}
# Add any paths that contain custom themes here, relative to this directory.
@@ -145,9 +153,10 @@
html_sidebars = {
'**': [
'about.html',
+ 'searchbox.html',
'navigation.html',
'relations.html',
- 'searchbox.html',
+ 'donate.html',
]
}
diff --git a/docs/contributing.rst b/docs/contributing.rst
index 21e2152c1..61c0b979c 100644
--- a/docs/contributing.rst
+++ b/docs/contributing.rst
@@ -14,7 +14,7 @@ report inappropriate behavior to aymeric DOT augustin AT fractalideas DOT com.
*(If I'm the person with the inappropriate behavior, please accept my
apologies. I know I can mess up. I can't expect you to tell me, but if you
-chose to do so, I'll do my best to handle criticism constructively.
+choose to do so, I'll do my best to handle criticism constructively.
-- Aymeric)*
Contributions
@@ -53,9 +53,12 @@ Bitcoin users
websockets appears to be quite popular for interfacing with Bitcoin or other
cryptocurrency trackers. I'm strongly opposed to Bitcoin's carbon footprint.
+I'm aware of efforts to build proof-of-stake models. I'll care once the total
+carbon footprint of all cryptocurrencies drops to a non-bullshit level.
+
Please stop heating the planet where my children are supposed to live, thanks.
-Since websockets is released under an open-source license, you can use it for
-any purpose you like. However, I won't spend any of my time to help.
+Since ``websockets`` is released under an open-source license, you can use it
+for any purpose you like. However, I won't spend any of my time to help.
I will summarily close issues related to Bitcoin or cryptocurrency in any way.
diff --git a/docs/deployment.rst b/docs/deployment.rst
index 0f571520d..8baa8836c 100644
--- a/docs/deployment.rst
+++ b/docs/deployment.rst
@@ -24,29 +24,23 @@ Graceful shutdown
You may want to close connections gracefully when shutting down the server,
perhaps after executing some cleanup logic. There are two ways to achieve this
-with the object returned by :func:`~server.serve`:
+with the object returned by :func:`~legacy.server.serve`:
- using it as a asynchronous context manager, or
- calling its ``close()`` method, then waiting for its ``wait_closed()``
method to complete.
-Tasks that handle connections will be canceled. For example, if the handler
-is awaiting :meth:`~protocol.WebSocketCommonProtocol.recv`, that call will
-raise :exc:`~asyncio.CancelledError`.
-
On Unix systems, shutdown is usually triggered by sending a signal.
-Here's a full example (Unix-only):
+Here's a full example for handling SIGTERM on Unix:
-.. literalinclude:: ../example/shutdown.py
+.. literalinclude:: ../example/shutdown_server.py
:emphasize-lines: 13,17-19
-``async`` and ``await`` were introduced in Python 3.5. websockets supports
-asynchronous context managers on Python ≥ 3.5.1. ``async for`` was introduced
-in Python 3.6. Here's the equivalent for older Python versions:
-
-.. literalinclude:: ../example/old_shutdown.py
- :emphasize-lines: 22-25
+This example is easily adapted to handle other signals. If you override the
+default handler for SIGINT, which raises :exc:`KeyboardInterrupt`, be aware
+that you won't be able to interrupt a program with Ctrl-C anymore when it's
+stuck in a loop.
It's more difficult to achieve the same effect on Windows. Some third-party
projects try to help with this problem.
@@ -54,15 +48,104 @@ projects try to help with this problem.
If your server doesn't run in the main thread, look at
:func:`~asyncio.AbstractEventLoop.call_soon_threadsafe`.
-Memory use
-----------
+Memory usage
+------------
+
+.. _memory-usage:
+
+In most cases, memory usage of a WebSocket server is proportional to the
+number of open connections. When a server handles thousands of connections,
+memory usage can become a bottleneck.
+
+Memory usage of a single connection is the sum of:
+
+1. the baseline amount of memory ``websockets`` requires for each connection,
+2. the amount of data held in buffers before the application processes it,
+3. any additional memory allocated by the application itself.
+
+Baseline
+........
+
+.. _compression-settings:
+
+Compression settings are the main factor affecting the baseline amount of
+memory used by each connection.
+
+By default ``websockets`` maximizes compression rate at the expense of memory
+usage. If memory usage is an issue, lowering compression settings can help:
+
+- Context Takeover is necessary to get good performance for almost all
+ applications. It should remain enabled.
+- Window Bits is a trade-off between memory usage and compression rate.
+ It defaults to 15 and can be lowered. The default value isn't optimal
+ for small, repetitive messages which are typical of WebSocket servers.
+- Memory Level is a trade-off between memory usage and compression speed.
+ It defaults to 8 and can be lowered. A lower memory level can actually
+ increase speed thanks to memory locality, even if the CPU does more work!
+
+See this :ref:`example ` for how to
+configure compression settings.
+
+Here's how various compression settings affect memory usage of a single
+connection on a 64-bit system, as well a benchmark_ of compressed size and
+compression time for a corpus of small JSON documents.
+
++-------------+-------------+--------------+--------------+------------------+------------------+
+| Compression | Window Bits | Memory Level | Memory usage | Size vs. default | Time vs. default |
++=============+=============+==============+==============+==================+==================+
+| *default* | 15 | 8 | 325 KiB | +0% | +0% +
++-------------+-------------+--------------+--------------+------------------+------------------+
+| | 14 | 7 | 181 KiB | +1.5% | -5.3% |
++-------------+-------------+--------------+--------------+------------------+------------------+
+| | 13 | 6 | 110 KiB | +2.8% | -7.5% |
++-------------+-------------+--------------+--------------+------------------+------------------+
+| | 12 | 5 | 73 KiB | +4.4% | -18.9% |
++-------------+-------------+--------------+--------------+------------------+------------------+
+| | 11 | 4 | 55 KiB | +8.5% | -18.8% |
++-------------+-------------+--------------+--------------+------------------+------------------+
+| *disabled* | N/A | N/A | 22 KiB | N/A | N/A |
++-------------+-------------+--------------+--------------+------------------+------------------+
+
+*Don't assume this example is representative! Compressed size and compression
+time depend heavily on the kind of messages exchanged by the application!*
+
+You can run the same benchmark for your application by creating a list of
+typical messages and passing it to the ``_benchmark`` function_.
+
+.. _benchmark: https://gist.github.com/aaugustin/fbea09ce8b5b30c4e56458eb081fe599
+.. _function: https://gist.github.com/aaugustin/fbea09ce8b5b30c4e56458eb081fe599#file-compression-py-L48-L144
+
+This `blog post by Ilya Grigorik`_ provides more details about how compression
+settings affect memory usage and how to optimize them.
+
+.. _blog post by Ilya Grigorik: https://www.igvita.com/2013/11/27/configuring-and-optimizing-websocket-compression/
+
+This `experiment by Peter Thorson`_ suggests Window Bits = 11, Memory Level =
+4 as a sweet spot for optimizing memory usage.
+
+.. _experiment by Peter Thorson: https://www.ietf.org/mail-archive/web/hybi/current/msg10222.html
+
+Buffers
+.......
+
+Under normal circumstances, buffers are almost always empty.
+
+Under high load, if a server receives more messages than it can process,
+bufferbloat can result in excessive memory use.
+
+By default ``websockets`` has generous limits. It is strongly recommended to
+adapt them to your application. When you call :func:`~legacy.server.serve`:
+
+- Set ``max_size`` (default: 1 MiB, UTF-8 encoded) to the maximum size of
+ messages your application generates.
+- Set ``max_queue`` (default: 32) to the maximum number of messages your
+ application expects to receive faster than it can process them. The queue
+ provides burst tolerance without slowing down the TCP connection.
-In order to avoid excessive memory use caused by buffer bloat, it is strongly
-recommended to :ref:`tune buffer sizes `.
+Furthermore, you can lower ``read_limit`` and ``write_limit`` (default:
+64 KiB) to reduce the size of buffers for incoming and outgoing data.
-Most importantly ``max_size`` should be lowered according to the expected size
-of messages. It is also suggested to lower ``max_queue``, ``read_limit`` and
-``write_limit`` if memory use is a concern.
+The design document provides :ref:`more details about buffers`.
Port sharing
------------
@@ -74,8 +157,8 @@ The author of ``websockets`` doesn't think that's a good idea, due to the
widely different operational characteristics of HTTP and WebSocket.
``websockets`` provide minimal support for responding to HTTP requests with
-the :meth:`~server.WebSocketServerProtocol.process_request()` hook. Typical
+the :meth:`~legacy.server.WebSocketServerProtocol.process_request` hook. Typical
use cases include health checks. Here's an example:
.. literalinclude:: ../example/health_check_server.py
- :emphasize-lines: 9-11,17-18
+ :emphasize-lines: 9-11,17-19
diff --git a/docs/design.rst b/docs/design.rst
index 03f1ec163..61b42b528 100644
--- a/docs/design.rst
+++ b/docs/design.rst
@@ -9,11 +9,11 @@ with the specification of the WebSocket protocol in :rfc:`6455`.
It's primarily intended at maintainers. It may also be useful for users who
wish to understand what happens under the hood.
-.. warning:
+.. warning::
Internals described in this document may change at any time.
- Backwards compatibility is only guaranteed for `public APIs `_.
+ Backwards compatibility is only guaranteed for :doc:`public APIs `.
Lifecycle
@@ -32,20 +32,20 @@ WebSocket connections go through a trivial state machine:
Transitions happen in the following places:
- ``CONNECTING -> OPEN``: in
- :meth:`~protocol.WebSocketCommonProtocol.connection_open()` which runs when
+ :meth:`~legacy.protocol.WebSocketCommonProtocol.connection_open` which runs when
the :ref:`opening handshake ` completes and the WebSocket
connection is established — not to be confused with
:meth:`~asyncio.Protocol.connection_made` which runs when the TCP connection
is established;
- ``OPEN -> CLOSING``: in
- :meth:`~protocol.WebSocketCommonProtocol.write_frame()` immediately before
+ :meth:`~legacy.protocol.WebSocketCommonProtocol.write_frame` immediately before
sending a close frame; since receiving a close frame triggers sending a
close frame, this does the right thing regardless of which side started the
:ref:`closing handshake `; also in
- :meth:`~protocol.WebSocketCommonProtocol.fail_connection()` which duplicates
- a few lines of code from `write_close_frame()` and `write_frame()`;
+ :meth:`~legacy.protocol.WebSocketCommonProtocol.fail_connection` which duplicates
+ a few lines of code from ``write_close_frame()`` and ``write_frame()``;
- ``* -> CLOSED``: in
- :meth:`~protocol.WebSocketCommonProtocol.connection_lost()` which is always
+ :meth:`~legacy.protocol.WebSocketCommonProtocol.connection_lost` which is always
called exactly once when the TCP connection is closed.
Coroutines
@@ -58,36 +58,36 @@ connection lifecycle on the client side.
:target: _images/lifecycle.svg
The lifecycle is identical on the server side, except inversion of control
-makes the equivalent of :meth:`~client.connect()` implicit.
+makes the equivalent of :meth:`~legacy.client.connect` implicit.
Coroutines shown in green are called by the application. Multiple coroutines
may interact with the WebSocket connection concurrently.
Coroutines shown in gray manage the connection. When the opening handshake
-succeeds, :meth:`~protocol.WebSocketCommonProtocol.connection_open()` starts
+succeeds, :meth:`~legacy.protocol.WebSocketCommonProtocol.connection_open` starts
two tasks:
-- :attr:`~protocol.WebSocketCommonProtocol.transfer_data_task` runs
- :meth:`~protocol.WebSocketCommonProtocol.transfer_data()` which handles
- incoming data and lets :meth:`~protocol.WebSocketCommonProtocol.recv()`
+- :attr:`~legacy.protocol.WebSocketCommonProtocol.transfer_data_task` runs
+ :meth:`~legacy.protocol.WebSocketCommonProtocol.transfer_data` which handles
+ incoming data and lets :meth:`~legacy.protocol.WebSocketCommonProtocol.recv`
consume it. It may be canceled to terminate the connection. It never exits
with an exception other than :exc:`~asyncio.CancelledError`. See :ref:`data
transfer ` below.
-- :attr:`~protocol.WebSocketCommonProtocol.keepalive_ping_task` runs
- :meth:`~protocol.WebSocketCommonProtocol.keepalive_ping()` which sends Ping
+- :attr:`~legacy.protocol.WebSocketCommonProtocol.keepalive_ping_task` runs
+ :meth:`~legacy.protocol.WebSocketCommonProtocol.keepalive_ping` which sends Ping
frames at regular intervals and ensures that corresponding Pong frames are
received. It is canceled when the connection terminates. It never exits
with an exception other than :exc:`~asyncio.CancelledError`.
-- :attr:`~protocol.WebSocketCommonProtocol.close_connection_task` runs
- :meth:`~protocol.WebSocketCommonProtocol.close_connection()` which waits for
+- :attr:`~legacy.protocol.WebSocketCommonProtocol.close_connection_task` runs
+ :meth:`~legacy.protocol.WebSocketCommonProtocol.close_connection` which waits for
the data transfer to terminate, then takes care of closing the TCP
connection. It must not be canceled. It never exits with an exception. See
:ref:`connection termination ` below.
-Besides, :meth:`~protocol.WebSocketCommonProtocol.fail_connection()` starts
-the same :attr:`~protocol.WebSocketCommonProtocol.close_connection_task` when
+Besides, :meth:`~legacy.protocol.WebSocketCommonProtocol.fail_connection` starts
+the same :attr:`~legacy.protocol.WebSocketCommonProtocol.close_connection_task` when
the opening handshake fails, in order to close the TCP connection.
Splitting the responsibilities between two tasks makes it easier to guarantee
@@ -99,11 +99,11 @@ that ``websockets`` can terminate connections:
regardless of whether the connection terminates normally or abnormally.
-:attr:`~protocol.WebSocketCommonProtocol.transfer_data_task` completes when no
+:attr:`~legacy.protocol.WebSocketCommonProtocol.transfer_data_task` completes when no
more data will be received on the connection. Under normal circumstances, it
exits after exchanging close frames.
-:attr:`~protocol.WebSocketCommonProtocol.close_connection_task` completes when
+:attr:`~legacy.protocol.WebSocketCommonProtocol.close_connection_task` completes when
the TCP connection is closed.
@@ -113,7 +113,7 @@ Opening handshake
-----------------
``websockets`` performs the opening handshake when establishing a WebSocket
-connection. On the client side, :meth:`~client.connect()` executes it before
+connection. On the client side, :meth:`~legacy.client.connect` executes it before
returning the protocol to the caller. On the server side, it's executed before
passing the protocol to the ``ws_handler`` coroutine handling the connection.
@@ -122,26 +122,26 @@ request and the server replies with an HTTP Switching Protocols response —
``websockets`` aims at keeping the implementation of both sides consistent
with one another.
-On the client side, :meth:`~client.WebSocketClientProtocol.handshake()`:
+On the client side, :meth:`~legacy.client.WebSocketClientProtocol.handshake`:
- builds a HTTP request based on the ``uri`` and parameters passed to
- :meth:`~client.connect()`;
+ :meth:`~legacy.client.connect`;
- writes the HTTP request to the network;
- reads a HTTP response from the network;
- checks the HTTP response, validates ``extensions`` and ``subprotocol``, and
configures the protocol accordingly;
- moves to the ``OPEN`` state.
-On the server side, :meth:`~server.WebSocketServerProtocol.handshake()`:
+On the server side, :meth:`~legacy.server.WebSocketServerProtocol.handshake`:
- reads a HTTP request from the network;
-- calls :meth:`~server.WebSocketServerProtocol.process_request()` which may
+- calls :meth:`~legacy.server.WebSocketServerProtocol.process_request` which may
abort the WebSocket handshake and return a HTTP response instead; this
hook only makes sense on the server side;
- checks the HTTP request, negotiates ``extensions`` and ``subprotocol``, and
configures the protocol accordingly;
- builds a HTTP response based on the above and parameters passed to
- :meth:`~server.serve()`;
+ :meth:`~legacy.server.serve`;
- writes the HTTP response to the network;
- moves to the ``OPEN`` state;
- returns the ``path`` part of the ``uri``.
@@ -177,16 +177,16 @@ differences between a server and a client:
These differences are so minor that all the logic for `data framing`_, for
`sending and receiving data`_ and for `closing the connection`_ is implemented
-in the same class, :class:`~protocol.WebSocketCommonProtocol`.
+in the same class, :class:`~legacy.protocol.WebSocketCommonProtocol`.
.. _data framing: https://tools.ietf.org/html/rfc6455#section-5
.. _sending and receiving data: https://tools.ietf.org/html/rfc6455#section-6
.. _closing the connection: https://tools.ietf.org/html/rfc6455#section-7
-The :attr:`~protocol.WebSocketCommonProtocol.is_client` attribute tells which
+The :attr:`~legacy.protocol.WebSocketCommonProtocol.is_client` attribute tells which
side a protocol instance is managing. This attribute is defined on the
-:attr:`~server.WebSocketServerProtocol` and
-:attr:`~client.WebSocketClientProtocol` classes.
+:attr:`~legacy.server.WebSocketServerProtocol` and
+:attr:`~legacy.client.WebSocketClientProtocol` classes.
Data flow
.........
@@ -210,11 +210,11 @@ The left side of the diagram shows how ``websockets`` receives data.
Incoming data is written to a :class:`~asyncio.StreamReader` in order to
implement flow control and provide backpressure on the TCP connection.
-:attr:`~protocol.WebSocketCommonProtocol.transfer_data_task`, which is started
+:attr:`~legacy.protocol.WebSocketCommonProtocol.transfer_data_task`, which is started
when the WebSocket connection is established, processes this data.
When it receives data frames, it reassembles fragments and puts the resulting
-messages in the :attr:`~protocol.WebSocketCommonProtocol.messages` queue.
+messages in the :attr:`~legacy.protocol.WebSocketCommonProtocol.messages` queue.
When it encounters a control frame:
@@ -226,28 +226,30 @@ When it encounters a control frame:
Running this process in a task guarantees that control frames are processed
promptly. Without such a task, ``websockets`` would depend on the application
to drive the connection by having exactly one coroutine awaiting
-:meth:`~protocol.WebSocketCommonProtocol.recv()` at any time. While this
+:meth:`~legacy.protocol.WebSocketCommonProtocol.recv` at any time. While this
happens naturally in many use cases, it cannot be relied upon.
-Then :meth:`~protocol.WebSocketCommonProtocol.recv()` fetches the next message
-from the :attr:`~protocol.WebSocketCommonProtocol.messages` queue, with some
-complexity added for handling termination correctly.
+Then :meth:`~legacy.protocol.WebSocketCommonProtocol.recv` fetches the next message
+from the :attr:`~legacy.protocol.WebSocketCommonProtocol.messages` queue, with some
+complexity added for handling backpressure and termination correctly.
Sending data
............
The right side of the diagram shows how ``websockets`` sends data.
-:meth:`~protocol.WebSocketCommonProtocol.send()` writes a single data frame
-containing the message. Fragmentation isn't supported at this time.
+:meth:`~legacy.protocol.WebSocketCommonProtocol.send` writes one or several data
+frames containing the message. While sending a fragmented message, concurrent
+calls to :meth:`~legacy.protocol.WebSocketCommonProtocol.send` are put on hold until
+all fragments are sent. This makes concurrent calls safe.
-:meth:`~protocol.WebSocketCommonProtocol.ping()` writes a ping frame and
+:meth:`~legacy.protocol.WebSocketCommonProtocol.ping` writes a ping frame and
yields a :class:`~asyncio.Future` which will be completed when a matching pong
frame is received.
-:meth:`~protocol.WebSocketCommonProtocol.pong()` writes a pong frame.
+:meth:`~legacy.protocol.WebSocketCommonProtocol.pong` writes a pong frame.
-:meth:`~protocol.WebSocketCommonProtocol.close()` writes a close frame and
+:meth:`~legacy.protocol.WebSocketCommonProtocol.close` writes a close frame and
waits for the TCP connection to terminate.
Outgoing data is written to a :class:`~asyncio.StreamWriter` in order to
@@ -259,17 +261,17 @@ Closing handshake
.................
When the other side of the connection initiates the closing handshake,
-:meth:`~protocol.WebSocketCommonProtocol.read_message()` receives a close
+:meth:`~legacy.protocol.WebSocketCommonProtocol.read_message` receives a close
frame while in the ``OPEN`` state. It moves to the ``CLOSING`` state, sends a
close frame, and returns ``None``, causing
-:attr:`~protocol.WebSocketCommonProtocol.transfer_data_task` to terminate.
+:attr:`~legacy.protocol.WebSocketCommonProtocol.transfer_data_task` to terminate.
When this side of the connection initiates the closing handshake with
-:meth:`~protocol.WebSocketCommonProtocol.close()`, it moves to the ``CLOSING``
+:meth:`~legacy.protocol.WebSocketCommonProtocol.close`, it moves to the ``CLOSING``
state and sends a close frame. When the other side sends a close frame,
-:meth:`~protocol.WebSocketCommonProtocol.read_message()` receives it in the
+:meth:`~legacy.protocol.WebSocketCommonProtocol.read_message` receives it in the
``CLOSING`` state and returns ``None``, also causing
-:attr:`~protocol.WebSocketCommonProtocol.transfer_data_task` to terminate.
+:attr:`~legacy.protocol.WebSocketCommonProtocol.transfer_data_task` to terminate.
If the other side doesn't send a close frame within the connection's close
timeout, ``websockets`` :ref:`fails the connection `.
@@ -286,31 +288,31 @@ Then ``websockets`` terminates the TCP connection.
Connection termination
----------------------
-:attr:`~protocol.WebSocketCommonProtocol.close_connection_task`, which is
+:attr:`~legacy.protocol.WebSocketCommonProtocol.close_connection_task`, which is
started when the WebSocket connection is established, is responsible for
eventually closing the TCP connection.
-First :attr:`~protocol.WebSocketCommonProtocol.close_connection_task` waits
-for :attr:`~protocol.WebSocketCommonProtocol.transfer_data_task` to terminate,
+First :attr:`~legacy.protocol.WebSocketCommonProtocol.close_connection_task` waits
+for :attr:`~legacy.protocol.WebSocketCommonProtocol.transfer_data_task` to terminate,
which may happen as a result of:
- a successful closing handshake: as explained above, this exits the infinite
- loop in :attr:`~protocol.WebSocketCommonProtocol.transfer_data_task`;
+ loop in :attr:`~legacy.protocol.WebSocketCommonProtocol.transfer_data_task`;
- a timeout while waiting for the closing handshake to complete: this cancels
- :attr:`~protocol.WebSocketCommonProtocol.transfer_data_task`;
+ :attr:`~legacy.protocol.WebSocketCommonProtocol.transfer_data_task`;
- a protocol error, including connection errors: depending on the exception,
- :attr:`~protocol.WebSocketCommonProtocol.transfer_data_task` :ref:`fails the
+ :attr:`~legacy.protocol.WebSocketCommonProtocol.transfer_data_task` :ref:`fails the
connection ` with a suitable code and exits.
-:attr:`~protocol.WebSocketCommonProtocol.close_connection_task` is separate
-from :attr:`~protocol.WebSocketCommonProtocol.transfer_data_task` to make it
+:attr:`~legacy.protocol.WebSocketCommonProtocol.close_connection_task` is separate
+from :attr:`~legacy.protocol.WebSocketCommonProtocol.transfer_data_task` to make it
easier to implement the timeout on the closing handshake. Canceling
-:attr:`~protocol.WebSocketCommonProtocol.transfer_data_task` creates no risk
-of canceling :attr:`~protocol.WebSocketCommonProtocol.close_connection_task`
+:attr:`~legacy.protocol.WebSocketCommonProtocol.transfer_data_task` creates no risk
+of canceling :attr:`~legacy.protocol.WebSocketCommonProtocol.close_connection_task`
and failing to close the TCP connection, thus leaking resources.
-Then :attr:`~protocol.WebSocketCommonProtocol.close_connection_task` cancels
-:attr:`~protocol.WebSocketCommonProtocol.keepalive_ping`. This task has no
+Then :attr:`~legacy.protocol.WebSocketCommonProtocol.close_connection_task` cancels
+:attr:`~legacy.protocol.WebSocketCommonProtocol.keepalive_ping`. This task has no
protocol compliance responsibilities. Terminating it to avoid leaking it is
the only concern.
@@ -332,11 +334,11 @@ If the opening handshake doesn't complete successfully, ``websockets`` fails
the connection by closing the TCP connection.
Once the opening handshake has completed, ``websockets`` fails the connection
-by canceling :attr:`~protocol.WebSocketCommonProtocol.transfer_data_task` and
+by canceling :attr:`~legacy.protocol.WebSocketCommonProtocol.transfer_data_task` and
sending a close frame if appropriate.
-:attr:`~protocol.WebSocketCommonProtocol.transfer_data_task` exits, unblocking
-:attr:`~protocol.WebSocketCommonProtocol.close_connection_task`, which closes
+:attr:`~legacy.protocol.WebSocketCommonProtocol.transfer_data_task` exits, unblocking
+:attr:`~legacy.protocol.WebSocketCommonProtocol.close_connection_task`, which closes
the TCP connection.
@@ -402,8 +404,8 @@ don't involve inversion of control.
Library
.......
-Most :doc:`public APIs ` of ``websockets`` are coroutines. They may be
-canceled, for example if the user starts a task that calls these coroutines
+Most :doc:`public APIs ` of ``websockets`` are coroutines. They may
+be canceled, for example if the user starts a task that calls these coroutines
and cancels the task later. ``websockets`` must handle this situation.
Cancellation during the opening handshake is handled like any other exception:
@@ -412,43 +414,45 @@ happen on the client side. On the server side, the opening handshake is
managed by ``websockets`` and nothing results in a cancellation.
Once the WebSocket connection is established, internal tasks
-:attr:`~protocol.WebSocketCommonProtocol.transfer_data_task` and
-:attr:`~protocol.WebSocketCommonProtocol.close_connection_task` mustn't get
+:attr:`~legacy.protocol.WebSocketCommonProtocol.transfer_data_task` and
+:attr:`~legacy.protocol.WebSocketCommonProtocol.close_connection_task` mustn't get
accidentally canceled if a coroutine that awaits them is canceled. In other
words, they must be shielded from cancellation.
-:meth:`~protocol.WebSocketCommonProtocol.recv()` waits for the next message in
-the queue or for :attr:`~protocol.WebSocketCommonProtocol.transfer_data_task`
-to terminate, whichever comes first. It relies on :func:`~asyncio.wait()` for
-waiting on two tasks in parallel. As a consequence, even though it's waiting
-on the transfer data task, it doesn't propagate cancellation to that task.
-
-:meth:`~protocol.WebSocketCommonProtocol.ensure_open()` is called by
-:meth:`~protocol.WebSocketCommonProtocol.send()`,
-:meth:`~protocol.WebSocketCommonProtocol.ping()`, and
-:meth:`~protocol.WebSocketCommonProtocol.pong()`. When the connection state is
+:meth:`~legacy.protocol.WebSocketCommonProtocol.recv` waits for the next message in
+the queue or for :attr:`~legacy.protocol.WebSocketCommonProtocol.transfer_data_task`
+to terminate, whichever comes first. It relies on :func:`~asyncio.wait` for
+waiting on two futures in parallel. As a consequence, even though it's waiting
+on a :class:`~asyncio.Future` signaling the next message and on
+:attr:`~legacy.protocol.WebSocketCommonProtocol.transfer_data_task`, it doesn't
+propagate cancellation to them.
+
+:meth:`~legacy.protocol.WebSocketCommonProtocol.ensure_open` is called by
+:meth:`~legacy.protocol.WebSocketCommonProtocol.send`,
+:meth:`~legacy.protocol.WebSocketCommonProtocol.ping`, and
+:meth:`~legacy.protocol.WebSocketCommonProtocol.pong`. When the connection state is
``CLOSING``, it waits for
-:attr:`~protocol.WebSocketCommonProtocol.transfer_data_task` but shields it to
+:attr:`~legacy.protocol.WebSocketCommonProtocol.transfer_data_task` but shields it to
prevent cancellation.
-:meth:`~protocol.WebSocketCommonProtocol.close()` waits for the data transfer
+:meth:`~legacy.protocol.WebSocketCommonProtocol.close` waits for the data transfer
task to terminate with :func:`~asyncio.wait_for`. If it's canceled or if the
-timeout elapses, :attr:`~protocol.WebSocketCommonProtocol.transfer_data_task`
+timeout elapses, :attr:`~legacy.protocol.WebSocketCommonProtocol.transfer_data_task`
is canceled, which is correct at this point.
-:meth:`~protocol.WebSocketCommonProtocol.close()` then waits for
-:attr:`~protocol.WebSocketCommonProtocol.close_connection_task` but shields it
+:meth:`~legacy.protocol.WebSocketCommonProtocol.close` then waits for
+:attr:`~legacy.protocol.WebSocketCommonProtocol.close_connection_task` but shields it
to prevent cancellation.
-:meth:`~protocol.WebSocketCommonProtocol.close()` and
-:func:`~protocol.WebSocketCommonProtocol.fail_connection()` are the only
-places where :attr:`~protocol.WebSocketCommonProtocol.transfer_data_task` may
+:meth:`~legacy.protocol.WebSocketCommonProtocol.close` and
+:func:`~legacy.protocol.WebSocketCommonProtocol.fail_connection` are the only
+places where :attr:`~legacy.protocol.WebSocketCommonProtocol.transfer_data_task` may
be canceled.
-:attr:`~protocol.WebSocketCommonProtocol.close_connnection_task` starts by
-waiting for :attr:`~protocol.WebSocketCommonProtocol.transfer_data_task`. It
+:attr:`~legacy.protocol.WebSocketCommonProtocol.close_connnection_task` starts by
+waiting for :attr:`~legacy.protocol.WebSocketCommonProtocol.transfer_data_task`. It
catches :exc:`~asyncio.CancelledError` to prevent a cancellation of
-:attr:`~protocol.WebSocketCommonProtocol.transfer_data_task` from propagating
-to :attr:`~protocol.WebSocketCommonProtocol.close_connnection_task`.
+:attr:`~legacy.protocol.WebSocketCommonProtocol.transfer_data_task` from propagating
+to :attr:`~legacy.protocol.WebSocketCommonProtocol.close_connnection_task`.
.. _backpressure:
@@ -513,40 +517,55 @@ Bufferbloat can happen at every level in the stack where there is a buffer.
For each connection, the receiving side contains these buffers:
- OS buffers: tuning them is an advanced optimization.
-- :class:`~asyncio.StreamReader` bytes buffer: the default limit is 64kB.
+- :class:`~asyncio.StreamReader` bytes buffer: the default limit is 64 KiB.
You can set another limit by passing a ``read_limit`` keyword argument to
- :func:`~client.connect()` or :func:`~server.serve()`.
+ :func:`~legacy.client.connect()` or :func:`~legacy.server.serve`.
- Incoming messages :class:`~collections.deque`: its size depends both on
the size and the number of messages it contains. By default the maximum
- UTF-8 encoded size is 1MB and the maximum number is 32. In the worst case,
- after UTF-8 decoding, a single message could take up to 4MB of memory and
- the overall memory consumption could reach 128MB. You should adjust these
+ UTF-8 encoded size is 1 MiB and the maximum number is 32. In the worst case,
+ after UTF-8 decoding, a single message could take up to 4 MiB of memory and
+ the overall memory consumption could reach 128 MiB. You should adjust these
limits by setting the ``max_size`` and ``max_queue`` keyword arguments of
- :func:`~client.connect()` or :func:`~server.serve()` according to your
+ :func:`~legacy.client.connect()` or :func:`~legacy.server.serve` according to your
application's requirements.
For each connection, the sending side contains these buffers:
-- :class:`~asyncio.StreamWriter` bytes buffer: the default size is 64kB.
+- :class:`~asyncio.StreamWriter` bytes buffer: the default size is 64 KiB.
You can set another limit by passing a ``write_limit`` keyword argument to
- :func:`~client.connect()` or :func:`~server.serve()`.
+ :func:`~legacy.client.connect()` or :func:`~legacy.server.serve`.
- OS buffers: tuning them is an advanced optimization.
Concurrency
-----------
-Calling any combination of :meth:`~protocol.WebSocketCommonProtocol.recv()`,
-:meth:`~protocol.WebSocketCommonProtocol.send()`,
-:meth:`~protocol.WebSocketCommonProtocol.close()`
-:meth:`~protocol.WebSocketCommonProtocol.ping()`, or
-:meth:`~protocol.WebSocketCommonProtocol.pong()` concurrently is safe,
-including multiple calls to the same method.
-
-As shown above, receiving frames is independent from sending frames. That
-isolates :meth:`~protocol.WebSocketCommonProtocol.recv()`, which receives
-frames, from the other methods, which send frames.
-
-Methods that send frames also support concurrent calls. While the connection
-is open, each frame is sent with a single write. Combined with the concurrency
-model of :mod:`asyncio`, this enforces serialization. After the connection is
-closed, sending a frame raises :exc:`~websockets.exceptions.ConnectionClosed`.
+Awaiting any combination of :meth:`~legacy.protocol.WebSocketCommonProtocol.recv`,
+:meth:`~legacy.protocol.WebSocketCommonProtocol.send`,
+:meth:`~legacy.protocol.WebSocketCommonProtocol.close`
+:meth:`~legacy.protocol.WebSocketCommonProtocol.ping`, or
+:meth:`~legacy.protocol.WebSocketCommonProtocol.pong` concurrently is safe, including
+multiple calls to the same method, with one exception and one limitation.
+
+* **Only one coroutine can receive messages at a time.** This constraint
+ avoids non-deterministic behavior (and simplifies the implementation). If a
+ coroutine is awaiting :meth:`~legacy.protocol.WebSocketCommonProtocol.recv`,
+ awaiting it again in another coroutine raises :exc:`RuntimeError`.
+
+* **Sending a fragmented message forces serialization.** Indeed, the WebSocket
+ protocol doesn't support multiplexing messages. If a coroutine is awaiting
+ :meth:`~legacy.protocol.WebSocketCommonProtocol.send` to send a fragmented message,
+ awaiting it again in another coroutine waits until the first call completes.
+ This will be transparent in many cases. It may be a concern if the
+ fragmented message is generated slowly by an asynchronous iterator.
+
+Receiving frames is independent from sending frames. This isolates
+:meth:`~legacy.protocol.WebSocketCommonProtocol.recv`, which receives frames, from
+the other methods, which send frames.
+
+While the connection is open, each frame is sent with a single write. Combined
+with the concurrency model of :mod:`asyncio`, this enforces serialization. The
+only other requirement is to prevent interleaving other data frames in the
+middle of a fragmented message.
+
+After the connection is closed, sending a frame raises
+:exc:`~websockets.exceptions.ConnectionClosed`, which is safe.
diff --git a/docs/extensions.rst b/docs/extensions.rst
new file mode 100644
index 000000000..f5e2f497f
--- /dev/null
+++ b/docs/extensions.rst
@@ -0,0 +1,97 @@
+Extensions
+==========
+
+.. currentmodule:: websockets.extensions
+
+The WebSocket protocol supports extensions_.
+
+At the time of writing, there's only one `registered extension`_ with a public
+specification, WebSocket Per-Message Deflate, specified in :rfc:`7692`.
+
+.. _extensions: https://tools.ietf.org/html/rfc6455#section-9
+.. _registered extension: https://www.iana.org/assignments/websocket/websocket.xhtml#extension-name
+
+Per-Message Deflate
+-------------------
+
+:func:`~websockets.client.connect` and :func:`~websockets.server.serve` enable
+the Per-Message Deflate extension by default.
+
+If you want to disable it, set ``compression=None``::
+
+ import websockets
+
+ websockets.connect(..., compression=None)
+
+ websockets.serve(..., compression=None)
+
+
+.. _per-message-deflate-configuration-example:
+
+You can also configure the Per-Message Deflate extension explicitly if you
+want to customize compression settings::
+
+ import websockets
+ from websockets.extensions import permessage_deflate
+
+ websockets.connect(
+ ...,
+ extensions=[
+ permessage_deflate.ClientPerMessageDeflateFactory(
+ server_max_window_bits=11,
+ client_max_window_bits=11,
+ compress_settings={'memLevel': 4},
+ ),
+ ],
+ )
+
+ websockets.serve(
+ ...,
+ extensions=[
+ permessage_deflate.ServerPerMessageDeflateFactory(
+ server_max_window_bits=11,
+ client_max_window_bits=11,
+ compress_settings={'memLevel': 4},
+ ),
+ ],
+ )
+
+The window bits and memory level values chosen in these examples reduce memory
+usage. You can read more about :ref:`optimizing compression settings
+`.
+
+Refer to the API documentation of
+:class:`~permessage_deflate.ClientPerMessageDeflateFactory` and
+:class:`~permessage_deflate.ServerPerMessageDeflateFactory` for details.
+
+Writing an extension
+--------------------
+
+During the opening handshake, WebSocket clients and servers negotiate which
+extensions will be used with which parameters. Then each frame is processed by
+extensions before being sent or after being received.
+
+As a consequence, writing an extension requires implementing several classes:
+
+* Extension Factory: it negotiates parameters and instantiates the extension.
+
+ Clients and servers require separate extension factories with distinct APIs.
+
+ Extension factories are the public API of an extension.
+
+* Extension: it decodes incoming frames and encodes outgoing frames.
+
+ If the extension is symmetrical, clients and servers can use the same
+ class.
+
+ Extensions are initialized by extension factories, so they don't need to be
+ part of the public API of an extension.
+
+``websockets`` provides abstract base classes for extension factories and
+extensions. See the API documentation for details on their methods:
+
+* :class:`ClientExtensionFactory` and class:`ServerExtensionFactory` for
+ :extension factories,
+* :class:`Extension` for extensions.
+
+
diff --git a/docs/faq.rst b/docs/faq.rst
new file mode 100644
index 000000000..ff91105b4
--- /dev/null
+++ b/docs/faq.rst
@@ -0,0 +1,317 @@
+FAQ
+===
+
+.. currentmodule:: websockets
+
+.. note::
+
+ Many questions asked in :mod:`websockets`' issue tracker are actually
+ about :mod:`asyncio`. Python's documentation about `developing with
+ asyncio`_ is a good complement.
+
+ .. _developing with asyncio: https://docs.python.org/3/library/asyncio-dev.html
+
+Server side
+-----------
+
+Why does the server close the connection after processing one message?
+......................................................................
+
+Your connection handler exits after processing one message. Write a loop to
+process multiple messages.
+
+For example, if your handler looks like this::
+
+ async def handler(websocket, path):
+ print(websocket.recv())
+
+change it like this::
+
+ async def handler(websocket, path):
+ async for message in websocket:
+ print(message)
+
+*Don't feel bad if this happens to you — it's the most common question in
+websockets' issue tracker :-)*
+
+Why can only one client connect at a time?
+..........................................
+
+Your connection handler blocks the event loop. Look for blocking calls.
+Any call that may take some time must be asynchronous.
+
+For example, if you have::
+
+ async def handler(websocket, path):
+ time.sleep(1)
+
+change it to::
+
+ async def handler(websocket, path):
+ await asyncio.sleep(1)
+
+This is part of learning asyncio. It isn't specific to websockets.
+
+See also Python's documentation about `running blocking code`_.
+
+.. _running blocking code: https://docs.python.org/3/library/asyncio-dev.html#running-blocking-code
+
+How can I pass additional arguments to the connection handler?
+..............................................................
+
+You can bind additional arguments to the connection handler with
+:func:`functools.partial`::
+
+ import asyncio
+ import functools
+ import websockets
+
+ async def handler(websocket, path, extra_argument):
+ ...
+
+ bound_handler = functools.partial(handler, extra_argument='spam')
+ start_server = websockets.serve(bound_handler, ...)
+
+Another way to achieve this result is to define the ``handler`` coroutine in
+a scope where the ``extra_argument`` variable exists instead of injecting it
+through an argument.
+
+How do I get access HTTP headers, for example cookies?
+......................................................
+
+To access HTTP headers during the WebSocket handshake, you can override
+:attr:`~legacy.server.WebSocketServerProtocol.process_request`::
+
+ async def process_request(self, path, request_headers):
+ cookies = request_header["Cookie"]
+
+Once the connection is established, they're available in
+:attr:`~legacy.protocol.WebSocketServerProtocol.request_headers`::
+
+ async def handler(websocket, path):
+ cookies = websocket.request_headers["Cookie"]
+
+How do I get the IP address of the client connecting to my server?
+..................................................................
+
+It's available in :attr:`~legacy.protocol.WebSocketCommonProtocol.remote_address`::
+
+ async def handler(websocket, path):
+ remote_ip = websocket.remote_address[0]
+
+How do I set which IP addresses my server listens to?
+.....................................................
+
+Look at the ``host`` argument of :meth:`~asyncio.loop.create_server`.
+
+:func:`serve` accepts the same arguments as
+:meth:`~asyncio.loop.create_server`.
+
+How do I close a connection properly?
+.....................................
+
+websockets takes care of closing the connection when the handler exits.
+
+How do I run a HTTP server and WebSocket server on the same port?
+.................................................................
+
+This isn't supported.
+
+Providing a HTTP server is out of scope for websockets. It only aims at
+providing a WebSocket server.
+
+There's limited support for returning HTTP responses with the
+:attr:`~legacy.server.WebSocketServerProtocol.process_request` hook.
+If you need more, pick a HTTP server and run it separately.
+
+Client side
+-----------
+
+How do I close a connection properly?
+.....................................
+
+The easiest is to use :func:`connect` as a context manager::
+
+ async with connect(...) as websocket:
+ ...
+
+How do I reconnect automatically when the connection drops?
+...........................................................
+
+See `issue 414`_.
+
+.. _issue 414: https://github.com/aaugustin/websockets/issues/414
+
+How do I stop a client that is continuously processing messages?
+................................................................
+
+You can close the connection.
+
+Here's an example that terminates cleanly when it receives SIGTERM on Unix:
+
+.. literalinclude:: ../example/shutdown_client.py
+ :emphasize-lines: 10-13
+
+
+How do I disable TLS/SSL certificate verification?
+..................................................
+
+Look at the ``ssl`` argument of :meth:`~asyncio.loop.create_connection`.
+
+:func:`connect` accepts the same arguments as
+:meth:`~asyncio.loop.create_connection`.
+
+Both sides
+----------
+
+How do I do two things in parallel? How do I integrate with another coroutine?
+..............................................................................
+
+You must start two tasks, which the event loop will run concurrently. You can
+achieve this with :func:`asyncio.gather` or :func:`asyncio.wait`.
+
+This is also part of learning asyncio and not specific to websockets.
+
+Keep track of the tasks and make sure they terminate or you cancel them when
+the connection terminates.
+
+How do I create channels or topics?
+...................................
+
+websockets doesn't have built-in publish / subscribe for these use cases.
+
+Depending on the scale of your service, a simple in-memory implementation may
+do the job or you may need an external publish / subscribe component.
+
+What does ``ConnectionClosedError: code = 1006`` mean?
+......................................................
+
+If you're seeing this traceback in the logs of a server:
+
+.. code-block:: pytb
+
+ Error in connection handler
+ Traceback (most recent call last):
+ ...
+ asyncio.streams.IncompleteReadError: 0 bytes read on a total of 2 expected bytes
+
+ The above exception was the direct cause of the following exception:
+
+ Traceback (most recent call last):
+ ...
+ websockets.exceptions.ConnectionClosedError: code = 1006 (connection closed abnormally [internal]), no reason
+
+or if a client crashes with this traceback:
+
+.. code-block:: pytb
+
+ Traceback (most recent call last):
+ ...
+ ConnectionResetError: [Errno 54] Connection reset by peer
+
+ The above exception was the direct cause of the following exception:
+
+ Traceback (most recent call last):
+ ...
+ websockets.exceptions.ConnectionClosedError: code = 1006 (connection closed abnormally [internal]), no reason
+
+it means that the TCP connection was lost. As a consequence, the WebSocket
+connection was closed without receiving a close frame, which is abnormal.
+
+You can catch and handle :exc:`~exceptions.ConnectionClosed` to prevent it
+from being logged.
+
+There are several reasons why long-lived connections may be lost:
+
+* End-user devices tend to lose network connectivity often and unpredictably
+ because they can move out of wireless network coverage, get unplugged from
+ a wired network, enter airplane mode, be put to sleep, etc.
+* HTTP load balancers or proxies that aren't configured for long-lived
+ connections may terminate connections after a short amount of time, usually
+ 30 seconds.
+
+If you're facing a reproducible issue, :ref:`enable debug logs ` to
+see when and how connections are closed.
+
+How can I pass additional arguments to a custom protocol subclass?
+..................................................................
+
+You can bind additional arguments to the protocol factory with
+:func:`functools.partial`::
+
+ import asyncio
+ import functools
+ import websockets
+
+ class MyServerProtocol(websockets.WebSocketServerProtocol):
+ def __init__(self, extra_argument, *args, **kwargs):
+ super().__init__(*args, **kwargs)
+ # do something with extra_argument
+
+ create_protocol = functools.partial(MyServerProtocol, extra_argument='spam')
+ start_server = websockets.serve(..., create_protocol=create_protocol)
+
+This example was for a server. The same pattern applies on a client.
+
+Why do I get the error: ``module 'websockets' has no attribute '...'``?
+.......................................................................
+
+Often, this is because you created a script called ``websockets.py`` in your
+current working directory. Then ``import websockets`` imports this module
+instead of the websockets library.
+
+Are there ``onopen``, ``onmessage``, ``onerror``, and ``onclose`` callbacks?
+............................................................................
+
+No, there aren't.
+
+websockets provides high-level, coroutine-based APIs. Compared to callbacks,
+coroutines make it easier to manage control flow in concurrent code.
+
+If you prefer callback-based APIs, you should use another library.
+
+Can I use ``websockets`` synchronously, without ``async`` / ``await``?
+......................................................................
+
+You can convert every asynchronous call to a synchronous call by wrapping it
+in ``asyncio.get_event_loop().run_until_complete(...)``.
+
+If this turns out to be impractical, you should use another library.
+
+Miscellaneous
+-------------
+
+How do I set a timeout on ``recv()``?
+.....................................
+
+Use :func:`~asyncio.wait_for`::
+
+ await asyncio.wait_for(websocket.recv(), timeout=10)
+
+This technique works for most APIs, except for asynchronous context managers.
+See `issue 574`_.
+
+.. _issue 574: https://github.com/aaugustin/websockets/issues/574
+
+How do I keep idle connections open?
+....................................
+
+websockets sends pings at 20 seconds intervals to keep the connection open.
+
+In closes the connection if it doesn't get a pong within 20 seconds.
+
+You can adjust this behavior with ``ping_interval`` and ``ping_timeout``.
+
+How do I respond to pings?
+..........................
+
+websockets takes care of responding to pings with pongs.
+
+Is there a Python 2 version?
+............................
+
+No, there isn't.
+
+websockets builds upon asyncio which requires Python 3.
+
+
diff --git a/docs/heroku.rst b/docs/heroku.rst
new file mode 100644
index 000000000..31c4b3f19
--- /dev/null
+++ b/docs/heroku.rst
@@ -0,0 +1,153 @@
+Deploying to Heroku
+===================
+
+This guide describes how to deploy a websockets server to Heroku_. We're going
+to deploy a very simple app. The process would be identical for a more
+realistic app.
+
+.. _Heroku: https://www.heroku.com/
+
+Create application
+------------------
+
+Deploying to Heroku requires a git repository. Let's initialize one:
+
+.. code:: console
+
+ $ mkdir websockets-echo
+ $ cd websockets-echo
+ $ git init .
+ Initialized empty Git repository in websockets-echo/.git/
+ $ git commit --allow-empty -m "Initial commit."
+ [master (root-commit) 1e7947d] Initial commit.
+
+Follow the `set-up instructions`_ to install the Heroku CLI and to log in, if
+you haven't done that yet.
+
+.. _set-up instructions: https://devcenter.heroku.com/articles/getting-started-with-python#set-up
+
+Then, create a Heroku app — if you follow these instructions step-by-step,
+you'll have to pick a different name because I'm already using
+``websockets-echo`` on Heroku:
+
+.. code:: console
+
+ $ $ heroku create websockets-echo
+ Creating ⬢ websockets-echo... done
+ https://websockets-echo.herokuapp.com/ | https://git.heroku.com/websockets-echo.git
+
+Here's the implementation of the app, an echo server. Save it in a file called
+``app.py``:
+
+.. code:: python
+
+ #!/usr/bin/env python
+
+ import asyncio
+ import os
+
+ import websockets
+
+ async def echo(websocket, path):
+ async for message in websocket:
+ await websocket.send(message)
+
+ start_server = websockets.serve(echo, "", int(os.environ["PORT"]))
+
+ asyncio.get_event_loop().run_until_complete(start_server)
+ asyncio.get_event_loop().run_forever()
+
+The server relies on the ``$PORT`` environment variable to tell on which port
+it will listen, according to Heroku's conventions.
+
+Configure deployment
+--------------------
+
+In order to build the app, Heroku needs to know that it depends on websockets.
+Create a ``requirements.txt`` file containing this line:
+
+.. code::
+
+ websockets
+
+Heroku also needs to know how to run the app. Create a ``Procfile`` with this
+content:
+
+.. code::
+
+ web: python app.py
+
+Confirm that you created the correct files and commit them to git:
+
+.. code:: console
+
+ $ ls
+ Procfile app.py requirements.txt
+ $ git add .
+ $ git commit -m "Deploy echo server to Heroku."
+ [master 8418c62] Deploy echo server to Heroku.
+ 3 files changed, 19 insertions(+)
+ create mode 100644 Procfile
+ create mode 100644 app.py
+ create mode 100644 requirements.txt
+
+Deploy
+------
+
+Our app is ready. Let's deploy it!
+
+.. code:: console
+
+ $ git push heroku master
+
+ ... lots of output...
+
+ remote: -----> Launching...
+ remote: Released v3
+ remote: https://websockets-echo.herokuapp.com/ deployed to Heroku
+ remote:
+ remote: Verifying deploy... done.
+ To https://git.heroku.com/websockets-echo.git
+ * [new branch] master -> master
+
+Validate deployment
+-------------------
+
+Of course we'd like to confirm that our application is running as expected!
+
+Since it's a WebSocket server, we need a WebSocket client, such as the
+interactive client that comes with websockets.
+
+If you're currently building a websockets server, perhaps you're already in a
+virtualenv where websockets is installed. If not, you can install it in a new
+virtualenv as follows:
+
+.. code:: console
+
+ $ python -m venv websockets-client
+ $ . websockets-client/bin/activate
+ $ pip install websockets
+
+Connect the interactive client — using the name of your Heroku app instead of
+``websockets-echo``:
+
+.. code:: console
+
+ $ python -m websockets wss://websockets-echo.herokuapp.com/
+ Connected to wss://websockets-echo.herokuapp.com/.
+ >
+
+Great! Our app is running!
+
+In this example, I used a secure connection (``wss://``). It worked because
+Heroku served a valid TLS certificate for ``websockets-echo.herokuapp.com``.
+An insecure connection (``ws://``) would also work.
+
+Once you're connected, you can send any message and the server will echo it,
+then press Ctrl-D to terminate the connection:
+
+.. code:: console
+
+ > Hello!
+ < Hello!
+ Connection closed: code = 1000 (OK), no reason.
diff --git a/docs/index.rst b/docs/index.rst
index 7ccd9463e..5914d7289 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -1,7 +1,7 @@
-WebSockets
+websockets
==========
-|pypi-v| |pypi-pyversions| |pypi-l| |pypi-wheel| |circleci| |codecov|
+|pypi-v| |pypi-pyversions| |pypi-l| |pypi-wheel| |tests|
.. |pypi-v| image:: https://img.shields.io/pypi/v/websockets.svg
:target: https://pypi.python.org/pypi/websockets
@@ -15,11 +15,8 @@ WebSockets
.. |pypi-wheel| image:: https://img.shields.io/pypi/wheel/websockets.svg
:target: https://pypi.python.org/pypi/websockets
-.. |circleci| image:: https://img.shields.io/circleci/project/github/aaugustin/websockets.svg
- :target: https://circleci.com/gh/aaugustin/websockets
-
-.. |codecov| image:: https://codecov.io/gh/aaugustin/websockets/branch/master/graph/badge.svg
- :target: https://codecov.io/gh/aaugustin/websockets
+.. |tests| image:: https://github.com/aaugustin/websockets/workflows/tests/badge.svg?branch=master
+ :target: https://github.com/aaugustin/websockets/actions?workflow=tests
``websockets`` is a library for building WebSocket servers_ and clients_ in
Python with a focus on correctness and simplicity.
@@ -30,7 +27,7 @@ Python with a focus on correctness and simplicity.
Built on top of :mod:`asyncio`, Python's standard asynchronous I/O framework,
it provides an elegant coroutine-based API.
-Here's a client that says "Hello world!":
+Here's how a client sends and receives messages:
.. literalinclude:: ../example/hello.py
@@ -49,6 +46,7 @@ If you're new to ``websockets``, this is the place to start.
:maxdepth: 2
intro
+ faq
How-to guides
-------------
@@ -60,6 +58,8 @@ These guides will help you build and deploy a ``websockets`` application.
cheatsheet
deployment
+ extensions
+ heroku
Reference
---------
@@ -69,7 +69,7 @@ Find all the details you could ask for, and then some.
.. toctree::
:maxdepth: 2
- api
+ api/index
Discussions
-----------
@@ -91,6 +91,7 @@ This is about websockets-the-project rather than websockets-the-software.
.. toctree::
:maxdepth: 2
- contributing
changelog
+ contributing
license
+ For enterprise
diff --git a/docs/intro.rst b/docs/intro.rst
index 154e1d8ea..c77139cab 100644
--- a/docs/intro.rst
+++ b/docs/intro.rst
@@ -6,20 +6,12 @@ Getting started
Requirements
------------
-``websockets`` requires Python ≥ 3.4.
+``websockets`` requires Python ≥ 3.6.1.
You should use the latest version of Python if possible. If you're using an
older version, be aware that for each minor version (3.x), only the latest
bugfix release (3.x.y) is officially supported.
-For the best experience, you should start with Python ≥ 3.6. :mod:`asyncio`
-received interesting improvements between Python 3.4 and 3.6.
-
-.. warning::
-
- This documentation is written for Python ≥ 3.6. If you're using an older
- Python version, you need to :ref:`adapt the code samples `.
-
Installation
------------
@@ -48,11 +40,13 @@ coroutine returns.
Here's a corresponding WebSocket client example.
.. literalinclude:: ../example/client.py
- :emphasize-lines: 8-10
+ :emphasize-lines: 8,10
Using :func:`connect` as an asynchronous context manager ensures the
connection is closed before exiting the ``hello`` coroutine.
+.. _secure-server-example:
+
Secure example
--------------
@@ -60,27 +54,25 @@ Secure WebSocket connections improve confidentiality and also reliability
because they reduce the risk of interference by bad proxies.
The WSS protocol is to WS what HTTPS is to HTTP: the connection is encrypted
-with TLS. WSS requires TLS certificates like HTTPS.
-
-Here's how to adapt the server example to provide secure connections, using
-APIs available in Python ≥ 3.6.
+with Transport Layer Security (TLS) — which is often referred to as Secure
+Sockets Layer (SSL). WSS requires TLS certificates like HTTPS.
-Refer to the documentation of the :mod:`ssl` module for configuring the
-context securely or adapting the code to older Python versions.
+Here's how to adapt the server example to provide secure connections. See the
+documentation of the :mod:`ssl` module for configuring the context securely.
.. literalinclude:: ../example/secure_server.py
- :emphasize-lines: 19,23-24
+ :emphasize-lines: 19,23-25
-Here's how to adapt the client, also on Python ≥ 3.6.
+Here's how to adapt the client.
.. literalinclude:: ../example/secure_client.py
- :emphasize-lines: 10,15-16
+ :emphasize-lines: 10,15-18
This client needs a context because the server uses a self-signed certificate.
A client connecting to a secure WebSocket server with a valid certificate
(i.e. signed by a CA that your Python installation trusts) can simply pass
-``ssl=True`` to :func:`connect`` instead of building a context.
+``ssl=True`` to :func:`connect` instead of building a context.
Browser-based example
---------------------
@@ -138,18 +130,6 @@ messages received on the WebSocket connection.
Iteration terminates when the client disconnects.
-Asynchronous iteration was introduced in Python 3.6; here's the same code for
-earlier Python versions::
-
- async def consumer_handler(websocket, path):
- while True:
- message = await websocket.recv()
- await consumer(message)
-
-:meth:`~protocol.WebSocketCommonProtocol.recv` raises a
-:exc:`~exceptions.ConnectionClosed` exception when the client disconnects,
-which breaks out of the ``while True`` loop.
-
Producer
........
@@ -163,7 +143,7 @@ For getting messages from a ``producer`` coroutine and sending them::
In this example, ``producer`` represents your business logic for generating
messages to send on the WebSocket connection.
-:meth:`~protocol.WebSocketCommonProtocol.send` raises a
+:meth:`~legacy.protocol.WebSocketCommonProtocol.send` raises a
:exc:`~exceptions.ConnectionClosed` exception when the client disconnects,
which breaks out of the ``while True`` loop.
@@ -200,7 +180,7 @@ unregister them when they disconnect.
# Register.
connected.add(websocket)
try:
- # Implement logic here.
+ # Broadcast a message to all connected clients.
await asyncio.wait([ws.send("Hello!") for ws in connected])
await asyncio.sleep(10)
finally:
@@ -227,87 +207,3 @@ One more thing...
``websockets`` provides an interactive client::
$ python -m websockets wss://echo.websocket.org/
-
-.. _python-lt-36:
-
-Python < 3.6
-------------
-
-This documentation takes advantage of several features that aren't available
-in Python < 3.6:
-
-- ``await`` and ``async`` were added in Python 3.5;
-- Asynchronous context managers didn't work well until Python 3.5.1;
-- Asynchronous iterators were added in Python 3.6;
-- f-strings were introduced in Python 3.6 (this is unrelated to :mod:`asyncio`
- and :mod:`websockets`).
-
-Here's how to adapt the basic server example.
-
-.. literalinclude:: ../example/old_server.py
- :emphasize-lines: 8-9,18
-
-And here's the basic client example.
-
-.. literalinclude:: ../example/old_client.py
- :emphasize-lines: 8-11,13,22-23
-
-``await`` and ``async``
-.......................
-
-If you're using Python < 3.5, you must substitute::
-
- async def ...
-
-with::
-
- @asyncio.coroutine
- def ...
-
-and::
-
- await ...
-
-with::
-
- yield from ...
-
-Otherwise you will encounter a :exc:`SyntaxError`.
-
-Asynchronous context managers
-.............................
-
-Asynchronous context managers were added in Python 3.5. However,
-``websockets`` only supports them on Python ≥ 3.5.1, where
-:func:`~asyncio.ensure_future` accepts any awaitable.
-
-If you're using Python < 3.5.1, instead of::
-
- with websockets.connect(...) as client:
- ...
-
-you must write::
-
- client = yield from websockets.connect(...)
- try:
- ...
- finally:
- yield from client.close()
-
-Asynchronous iterators
-......................
-
-If you're using Python < 3.6, you must replace::
-
- async for message in websocket:
- ...
-
-with::
-
- while True:
- message = yield from websocket.recv()
- ...
-
-The latter will always raise a :exc:`~exceptions.ConnectionClosed` exception
-when the connection is closed, while the former will only raise that exception
-if the connection terminates with an error.
diff --git a/docs/protocol.graffle b/docs/protocol.graffle
index 13fdb307e..df76f4960 100644
Binary files a/docs/protocol.graffle and b/docs/protocol.graffle differ
diff --git a/docs/protocol.svg b/docs/protocol.svg
index 301bb1b4c..51bfd982b 100644
--- a/docs/protocol.svg
+++ b/docs/protocol.svg
@@ -1,3 +1,3 @@
- Produced by OmniGraffle 6.6.2 2017-09-24 19:39:13 +0000 Canvas 1 Layer 1 remote endpoint websock ets WebSocketCommonProtocol application logic reader StreamReader writer StreamWriter pings dict transfer_data_task Task network read_frame read_data_frame read_message bytes frames data frames write_frame messages deque recv send ping pong close control frames bytes frames Produced by OmniGraffle 6.6.2 2019-07-07 08:38:24 +0000 Canvas 1 Layer 1 remote endpoint websock ets WebSocketCommonProtocol application logic reader StreamReader writer StreamWriter pings dict transfer_data_task Task network read_frame read_data_frame read_message bytes frames data frames write_frame messages deque recv send ping pong close control frames bytes frames `.
+
Memory use
----------
+
.. warning::
An attacker who can open an arbitrary number of connections will be able
@@ -10,27 +19,13 @@ Memory use
by denial of service attacks, you must reject suspicious connections
before they reach ``websockets``, typically in a reverse proxy.
-The baseline memory use for a connection is about 20kB.
-
-The incoming bytes buffer, incoming messages queue and outgoing bytes buffer
-contribute to the memory use of a connection. By default, each bytes buffer
-takes up to 64kB and the messages queue up to 128MB, which is very large.
-
-Most applications use small messages. Setting ``max_size`` according to the
-application's requirements is strongly recommended. See :ref:`buffers` for
-details about tuning buffers.
-
-When compression is enabled, additional memory may be allocated for carrying
-the compression context across messages, depending on the context takeover and
-window size parameters. With the default configuration, this adds 320kB to the
-memory use for a connection.
+With the default settings, opening a connection uses 325 KiB of memory.
-You can reduce this amount by configuring the ``PerMessageDeflate`` extension
-with lower ``server_max_window_bits`` and ``client_max_window_bits`` values.
-These parameters default is 15. Lowering them to 11 is a good choice.
+Sending some highly compressed messages could use up to 128 MiB of memory
+with an amplification factor of 1000 between network traffic and memory use.
-Finally, memory consumed by your application code also counts towards the
-memory use of a connection.
+Configuring a server to :ref:`optimize memory usage ` will
+improve security in addition to improving performance.
Other limits
------------
diff --git a/docs/spelling_wordlist.txt b/docs/spelling_wordlist.txt
index ba30efd99..4d8fc1e2d 100644
--- a/docs/spelling_wordlist.txt
+++ b/docs/spelling_wordlist.txt
@@ -5,29 +5,53 @@ awaitable
aymeric
backpressure
Backpressure
+balancer
+balancers
Bitcoin
+bottlenecked
bufferbloat
Bufferbloat
bugfix
+bytestring
+bytestrings
changelog
+coroutine
+coroutines
+cryptocurrencies
cryptocurrency
+Ctrl
daemonize
+datastructures
fractalideas
+IPv
iterable
-kB
keepalive
+KiB
lifecycle
Lifecycle
+lookups
+MiB
+mypy
nginx
+parsers
permessage
pong
+pongs
Pythonic
serializers
+Subclasses
+subclasses
subclassing
subprotocol
subprotocols
+Tidelift
TLS
+tox
Unparse
+unregister
+uple
+username
+virtualenv
websocket
WebSocket
websockets
diff --git a/docs/tidelift.rst b/docs/tidelift.rst
new file mode 100644
index 000000000..43b457aaf
--- /dev/null
+++ b/docs/tidelift.rst
@@ -0,0 +1,112 @@
+websockets for enterprise
+=========================
+
+Available as part of the Tidelift Subscription
+----------------------------------------------
+
+.. image:: _static/tidelift.png
+ :height: 150px
+ :width: 150px
+ :align: left
+
+Tidelift is working with the maintainers of websockets and thousands of other
+open source projects to deliver commercial support and maintenance for the
+open source dependencies you use to build your applications. Save time, reduce
+risk, and improve code health, while paying the maintainers of the exact
+dependencies you use.
+
+.. raw:: html
+
+
+
+
+
+Enterprise-ready open source software—managed for you
+-----------------------------------------------------
+
+The Tidelift Subscription is a managed open source subscription for
+application dependencies covering millions of open source projects across
+JavaScript, Python, Java, PHP, Ruby, .NET, and more.
+
+Your subscription includes:
+
+* **Security updates**
+
+ * Tidelift’s security response team coordinates patches for new breaking
+ security vulnerabilities and alerts immediately through a private channel,
+ so your software supply chain is always secure.
+
+* **Licensing verification and indemnification**
+
+ * Tidelift verifies license information to enable easy policy enforcement
+ and adds intellectual property indemnification to cover creators and users
+ in case something goes wrong. You always have a 100% up-to-date bill of
+ materials for your dependencies to share with your legal team, customers,
+ or partners.
+
+* **Maintenance and code improvement**
+
+ * Tidelift ensures the software you rely on keeps working as long as you
+ need it to work. Your managed dependencies are actively maintained and we
+ recruit additional maintainers where required.
+
+* **Package selection and version guidance**
+
+ * We help you choose the best open source packages from the start—and then
+ guide you through updates to stay on the best releases as new issues
+ arise.
+
+* **Roadmap input**
+
+ * Take a seat at the table with the creators behind the software you use.
+ Tidelift’s participating maintainers earn more income as their software is
+ used by more subscribers, so they’re interested in knowing what you need.
+
+* **Tooling and cloud integration**
+
+ * Tidelift works with GitHub, GitLab, BitBucket, and more. We support every
+ cloud platform (and other deployment targets, too).
+
+The end result? All of the capabilities you expect from commercial-grade
+software, for the full breadth of open source you use. That means less time
+grappling with esoteric open source trivia, and more time building your own
+applications—and your business.
+
+.. raw:: html
+
+
diff --git a/example/basic_auth_client.py b/example/basic_auth_client.py
new file mode 100755
index 000000000..cc94dbe4b
--- /dev/null
+++ b/example/basic_auth_client.py
@@ -0,0 +1,14 @@
+#!/usr/bin/env python
+
+# WS client example with HTTP Basic Authentication
+
+import asyncio
+import websockets
+
+async def hello():
+ uri = "ws://mary:p@ssw0rd@localhost:8765"
+ async with websockets.connect(uri) as websocket:
+ greeting = await websocket.recv()
+ print(greeting)
+
+asyncio.get_event_loop().run_until_complete(hello())
diff --git a/example/basic_auth_server.py b/example/basic_auth_server.py
new file mode 100755
index 000000000..6740d5798
--- /dev/null
+++ b/example/basic_auth_server.py
@@ -0,0 +1,20 @@
+#!/usr/bin/env python
+
+# Server example with HTTP Basic Authentication over TLS
+
+import asyncio
+import websockets
+
+async def hello(websocket, path):
+ greeting = f"Hello {websocket.username}!"
+ await websocket.send(greeting)
+
+start_server = websockets.serve(
+ hello, "localhost", 8765,
+ create_protocol=websockets.basic_auth_protocol_factory(
+ realm="example", credentials=("mary", "p@ssw0rd")
+ ),
+)
+
+asyncio.get_event_loop().run_until_complete(start_server)
+asyncio.get_event_loop().run_forever()
diff --git a/example/client.py b/example/client.py
index e71595ff5..4f969c478 100755
--- a/example/client.py
+++ b/example/client.py
@@ -6,8 +6,8 @@
import websockets
async def hello():
- async with websockets.connect(
- 'ws://localhost:8765') as websocket:
+ uri = "ws://localhost:8765"
+ async with websockets.connect(uri) as websocket:
name = input("What's your name? ")
await websocket.send(name)
diff --git a/example/counter.py b/example/counter.py
index 9cce009fd..239ec203a 100755
--- a/example/counter.py
+++ b/example/counter.py
@@ -9,34 +9,41 @@
logging.basicConfig()
-STATE = {'value': 0}
+STATE = {"value": 0}
USERS = set()
+
def state_event():
- return json.dumps({'type': 'state', **STATE})
+ return json.dumps({"type": "state", **STATE})
+
def users_event():
- return json.dumps({'type': 'users', 'count': len(USERS)})
+ return json.dumps({"type": "users", "count": len(USERS)})
+
async def notify_state():
- if USERS: # asyncio.wait doesn't accept an empty list
+ if USERS: # asyncio.wait doesn't accept an empty list
message = state_event()
await asyncio.wait([user.send(message) for user in USERS])
+
async def notify_users():
- if USERS: # asyncio.wait doesn't accept an empty list
+ if USERS: # asyncio.wait doesn't accept an empty list
message = users_event()
await asyncio.wait([user.send(message) for user in USERS])
+
async def register(websocket):
USERS.add(websocket)
await notify_users()
+
async def unregister(websocket):
USERS.remove(websocket)
await notify_users()
+
async def counter(websocket, path):
# register(websocket) sends user_event() to websocket
await register(websocket)
@@ -44,18 +51,19 @@ async def counter(websocket, path):
await websocket.send(state_event())
async for message in websocket:
data = json.loads(message)
- if data['action'] == 'minus':
- STATE['value'] -= 1
+ if data["action"] == "minus":
+ STATE["value"] -= 1
await notify_state()
- elif data['action'] == 'plus':
- STATE['value'] += 1
+ elif data["action"] == "plus":
+ STATE["value"] += 1
await notify_state()
else:
- logging.error(
- "unsupported event: {}", data)
+ logging.error("unsupported event: %s", data)
finally:
await unregister(websocket)
-asyncio.get_event_loop().run_until_complete(
- websockets.serve(counter, 'localhost', 6789))
+
+start_server = websockets.serve(counter, "localhost", 6789)
+
+asyncio.get_event_loop().run_until_complete(start_server)
asyncio.get_event_loop().run_forever()
diff --git a/example/echo.py b/example/echo.py
index 8fa307dd7..b7ca38d32 100755
--- a/example/echo.py
+++ b/example/echo.py
@@ -7,6 +7,7 @@ async def echo(websocket, path):
async for message in websocket:
await websocket.send(message)
-asyncio.get_event_loop().run_until_complete(
- websockets.serve(echo, 'localhost', 8765))
+start_server = websockets.serve(echo, "localhost", 8765)
+
+asyncio.get_event_loop().run_until_complete(start_server)
asyncio.get_event_loop().run_forever()
diff --git a/example/health_check_server.py b/example/health_check_server.py
index 8e70890b5..417063fce 100755
--- a/example/health_check_server.py
+++ b/example/health_check_server.py
@@ -6,16 +6,17 @@
import http
import websockets
-def health_check(path, request_headers):
- if path == '/health/':
- return http.HTTPStatus.OK, [], b'OK\n'
+async def health_check(path, request_headers):
+ if path == "/health/":
+ return http.HTTPStatus.OK, [], b"OK\n"
async def echo(websocket, path):
async for message in websocket:
await websocket.send(message)
start_server = websockets.serve(
- echo, 'localhost', 8765, process_request=health_check)
+ echo, "localhost", 8765, process_request=health_check
+)
asyncio.get_event_loop().run_until_complete(start_server)
asyncio.get_event_loop().run_forever()
diff --git a/example/hello.py b/example/hello.py
index bbb3d9a0e..6c9c839d8 100755
--- a/example/hello.py
+++ b/example/hello.py
@@ -3,9 +3,10 @@
import asyncio
import websockets
-async def hello(uri):
+async def hello():
+ uri = "ws://localhost:8765"
async with websockets.connect(uri) as websocket:
await websocket.send("Hello world!")
+ await websocket.recv()
-asyncio.get_event_loop().run_until_complete(
- hello('ws://localhost:8765'))
+asyncio.get_event_loop().run_until_complete(hello())
diff --git a/example/old_client.py b/example/old_client.py
deleted file mode 100755
index c44d6edff..000000000
--- a/example/old_client.py
+++ /dev/null
@@ -1,25 +0,0 @@
-#!/usr/bin/env python
-
-# WS client example for old Python versions
-
-import asyncio
-import websockets
-
-@asyncio.coroutine
-def hello():
- websocket = yield from websockets.connect(
- 'ws://localhost:8765/')
-
- try:
- name = input("What's your name? ")
-
- yield from websocket.send(name)
- print("> {}".format(name))
-
- greeting = yield from websocket.recv()
- print("< {}".format(greeting))
-
- finally:
- yield from websocket.close()
-
-asyncio.get_event_loop().run_until_complete(hello())
diff --git a/example/old_server.py b/example/old_server.py
deleted file mode 100755
index bb19bdabc..000000000
--- a/example/old_server.py
+++ /dev/null
@@ -1,21 +0,0 @@
-#!/usr/bin/env python
-
-# WS server example for old Python versions
-
-import asyncio
-import websockets
-
-@asyncio.coroutine
-def hello(websocket, path):
- name = yield from websocket.recv()
- print("< {}".format(name))
-
- greeting = "Hello {}!".format(name)
-
- yield from websocket.send(greeting)
- print("> {}".format(greeting))
-
-start_server = websockets.serve(hello, 'localhost', 8765)
-
-asyncio.get_event_loop().run_until_complete(start_server)
-asyncio.get_event_loop().run_forever()
diff --git a/example/old_shutdown.py b/example/old_shutdown.py
deleted file mode 100755
index 180da9059..000000000
--- a/example/old_shutdown.py
+++ /dev/null
@@ -1,29 +0,0 @@
-#!/usr/bin/env python
-
-import asyncio
-import signal
-import websockets
-
-async def echo(websocket, path):
- while True:
- try:
- msg = await websocket.recv()
- except websockets.ConnectionClosed:
- break
- else:
- await websocket.send(msg)
-
-loop = asyncio.get_event_loop()
-
-# Create the server.
-start_server = websockets.serve(echo, 'localhost', 8765)
-server = loop.run_until_complete(start_server)
-
-# Run the server until receiving SIGTERM.
-stop = asyncio.Future()
-loop.add_signal_handler(signal.SIGTERM, stop.set_result, None)
-loop.run_until_complete(stop)
-
-# Shut down the server.
-server.close()
-loop.run_until_complete(server.wait_closed())
diff --git a/example/secure_client.py b/example/secure_client.py
index 8e7f57ff9..54971b984 100755
--- a/example/secure_client.py
+++ b/example/secure_client.py
@@ -8,12 +8,14 @@
import websockets
ssl_context = ssl.SSLContext(ssl.PROTOCOL_TLS_CLIENT)
-ssl_context.load_verify_locations(
- pathlib.Path(__file__).with_name('localhost.pem'))
+localhost_pem = pathlib.Path(__file__).with_name("localhost.pem")
+ssl_context.load_verify_locations(localhost_pem)
async def hello():
+ uri = "wss://localhost:8765"
async with websockets.connect(
- 'wss://localhost:8765', ssl=ssl_context) as websocket:
+ uri, ssl=ssl_context
+ ) as websocket:
name = input("What's your name? ")
await websocket.send(name)
diff --git a/example/secure_server.py b/example/secure_server.py
index 5cbed46c0..2a00bdb50 100755
--- a/example/secure_server.py
+++ b/example/secure_server.py
@@ -17,11 +17,12 @@ async def hello(websocket, path):
print(f"> {greeting}")
ssl_context = ssl.SSLContext(ssl.PROTOCOL_TLS_SERVER)
-ssl_context.load_cert_chain(
- pathlib.Path(__file__).with_name('localhost.pem'))
+localhost_pem = pathlib.Path(__file__).with_name("localhost.pem")
+ssl_context.load_cert_chain(localhost_pem)
start_server = websockets.serve(
- hello, 'localhost', 8765, ssl=ssl_context)
+ hello, "localhost", 8765, ssl=ssl_context
+)
asyncio.get_event_loop().run_until_complete(start_server)
asyncio.get_event_loop().run_forever()
diff --git a/example/server.py b/example/server.py
index cc5c8fea8..c8ab69971 100755
--- a/example/server.py
+++ b/example/server.py
@@ -14,7 +14,7 @@ async def hello(websocket, path):
await websocket.send(greeting)
print(f"> {greeting}")
-start_server = websockets.serve(hello, 'localhost', 8765)
+start_server = websockets.serve(hello, "localhost", 8765)
asyncio.get_event_loop().run_until_complete(start_server)
asyncio.get_event_loop().run_forever()
diff --git a/example/show_time.py b/example/show_time.py
index 6d196deb3..e5d6ac9aa 100755
--- a/example/show_time.py
+++ b/example/show_time.py
@@ -9,11 +9,11 @@
async def time(websocket, path):
while True:
- now = datetime.datetime.utcnow().isoformat() + 'Z'
+ now = datetime.datetime.utcnow().isoformat() + "Z"
await websocket.send(now)
await asyncio.sleep(random.random() * 3)
-start_server = websockets.serve(time, '127.0.0.1', 5678)
+start_server = websockets.serve(time, "127.0.0.1", 5678)
asyncio.get_event_loop().run_until_complete(start_server)
asyncio.get_event_loop().run_forever()
diff --git a/example/shutdown_client.py b/example/shutdown_client.py
new file mode 100755
index 000000000..f21c0f6fa
--- /dev/null
+++ b/example/shutdown_client.py
@@ -0,0 +1,19 @@
+#!/usr/bin/env python
+
+import asyncio
+import signal
+import websockets
+
+async def client():
+ uri = "ws://localhost:8765"
+ async with websockets.connect(uri) as websocket:
+ # Close the connection when receiving SIGTERM.
+ loop = asyncio.get_event_loop()
+ loop.add_signal_handler(
+ signal.SIGTERM, loop.create_task, websocket.close())
+
+ # Process messages received on the connection.
+ async for message in websocket:
+ ...
+
+asyncio.get_event_loop().run_until_complete(client())
diff --git a/example/shutdown.py b/example/shutdown_server.py
similarity index 84%
rename from example/shutdown.py
rename to example/shutdown_server.py
index dd3e8f6a4..86846abe7 100755
--- a/example/shutdown.py
+++ b/example/shutdown_server.py
@@ -9,13 +9,13 @@ async def echo(websocket, path):
await websocket.send(message)
async def echo_server(stop):
- async with websockets.serve(echo, 'localhost', 8765):
+ async with websockets.serve(echo, "localhost", 8765):
await stop
loop = asyncio.get_event_loop()
# The stop condition is set when receiving SIGTERM.
-stop = asyncio.Future()
+stop = loop.create_future()
loop.add_signal_handler(signal.SIGTERM, stop.set_result, None)
# Run the server until the stop condition is met.
diff --git a/example/unix_client.py b/example/unix_client.py
new file mode 100755
index 000000000..577135b3d
--- /dev/null
+++ b/example/unix_client.py
@@ -0,0 +1,19 @@
+#!/usr/bin/env python
+
+# WS client example connecting to a Unix socket
+
+import asyncio
+import os.path
+import websockets
+
+async def hello():
+ socket_path = os.path.join(os.path.dirname(__file__), "socket")
+ async with websockets.unix_connect(socket_path) as websocket:
+ name = input("What's your name? ")
+ await websocket.send(name)
+ print(f"> {name}")
+
+ greeting = await websocket.recv()
+ print(f"< {greeting}")
+
+asyncio.get_event_loop().run_until_complete(hello())
diff --git a/example/unix_server.py b/example/unix_server.py
new file mode 100755
index 000000000..a6ec0168a
--- /dev/null
+++ b/example/unix_server.py
@@ -0,0 +1,22 @@
+#!/usr/bin/env python
+
+# WS server example listening on a Unix socket
+
+import asyncio
+import os.path
+import websockets
+
+async def hello(websocket, path):
+ name = await websocket.recv()
+ print(f"< {name}")
+
+ greeting = f"Hello {name}!"
+
+ await websocket.send(greeting)
+ print(f"> {greeting}")
+
+socket_path = os.path.join(os.path.dirname(__file__), "socket")
+start_server = websockets.unix_serve(hello, socket_path)
+
+asyncio.get_event_loop().run_until_complete(start_server)
+asyncio.get_event_loop().run_forever()
diff --git a/logo/horizontal.svg b/logo/horizontal.svg
new file mode 100644
index 000000000..ee872dc47
--- /dev/null
+++ b/logo/horizontal.svg
@@ -0,0 +1,31 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/logo/icon.svg b/logo/icon.svg
new file mode 100644
index 000000000..cb760940a
--- /dev/null
+++ b/logo/icon.svg
@@ -0,0 +1,15 @@
+
+
+
+
+
+
+
+
diff --git a/logo/old.svg b/logo/old.svg
new file mode 100644
index 000000000..a073139e3
--- /dev/null
+++ b/logo/old.svg
@@ -0,0 +1,14 @@
+
+
+
+
+
+
diff --git a/logo/tidelift.png b/logo/tidelift.png
new file mode 100644
index 000000000..317dc4d98
Binary files /dev/null and b/logo/tidelift.png differ
diff --git a/logo/vertical.svg b/logo/vertical.svg
new file mode 100644
index 000000000..b07fb2238
--- /dev/null
+++ b/logo/vertical.svg
@@ -0,0 +1,31 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/performance/mem_client.py b/performance/mem_client.py
new file mode 100644
index 000000000..890216edf
--- /dev/null
+++ b/performance/mem_client.py
@@ -0,0 +1,54 @@
+#!/usr/bin/env python
+
+import asyncio
+import statistics
+import tracemalloc
+
+import websockets
+from websockets.extensions import permessage_deflate
+
+
+CLIENTS = 10
+INTERVAL = 1 / 10 # seconds
+
+MEM_SIZE = []
+
+
+async def mem_client(client):
+ # Space out connections to make them sequential.
+ await asyncio.sleep(client * INTERVAL)
+
+ tracemalloc.start()
+
+ async with websockets.connect(
+ "ws://localhost:8765",
+ extensions=[
+ permessage_deflate.ClientPerMessageDeflateFactory(
+ server_max_window_bits=10,
+ client_max_window_bits=10,
+ compress_settings={"memLevel": 3},
+ )
+ ],
+ ) as ws:
+ await ws.send("hello")
+ await ws.recv()
+
+ await ws.send(b"hello")
+ await ws.recv()
+
+ MEM_SIZE.append(tracemalloc.get_traced_memory()[0])
+ tracemalloc.stop()
+
+ # Hold connection open until the end of the test.
+ await asyncio.sleep(CLIENTS * INTERVAL)
+
+
+asyncio.get_event_loop().run_until_complete(
+ asyncio.gather(*[mem_client(client) for client in range(CLIENTS + 1)])
+)
+
+# First connection incurs non-representative setup costs.
+del MEM_SIZE[0]
+
+print(f"µ = {statistics.mean(MEM_SIZE) / 1024:.1f} KiB")
+print(f"σ = {statistics.stdev(MEM_SIZE) / 1024:.1f} KiB")
diff --git a/performance/mem_server.py b/performance/mem_server.py
new file mode 100644
index 000000000..0a4a29f76
--- /dev/null
+++ b/performance/mem_server.py
@@ -0,0 +1,63 @@
+#!/usr/bin/env python
+
+import asyncio
+import signal
+import statistics
+import tracemalloc
+
+import websockets
+from websockets.extensions import permessage_deflate
+
+
+CLIENTS = 10
+INTERVAL = 1 / 10 # seconds
+
+MEM_SIZE = []
+
+
+async def handler(ws, path):
+ msg = await ws.recv()
+ await ws.send(msg)
+
+ msg = await ws.recv()
+ await ws.send(msg)
+
+ MEM_SIZE.append(tracemalloc.get_traced_memory()[0])
+ tracemalloc.stop()
+
+ tracemalloc.start()
+
+ # Hold connection open until the end of the test.
+ await asyncio.sleep(CLIENTS * INTERVAL)
+
+
+async def mem_server(stop):
+ async with websockets.serve(
+ handler,
+ "localhost",
+ 8765,
+ extensions=[
+ permessage_deflate.ServerPerMessageDeflateFactory(
+ server_max_window_bits=10,
+ client_max_window_bits=10,
+ compress_settings={"memLevel": 3},
+ )
+ ],
+ ):
+ await stop
+
+
+loop = asyncio.get_event_loop()
+
+stop = loop.create_future()
+loop.add_signal_handler(signal.SIGINT, stop.set_result, None)
+
+tracemalloc.start()
+
+loop.run_until_complete(mem_server(stop))
+
+# First connection incurs non-representative setup costs.
+del MEM_SIZE[0]
+
+print(f"µ = {statistics.mean(MEM_SIZE) / 1024:.1f} KiB")
+print(f"σ = {statistics.stdev(MEM_SIZE) / 1024:.1f} KiB")
diff --git a/setup.cfg b/setup.cfg
index ad3af102f..04b792989 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -1,21 +1,17 @@
[bdist_wheel]
-python-tag = py34.py35.py36.py37
+python-tag = py36.py37.py38.py39
[metadata]
license_file = LICENSE
[flake8]
-ignore = E731,F403,F405,W503
+ignore = E203,E731,F403,F405,W503
max-line-length = 88
[isort]
+profile = black
combine_as_imports = True
-force_grid_wrap = 0
-include_trailing_comma = True
-known_standard_library = asyncio
-line_length = 88
lines_after_imports = 2
-multi_line_output = 3
[coverage:run]
branch = True
diff --git a/setup.py b/setup.py
index 3a86887aa..5adb8e835 100644
--- a/setup.py
+++ b/setup.py
@@ -1,4 +1,5 @@
import pathlib
+import re
import sys
import setuptools
@@ -8,28 +9,22 @@
description = "An implementation of the WebSocket Protocol (RFC 6455 & 7692)"
-# When dropping Python < 3.5, change to:
-# long_description = (root_dir / 'README.rst').read_text(encoding='utf-8')
-with (root_dir / 'README.rst').open(encoding='utf-8') as f:
- long_description = f.read()
+long_description = (root_dir / 'README.rst').read_text(encoding='utf-8')
-# When dropping Python < 3.5, change to:
-# exec((root_dir / 'src' / 'websockets' / 'version.py').read_text(encoding='utf-8'))
-with (root_dir / 'src' / 'websockets' / 'version.py').open(encoding='utf-8') as f:
- exec(f.read())
-
-py_version = sys.version_info[:2]
-
-if py_version < (3, 4):
- raise Exception("websockets requires Python >= 3.4.")
+# PyPI disables the "raw" directive.
+long_description = re.sub(
+ r"^\.\. raw:: html.*?^(?=\w)",
+ "",
+ long_description,
+ flags=re.DOTALL | re.MULTILINE,
+)
-packages = ['websockets', 'websockets/extensions']
+exec((root_dir / 'src' / 'websockets' / 'version.py').read_text(encoding='utf-8'))
-if py_version >= (3, 5):
- packages.append('websockets/py35')
+if sys.version_info[:3] < (3, 6, 1):
+ raise Exception("websockets requires Python >= 3.6.1.")
-if py_version >= (3, 6):
- packages.append('websockets/py36')
+packages = ['websockets', 'websockets/legacy', 'websockets/extensions']
ext_modules = [
setuptools.Extension(
@@ -56,16 +51,17 @@
'Operating System :: OS Independent',
'Programming Language :: Python',
'Programming Language :: Python :: 3',
- 'Programming Language :: Python :: 3.4',
- 'Programming Language :: Python :: 3.5',
'Programming Language :: Python :: 3.6',
'Programming Language :: Python :: 3.7',
+ 'Programming Language :: Python :: 3.8',
+ 'Programming Language :: Python :: 3.9',
],
package_dir = {'': 'src'},
+ package_data = {'websockets': ['py.typed']},
packages=packages,
ext_modules=ext_modules,
include_package_data=True,
- zip_safe=True,
- python_requires='>=3.4',
+ zip_safe=False,
+ python_requires='>=3.6.1',
test_loader='unittest:TestLoader',
)
diff --git a/src/websockets/__init__.py b/src/websockets/__init__.py
index 5fbff0d41..65d9fb913 100644
--- a/src/websockets/__init__.py
+++ b/src/websockets/__init__.py
@@ -1,17 +1,106 @@
-# This relies on each of the submodules having an __all__ variable.
-
-from .client import *
-from .exceptions import *
-from .protocol import *
-from .server import *
-from .uri import *
+from .imports import lazy_import
from .version import version as __version__ # noqa
-__all__ = (
- client.__all__
- + exceptions.__all__
- + protocol.__all__
- + server.__all__
- + uri.__all__
+__all__ = [ # noqa
+ "AbortHandshake",
+ "basic_auth_protocol_factory",
+ "BasicAuthWebSocketServerProtocol",
+ "ClientConnection",
+ "connect",
+ "ConnectionClosed",
+ "ConnectionClosedError",
+ "ConnectionClosedOK",
+ "Data",
+ "DuplicateParameter",
+ "ExtensionHeader",
+ "ExtensionParameter",
+ "InvalidHandshake",
+ "InvalidHeader",
+ "InvalidHeaderFormat",
+ "InvalidHeaderValue",
+ "InvalidMessage",
+ "InvalidOrigin",
+ "InvalidParameterName",
+ "InvalidParameterValue",
+ "InvalidState",
+ "InvalidStatusCode",
+ "InvalidUpgrade",
+ "InvalidURI",
+ "NegotiationError",
+ "Origin",
+ "parse_uri",
+ "PayloadTooBig",
+ "ProtocolError",
+ "RedirectHandshake",
+ "SecurityError",
+ "serve",
+ "ServerConnection",
+ "Subprotocol",
+ "unix_connect",
+ "unix_serve",
+ "WebSocketClientProtocol",
+ "WebSocketCommonProtocol",
+ "WebSocketException",
+ "WebSocketProtocolError",
+ "WebSocketServer",
+ "WebSocketServerProtocol",
+ "WebSocketURI",
+]
+
+lazy_import(
+ globals(),
+ aliases={
+ "auth": ".legacy",
+ "basic_auth_protocol_factory": ".legacy.auth",
+ "BasicAuthWebSocketServerProtocol": ".legacy.auth",
+ "ClientConnection": ".client",
+ "connect": ".legacy.client",
+ "unix_connect": ".legacy.client",
+ "WebSocketClientProtocol": ".legacy.client",
+ "Headers": ".datastructures",
+ "MultipleValuesError": ".datastructures",
+ "WebSocketException": ".exceptions",
+ "ConnectionClosed": ".exceptions",
+ "ConnectionClosedError": ".exceptions",
+ "ConnectionClosedOK": ".exceptions",
+ "InvalidHandshake": ".exceptions",
+ "SecurityError": ".exceptions",
+ "InvalidMessage": ".exceptions",
+ "InvalidHeader": ".exceptions",
+ "InvalidHeaderFormat": ".exceptions",
+ "InvalidHeaderValue": ".exceptions",
+ "InvalidOrigin": ".exceptions",
+ "InvalidUpgrade": ".exceptions",
+ "InvalidStatusCode": ".exceptions",
+ "NegotiationError": ".exceptions",
+ "DuplicateParameter": ".exceptions",
+ "InvalidParameterName": ".exceptions",
+ "InvalidParameterValue": ".exceptions",
+ "AbortHandshake": ".exceptions",
+ "RedirectHandshake": ".exceptions",
+ "InvalidState": ".exceptions",
+ "InvalidURI": ".exceptions",
+ "PayloadTooBig": ".exceptions",
+ "ProtocolError": ".exceptions",
+ "WebSocketProtocolError": ".exceptions",
+ "protocol": ".legacy",
+ "WebSocketCommonProtocol": ".legacy.protocol",
+ "ServerConnection": ".server",
+ "serve": ".legacy.server",
+ "unix_serve": ".legacy.server",
+ "WebSocketServerProtocol": ".legacy.server",
+ "WebSocketServer": ".legacy.server",
+ "Data": ".typing",
+ "Origin": ".typing",
+ "ExtensionHeader": ".typing",
+ "ExtensionParameter": ".typing",
+ "Subprotocol": ".typing",
+ },
+ deprecated_aliases={
+ "framing": ".legacy",
+ "handshake": ".legacy",
+ "parse_uri": ".uri",
+ "WebSocketURI": ".uri",
+ },
)
diff --git a/src/websockets/__main__.py b/src/websockets/__main__.py
index af9286637..fb126997a 100644
--- a/src/websockets/__main__.py
+++ b/src/websockets/__main__.py
@@ -4,106 +4,112 @@
import signal
import sys
import threading
+from typing import Any, Set
-import websockets
-from websockets.compatibility import asyncio_ensure_future
-from websockets.exceptions import format_close
+from .exceptions import ConnectionClosed, format_close
+from .legacy.client import connect
-def win_enable_vt100():
- """
- Enable VT-100 for console output on Windows.
+if sys.platform == "win32":
- See also https://bugs.python.org/issue29059.
+ def win_enable_vt100() -> None:
+ """
+ Enable VT-100 for console output on Windows.
- """
- import ctypes
+ See also https://bugs.python.org/issue29059.
- STD_OUTPUT_HANDLE = ctypes.c_uint(-11)
- INVALID_HANDLE_VALUE = ctypes.c_uint(-1)
- ENABLE_VIRTUAL_TERMINAL_PROCESSING = 0x004
+ """
+ import ctypes
- handle = ctypes.windll.kernel32.GetStdHandle(STD_OUTPUT_HANDLE)
- if handle == INVALID_HANDLE_VALUE:
- raise RuntimeError("Unable to obtain stdout handle")
+ STD_OUTPUT_HANDLE = ctypes.c_uint(-11)
+ INVALID_HANDLE_VALUE = ctypes.c_uint(-1)
+ ENABLE_VIRTUAL_TERMINAL_PROCESSING = 0x004
- cur_mode = ctypes.c_uint()
- if ctypes.windll.kernel32.GetConsoleMode(handle, ctypes.byref(cur_mode)) == 0:
- raise RuntimeError("Unable to query current console mode")
+ handle = ctypes.windll.kernel32.GetStdHandle(STD_OUTPUT_HANDLE)
+ if handle == INVALID_HANDLE_VALUE:
+ raise RuntimeError("unable to obtain stdout handle")
- # ctypes ints lack support for the required bit-OR operation.
- # Temporarily convert to Py int, do the OR and convert back.
- py_int_mode = int.from_bytes(cur_mode, sys.byteorder)
- new_mode = ctypes.c_uint(py_int_mode | ENABLE_VIRTUAL_TERMINAL_PROCESSING)
+ cur_mode = ctypes.c_uint()
+ if ctypes.windll.kernel32.GetConsoleMode(handle, ctypes.byref(cur_mode)) == 0:
+ raise RuntimeError("unable to query current console mode")
- if ctypes.windll.kernel32.SetConsoleMode(handle, new_mode) == 0:
- raise RuntimeError("Unable to set console mode")
+ # ctypes ints lack support for the required bit-OR operation.
+ # Temporarily convert to Py int, do the OR and convert back.
+ py_int_mode = int.from_bytes(cur_mode, sys.byteorder)
+ new_mode = ctypes.c_uint(py_int_mode | ENABLE_VIRTUAL_TERMINAL_PROCESSING)
+ if ctypes.windll.kernel32.SetConsoleMode(handle, new_mode) == 0:
+ raise RuntimeError("unable to set console mode")
-def exit_from_event_loop_thread(loop, stop):
+
+def exit_from_event_loop_thread(
+ loop: asyncio.AbstractEventLoop, stop: "asyncio.Future[None]"
+) -> None:
loop.stop()
if not stop.done():
# When exiting the thread that runs the event loop, raise
- # KeyboardInterrupt in the main thead to exit the program.
- try:
- ctrl_c = signal.CTRL_C_EVENT # Windows
- except AttributeError:
- ctrl_c = signal.SIGINT # POSIX
+ # KeyboardInterrupt in the main thread to exit the program.
+ if sys.platform == "win32":
+ ctrl_c = signal.CTRL_C_EVENT
+ else:
+ ctrl_c = signal.SIGINT
os.kill(os.getpid(), ctrl_c)
-def print_during_input(string):
+def print_during_input(string: str) -> None:
sys.stdout.write(
- (
- # Save cursor position
- '\N{ESC}7'
- # Add a new line
- '\N{LINE FEED}'
- # Move cursor up
- '\N{ESC}[A'
- # Insert blank line, scroll last line down
- '\N{ESC}[L'
- # Print string in the inserted blank line
- '{string}\N{LINE FEED}'
- # Restore cursor position
- '\N{ESC}8'
- # Move cursor down
- '\N{ESC}[B'
- ).format(string=string)
+ # Save cursor position
+ "\N{ESC}7"
+ # Add a new line
+ "\N{LINE FEED}"
+ # Move cursor up
+ "\N{ESC}[A"
+ # Insert blank line, scroll last line down
+ "\N{ESC}[L"
+ # Print string in the inserted blank line
+ f"{string}\N{LINE FEED}"
+ # Restore cursor position
+ "\N{ESC}8"
+ # Move cursor down
+ "\N{ESC}[B"
)
sys.stdout.flush()
-def print_over_input(string):
+def print_over_input(string: str) -> None:
sys.stdout.write(
- (
- # Move cursor to beginning of line
- '\N{CARRIAGE RETURN}'
- # Delete current line
- '\N{ESC}[K'
- # Print string
- '{string}\N{LINE FEED}'
- ).format(string=string)
+ # Move cursor to beginning of line
+ "\N{CARRIAGE RETURN}"
+ # Delete current line
+ "\N{ESC}[K"
+ # Print string
+ f"{string}\N{LINE FEED}"
)
sys.stdout.flush()
-@asyncio.coroutine
-def run_client(uri, loop, inputs, stop):
+async def run_client(
+ uri: str,
+ loop: asyncio.AbstractEventLoop,
+ inputs: "asyncio.Queue[str]",
+ stop: "asyncio.Future[None]",
+) -> None:
try:
- websocket = yield from websockets.connect(uri)
+ websocket = await connect(uri)
except Exception as exc:
- print_over_input("Failed to connect to {}: {}.".format(uri, exc))
+ print_over_input(f"Failed to connect to {uri}: {exc}.")
exit_from_event_loop_thread(loop, stop)
return
else:
- print_during_input("Connected to {}.".format(uri))
+ print_during_input(f"Connected to {uri}.")
try:
while True:
- incoming = asyncio_ensure_future(websocket.recv())
- outgoing = asyncio_ensure_future(inputs.get())
- done, pending = yield from asyncio.wait(
+ incoming: asyncio.Future[Any] = asyncio.ensure_future(websocket.recv())
+ outgoing: asyncio.Future[Any] = asyncio.ensure_future(inputs.get())
+ done: Set[asyncio.Future[Any]]
+ pending: Set[asyncio.Future[Any]]
+ done, pending = await asyncio.wait(
[incoming, outgoing, stop], return_when=asyncio.FIRST_COMPLETED
)
@@ -116,64 +122,73 @@ def run_client(uri, loop, inputs, stop):
if incoming in done:
try:
message = incoming.result()
- except websockets.ConnectionClosed:
+ except ConnectionClosed:
break
else:
- print_during_input('< ' + message)
+ if isinstance(message, str):
+ print_during_input("< " + message)
+ else:
+ print_during_input("< (binary) " + message.hex())
if outgoing in done:
message = outgoing.result()
- yield from websocket.send(message)
+ await websocket.send(message)
if stop in done:
break
finally:
- yield from websocket.close()
+ await websocket.close()
close_status = format_close(websocket.close_code, websocket.close_reason)
- print_over_input(
- "Connection closed: {close_status}.".format(close_status=close_status)
- )
+ print_over_input(f"Connection closed: {close_status}.")
exit_from_event_loop_thread(loop, stop)
-def main():
+def main() -> None:
# If we're on Windows, enable VT100 terminal support.
- if os.name == 'nt':
+ if sys.platform == "win32":
try:
win_enable_vt100()
except RuntimeError as exc:
sys.stderr.write(
- (
- "Unable to set terminal to VT100 mode. This is only "
- "supported since Win10 anniversary update. Expect "
- "weird symbols on the terminal.\nError: {exc!s}\n"
- ).format(exc=exc)
+ f"Unable to set terminal to VT100 mode. This is only "
+ f"supported since Win10 anniversary update. Expect "
+ f"weird symbols on the terminal.\nError: {exc}\n"
)
sys.stderr.flush()
+ try:
+ import readline # noqa
+ except ImportError: # Windows has no `readline` normally
+ pass
+
# Parse command line arguments.
parser = argparse.ArgumentParser(
prog="python -m websockets",
description="Interactive WebSocket client.",
add_help=False,
)
- parser.add_argument('uri', metavar='')
+ parser.add_argument("uri", metavar="")
args = parser.parse_args()
# Create an event loop that will run in a background thread.
loop = asyncio.new_event_loop()
+ # Due to zealous removal of the loop parameter in the Queue constructor,
+ # we need a factory coroutine to run in the freshly created event loop.
+ async def queue_factory() -> "asyncio.Queue[str]":
+ return asyncio.Queue()
+
# Create a queue of user inputs. There's no need to limit its size.
- inputs = asyncio.Queue(loop=loop)
+ inputs: "asyncio.Queue[str]" = loop.run_until_complete(queue_factory())
# Create a stop condition when receiving SIGINT or SIGTERM.
- stop = asyncio.Future(loop=loop)
+ stop: asyncio.Future[None] = loop.create_future()
# Schedule the task that will manage the connection.
- asyncio_ensure_future(run_client(args.uri, loop, inputs, stop), loop=loop)
+ asyncio.ensure_future(run_client(args.uri, loop, inputs, stop), loop=loop)
# Start the event loop in a background thread.
thread = threading.Thread(target=loop.run_forever)
@@ -183,7 +198,7 @@ def main():
try:
while True:
# Since there's no size limit, put_nowait is identical to put.
- message = input('> ')
+ message = input("> ")
loop.call_soon_threadsafe(inputs.put_nowait, message)
except (KeyboardInterrupt, EOFError): # ^C, ^D
loop.call_soon_threadsafe(stop.set_result, None)
@@ -191,6 +206,10 @@ def main():
# Wait for the event loop to terminate.
thread.join()
+ # For reasons unclear, even though the loop is closed in the thread,
+ # it still thinks it's running here.
+ loop.close()
+
-if __name__ == '__main__':
+if __name__ == "__main__":
main()
diff --git a/src/websockets/auth.py b/src/websockets/auth.py
new file mode 100644
index 000000000..f97c1feb0
--- /dev/null
+++ b/src/websockets/auth.py
@@ -0,0 +1,2 @@
+# See #940 for why lazy_import isn't used here for backwards compatibility.
+from .legacy.auth import * # noqa
diff --git a/src/websockets/client.py b/src/websockets/client.py
index 9f92f18e8..0ddf19f00 100644
--- a/src/websockets/client.py
+++ b/src/websockets/client.py
@@ -1,102 +1,167 @@
-"""
-The :mod:`websockets.client` module defines a simple WebSocket client API.
-
-"""
-
-import asyncio
-import collections.abc
-import sys
+import collections
+import logging
+from typing import Generator, List, Optional, Sequence
+from .connection import CLIENT, CONNECTING, OPEN, Connection
+from .datastructures import Headers, HeadersLike, MultipleValuesError
from .exceptions import (
InvalidHandshake,
- InvalidMessage,
+ InvalidHeader,
+ InvalidHeaderValue,
InvalidStatusCode,
+ InvalidUpgrade,
NegotiationError,
)
-from .extensions.permessage_deflate import ClientPerMessageDeflateFactory
-from .handshake import build_request, check_response
+from .extensions.base import ClientExtensionFactory, Extension
from .headers import (
- build_basic_auth,
- build_extension_list,
- build_subprotocol_list,
- parse_extension_list,
- parse_subprotocol_list,
+ build_authorization_basic,
+ build_extension,
+ build_subprotocol,
+ parse_connection,
+ parse_extension,
+ parse_subprotocol,
+ parse_upgrade,
+)
+from .http import USER_AGENT, build_host
+from .http11 import Request, Response
+from .typing import (
+ ConnectionOption,
+ ExtensionHeader,
+ Origin,
+ Subprotocol,
+ UpgradeProtocol,
)
-from .http import USER_AGENT, Headers, read_response
-from .protocol import WebSocketCommonProtocol
from .uri import parse_uri
+from .utils import accept_key, generate_key
-__all__ = ['connect', 'WebSocketClientProtocol']
-
+# See #940 for why lazy_import isn't used here for backwards compatibility.
+from .legacy.client import * # isort:skip # noqa
-class WebSocketClientProtocol(WebSocketCommonProtocol):
- """
- Complete WebSocket client implementation as an :class:`asyncio.Protocol`.
- This class inherits most of its methods from
- :class:`~websockets.protocol.WebSocketCommonProtocol`.
+__all__ = ["ClientConnection"]
- """
+logger = logging.getLogger(__name__)
- is_client = True
- side = 'client'
+class ClientConnection(Connection):
def __init__(
self,
- *,
- origin=None,
- extensions=None,
- subprotocols=None,
- extra_headers=None,
- **kwds
+ uri: str,
+ origin: Optional[Origin] = None,
+ extensions: Optional[Sequence[ClientExtensionFactory]] = None,
+ subprotocols: Optional[Sequence[Subprotocol]] = None,
+ extra_headers: Optional[HeadersLike] = None,
+ max_size: Optional[int] = 2 ** 20,
):
+ super().__init__(side=CLIENT, state=CONNECTING, max_size=max_size)
+ self.wsuri = parse_uri(uri)
self.origin = origin
self.available_extensions = extensions
self.available_subprotocols = subprotocols
self.extra_headers = extra_headers
- super().__init__(**kwds)
+ self.key = generate_key()
- @asyncio.coroutine
- def write_http_request(self, path, headers):
+ def connect(self) -> Request: # noqa: F811
"""
- Write request line and headers to the HTTP request.
+ Create a WebSocket handshake request event to send to the server.
"""
- self.path = path
- self.request_headers = headers
+ headers = Headers()
- # Since the path and headers only contain ASCII characters,
- # we can keep this simple.
- request = 'GET {path} HTTP/1.1\r\n'.format(path=path)
- request += str(headers)
+ headers["Host"] = build_host(
+ self.wsuri.host, self.wsuri.port, self.wsuri.secure
+ )
- self.writer.write(request.encode())
+ if self.wsuri.user_info:
+ headers["Authorization"] = build_authorization_basic(*self.wsuri.user_info)
- @asyncio.coroutine
- def read_http_response(self):
- """
- Read status line and headers from the HTTP response.
+ if self.origin is not None:
+ headers["Origin"] = self.origin
- Raise :exc:`~websockets.exceptions.InvalidMessage` if the HTTP message
- is malformed or isn't an HTTP/1.1 GET request.
+ headers["Upgrade"] = "websocket"
+ headers["Connection"] = "Upgrade"
+ headers["Sec-WebSocket-Key"] = self.key
+ headers["Sec-WebSocket-Version"] = "13"
- Don't attempt to read the response body because WebSocket handshake
- responses don't have one. If the response contains a body, it may be
- read from ``self.reader`` after this coroutine returns.
+ if self.available_extensions is not None:
+ extensions_header = build_extension(
+ [
+ (extension_factory.name, extension_factory.get_request_params())
+ for extension_factory in self.available_extensions
+ ]
+ )
+ headers["Sec-WebSocket-Extensions"] = extensions_header
+ if self.available_subprotocols is not None:
+ protocol_header = build_subprotocol(self.available_subprotocols)
+ headers["Sec-WebSocket-Protocol"] = protocol_header
+
+ if self.extra_headers is not None:
+ extra_headers = self.extra_headers
+ if isinstance(extra_headers, Headers):
+ extra_headers = extra_headers.raw_items()
+ elif isinstance(extra_headers, collections.abc.Mapping):
+ extra_headers = extra_headers.items()
+ for name, value in extra_headers:
+ headers[name] = value
+
+ headers.setdefault("User-Agent", USER_AGENT)
+
+ return Request(self.wsuri.resource_name, headers)
+
+ def process_response(self, response: Response) -> None:
"""
+ Check a handshake response received from the server.
+
+ :param response: response
+ :param key: comes from :func:`build_request`
+ :raises ~websockets.exceptions.InvalidHandshake: if the handshake response
+ is invalid
+
+ """
+
+ if response.status_code != 101:
+ raise InvalidStatusCode(response.status_code)
+
+ headers = response.headers
+
+ connection: List[ConnectionOption] = sum(
+ [parse_connection(value) for value in headers.get_all("Connection")], []
+ )
+
+ if not any(value.lower() == "upgrade" for value in connection):
+ raise InvalidUpgrade(
+ "Connection", ", ".join(connection) if connection else None
+ )
+
+ upgrade: List[UpgradeProtocol] = sum(
+ [parse_upgrade(value) for value in headers.get_all("Upgrade")], []
+ )
+
+ # For compatibility with non-strict implementations, ignore case when
+ # checking the Upgrade header. It's supposed to be 'WebSocket'.
+ if not (len(upgrade) == 1 and upgrade[0].lower() == "websocket"):
+ raise InvalidUpgrade("Upgrade", ", ".join(upgrade) if upgrade else None)
+
try:
- status_code, headers = yield from read_response(self.reader)
- except ValueError as exc:
- raise InvalidMessage("Malformed HTTP message") from exc
+ s_w_accept = headers["Sec-WebSocket-Accept"]
+ except KeyError as exc:
+ raise InvalidHeader("Sec-WebSocket-Accept") from exc
+ except MultipleValuesError as exc:
+ raise InvalidHeader(
+ "Sec-WebSocket-Accept",
+ "more than one Sec-WebSocket-Accept header found",
+ ) from exc
- self.response_headers = headers
+ if s_w_accept != accept_key(self.key):
+ raise InvalidHeaderValue("Sec-WebSocket-Accept", s_w_accept)
- return status_code, self.response_headers
+ self.extensions = self.process_extensions(headers)
- @staticmethod
- def process_extensions(headers, available_extensions):
+ self.subprotocol = self.process_subprotocol(headers)
+
+ def process_extensions(self, headers: Headers) -> List[Extension]:
"""
Handle the Sec-WebSocket-Extensions HTTP response header.
@@ -108,7 +173,7 @@ def process_extensions(headers, available_extensions):
connection.
:rfc:`6455` leaves the rules up to the specification of each
- :extension.
+ extension.
To provide this level of flexibility, for each extension accepted by
the server, we check for a match with each extension available in the
@@ -123,23 +188,22 @@ def process_extensions(headers, available_extensions):
order of extensions, may be implemented by overriding this method.
"""
- accepted_extensions = []
+ accepted_extensions: List[Extension] = []
- header_values = headers.get_all('Sec-WebSocket-Extensions')
+ extensions = headers.get_all("Sec-WebSocket-Extensions")
- if header_values:
+ if extensions:
- if available_extensions is None:
- raise InvalidHandshake("No extensions supported")
+ if self.available_extensions is None:
+ raise InvalidHandshake("no extensions supported")
- parsed_header_values = sum(
- [parse_extension_list(header_value) for header_value in header_values],
- [],
+ parsed_extensions: List[ExtensionHeader] = sum(
+ [parse_extension(header_value) for header_value in extensions], []
)
- for name, response_params in parsed_header_values:
+ for name, response_params in parsed_extensions:
- for extension_factory in available_extensions:
+ for extension_factory in self.available_extensions:
# Skip non-matching extensions based on their name.
if extension_factory.name != name:
@@ -163,15 +227,13 @@ def process_extensions(headers, available_extensions):
# matched what the server sent. Fail the connection.
else:
raise NegotiationError(
- "Unsupported extension: name = {}, params = {}".format(
- name, response_params
- )
+ f"Unsupported extension: "
+ f"name = {name}, params = {response_params}"
)
return accepted_extensions
- @staticmethod
- def process_subprotocol(headers, available_subprotocols):
+ def process_subprotocol(self, headers: Headers) -> Optional[Subprotocol]:
"""
Handle the Sec-WebSocket-Protocol HTTP response header.
@@ -180,301 +242,52 @@ def process_subprotocol(headers, available_subprotocols):
Return the selected subprotocol.
"""
- subprotocol = None
+ subprotocol: Optional[Subprotocol] = None
- header_values = headers.get_all('Sec-WebSocket-Protocol')
+ subprotocols = headers.get_all("Sec-WebSocket-Protocol")
- if header_values:
+ if subprotocols:
- if available_subprotocols is None:
- raise InvalidHandshake("No subprotocols supported")
+ if self.available_subprotocols is None:
+ raise InvalidHandshake("no subprotocols supported")
- parsed_header_values = sum(
- [
- parse_subprotocol_list(header_value)
- for header_value in header_values
- ],
- [],
+ parsed_subprotocols: Sequence[Subprotocol] = sum(
+ [parse_subprotocol(header_value) for header_value in subprotocols], []
)
- if len(parsed_header_values) > 1:
- raise InvalidHandshake(
- "Multiple subprotocols: {}".format(', '.join(parsed_header_values))
- )
+ if len(parsed_subprotocols) > 1:
+ subprotocols_display = ", ".join(parsed_subprotocols)
+ raise InvalidHandshake(f"multiple subprotocols: {subprotocols_display}")
- subprotocol = parsed_header_values[0]
+ subprotocol = parsed_subprotocols[0]
- if subprotocol not in available_subprotocols:
- raise NegotiationError(
- "Unsupported subprotocol: {}".format(subprotocol)
- )
+ if subprotocol not in self.available_subprotocols:
+ raise NegotiationError(f"unsupported subprotocol: {subprotocol}")
return subprotocol
- @asyncio.coroutine
- def handshake(
- self,
- wsuri,
- origin=None,
- available_extensions=None,
- available_subprotocols=None,
- extra_headers=None,
- ):
+ def send_request(self, request: Request) -> None:
"""
- Perform the client side of the opening handshake.
-
- If provided, ``origin`` sets the Origin HTTP header.
-
- If provided, ``available_extensions`` is a list of supported
- extensions in the order in which they should be used.
-
- If provided, ``available_subprotocols`` is a list of supported
- subprotocols in order of decreasing preference.
-
- If provided, ``extra_headers`` sets additional HTTP request headers.
- It must be a :class:`~websockets.http.Headers` instance, a
- :class:`~collections.abc.Mapping`, or an iterable of ``(name, value)``
- pairs.
-
- Raise :exc:`~websockets.exceptions.InvalidHandshake` if the handshake
- fails.
+ Send a WebSocket handshake request to the server.
"""
- request_headers = Headers()
-
- if wsuri.port == (443 if wsuri.secure else 80): # pragma: no cover
- request_headers['Host'] = wsuri.host
- else:
- request_headers['Host'] = '{}:{}'.format(wsuri.host, wsuri.port)
-
- if wsuri.user_info:
- request_headers['Authorization'] = build_basic_auth(*wsuri.user_info)
-
- if origin is not None:
- request_headers['Origin'] = origin
-
- key = build_request(request_headers)
-
- if available_extensions is not None:
- extensions_header = build_extension_list(
- [
- (extension_factory.name, extension_factory.get_request_params())
- for extension_factory in available_extensions
- ]
- )
- request_headers['Sec-WebSocket-Extensions'] = extensions_header
-
- if available_subprotocols is not None:
- protocol_header = build_subprotocol_list(available_subprotocols)
- request_headers['Sec-WebSocket-Protocol'] = protocol_header
-
- if extra_headers is not None:
- if isinstance(extra_headers, Headers):
- extra_headers = extra_headers.raw_items()
- elif isinstance(extra_headers, collections.abc.Mapping):
- extra_headers = extra_headers.items()
- for name, value in extra_headers:
- request_headers[name] = value
-
- request_headers.setdefault('User-Agent', USER_AGENT)
-
- yield from self.write_http_request(wsuri.resource_name, request_headers)
-
- status_code, response_headers = yield from self.read_http_response()
-
- if status_code != 101:
- raise InvalidStatusCode(status_code)
-
- check_response(response_headers, key)
-
- self.extensions = self.process_extensions(
- response_headers, available_extensions
- )
-
- self.subprotocol = self.process_subprotocol(
- response_headers, available_subprotocols
- )
-
- self.connection_open()
-
-
-class Connect:
- """
- Connect to the WebSocket server at the given ``uri``.
-
- :func:`connect` returns an awaitable. Awaiting it yields an instance of
- :class:`WebSocketClientProtocol` which can then be used to send and
- receive messages.
-
- On Python ≥ 3.5.1, :func:`connect` can be used as a asynchronous context
- manager. In that case, the connection is closed when exiting the context.
-
- :func:`connect` is a wrapper around the event loop's
- :meth:`~asyncio.BaseEventLoop.create_connection` method. Unknown keyword
- arguments are passed to :meth:`~asyncio.BaseEventLoop.create_connection`.
-
- For example, you can set the ``ssl`` keyword argument to a
- :class:`~ssl.SSLContext` to enforce some TLS settings. When connecting to
- a ``wss://`` URI, if this argument isn't provided explicitly, it's set to
- ``True``, which means Python's default :class:`~ssl.SSLContext` is used.
+ logger.debug("%s > GET %s HTTP/1.1", self.side, request.path)
+ logger.debug("%s > %r", self.side, request.headers)
- The behavior of the ``ping_interval``, ``ping_timeout``, ``close_timeout``,
- ``max_size``, ``max_queue``, ``read_limit``, and ``write_limit`` optional
- arguments is described in the documentation of
- :class:`~websockets.protocol.WebSocketCommonProtocol`.
+ self.writes.append(request.serialize())
- The ``create_protocol`` parameter allows customizing the asyncio protocol
- that manages the connection. It should be a callable or class accepting
- the same arguments as :class:`WebSocketClientProtocol` and returning a
- :class:`WebSocketClientProtocol` instance. It defaults to
- :class:`WebSocketClientProtocol`.
-
- :func:`connect` also accepts the following optional arguments:
-
- * ``compression`` is a shortcut to configure compression extensions;
- by default it enables the "permessage-deflate" extension; set it to
- ``None`` to disable compression
- * ``origin`` sets the Origin HTTP header
- * ``extensions`` is a list of supported extensions in order of
- decreasing preference
- * ``subprotocols`` is a list of supported subprotocols in order of
- decreasing preference
- * ``extra_headers`` sets additional HTTP request headers – it can be a
- :class:`~websockets.http.Headers` instance, a
- :class:`~collections.abc.Mapping`, or an iterable of ``(name, value)``
- pairs
-
- :func:`connect` raises :exc:`~websockets.uri.InvalidURI` if ``uri`` is
- invalid and :exc:`~websockets.handshake.InvalidHandshake` if the opening
- handshake fails.
-
- """
-
- def __init__(
- self,
- uri,
- *,
- create_protocol=None,
- ping_interval=20,
- ping_timeout=20,
- close_timeout=None,
- max_size=2 ** 20,
- max_queue=2 ** 5,
- read_limit=2 ** 16,
- write_limit=2 ** 16,
- loop=None,
- legacy_recv=False,
- klass=WebSocketClientProtocol,
- timeout=10,
- compression='deflate',
- origin=None,
- extensions=None,
- subprotocols=None,
- extra_headers=None,
- **kwds
- ):
- if loop is None:
- loop = asyncio.get_event_loop()
-
- # Backwards-compatibility: close_timeout used to be called timeout.
- # If both are specified, timeout is ignored.
- if close_timeout is None:
- close_timeout = timeout
-
- # Backwards-compatibility: create_protocol used to be called klass.
- # If both are specified, klass is ignored.
- if create_protocol is None:
- create_protocol = klass
-
- wsuri = parse_uri(uri)
- if wsuri.secure:
- kwds.setdefault('ssl', True)
- elif kwds.get('ssl') is not None:
- raise ValueError(
- "connect() received a SSL context for a ws:// URI, "
- "use a wss:// URI to enable TLS"
- )
-
- if compression == 'deflate':
- if extensions is None:
- extensions = []
- if not any(
- extension_factory.name == ClientPerMessageDeflateFactory.name
- for extension_factory in extensions
- ):
- extensions.append(
- ClientPerMessageDeflateFactory(client_max_window_bits=True)
- )
- elif compression is not None:
- raise ValueError("Unsupported compression: {}".format(compression))
-
- factory = lambda: create_protocol(
- host=wsuri.host,
- port=wsuri.port,
- secure=wsuri.secure,
- ping_interval=ping_interval,
- ping_timeout=ping_timeout,
- close_timeout=close_timeout,
- max_size=max_size,
- max_queue=max_queue,
- read_limit=read_limit,
- write_limit=write_limit,
- loop=loop,
- legacy_recv=legacy_recv,
- origin=origin,
- extensions=extensions,
- subprotocols=subprotocols,
- extra_headers=extra_headers,
+ def parse(self) -> Generator[None, None, None]:
+ response = yield from Response.parse(
+ self.reader.read_line, self.reader.read_exact, self.reader.read_to_eof
)
-
- if kwds.get('sock') is None:
- host, port = wsuri.host, wsuri.port
- else:
- # If sock is given, host and port mustn't be specified.
- host, port = None, None
-
- self._wsuri = wsuri
- self._origin = origin
-
- # This is a coroutine object.
- self._creating_connection = loop.create_connection(factory, host, port, **kwds)
-
- @asyncio.coroutine
- def __iter__(self): # pragma: no cover
- transport, protocol = yield from self._creating_connection
-
+ assert self.state == CONNECTING
try:
- yield from protocol.handshake(
- self._wsuri,
- origin=self._origin,
- available_extensions=protocol.available_extensions,
- available_subprotocols=protocol.available_subprotocols,
- extra_headers=protocol.extra_headers,
- )
- except Exception:
- protocol.fail_connection()
- yield from protocol.wait_closed()
- raise
-
- self.ws_client = protocol
- return protocol
-
-
-# We can't define __await__ on Python < 3.5.1 because asyncio.ensure_future
-# didn't accept arbitrary awaitables until Python 3.5.1. We don't define
-# __aenter__ and __aexit__ either on Python < 3.5.1 to keep things simple.
-if sys.version_info[:3] <= (3, 5, 0): # pragma: no cover
-
- @asyncio.coroutine
- def connect(*args, **kwds):
- return Connect(*args, **kwds).__iter__()
-
- connect.__doc__ = Connect.__doc__
-
-else:
- from .py35.client import __aenter__, __aexit__, __await__
-
- Connect.__aenter__ = __aenter__
- Connect.__aexit__ = __aexit__
- Connect.__await__ = __await__
- connect = Connect
+ self.process_response(response)
+ except InvalidHandshake as exc:
+ response = response._replace(exception=exc)
+ logger.debug("Invalid handshake", exc_info=True)
+ else:
+ self.set_state(OPEN)
+ finally:
+ self.events.append(response)
+ yield from super().parse()
diff --git a/src/websockets/compatibility.py b/src/websockets/compatibility.py
deleted file mode 100644
index b6506b70c..000000000
--- a/src/websockets/compatibility.py
+++ /dev/null
@@ -1,59 +0,0 @@
-"""
-The :mod:`websockets.compatibility` module provides helpers for bridging
-compatibility issues across Python versions.
-
-"""
-
-import asyncio
-import http
-
-
-# Replace with BaseEventLoop.create_task when dropping Python < 3.4.2.
-try: # pragma: no cover
- asyncio_ensure_future = asyncio.ensure_future # Python ≥ 3.5
-except AttributeError: # pragma: no cover
- asyncio_ensure_future = getattr(asyncio, 'async') # Python < 3.5
-
-try: # pragma: no cover
- # Python ≥ 3.5
- SWITCHING_PROTOCOLS = http.HTTPStatus.SWITCHING_PROTOCOLS
- OK = http.HTTPStatus.OK
- BAD_REQUEST = http.HTTPStatus.BAD_REQUEST
- UNAUTHORIZED = http.HTTPStatus.UNAUTHORIZED
- FORBIDDEN = http.HTTPStatus.FORBIDDEN
- UPGRADE_REQUIRED = http.HTTPStatus.UPGRADE_REQUIRED
- INTERNAL_SERVER_ERROR = http.HTTPStatus.INTERNAL_SERVER_ERROR
- SERVICE_UNAVAILABLE = http.HTTPStatus.SERVICE_UNAVAILABLE
-except AttributeError: # pragma: no cover
- # Python < 3.5
- class SWITCHING_PROTOCOLS:
- value = 101
- phrase = "Switching Protocols"
-
- class OK:
- value = 200
- phrase = "OK"
-
- class BAD_REQUEST:
- value = 400
- phrase = "Bad Request"
-
- class UNAUTHORIZED:
- value = 401
- phrase = "Unauthorized"
-
- class FORBIDDEN:
- value = 403
- phrase = "Forbidden"
-
- class UPGRADE_REQUIRED:
- value = 426
- phrase = "Upgrade Required"
-
- class INTERNAL_SERVER_ERROR:
- value = 500
- phrase = "Internal Server Error"
-
- class SERVICE_UNAVAILABLE:
- value = 503
- phrase = "Service Unavailable"
diff --git a/src/websockets/connection.py b/src/websockets/connection.py
new file mode 100644
index 000000000..aeb774f00
--- /dev/null
+++ b/src/websockets/connection.py
@@ -0,0 +1,409 @@
+import enum
+import logging
+from typing import Generator, List, Optional, Union
+
+from .exceptions import InvalidState, PayloadTooBig, ProtocolError
+from .extensions.base import Extension
+from .frames import (
+ OP_BINARY,
+ OP_CLOSE,
+ OP_CONT,
+ OP_PING,
+ OP_PONG,
+ OP_TEXT,
+ Frame,
+ parse_close,
+ serialize_close,
+)
+from .http11 import Request, Response
+from .streams import StreamReader
+from .typing import Origin, Subprotocol
+
+
+__all__ = [
+ "Connection",
+ "Side",
+ "State",
+ "SEND_EOF",
+]
+
+logger = logging.getLogger(__name__)
+
+Event = Union[Request, Response, Frame]
+
+
+# A WebSocket connection is either a server or a client.
+
+
+class Side(enum.IntEnum):
+ SERVER, CLIENT = range(2)
+
+
+SERVER = Side.SERVER
+CLIENT = Side.CLIENT
+
+
+# A WebSocket connection goes through the following four states, in order:
+
+
+class State(enum.IntEnum):
+ CONNECTING, OPEN, CLOSING, CLOSED = range(4)
+
+
+CONNECTING = State.CONNECTING
+OPEN = State.OPEN
+CLOSING = State.CLOSING
+CLOSED = State.CLOSED
+
+
+# Sentinel to signal that the connection should be closed.
+
+SEND_EOF = b""
+
+
+class Connection:
+ def __init__(
+ self,
+ side: Side,
+ state: State = OPEN,
+ max_size: Optional[int] = 2 ** 20,
+ ) -> None:
+ # Connection side. CLIENT or SERVER.
+ self.side = side
+
+ # Connnection state. CONNECTING and CLOSED states are handled in subclasses.
+ logger.debug("%s - initial state: %s", self.side, state.name)
+ self.state = state
+
+ # Maximum size of incoming messages in bytes.
+ self.max_size = max_size
+
+ # Current size of incoming message in bytes. Only set while reading a
+ # fragmented message i.e. a data frames with the FIN bit not set.
+ self.cur_size: Optional[int] = None
+
+ # True while sending a fragmented message i.e. a data frames with the
+ # FIN bit not set.
+ self.expect_continuation_frame = False
+
+ # WebSocket protocol parameters.
+ self.origin: Optional[Origin] = None
+ self.extensions: List[Extension] = []
+ self.subprotocol: Optional[Subprotocol] = None
+
+ # Connection state isn't enough to tell if a close frame was received:
+ # when this side closes the connection, state is CLOSING as soon as a
+ # close frame is sent, before a close frame is received.
+ self.close_frame_received = False
+
+ # Close code and reason. Set when receiving a close frame or when the
+ # TCP connection drops.
+ self.close_code: int
+ self.close_reason: str
+
+ # Track if send_eof() was called.
+ self.eof_sent = False
+
+ # Parser state.
+ self.reader = StreamReader()
+ self.events: List[Event] = []
+ self.writes: List[bytes] = []
+ self.parser = self.parse()
+ next(self.parser) # start coroutine
+ self.parser_exc: Optional[Exception] = None
+
+ def set_state(self, state: State) -> None:
+ logger.debug(
+ "%s - state change: %s > %s", self.side, self.state.name, state.name
+ )
+ self.state = state
+
+ # Public APIs for receiving data.
+
+ def receive_data(self, data: bytes) -> None:
+ """
+ Receive data from the connection.
+
+ After calling this method:
+
+ - You must call :meth:`data_to_send` and send this data.
+ - You should call :meth:`events_received` and process these events.
+
+ """
+ self.reader.feed_data(data)
+ self.step_parser()
+
+ def receive_eof(self) -> None:
+ """
+ Receive the end of the data stream from the connection.
+
+ After calling this method:
+
+ - You must call :meth:`data_to_send` and send this data.
+ - You shouldn't call :meth:`events_received` as it won't
+ return any new events.
+
+ """
+ self.reader.feed_eof()
+ self.step_parser()
+
+ # Public APIs for sending events.
+
+ def send_continuation(self, data: bytes, fin: bool) -> None:
+ """
+ Send a continuation frame.
+
+ """
+ if not self.expect_continuation_frame:
+ raise ProtocolError("unexpected continuation frame")
+ self.expect_continuation_frame = not fin
+ self.send_frame(Frame(fin, OP_CONT, data))
+
+ def send_text(self, data: bytes, fin: bool = True) -> None:
+ """
+ Send a text frame.
+
+ """
+ if self.expect_continuation_frame:
+ raise ProtocolError("expected a continuation frame")
+ self.expect_continuation_frame = not fin
+ self.send_frame(Frame(fin, OP_TEXT, data))
+
+ def send_binary(self, data: bytes, fin: bool = True) -> None:
+ """
+ Send a binary frame.
+
+ """
+ if self.expect_continuation_frame:
+ raise ProtocolError("expected a continuation frame")
+ self.expect_continuation_frame = not fin
+ self.send_frame(Frame(fin, OP_BINARY, data))
+
+ def send_close(self, code: Optional[int] = None, reason: str = "") -> None:
+ """
+ Send a connection close frame.
+
+ """
+ if self.expect_continuation_frame:
+ raise ProtocolError("expected a continuation frame")
+ if code is None:
+ if reason != "":
+ raise ValueError("cannot send a reason without a code")
+ data = b""
+ else:
+ data = serialize_close(code, reason)
+ self.send_frame(Frame(True, OP_CLOSE, data))
+ # send_frame() guarantees that self.state is OPEN at this point.
+ # 7.1.3. The WebSocket Closing Handshake is Started
+ self.set_state(CLOSING)
+ if self.side is SERVER:
+ self.send_eof()
+
+ def send_ping(self, data: bytes) -> None:
+ """
+ Send a ping frame.
+
+ """
+ self.send_frame(Frame(True, OP_PING, data))
+
+ def send_pong(self, data: bytes) -> None:
+ """
+ Send a pong frame.
+
+ """
+ self.send_frame(Frame(True, OP_PONG, data))
+
+ # Public API for getting incoming events after receiving data.
+
+ def events_received(self) -> List[Event]:
+ """
+ Return events read from the connection.
+
+ Call this method immediately after calling any of the ``receive_*()``
+ methods and process the events.
+
+ """
+ events, self.events = self.events, []
+ return events
+
+ # Public API for getting outgoing data after receiving data or sending events.
+
+ def data_to_send(self) -> List[bytes]:
+ """
+ Return data to write to the connection.
+
+ Call this method immediately after calling any of the ``receive_*()``
+ or ``send_*()`` methods and write the data to the connection.
+
+ The empty bytestring signals the end of the data stream.
+
+ """
+ writes, self.writes = self.writes, []
+ return writes
+
+ # Private APIs for receiving data.
+
+ def fail_connection(self, code: int = 1006, reason: str = "") -> None:
+ # Send a close frame when the state is OPEN (a close frame was already
+ # sent if it's CLOSING), except when failing the connection because of
+ # an error reading from or writing to the network.
+ if code != 1006 and self.state is OPEN:
+ self.send_frame(Frame(True, OP_CLOSE, serialize_close(code, reason)))
+ self.set_state(CLOSING)
+ if not self.eof_sent:
+ self.send_eof()
+
+ def step_parser(self) -> None:
+ # Run parser until more data is needed or EOF
+ try:
+ next(self.parser)
+ except StopIteration:
+ # This happens if receive_data() or receive_eof() is called after
+ # the parser raised an exception. (It cannot happen after reaching
+ # EOF because receive_data() or receive_eof() would fail earlier.)
+ assert self.parser_exc is not None
+ raise RuntimeError(
+ "cannot receive data or EOF after an error"
+ ) from self.parser_exc
+ except ProtocolError as exc:
+ self.fail_connection(1002, str(exc))
+ self.parser_exc = exc
+ raise
+ except EOFError as exc:
+ self.fail_connection(1006, str(exc))
+ self.parser_exc = exc
+ raise
+ except UnicodeDecodeError as exc:
+ self.fail_connection(1007, f"{exc.reason} at position {exc.start}")
+ self.parser_exc = exc
+ raise
+ except PayloadTooBig as exc:
+ self.fail_connection(1009, str(exc))
+ self.parser_exc = exc
+ raise
+ except Exception as exc:
+ logger.error("unexpected exception in parser", exc_info=True)
+ # Don't include exception details, which may be security-sensitive.
+ self.fail_connection(1011)
+ self.parser_exc = exc
+ raise
+
+ def parse(self) -> Generator[None, None, None]:
+ while True:
+ eof = yield from self.reader.at_eof()
+ if eof:
+ if self.close_frame_received:
+ if not self.eof_sent:
+ self.send_eof()
+ yield
+ # Once the reader reaches EOF, its feed_data/eof() methods
+ # raise an error, so our receive_data/eof() methods never
+ # call step_parser(), so the generator shouldn't resume
+ # executing until it's garbage collected.
+ raise AssertionError(
+ "parser shouldn't step after EOF"
+ ) # pragma: no cover
+ else:
+ raise EOFError("unexpected end of stream")
+
+ if self.max_size is None:
+ max_size = None
+ elif self.cur_size is None:
+ max_size = self.max_size
+ else:
+ max_size = self.max_size - self.cur_size
+
+ frame = yield from Frame.parse(
+ self.reader.read_exact,
+ mask=self.side is SERVER,
+ max_size=max_size,
+ extensions=self.extensions,
+ )
+
+ if frame.opcode is OP_TEXT or frame.opcode is OP_BINARY:
+ # 5.5.1 Close: "The application MUST NOT send any more data
+ # frames after sending a Close frame."
+ if self.close_frame_received:
+ raise ProtocolError("data frame after close frame")
+
+ if self.cur_size is not None:
+ raise ProtocolError("expected a continuation frame")
+ if frame.fin:
+ self.cur_size = None
+ else:
+ self.cur_size = len(frame.data)
+
+ elif frame.opcode is OP_CONT:
+ # 5.5.1 Close: "The application MUST NOT send any more data
+ # frames after sending a Close frame."
+ if self.close_frame_received:
+ raise ProtocolError("data frame after close frame")
+
+ if self.cur_size is None:
+ raise ProtocolError("unexpected continuation frame")
+ if frame.fin:
+ self.cur_size = None
+ else:
+ self.cur_size += len(frame.data)
+
+ elif frame.opcode is OP_PING:
+ # 5.5.2. Ping: "Upon receipt of a Ping frame, an endpoint MUST
+ # send a Pong frame in response, unless it already received a
+ # Close frame."
+ if not self.close_frame_received:
+ pong_frame = Frame(True, OP_PONG, frame.data)
+ self.send_frame(pong_frame)
+
+ elif frame.opcode is OP_PONG:
+ # 5.5.3 Pong: "A response to an unsolicited Pong frame is not
+ # expected."
+ pass
+
+ elif frame.opcode is OP_CLOSE:
+ self.close_frame_received = True
+ # 7.1.5. The WebSocket Connection Close Code
+ # 7.1.6. The WebSocket Connection Close Reason
+ self.close_code, self.close_reason = parse_close(frame.data)
+
+ if self.cur_size is not None:
+ raise ProtocolError("incomplete fragmented message")
+ # 5.5.1 Close: "If an endpoint receives a Close frame and did
+ # not previously send a Close frame, the endpoint MUST send a
+ # Close frame in response. (When sending a Close frame in
+ # response, the endpoint typically echos the status code it
+ # received.)"
+ if self.state is OPEN:
+ # Echo the original data instead of re-serializing it with
+ # serialize_close() because that fails when the close frame
+ # is empty and parse_close() synthetizes a 1005 close code.
+ # The rest is identical to send_close().
+ self.send_frame(Frame(True, OP_CLOSE, frame.data))
+ self.set_state(CLOSING)
+ if self.side is SERVER:
+ self.send_eof()
+
+ else: # pragma: no cover
+ # This can't happen because Frame.parse() validates opcodes.
+ raise AssertionError(f"unexpected opcode: {frame.opcode:02x}")
+
+ self.events.append(frame)
+
+ # Private APIs for sending events.
+
+ def send_frame(self, frame: Frame) -> None:
+ # Defensive assertion for protocol compliance.
+ if self.state is not OPEN:
+ raise InvalidState(
+ f"cannot write to a WebSocket in the {self.state.name} state"
+ )
+
+ logger.debug("%s > %r", self.side, frame)
+ self.writes.append(
+ frame.serialize(mask=self.side is CLIENT, extensions=self.extensions)
+ )
+
+ def send_eof(self) -> None:
+ assert not self.eof_sent
+ self.eof_sent = True
+ logger.debug("%s > EOF", self.side)
+ self.writes.append(SEND_EOF)
diff --git a/src/websockets/datastructures.py b/src/websockets/datastructures.py
new file mode 100644
index 000000000..c8e17fa98
--- /dev/null
+++ b/src/websockets/datastructures.py
@@ -0,0 +1,165 @@
+"""
+:mod:`websockets.datastructures` defines a class for manipulating HTTP headers.
+
+"""
+
+from typing import (
+ Any,
+ Dict,
+ Iterable,
+ Iterator,
+ List,
+ Mapping,
+ MutableMapping,
+ Tuple,
+ Union,
+)
+
+
+__all__ = ["Headers", "HeadersLike", "MultipleValuesError"]
+
+
+class MultipleValuesError(LookupError):
+ """
+ Exception raised when :class:`Headers` has more than one value for a key.
+
+ """
+
+ def __str__(self) -> str:
+ # Implement the same logic as KeyError_str in Objects/exceptions.c.
+ if len(self.args) == 1:
+ return repr(self.args[0])
+ return super().__str__()
+
+
+class Headers(MutableMapping[str, str]):
+ """
+ Efficient data structure for manipulating HTTP headers.
+
+ A :class:`list` of ``(name, values)`` is inefficient for lookups.
+
+ A :class:`dict` doesn't suffice because header names are case-insensitive
+ and multiple occurrences of headers with the same name are possible.
+
+ :class:`Headers` stores HTTP headers in a hybrid data structure to provide
+ efficient insertions and lookups while preserving the original data.
+
+ In order to account for multiple values with minimal hassle,
+ :class:`Headers` follows this logic:
+
+ - When getting a header with ``headers[name]``:
+ - if there's no value, :exc:`KeyError` is raised;
+ - if there's exactly one value, it's returned;
+ - if there's more than one value, :exc:`MultipleValuesError` is raised.
+
+ - When setting a header with ``headers[name] = value``, the value is
+ appended to the list of values for that header.
+
+ - When deleting a header with ``del headers[name]``, all values for that
+ header are removed (this is slow).
+
+ Other methods for manipulating headers are consistent with this logic.
+
+ As long as no header occurs multiple times, :class:`Headers` behaves like
+ :class:`dict`, except keys are lower-cased to provide case-insensitivity.
+
+ Two methods support manipulating multiple values explicitly:
+
+ - :meth:`get_all` returns a list of all values for a header;
+ - :meth:`raw_items` returns an iterator of ``(name, values)`` pairs.
+
+ """
+
+ __slots__ = ["_dict", "_list"]
+
+ def __init__(self, *args: Any, **kwargs: str) -> None:
+ self._dict: Dict[str, List[str]] = {}
+ self._list: List[Tuple[str, str]] = []
+ # MutableMapping.update calls __setitem__ for each (name, value) pair.
+ self.update(*args, **kwargs)
+
+ def __str__(self) -> str:
+ return "".join(f"{key}: {value}\r\n" for key, value in self._list) + "\r\n"
+
+ def __repr__(self) -> str:
+ return f"{self.__class__.__name__}({self._list!r})"
+
+ def copy(self) -> "Headers":
+ copy = self.__class__()
+ copy._dict = self._dict.copy()
+ copy._list = self._list.copy()
+ return copy
+
+ def serialize(self) -> bytes:
+ # Headers only contain ASCII characters.
+ return str(self).encode()
+
+ # Collection methods
+
+ def __contains__(self, key: object) -> bool:
+ return isinstance(key, str) and key.lower() in self._dict
+
+ def __iter__(self) -> Iterator[str]:
+ return iter(self._dict)
+
+ def __len__(self) -> int:
+ return len(self._dict)
+
+ # MutableMapping methods
+
+ def __getitem__(self, key: str) -> str:
+ value = self._dict[key.lower()]
+ if len(value) == 1:
+ return value[0]
+ else:
+ raise MultipleValuesError(key)
+
+ def __setitem__(self, key: str, value: str) -> None:
+ self._dict.setdefault(key.lower(), []).append(value)
+ self._list.append((key, value))
+
+ def __delitem__(self, key: str) -> None:
+ key_lower = key.lower()
+ self._dict.__delitem__(key_lower)
+ # This is inefficent. Fortunately deleting HTTP headers is uncommon.
+ self._list = [(k, v) for k, v in self._list if k.lower() != key_lower]
+
+ def __eq__(self, other: Any) -> bool:
+ if not isinstance(other, Headers):
+ return NotImplemented
+ return self._list == other._list
+
+ def clear(self) -> None:
+ """
+ Remove all headers.
+
+ """
+ self._dict = {}
+ self._list = []
+
+ # Methods for handling multiple values
+
+ def get_all(self, key: str) -> List[str]:
+ """
+ Return the (possibly empty) list of all values for a header.
+
+ :param key: header name
+
+ """
+ return self._dict.get(key.lower(), [])
+
+ def raw_items(self) -> Iterator[Tuple[str, str]]:
+ """
+ Return an iterator of all values as ``(name, value)`` pairs.
+
+ """
+ return iter(self._list)
+
+
+HeadersLike = Union[Headers, Mapping[str, str], Iterable[Tuple[str, str]]]
+HeadersLike__doc__ = """Types accepted wherever :class:`Headers` is expected"""
+# Remove try / except when dropping support for Python < 3.7
+try:
+ HeadersLike.__doc__ = HeadersLike__doc__
+except AttributeError: # pragma: no cover
+ pass
diff --git a/src/websockets/exceptions.py b/src/websockets/exceptions.py
index b1618fa73..e0860c743 100644
--- a/src/websockets/exceptions.py
+++ b/src/websockets/exceptions.py
@@ -1,251 +1,373 @@
+"""
+:mod:`websockets.exceptions` defines the following exception hierarchy:
+
+* :exc:`WebSocketException`
+ * :exc:`ConnectionClosed`
+ * :exc:`ConnectionClosedError`
+ * :exc:`ConnectionClosedOK`
+ * :exc:`InvalidHandshake`
+ * :exc:`SecurityError`
+ * :exc:`InvalidMessage`
+ * :exc:`InvalidHeader`
+ * :exc:`InvalidHeaderFormat`
+ * :exc:`InvalidHeaderValue`
+ * :exc:`InvalidOrigin`
+ * :exc:`InvalidUpgrade`
+ * :exc:`InvalidStatusCode`
+ * :exc:`NegotiationError`
+ * :exc:`DuplicateParameter`
+ * :exc:`InvalidParameterName`
+ * :exc:`InvalidParameterValue`
+ * :exc:`AbortHandshake`
+ * :exc:`RedirectHandshake`
+ * :exc:`InvalidState`
+ * :exc:`InvalidURI`
+ * :exc:`PayloadTooBig`
+ * :exc:`ProtocolError`
+
+"""
+
+import http
+from typing import Optional
+
+from .datastructures import Headers, HeadersLike
+
+
__all__ = [
- 'AbortHandshake',
- 'CancelHandshake',
- 'ConnectionClosed',
- 'DuplicateParameter',
- 'InvalidHandshake',
- 'InvalidHeader',
- 'InvalidHeaderFormat',
- 'InvalidHeaderValue',
- 'InvalidMessage',
- 'InvalidOrigin',
- 'InvalidParameterName',
- 'InvalidParameterValue',
- 'InvalidState',
- 'InvalidStatusCode',
- 'InvalidUpgrade',
- 'InvalidURI',
- 'NegotiationError',
- 'PayloadTooBig',
- 'WebSocketProtocolError',
+ "WebSocketException",
+ "ConnectionClosed",
+ "ConnectionClosedError",
+ "ConnectionClosedOK",
+ "InvalidHandshake",
+ "SecurityError",
+ "InvalidMessage",
+ "InvalidHeader",
+ "InvalidHeaderFormat",
+ "InvalidHeaderValue",
+ "InvalidOrigin",
+ "InvalidUpgrade",
+ "InvalidStatusCode",
+ "NegotiationError",
+ "DuplicateParameter",
+ "InvalidParameterName",
+ "InvalidParameterValue",
+ "AbortHandshake",
+ "RedirectHandshake",
+ "InvalidState",
+ "InvalidURI",
+ "PayloadTooBig",
+ "ProtocolError",
+ "WebSocketProtocolError",
]
-class InvalidHandshake(Exception):
+class WebSocketException(Exception):
"""
- Exception raised when a handshake request or response is invalid.
+ Base class for all exceptions defined by :mod:`websockets`.
"""
-class AbortHandshake(InvalidHandshake):
+# See https://www.iana.org/assignments/websocket/websocket.xhtml
+CLOSE_CODES = {
+ 1000: "OK",
+ 1001: "going away",
+ 1002: "protocol error",
+ 1003: "unsupported type",
+ # 1004 is reserved
+ 1005: "no status code [internal]",
+ 1006: "connection closed abnormally [internal]",
+ 1007: "invalid data",
+ 1008: "policy violation",
+ 1009: "message too big",
+ 1010: "extension required",
+ 1011: "unexpected error",
+ 1012: "service restart",
+ 1013: "try again later",
+ 1014: "bad gateway",
+ 1015: "TLS failure [internal]",
+}
+
+
+def format_close(code: int, reason: str) -> str:
"""
- Exception raised to abort a handshake and return a HTTP response.
+ Display a human-readable version of the close code and reason.
"""
+ if 3000 <= code < 4000:
+ explanation = "registered"
+ elif 4000 <= code < 5000:
+ explanation = "private use"
+ else:
+ explanation = CLOSE_CODES.get(code, "unknown")
+ result = f"code = {code} ({explanation}), "
- def __init__(self, status, headers, body=b''):
- self.status = status
- self.headers = headers
- self.body = body
- message = "HTTP {}, {} headers, {} bytes".format(
- status, len(headers), len(body)
- )
- super().__init__(message)
+ if reason:
+ result += f"reason = {reason}"
+ else:
+ result += "no reason"
+
+ return result
-class CancelHandshake(InvalidHandshake):
+class ConnectionClosed(WebSocketException):
"""
- Exception raised to cancel a handshake when the connection is closed.
+ Raised when trying to interact with a closed connection.
+
+ Provides the connection close code and reason in its ``code`` and
+ ``reason`` attributes respectively.
+
+ """
+
+ def __init__(self, code: int, reason: str) -> None:
+ self.code = code
+ self.reason = reason
+ super().__init__(format_close(code, reason))
+
+
+class ConnectionClosedError(ConnectionClosed):
+ """
+ Like :exc:`ConnectionClosed`, when the connection terminated with an error.
+
+ This means the close code is different from 1000 (OK) and 1001 (going away).
+
+ """
+
+ def __init__(self, code: int, reason: str) -> None:
+ assert code != 1000 and code != 1001
+ super().__init__(code, reason)
+
+
+class ConnectionClosedOK(ConnectionClosed):
+ """
+ Like :exc:`ConnectionClosed`, when the connection terminated properly.
+
+ This means the close code is 1000 (OK) or 1001 (going away).
+
+ """
+
+ def __init__(self, code: int, reason: str) -> None:
+ assert code == 1000 or code == 1001
+ super().__init__(code, reason)
+
+
+class InvalidHandshake(WebSocketException):
+ """
+ Raised during the handshake when the WebSocket connection fails.
+
+ """
+
+
+class SecurityError(InvalidHandshake):
+ """
+ Raised when a handshake request or response breaks a security rule.
+
+ Security limits are hard coded.
"""
class InvalidMessage(InvalidHandshake):
"""
- Exception raised when the HTTP message in a handshake request is malformed.
+ Raised when a handshake request or response is malformed.
"""
class InvalidHeader(InvalidHandshake):
"""
- Exception raised when a HTTP header doesn't have a valid format or value.
+ Raised when a HTTP header doesn't have a valid format or value.
"""
- def __init__(self, name, value=None):
+ def __init__(self, name: str, value: Optional[str] = None) -> None:
+ self.name = name
+ self.value = value
if value is None:
- message = "Missing {} header".format(name)
- elif value == '':
- message = "Empty {} header".format(name)
+ message = f"missing {name} header"
+ elif value == "":
+ message = f"empty {name} header"
else:
- message = "Invalid {} header: {}".format(name, value)
+ message = f"invalid {name} header: {value}"
super().__init__(message)
class InvalidHeaderFormat(InvalidHeader):
"""
- Exception raised when a Sec-WebSocket-* HTTP header cannot be parsed.
+ Raised when a HTTP header cannot be parsed.
+
+ The format of the header doesn't match the grammar for that header.
"""
- def __init__(self, name, error, string, pos):
- error = "{} at {} in {}".format(error, pos, string)
+ def __init__(self, name: str, error: str, header: str, pos: int) -> None:
+ self.name = name
+ error = f"{error} at {pos} in {header}"
super().__init__(name, error)
class InvalidHeaderValue(InvalidHeader):
"""
- Exception raised when a Sec-WebSocket-* HTTP header has a wrong value.
+ Raised when a HTTP header has a wrong value.
+
+ The format of the header is correct but a value isn't acceptable.
"""
-class InvalidUpgrade(InvalidHeader):
+class InvalidOrigin(InvalidHeader):
"""
- Exception raised when a Upgrade or Connection header isn't correct.
+ Raised when the Origin header in a request isn't allowed.
"""
+ def __init__(self, origin: Optional[str]) -> None:
+ super().__init__("Origin", origin)
-class InvalidOrigin(InvalidHeader):
- """
- Exception raised when the Origin header in a request isn't allowed.
+class InvalidUpgrade(InvalidHeader):
"""
+ Raised when the Upgrade or Connection header isn't correct.
- def __init__(self, origin):
- super().__init__('Origin', origin)
+ """
class InvalidStatusCode(InvalidHandshake):
"""
- Exception raised when a handshake response status code is invalid.
+ Raised when a handshake response status code is invalid.
- Provides the integer status code in its ``status_code`` attribute.
+ The integer status code is available in the ``status_code`` attribute.
"""
- def __init__(self, status_code):
+ def __init__(self, status_code: int) -> None:
self.status_code = status_code
- message = "Status code not 101: {}".format(status_code)
+ message = f"server rejected WebSocket connection: HTTP {status_code}"
super().__init__(message)
class NegotiationError(InvalidHandshake):
"""
- Exception raised when negotiating an extension fails.
+ Raised when negotiating an extension fails.
"""
-class InvalidParameterName(NegotiationError):
+class DuplicateParameter(NegotiationError):
"""
- Exception raised when a parameter name in an extension header is invalid.
+ Raised when a parameter name is repeated in an extension header.
"""
- def __init__(self, name):
+ def __init__(self, name: str) -> None:
self.name = name
- message = "Invalid parameter name: {}".format(name)
+ message = f"duplicate parameter: {name}"
super().__init__(message)
-class InvalidParameterValue(NegotiationError):
+class InvalidParameterName(NegotiationError):
"""
- Exception raised when a parameter value in an extension header is invalid.
+ Raised when a parameter name in an extension header is invalid.
"""
- def __init__(self, name, value):
+ def __init__(self, name: str) -> None:
self.name = name
- self.value = value
- message = "Invalid value for parameter {}: {}".format(name, value)
+ message = f"invalid parameter name: {name}"
super().__init__(message)
-class DuplicateParameter(NegotiationError):
+class InvalidParameterValue(NegotiationError):
"""
- Exception raised when a parameter name is repeated in an extension header.
+ Raised when a parameter value in an extension header is invalid.
"""
- def __init__(self, name):
+ def __init__(self, name: str, value: Optional[str]) -> None:
self.name = name
- message = "Duplicate parameter: {}".format(name)
+ self.value = value
+ if value is None:
+ message = f"missing value for parameter {name}"
+ elif value == "":
+ message = f"empty value for parameter {name}"
+ else:
+ message = f"invalid value for parameter {name}: {value}"
super().__init__(message)
-class InvalidState(Exception):
+class AbortHandshake(InvalidHandshake):
"""
- Exception raised when an operation is forbidden in the current state.
+ Raised to abort the handshake on purpose and return a HTTP response.
- """
+ This exception is an implementation detail.
+ The public API is :meth:`~legacy.server.WebSocketServerProtocol.process_request`.
-CLOSE_CODES = {
- 1000: "OK",
- 1001: "going away",
- 1002: "protocol error",
- 1003: "unsupported type",
- # 1004 is reserved
- 1005: "no status code [internal]",
- 1006: "connection closed abnormally [internal]",
- 1007: "invalid data",
- 1008: "policy violation",
- 1009: "message too big",
- 1010: "extension required",
- 1011: "unexpected error",
- 1015: "TLS failure [internal]",
-}
+ """
+
+ def __init__(
+ self,
+ status: http.HTTPStatus,
+ headers: HeadersLike,
+ body: bytes = b"",
+ ) -> None:
+ self.status = status
+ self.headers = Headers(headers)
+ self.body = body
+ message = f"HTTP {status}, {len(self.headers)} headers, {len(body)} bytes"
+ super().__init__(message)
-def format_close(code, reason):
+class RedirectHandshake(InvalidHandshake):
"""
- Display a human-readable version of the close code and reason.
+ Raised when a handshake gets redirected.
+ This exception is an implementation detail.
"""
- if 3000 <= code < 4000:
- explanation = "registered"
- elif 4000 <= code < 5000:
- explanation = "private use"
- else:
- explanation = CLOSE_CODES.get(code, "unknown")
- result = "code = {} ({}), ".format(code, explanation)
- if reason:
- result += "reason = {}".format(reason)
- else:
- result += "no reason"
+ def __init__(self, uri: str) -> None:
+ self.uri = uri
- return result
+ def __str__(self) -> str:
+ return f"redirect to {self.uri}"
-class ConnectionClosed(InvalidState):
+class InvalidState(WebSocketException, AssertionError):
"""
- Exception raised when trying to read or write on a closed connection.
+ Raised when an operation is forbidden in the current state.
- Provides the connection close code and reason in its ``code`` and
- ``reason`` attributes respectively.
+ This exception is an implementation detail.
- """
+ It should never be raised in normal circumstances.
- def __init__(self, code, reason):
- self.code = code
- self.reason = reason
- message = "WebSocket connection is closed: "
- message += format_close(code, reason)
- super().__init__(message)
+ """
-class InvalidURI(Exception):
+class InvalidURI(WebSocketException):
"""
- Exception raised when an URI isn't a valid websocket URI.
+ Raised when connecting to an URI that isn't a valid WebSocket URI.
"""
+ def __init__(self, uri: str) -> None:
+ self.uri = uri
+ message = "{} isn't a valid URI".format(uri)
+ super().__init__(message)
+
-class PayloadTooBig(Exception):
+class PayloadTooBig(WebSocketException):
"""
- Exception raised when a frame's payload exceeds the maximum size.
+ Raised when receiving a frame with a payload exceeding the maximum size.
"""
-class WebSocketProtocolError(Exception):
+class ProtocolError(WebSocketException):
"""
- Internal exception raised when the remote side breaks the protocol.
+ Raised when a frame breaks the protocol.
"""
+
+
+WebSocketProtocolError = ProtocolError # for backwards compatibility
diff --git a/src/websockets/extensions/__init__.py b/src/websockets/extensions/__init__.py
index e69de29bb..02838b98a 100644
--- a/src/websockets/extensions/__init__.py
+++ b/src/websockets/extensions/__init__.py
@@ -0,0 +1,4 @@
+from .base import *
+
+
+__all__ = ["Extension", "ClientExtensionFactory", "ServerExtensionFactory"]
diff --git a/src/websockets/extensions/base.py b/src/websockets/extensions/base.py
index 69b55b3f8..cfc090799 100644
--- a/src/websockets/extensions/base.py
+++ b/src/websockets/extensions/base.py
@@ -1,92 +1,119 @@
"""
-The :mod:`websockets.extensions.base` defines abstract classes for extensions.
+:mod:`websockets.extensions.base` defines abstract classes for implementing
+extensions.
-See https://tools.ietf.org/html/rfc6455#section-9.
+See `section 9 of RFC 6455`_.
+
+.. _section 9 of RFC 6455: http://tools.ietf.org/html/rfc6455#section-9
"""
+from typing import List, Optional, Sequence, Tuple
+
+from ..frames import Frame
+from ..typing import ExtensionName, ExtensionParameter
-class ClientExtensionFactory:
- """
- Abstract class for client-side extension factories.
- Extension factories handle configuration and negotiation.
+__all__ = ["Extension", "ClientExtensionFactory", "ServerExtensionFactory"]
+
+class Extension:
"""
+ Abstract class for extensions.
- name = ...
+ """
- def get_request_params(self):
+ @property
+ def name(self) -> ExtensionName:
"""
- Build request parameters.
-
- Return a list of (name, value) pairs.
+ Extension identifier.
"""
- def process_response_params(self, params, accepted_extensions):
- """"
- Process response parameters.
+ def decode(self, frame: Frame, *, max_size: Optional[int] = None) -> Frame:
+ """
+ Decode an incoming frame.
- ``params`` are a list of (name, value) pairs.
+ :param frame: incoming frame
+ :param max_size: maximum payload size in bytes
- ``accepted_extensions`` is a list of previously accepted extensions,
- represented by extension instances.
+ """
- Return an extension instance (an instance of a subclass of
- :class:`Extension`) if these parameters are acceptable.
+ def encode(self, frame: Frame) -> Frame:
+ """
+ Encode an outgoing frame.
- Raise :exc:`~websockets.exceptions.NegotiationError` if they aren't.
+ :param frame: outgoing frame
"""
-class ServerExtensionFactory:
+class ClientExtensionFactory:
"""
- Abstract class for server-side extension factories.
-
- Extension factories handle configuration and negotiation.
+ Abstract class for client-side extension factories.
"""
- name = ...
+ @property
+ def name(self) -> ExtensionName:
+ """
+ Extension identifier.
- def process_request_params(self, params, accepted_extensions):
- """"
- Process request parameters.
+ """
- ``accepted_extensions`` is a list of previously accepted extensions,
- represented by extension instances.
+ def get_request_params(self) -> List[ExtensionParameter]:
+ """
+ Build request parameters.
- Return response params (a list of (name, value) pairs) and an
- extension instance (an instance of a subclass of :class:`Extension`)
- to accept this extension.
+ Return a list of ``(name, value)`` pairs.
- Raise :exc:`~websockets.exceptions.NegotiationError` to reject it.
+ """
+ def process_response_params(
+ self,
+ params: Sequence[ExtensionParameter],
+ accepted_extensions: Sequence[Extension],
+ ) -> Extension:
"""
+ Process response parameters received from the server.
+ :param params: list of ``(name, value)`` pairs.
+ :param accepted_extensions: list of previously accepted extensions.
+ :raises ~websockets.exceptions.NegotiationError: if parameters aren't
+ acceptable
-class Extension:
- """
- Abstract class for extensions.
+ """
+
+class ServerExtensionFactory:
"""
+ Abstract class for server-side extension factories.
- name = ...
+ """
- def decode(self, frame, *, max_size=None):
+ @property
+ def name(self) -> ExtensionName:
"""
- Decode an incoming frame.
-
- Return a frame.
+ Extension identifier.
"""
- def encode(self, frame):
+ def process_request_params(
+ self,
+ params: Sequence[ExtensionParameter],
+ accepted_extensions: Sequence[Extension],
+ ) -> Tuple[List[ExtensionParameter], Extension]:
"""
- Encode an outgoing frame.
+ Process request parameters received from the client.
+
+ To accept the offer, return a 2-uple containing:
+
+ - response parameters: a list of ``(name, value)`` pairs
+ - an extension: an instance of a subclass of :class:`Extension`
- Return a frame.
+ :param params: list of ``(name, value)`` pairs.
+ :param accepted_extensions: list of previously accepted extensions.
+ :raises ~websockets.exceptions.NegotiationError: to reject the offer,
+ if parameters aren't acceptable
"""
diff --git a/src/websockets/extensions/permessage_deflate.py b/src/websockets/extensions/permessage_deflate.py
index 19f340734..4f520af38 100644
--- a/src/websockets/extensions/permessage_deflate.py
+++ b/src/websockets/extensions/permessage_deflate.py
@@ -1,10 +1,11 @@
"""
-The :mod:`websockets.extensions.permessage_deflate` module implements the
-Compression Extensions for WebSocket as specified in :rfc:`7692`.
+:mod:`websockets.extensions.permessage_deflate` implements the Compression
+Extensions for WebSocket as specified in :rfc:`7692`.
"""
import zlib
+from typing import Any, Dict, List, Optional, Sequence, Tuple, Union
from ..exceptions import (
DuplicateParameter,
@@ -13,45 +14,192 @@
NegotiationError,
PayloadTooBig,
)
-from ..framing import CTRL_OPCODES, OP_CONT
+from ..frames import CTRL_OPCODES, OP_CONT, Frame
+from ..typing import ExtensionName, ExtensionParameter
+from .base import ClientExtensionFactory, Extension, ServerExtensionFactory
__all__ = [
- 'ClientPerMessageDeflateFactory',
- 'ServerPerMessageDeflateFactory',
- 'PerMessageDeflate',
+ "PerMessageDeflate",
+ "ClientPerMessageDeflateFactory",
+ "enable_client_permessage_deflate",
+ "ServerPerMessageDeflateFactory",
+ "enable_server_permessage_deflate",
]
-_EMPTY_UNCOMPRESSED_BLOCK = b'\x00\x00\xff\xff'
+_EMPTY_UNCOMPRESSED_BLOCK = b"\x00\x00\xff\xff"
_MAX_WINDOW_BITS_VALUES = [str(bits) for bits in range(8, 16)]
+class PerMessageDeflate(Extension):
+ """
+ Per-Message Deflate extension.
+
+ """
+
+ name = ExtensionName("permessage-deflate")
+
+ def __init__(
+ self,
+ remote_no_context_takeover: bool,
+ local_no_context_takeover: bool,
+ remote_max_window_bits: int,
+ local_max_window_bits: int,
+ compress_settings: Optional[Dict[Any, Any]] = None,
+ ) -> None:
+ """
+ Configure the Per-Message Deflate extension.
+
+ """
+ if compress_settings is None:
+ compress_settings = {}
+
+ assert remote_no_context_takeover in [False, True]
+ assert local_no_context_takeover in [False, True]
+ assert 8 <= remote_max_window_bits <= 15
+ assert 8 <= local_max_window_bits <= 15
+ assert "wbits" not in compress_settings
+
+ self.remote_no_context_takeover = remote_no_context_takeover
+ self.local_no_context_takeover = local_no_context_takeover
+ self.remote_max_window_bits = remote_max_window_bits
+ self.local_max_window_bits = local_max_window_bits
+ self.compress_settings = compress_settings
+
+ if not self.remote_no_context_takeover:
+ self.decoder = zlib.decompressobj(wbits=-self.remote_max_window_bits)
+
+ if not self.local_no_context_takeover:
+ self.encoder = zlib.compressobj(
+ wbits=-self.local_max_window_bits, **self.compress_settings
+ )
+
+ # To handle continuation frames properly, we must keep track of
+ # whether that initial frame was encoded.
+ self.decode_cont_data = False
+ # There's no need for self.encode_cont_data because we always encode
+ # outgoing frames, so it would always be True.
+
+ def __repr__(self) -> str:
+ return (
+ f"PerMessageDeflate("
+ f"remote_no_context_takeover={self.remote_no_context_takeover}, "
+ f"local_no_context_takeover={self.local_no_context_takeover}, "
+ f"remote_max_window_bits={self.remote_max_window_bits}, "
+ f"local_max_window_bits={self.local_max_window_bits})"
+ )
+
+ def decode(self, frame: Frame, *, max_size: Optional[int] = None) -> Frame:
+ """
+ Decode an incoming frame.
+
+ """
+ # Skip control frames.
+ if frame.opcode in CTRL_OPCODES:
+ return frame
+
+ # Handle continuation data frames:
+ # - skip if the message isn't encoded
+ # - reset "decode continuation data" flag if it's a final frame
+ if frame.opcode == OP_CONT:
+ if not self.decode_cont_data:
+ return frame
+ if frame.fin:
+ self.decode_cont_data = False
+
+ # Handle text and binary data frames:
+ # - skip if the message isn't encoded
+ # - unset the rsv1 flag on the first frame of a compressed message
+ # - set "decode continuation data" flag if it's a non-final frame
+ else:
+ if not frame.rsv1:
+ return frame
+ frame = frame._replace(rsv1=False)
+ if not frame.fin:
+ self.decode_cont_data = True
+
+ # Re-initialize per-message decoder.
+ if self.remote_no_context_takeover:
+ self.decoder = zlib.decompressobj(wbits=-self.remote_max_window_bits)
+
+ # Uncompress data. Protect against zip bombs by preventing zlib from
+ # decompressing more than max_length bytes (except when the limit is
+ # disabled with max_size = None).
+ data = frame.data
+ if frame.fin:
+ data += _EMPTY_UNCOMPRESSED_BLOCK
+ max_length = 0 if max_size is None else max_size
+ data = self.decoder.decompress(data, max_length)
+ if self.decoder.unconsumed_tail:
+ raise PayloadTooBig(f"over size limit (? > {max_size} bytes)")
+
+ # Allow garbage collection of the decoder if it won't be reused.
+ if frame.fin and self.remote_no_context_takeover:
+ del self.decoder
+
+ return frame._replace(data=data)
+
+ def encode(self, frame: Frame) -> Frame:
+ """
+ Encode an outgoing frame.
+
+ """
+ # Skip control frames.
+ if frame.opcode in CTRL_OPCODES:
+ return frame
+
+ # Since we always encode messages, there's no "encode continuation
+ # data" flag similar to "decode continuation data" at this time.
+
+ if frame.opcode != OP_CONT:
+ # Set the rsv1 flag on the first frame of a compressed message.
+ frame = frame._replace(rsv1=True)
+ # Re-initialize per-message decoder.
+ if self.local_no_context_takeover:
+ self.encoder = zlib.compressobj(
+ wbits=-self.local_max_window_bits, **self.compress_settings
+ )
+
+ # Compress data.
+ data = self.encoder.compress(frame.data) + self.encoder.flush(zlib.Z_SYNC_FLUSH)
+ if frame.fin and data.endswith(_EMPTY_UNCOMPRESSED_BLOCK):
+ data = data[:-4]
+
+ # Allow garbage collection of the encoder if it won't be reused.
+ if frame.fin and self.local_no_context_takeover:
+ del self.encoder
+
+ return frame._replace(data=data)
+
+
def _build_parameters(
- server_no_context_takeover,
- client_no_context_takeover,
- server_max_window_bits,
- client_max_window_bits,
-):
+ server_no_context_takeover: bool,
+ client_no_context_takeover: bool,
+ server_max_window_bits: Optional[int],
+ client_max_window_bits: Optional[Union[int, bool]],
+) -> List[ExtensionParameter]:
"""
Build a list of ``(name, value)`` pairs for some compression parameters.
"""
- params = []
+ params: List[ExtensionParameter] = []
if server_no_context_takeover:
- params.append(('server_no_context_takeover', None))
+ params.append(("server_no_context_takeover", None))
if client_no_context_takeover:
- params.append(('client_no_context_takeover', None))
+ params.append(("client_no_context_takeover", None))
if server_max_window_bits:
- params.append(('server_max_window_bits', str(server_max_window_bits)))
+ params.append(("server_max_window_bits", str(server_max_window_bits)))
if client_max_window_bits is True: # only in handshake requests
- params.append(('client_max_window_bits', None))
+ params.append(("client_max_window_bits", None))
elif client_max_window_bits:
- params.append(('client_max_window_bits', str(client_max_window_bits)))
+ params.append(("client_max_window_bits", str(client_max_window_bits)))
return params
-def _extract_parameters(params, *, is_server):
+def _extract_parameters(
+ params: Sequence[ExtensionParameter], *, is_server: bool
+) -> Tuple[bool, bool, Optional[int], Optional[Union[int, bool]]]:
"""
Extract compression parameters from a list of ``(name, value)`` pairs.
@@ -59,14 +207,14 @@ def _extract_parameters(params, *, is_server):
without a value. This is only allow in handshake requests.
"""
- server_no_context_takeover = False
- client_no_context_takeover = False
- server_max_window_bits = None
- client_max_window_bits = None
+ server_no_context_takeover: bool = False
+ client_no_context_takeover: bool = False
+ server_max_window_bits: Optional[int] = None
+ client_max_window_bits: Optional[Union[int, bool]] = None
for name, value in params:
- if name == 'server_no_context_takeover':
+ if name == "server_no_context_takeover":
if server_no_context_takeover:
raise DuplicateParameter(name)
if value is None:
@@ -74,7 +222,7 @@ def _extract_parameters(params, *, is_server):
else:
raise InvalidParameterValue(name, value)
- elif name == 'client_no_context_takeover':
+ elif name == "client_no_context_takeover":
if client_no_context_takeover:
raise DuplicateParameter(name)
if value is None:
@@ -82,7 +230,7 @@ def _extract_parameters(params, *, is_server):
else:
raise InvalidParameterValue(name, value)
- elif name == 'server_max_window_bits':
+ elif name == "server_max_window_bits":
if server_max_window_bits is not None:
raise DuplicateParameter(name)
if value in _MAX_WINDOW_BITS_VALUES:
@@ -90,7 +238,7 @@ def _extract_parameters(params, *, is_server):
else:
raise InvalidParameterValue(name, value)
- elif name == 'client_max_window_bits':
+ elif name == "client_max_window_bits":
if client_max_window_bits is not None:
raise DuplicateParameter(name)
if is_server and value is None: # only in handshake requests
@@ -111,26 +259,37 @@ def _extract_parameters(params, *, is_server):
)
-class ClientPerMessageDeflateFactory:
+class ClientPerMessageDeflateFactory(ClientExtensionFactory):
"""
- Client-side extension factory for permessage-deflate extension.
+ Client-side extension factory for the Per-Message Deflate extension.
+
+ Parameters behave as described in `section 7.1 of RFC 7692`_. Set them to
+ ``True`` to include them in the negotiation offer without a value or to an
+ integer value to include them with this value.
+
+ .. _section 7.1 of RFC 7692: https://tools.ietf.org/html/rfc7692#section-7.1
+
+ :param server_no_context_takeover: defaults to ``False``
+ :param client_no_context_takeover: defaults to ``False``
+ :param server_max_window_bits: optional, defaults to ``None``
+ :param client_max_window_bits: optional, defaults to ``None``
+ :param compress_settings: optional, keyword arguments for
+ :func:`zlib.compressobj`, excluding ``wbits``
"""
- name = 'permessage-deflate'
+ name = ExtensionName("permessage-deflate")
def __init__(
self,
- server_no_context_takeover=False,
- client_no_context_takeover=False,
- server_max_window_bits=None,
- client_max_window_bits=None,
- compress_settings=None,
- ):
+ server_no_context_takeover: bool = False,
+ client_no_context_takeover: bool = False,
+ server_max_window_bits: Optional[int] = None,
+ client_max_window_bits: Optional[Union[int, bool]] = None,
+ compress_settings: Optional[Dict[str, Any]] = None,
+ ) -> None:
"""
- Configure permessage-deflate extension factory.
-
- See https://tools.ietf.org/html/rfc7692#section-7.1.
+ Configure the Per-Message Deflate extension factory.
"""
if not (server_max_window_bits is None or 8 <= server_max_window_bits <= 15):
@@ -141,7 +300,7 @@ def __init__(
or 8 <= client_max_window_bits <= 15
):
raise ValueError("client_max_window_bits must be between 8 and 15")
- if compress_settings is not None and 'wbits' in compress_settings:
+ if compress_settings is not None and "wbits" in compress_settings:
raise ValueError(
"compress_settings must not include wbits, "
"set client_max_window_bits instead"
@@ -153,7 +312,7 @@ def __init__(
self.client_max_window_bits = client_max_window_bits
self.compress_settings = compress_settings
- def get_request_params(self):
+ def get_request_params(self) -> List[ExtensionParameter]:
"""
Build request parameters.
@@ -165,15 +324,19 @@ def get_request_params(self):
self.client_max_window_bits,
)
- def process_response_params(self, params, accepted_extensions):
- """"
+ def process_response_params(
+ self,
+ params: Sequence[ExtensionParameter],
+ accepted_extensions: Sequence["Extension"],
+ ) -> PerMessageDeflate:
+ """
Process response parameters.
Return an extension instance.
"""
if any(other.name == self.name for other in accepted_extensions):
- raise NegotiationError("Received duplicate {}".format(self.name))
+ raise NegotiationError(f"received duplicate {self.name}")
# Request parameters are available in instance variables.
@@ -199,7 +362,7 @@ def process_response_params(self, params, accepted_extensions):
if self.server_no_context_takeover:
if not server_no_context_takeover:
- raise NegotiationError("Expected server_no_context_takeover")
+ raise NegotiationError("expected server_no_context_takeover")
# client_no_context_takeover
#
@@ -229,9 +392,9 @@ def process_response_params(self, params, accepted_extensions):
else:
if server_max_window_bits is None:
- raise NegotiationError("Expected server_max_window_bits")
+ raise NegotiationError("expected server_max_window_bits")
elif server_max_window_bits > self.server_max_window_bits:
- raise NegotiationError("Unsupported server_max_window_bits")
+ raise NegotiationError("unsupported server_max_window_bits")
# client_max_window_bits
@@ -247,7 +410,7 @@ def process_response_params(self, params, accepted_extensions):
if self.client_max_window_bits is None:
if client_max_window_bits is not None:
- raise NegotiationError("Unexpected client_max_window_bits")
+ raise NegotiationError("unexpected client_max_window_bits")
elif self.client_max_window_bits is True:
pass
@@ -256,7 +419,7 @@ def process_response_params(self, params, accepted_extensions):
if client_max_window_bits is None:
client_max_window_bits = self.client_max_window_bits
elif client_max_window_bits > self.client_max_window_bits:
- raise NegotiationError("Unsupported client_max_window_bits")
+ raise NegotiationError("unsupported client_max_window_bits")
return PerMessageDeflate(
server_no_context_takeover, # remote_no_context_takeover
@@ -267,33 +430,67 @@ def process_response_params(self, params, accepted_extensions):
)
-class ServerPerMessageDeflateFactory:
+def enable_client_permessage_deflate(
+ extensions: Optional[Sequence[ClientExtensionFactory]],
+) -> Sequence[ClientExtensionFactory]:
+ """
+ Enable Per-Message Deflate with default settings in client extensions.
+
+ If the extension is already present, perhaps with non-default settings,
+ the configuration isn't changed.
+
+
+ """
+ if extensions is None:
+ extensions = []
+ if not any(
+ extension_factory.name == ClientPerMessageDeflateFactory.name
+ for extension_factory in extensions
+ ):
+ extensions = list(extensions) + [
+ ClientPerMessageDeflateFactory(client_max_window_bits=True)
+ ]
+ return extensions
+
+
+class ServerPerMessageDeflateFactory(ServerExtensionFactory):
"""
- Server-side extension factory for permessage-deflate extension.
+ Server-side extension factory for the Per-Message Deflate extension.
+
+ Parameters behave as described in `section 7.1 of RFC 7692`_. Set them to
+ ``True`` to include them in the negotiation offer without a value or to an
+ integer value to include them with this value.
+
+ .. _section 7.1 of RFC 7692: https://tools.ietf.org/html/rfc7692#section-7.1
+
+ :param server_no_context_takeover: defaults to ``False``
+ :param client_no_context_takeover: defaults to ``False``
+ :param server_max_window_bits: optional, defaults to ``None``
+ :param client_max_window_bits: optional, defaults to ``None``
+ :param compress_settings: optional, keyword arguments for
+ :func:`zlib.compressobj`, excluding ``wbits``
"""
- name = 'permessage-deflate'
+ name = ExtensionName("permessage-deflate")
def __init__(
self,
- server_no_context_takeover=False,
- client_no_context_takeover=False,
- server_max_window_bits=None,
- client_max_window_bits=None,
- compress_settings=None,
- ):
+ server_no_context_takeover: bool = False,
+ client_no_context_takeover: bool = False,
+ server_max_window_bits: Optional[int] = None,
+ client_max_window_bits: Optional[int] = None,
+ compress_settings: Optional[Dict[str, Any]] = None,
+ ) -> None:
"""
- Configure permessage-deflate extension factory.
-
- See https://tools.ietf.org/html/rfc7692#section-7.1.
+ Configure the Per-Message Deflate extension factory.
"""
if not (server_max_window_bits is None or 8 <= server_max_window_bits <= 15):
raise ValueError("server_max_window_bits must be between 8 and 15")
if not (client_max_window_bits is None or 8 <= client_max_window_bits <= 15):
raise ValueError("client_max_window_bits must be between 8 and 15")
- if compress_settings is not None and 'wbits' in compress_settings:
+ if compress_settings is not None and "wbits" in compress_settings:
raise ValueError(
"compress_settings must not include wbits, "
"set server_max_window_bits instead"
@@ -305,15 +502,19 @@ def __init__(
self.client_max_window_bits = client_max_window_bits
self.compress_settings = compress_settings
- def process_request_params(self, params, accepted_extensions):
- """"
+ def process_request_params(
+ self,
+ params: Sequence[ExtensionParameter],
+ accepted_extensions: Sequence["Extension"],
+ ) -> Tuple[List[ExtensionParameter], PerMessageDeflate]:
+ """
Process request parameters.
Return response params and an extension instance.
"""
if any(other.name == self.name for other in accepted_extensions):
- raise NegotiationError("Skipped duplicate {}".format(self.name))
+ raise NegotiationError(f"skipped duplicate {self.name}")
# Load request parameters in local variables.
(
@@ -391,7 +592,7 @@ def process_request_params(self, params, accepted_extensions):
else:
if client_max_window_bits is None:
- raise NegotiationError("Required client_max_window_bits")
+ raise NegotiationError("required client_max_window_bits")
elif client_max_window_bits is True:
client_max_window_bits = self.client_max_window_bits
elif self.client_max_window_bits < client_max_window_bits:
@@ -414,147 +615,21 @@ def process_request_params(self, params, accepted_extensions):
)
-class PerMessageDeflate:
+def enable_server_permessage_deflate(
+ extensions: Optional[Sequence[ServerExtensionFactory]],
+) -> Sequence[ServerExtensionFactory]:
"""
- permessage-deflate extension.
+ Enable Per-Message Deflate with default settings in server extensions.
- """
-
- name = 'permessage-deflate'
+ If the extension is already present, perhaps with non-default settings,
+ the configuration isn't changed.
- def __init__(
- self,
- remote_no_context_takeover,
- local_no_context_takeover,
- remote_max_window_bits,
- local_max_window_bits,
- compress_settings=None,
+ """
+ if extensions is None:
+ extensions = []
+ if not any(
+ ext_factory.name == ServerPerMessageDeflateFactory.name
+ for ext_factory in extensions
):
- """
- Configure permessage-deflate extension.
-
- """
- if compress_settings is None:
- compress_settings = {}
-
- assert remote_no_context_takeover in [False, True]
- assert local_no_context_takeover in [False, True]
- assert 8 <= remote_max_window_bits <= 15
- assert 8 <= local_max_window_bits <= 15
- assert 'wbits' not in compress_settings
-
- self.remote_no_context_takeover = remote_no_context_takeover
- self.local_no_context_takeover = local_no_context_takeover
- self.remote_max_window_bits = remote_max_window_bits
- self.local_max_window_bits = local_max_window_bits
- self.compress_settings = compress_settings
-
- if not self.remote_no_context_takeover:
- self.decoder = zlib.decompressobj(wbits=-self.remote_max_window_bits)
-
- if not self.local_no_context_takeover:
- self.encoder = zlib.compressobj(
- wbits=-self.local_max_window_bits, **self.compress_settings
- )
-
- # To handle continuation frames properly, we must keep track of
- # whether that initial frame was encoded.
- self.decode_cont_data = False
- # There's no need for self.encode_cont_data because we always encode
- # outgoing frames, so it would always be True.
-
- def __repr__(self):
- return (
- 'PerMessageDeflate('
- 'remote_no_context_takeover={}, '
- 'local_no_context_takeover={}, '
- 'remote_max_window_bits={}, '
- 'local_max_window_bits={})'
- ).format(
- self.remote_no_context_takeover,
- self.local_no_context_takeover,
- self.remote_max_window_bits,
- self.local_max_window_bits,
- )
-
- def decode(self, frame, *, max_size=None):
- """
- Decode an incoming frame.
-
- """
- # Skip control frames.
- if frame.opcode in CTRL_OPCODES:
- return frame
-
- # Handle continuation data frames:
- # - skip if the initial data frame wasn't encoded
- # - reset "decode continuation data" flag if it's a final frame
- if frame.opcode == OP_CONT:
- if not self.decode_cont_data:
- return frame
- if frame.fin:
- self.decode_cont_data = False
-
- # Handle text and binary data frames:
- # - skip if the frame isn't encoded
- # - set "decode continuation data" flag if it's a non-final frame
- else:
- if not frame.rsv1:
- return frame
- if not frame.fin: # frame.rsv1 is True at this point
- self.decode_cont_data = True
-
- # Re-initialize per-message decoder.
- if self.remote_no_context_takeover:
- self.decoder = zlib.decompressobj(wbits=-self.remote_max_window_bits)
-
- # Uncompress compressed frames. Protect against zip bombs by
- # preventing zlib from decompressing more than max_length bytes
- # (except when the limit is disabled with max_size = None).
- data = frame.data
- if frame.fin:
- data += _EMPTY_UNCOMPRESSED_BLOCK
- max_length = 0 if max_size is None else max_size
- data = self.decoder.decompress(data, max_length)
- if self.decoder.unconsumed_tail:
- raise PayloadTooBig(
- "Uncompressed payload length exceeds size limit (? > {} bytes)".format(
- max_size
- )
- )
-
- # Allow garbage collection of the decoder if it won't be reused.
- if frame.fin and self.remote_no_context_takeover:
- self.decoder = None
-
- return frame._replace(data=data, rsv1=False)
-
- def encode(self, frame):
- """
- Encode an outgoing frame.
-
- """
- # Skip control frames.
- if frame.opcode in CTRL_OPCODES:
- return frame
-
- # Since we always encode and never fragment messages, there's no logic
- # similar to decode() here at this time.
-
- if frame.opcode != OP_CONT:
- # Re-initialize per-message decoder.
- if self.local_no_context_takeover:
- self.encoder = zlib.compressobj(
- wbits=-self.local_max_window_bits, **self.compress_settings
- )
-
- # Compress data frames.
- data = self.encoder.compress(frame.data) + self.encoder.flush(zlib.Z_SYNC_FLUSH)
- if frame.fin and data.endswith(_EMPTY_UNCOMPRESSED_BLOCK):
- data = data[:-4]
-
- # Allow garbage collection of the encoder if it won't be reused.
- if frame.fin and self.local_no_context_takeover:
- self.encoder = None
-
- return frame._replace(data=data, rsv1=True)
+ extensions = list(extensions) + [ServerPerMessageDeflateFactory()]
+ return extensions
diff --git a/src/websockets/frames.py b/src/websockets/frames.py
new file mode 100644
index 000000000..6e5ef1b73
--- /dev/null
+++ b/src/websockets/frames.py
@@ -0,0 +1,341 @@
+"""
+Parse and serialize WebSocket frames.
+
+"""
+
+import enum
+import io
+import secrets
+import struct
+from typing import Callable, Generator, NamedTuple, Optional, Sequence, Tuple
+
+from .exceptions import PayloadTooBig, ProtocolError
+from .typing import Data
+
+
+try:
+ from .speedups import apply_mask
+except ImportError: # pragma: no cover
+ from .utils import apply_mask
+
+
+__all__ = [
+ "Opcode",
+ "OP_CONT",
+ "OP_TEXT",
+ "OP_BINARY",
+ "OP_CLOSE",
+ "OP_PING",
+ "OP_PONG",
+ "DATA_OPCODES",
+ "CTRL_OPCODES",
+ "Frame",
+ "prepare_data",
+ "prepare_ctrl",
+ "parse_close",
+ "serialize_close",
+]
+
+
+class Opcode(enum.IntEnum):
+ CONT, TEXT, BINARY = 0x00, 0x01, 0x02
+ CLOSE, PING, PONG = 0x08, 0x09, 0x0A
+
+
+OP_CONT = Opcode.CONT
+OP_TEXT = Opcode.TEXT
+OP_BINARY = Opcode.BINARY
+OP_CLOSE = Opcode.CLOSE
+OP_PING = Opcode.PING
+OP_PONG = Opcode.PONG
+
+DATA_OPCODES = OP_CONT, OP_TEXT, OP_BINARY
+CTRL_OPCODES = OP_CLOSE, OP_PING, OP_PONG
+
+# Close code that are allowed in a close frame.
+# Using a set optimizes `code in EXTERNAL_CLOSE_CODES`.
+EXTERNAL_CLOSE_CODES = {
+ 1000,
+ 1001,
+ 1002,
+ 1003,
+ 1007,
+ 1008,
+ 1009,
+ 1010,
+ 1011,
+ 1012,
+ 1013,
+ 1014,
+}
+
+
+# Consider converting to a dataclass when dropping support for Python < 3.7.
+
+
+class Frame(NamedTuple):
+ """
+ WebSocket frame.
+
+ :param bool fin: FIN bit
+ :param bool rsv1: RSV1 bit
+ :param bool rsv2: RSV2 bit
+ :param bool rsv3: RSV3 bit
+ :param int opcode: opcode
+ :param bytes data: payload data
+
+ Only these fields are needed. The MASK bit, payload length and masking-key
+ are handled on the fly by :func:`parse_frame` and :meth:`serialize_frame`.
+
+ """
+
+ fin: bool
+ opcode: Opcode
+ data: bytes
+ rsv1: bool = False
+ rsv2: bool = False
+ rsv3: bool = False
+
+ @classmethod
+ def parse(
+ cls,
+ read_exact: Callable[[int], Generator[None, None, bytes]],
+ *,
+ mask: bool,
+ max_size: Optional[int] = None,
+ extensions: Optional[Sequence["extensions.Extension"]] = None,
+ ) -> Generator[None, None, "Frame"]:
+ """
+ Read a WebSocket frame.
+
+ :param read_exact: generator-based coroutine that reads the requested
+ number of bytes or raises an exception if there isn't enough data
+ :param mask: whether the frame should be masked i.e. whether the read
+ happens on the server side
+ :param max_size: maximum payload size in bytes
+ :param extensions: list of classes with a ``decode()`` method that
+ transforms the frame and return a new frame; extensions are applied
+ in reverse order
+ :raises ~websockets.exceptions.PayloadTooBig: if the frame exceeds
+ ``max_size``
+ :raises ~websockets.exceptions.ProtocolError: if the frame
+ contains incorrect values
+
+ """
+ # Read the header.
+ data = yield from read_exact(2)
+ head1, head2 = struct.unpack("!BB", data)
+
+ # While not Pythonic, this is marginally faster than calling bool().
+ fin = True if head1 & 0b10000000 else False
+ rsv1 = True if head1 & 0b01000000 else False
+ rsv2 = True if head1 & 0b00100000 else False
+ rsv3 = True if head1 & 0b00010000 else False
+
+ try:
+ opcode = Opcode(head1 & 0b00001111)
+ except ValueError as exc:
+ raise ProtocolError("invalid opcode") from exc
+
+ if (True if head2 & 0b10000000 else False) != mask:
+ raise ProtocolError("incorrect masking")
+
+ length = head2 & 0b01111111
+ if length == 126:
+ data = yield from read_exact(2)
+ (length,) = struct.unpack("!H", data)
+ elif length == 127:
+ data = yield from read_exact(8)
+ (length,) = struct.unpack("!Q", data)
+ if max_size is not None and length > max_size:
+ raise PayloadTooBig(f"over size limit ({length} > {max_size} bytes)")
+ if mask:
+ mask_bytes = yield from read_exact(4)
+
+ # Read the data.
+ data = yield from read_exact(length)
+ if mask:
+ data = apply_mask(data, mask_bytes)
+
+ frame = cls(fin, opcode, data, rsv1, rsv2, rsv3)
+
+ if extensions is None:
+ extensions = []
+ for extension in reversed(extensions):
+ frame = extension.decode(frame, max_size=max_size)
+
+ frame.check()
+
+ return frame
+
+ def serialize(
+ self,
+ *,
+ mask: bool,
+ extensions: Optional[Sequence["extensions.Extension"]] = None,
+ ) -> bytes:
+ """
+ Write a WebSocket frame.
+
+ :param frame: frame to write
+ :param mask: whether the frame should be masked i.e. whether the write
+ happens on the client side
+ :param extensions: list of classes with an ``encode()`` method that
+ transform the frame and return a new frame; extensions are applied
+ in order
+ :raises ~websockets.exceptions.ProtocolError: if the frame
+ contains incorrect values
+
+ """
+ self.check()
+
+ if extensions is None:
+ extensions = []
+ for extension in extensions:
+ self = extension.encode(self)
+
+ output = io.BytesIO()
+
+ # Prepare the header.
+ head1 = (
+ (0b10000000 if self.fin else 0)
+ | (0b01000000 if self.rsv1 else 0)
+ | (0b00100000 if self.rsv2 else 0)
+ | (0b00010000 if self.rsv3 else 0)
+ | self.opcode
+ )
+
+ head2 = 0b10000000 if mask else 0
+
+ length = len(self.data)
+ if length < 126:
+ output.write(struct.pack("!BB", head1, head2 | length))
+ elif length < 65536:
+ output.write(struct.pack("!BBH", head1, head2 | 126, length))
+ else:
+ output.write(struct.pack("!BBQ", head1, head2 | 127, length))
+
+ if mask:
+ mask_bytes = secrets.token_bytes(4)
+ output.write(mask_bytes)
+
+ # Prepare the data.
+ if mask:
+ data = apply_mask(self.data, mask_bytes)
+ else:
+ data = self.data
+ output.write(data)
+
+ return output.getvalue()
+
+ def check(self) -> None:
+ """
+ Check that reserved bits and opcode have acceptable values.
+
+ :raises ~websockets.exceptions.ProtocolError: if a reserved
+ bit or the opcode is invalid
+
+ """
+ if self.rsv1 or self.rsv2 or self.rsv3:
+ raise ProtocolError("reserved bits must be 0")
+
+ if self.opcode in CTRL_OPCODES:
+ if len(self.data) > 125:
+ raise ProtocolError("control frame too long")
+ if not self.fin:
+ raise ProtocolError("fragmented control frame")
+
+
+def prepare_data(data: Data) -> Tuple[int, bytes]:
+ """
+ Convert a string or byte-like object to an opcode and a bytes-like object.
+
+ This function is designed for data frames.
+
+ If ``data`` is a :class:`str`, return ``OP_TEXT`` and a :class:`bytes`
+ object encoding ``data`` in UTF-8.
+
+ If ``data`` is a bytes-like object, return ``OP_BINARY`` and a bytes-like
+ object.
+
+ :raises TypeError: if ``data`` doesn't have a supported type
+
+ """
+ if isinstance(data, str):
+ return OP_TEXT, data.encode("utf-8")
+ elif isinstance(data, (bytes, bytearray, memoryview)):
+ return OP_BINARY, data
+ else:
+ raise TypeError("data must be bytes-like or str")
+
+
+def prepare_ctrl(data: Data) -> bytes:
+ """
+ Convert a string or byte-like object to bytes.
+
+ This function is designed for ping and pong frames.
+
+ If ``data`` is a :class:`str`, return a :class:`bytes` object encoding
+ ``data`` in UTF-8.
+
+ If ``data`` is a bytes-like object, return a :class:`bytes` object.
+
+ :raises TypeError: if ``data`` doesn't have a supported type
+
+ """
+ if isinstance(data, str):
+ return data.encode("utf-8")
+ elif isinstance(data, (bytes, bytearray, memoryview)):
+ return bytes(data)
+ else:
+ raise TypeError("data must be bytes-like or str")
+
+
+def parse_close(data: bytes) -> Tuple[int, str]:
+ """
+ Parse the payload from a close frame.
+
+ Return ``(code, reason)``.
+
+ :raises ~websockets.exceptions.ProtocolError: if data is ill-formed
+ :raises UnicodeDecodeError: if the reason isn't valid UTF-8
+
+ """
+ length = len(data)
+ if length >= 2:
+ (code,) = struct.unpack("!H", data[:2])
+ check_close(code)
+ reason = data[2:].decode("utf-8")
+ return code, reason
+ elif length == 0:
+ return 1005, ""
+ else:
+ assert length == 1
+ raise ProtocolError("close frame too short")
+
+
+def serialize_close(code: int, reason: str) -> bytes:
+ """
+ Serialize the payload for a close frame.
+
+ This is the reverse of :func:`parse_close`.
+
+ """
+ check_close(code)
+ return struct.pack("!H", code) + reason.encode("utf-8")
+
+
+def check_close(code: int) -> None:
+ """
+ Check that the close code has an acceptable value for a close frame.
+
+ :raises ~websockets.exceptions.ProtocolError: if the close code
+ is invalid
+
+ """
+ if not (code in EXTERNAL_CLOSE_CODES or 3000 <= code < 5000):
+ raise ProtocolError("invalid status code")
+
+
+# at the bottom to allow circular import, because Extension depends on Frame
+from . import extensions # isort:skip # noqa
diff --git a/src/websockets/framing.py b/src/websockets/framing.py
deleted file mode 100644
index 00a24d807..000000000
--- a/src/websockets/framing.py
+++ /dev/null
@@ -1,295 +0,0 @@
-"""
-The :mod:`websockets.framing` module implements data framing as specified in
-`section 5 of RFC 6455`_.
-
-It deals with a single frame at a time. Anything that depends on the sequence
-of frames is implemented in :mod:`websockets.protocol`.
-
-.. _section 5 of RFC 6455: http://tools.ietf.org/html/rfc6455#section-5
-
-"""
-
-import asyncio
-import collections
-import io
-import random
-import struct
-
-from .exceptions import PayloadTooBig, WebSocketProtocolError
-
-
-try:
- from .speedups import apply_mask
-except ImportError: # pragma: no cover
- from .utils import apply_mask
-
-
-__all__ = [
- 'DATA_OPCODES',
- 'CTRL_OPCODES',
- 'OP_CONT',
- 'OP_TEXT',
- 'OP_BINARY',
- 'OP_CLOSE',
- 'OP_PING',
- 'OP_PONG',
- 'Frame',
- 'encode_data',
- 'parse_close',
- 'serialize_close',
-]
-
-DATA_OPCODES = OP_CONT, OP_TEXT, OP_BINARY = 0x00, 0x01, 0x02
-CTRL_OPCODES = OP_CLOSE, OP_PING, OP_PONG = 0x08, 0x09, 0x0A
-
-# Close code that are allowed in a close frame.
-# Using a list optimizes `code in EXTERNAL_CLOSE_CODES`.
-EXTERNAL_CLOSE_CODES = [1000, 1001, 1002, 1003, 1007, 1008, 1009, 1010, 1011]
-
-FrameData = collections.namedtuple(
- 'FrameData', ['fin', 'opcode', 'data', 'rsv1', 'rsv2', 'rsv3']
-)
-
-
-class Frame(FrameData):
- """
- WebSocket frame.
-
- * ``fin`` is the FIN bit
- * ``rsv1`` is the RSV1 bit
- * ``rsv2`` is the RSV2 bit
- * ``rsv3`` is the RSV3 bit
- * ``opcode`` is the opcode
- * ``data`` is the payload data
-
- Only these fields are needed by higher level code. The MASK bit, payload
- length and masking-key are handled on the fly by :meth:`read` and
- :meth:`write`.
-
- """
-
- def __new__(cls, fin, opcode, data, rsv1=False, rsv2=False, rsv3=False):
- return FrameData.__new__(cls, fin, opcode, data, rsv1, rsv2, rsv3)
-
- @classmethod
- @asyncio.coroutine
- def read(cls, reader, *, mask, max_size=None, extensions=None):
- """
- Read a WebSocket frame and return a :class:`Frame` object.
-
- ``reader`` is a coroutine taking an integer argument and reading
- exactly this number of bytes, unless the end of file is reached.
-
- ``mask`` is a :class:`bool` telling whether the frame should be masked
- i.e. whether the read happens on the server side.
-
- If ``max_size`` is set and the payload exceeds this size in bytes,
- :exc:`~websockets.exceptions.PayloadTooBig` is raised.
-
- If ``extensions`` is provided, it's a list of classes with an
- ``decode()`` method that transform the frame and return a new frame.
- They are applied in reverse order.
-
- This function validates the frame before returning it and raises
- :exc:`~websockets.exceptions.WebSocketProtocolError` if it contains
- incorrect values.
-
- """
- # Read the header.
- data = yield from reader(2)
- head1, head2 = struct.unpack('!BB', data)
-
- # While not Pythonic, this is marginally faster than calling bool().
- fin = True if head1 & 0b10000000 else False
- rsv1 = True if head1 & 0b01000000 else False
- rsv2 = True if head1 & 0b00100000 else False
- rsv3 = True if head1 & 0b00010000 else False
- opcode = head1 & 0b00001111
-
- if (True if head2 & 0b10000000 else False) != mask:
- raise WebSocketProtocolError("Incorrect masking")
-
- length = head2 & 0b01111111
- if length == 126:
- data = yield from reader(2)
- length, = struct.unpack('!H', data)
- elif length == 127:
- data = yield from reader(8)
- length, = struct.unpack('!Q', data)
- if max_size is not None and length > max_size:
- raise PayloadTooBig(
- "Payload length exceeds size limit ({} > {} bytes)".format(
- length, max_size
- )
- )
- if mask:
- mask_bits = yield from reader(4)
-
- # Read the data.
- data = yield from reader(length)
- if mask:
- data = apply_mask(data, mask_bits)
-
- frame = cls(fin, opcode, data, rsv1, rsv2, rsv3)
-
- if extensions is None:
- extensions = []
- for extension in reversed(extensions):
- frame = extension.decode(frame, max_size=max_size)
-
- frame.check()
-
- return frame
-
- def write(frame, writer, *, mask, extensions=None):
- """
- Write a WebSocket frame.
-
- ``frame`` is the :class:`Frame` object to write.
-
- ``writer`` is a function accepting bytes.
-
- ``mask`` is a :class:`bool` telling whether the frame should be masked
- i.e. whether the write happens on the client side.
-
- If ``extensions`` is provided, it's a list of classes with an
- ``encode()`` method that transform the frame and return a new frame.
- They are applied in order.
-
- This function validates the frame before sending it and raises
- :exc:`~websockets.exceptions.WebSocketProtocolError` if it contains
- incorrect values.
-
- """
- # The first parameter is called `frame` rather than `self`,
- # but it's the instance of class to which this method is bound.
-
- frame.check()
-
- if extensions is None:
- extensions = []
- for extension in extensions:
- frame = extension.encode(frame)
-
- output = io.BytesIO()
-
- # Prepare the header.
- head1 = (
- (0b10000000 if frame.fin else 0)
- | (0b01000000 if frame.rsv1 else 0)
- | (0b00100000 if frame.rsv2 else 0)
- | (0b00010000 if frame.rsv3 else 0)
- | frame.opcode
- )
-
- head2 = 0b10000000 if mask else 0
-
- length = len(frame.data)
- if length < 126:
- output.write(struct.pack('!BB', head1, head2 | length))
- elif length < 65536:
- output.write(struct.pack('!BBH', head1, head2 | 126, length))
- else:
- output.write(struct.pack('!BBQ', head1, head2 | 127, length))
-
- if mask:
- mask_bits = struct.pack('!I', random.getrandbits(32))
- output.write(mask_bits)
-
- # Prepare the data.
- if mask:
- data = apply_mask(frame.data, mask_bits)
- else:
- data = frame.data
- output.write(data)
-
- # Send the frame.
-
- # The frame is written in a single call to writer in order to prevent
- # TCP fragmentation. See #68 for details. This also makes it safe to
- # send frames concurrently from multiple coroutines.
- writer(output.getvalue())
-
- def check(frame):
- """
- Check that this frame contains acceptable values.
-
- Raise :exc:`~websockets.exceptions.WebSocketProtocolError` if this
- frame contains incorrect values.
-
- """
- # The first parameter is called `frame` rather than `self`,
- # but it's the instance of class to which this method is bound.
-
- if frame.rsv1 or frame.rsv2 or frame.rsv3:
- raise WebSocketProtocolError("Reserved bits must be 0")
-
- if frame.opcode in DATA_OPCODES:
- return
- elif frame.opcode in CTRL_OPCODES:
- if len(frame.data) > 125:
- raise WebSocketProtocolError("Control frame too long")
- if not frame.fin:
- raise WebSocketProtocolError("Fragmented control frame")
- else:
- raise WebSocketProtocolError("Invalid opcode: {}".format(frame.opcode))
-
-
-def encode_data(data):
- """
- Helper that converts :class:`str` or :class:`bytes` to :class:`bytes`.
-
- :class:`str` are encoded with UTF-8.
-
- """
- # Expect str or bytes, return bytes.
- if isinstance(data, str):
- return data.encode('utf-8')
- elif isinstance(data, bytes):
- return data
- else:
- raise TypeError("data must be bytes or str")
-
-
-def parse_close(data):
- """
- Parse the data in a close frame.
-
- Return ``(code, reason)`` when ``code`` is an :class:`int` and ``reason``
- a :class:`str`.
-
- Raise :exc:`~websockets.exceptions.WebSocketProtocolError` or
- :exc:`UnicodeDecodeError` if the data is invalid.
-
- """
- length = len(data)
- if length >= 2:
- code, = struct.unpack('!H', data[:2])
- check_close(code)
- reason = data[2:].decode('utf-8')
- return code, reason
- elif length == 0:
- return 1005, ''
- else:
- assert length == 1
- raise WebSocketProtocolError("Close frame too short")
-
-
-def serialize_close(code, reason):
- """
- Serialize the data for a close frame.
-
- This is the reverse of :func:`parse_close`.
-
- """
- check_close(code)
- return struct.pack('!H', code) + reason.encode('utf-8')
-
-
-def check_close(code):
- """
- Check the close code for a close frame.
-
- """
- if not (code in EXTERNAL_CLOSE_CODES or 3000 <= code < 5000):
- raise WebSocketProtocolError("Invalid status code")
diff --git a/src/websockets/handshake.py b/src/websockets/handshake.py
deleted file mode 100644
index cc4248974..000000000
--- a/src/websockets/handshake.py
+++ /dev/null
@@ -1,183 +0,0 @@
-"""
-The :mod:`websockets.handshake` module deals with the WebSocket opening
-handshake according to `section 4 of RFC 6455`_.
-
-.. _section 4 of RFC 6455: http://tools.ietf.org/html/rfc6455#section-4
-
-Functions defined in this module manipulate HTTP headers. The ``headers``
-argument must implement ``get`` and ``__setitem__`` and ``get`` — a small
-subset of the :class:`~collections.abc.MutableMapping` abstract base class.
-
-Headers names and values are :class:`str` objects containing only ASCII
-characters.
-
-Some checks cannot be performed because they depend too much on the
-context; instead, they're documented below.
-
-To accept a connection, a server must:
-
-- Read the request, check that the method is GET, and check the headers with
- :func:`check_request`,
-- Send a 101 response to the client with the headers created by
- :func:`build_response` if the request is valid; otherwise, send an
- appropriate HTTP error code.
-
-To open a connection, a client must:
-
-- Send a GET request to the server with the headers created by
- :func:`build_request`,
-- Read the response, check that the status code is 101, and check the headers
- with :func:`check_response`.
-
-"""
-
-import base64
-import binascii
-import hashlib
-import random
-
-from .exceptions import InvalidHeader, InvalidHeaderValue, InvalidUpgrade
-from .headers import parse_connection, parse_upgrade
-from .http import MultipleValuesError
-
-
-__all__ = ['build_request', 'check_request', 'build_response', 'check_response']
-
-GUID = '258EAFA5-E914-47DA-95CA-C5AB0DC85B11'
-
-
-def build_request(headers):
- """
- Build a handshake request to send to the server.
-
- Return the ``key`` which must be passed to :func:`check_response`.
-
- """
- raw_key = bytes(random.getrandbits(8) for _ in range(16))
- key = base64.b64encode(raw_key).decode()
- headers['Upgrade'] = 'websocket'
- headers['Connection'] = 'Upgrade'
- headers['Sec-WebSocket-Key'] = key
- headers['Sec-WebSocket-Version'] = '13'
- return key
-
-
-def check_request(headers):
- """
- Check a handshake request received from the client.
-
- If the handshake is valid, this function returns the ``key`` which must be
- passed to :func:`build_response`.
-
- Otherwise it raises an :exc:`~websockets.exceptions.InvalidHandshake`
- exception and the server must return an error like 400 Bad Request.
-
- This function doesn't verify that the request is an HTTP/1.1 or higher GET
- request and doesn't perform Host and Origin checks. These controls are
- usually performed earlier in the HTTP request handling code. They're the
- responsibility of the caller.
-
- """
- connection = sum(
- [parse_connection(value) for value in headers.get_all('Connection')], []
- )
-
- if not any(value.lower() == 'upgrade' for value in connection):
- raise InvalidUpgrade('Connection', connection)
-
- upgrade = sum([parse_upgrade(value) for value in headers.get_all('Upgrade')], [])
-
- # For compatibility with non-strict implementations, ignore case when
- # checking the Upgrade header. It's supposed to be 'WebSocket'.
- if not (len(upgrade) == 1 and upgrade[0].lower() == 'websocket'):
- raise InvalidUpgrade('Upgrade', upgrade)
-
- try:
- s_w_key = headers['Sec-WebSocket-Key']
- except KeyError:
- raise InvalidHeader('Sec-WebSocket-Key')
- except MultipleValuesError:
- raise InvalidHeader(
- 'Sec-WebSocket-Key', "more than one Sec-WebSocket-Key header found"
- )
-
- try:
- raw_key = base64.b64decode(s_w_key.encode(), validate=True)
- except binascii.Error:
- raise InvalidHeaderValue('Sec-WebSocket-Key', s_w_key)
- if len(raw_key) != 16:
- raise InvalidHeaderValue('Sec-WebSocket-Key', s_w_key)
-
- try:
- s_w_version = headers['Sec-WebSocket-Version']
- except KeyError:
- raise InvalidHeader('Sec-WebSocket-Version')
- except MultipleValuesError:
- raise InvalidHeader(
- 'Sec-WebSocket-Version', "more than one Sec-WebSocket-Version header found"
- )
-
- if s_w_version != '13':
- raise InvalidHeaderValue('Sec-WebSocket-Version', s_w_version)
-
- return s_w_key
-
-
-def build_response(headers, key):
- """
- Build a handshake response to send to the client.
-
- ``key`` comes from :func:`check_request`.
-
- """
- headers['Upgrade'] = 'websocket'
- headers['Connection'] = 'Upgrade'
- headers['Sec-WebSocket-Accept'] = accept(key)
-
-
-def check_response(headers, key):
- """
- Check a handshake response received from the server.
-
- ``key`` comes from :func:`build_request`.
-
- If the handshake is valid, this function returns ``None``.
-
- Otherwise it raises an :exc:`~websockets.exceptions.InvalidHandshake`
- exception.
-
- This function doesn't verify that the response is an HTTP/1.1 or higher
- response with a 101 status code. These controls are the responsibility of
- the caller.
-
- """
- connection = sum(
- [parse_connection(value) for value in headers.get_all('Connection')], []
- )
-
- if not any(value.lower() == 'upgrade' for value in connection):
- raise InvalidUpgrade('Connection', connection)
-
- upgrade = sum([parse_upgrade(value) for value in headers.get_all('Upgrade')], [])
-
- # For compatibility with non-strict implementations, ignore case when
- # checking the Upgrade header. It's supposed to be 'WebSocket'.
- if not (len(upgrade) == 1 and upgrade[0].lower() == 'websocket'):
- raise InvalidUpgrade('Upgrade', upgrade)
-
- try:
- s_w_accept = headers['Sec-WebSocket-Accept']
- except KeyError:
- raise InvalidHeader('Sec-WebSocket-Accept')
- except MultipleValuesError:
- raise InvalidHeader(
- 'Sec-WebSocket-Accept', "more than one Sec-WebSocket-Accept header found"
- )
-
- if s_w_accept != accept(key):
- raise InvalidHeaderValue('Sec-WebSocket-Accept', s_w_accept)
-
-
-def accept(key):
- sha1 = hashlib.sha1((key + GUID).encode()).digest()
- return base64.b64encode(sha1).decode()
diff --git a/src/websockets/headers.py b/src/websockets/headers.py
index 937962376..6779c9c04 100644
--- a/src/websockets/headers.py
+++ b/src/websockets/headers.py
@@ -1,51 +1,64 @@
"""
-The :mod:`websockets.headers` module provides parsers and serializers for HTTP
-headers used in WebSocket handshake messages.
-
-Its functions cannot be imported from :mod:`websockets`. They must be imported
-from :mod:`websockets.headers`.
+:mod:`websockets.headers` provides parsers and serializers for HTTP headers
+used in WebSocket handshake messages.
"""
import base64
+import binascii
import re
-
-from .exceptions import InvalidHeaderFormat
+from typing import Callable, List, Optional, Sequence, Tuple, TypeVar, cast
+
+from .exceptions import InvalidHeaderFormat, InvalidHeaderValue
+from .typing import (
+ ConnectionOption,
+ ExtensionHeader,
+ ExtensionName,
+ ExtensionParameter,
+ Subprotocol,
+ UpgradeProtocol,
+)
__all__ = [
- 'parse_connection',
- 'parse_upgrade',
- 'parse_extension_list',
- 'build_extension_list',
- 'parse_subprotocol_list',
- 'build_subprotocol_list',
+ "parse_connection",
+ "parse_upgrade",
+ "parse_extension",
+ "build_extension",
+ "parse_subprotocol",
+ "build_subprotocol",
+ "build_www_authenticate_basic",
+ "parse_authorization_basic",
+ "build_authorization_basic",
]
+T = TypeVar("T")
+
+
# To avoid a dependency on a parsing library, we implement manually the ABNF
# described in https://tools.ietf.org/html/rfc6455#section-9.1 with the
# definitions from https://tools.ietf.org/html/rfc7230#appendix-B.
-def peek_ahead(string, pos):
+def peek_ahead(header: str, pos: int) -> Optional[str]:
"""
- Return the next character from ``string`` at the given position.
+ Return the next character from ``header`` at the given position.
- Return ``None`` at the end of ``string``.
+ Return ``None`` at the end of ``header``.
We never need to peek more than one character ahead.
"""
- return None if pos == len(string) else string[pos]
+ return None if pos == len(header) else header[pos]
-_OWS_re = re.compile(r'[\t ]*')
+_OWS_re = re.compile(r"[\t ]*")
-def parse_OWS(string, pos):
+def parse_OWS(header: str, pos: int) -> int:
"""
- Parse optional whitespace from ``string`` at the given position.
+ Parse optional whitespace from ``header`` at the given position.
Return the new position.
@@ -53,25 +66,26 @@ def parse_OWS(string, pos):
"""
# There's always a match, possibly empty, whose content doesn't matter.
- match = _OWS_re.match(string, pos)
+ match = _OWS_re.match(header, pos)
+ assert match is not None
return match.end()
-_token_re = re.compile(r'[-!#$%&\'*+.^_`|~0-9a-zA-Z]+')
+_token_re = re.compile(r"[-!#$%&\'*+.^_`|~0-9a-zA-Z]+")
-def parse_token(string, pos, header_name):
+def parse_token(header: str, pos: int, header_name: str) -> Tuple[str, int]:
"""
- Parse a token from ``string`` at the given position.
+ Parse a token from ``header`` at the given position.
Return the token value and the new position.
- Raise :exc:`~websockets.exceptions.InvalidHeaderFormat` on invalid inputs.
+ :raises ~websockets.exceptions.InvalidHeaderFormat: on invalid inputs.
"""
- match = _token_re.match(string, pos)
+ match = _token_re.match(header, pos)
if match is None:
- raise InvalidHeaderFormat(header_name, "expected token", string=string, pos=pos)
+ raise InvalidHeaderFormat(header_name, "expected token", header, pos)
return match.group(), match.end()
@@ -80,29 +94,51 @@ def parse_token(string, pos, header_name):
)
-_unquote_re = re.compile(r'\\([\x09\x20-\x7e\x80-\xff])')
+_unquote_re = re.compile(r"\\([\x09\x20-\x7e\x80-\xff])")
-def parse_quoted_string(string, pos, header_name):
+def parse_quoted_string(header: str, pos: int, header_name: str) -> Tuple[str, int]:
"""
- Parse a quoted string from ``string`` at the given position.
+ Parse a quoted string from ``header`` at the given position.
Return the unquoted value and the new position.
- Raise :exc:`~websockets.exceptions.InvalidHeaderFormat` on invalid inputs.
+ :raises ~websockets.exceptions.InvalidHeaderFormat: on invalid inputs.
"""
- match = _quoted_string_re.match(string, pos)
+ match = _quoted_string_re.match(header, pos)
if match is None:
- raise InvalidHeaderFormat(
- header_name, "expected quoted string", string=string, pos=pos
- )
- return _unquote_re.sub(r'\1', match.group()[1:-1]), match.end()
+ raise InvalidHeaderFormat(header_name, "expected quoted string", header, pos)
+ return _unquote_re.sub(r"\1", match.group()[1:-1]), match.end()
+
+
+_quotable_re = re.compile(r"[\x09\x20-\x7e\x80-\xff]*")
+
+
+_quote_re = re.compile(r"([\x22\x5c])")
-def parse_list(parse_item, string, pos, header_name):
+def build_quoted_string(value: str) -> str:
"""
- Parse a comma-separated list from ``string`` at the given position.
+ Format ``value`` as a quoted string.
+
+ This is the reverse of :func:`parse_quoted_string`.
+
+ """
+ match = _quotable_re.fullmatch(value)
+ if match is None:
+ raise ValueError("invalid characters for quoted-string encoding")
+ return '"' + _quote_re.sub(r"\\\1", value) + '"'
+
+
+def parse_list(
+ parse_item: Callable[[str, int, str], Tuple[T, int]],
+ header: str,
+ pos: int,
+ header_name: str,
+) -> List[T]:
+ """
+ Parse a comma-separated list from ``header`` at the given position.
This is appropriate for parsing values with the following grammar:
@@ -110,14 +146,14 @@ def parse_list(parse_item, string, pos, header_name):
``parse_item`` parses one item.
- ``string`` is assumed not to start or end with whitespace.
+ ``header`` is assumed not to start or end with whitespace.
(This function is designed for parsing an entire header value and
:func:`~websockets.http.read_headers` strips whitespace from values.)
Return a list of items.
- Raise :exc:`~websockets.exceptions.InvalidHeaderFormat` on invalid inputs.
+ :raises ~websockets.exceptions.InvalidHeaderFormat: on invalid inputs.
"""
# Per https://tools.ietf.org/html/rfc7230#section-7, "a recipient MUST
@@ -125,152 +161,167 @@ def parse_list(parse_item, string, pos, header_name):
# while loops that remove extra delimiters.
# Remove extra delimiters before the first item.
- while peek_ahead(string, pos) == ',':
- pos = parse_OWS(string, pos + 1)
+ while peek_ahead(header, pos) == ",":
+ pos = parse_OWS(header, pos + 1)
items = []
while True:
- # Loop invariant: a item starts at pos in string.
- item, pos = parse_item(string, pos, header_name)
+ # Loop invariant: a item starts at pos in header.
+ item, pos = parse_item(header, pos, header_name)
items.append(item)
- pos = parse_OWS(string, pos)
+ pos = parse_OWS(header, pos)
- # We may have reached the end of the string.
- if pos == len(string):
+ # We may have reached the end of the header.
+ if pos == len(header):
break
# There must be a delimiter after each element except the last one.
- if peek_ahead(string, pos) == ',':
- pos = parse_OWS(string, pos + 1)
+ if peek_ahead(header, pos) == ",":
+ pos = parse_OWS(header, pos + 1)
else:
- raise InvalidHeaderFormat(
- header_name, "expected comma", string=string, pos=pos
- )
+ raise InvalidHeaderFormat(header_name, "expected comma", header, pos)
# Remove extra delimiters before the next item.
- while peek_ahead(string, pos) == ',':
- pos = parse_OWS(string, pos + 1)
+ while peek_ahead(header, pos) == ",":
+ pos = parse_OWS(header, pos + 1)
- # We may have reached the end of the string.
- if pos == len(string):
+ # We may have reached the end of the header.
+ if pos == len(header):
break
- # Since we only advance in the string by one character with peek_ahead()
+ # Since we only advance in the header by one character with peek_ahead()
# or with the end position of a regex match, we can't overshoot the end.
- assert pos == len(string)
+ assert pos == len(header)
return items
-def parse_connection(string):
+def parse_connection_option(
+ header: str, pos: int, header_name: str
+) -> Tuple[ConnectionOption, int]:
+ """
+ Parse a Connection option from ``header`` at the given position.
+
+ Return the protocol value and the new position.
+
+ :raises ~websockets.exceptions.InvalidHeaderFormat: on invalid inputs.
+
+ """
+ item, pos = parse_token(header, pos, header_name)
+ return cast(ConnectionOption, item), pos
+
+
+def parse_connection(header: str) -> List[ConnectionOption]:
"""
Parse a ``Connection`` header.
- Return a list of connection options.
+ Return a list of HTTP connection options.
- Raise :exc:`~websockets.exceptions.InvalidHeaderFormat` on invalid inputs.
+ :param header: value of the ``Connection`` header
+ :raises ~websockets.exceptions.InvalidHeaderFormat: on invalid inputs.
"""
- return parse_list(parse_token, string, 0, 'Connection')
+ return parse_list(parse_connection_option, header, 0, "Connection")
_protocol_re = re.compile(
- r'[-!#$%&\'*+.^_`|~0-9a-zA-Z]+(?:/[-!#$%&\'*+.^_`|~0-9a-zA-Z]+)?'
+ r"[-!#$%&\'*+.^_`|~0-9a-zA-Z]+(?:/[-!#$%&\'*+.^_`|~0-9a-zA-Z]+)?"
)
-def parse_protocol(string, pos, header_name):
+def parse_upgrade_protocol(
+ header: str, pos: int, header_name: str
+) -> Tuple[UpgradeProtocol, int]:
"""
- Parse a protocol from ``string`` at the given position.
+ Parse an Upgrade protocol from ``header`` at the given position.
Return the protocol value and the new position.
- Raise :exc:`~websockets.exceptions.InvalidHeaderFormat` on invalid inputs.
+ :raises ~websockets.exceptions.InvalidHeaderFormat: on invalid inputs.
"""
- match = _protocol_re.match(string, pos)
+ match = _protocol_re.match(header, pos)
if match is None:
- raise InvalidHeaderFormat(
- header_name, "expected protocol", string=string, pos=pos
- )
- return match.group(), match.end()
+ raise InvalidHeaderFormat(header_name, "expected protocol", header, pos)
+ return cast(UpgradeProtocol, match.group()), match.end()
-def parse_upgrade(string):
+def parse_upgrade(header: str) -> List[UpgradeProtocol]:
"""
Parse an ``Upgrade`` header.
- Return a list of connection options.
+ Return a list of HTTP protocols.
- Raise :exc:`~websockets.exceptions.InvalidHeaderFormat` on invalid inputs.
+ :param header: value of the ``Upgrade`` header
+ :raises ~websockets.exceptions.InvalidHeaderFormat: on invalid inputs.
"""
- return parse_list(parse_protocol, string, 0, 'Upgrade')
+ return parse_list(parse_upgrade_protocol, header, 0, "Upgrade")
-def parse_extension_param(string, pos, header_name):
+def parse_extension_item_param(
+ header: str, pos: int, header_name: str
+) -> Tuple[ExtensionParameter, int]:
"""
- Parse a single extension parameter from ``string`` at the given position.
+ Parse a single extension parameter from ``header`` at the given position.
Return a ``(name, value)`` pair and the new position.
- Raise :exc:`~websockets.exceptions.InvalidHeaderFormat` on invalid inputs.
+ :raises ~websockets.exceptions.InvalidHeaderFormat: on invalid inputs.
"""
# Extract parameter name.
- name, pos = parse_token(string, pos, header_name)
- pos = parse_OWS(string, pos)
- # Extract parameter string, if there is one.
- if peek_ahead(string, pos) == '=':
- pos = parse_OWS(string, pos + 1)
- if peek_ahead(string, pos) == '"':
+ name, pos = parse_token(header, pos, header_name)
+ pos = parse_OWS(header, pos)
+ # Extract parameter value, if there is one.
+ value: Optional[str] = None
+ if peek_ahead(header, pos) == "=":
+ pos = parse_OWS(header, pos + 1)
+ if peek_ahead(header, pos) == '"':
pos_before = pos # for proper error reporting below
- value, pos = parse_quoted_string(string, pos, header_name)
+ value, pos = parse_quoted_string(header, pos, header_name)
# https://tools.ietf.org/html/rfc6455#section-9.1 says: the value
# after quoted-string unescaping MUST conform to the 'token' ABNF.
if _token_re.fullmatch(value) is None:
raise InvalidHeaderFormat(
- header_name,
- "invalid quoted string content",
- string=string,
- pos=pos_before,
+ header_name, "invalid quoted header content", header, pos_before
)
else:
- value, pos = parse_token(string, pos, header_name)
- pos = parse_OWS(string, pos)
- else:
- value = None
+ value, pos = parse_token(header, pos, header_name)
+ pos = parse_OWS(header, pos)
return (name, value), pos
-def parse_extension(string, pos, header_name):
+def parse_extension_item(
+ header: str, pos: int, header_name: str
+) -> Tuple[ExtensionHeader, int]:
"""
- Parse an extension definition from ``string`` at the given position.
+ Parse an extension definition from ``header`` at the given position.
Return an ``(extension name, parameters)`` pair, where ``parameters`` is a
list of ``(name, value)`` pairs, and the new position.
- Raise :exc:`~websockets.exceptions.InvalidHeaderFormat` on invalid inputs.
+ :raises ~websockets.exceptions.InvalidHeaderFormat: on invalid inputs.
"""
# Extract extension name.
- name, pos = parse_token(string, pos, header_name)
- pos = parse_OWS(string, pos)
+ name, pos = parse_token(header, pos, header_name)
+ pos = parse_OWS(header, pos)
# Extract all parameters.
parameters = []
- while peek_ahead(string, pos) == ';':
- pos = parse_OWS(string, pos + 1)
- parameter, pos = parse_extension_param(string, pos, header_name)
+ while peek_ahead(header, pos) == ";":
+ pos = parse_OWS(header, pos + 1)
+ parameter, pos = parse_extension_item_param(header, pos, header_name)
parameters.append(parameter)
- return (name, parameters), pos
+ return (cast(ExtensionName, name), parameters), pos
-def parse_extension_list(string):
+def parse_extension(header: str) -> List[ExtensionHeader]:
"""
Parse a ``Sec-WebSocket-Extensions`` header.
- Return a value with the following format::
+ Return a list of WebSocket extensions and their parameters in this format::
[
(
@@ -285,68 +336,181 @@ def parse_extension_list(string):
Parameter values are ``None`` when no value is provided.
- Raise :exc:`~websockets.exceptions.InvalidHeaderFormat` on invalid inputs.
+ :raises ~websockets.exceptions.InvalidHeaderFormat: on invalid inputs.
"""
- return parse_list(parse_extension, string, 0, 'Sec-WebSocket-Extensions')
+ return parse_list(parse_extension_item, header, 0, "Sec-WebSocket-Extensions")
+
+parse_extension_list = parse_extension # alias for backwards compatibility
-def build_extension(name, parameters):
+
+def build_extension_item(
+ name: ExtensionName, parameters: List[ExtensionParameter]
+) -> str:
"""
Build an extension definition.
- This is the reverse of :func:`parse_extension`.
+ This is the reverse of :func:`parse_extension_item`.
"""
- return '; '.join(
- [name]
+ return "; ".join(
+ [cast(str, name)]
+ [
# Quoted strings aren't necessary because values are always tokens.
- name if value is None else '{}={}'.format(name, value)
+ name if value is None else f"{name}={value}"
for name, value in parameters
]
)
-def build_extension_list(extensions):
+def build_extension(extensions: Sequence[ExtensionHeader]) -> str:
"""
- Unparse a ``Sec-WebSocket-Extensions`` header.
+ Build a ``Sec-WebSocket-Extensions`` header.
- This is the reverse of :func:`parse_extension_list`.
+ This is the reverse of :func:`parse_extension`.
"""
- return ', '.join(
- build_extension(name, parameters) for name, parameters in extensions
+ return ", ".join(
+ build_extension_item(name, parameters) for name, parameters in extensions
)
-def parse_subprotocol_list(string):
+build_extension_list = build_extension # alias for backwards compatibility
+
+
+def parse_subprotocol_item(
+ header: str, pos: int, header_name: str
+) -> Tuple[Subprotocol, int]:
+ """
+ Parse a subprotocol from ``header`` at the given position.
+
+ Return the subprotocol value and the new position.
+
+ :raises ~websockets.exceptions.InvalidHeaderFormat: on invalid inputs.
+
+ """
+ item, pos = parse_token(header, pos, header_name)
+ return cast(Subprotocol, item), pos
+
+
+def parse_subprotocol(header: str) -> List[Subprotocol]:
"""
Parse a ``Sec-WebSocket-Protocol`` header.
- Raise :exc:`~websockets.exceptions.InvalidHeaderFormat` on invalid inputs.
+ Return a list of WebSocket subprotocols.
+ :raises ~websockets.exceptions.InvalidHeaderFormat: on invalid inputs.
+
+ """
+ return parse_list(parse_subprotocol_item, header, 0, "Sec-WebSocket-Protocol")
+
+
+parse_subprotocol_list = parse_subprotocol # alias for backwards compatibility
+
+
+def build_subprotocol(protocols: Sequence[Subprotocol]) -> str:
+ """
+ Build a ``Sec-WebSocket-Protocol`` header.
+
+ This is the reverse of :func:`parse_subprotocol`.
+
+ """
+ return ", ".join(protocols)
+
+
+build_subprotocol_list = build_subprotocol # alias for backwards compatibility
+
+
+def build_www_authenticate_basic(realm: str) -> str:
+ """
+ Build a ``WWW-Authenticate`` header for HTTP Basic Auth.
+
+ :param realm: authentication realm
+
+ """
+ # https://tools.ietf.org/html/rfc7617#section-2
+ realm = build_quoted_string(realm)
+ charset = build_quoted_string("UTF-8")
+ return f"Basic realm={realm}, charset={charset}"
+
+
+_token68_re = re.compile(r"[A-Za-z0-9-._~+/]+=*")
+
+
+def parse_token68(header: str, pos: int, header_name: str) -> Tuple[str, int]:
"""
- return parse_list(parse_token, string, 0, 'Sec-WebSocket-Protocol')
+ Parse a token68 from ``header`` at the given position.
+
+ Return the token value and the new position.
+ :raises ~websockets.exceptions.InvalidHeaderFormat: on invalid inputs.
-def build_subprotocol_list(protocols):
"""
- Unparse a ``Sec-WebSocket-Protocol`` header.
+ match = _token68_re.match(header, pos)
+ if match is None:
+ raise InvalidHeaderFormat(header_name, "expected token68", header, pos)
+ return match.group(), match.end()
- This is the reverse of :func:`parse_subprotocol_list`.
+def parse_end(header: str, pos: int, header_name: str) -> None:
"""
- return ', '.join(protocols)
+ Check that parsing reached the end of header.
+
+ """
+ if pos < len(header):
+ raise InvalidHeaderFormat(header_name, "trailing data", header, pos)
-def build_basic_auth(username, password):
+def parse_authorization_basic(header: str) -> Tuple[str, str]:
"""
- Build an Authorization header for HTTP Basic Auth.
+ Parse an ``Authorization`` header for HTTP Basic Auth.
+
+ Return a ``(username, password)`` tuple.
+
+ :param header: value of the ``Authorization`` header
+ :raises InvalidHeaderFormat: on invalid inputs
+ :raises InvalidHeaderValue: on unsupported inputs
+
+ """
+ # https://tools.ietf.org/html/rfc7235#section-2.1
+ # https://tools.ietf.org/html/rfc7617#section-2
+ scheme, pos = parse_token(header, 0, "Authorization")
+ if scheme.lower() != "basic":
+ raise InvalidHeaderValue("Authorization", f"unsupported scheme: {scheme}")
+ if peek_ahead(header, pos) != " ":
+ raise InvalidHeaderFormat(
+ "Authorization", "expected space after scheme", header, pos
+ )
+ pos += 1
+ basic_credentials, pos = parse_token68(header, pos, "Authorization")
+ parse_end(header, pos, "Authorization")
+
+ try:
+ user_pass = base64.b64decode(basic_credentials.encode()).decode()
+ except binascii.Error:
+ raise InvalidHeaderValue(
+ "Authorization", "expected base64-encoded credentials"
+ ) from None
+ try:
+ username, password = user_pass.split(":", 1)
+ except ValueError:
+ raise InvalidHeaderValue(
+ "Authorization", "expected username:password credentials"
+ ) from None
+
+ return username, password
+
+
+def build_authorization_basic(username: str, password: str) -> str:
+ """
+ Build an ``Authorization`` header for HTTP Basic Auth.
+
+ This is the reverse of :func:`parse_authorization_basic`.
"""
# https://tools.ietf.org/html/rfc7617#section-2
- assert ':' not in username
- user_pass = '{}:{}'.format(username, password)
+ assert ":" not in username
+ user_pass = f"{username}:{password}"
basic_credentials = base64.b64encode(user_pass.encode()).decode()
- return 'Basic ' + basic_credentials
+ return "Basic " + basic_credentials
diff --git a/src/websockets/http.py b/src/websockets/http.py
index e56a4a2c5..9092836c2 100644
--- a/src/websockets/http.py
+++ b/src/websockets/http.py
@@ -1,330 +1,52 @@
-"""
-The :mod:`websockets.http` module provides basic HTTP parsing and
-serialization. It is merely adequate for WebSocket handshake messages.
-
-Its functions cannot be imported from :mod:`websockets`. They must be imported
-from :mod:`websockets.http`.
-
-"""
-
-import asyncio
-import collections.abc
-import re
+import ipaddress
import sys
+from .imports import lazy_import
from .version import version as websockets_version
-__all__ = [
- 'Headers',
- 'MultipleValuesError',
- 'read_request',
- 'read_response',
- 'USER_AGENT',
-]
-
-MAX_HEADERS = 256
-MAX_LINE = 4096
-
-USER_AGENT = 'Python/{} websockets/{}'.format(sys.version[:3], websockets_version)
-
-
-# See https://tools.ietf.org/html/rfc7230#appendix-B.
+# For backwards compatibility:
-# Regex for validating header names.
-_token_re = re.compile(rb'[-!#$%&\'*+.^_`|~0-9a-zA-Z]+')
+lazy_import(
+ globals(),
+ # Headers and MultipleValuesError used to be defined in this module.
+ aliases={
+ "Headers": ".datastructures",
+ "MultipleValuesError": ".datastructures",
+ },
+ deprecated_aliases={
+ "read_request": ".legacy.http",
+ "read_response": ".legacy.http",
+ },
+)
-# Regex for validating header values.
-# We don't attempt to support obsolete line folding.
+__all__ = ["USER_AGENT", "build_host"]
-# Include HTAB (\x09), SP (\x20), VCHAR (\x21-\x7e), obs-text (\x80-\xff).
-# The ABNF is complicated because it attempts to express that optional
-# whitespace is ignored. We strip whitespace and don't revalidate that.
+PYTHON_VERSION = "{}.{}".format(*sys.version_info)
+USER_AGENT = f"Python/{PYTHON_VERSION} websockets/{websockets_version}"
-# See also https://www.rfc-editor.org/errata_search.php?rfc=7230&eid=4189
-_value_re = re.compile(rb'[\x09\x20-\x7e\x80-\xff]*')
-
-
-@asyncio.coroutine
-def read_request(stream):
+def build_host(host: str, port: int, secure: bool) -> str:
"""
- Read an HTTP/1.1 GET request from ``stream``.
-
- ``stream`` is an :class:`~asyncio.StreamReader`.
-
- Return ``(path, headers)`` where ``path`` is a :class:`str` and
- ``headers`` is a :class:`Headers` instance.
-
- ``path`` isn't URL-decoded or validated in any way.
-
- Non-ASCII characters are represented with surrogate escapes.
-
- Raise an exception if the request isn't well formatted.
-
- Don't attempt to read the request body because WebSocket handshake
- requests don't have one. If the request contains a body, it may be
- read from ``stream`` after this coroutine returns.
-
- """
- # https://tools.ietf.org/html/rfc7230#section-3.1.1
-
- # Parsing is simple because fixed values are expected for method and
- # version and because path isn't checked. Since WebSocket software tends
- # to implement HTTP/1.1 strictly, there's little need for lenient parsing.
-
- # Given the implementation of read_line(), request_line ends with CRLF.
- request_line = yield from read_line(stream)
-
- # This may raise "ValueError: not enough values to unpack"
- method, path, version = request_line[:-2].split(b' ', 2)
-
- if method != b'GET':
- raise ValueError("Unsupported HTTP method: %r" % method)
- if version != b'HTTP/1.1':
- raise ValueError("Unsupported HTTP version: %r" % version)
-
- path = path.decode('ascii', 'surrogateescape')
-
- headers = yield from read_headers(stream)
-
- return path, headers
-
+ Build a ``Host`` header.
-@asyncio.coroutine
-def read_response(stream):
"""
- Read an HTTP/1.1 response from ``stream``.
-
- ``stream`` is an :class:`~asyncio.StreamReader`.
-
- Return ``(status_code, headers)`` where ``status_code`` is a :class:`int`
- and ``headers`` is a :class:`Headers` instance.
-
- Non-ASCII characters are represented with surrogate escapes.
-
- Raise an exception if the response isn't well formatted.
-
- Don't attempt to read the response body, because WebSocket handshake
- responses don't have one. If the response contains a body, it may be
- read from ``stream`` after this coroutine returns.
-
- """
- # https://tools.ietf.org/html/rfc7230#section-3.1.2
-
- # As in read_request, parsing is simple because a fixed value is expected
- # for version, status_code is a 3-digit number, and reason can be ignored.
-
- # Given the implementation of read_line(), status_line ends with CRLF.
- status_line = yield from read_line(stream)
-
- # This may raise "ValueError: not enough values to unpack"
- version, status_code, reason = status_line[:-2].split(b' ', 2)
-
- if version != b'HTTP/1.1':
- raise ValueError("Unsupported HTTP version: %r" % version)
- # This may raise "ValueError: invalid literal for int() with base 10"
- status_code = int(status_code)
- if not 100 <= status_code < 1000:
- raise ValueError("Unsupported HTTP status code: %d" % status_code)
- if not _value_re.fullmatch(reason):
- raise ValueError("Invalid HTTP reason phrase: %r" % reason)
-
- headers = yield from read_headers(stream)
-
- return status_code, headers
-
-
-@asyncio.coroutine
-def read_headers(stream):
- """
- Read HTTP headers from ``stream``.
-
- ``stream`` is an :class:`~asyncio.StreamReader`.
-
- Return a :class:`Headers` instance
-
- Non-ASCII characters are represented with surrogate escapes.
-
- """
- # https://tools.ietf.org/html/rfc7230#section-3.2
-
- # We don't attempt to support obsolete line folding.
-
- headers = Headers()
- for _ in range(MAX_HEADERS + 1):
- line = yield from read_line(stream)
- if line == b'\r\n':
- break
-
- # This may raise "ValueError: not enough values to unpack"
- name, value = line[:-2].split(b':', 1)
- if not _token_re.fullmatch(name):
- raise ValueError("Invalid HTTP header name: %r" % name)
- value = value.strip(b' \t')
- if not _value_re.fullmatch(value):
- raise ValueError("Invalid HTTP header value: %r" % value)
-
- name = name.decode('ascii') # guaranteed to be ASCII at this point
- value = value.decode('ascii', 'surrogateescape')
- headers[name] = value
-
+ # https://tools.ietf.org/html/rfc3986#section-3.2.2
+ # IPv6 addresses must be enclosed in brackets.
+ try:
+ address = ipaddress.ip_address(host)
+ except ValueError:
+ # host is a hostname
+ pass
else:
- raise ValueError("Too many HTTP headers")
-
- return headers
-
-
-@asyncio.coroutine
-def read_line(stream):
- """
- Read a single line from ``stream``.
-
- ``stream`` is an :class:`~asyncio.StreamReader`.
-
- """
- # Security: this is bounded by the StreamReader's limit (default = 32kB).
- line = yield from stream.readline()
- # Security: this guarantees header values are small (hard-coded = 4kB)
- if len(line) > MAX_LINE:
- raise ValueError("Line too long")
- # Not mandatory but safe - https://tools.ietf.org/html/rfc7230#section-3.5
- if not line.endswith(b'\r\n'):
- raise ValueError("Line without CRLF")
- return line
-
-
-class MultipleValuesError(LookupError):
- """
- Exception raised when :class:`Headers` has more than one value for a key.
-
- """
-
- def __str__(self):
- # Implement the same logic as KeyError_str in Objects/exceptions.c.
- if len(self.args) == 1:
- return repr(self.args[0])
- return super().__str__()
-
-
-class Headers(collections.abc.MutableMapping):
- """
- Data structure for working with HTTP headers efficiently.
-
- A :class:`list` of ``(name, values)`` is inefficient for lookups.
-
- A :class:`dict` doesn't suffice because header names are case-insensitive
- and multiple occurrences of headers with the same name are possible.
-
- :class:`Headers` stores HTTP headers in a hybrid data structure to provide
- efficient insertions and lookups while preserving the original data.
-
- In order to account for multiple values with minimal hassle,
- :class:`Headers` follows this logic:
-
- - When getting a header with ``headers[name]``:
- - if there's no value, :exc:`KeyError` is raised;
- - if there's exactly one value, it's returned;
- - if there's more than one value, :exc:`MultipleValuesError` is raised.
-
- - When setting a header with ``headers[name] = value``, the value is
- appended to the list of values for that header.
-
- - When deleting a header with ``del headers[name]``, all values for that
- header are removed (this is slow).
-
- Other methods for manipulating headers are consistent with this logic.
-
- As long as no header occurs multiple times, :class:`Headers` behaves like
- :class:`dict`, except keys are lower-cased to provide case-insensitivity.
-
- :meth:`get_all()` returns a list of all values for a header and
- :meth:`raw_items()` returns an iterator of ``(name, values)`` pairs,
- similar to :meth:`http.client.HTTPMessage`.
-
- """
-
- __slots__ = ['_dict', '_list']
-
- def __init__(self, *args, **kwargs):
- self._dict = {}
- self._list = []
- # MutableMapping.update calls __setitem__ for each (name, value) pair.
- self.update(*args, **kwargs)
-
- def __str__(self):
- return (
- ''.join('{}: {}\r\n'.format(key, value) for key, value in self._list)
- + '\r\n'
- )
-
- def __repr__(self):
- return '{}({})'.format(self.__class__.__name__, repr(self._list))
-
- def copy(self):
- copy = self.__class__()
- copy._dict = self._dict.copy()
- copy._list = self._list.copy()
- return copy
-
- # Collection methods
-
- def __contains__(self, key):
- return key.lower() in self._dict
-
- def __iter__(self):
- return iter(self._dict)
-
- def __len__(self):
- return len(self._dict)
-
- # MutableMapping methods
-
- def __getitem__(self, key):
- value = self._dict[key.lower()]
- if len(value) == 1:
- return value[0]
- else:
- raise MultipleValuesError(key)
-
- def __setitem__(self, key, value):
- self._dict.setdefault(key.lower(), []).append(value)
- self._list.append((key, value))
-
- def __delitem__(self, key):
- key_lower = key.lower()
- self._dict.__delitem__(key_lower)
- # This is inefficent. Fortunately deleting HTTP headers is uncommon.
- self._list = [(k, v) for k, v in self._list if k.lower() != key_lower]
-
- def __eq__(self, other):
- if not isinstance(other, Headers):
- return NotImplemented
- return self._list == other._list
-
- def clear(self):
- """
- Remove all headers.
-
- """
- self._dict = {}
- self._list = []
-
- # Methods for handling multiple values
-
- def get_all(self, key):
- """
- Return the (possibly empty) list of all values for a header.
-
- """
- return self._dict.get(key.lower(), [])
+ # host is an IP address
+ if address.version == 6:
+ host = f"[{host}]"
- def raw_items(self):
- """
- Return an iterator of (header name, header value).
+ if port != (443 if secure else 80):
+ host = f"{host}:{port}"
- """
- return iter(self._list)
+ return host
diff --git a/src/websockets/http11.py b/src/websockets/http11.py
new file mode 100644
index 000000000..0754ddabb
--- /dev/null
+++ b/src/websockets/http11.py
@@ -0,0 +1,298 @@
+import re
+from typing import Callable, Generator, NamedTuple, Optional
+
+from .datastructures import Headers
+from .exceptions import SecurityError
+
+
+MAX_HEADERS = 256
+MAX_LINE = 4110
+
+
+def d(value: bytes) -> str:
+ """
+ Decode a bytestring for interpolating into an error message.
+
+ """
+ return value.decode(errors="backslashreplace")
+
+
+# See https://tools.ietf.org/html/rfc7230#appendix-B.
+
+# Regex for validating header names.
+
+_token_re = re.compile(rb"[-!#$%&\'*+.^_`|~0-9a-zA-Z]+")
+
+# Regex for validating header values.
+
+# We don't attempt to support obsolete line folding.
+
+# Include HTAB (\x09), SP (\x20), VCHAR (\x21-\x7e), obs-text (\x80-\xff).
+
+# The ABNF is complicated because it attempts to express that optional
+# whitespace is ignored. We strip whitespace and don't revalidate that.
+
+# See also https://www.rfc-editor.org/errata_search.php?rfc=7230&eid=4189
+
+_value_re = re.compile(rb"[\x09\x20-\x7e\x80-\xff]*")
+
+
+# Consider converting to dataclasses when dropping support for Python < 3.7.
+
+
+class Request(NamedTuple):
+ """
+ WebSocket handshake request.
+
+ :param path: path and optional query
+ :param headers:
+ """
+
+ path: str
+ headers: Headers
+ # body isn't useful is the context of this library
+
+ @classmethod
+ def parse(
+ cls, read_line: Callable[[], Generator[None, None, bytes]]
+ ) -> Generator[None, None, "Request"]:
+ """
+ Parse an HTTP/1.1 GET request and return ``(path, headers)``.
+
+ ``path`` isn't URL-decoded or validated in any way.
+
+ ``path`` and ``headers`` are expected to contain only ASCII characters.
+ Other characters are represented with surrogate escapes.
+
+ :func:`parse_request` doesn't attempt to read the request body because
+ WebSocket handshake requests don't have one. If the request contains a
+ body, it may be read from ``stream`` after this coroutine returns.
+
+ :param read_line: generator-based coroutine that reads a LF-terminated
+ line or raises an exception if there isn't enough data
+ :raises EOFError: if the connection is closed without a full HTTP request
+ :raises SecurityError: if the request exceeds a security limit
+ :raises ValueError: if the request isn't well formatted
+
+ """
+ # https://tools.ietf.org/html/rfc7230#section-3.1.1
+
+ # Parsing is simple because fixed values are expected for method and
+ # version and because path isn't checked. Since WebSocket software tends
+ # to implement HTTP/1.1 strictly, there's little need for lenient parsing.
+
+ try:
+ request_line = yield from parse_line(read_line)
+ except EOFError as exc:
+ raise EOFError("connection closed while reading HTTP request line") from exc
+
+ try:
+ method, raw_path, version = request_line.split(b" ", 2)
+ except ValueError: # not enough values to unpack (expected 3, got 1-2)
+ raise ValueError(f"invalid HTTP request line: {d(request_line)}") from None
+
+ if method != b"GET":
+ raise ValueError(f"unsupported HTTP method: {d(method)}")
+ if version != b"HTTP/1.1":
+ raise ValueError(f"unsupported HTTP version: {d(version)}")
+ path = raw_path.decode("ascii", "surrogateescape")
+
+ headers = yield from parse_headers(read_line)
+
+ return cls(path, headers)
+
+ def serialize(self) -> bytes:
+ """
+ Serialize an HTTP/1.1 GET request.
+
+ """
+ # Since the path and headers only contain ASCII characters,
+ # we can keep this simple.
+ request = f"GET {self.path} HTTP/1.1\r\n".encode()
+ request += self.headers.serialize()
+ return request
+
+
+# Consider converting to dataclasses when dropping support for Python < 3.7.
+
+
+class Response(NamedTuple):
+ """
+ WebSocket handshake response.
+
+ """
+
+ status_code: int
+ reason_phrase: str
+ headers: Headers
+ body: Optional[bytes] = None
+
+ # If processing the response triggers an exception, it's stored here.
+ exception: Optional[Exception] = None
+
+ @classmethod
+ def parse(
+ cls,
+ read_line: Callable[[], Generator[None, None, bytes]],
+ read_exact: Callable[[int], Generator[None, None, bytes]],
+ read_to_eof: Callable[[], Generator[None, None, bytes]],
+ ) -> Generator[None, None, "Response"]:
+ """
+ Parse an HTTP/1.1 response and return ``(status_code, reason, headers)``.
+
+ ``reason`` and ``headers`` are expected to contain only ASCII characters.
+ Other characters are represented with surrogate escapes.
+
+ :func:`parse_request` doesn't attempt to read the response body because
+ WebSocket handshake responses don't have one. If the response contains a
+ body, it may be read from ``stream`` after this coroutine returns.
+
+ :param read_line: generator-based coroutine that reads a LF-terminated
+ line or raises an exception if there isn't enough data
+ :param read_exact: generator-based coroutine that reads the requested
+ number of bytes or raises an exception if there isn't enough data
+ :raises EOFError: if the connection is closed without a full HTTP response
+ :raises SecurityError: if the response exceeds a security limit
+ :raises LookupError: if the response isn't well formatted
+ :raises ValueError: if the response isn't well formatted
+
+ """
+ # https://tools.ietf.org/html/rfc7230#section-3.1.2
+
+ # As in parse_request, parsing is simple because a fixed value is expected
+ # for version, status_code is a 3-digit number, and reason can be ignored.
+
+ try:
+ status_line = yield from parse_line(read_line)
+ except EOFError as exc:
+ raise EOFError("connection closed while reading HTTP status line") from exc
+
+ try:
+ version, raw_status_code, raw_reason = status_line.split(b" ", 2)
+ except ValueError: # not enough values to unpack (expected 3, got 1-2)
+ raise ValueError(f"invalid HTTP status line: {d(status_line)}") from None
+
+ if version != b"HTTP/1.1":
+ raise ValueError(f"unsupported HTTP version: {d(version)}")
+ try:
+ status_code = int(raw_status_code)
+ except ValueError: # invalid literal for int() with base 10
+ raise ValueError(
+ f"invalid HTTP status code: {d(raw_status_code)}"
+ ) from None
+ if not 100 <= status_code < 1000:
+ raise ValueError(f"unsupported HTTP status code: {d(raw_status_code)}")
+ if not _value_re.fullmatch(raw_reason):
+ raise ValueError(f"invalid HTTP reason phrase: {d(raw_reason)}")
+ reason = raw_reason.decode()
+
+ headers = yield from parse_headers(read_line)
+
+ # https://tools.ietf.org/html/rfc7230#section-3.3.3
+
+ if "Transfer-Encoding" in headers:
+ raise NotImplementedError("transfer codings aren't supported")
+
+ # Since websockets only does GET requests (no HEAD, no CONNECT), all
+ # responses except 1xx, 204, and 304 include a message body.
+ if 100 <= status_code < 200 or status_code == 204 or status_code == 304:
+ body = None
+ else:
+ content_length: Optional[int]
+ try:
+ # MultipleValuesError is sufficiently unlikely that we don't
+ # attempt to handle it. Instead we document that its parent
+ # class, LookupError, may be raised.
+ raw_content_length = headers["Content-Length"]
+ except KeyError:
+ content_length = None
+ else:
+ content_length = int(raw_content_length)
+
+ if content_length is None:
+ body = yield from read_to_eof()
+ else:
+ body = yield from read_exact(content_length)
+
+ return cls(status_code, reason, headers, body)
+
+ def serialize(self) -> bytes:
+ """
+ Serialize an HTTP/1.1 GET response.
+
+ """
+ # Since the status line and headers only contain ASCII characters,
+ # we can keep this simple.
+ response = f"HTTP/1.1 {self.status_code} {self.reason_phrase}\r\n".encode()
+ response += self.headers.serialize()
+ if self.body is not None:
+ response += self.body
+ return response
+
+
+def parse_headers(
+ read_line: Callable[[], Generator[None, None, bytes]]
+) -> Generator[None, None, Headers]:
+ """
+ Parse HTTP headers.
+
+ Non-ASCII characters are represented with surrogate escapes.
+
+ :param read_line: generator-based coroutine that reads a LF-terminated
+ line or raises an exception if there isn't enough data
+
+ """
+ # https://tools.ietf.org/html/rfc7230#section-3.2
+
+ # We don't attempt to support obsolete line folding.
+
+ headers = Headers()
+ for _ in range(MAX_HEADERS + 1):
+ try:
+ line = yield from parse_line(read_line)
+ except EOFError as exc:
+ raise EOFError("connection closed while reading HTTP headers") from exc
+ if line == b"":
+ break
+
+ try:
+ raw_name, raw_value = line.split(b":", 1)
+ except ValueError: # not enough values to unpack (expected 2, got 1)
+ raise ValueError(f"invalid HTTP header line: {d(line)}") from None
+ if not _token_re.fullmatch(raw_name):
+ raise ValueError(f"invalid HTTP header name: {d(raw_name)}")
+ raw_value = raw_value.strip(b" \t")
+ if not _value_re.fullmatch(raw_value):
+ raise ValueError(f"invalid HTTP header value: {d(raw_value)}")
+
+ name = raw_name.decode("ascii") # guaranteed to be ASCII at this point
+ value = raw_value.decode("ascii", "surrogateescape")
+ headers[name] = value
+
+ else:
+ raise SecurityError("too many HTTP headers")
+
+ return headers
+
+
+def parse_line(
+ read_line: Callable[[], Generator[None, None, bytes]]
+) -> Generator[None, None, bytes]:
+ """
+ Parse a single line.
+
+ CRLF is stripped from the return value.
+
+ :param read_line: generator-based coroutine that reads a LF-terminated
+ line or raises an exception if there isn't enough data
+
+ """
+ # Security: TODO: add a limit here
+ line = yield from read_line()
+ # Security: this guarantees header values are small (hard-coded = 4 KiB)
+ if len(line) > MAX_LINE:
+ raise SecurityError("line too long")
+ # Not mandatory but safe - https://tools.ietf.org/html/rfc7230#section-3.5
+ if not line.endswith(b"\r\n"):
+ raise EOFError("line without CRLF")
+ return line[:-2]
diff --git a/src/websockets/imports.py b/src/websockets/imports.py
new file mode 100644
index 000000000..efd3eabf3
--- /dev/null
+++ b/src/websockets/imports.py
@@ -0,0 +1,111 @@
+import sys
+import warnings
+from typing import Any, Dict, Iterable, Optional
+
+
+__all__ = ["lazy_import"]
+
+
+def import_name(name: str, source: str, namespace: Dict[str, Any]) -> Any:
+ """
+ Import from in .
+
+ There are two cases:
+
+ - is an object defined in
+ - is a submodule of source
+
+ Neither __import__ nor importlib.import_module does exactly this.
+ __import__ is closer to the intended behavior.
+
+ """
+ level = 0
+ while source[level] == ".":
+ level += 1
+ assert level < len(source), "importing from parent isn't supported"
+ module = __import__(source[level:], namespace, None, [name], level)
+ return getattr(module, name)
+
+
+def lazy_import(
+ namespace: Dict[str, Any],
+ aliases: Optional[Dict[str, str]] = None,
+ deprecated_aliases: Optional[Dict[str, str]] = None,
+) -> None:
+ """
+ Provide lazy, module-level imports.
+
+ Typical use::
+
+ __getattr__, __dir__ = lazy_import(
+ globals(),
+ aliases={
+ "": "",
+ ...
+ },
+ deprecated_aliases={
+ ...,
+ }
+ )
+
+ This function defines __getattr__ and __dir__ per PEP 562.
+
+ On Python 3.6 and earlier, it falls back to non-lazy imports and doesn't
+ raise deprecation warnings.
+
+ """
+ if aliases is None:
+ aliases = {}
+ if deprecated_aliases is None:
+ deprecated_aliases = {}
+
+ namespace_set = set(namespace)
+ aliases_set = set(aliases)
+ deprecated_aliases_set = set(deprecated_aliases)
+
+ assert not namespace_set & aliases_set, "namespace conflict"
+ assert not namespace_set & deprecated_aliases_set, "namespace conflict"
+ assert not aliases_set & deprecated_aliases_set, "namespace conflict"
+
+ package = namespace["__name__"]
+
+ if sys.version_info[:2] >= (3, 7):
+
+ def __getattr__(name: str) -> Any:
+ assert aliases is not None # mypy cannot figure this out
+ try:
+ source = aliases[name]
+ except KeyError:
+ pass
+ else:
+ return import_name(name, source, namespace)
+
+ assert deprecated_aliases is not None # mypy cannot figure this out
+ try:
+ source = deprecated_aliases[name]
+ except KeyError:
+ pass
+ else:
+ warnings.warn(
+ f"{package}.{name} is deprecated",
+ DeprecationWarning,
+ stacklevel=2,
+ )
+ return import_name(name, source, namespace)
+
+ raise AttributeError(f"module {package!r} has no attribute {name!r}")
+
+ namespace["__getattr__"] = __getattr__
+
+ def __dir__() -> Iterable[str]:
+ return sorted(namespace_set | aliases_set | deprecated_aliases_set)
+
+ namespace["__dir__"] = __dir__
+
+ else: # pragma: no cover
+
+ for name, source in aliases.items():
+ namespace[name] = import_name(name, source, namespace)
+
+ for name, source in deprecated_aliases.items():
+ namespace[name] = import_name(name, source, namespace)
diff --git a/tests/py35/__init__.py b/src/websockets/legacy/__init__.py
similarity index 100%
rename from tests/py35/__init__.py
rename to src/websockets/legacy/__init__.py
diff --git a/src/websockets/legacy/auth.py b/src/websockets/legacy/auth.py
new file mode 100644
index 000000000..80ceff28d
--- /dev/null
+++ b/src/websockets/legacy/auth.py
@@ -0,0 +1,164 @@
+"""
+:mod:`websockets.legacy.auth` provides HTTP Basic Authentication according to
+:rfc:`7235` and :rfc:`7617`.
+
+"""
+
+
+import functools
+import hmac
+import http
+from typing import Any, Awaitable, Callable, Iterable, Optional, Tuple, Union, cast
+
+from ..datastructures import Headers
+from ..exceptions import InvalidHeader
+from ..headers import build_www_authenticate_basic, parse_authorization_basic
+from .server import HTTPResponse, WebSocketServerProtocol
+
+
+__all__ = ["BasicAuthWebSocketServerProtocol", "basic_auth_protocol_factory"]
+
+Credentials = Tuple[str, str]
+
+
+def is_credentials(value: Any) -> bool:
+ try:
+ username, password = value
+ except (TypeError, ValueError):
+ return False
+ else:
+ return isinstance(username, str) and isinstance(password, str)
+
+
+class BasicAuthWebSocketServerProtocol(WebSocketServerProtocol):
+ """
+ WebSocket server protocol that enforces HTTP Basic Auth.
+
+ """
+
+ def __init__(
+ self,
+ *args: Any,
+ realm: str,
+ check_credentials: Callable[[str, str], Awaitable[bool]],
+ **kwargs: Any,
+ ) -> None:
+ self.realm = realm
+ self.check_credentials = check_credentials
+ super().__init__(*args, **kwargs)
+
+ async def process_request(
+ self, path: str, request_headers: Headers
+ ) -> Optional[HTTPResponse]:
+ """
+ Check HTTP Basic Auth and return a HTTP 401 or 403 response if needed.
+
+ """
+ try:
+ authorization = request_headers["Authorization"]
+ except KeyError:
+ return (
+ http.HTTPStatus.UNAUTHORIZED,
+ [("WWW-Authenticate", build_www_authenticate_basic(self.realm))],
+ b"Missing credentials\n",
+ )
+
+ try:
+ username, password = parse_authorization_basic(authorization)
+ except InvalidHeader:
+ return (
+ http.HTTPStatus.UNAUTHORIZED,
+ [("WWW-Authenticate", build_www_authenticate_basic(self.realm))],
+ b"Unsupported credentials\n",
+ )
+
+ if not await self.check_credentials(username, password):
+ return (
+ http.HTTPStatus.UNAUTHORIZED,
+ [("WWW-Authenticate", build_www_authenticate_basic(self.realm))],
+ b"Invalid credentials\n",
+ )
+
+ self.username = username
+
+ return await super().process_request(path, request_headers)
+
+
+def basic_auth_protocol_factory(
+ realm: str,
+ credentials: Optional[Union[Credentials, Iterable[Credentials]]] = None,
+ check_credentials: Optional[Callable[[str, str], Awaitable[bool]]] = None,
+ create_protocol: Optional[Callable[[Any], BasicAuthWebSocketServerProtocol]] = None,
+) -> Callable[[Any], BasicAuthWebSocketServerProtocol]:
+ """
+ Protocol factory that enforces HTTP Basic Auth.
+
+ ``basic_auth_protocol_factory`` is designed to integrate with
+ :func:`~websockets.legacy.server.serve` like this::
+
+ websockets.serve(
+ ...,
+ create_protocol=websockets.basic_auth_protocol_factory(
+ realm="my dev server",
+ credentials=("hello", "iloveyou"),
+ )
+ )
+
+ ``realm`` indicates the scope of protection. It should contain only ASCII
+ characters because the encoding of non-ASCII characters is undefined.
+ Refer to section 2.2 of :rfc:`7235` for details.
+
+ ``credentials`` defines hard coded authorized credentials. It can be a
+ ``(username, password)`` pair or a list of such pairs.
+
+ ``check_credentials`` defines a coroutine that checks whether credentials
+ are authorized. This coroutine receives ``username`` and ``password``
+ arguments and returns a :class:`bool`.
+
+ One of ``credentials`` or ``check_credentials`` must be provided but not
+ both.
+
+ By default, ``basic_auth_protocol_factory`` creates a factory for building
+ :class:`BasicAuthWebSocketServerProtocol` instances. You can override this
+ with the ``create_protocol`` parameter.
+
+ :param realm: scope of protection
+ :param credentials: hard coded credentials
+ :param check_credentials: coroutine that verifies credentials
+ :raises TypeError: if the credentials argument has the wrong type
+
+ """
+ if (credentials is None) == (check_credentials is None):
+ raise TypeError("provide either credentials or check_credentials")
+
+ if credentials is not None:
+ if is_credentials(credentials):
+ credentials_list = [cast(Credentials, credentials)]
+ elif isinstance(credentials, Iterable):
+ credentials_list = list(credentials)
+ if not all(is_credentials(item) for item in credentials_list):
+ raise TypeError(f"invalid credentials argument: {credentials}")
+ else:
+ raise TypeError(f"invalid credentials argument: {credentials}")
+
+ credentials_dict = dict(credentials_list)
+
+ async def check_credentials(username: str, password: str) -> bool:
+ try:
+ expected_password = credentials_dict[username]
+ except KeyError:
+ return False
+ return hmac.compare_digest(expected_password, password)
+
+ if create_protocol is None:
+ # Not sure why mypy cannot figure this out.
+ create_protocol = cast(
+ Callable[[Any], BasicAuthWebSocketServerProtocol],
+ BasicAuthWebSocketServerProtocol,
+ )
+
+ return functools.partial(
+ create_protocol,
+ realm=realm,
+ check_credentials=check_credentials,
+ )
diff --git a/src/websockets/legacy/client.py b/src/websockets/legacy/client.py
new file mode 100644
index 000000000..1b5bd303f
--- /dev/null
+++ b/src/websockets/legacy/client.py
@@ -0,0 +1,673 @@
+"""
+:mod:`websockets.legacy.client` defines the WebSocket client APIs.
+
+"""
+
+import asyncio
+import collections.abc
+import functools
+import logging
+import warnings
+from types import TracebackType
+from typing import Any, Callable, Generator, List, Optional, Sequence, Tuple, Type, cast
+
+from ..datastructures import Headers, HeadersLike
+from ..exceptions import (
+ InvalidHandshake,
+ InvalidHeader,
+ InvalidMessage,
+ InvalidStatusCode,
+ NegotiationError,
+ RedirectHandshake,
+ SecurityError,
+)
+from ..extensions.base import ClientExtensionFactory, Extension
+from ..extensions.permessage_deflate import enable_client_permessage_deflate
+from ..headers import (
+ build_authorization_basic,
+ build_extension,
+ build_subprotocol,
+ parse_extension,
+ parse_subprotocol,
+)
+from ..http import USER_AGENT, build_host
+from ..typing import ExtensionHeader, Origin, Subprotocol
+from ..uri import WebSocketURI, parse_uri
+from .handshake import build_request, check_response
+from .http import read_response
+from .protocol import WebSocketCommonProtocol
+
+
+__all__ = ["connect", "unix_connect", "WebSocketClientProtocol"]
+
+logger = logging.getLogger("websockets.server")
+
+
+class WebSocketClientProtocol(WebSocketCommonProtocol):
+ """
+ :class:`~asyncio.Protocol` subclass implementing a WebSocket client.
+
+ :class:`WebSocketClientProtocol`:
+
+ * performs the opening handshake to establish the connection;
+ * provides :meth:`recv` and :meth:`send` coroutines for receiving and
+ sending messages;
+ * deals with control frames automatically;
+ * performs the closing handshake to terminate the connection.
+
+ :class:`WebSocketClientProtocol` supports asynchronous iteration::
+
+ async for message in websocket:
+ await process(message)
+
+ The iterator yields incoming messages. It exits normally when the
+ connection is closed with the close code 1000 (OK) or 1001 (going away).
+ It raises a :exc:`~websockets.exceptions.ConnectionClosedError` exception
+ when the connection is closed with any other code.
+
+ Once the connection is open, a `Ping frame`_ is sent every
+ ``ping_interval`` seconds. This serves as a keepalive. It helps keeping
+ the connection open, especially in the presence of proxies with short
+ timeouts on inactive connections. Set ``ping_interval`` to ``None`` to
+ disable this behavior.
+
+ .. _Ping frame: https://tools.ietf.org/html/rfc6455#section-5.5.2
+
+ If the corresponding `Pong frame`_ isn't received within ``ping_timeout``
+ seconds, the connection is considered unusable and is closed with
+ code 1011. This ensures that the remote endpoint remains responsive. Set
+ ``ping_timeout`` to ``None`` to disable this behavior.
+
+ .. _Pong frame: https://tools.ietf.org/html/rfc6455#section-5.5.3
+
+ The ``close_timeout`` parameter defines a maximum wait time for completing
+ the closing handshake and terminating the TCP connection. For legacy
+ reasons, :meth:`close` completes in at most ``5 * close_timeout`` seconds.
+
+ ``close_timeout`` needs to be a parameter of the protocol because
+ websockets usually calls :meth:`close` implicitly upon exit when
+ :func:`connect` is used as a context manager.
+
+ To apply a timeout to any other API, wrap it in :func:`~asyncio.wait_for`.
+
+ The ``max_size`` parameter enforces the maximum size for incoming messages
+ in bytes. The default value is 1 MiB. ``None`` disables the limit. If a
+ message larger than the maximum size is received, :meth:`recv` will
+ raise :exc:`~websockets.exceptions.ConnectionClosedError` and the
+ connection will be closed with code 1009.
+
+ The ``max_queue`` parameter sets the maximum length of the queue that
+ holds incoming messages. The default value is ``32``. ``None`` disables
+ the limit. Messages are added to an in-memory queue when they're received;
+ then :meth:`recv` pops from that queue. In order to prevent excessive
+ memory consumption when messages are received faster than they can be
+ processed, the queue must be bounded. If the queue fills up, the protocol
+ stops processing incoming data until :meth:`recv` is called. In this
+ situation, various receive buffers (at least in :mod:`asyncio` and in the
+ OS) will fill up, then the TCP receive window will shrink, slowing down
+ transmission to avoid packet loss.
+
+ Since Python can use up to 4 bytes of memory to represent a single
+ character, each connection may use up to ``4 * max_size * max_queue``
+ bytes of memory to store incoming messages. By default, this is 128 MiB.
+ You may want to lower the limits, depending on your application's
+ requirements.
+
+ The ``read_limit`` argument sets the high-water limit of the buffer for
+ incoming bytes. The low-water limit is half the high-water limit. The
+ default value is 64 KiB, half of asyncio's default (based on the current
+ implementation of :class:`~asyncio.StreamReader`).
+
+ The ``write_limit`` argument sets the high-water limit of the buffer for
+ outgoing bytes. The low-water limit is a quarter of the high-water limit.
+ The default value is 64 KiB, equal to asyncio's default (based on the
+ current implementation of ``FlowControlMixin``).
+
+ As soon as the HTTP request and response in the opening handshake are
+ processed:
+
+ * the request path is available in the :attr:`path` attribute;
+ * the request and response HTTP headers are available in the
+ :attr:`request_headers` and :attr:`response_headers` attributes,
+ which are :class:`~websockets.http.Headers` instances.
+
+ If a subprotocol was negotiated, it's available in the :attr:`subprotocol`
+ attribute.
+
+ Once the connection is closed, the code is available in the
+ :attr:`close_code` attribute and the reason in :attr:`close_reason`.
+
+ All attributes must be treated as read-only.
+
+ """
+
+ is_client = True
+ side = "client"
+
+ def __init__(
+ self,
+ *,
+ origin: Optional[Origin] = None,
+ extensions: Optional[Sequence[ClientExtensionFactory]] = None,
+ subprotocols: Optional[Sequence[Subprotocol]] = None,
+ extra_headers: Optional[HeadersLike] = None,
+ **kwargs: Any,
+ ) -> None:
+ self.origin = origin
+ self.available_extensions = extensions
+ self.available_subprotocols = subprotocols
+ self.extra_headers = extra_headers
+ super().__init__(**kwargs)
+
+ def write_http_request(self, path: str, headers: Headers) -> None:
+ """
+ Write request line and headers to the HTTP request.
+
+ """
+ self.path = path
+ self.request_headers = headers
+
+ logger.debug("%s > GET %s HTTP/1.1", self.side, path)
+ logger.debug("%s > %r", self.side, headers)
+
+ # Since the path and headers only contain ASCII characters,
+ # we can keep this simple.
+ request = f"GET {path} HTTP/1.1\r\n"
+ request += str(headers)
+
+ self.transport.write(request.encode())
+
+ async def read_http_response(self) -> Tuple[int, Headers]:
+ """
+ Read status line and headers from the HTTP response.
+
+ If the response contains a body, it may be read from ``self.reader``
+ after this coroutine returns.
+
+ :raises ~websockets.exceptions.InvalidMessage: if the HTTP message is
+ malformed or isn't an HTTP/1.1 GET response
+
+ """
+ try:
+ status_code, reason, headers = await read_response(self.reader)
+ # Remove this branch when dropping support for Python < 3.8
+ # because CancelledError no longer inherits Exception.
+ except asyncio.CancelledError: # pragma: no cover
+ raise
+ except Exception as exc:
+ raise InvalidMessage("did not receive a valid HTTP response") from exc
+
+ logger.debug("%s < HTTP/1.1 %d %s", self.side, status_code, reason)
+ logger.debug("%s < %r", self.side, headers)
+
+ self.response_headers = headers
+
+ return status_code, self.response_headers
+
+ @staticmethod
+ def process_extensions(
+ headers: Headers,
+ available_extensions: Optional[Sequence[ClientExtensionFactory]],
+ ) -> List[Extension]:
+ """
+ Handle the Sec-WebSocket-Extensions HTTP response header.
+
+ Check that each extension is supported, as well as its parameters.
+
+ Return the list of accepted extensions.
+
+ Raise :exc:`~websockets.exceptions.InvalidHandshake` to abort the
+ connection.
+
+ :rfc:`6455` leaves the rules up to the specification of each
+ :extension.
+
+ To provide this level of flexibility, for each extension accepted by
+ the server, we check for a match with each extension available in the
+ client configuration. If no match is found, an exception is raised.
+
+ If several variants of the same extension are accepted by the server,
+ it may be configured several times, which won't make sense in general.
+ Extensions must implement their own requirements. For this purpose,
+ the list of previously accepted extensions is provided.
+
+ Other requirements, for example related to mandatory extensions or the
+ order of extensions, may be implemented by overriding this method.
+
+ """
+ accepted_extensions: List[Extension] = []
+
+ header_values = headers.get_all("Sec-WebSocket-Extensions")
+
+ if header_values:
+
+ if available_extensions is None:
+ raise InvalidHandshake("no extensions supported")
+
+ parsed_header_values: List[ExtensionHeader] = sum(
+ [parse_extension(header_value) for header_value in header_values], []
+ )
+
+ for name, response_params in parsed_header_values:
+
+ for extension_factory in available_extensions:
+
+ # Skip non-matching extensions based on their name.
+ if extension_factory.name != name:
+ continue
+
+ # Skip non-matching extensions based on their params.
+ try:
+ extension = extension_factory.process_response_params(
+ response_params, accepted_extensions
+ )
+ except NegotiationError:
+ continue
+
+ # Add matching extension to the final list.
+ accepted_extensions.append(extension)
+
+ # Break out of the loop once we have a match.
+ break
+
+ # If we didn't break from the loop, no extension in our list
+ # matched what the server sent. Fail the connection.
+ else:
+ raise NegotiationError(
+ f"Unsupported extension: "
+ f"name = {name}, params = {response_params}"
+ )
+
+ return accepted_extensions
+
+ @staticmethod
+ def process_subprotocol(
+ headers: Headers, available_subprotocols: Optional[Sequence[Subprotocol]]
+ ) -> Optional[Subprotocol]:
+ """
+ Handle the Sec-WebSocket-Protocol HTTP response header.
+
+ Check that it contains exactly one supported subprotocol.
+
+ Return the selected subprotocol.
+
+ """
+ subprotocol: Optional[Subprotocol] = None
+
+ header_values = headers.get_all("Sec-WebSocket-Protocol")
+
+ if header_values:
+
+ if available_subprotocols is None:
+ raise InvalidHandshake("no subprotocols supported")
+
+ parsed_header_values: Sequence[Subprotocol] = sum(
+ [parse_subprotocol(header_value) for header_value in header_values], []
+ )
+
+ if len(parsed_header_values) > 1:
+ subprotocols = ", ".join(parsed_header_values)
+ raise InvalidHandshake(f"multiple subprotocols: {subprotocols}")
+
+ subprotocol = parsed_header_values[0]
+
+ if subprotocol not in available_subprotocols:
+ raise NegotiationError(f"unsupported subprotocol: {subprotocol}")
+
+ return subprotocol
+
+ async def handshake(
+ self,
+ wsuri: WebSocketURI,
+ origin: Optional[Origin] = None,
+ available_extensions: Optional[Sequence[ClientExtensionFactory]] = None,
+ available_subprotocols: Optional[Sequence[Subprotocol]] = None,
+ extra_headers: Optional[HeadersLike] = None,
+ ) -> None:
+ """
+ Perform the client side of the opening handshake.
+
+ :param origin: sets the Origin HTTP header
+ :param available_extensions: list of supported extensions in the order
+ in which they should be used
+ :param available_subprotocols: list of supported subprotocols in order
+ of decreasing preference
+ :param extra_headers: sets additional HTTP request headers; it must be
+ a :class:`~websockets.http.Headers` instance, a
+ :class:`~collections.abc.Mapping`, or an iterable of ``(name,
+ value)`` pairs
+ :raises ~websockets.exceptions.InvalidHandshake: if the handshake
+ fails
+
+ """
+ request_headers = Headers()
+
+ request_headers["Host"] = build_host(wsuri.host, wsuri.port, wsuri.secure)
+
+ if wsuri.user_info:
+ request_headers["Authorization"] = build_authorization_basic(
+ *wsuri.user_info
+ )
+
+ if origin is not None:
+ request_headers["Origin"] = origin
+
+ key = build_request(request_headers)
+
+ if available_extensions is not None:
+ extensions_header = build_extension(
+ [
+ (extension_factory.name, extension_factory.get_request_params())
+ for extension_factory in available_extensions
+ ]
+ )
+ request_headers["Sec-WebSocket-Extensions"] = extensions_header
+
+ if available_subprotocols is not None:
+ protocol_header = build_subprotocol(available_subprotocols)
+ request_headers["Sec-WebSocket-Protocol"] = protocol_header
+
+ if extra_headers is not None:
+ if isinstance(extra_headers, Headers):
+ extra_headers = extra_headers.raw_items()
+ elif isinstance(extra_headers, collections.abc.Mapping):
+ extra_headers = extra_headers.items()
+ for name, value in extra_headers:
+ request_headers[name] = value
+
+ request_headers.setdefault("User-Agent", USER_AGENT)
+
+ self.write_http_request(wsuri.resource_name, request_headers)
+
+ status_code, response_headers = await self.read_http_response()
+ if status_code in (301, 302, 303, 307, 308):
+ if "Location" not in response_headers:
+ raise InvalidHeader("Location")
+ raise RedirectHandshake(response_headers["Location"])
+ elif status_code != 101:
+ raise InvalidStatusCode(status_code)
+
+ check_response(response_headers, key)
+
+ self.extensions = self.process_extensions(
+ response_headers, available_extensions
+ )
+
+ self.subprotocol = self.process_subprotocol(
+ response_headers, available_subprotocols
+ )
+
+ self.connection_open()
+
+
+class Connect:
+ """
+ Connect to the WebSocket server at the given ``uri``.
+
+ Awaiting :func:`connect` yields a :class:`WebSocketClientProtocol` which
+ can then be used to send and receive messages.
+
+ :func:`connect` can also be used as a asynchronous context manager::
+
+ async with connect(...) as websocket:
+ ...
+
+ In that case, the connection is closed when exiting the context.
+
+ :func:`connect` is a wrapper around the event loop's
+ :meth:`~asyncio.loop.create_connection` method. Unknown keyword arguments
+ are passed to :meth:`~asyncio.loop.create_connection`.
+
+ For example, you can set the ``ssl`` keyword argument to a
+ :class:`~ssl.SSLContext` to enforce some TLS settings. When connecting to
+ a ``wss://`` URI, if this argument isn't provided explicitly,
+ :func:`ssl.create_default_context` is called to create a context.
+
+ You can connect to a different host and port from those found in ``uri``
+ by setting ``host`` and ``port`` keyword arguments. This only changes the
+ destination of the TCP connection. The host name from ``uri`` is still
+ used in the TLS handshake for secure connections and in the ``Host`` HTTP
+ header.
+
+ ``create_protocol`` defaults to :class:`WebSocketClientProtocol`. It may
+ be replaced by a wrapper or a subclass to customize the protocol that
+ manages the connection.
+
+ The behavior of ``ping_interval``, ``ping_timeout``, ``close_timeout``,
+ ``max_size``, ``max_queue``, ``read_limit``, and ``write_limit`` is
+ described in :class:`WebSocketClientProtocol`.
+
+ :func:`connect` also accepts the following optional arguments:
+
+ * ``compression`` is a shortcut to configure compression extensions;
+ by default it enables the "permessage-deflate" extension; set it to
+ ``None`` to disable compression.
+ * ``origin`` sets the Origin HTTP header.
+ * ``extensions`` is a list of supported extensions in order of
+ decreasing preference.
+ * ``subprotocols`` is a list of supported subprotocols in order of
+ decreasing preference.
+ * ``extra_headers`` sets additional HTTP request headers; it can be a
+ :class:`~websockets.http.Headers` instance, a
+ :class:`~collections.abc.Mapping`, or an iterable of ``(name, value)``
+ pairs.
+
+ :raises ~websockets.uri.InvalidURI: if ``uri`` is invalid
+ :raises ~websockets.handshake.InvalidHandshake: if the opening handshake
+ fails
+
+ """
+
+ MAX_REDIRECTS_ALLOWED = 10
+
+ def __init__(
+ self,
+ uri: str,
+ *,
+ create_protocol: Optional[Callable[[Any], WebSocketClientProtocol]] = None,
+ ping_interval: Optional[float] = 20,
+ ping_timeout: Optional[float] = 20,
+ close_timeout: Optional[float] = None,
+ max_size: Optional[int] = 2 ** 20,
+ max_queue: Optional[int] = 2 ** 5,
+ read_limit: int = 2 ** 16,
+ write_limit: int = 2 ** 16,
+ loop: Optional[asyncio.AbstractEventLoop] = None,
+ compression: Optional[str] = "deflate",
+ origin: Optional[Origin] = None,
+ extensions: Optional[Sequence[ClientExtensionFactory]] = None,
+ subprotocols: Optional[Sequence[Subprotocol]] = None,
+ extra_headers: Optional[HeadersLike] = None,
+ **kwargs: Any,
+ ) -> None:
+ # Backwards compatibility: close_timeout used to be called timeout.
+ timeout: Optional[float] = kwargs.pop("timeout", None)
+ if timeout is None:
+ timeout = 10
+ else:
+ warnings.warn("rename timeout to close_timeout", DeprecationWarning)
+ # If both are specified, timeout is ignored.
+ if close_timeout is None:
+ close_timeout = timeout
+
+ # Backwards compatibility: create_protocol used to be called klass.
+ klass: Optional[Type[WebSocketClientProtocol]] = kwargs.pop("klass", None)
+ if klass is None:
+ klass = WebSocketClientProtocol
+ else:
+ warnings.warn("rename klass to create_protocol", DeprecationWarning)
+ # If both are specified, klass is ignored.
+ if create_protocol is None:
+ create_protocol = klass
+
+ # Backwards compatibility: recv() used to return None on closed connections
+ legacy_recv: bool = kwargs.pop("legacy_recv", False)
+
+ if loop is None:
+ loop = asyncio.get_event_loop()
+
+ wsuri = parse_uri(uri)
+ if wsuri.secure:
+ kwargs.setdefault("ssl", True)
+ elif kwargs.get("ssl") is not None:
+ raise ValueError(
+ "connect() received a ssl argument for a ws:// URI, "
+ "use a wss:// URI to enable TLS"
+ )
+
+ if compression == "deflate":
+ extensions = enable_client_permessage_deflate(extensions)
+ elif compression is not None:
+ raise ValueError(f"unsupported compression: {compression}")
+
+ factory = functools.partial(
+ create_protocol,
+ ping_interval=ping_interval,
+ ping_timeout=ping_timeout,
+ close_timeout=close_timeout,
+ max_size=max_size,
+ max_queue=max_queue,
+ read_limit=read_limit,
+ write_limit=write_limit,
+ loop=loop,
+ host=wsuri.host,
+ port=wsuri.port,
+ secure=wsuri.secure,
+ legacy_recv=legacy_recv,
+ origin=origin,
+ extensions=extensions,
+ subprotocols=subprotocols,
+ extra_headers=extra_headers,
+ )
+
+ if kwargs.pop("unix", False):
+ path: Optional[str] = kwargs.pop("path", None)
+ create_connection = functools.partial(
+ loop.create_unix_connection, factory, path, **kwargs
+ )
+ else:
+ host: Optional[str]
+ port: Optional[int]
+ if kwargs.get("sock") is None:
+ host, port = wsuri.host, wsuri.port
+ else:
+ # If sock is given, host and port shouldn't be specified.
+ host, port = None, None
+ # If host and port are given, override values from the URI.
+ host = kwargs.pop("host", host)
+ port = kwargs.pop("port", port)
+ create_connection = functools.partial(
+ loop.create_connection, factory, host, port, **kwargs
+ )
+
+ # This is a coroutine function.
+ self._create_connection = create_connection
+ self._wsuri = wsuri
+
+ def handle_redirect(self, uri: str) -> None:
+ # Update the state of this instance to connect to a new URI.
+ old_wsuri = self._wsuri
+ new_wsuri = parse_uri(uri)
+
+ # Forbid TLS downgrade.
+ if old_wsuri.secure and not new_wsuri.secure:
+ raise SecurityError("redirect from WSS to WS")
+
+ same_origin = (
+ old_wsuri.host == new_wsuri.host and old_wsuri.port == new_wsuri.port
+ )
+
+ # Rewrite the host and port arguments for cross-origin redirects.
+ # This preserves connection overrides with the host and port
+ # arguments if the redirect points to the same host and port.
+ if not same_origin:
+ # Replace the host and port argument passed to the protocol factory.
+ factory = self._create_connection.args[0]
+ factory = functools.partial(
+ factory.func,
+ *factory.args,
+ **dict(factory.keywords, host=new_wsuri.host, port=new_wsuri.port),
+ )
+ # Replace the host and port argument passed to create_connection.
+ self._create_connection = functools.partial(
+ self._create_connection.func,
+ *(factory, new_wsuri.host, new_wsuri.port),
+ **self._create_connection.keywords,
+ )
+
+ # Set the new WebSocket URI. This suffices for same-origin redirects.
+ self._wsuri = new_wsuri
+
+ # async with connect(...)
+
+ async def __aenter__(self) -> WebSocketClientProtocol:
+ return await self
+
+ async def __aexit__(
+ self,
+ exc_type: Optional[Type[BaseException]],
+ exc_value: Optional[BaseException],
+ traceback: Optional[TracebackType],
+ ) -> None:
+ await self.protocol.close()
+
+ # await connect(...)
+
+ def __await__(self) -> Generator[Any, None, WebSocketClientProtocol]:
+ # Create a suitable iterator by calling __await__ on a coroutine.
+ return self.__await_impl__().__await__()
+
+ async def __await_impl__(self) -> WebSocketClientProtocol:
+ for redirects in range(self.MAX_REDIRECTS_ALLOWED):
+ transport, protocol = await self._create_connection()
+ # https://github.com/python/typeshed/pull/2756
+ transport = cast(asyncio.Transport, transport)
+ protocol = cast(WebSocketClientProtocol, protocol)
+
+ try:
+ try:
+ await protocol.handshake(
+ self._wsuri,
+ origin=protocol.origin,
+ available_extensions=protocol.available_extensions,
+ available_subprotocols=protocol.available_subprotocols,
+ extra_headers=protocol.extra_headers,
+ )
+ except Exception:
+ protocol.fail_connection()
+ await protocol.wait_closed()
+ raise
+ else:
+ self.protocol = protocol
+ return protocol
+ except RedirectHandshake as exc:
+ self.handle_redirect(exc.uri)
+ else:
+ raise SecurityError("too many redirects")
+
+ # yield from connect(...)
+
+ __iter__ = __await__
+
+
+connect = Connect
+
+
+def unix_connect(
+ path: Optional[str], uri: str = "ws://localhost/", **kwargs: Any
+) -> Connect:
+ """
+ Similar to :func:`connect`, but for connecting to a Unix socket.
+
+ This function calls the event loop's
+ :meth:`~asyncio.loop.create_unix_connection` method.
+
+ It is only available on Unix.
+
+ It's mainly useful for debugging servers listening on Unix sockets.
+
+ :param path: file system path to the Unix socket
+ :param uri: WebSocket URI
+
+ """
+ return connect(uri=uri, path=path, unix=True, **kwargs)
diff --git a/src/websockets/legacy/framing.py b/src/websockets/legacy/framing.py
new file mode 100644
index 000000000..627e6922c
--- /dev/null
+++ b/src/websockets/legacy/framing.py
@@ -0,0 +1,135 @@
+"""
+:mod:`websockets.legacy.framing` reads and writes WebSocket frames.
+
+It deals with a single frame at a time. Anything that depends on the sequence
+of frames is implemented in :mod:`websockets.legacy.protocol`.
+
+See `section 5 of RFC 6455`_.
+
+.. _section 5 of RFC 6455: http://tools.ietf.org/html/rfc6455#section-5
+
+"""
+
+import struct
+from typing import Any, Awaitable, Callable, Optional, Sequence
+
+from ..exceptions import PayloadTooBig, ProtocolError
+from ..frames import Frame as NewFrame, Opcode
+
+
+try:
+ from ..speedups import apply_mask
+except ImportError: # pragma: no cover
+ from ..utils import apply_mask
+
+
+class Frame(NewFrame):
+ @classmethod
+ async def read(
+ cls,
+ reader: Callable[[int], Awaitable[bytes]],
+ *,
+ mask: bool,
+ max_size: Optional[int] = None,
+ extensions: Optional[Sequence["extensions.Extension"]] = None,
+ ) -> "Frame":
+ """
+ Read a WebSocket frame.
+
+ :param reader: coroutine that reads exactly the requested number of
+ bytes, unless the end of file is reached
+ :param mask: whether the frame should be masked i.e. whether the read
+ happens on the server side
+ :param max_size: maximum payload size in bytes
+ :param extensions: list of classes with a ``decode()`` method that
+ transforms the frame and return a new frame; extensions are applied
+ in reverse order
+ :raises ~websockets.exceptions.PayloadTooBig: if the frame exceeds
+ ``max_size``
+ :raises ~websockets.exceptions.ProtocolError: if the frame
+ contains incorrect values
+
+ """
+
+ # Read the header.
+ data = await reader(2)
+ head1, head2 = struct.unpack("!BB", data)
+
+ # While not Pythonic, this is marginally faster than calling bool().
+ fin = True if head1 & 0b10000000 else False
+ rsv1 = True if head1 & 0b01000000 else False
+ rsv2 = True if head1 & 0b00100000 else False
+ rsv3 = True if head1 & 0b00010000 else False
+
+ try:
+ opcode = Opcode(head1 & 0b00001111)
+ except ValueError as exc:
+ raise ProtocolError("invalid opcode") from exc
+
+ if (True if head2 & 0b10000000 else False) != mask:
+ raise ProtocolError("incorrect masking")
+
+ length = head2 & 0b01111111
+ if length == 126:
+ data = await reader(2)
+ (length,) = struct.unpack("!H", data)
+ elif length == 127:
+ data = await reader(8)
+ (length,) = struct.unpack("!Q", data)
+ if max_size is not None and length > max_size:
+ raise PayloadTooBig(f"over size limit ({length} > {max_size} bytes)")
+ if mask:
+ mask_bits = await reader(4)
+
+ # Read the data.
+ data = await reader(length)
+ if mask:
+ data = apply_mask(data, mask_bits)
+
+ frame = cls(fin, opcode, data, rsv1, rsv2, rsv3)
+
+ if extensions is None:
+ extensions = []
+ for extension in reversed(extensions):
+ frame = cls(*extension.decode(frame, max_size=max_size))
+
+ frame.check()
+
+ return frame
+
+ def write(
+ self,
+ write: Callable[[bytes], Any],
+ *,
+ mask: bool,
+ extensions: Optional[Sequence["extensions.Extension"]] = None,
+ ) -> None:
+ """
+ Write a WebSocket frame.
+
+ :param frame: frame to write
+ :param write: function that writes bytes
+ :param mask: whether the frame should be masked i.e. whether the write
+ happens on the client side
+ :param extensions: list of classes with an ``encode()`` method that
+ transform the frame and return a new frame; extensions are applied
+ in order
+ :raises ~websockets.exceptions.ProtocolError: if the frame
+ contains incorrect values
+
+ """
+ # The frame is written in a single call to write in order to prevent
+ # TCP fragmentation. See #68 for details. This also makes it safe to
+ # send frames concurrently from multiple coroutines.
+ write(self.serialize(mask=mask, extensions=extensions))
+
+
+# Backwards compatibility with previously documented public APIs
+from ..frames import parse_close # isort:skip # noqa
+from ..frames import prepare_ctrl as encode_data # isort:skip # noqa
+from ..frames import prepare_data # isort:skip # noqa
+from ..frames import serialize_close # isort:skip # noqa
+
+
+# at the bottom to allow circular import, because Extension depends on Frame
+from .. import extensions # isort:skip # noqa
diff --git a/src/websockets/legacy/handshake.py b/src/websockets/legacy/handshake.py
new file mode 100644
index 000000000..44da72d21
--- /dev/null
+++ b/src/websockets/legacy/handshake.py
@@ -0,0 +1,179 @@
+"""
+:mod:`websockets.legacy.handshake` provides helpers for the WebSocket handshake.
+
+See `section 4 of RFC 6455`_.
+
+.. _section 4 of RFC 6455: http://tools.ietf.org/html/rfc6455#section-4
+
+Some checks cannot be performed because they depend too much on the
+context; instead, they're documented below.
+
+To accept a connection, a server must:
+
+- Read the request, check that the method is GET, and check the headers with
+ :func:`check_request`,
+- Send a 101 response to the client with the headers created by
+ :func:`build_response` if the request is valid; otherwise, send an
+ appropriate HTTP error code.
+
+To open a connection, a client must:
+
+- Send a GET request to the server with the headers created by
+ :func:`build_request`,
+- Read the response, check that the status code is 101, and check the headers
+ with :func:`check_response`.
+
+"""
+
+import base64
+import binascii
+from typing import List
+
+from ..datastructures import Headers, MultipleValuesError
+from ..exceptions import InvalidHeader, InvalidHeaderValue, InvalidUpgrade
+from ..headers import parse_connection, parse_upgrade
+from ..typing import ConnectionOption, UpgradeProtocol
+from ..utils import accept_key as accept, generate_key
+
+
+__all__ = ["build_request", "check_request", "build_response", "check_response"]
+
+
+def build_request(headers: Headers) -> str:
+ """
+ Build a handshake request to send to the server.
+
+ Update request headers passed in argument.
+
+ :param headers: request headers
+ :returns: ``key`` which must be passed to :func:`check_response`
+
+ """
+ key = generate_key()
+ headers["Upgrade"] = "websocket"
+ headers["Connection"] = "Upgrade"
+ headers["Sec-WebSocket-Key"] = key
+ headers["Sec-WebSocket-Version"] = "13"
+ return key
+
+
+def check_request(headers: Headers) -> str:
+ """
+ Check a handshake request received from the client.
+
+ This function doesn't verify that the request is an HTTP/1.1 or higher GET
+ request and doesn't perform ``Host`` and ``Origin`` checks. These controls
+ are usually performed earlier in the HTTP request handling code. They're
+ the responsibility of the caller.
+
+ :param headers: request headers
+ :returns: ``key`` which must be passed to :func:`build_response`
+ :raises ~websockets.exceptions.InvalidHandshake: if the handshake request
+ is invalid; then the server must return 400 Bad Request error
+
+ """
+ connection: List[ConnectionOption] = sum(
+ [parse_connection(value) for value in headers.get_all("Connection")], []
+ )
+
+ if not any(value.lower() == "upgrade" for value in connection):
+ raise InvalidUpgrade("Connection", ", ".join(connection))
+
+ upgrade: List[UpgradeProtocol] = sum(
+ [parse_upgrade(value) for value in headers.get_all("Upgrade")], []
+ )
+
+ # For compatibility with non-strict implementations, ignore case when
+ # checking the Upgrade header. The RFC always uses "websocket", except
+ # in section 11.2. (IANA registration) where it uses "WebSocket".
+ if not (len(upgrade) == 1 and upgrade[0].lower() == "websocket"):
+ raise InvalidUpgrade("Upgrade", ", ".join(upgrade))
+
+ try:
+ s_w_key = headers["Sec-WebSocket-Key"]
+ except KeyError as exc:
+ raise InvalidHeader("Sec-WebSocket-Key") from exc
+ except MultipleValuesError as exc:
+ raise InvalidHeader(
+ "Sec-WebSocket-Key", "more than one Sec-WebSocket-Key header found"
+ ) from exc
+
+ try:
+ raw_key = base64.b64decode(s_w_key.encode(), validate=True)
+ except binascii.Error as exc:
+ raise InvalidHeaderValue("Sec-WebSocket-Key", s_w_key) from exc
+ if len(raw_key) != 16:
+ raise InvalidHeaderValue("Sec-WebSocket-Key", s_w_key)
+
+ try:
+ s_w_version = headers["Sec-WebSocket-Version"]
+ except KeyError as exc:
+ raise InvalidHeader("Sec-WebSocket-Version") from exc
+ except MultipleValuesError as exc:
+ raise InvalidHeader(
+ "Sec-WebSocket-Version", "more than one Sec-WebSocket-Version header found"
+ ) from exc
+
+ if s_w_version != "13":
+ raise InvalidHeaderValue("Sec-WebSocket-Version", s_w_version)
+
+ return s_w_key
+
+
+def build_response(headers: Headers, key: str) -> None:
+ """
+ Build a handshake response to send to the client.
+
+ Update response headers passed in argument.
+
+ :param headers: response headers
+ :param key: comes from :func:`check_request`
+
+ """
+ headers["Upgrade"] = "websocket"
+ headers["Connection"] = "Upgrade"
+ headers["Sec-WebSocket-Accept"] = accept(key)
+
+
+def check_response(headers: Headers, key: str) -> None:
+ """
+ Check a handshake response received from the server.
+
+ This function doesn't verify that the response is an HTTP/1.1 or higher
+ response with a 101 status code. These controls are the responsibility of
+ the caller.
+
+ :param headers: response headers
+ :param key: comes from :func:`build_request`
+ :raises ~websockets.exceptions.InvalidHandshake: if the handshake response
+ is invalid
+
+ """
+ connection: List[ConnectionOption] = sum(
+ [parse_connection(value) for value in headers.get_all("Connection")], []
+ )
+
+ if not any(value.lower() == "upgrade" for value in connection):
+ raise InvalidUpgrade("Connection", " ".join(connection))
+
+ upgrade: List[UpgradeProtocol] = sum(
+ [parse_upgrade(value) for value in headers.get_all("Upgrade")], []
+ )
+
+ # For compatibility with non-strict implementations, ignore case when
+ # checking the Upgrade header. The RFC always uses "websocket", except
+ # in section 11.2. (IANA registration) where it uses "WebSocket".
+ if not (len(upgrade) == 1 and upgrade[0].lower() == "websocket"):
+ raise InvalidUpgrade("Upgrade", ", ".join(upgrade))
+
+ try:
+ s_w_accept = headers["Sec-WebSocket-Accept"]
+ except KeyError as exc:
+ raise InvalidHeader("Sec-WebSocket-Accept") from exc
+ except MultipleValuesError as exc:
+ raise InvalidHeader(
+ "Sec-WebSocket-Accept", "more than one Sec-WebSocket-Accept header found"
+ ) from exc
+
+ if s_w_accept != accept(key):
+ raise InvalidHeaderValue("Sec-WebSocket-Accept", s_w_accept)
diff --git a/src/websockets/legacy/http.py b/src/websockets/legacy/http.py
new file mode 100644
index 000000000..c18e08e8d
--- /dev/null
+++ b/src/websockets/legacy/http.py
@@ -0,0 +1,193 @@
+import asyncio
+import re
+from typing import Tuple
+
+from ..datastructures import Headers
+from ..exceptions import SecurityError
+
+
+__all__ = ["read_request", "read_response"]
+
+MAX_HEADERS = 256
+MAX_LINE = 4110
+
+
+def d(value: bytes) -> str:
+ """
+ Decode a bytestring for interpolating into an error message.
+
+ """
+ return value.decode(errors="backslashreplace")
+
+
+# See https://tools.ietf.org/html/rfc7230#appendix-B.
+
+# Regex for validating header names.
+
+_token_re = re.compile(rb"[-!#$%&\'*+.^_`|~0-9a-zA-Z]+")
+
+# Regex for validating header values.
+
+# We don't attempt to support obsolete line folding.
+
+# Include HTAB (\x09), SP (\x20), VCHAR (\x21-\x7e), obs-text (\x80-\xff).
+
+# The ABNF is complicated because it attempts to express that optional
+# whitespace is ignored. We strip whitespace and don't revalidate that.
+
+# See also https://www.rfc-editor.org/errata_search.php?rfc=7230&eid=4189
+
+_value_re = re.compile(rb"[\x09\x20-\x7e\x80-\xff]*")
+
+
+async def read_request(stream: asyncio.StreamReader) -> Tuple[str, Headers]:
+ """
+ Read an HTTP/1.1 GET request and return ``(path, headers)``.
+
+ ``path`` isn't URL-decoded or validated in any way.
+
+ ``path`` and ``headers`` are expected to contain only ASCII characters.
+ Other characters are represented with surrogate escapes.
+
+ :func:`read_request` doesn't attempt to read the request body because
+ WebSocket handshake requests don't have one. If the request contains a
+ body, it may be read from ``stream`` after this coroutine returns.
+
+ :param stream: input to read the request from
+ :raises EOFError: if the connection is closed without a full HTTP request
+ :raises SecurityError: if the request exceeds a security limit
+ :raises ValueError: if the request isn't well formatted
+
+ """
+ # https://tools.ietf.org/html/rfc7230#section-3.1.1
+
+ # Parsing is simple because fixed values are expected for method and
+ # version and because path isn't checked. Since WebSocket software tends
+ # to implement HTTP/1.1 strictly, there's little need for lenient parsing.
+
+ try:
+ request_line = await read_line(stream)
+ except EOFError as exc:
+ raise EOFError("connection closed while reading HTTP request line") from exc
+
+ try:
+ method, raw_path, version = request_line.split(b" ", 2)
+ except ValueError: # not enough values to unpack (expected 3, got 1-2)
+ raise ValueError(f"invalid HTTP request line: {d(request_line)}") from None
+
+ if method != b"GET":
+ raise ValueError(f"unsupported HTTP method: {d(method)}")
+ if version != b"HTTP/1.1":
+ raise ValueError(f"unsupported HTTP version: {d(version)}")
+ path = raw_path.decode("ascii", "surrogateescape")
+
+ headers = await read_headers(stream)
+
+ return path, headers
+
+
+async def read_response(stream: asyncio.StreamReader) -> Tuple[int, str, Headers]:
+ """
+ Read an HTTP/1.1 response and return ``(status_code, reason, headers)``.
+
+ ``reason`` and ``headers`` are expected to contain only ASCII characters.
+ Other characters are represented with surrogate escapes.
+
+ :func:`read_request` doesn't attempt to read the response body because
+ WebSocket handshake responses don't have one. If the response contains a
+ body, it may be read from ``stream`` after this coroutine returns.
+
+ :param stream: input to read the response from
+ :raises EOFError: if the connection is closed without a full HTTP response
+ :raises SecurityError: if the response exceeds a security limit
+ :raises ValueError: if the response isn't well formatted
+
+ """
+ # https://tools.ietf.org/html/rfc7230#section-3.1.2
+
+ # As in read_request, parsing is simple because a fixed value is expected
+ # for version, status_code is a 3-digit number, and reason can be ignored.
+
+ try:
+ status_line = await read_line(stream)
+ except EOFError as exc:
+ raise EOFError("connection closed while reading HTTP status line") from exc
+
+ try:
+ version, raw_status_code, raw_reason = status_line.split(b" ", 2)
+ except ValueError: # not enough values to unpack (expected 3, got 1-2)
+ raise ValueError(f"invalid HTTP status line: {d(status_line)}") from None
+
+ if version != b"HTTP/1.1":
+ raise ValueError(f"unsupported HTTP version: {d(version)}")
+ try:
+ status_code = int(raw_status_code)
+ except ValueError: # invalid literal for int() with base 10
+ raise ValueError(f"invalid HTTP status code: {d(raw_status_code)}") from None
+ if not 100 <= status_code < 1000:
+ raise ValueError(f"unsupported HTTP status code: {d(raw_status_code)}")
+ if not _value_re.fullmatch(raw_reason):
+ raise ValueError(f"invalid HTTP reason phrase: {d(raw_reason)}")
+ reason = raw_reason.decode()
+
+ headers = await read_headers(stream)
+
+ return status_code, reason, headers
+
+
+async def read_headers(stream: asyncio.StreamReader) -> Headers:
+ """
+ Read HTTP headers from ``stream``.
+
+ Non-ASCII characters are represented with surrogate escapes.
+
+ """
+ # https://tools.ietf.org/html/rfc7230#section-3.2
+
+ # We don't attempt to support obsolete line folding.
+
+ headers = Headers()
+ for _ in range(MAX_HEADERS + 1):
+ try:
+ line = await read_line(stream)
+ except EOFError as exc:
+ raise EOFError("connection closed while reading HTTP headers") from exc
+ if line == b"":
+ break
+
+ try:
+ raw_name, raw_value = line.split(b":", 1)
+ except ValueError: # not enough values to unpack (expected 2, got 1)
+ raise ValueError(f"invalid HTTP header line: {d(line)}") from None
+ if not _token_re.fullmatch(raw_name):
+ raise ValueError(f"invalid HTTP header name: {d(raw_name)}")
+ raw_value = raw_value.strip(b" \t")
+ if not _value_re.fullmatch(raw_value):
+ raise ValueError(f"invalid HTTP header value: {d(raw_value)}")
+
+ name = raw_name.decode("ascii") # guaranteed to be ASCII at this point
+ value = raw_value.decode("ascii", "surrogateescape")
+ headers[name] = value
+
+ else:
+ raise SecurityError("too many HTTP headers")
+
+ return headers
+
+
+async def read_line(stream: asyncio.StreamReader) -> bytes:
+ """
+ Read a single line from ``stream``.
+
+ CRLF is stripped from the return value.
+
+ """
+ # Security: this is bounded by the StreamReader's limit (default = 32 KiB).
+ line = await stream.readline()
+ # Security: this guarantees header values are small (hard-coded = 4 KiB)
+ if len(line) > MAX_LINE:
+ raise SecurityError("line too long")
+ # Not mandatory but safe - https://tools.ietf.org/html/rfc7230#section-3.5
+ if not line.endswith(b"\r\n"):
+ raise EOFError("line without CRLF")
+ return line[:-2]
diff --git a/src/websockets/legacy/protocol.py b/src/websockets/legacy/protocol.py
new file mode 100644
index 000000000..e4c6d63c5
--- /dev/null
+++ b/src/websockets/legacy/protocol.py
@@ -0,0 +1,1361 @@
+"""
+:mod:`websockets.legacy.protocol` handles WebSocket control and data frames.
+
+See `sections 4 to 8 of RFC 6455`_.
+
+.. _sections 4 to 8 of RFC 6455: http://tools.ietf.org/html/rfc6455#section-4
+
+"""
+
+import asyncio
+import codecs
+import collections
+import enum
+import logging
+import random
+import struct
+import sys
+import warnings
+from typing import (
+ Any,
+ AsyncIterable,
+ AsyncIterator,
+ Awaitable,
+ Deque,
+ Dict,
+ Iterable,
+ List,
+ Mapping,
+ Optional,
+ Union,
+ cast,
+)
+
+from ..datastructures import Headers
+from ..exceptions import (
+ ConnectionClosed,
+ ConnectionClosedError,
+ ConnectionClosedOK,
+ InvalidState,
+ PayloadTooBig,
+ ProtocolError,
+)
+from ..extensions.base import Extension
+from ..frames import (
+ OP_BINARY,
+ OP_CLOSE,
+ OP_CONT,
+ OP_PING,
+ OP_PONG,
+ OP_TEXT,
+ Opcode,
+ parse_close,
+ prepare_ctrl,
+ prepare_data,
+ serialize_close,
+)
+from ..typing import Data, Subprotocol
+from .framing import Frame
+
+
+__all__ = ["WebSocketCommonProtocol"]
+
+logger = logging.getLogger("websockets.protocol")
+
+
+# A WebSocket connection goes through the following four states, in order:
+
+
+class State(enum.IntEnum):
+ CONNECTING, OPEN, CLOSING, CLOSED = range(4)
+
+
+# In order to ensure consistency, the code always checks the current value of
+# WebSocketCommonProtocol.state before assigning a new value and never yields
+# between the check and the assignment.
+
+
+class WebSocketCommonProtocol(asyncio.Protocol):
+ """
+ :class:`~asyncio.Protocol` subclass implementing the data transfer phase.
+
+ Once the WebSocket connection is established, during the data transfer
+ phase, the protocol is almost symmetrical between the server side and the
+ client side. :class:`WebSocketCommonProtocol` implements logic that's
+ shared between servers and clients.
+
+ Subclasses such as
+ :class:`~websockets.legacy.server.WebSocketServerProtocol` and
+ :class:`~websockets.legacy.client.WebSocketClientProtocol` implement the
+ opening handshake, which is different between servers and clients.
+
+ """
+
+ # There are only two differences between the client-side and server-side
+ # behavior: masking the payload and closing the underlying TCP connection.
+ # Set is_client = True/False and side = "client"/"server" to pick a side.
+ is_client: bool
+ side: str = "undefined"
+
+ def __init__(
+ self,
+ *,
+ ping_interval: Optional[float] = 20,
+ ping_timeout: Optional[float] = 20,
+ close_timeout: Optional[float] = None,
+ max_size: Optional[int] = 2 ** 20,
+ max_queue: Optional[int] = 2 ** 5,
+ read_limit: int = 2 ** 16,
+ write_limit: int = 2 ** 16,
+ loop: Optional[asyncio.AbstractEventLoop] = None,
+ # The following arguments are kept only for backwards compatibility.
+ host: Optional[str] = None,
+ port: Optional[int] = None,
+ secure: Optional[bool] = None,
+ legacy_recv: bool = False,
+ timeout: Optional[float] = None,
+ ) -> None:
+ # Backwards compatibility: close_timeout used to be called timeout.
+ if timeout is None:
+ timeout = 10
+ else:
+ warnings.warn("rename timeout to close_timeout", DeprecationWarning)
+ # If both are specified, timeout is ignored.
+ if close_timeout is None:
+ close_timeout = timeout
+
+ self.ping_interval = ping_interval
+ self.ping_timeout = ping_timeout
+ self.close_timeout = close_timeout
+ self.max_size = max_size
+ self.max_queue = max_queue
+ self.read_limit = read_limit
+ self.write_limit = write_limit
+
+ if loop is None:
+ loop = asyncio.get_event_loop()
+ self.loop = loop
+
+ self._host = host
+ self._port = port
+ self._secure = secure
+ self.legacy_recv = legacy_recv
+
+ # Configure read buffer limits. The high-water limit is defined by
+ # ``self.read_limit``. The ``limit`` argument controls the line length
+ # limit and half the buffer limit of :class:`~asyncio.StreamReader`.
+ # That's why it must be set to half of ``self.read_limit``.
+ self.reader = asyncio.StreamReader(limit=read_limit // 2, loop=loop)
+
+ # Copied from asyncio.FlowControlMixin
+ self._paused = False
+ self._drain_waiter: Optional[asyncio.Future[None]] = None
+
+ self._drain_lock = asyncio.Lock(
+ loop=loop if sys.version_info[:2] < (3, 8) else None
+ )
+
+ # This class implements the data transfer and closing handshake, which
+ # are shared between the client-side and the server-side.
+ # Subclasses implement the opening handshake and, on success, execute
+ # :meth:`connection_open` to change the state to OPEN.
+ self.state = State.CONNECTING
+ logger.debug("%s - state = CONNECTING", self.side)
+
+ # HTTP protocol parameters.
+ self.path: str
+ self.request_headers: Headers
+ self.response_headers: Headers
+
+ # WebSocket protocol parameters.
+ self.extensions: List[Extension] = []
+ self.subprotocol: Optional[Subprotocol] = None
+
+ # The close code and reason are set when receiving a close frame or
+ # losing the TCP connection.
+ self.close_code: int
+ self.close_reason: str
+
+ # Completed when the connection state becomes CLOSED. Translates the
+ # :meth:`connection_lost` callback to a :class:`~asyncio.Future`
+ # that can be awaited. (Other :class:`~asyncio.Protocol` callbacks are
+ # translated by ``self.stream_reader``).
+ self.connection_lost_waiter: asyncio.Future[None] = loop.create_future()
+
+ # Queue of received messages.
+ self.messages: Deque[Data] = collections.deque()
+ self._pop_message_waiter: Optional[asyncio.Future[None]] = None
+ self._put_message_waiter: Optional[asyncio.Future[None]] = None
+
+ # Protect sending fragmented messages.
+ self._fragmented_message_waiter: Optional[asyncio.Future[None]] = None
+
+ # Mapping of ping IDs to pong waiters, in chronological order.
+ self.pings: Dict[bytes, asyncio.Future[None]] = {}
+
+ # Task running the data transfer.
+ self.transfer_data_task: asyncio.Task[None]
+
+ # Exception that occurred during data transfer, if any.
+ self.transfer_data_exc: Optional[BaseException] = None
+
+ # Task sending keepalive pings.
+ self.keepalive_ping_task: asyncio.Task[None]
+
+ # Task closing the TCP connection.
+ self.close_connection_task: asyncio.Task[None]
+
+ # Copied from asyncio.FlowControlMixin
+ async def _drain_helper(self) -> None: # pragma: no cover
+ if self.connection_lost_waiter.done():
+ raise ConnectionResetError("Connection lost")
+ if not self._paused:
+ return
+ waiter = self._drain_waiter
+ assert waiter is None or waiter.cancelled()
+ waiter = self.loop.create_future()
+ self._drain_waiter = waiter
+ await waiter
+
+ # Copied from asyncio.StreamWriter
+ async def _drain(self) -> None: # pragma: no cover
+ if self.reader is not None:
+ exc = self.reader.exception()
+ if exc is not None:
+ raise exc
+ if self.transport is not None:
+ if self.transport.is_closing():
+ # Yield to the event loop so connection_lost() may be
+ # called. Without this, _drain_helper() would return
+ # immediately, and code that calls
+ # write(...); yield from drain()
+ # in a loop would never call connection_lost(), so it
+ # would not see an error when the socket is closed.
+ await asyncio.sleep(
+ 0, loop=self.loop if sys.version_info[:2] < (3, 8) else None
+ )
+ await self._drain_helper()
+
+ def connection_open(self) -> None:
+ """
+ Callback when the WebSocket opening handshake completes.
+
+ Enter the OPEN state and start the data transfer phase.
+
+ """
+ # 4.1. The WebSocket Connection is Established.
+ assert self.state is State.CONNECTING
+ self.state = State.OPEN
+ logger.debug("%s - state = OPEN", self.side)
+ # Start the task that receives incoming WebSocket messages.
+ self.transfer_data_task = self.loop.create_task(self.transfer_data())
+ # Start the task that sends pings at regular intervals.
+ self.keepalive_ping_task = self.loop.create_task(self.keepalive_ping())
+ # Start the task that eventually closes the TCP connection.
+ self.close_connection_task = self.loop.create_task(self.close_connection())
+
+ @property
+ def host(self) -> Optional[str]:
+ alternative = "remote_address" if self.is_client else "local_address"
+ warnings.warn(f"use {alternative}[0] instead of host", DeprecationWarning)
+ return self._host
+
+ @property
+ def port(self) -> Optional[int]:
+ alternative = "remote_address" if self.is_client else "local_address"
+ warnings.warn(f"use {alternative}[1] instead of port", DeprecationWarning)
+ return self._port
+
+ @property
+ def secure(self) -> Optional[bool]:
+ warnings.warn("don't use secure", DeprecationWarning)
+ return self._secure
+
+ # Public API
+
+ @property
+ def local_address(self) -> Any:
+ """
+ Local address of the connection as a ``(host, port)`` tuple.
+
+ When the connection isn't open, ``local_address`` is ``None``.
+
+ """
+ try:
+ transport = self.transport
+ except AttributeError:
+ return None
+ else:
+ return transport.get_extra_info("sockname")
+
+ @property
+ def remote_address(self) -> Any:
+ """
+ Remote address of the connection as a ``(host, port)`` tuple.
+
+ When the connection isn't open, ``remote_address`` is ``None``.
+
+ """
+ try:
+ transport = self.transport
+ except AttributeError:
+ return None
+ else:
+ return transport.get_extra_info("peername")
+
+ @property
+ def open(self) -> bool:
+ """
+ ``True`` when the connection is usable.
+
+ It may be used to detect disconnections. However, this approach is
+ discouraged per the EAFP_ principle.
+
+ When ``open`` is ``False``, using the connection raises a
+ :exc:`~websockets.exceptions.ConnectionClosed` exception.
+
+ .. _EAFP: https://docs.python.org/3/glossary.html#term-eafp
+
+ """
+ return self.state is State.OPEN and not self.transfer_data_task.done()
+
+ @property
+ def closed(self) -> bool:
+ """
+ ``True`` once the connection is closed.
+
+ Be aware that both :attr:`open` and :attr:`closed` are ``False`` during
+ the opening and closing sequences.
+
+ """
+ return self.state is State.CLOSED
+
+ async def wait_closed(self) -> None:
+ """
+ Wait until the connection is closed.
+
+ This is identical to :attr:`closed`, except it can be awaited.
+
+ This can make it easier to handle connection termination, regardless
+ of its cause, in tasks that interact with the WebSocket connection.
+
+ """
+ await asyncio.shield(self.connection_lost_waiter)
+
+ async def __aiter__(self) -> AsyncIterator[Data]:
+ """
+ Iterate on received messages.
+
+ Exit normally when the connection is closed with code 1000 or 1001.
+
+ Raise an exception in other cases.
+
+ """
+ try:
+ while True:
+ yield await self.recv()
+ except ConnectionClosedOK:
+ return
+
+ async def recv(self) -> Data:
+ """
+ Receive the next message.
+
+ Return a :class:`str` for a text frame and :class:`bytes` for a binary
+ frame.
+
+ When the end of the message stream is reached, :meth:`recv` raises
+ :exc:`~websockets.exceptions.ConnectionClosed`. Specifically, it
+ raises :exc:`~websockets.exceptions.ConnectionClosedOK` after a normal
+ connection closure and
+ :exc:`~websockets.exceptions.ConnectionClosedError` after a protocol
+ error or a network failure.
+
+ Canceling :meth:`recv` is safe. There's no risk of losing the next
+ message. The next invocation of :meth:`recv` will return it. This
+ makes it possible to enforce a timeout by wrapping :meth:`recv` in
+ :func:`~asyncio.wait_for`.
+
+ :raises ~websockets.exceptions.ConnectionClosed: when the
+ connection is closed
+ :raises RuntimeError: if two coroutines call :meth:`recv` concurrently
+
+ """
+ if self._pop_message_waiter is not None:
+ raise RuntimeError(
+ "cannot call recv while another coroutine "
+ "is already waiting for the next message"
+ )
+
+ # Don't await self.ensure_open() here:
+ # - messages could be available in the queue even if the connection
+ # is closed;
+ # - messages could be received before the closing frame even if the
+ # connection is closing.
+
+ # Wait until there's a message in the queue (if necessary) or the
+ # connection is closed.
+ while len(self.messages) <= 0:
+ pop_message_waiter: asyncio.Future[None] = self.loop.create_future()
+ self._pop_message_waiter = pop_message_waiter
+ try:
+ # If asyncio.wait() is canceled, it doesn't cancel
+ # pop_message_waiter and self.transfer_data_task.
+ await asyncio.wait(
+ [pop_message_waiter, self.transfer_data_task],
+ loop=self.loop if sys.version_info[:2] < (3, 8) else None,
+ return_when=asyncio.FIRST_COMPLETED,
+ )
+ finally:
+ self._pop_message_waiter = None
+
+ # If asyncio.wait(...) exited because self.transfer_data_task
+ # completed before receiving a new message, raise a suitable
+ # exception (or return None if legacy_recv is enabled).
+ if not pop_message_waiter.done():
+ if self.legacy_recv:
+ return None # type: ignore
+ else:
+ # Wait until the connection is closed to raise
+ # ConnectionClosed with the correct code and reason.
+ await self.ensure_open()
+
+ # Pop a message from the queue.
+ message = self.messages.popleft()
+
+ # Notify transfer_data().
+ if self._put_message_waiter is not None:
+ self._put_message_waiter.set_result(None)
+ self._put_message_waiter = None
+
+ return message
+
+ async def send(
+ self, message: Union[Data, Iterable[Data], AsyncIterable[Data]]
+ ) -> None:
+ """
+ Send a message.
+
+ A string (:class:`str`) is sent as a `Text frame`_. A bytestring or
+ bytes-like object (:class:`bytes`, :class:`bytearray`, or
+ :class:`memoryview`) is sent as a `Binary frame`_.
+
+ .. _Text frame: https://tools.ietf.org/html/rfc6455#section-5.6
+ .. _Binary frame: https://tools.ietf.org/html/rfc6455#section-5.6
+
+ :meth:`send` also accepts an iterable or an asynchronous iterable of
+ strings, bytestrings, or bytes-like objects. In that case the message
+ is fragmented. Each item is treated as a message fragment and sent in
+ its own frame. All items must be of the same type, or else
+ :meth:`send` will raise a :exc:`TypeError` and the connection will be
+ closed.
+
+ :meth:`send` rejects dict-like objects because this is often an error.
+ If you wish to send the keys of a dict-like object as fragments, call
+ its :meth:`~dict.keys` method and pass the result to :meth:`send`.
+
+ Canceling :meth:`send` is discouraged. Instead, you should close the
+ connection with :meth:`close`. Indeed, there are only two situations
+ where :meth:`send` may yield control to the event loop:
+
+ 1. The write buffer is full. If you don't want to wait until enough
+ data is sent, your only alternative is to close the connection.
+ :meth:`close` will likely time out then abort the TCP connection.
+ 2. ``message`` is an asynchronous iterator that yields control.
+ Stopping in the middle of a fragmented message will cause a
+ protocol error. Closing the connection has the same effect.
+
+ :raises TypeError: for unsupported inputs
+
+ """
+ await self.ensure_open()
+
+ # While sending a fragmented message, prevent sending other messages
+ # until all fragments are sent.
+ while self._fragmented_message_waiter is not None:
+ await asyncio.shield(self._fragmented_message_waiter)
+
+ # Unfragmented message -- this case must be handled first because
+ # strings and bytes-like objects are iterable.
+
+ if isinstance(message, (str, bytes, bytearray, memoryview)):
+ opcode, data = prepare_data(message)
+ await self.write_frame(True, opcode, data)
+
+ # Catch a common mistake -- passing a dict to send().
+
+ elif isinstance(message, Mapping):
+ raise TypeError("data is a dict-like object")
+
+ # Fragmented message -- regular iterator.
+
+ elif isinstance(message, Iterable):
+
+ # Work around https://github.com/python/mypy/issues/6227
+ message = cast(Iterable[Data], message)
+
+ iter_message = iter(message)
+ try:
+ message_chunk = next(iter_message)
+ except StopIteration:
+ return
+ opcode, data = prepare_data(message_chunk)
+
+ self._fragmented_message_waiter = asyncio.Future()
+ try:
+ # First fragment.
+ await self.write_frame(False, opcode, data)
+
+ # Other fragments.
+ for message_chunk in iter_message:
+ confirm_opcode, data = prepare_data(message_chunk)
+ if confirm_opcode != opcode:
+ raise TypeError("data contains inconsistent types")
+ await self.write_frame(False, OP_CONT, data)
+
+ # Final fragment.
+ await self.write_frame(True, OP_CONT, b"")
+
+ except Exception:
+ # We're half-way through a fragmented message and we can't
+ # complete it. This makes the connection unusable.
+ self.fail_connection(1011)
+ raise
+
+ finally:
+ self._fragmented_message_waiter.set_result(None)
+ self._fragmented_message_waiter = None
+
+ # Fragmented message -- asynchronous iterator
+
+ elif isinstance(message, AsyncIterable):
+ # aiter_message = aiter(message) without aiter
+ # https://github.com/python/mypy/issues/5738
+ aiter_message = type(message).__aiter__(message) # type: ignore
+ try:
+ # message_chunk = anext(aiter_message) without anext
+ # https://github.com/python/mypy/issues/5738
+ message_chunk = await type(aiter_message).__anext__( # type: ignore
+ aiter_message
+ )
+ except StopAsyncIteration:
+ return
+ opcode, data = prepare_data(message_chunk)
+
+ self._fragmented_message_waiter = asyncio.Future()
+ try:
+ # First fragment.
+ await self.write_frame(False, opcode, data)
+
+ # Other fragments.
+ # https://github.com/python/mypy/issues/5738
+ # coverage reports this code as not covered, but it is
+ # exercised by tests - changing it breaks the tests!
+ async for message_chunk in aiter_message: # type: ignore # pragma: no cover # noqa
+ confirm_opcode, data = prepare_data(message_chunk)
+ if confirm_opcode != opcode:
+ raise TypeError("data contains inconsistent types")
+ await self.write_frame(False, OP_CONT, data)
+
+ # Final fragment.
+ await self.write_frame(True, OP_CONT, b"")
+
+ except Exception:
+ # We're half-way through a fragmented message and we can't
+ # complete it. This makes the connection unusable.
+ self.fail_connection(1011)
+ raise
+
+ finally:
+ self._fragmented_message_waiter.set_result(None)
+ self._fragmented_message_waiter = None
+
+ else:
+ raise TypeError("data must be bytes, str, or iterable")
+
+ async def close(self, code: int = 1000, reason: str = "") -> None:
+ """
+ Perform the closing handshake.
+
+ :meth:`close` waits for the other end to complete the handshake and
+ for the TCP connection to terminate. As a consequence, there's no need
+ to await :meth:`wait_closed`; :meth:`close` already does it.
+
+ :meth:`close` is idempotent: it doesn't do anything once the
+ connection is closed.
+
+ Wrapping :func:`close` in :func:`~asyncio.create_task` is safe, given
+ that errors during connection termination aren't particularly useful.
+
+ Canceling :meth:`close` is discouraged. If it takes too long, you can
+ set a shorter ``close_timeout``. If you don't want to wait, let the
+ Python process exit, then the OS will close the TCP connection.
+
+ :param code: WebSocket close code
+ :param reason: WebSocket close reason
+
+ """
+ try:
+ await asyncio.wait_for(
+ self.write_close_frame(serialize_close(code, reason)),
+ self.close_timeout,
+ loop=self.loop if sys.version_info[:2] < (3, 8) else None,
+ )
+ except asyncio.TimeoutError:
+ # If the close frame cannot be sent because the send buffers
+ # are full, the closing handshake won't complete anyway.
+ # Fail the connection to shut down faster.
+ self.fail_connection()
+
+ # If no close frame is received within the timeout, wait_for() cancels
+ # the data transfer task and raises TimeoutError.
+
+ # If close() is called multiple times concurrently and one of these
+ # calls hits the timeout, the data transfer task will be cancelled.
+ # Other calls will receive a CancelledError here.
+
+ try:
+ # If close() is canceled during the wait, self.transfer_data_task
+ # is canceled before the timeout elapses.
+ await asyncio.wait_for(
+ self.transfer_data_task,
+ self.close_timeout,
+ loop=self.loop if sys.version_info[:2] < (3, 8) else None,
+ )
+ except (asyncio.TimeoutError, asyncio.CancelledError):
+ pass
+
+ # Wait for the close connection task to close the TCP connection.
+ await asyncio.shield(self.close_connection_task)
+
+ async def ping(self, data: Optional[Data] = None) -> Awaitable[None]:
+ """
+ Send a ping.
+
+ Return a :class:`~asyncio.Future` that will be completed when the
+ corresponding pong is received. You can ignore it if you don't intend
+ to wait.
+
+ A ping may serve as a keepalive or as a check that the remote endpoint
+ received all messages up to this point::
+
+ pong_waiter = await ws.ping()
+ await pong_waiter # only if you want to wait for the pong
+
+ By default, the ping contains four random bytes. This payload may be
+ overridden with the optional ``data`` argument which must be a string
+ (which will be encoded to UTF-8) or a bytes-like object.
+
+ Canceling :meth:`ping` is discouraged. If :meth:`ping` doesn't return
+ immediately, it means the write buffer is full. If you don't want to
+ wait, you should close the connection.
+
+ Canceling the :class:`~asyncio.Future` returned by :meth:`ping` has no
+ effect.
+
+ """
+ await self.ensure_open()
+
+ if data is not None:
+ data = prepare_ctrl(data)
+
+ # Protect against duplicates if a payload is explicitly set.
+ if data in self.pings:
+ raise ValueError("already waiting for a pong with the same data")
+
+ # Generate a unique random payload otherwise.
+ while data is None or data in self.pings:
+ data = struct.pack("!I", random.getrandbits(32))
+
+ self.pings[data] = self.loop.create_future()
+
+ await self.write_frame(True, OP_PING, data)
+
+ return asyncio.shield(self.pings[data])
+
+ async def pong(self, data: Data = b"") -> None:
+ """
+ Send a pong.
+
+ An unsolicited pong may serve as a unidirectional heartbeat.
+
+ The payload may be set with the optional ``data`` argument which must
+ be a string (which will be encoded to UTF-8) or a bytes-like object.
+
+ Canceling :meth:`pong` is discouraged for the same reason as
+ :meth:`ping`.
+
+ """
+ await self.ensure_open()
+
+ data = prepare_ctrl(data)
+
+ await self.write_frame(True, OP_PONG, data)
+
+ # Private methods - no guarantees.
+
+ def connection_closed_exc(self) -> ConnectionClosed:
+ exception: ConnectionClosed
+ if self.close_code == 1000 or self.close_code == 1001:
+ exception = ConnectionClosedOK(self.close_code, self.close_reason)
+ else:
+ exception = ConnectionClosedError(self.close_code, self.close_reason)
+ # Chain to the exception that terminated data transfer, if any.
+ exception.__cause__ = self.transfer_data_exc
+ return exception
+
+ async def ensure_open(self) -> None:
+ """
+ Check that the WebSocket connection is open.
+
+ Raise :exc:`~websockets.exceptions.ConnectionClosed` if it isn't.
+
+ """
+ # Handle cases from most common to least common for performance.
+ if self.state is State.OPEN:
+ # If self.transfer_data_task exited without a closing handshake,
+ # self.close_connection_task may be closing the connection, going
+ # straight from OPEN to CLOSED.
+ if self.transfer_data_task.done():
+ await asyncio.shield(self.close_connection_task)
+ raise self.connection_closed_exc()
+ else:
+ return
+
+ if self.state is State.CLOSED:
+ raise self.connection_closed_exc()
+
+ if self.state is State.CLOSING:
+ # If we started the closing handshake, wait for its completion to
+ # get the proper close code and reason. self.close_connection_task
+ # will complete within 4 or 5 * close_timeout after close(). The
+ # CLOSING state also occurs when failing the connection. In that
+ # case self.close_connection_task will complete even faster.
+ await asyncio.shield(self.close_connection_task)
+ raise self.connection_closed_exc()
+
+ # Control may only reach this point in buggy third-party subclasses.
+ assert self.state is State.CONNECTING
+ raise InvalidState("WebSocket connection isn't established yet")
+
+ async def transfer_data(self) -> None:
+ """
+ Read incoming messages and put them in a queue.
+
+ This coroutine runs in a task until the closing handshake is started.
+
+ """
+ try:
+ while True:
+ message = await self.read_message()
+
+ # Exit the loop when receiving a close frame.
+ if message is None:
+ break
+
+ # Wait until there's room in the queue (if necessary).
+ if self.max_queue is not None:
+ while len(self.messages) >= self.max_queue:
+ self._put_message_waiter = self.loop.create_future()
+ try:
+ await asyncio.shield(self._put_message_waiter)
+ finally:
+ self._put_message_waiter = None
+
+ # Put the message in the queue.
+ self.messages.append(message)
+
+ # Notify recv().
+ if self._pop_message_waiter is not None:
+ self._pop_message_waiter.set_result(None)
+ self._pop_message_waiter = None
+
+ except asyncio.CancelledError as exc:
+ self.transfer_data_exc = exc
+ # If fail_connection() cancels this task, avoid logging the error
+ # twice and failing the connection again.
+ raise
+
+ except ProtocolError as exc:
+ self.transfer_data_exc = exc
+ self.fail_connection(1002)
+
+ except (ConnectionError, TimeoutError, EOFError) as exc:
+ # Reading data with self.reader.readexactly may raise:
+ # - most subclasses of ConnectionError if the TCP connection
+ # breaks, is reset, or is aborted;
+ # - TimeoutError if the TCP connection times out;
+ # - IncompleteReadError, a subclass of EOFError, if fewer
+ # bytes are available than requested.
+ self.transfer_data_exc = exc
+ self.fail_connection(1006)
+
+ except UnicodeDecodeError as exc:
+ self.transfer_data_exc = exc
+ self.fail_connection(1007)
+
+ except PayloadTooBig as exc:
+ self.transfer_data_exc = exc
+ self.fail_connection(1009)
+
+ except Exception as exc:
+ # This shouldn't happen often because exceptions expected under
+ # regular circumstances are handled above. If it does, consider
+ # catching and handling more exceptions.
+ logger.error("Error in data transfer", exc_info=True)
+
+ self.transfer_data_exc = exc
+ self.fail_connection(1011)
+
+ async def read_message(self) -> Optional[Data]:
+ """
+ Read a single message from the connection.
+
+ Re-assemble data frames if the message is fragmented.
+
+ Return ``None`` when the closing handshake is started.
+
+ """
+ frame = await self.read_data_frame(max_size=self.max_size)
+
+ # A close frame was received.
+ if frame is None:
+ return None
+
+ if frame.opcode == OP_TEXT:
+ text = True
+ elif frame.opcode == OP_BINARY:
+ text = False
+ else: # frame.opcode == OP_CONT
+ raise ProtocolError("unexpected opcode")
+
+ # Shortcut for the common case - no fragmentation
+ if frame.fin:
+ return frame.data.decode("utf-8") if text else frame.data
+
+ # 5.4. Fragmentation
+ chunks: List[Data] = []
+ max_size = self.max_size
+ if text:
+ decoder_factory = codecs.getincrementaldecoder("utf-8")
+ decoder = decoder_factory(errors="strict")
+ if max_size is None:
+
+ def append(frame: Frame) -> None:
+ nonlocal chunks
+ chunks.append(decoder.decode(frame.data, frame.fin))
+
+ else:
+
+ def append(frame: Frame) -> None:
+ nonlocal chunks, max_size
+ chunks.append(decoder.decode(frame.data, frame.fin))
+ assert isinstance(max_size, int)
+ max_size -= len(frame.data)
+
+ else:
+ if max_size is None:
+
+ def append(frame: Frame) -> None:
+ nonlocal chunks
+ chunks.append(frame.data)
+
+ else:
+
+ def append(frame: Frame) -> None:
+ nonlocal chunks, max_size
+ chunks.append(frame.data)
+ assert isinstance(max_size, int)
+ max_size -= len(frame.data)
+
+ append(frame)
+
+ while not frame.fin:
+ frame = await self.read_data_frame(max_size=max_size)
+ if frame is None:
+ raise ProtocolError("incomplete fragmented message")
+ if frame.opcode != OP_CONT:
+ raise ProtocolError("unexpected opcode")
+ append(frame)
+
+ # mypy cannot figure out that chunks have the proper type.
+ return ("" if text else b"").join(chunks) # type: ignore
+
+ async def read_data_frame(self, max_size: Optional[int]) -> Optional[Frame]:
+ """
+ Read a single data frame from the connection.
+
+ Process control frames received before the next data frame.
+
+ Return ``None`` if a close frame is encountered before any data frame.
+
+ """
+ # 6.2. Receiving Data
+ while True:
+ frame = await self.read_frame(max_size)
+
+ # 5.5. Control Frames
+ if frame.opcode == OP_CLOSE:
+ # 7.1.5. The WebSocket Connection Close Code
+ # 7.1.6. The WebSocket Connection Close Reason
+ self.close_code, self.close_reason = parse_close(frame.data)
+ try:
+ # Echo the original data instead of re-serializing it with
+ # serialize_close() because that fails when the close frame
+ # is empty and parse_close() synthetizes a 1005 close code.
+ await self.write_close_frame(frame.data)
+ except ConnectionClosed:
+ # It doesn't really matter if the connection was closed
+ # before we could send back a close frame.
+ pass
+ return None
+
+ elif frame.opcode == OP_PING:
+ # Answer pings.
+ ping_hex = frame.data.hex() or "[empty]"
+ logger.debug(
+ "%s - received ping, sending pong: %s", self.side, ping_hex
+ )
+ await self.pong(frame.data)
+
+ elif frame.opcode == OP_PONG:
+ # Acknowledge pings on solicited pongs.
+ if frame.data in self.pings:
+ logger.debug(
+ "%s - received solicited pong: %s",
+ self.side,
+ frame.data.hex() or "[empty]",
+ )
+ # Acknowledge all pings up to the one matching this pong.
+ ping_id = None
+ ping_ids = []
+ for ping_id, ping in self.pings.items():
+ ping_ids.append(ping_id)
+ if not ping.done():
+ ping.set_result(None)
+ if ping_id == frame.data:
+ break
+ else: # pragma: no cover
+ assert False, "ping_id is in self.pings"
+ # Remove acknowledged pings from self.pings.
+ for ping_id in ping_ids:
+ del self.pings[ping_id]
+ ping_ids = ping_ids[:-1]
+ if ping_ids:
+ pings_hex = ", ".join(
+ ping_id.hex() or "[empty]" for ping_id in ping_ids
+ )
+ plural = "s" if len(ping_ids) > 1 else ""
+ logger.debug(
+ "%s - acknowledged previous ping%s: %s",
+ self.side,
+ plural,
+ pings_hex,
+ )
+ else:
+ logger.debug(
+ "%s - received unsolicited pong: %s",
+ self.side,
+ frame.data.hex() or "[empty]",
+ )
+
+ # 5.6. Data Frames
+ else:
+ return frame
+
+ async def read_frame(self, max_size: Optional[int]) -> Frame:
+ """
+ Read a single frame from the connection.
+
+ """
+ frame = await Frame.read(
+ self.reader.readexactly,
+ mask=not self.is_client,
+ max_size=max_size,
+ extensions=self.extensions,
+ )
+ logger.debug("%s < %r", self.side, frame)
+ return frame
+
+ async def write_frame(
+ self, fin: bool, opcode: int, data: bytes, *, _expected_state: int = State.OPEN
+ ) -> None:
+ # Defensive assertion for protocol compliance.
+ if self.state is not _expected_state: # pragma: no cover
+ raise InvalidState(
+ f"Cannot write to a WebSocket in the {self.state.name} state"
+ )
+
+ frame = Frame(fin, Opcode(opcode), data)
+ logger.debug("%s > %r", self.side, frame)
+ frame.write(
+ self.transport.write, mask=self.is_client, extensions=self.extensions
+ )
+
+ try:
+ # drain() cannot be called concurrently by multiple coroutines:
+ # http://bugs.python.org/issue29930. Remove this lock when no
+ # version of Python where this bugs exists is supported anymore.
+ async with self._drain_lock:
+ # Handle flow control automatically.
+ await self._drain()
+ except ConnectionError:
+ # Terminate the connection if the socket died.
+ self.fail_connection()
+ # Wait until the connection is closed to raise ConnectionClosed
+ # with the correct code and reason.
+ await self.ensure_open()
+
+ async def write_close_frame(self, data: bytes = b"") -> None:
+ """
+ Write a close frame if and only if the connection state is OPEN.
+
+ This dedicated coroutine must be used for writing close frames to
+ ensure that at most one close frame is sent on a given connection.
+
+ """
+ # Test and set the connection state before sending the close frame to
+ # avoid sending two frames in case of concurrent calls.
+ if self.state is State.OPEN:
+ # 7.1.3. The WebSocket Closing Handshake is Started
+ self.state = State.CLOSING
+ logger.debug("%s - state = CLOSING", self.side)
+
+ # 7.1.2. Start the WebSocket Closing Handshake
+ await self.write_frame(True, OP_CLOSE, data, _expected_state=State.CLOSING)
+
+ async def keepalive_ping(self) -> None:
+ """
+ Send a Ping frame and wait for a Pong frame at regular intervals.
+
+ This coroutine exits when the connection terminates and one of the
+ following happens:
+
+ - :meth:`ping` raises :exc:`ConnectionClosed`, or
+ - :meth:`close_connection` cancels :attr:`keepalive_ping_task`.
+
+ """
+ if self.ping_interval is None:
+ return
+
+ try:
+ while True:
+ await asyncio.sleep(
+ self.ping_interval,
+ loop=self.loop if sys.version_info[:2] < (3, 8) else None,
+ )
+
+ # ping() raises CancelledError if the connection is closed,
+ # when close_connection() cancels self.keepalive_ping_task.
+
+ # ping() raises ConnectionClosed if the connection is lost,
+ # when connection_lost() calls abort_pings().
+
+ pong_waiter = await self.ping()
+
+ if self.ping_timeout is not None:
+ try:
+ await asyncio.wait_for(
+ pong_waiter,
+ self.ping_timeout,
+ loop=self.loop if sys.version_info[:2] < (3, 8) else None,
+ )
+ except asyncio.TimeoutError:
+ logger.debug("%s ! timed out waiting for pong", self.side)
+ self.fail_connection(1011)
+ break
+
+ # Remove this branch when dropping support for Python < 3.8
+ # because CancelledError no longer inherits Exception.
+ except asyncio.CancelledError:
+ raise
+
+ except ConnectionClosed:
+ pass
+
+ except Exception:
+ logger.warning("Unexpected exception in keepalive ping task", exc_info=True)
+
+ async def close_connection(self) -> None:
+ """
+ 7.1.1. Close the WebSocket Connection
+
+ When the opening handshake succeeds, :meth:`connection_open` starts
+ this coroutine in a task. It waits for the data transfer phase to
+ complete then it closes the TCP connection cleanly.
+
+ When the opening handshake fails, :meth:`fail_connection` does the
+ same. There's no data transfer phase in that case.
+
+ """
+ try:
+ # Wait for the data transfer phase to complete.
+ if hasattr(self, "transfer_data_task"):
+ try:
+ await self.transfer_data_task
+ except asyncio.CancelledError:
+ pass
+
+ # Cancel the keepalive ping task.
+ if hasattr(self, "keepalive_ping_task"):
+ self.keepalive_ping_task.cancel()
+
+ # A client should wait for a TCP close from the server.
+ if self.is_client and hasattr(self, "transfer_data_task"):
+ if await self.wait_for_connection_lost():
+ # Coverage marks this line as a partially executed branch.
+ # I supect a bug in coverage. Ignore it for now.
+ return # pragma: no cover
+ logger.debug("%s ! timed out waiting for TCP close", self.side)
+
+ # Half-close the TCP connection if possible (when there's no TLS).
+ if self.transport.can_write_eof():
+ logger.debug("%s x half-closing TCP connection", self.side)
+ self.transport.write_eof()
+
+ if await self.wait_for_connection_lost():
+ # Coverage marks this line as a partially executed branch.
+ # I supect a bug in coverage. Ignore it for now.
+ return # pragma: no cover
+ logger.debug("%s ! timed out waiting for TCP close", self.side)
+
+ finally:
+ # The try/finally ensures that the transport never remains open,
+ # even if this coroutine is canceled (for example).
+
+ # If connection_lost() was called, the TCP connection is closed.
+ # However, if TLS is enabled, the transport still needs closing.
+ # Else asyncio complains: ResourceWarning: unclosed transport.
+ if self.connection_lost_waiter.done() and self.transport.is_closing():
+ return
+
+ # Close the TCP connection. Buffers are flushed asynchronously.
+ logger.debug("%s x closing TCP connection", self.side)
+ self.transport.close()
+
+ if await self.wait_for_connection_lost():
+ return
+ logger.debug("%s ! timed out waiting for TCP close", self.side)
+
+ # Abort the TCP connection. Buffers are discarded.
+ logger.debug("%s x aborting TCP connection", self.side)
+ self.transport.abort()
+
+ # connection_lost() is called quickly after aborting.
+ # Coverage marks this line as a partially executed branch.
+ # I supect a bug in coverage. Ignore it for now.
+ await self.wait_for_connection_lost() # pragma: no cover
+
+ async def wait_for_connection_lost(self) -> bool:
+ """
+ Wait until the TCP connection is closed or ``self.close_timeout`` elapses.
+
+ Return ``True`` if the connection is closed and ``False`` otherwise.
+
+ """
+ if not self.connection_lost_waiter.done():
+ try:
+ await asyncio.wait_for(
+ asyncio.shield(self.connection_lost_waiter),
+ self.close_timeout,
+ loop=self.loop if sys.version_info[:2] < (3, 8) else None,
+ )
+ except asyncio.TimeoutError:
+ pass
+ # Re-check self.connection_lost_waiter.done() synchronously because
+ # connection_lost() could run between the moment the timeout occurs
+ # and the moment this coroutine resumes running.
+ return self.connection_lost_waiter.done()
+
+ def fail_connection(self, code: int = 1006, reason: str = "") -> None:
+ """
+ 7.1.7. Fail the WebSocket Connection
+
+ This requires:
+
+ 1. Stopping all processing of incoming data, which means cancelling
+ :attr:`transfer_data_task`. The close code will be 1006 unless a
+ close frame was received earlier.
+
+ 2. Sending a close frame with an appropriate code if the opening
+ handshake succeeded and the other side is likely to process it.
+
+ 3. Closing the connection. :meth:`close_connection` takes care of
+ this once :attr:`transfer_data_task` exits after being canceled.
+
+ (The specification describes these steps in the opposite order.)
+
+ """
+ logger.debug(
+ "%s ! failing %s WebSocket connection with code %d",
+ self.side,
+ self.state.name,
+ code,
+ )
+
+ # Cancel transfer_data_task if the opening handshake succeeded.
+ # cancel() is idempotent and ignored if the task is done already.
+ if hasattr(self, "transfer_data_task"):
+ self.transfer_data_task.cancel()
+
+ # Send a close frame when the state is OPEN (a close frame was already
+ # sent if it's CLOSING), except when failing the connection because of
+ # an error reading from or writing to the network.
+ # Don't send a close frame if the connection is broken.
+ if code != 1006 and self.state is State.OPEN:
+
+ frame_data = serialize_close(code, reason)
+
+ # Write the close frame without draining the write buffer.
+
+ # Keeping fail_connection() synchronous guarantees it can't
+ # get stuck and simplifies the implementation of the callers.
+ # Not drainig the write buffer is acceptable in this context.
+
+ # This duplicates a few lines of code from write_close_frame()
+ # and write_frame().
+
+ self.state = State.CLOSING
+ logger.debug("%s - state = CLOSING", self.side)
+
+ frame = Frame(True, OP_CLOSE, frame_data)
+ logger.debug("%s > %r", self.side, frame)
+ frame.write(
+ self.transport.write, mask=self.is_client, extensions=self.extensions
+ )
+
+ # Start close_connection_task if the opening handshake didn't succeed.
+ if not hasattr(self, "close_connection_task"):
+ self.close_connection_task = self.loop.create_task(self.close_connection())
+
+ def abort_pings(self) -> None:
+ """
+ Raise ConnectionClosed in pending keepalive pings.
+
+ They'll never receive a pong once the connection is closed.
+
+ """
+ assert self.state is State.CLOSED
+ exc = self.connection_closed_exc()
+
+ for ping in self.pings.values():
+ ping.set_exception(exc)
+ # If the exception is never retrieved, it will be logged when ping
+ # is garbage-collected. This is confusing for users.
+ # Given that ping is done (with an exception), canceling it does
+ # nothing, but it prevents logging the exception.
+ ping.cancel()
+
+ if self.pings:
+ pings_hex = ", ".join(ping_id.hex() or "[empty]" for ping_id in self.pings)
+ plural = "s" if len(self.pings) > 1 else ""
+ logger.debug(
+ "%s - aborted pending ping%s: %s", self.side, plural, pings_hex
+ )
+
+ # asyncio.Protocol methods
+
+ def connection_made(self, transport: asyncio.BaseTransport) -> None:
+ """
+ Configure write buffer limits.
+
+ The high-water limit is defined by ``self.write_limit``.
+
+ The low-water limit currently defaults to ``self.write_limit // 4`` in
+ :meth:`~asyncio.WriteTransport.set_write_buffer_limits`, which should
+ be all right for reasonable use cases of this library.
+
+ This is the earliest point where we can get hold of the transport,
+ which means it's the best point for configuring it.
+
+ """
+ logger.debug("%s - event = connection_made(%s)", self.side, transport)
+
+ transport = cast(asyncio.Transport, transport)
+ transport.set_write_buffer_limits(self.write_limit)
+ self.transport = transport
+
+ # Copied from asyncio.StreamReaderProtocol
+ self.reader.set_transport(transport)
+
+ def connection_lost(self, exc: Optional[Exception]) -> None:
+ """
+ 7.1.4. The WebSocket Connection is Closed.
+
+ """
+ logger.debug("%s - event = connection_lost(%s)", self.side, exc)
+ self.state = State.CLOSED
+ logger.debug("%s - state = CLOSED", self.side)
+ if not hasattr(self, "close_code"):
+ self.close_code = 1006
+ if not hasattr(self, "close_reason"):
+ self.close_reason = ""
+ logger.debug(
+ "%s x code = %d, reason = %s",
+ self.side,
+ self.close_code,
+ self.close_reason or "[no reason]",
+ )
+ self.abort_pings()
+ # If self.connection_lost_waiter isn't pending, that's a bug, because:
+ # - it's set only here in connection_lost() which is called only once;
+ # - it must never be canceled.
+ self.connection_lost_waiter.set_result(None)
+
+ if True: # pragma: no cover
+
+ # Copied from asyncio.StreamReaderProtocol
+ if self.reader is not None:
+ if exc is None:
+ self.reader.feed_eof()
+ else:
+ self.reader.set_exception(exc)
+
+ # Copied from asyncio.FlowControlMixin
+ # Wake up the writer if currently paused.
+ if not self._paused:
+ return
+ waiter = self._drain_waiter
+ if waiter is None:
+ return
+ self._drain_waiter = None
+ if waiter.done():
+ return
+ if exc is None:
+ waiter.set_result(None)
+ else:
+ waiter.set_exception(exc)
+
+ def pause_writing(self) -> None: # pragma: no cover
+ assert not self._paused
+ self._paused = True
+
+ def resume_writing(self) -> None: # pragma: no cover
+ assert self._paused
+ self._paused = False
+
+ waiter = self._drain_waiter
+ if waiter is not None:
+ self._drain_waiter = None
+ if not waiter.done():
+ waiter.set_result(None)
+
+ def data_received(self, data: bytes) -> None:
+ logger.debug("%s - event = data_received(<%d bytes>)", self.side, len(data))
+ self.reader.feed_data(data)
+
+ def eof_received(self) -> None:
+ """
+ Close the transport after receiving EOF.
+
+ The WebSocket protocol has its own closing handshake: endpoints close
+ the TCP or TLS connection after sending and receiving a close frame.
+
+ As a consequence, they never need to write after receiving EOF, so
+ there's no reason to keep the transport open by returning ``True``.
+
+ Besides, that doesn't work on TLS connections.
+
+ """
+ logger.debug("%s - event = eof_received()", self.side)
+ self.reader.feed_eof()
diff --git a/src/websockets/legacy/server.py b/src/websockets/legacy/server.py
new file mode 100644
index 000000000..e693bbd2f
--- /dev/null
+++ b/src/websockets/legacy/server.py
@@ -0,0 +1,1101 @@
+"""
+:mod:`websockets.legacy.server` defines the WebSocket server APIs.
+
+"""
+
+import asyncio
+import collections.abc
+import email.utils
+import functools
+import http
+import logging
+import socket
+import sys
+import warnings
+from types import TracebackType
+from typing import (
+ Any,
+ Awaitable,
+ Callable,
+ Generator,
+ List,
+ Optional,
+ Sequence,
+ Set,
+ Tuple,
+ Type,
+ Union,
+ cast,
+)
+
+from ..datastructures import Headers, HeadersLike, MultipleValuesError
+from ..exceptions import (
+ AbortHandshake,
+ InvalidHandshake,
+ InvalidHeader,
+ InvalidMessage,
+ InvalidOrigin,
+ InvalidUpgrade,
+ NegotiationError,
+)
+from ..extensions.base import Extension, ServerExtensionFactory
+from ..extensions.permessage_deflate import enable_server_permessage_deflate
+from ..headers import build_extension, parse_extension, parse_subprotocol
+from ..http import USER_AGENT
+from ..typing import ExtensionHeader, Origin, Subprotocol
+from .handshake import build_response, check_request
+from .http import read_request
+from .protocol import WebSocketCommonProtocol
+
+
+__all__ = ["serve", "unix_serve", "WebSocketServerProtocol", "WebSocketServer"]
+
+logger = logging.getLogger("websockets.server")
+
+
+HeadersLikeOrCallable = Union[HeadersLike, Callable[[str, Headers], HeadersLike]]
+
+HTTPResponse = Tuple[http.HTTPStatus, HeadersLike, bytes]
+
+
+class WebSocketServerProtocol(WebSocketCommonProtocol):
+ """
+ :class:`~asyncio.Protocol` subclass implementing a WebSocket server.
+
+ :class:`WebSocketServerProtocol`:
+
+ * performs the opening handshake to establish the connection;
+ * provides :meth:`recv` and :meth:`send` coroutines for receiving and
+ sending messages;
+ * deals with control frames automatically;
+ * performs the closing handshake to terminate the connection.
+
+ You may customize the opening handshake by subclassing
+ :class:`WebSocketServer` and overriding:
+
+ * :meth:`process_request` to intercept the client request before any
+ processing and, if appropriate, to abort the WebSocket request and
+ return a HTTP response instead;
+ * :meth:`select_subprotocol` to select a subprotocol, if the client and
+ the server have multiple subprotocols in common and the default logic
+ for choosing one isn't suitable (this is rarely needed).
+
+ :class:`WebSocketServerProtocol` supports asynchronous iteration::
+
+ async for message in websocket:
+ await process(message)
+
+ The iterator yields incoming messages. It exits normally when the
+ connection is closed with the close code 1000 (OK) or 1001 (going away).
+ It raises a :exc:`~websockets.exceptions.ConnectionClosedError` exception
+ when the connection is closed with any other code.
+
+ Once the connection is open, a `Ping frame`_ is sent every
+ ``ping_interval`` seconds. This serves as a keepalive. It helps keeping
+ the connection open, especially in the presence of proxies with short
+ timeouts on inactive connections. Set ``ping_interval`` to ``None`` to
+ disable this behavior.
+
+ .. _Ping frame: https://tools.ietf.org/html/rfc6455#section-5.5.2
+
+ If the corresponding `Pong frame`_ isn't received within ``ping_timeout``
+ seconds, the connection is considered unusable and is closed with
+ code 1011. This ensures that the remote endpoint remains responsive. Set
+ ``ping_timeout`` to ``None`` to disable this behavior.
+
+ .. _Pong frame: https://tools.ietf.org/html/rfc6455#section-5.5.3
+
+ The ``close_timeout`` parameter defines a maximum wait time for completing
+ the closing handshake and terminating the TCP connection. For legacy
+ reasons, :meth:`close` completes in at most ``4 * close_timeout`` seconds.
+
+ ``close_timeout`` needs to be a parameter of the protocol because
+ websockets usually calls :meth:`close` implicitly when the connection
+ handler terminates.
+
+ To apply a timeout to any other API, wrap it in :func:`~asyncio.wait_for`.
+
+ The ``max_size`` parameter enforces the maximum size for incoming messages
+ in bytes. The default value is 1 MiB. ``None`` disables the limit. If a
+ message larger than the maximum size is received, :meth:`recv` will
+ raise :exc:`~websockets.exceptions.ConnectionClosedError` and the
+ connection will be closed with code 1009.
+
+ The ``max_queue`` parameter sets the maximum length of the queue that
+ holds incoming messages. The default value is ``32``. ``None`` disables
+ the limit. Messages are added to an in-memory queue when they're received;
+ then :meth:`recv` pops from that queue. In order to prevent excessive
+ memory consumption when messages are received faster than they can be
+ processed, the queue must be bounded. If the queue fills up, the protocol
+ stops processing incoming data until :meth:`recv` is called. In this
+ situation, various receive buffers (at least in :mod:`asyncio` and in the
+ OS) will fill up, then the TCP receive window will shrink, slowing down
+ transmission to avoid packet loss.
+
+ Since Python can use up to 4 bytes of memory to represent a single
+ character, each connection may use up to ``4 * max_size * max_queue``
+ bytes of memory to store incoming messages. By default, this is 128 MiB.
+ You may want to lower the limits, depending on your application's
+ requirements.
+
+ The ``read_limit`` argument sets the high-water limit of the buffer for
+ incoming bytes. The low-water limit is half the high-water limit. The
+ default value is 64 KiB, half of asyncio's default (based on the current
+ implementation of :class:`~asyncio.StreamReader`).
+
+ The ``write_limit`` argument sets the high-water limit of the buffer for
+ outgoing bytes. The low-water limit is a quarter of the high-water limit.
+ The default value is 64 KiB, equal to asyncio's default (based on the
+ current implementation of ``FlowControlMixin``).
+
+ As soon as the HTTP request and response in the opening handshake are
+ processed:
+
+ * the request path is available in the :attr:`path` attribute;
+ * the request and response HTTP headers are available in the
+ :attr:`request_headers` and :attr:`response_headers` attributes,
+ which are :class:`~websockets.http.Headers` instances.
+
+ If a subprotocol was negotiated, it's available in the :attr:`subprotocol`
+ attribute.
+
+ Once the connection is closed, the code is available in the
+ :attr:`close_code` attribute and the reason in :attr:`close_reason`.
+
+ All attributes must be treated as read-only.
+
+ """
+
+ is_client = False
+ side = "server"
+
+ def __init__(
+ self,
+ ws_handler: Callable[["WebSocketServerProtocol", str], Awaitable[Any]],
+ ws_server: "WebSocketServer",
+ *,
+ origins: Optional[Sequence[Optional[Origin]]] = None,
+ extensions: Optional[Sequence[ServerExtensionFactory]] = None,
+ subprotocols: Optional[Sequence[Subprotocol]] = None,
+ extra_headers: Optional[HeadersLikeOrCallable] = None,
+ process_request: Optional[
+ Callable[[str, Headers], Awaitable[Optional[HTTPResponse]]]
+ ] = None,
+ select_subprotocol: Optional[
+ Callable[[Sequence[Subprotocol], Sequence[Subprotocol]], Subprotocol]
+ ] = None,
+ **kwargs: Any,
+ ) -> None:
+ # For backwards compatibility with 6.0 or earlier.
+ if origins is not None and "" in origins:
+ warnings.warn("use None instead of '' in origins", DeprecationWarning)
+ origins = [None if origin == "" else origin for origin in origins]
+ self.ws_handler = ws_handler
+ self.ws_server = ws_server
+ self.origins = origins
+ self.available_extensions = extensions
+ self.available_subprotocols = subprotocols
+ self.extra_headers = extra_headers
+ self._process_request = process_request
+ self._select_subprotocol = select_subprotocol
+ super().__init__(**kwargs)
+
+ def connection_made(self, transport: asyncio.BaseTransport) -> None:
+ """
+ Register connection and initialize a task to handle it.
+
+ """
+ super().connection_made(transport)
+ # Register the connection with the server before creating the handler
+ # task. Registering at the beginning of the handler coroutine would
+ # create a race condition between the creation of the task, which
+ # schedules its execution, and the moment the handler starts running.
+ self.ws_server.register(self)
+ self.handler_task = self.loop.create_task(self.handler())
+
+ async def handler(self) -> None:
+ """
+ Handle the lifecycle of a WebSocket connection.
+
+ Since this method doesn't have a caller able to handle exceptions, it
+ attemps to log relevant ones and guarantees that the TCP connection is
+ closed before exiting.
+
+ """
+ try:
+
+ try:
+ path = await self.handshake(
+ origins=self.origins,
+ available_extensions=self.available_extensions,
+ available_subprotocols=self.available_subprotocols,
+ extra_headers=self.extra_headers,
+ )
+ # Remove this branch when dropping support for Python < 3.8
+ # because CancelledError no longer inherits Exception.
+ except asyncio.CancelledError: # pragma: no cover
+ raise
+ except ConnectionError:
+ logger.debug("Connection error in opening handshake", exc_info=True)
+ raise
+ except Exception as exc:
+ if isinstance(exc, AbortHandshake):
+ status, headers, body = exc.status, exc.headers, exc.body
+ elif isinstance(exc, InvalidOrigin):
+ logger.debug("Invalid origin", exc_info=True)
+ status, headers, body = (
+ http.HTTPStatus.FORBIDDEN,
+ Headers(),
+ f"Failed to open a WebSocket connection: {exc}.\n".encode(),
+ )
+ elif isinstance(exc, InvalidUpgrade):
+ logger.debug("Invalid upgrade", exc_info=True)
+ status, headers, body = (
+ http.HTTPStatus.UPGRADE_REQUIRED,
+ Headers([("Upgrade", "websocket")]),
+ (
+ f"Failed to open a WebSocket connection: {exc}.\n"
+ f"\n"
+ f"You cannot access a WebSocket server directly "
+ f"with a browser. You need a WebSocket client.\n"
+ ).encode(),
+ )
+ elif isinstance(exc, InvalidHandshake):
+ logger.debug("Invalid handshake", exc_info=True)
+ status, headers, body = (
+ http.HTTPStatus.BAD_REQUEST,
+ Headers(),
+ f"Failed to open a WebSocket connection: {exc}.\n".encode(),
+ )
+ else:
+ logger.warning("Error in opening handshake", exc_info=True)
+ status, headers, body = (
+ http.HTTPStatus.INTERNAL_SERVER_ERROR,
+ Headers(),
+ (
+ b"Failed to open a WebSocket connection.\n"
+ b"See server log for more information.\n"
+ ),
+ )
+
+ headers.setdefault("Date", email.utils.formatdate(usegmt=True))
+ headers.setdefault("Server", USER_AGENT)
+ headers.setdefault("Content-Length", str(len(body)))
+ headers.setdefault("Content-Type", "text/plain")
+ headers.setdefault("Connection", "close")
+
+ self.write_http_response(status, headers, body)
+ self.fail_connection()
+ await self.wait_closed()
+ return
+
+ try:
+ await self.ws_handler(self, path)
+ except Exception:
+ logger.error("Error in connection handler", exc_info=True)
+ if not self.closed:
+ self.fail_connection(1011)
+ raise
+
+ try:
+ await self.close()
+ except ConnectionError:
+ logger.debug("Connection error in closing handshake", exc_info=True)
+ raise
+ except Exception:
+ logger.warning("Error in closing handshake", exc_info=True)
+ raise
+
+ except Exception:
+ # Last-ditch attempt to avoid leaking connections on errors.
+ try:
+ self.transport.close()
+ except Exception: # pragma: no cover
+ pass
+
+ finally:
+ # Unregister the connection with the server when the handler task
+ # terminates. Registration is tied to the lifecycle of the handler
+ # task because the server waits for tasks attached to registered
+ # connections before terminating.
+ self.ws_server.unregister(self)
+
+ async def read_http_request(self) -> Tuple[str, Headers]:
+ """
+ Read request line and headers from the HTTP request.
+
+ If the request contains a body, it may be read from ``self.reader``
+ after this coroutine returns.
+
+ :raises ~websockets.exceptions.InvalidMessage: if the HTTP message is
+ malformed or isn't an HTTP/1.1 GET request
+
+ """
+ try:
+ path, headers = await read_request(self.reader)
+ except asyncio.CancelledError: # pragma: no cover
+ raise
+ except Exception as exc:
+ raise InvalidMessage("did not receive a valid HTTP request") from exc
+
+ logger.debug("%s < GET %s HTTP/1.1", self.side, path)
+ logger.debug("%s < %r", self.side, headers)
+
+ self.path = path
+ self.request_headers = headers
+
+ return path, headers
+
+ def write_http_response(
+ self, status: http.HTTPStatus, headers: Headers, body: Optional[bytes] = None
+ ) -> None:
+ """
+ Write status line and headers to the HTTP response.
+
+ This coroutine is also able to write a response body.
+
+ """
+ self.response_headers = headers
+
+ logger.debug("%s > HTTP/1.1 %d %s", self.side, status.value, status.phrase)
+ logger.debug("%s > %r", self.side, headers)
+
+ # Since the status line and headers only contain ASCII characters,
+ # we can keep this simple.
+ response = f"HTTP/1.1 {status.value} {status.phrase}\r\n"
+ response += str(headers)
+
+ self.transport.write(response.encode())
+
+ if body is not None:
+ logger.debug("%s > body (%d bytes)", self.side, len(body))
+ self.transport.write(body)
+
+ async def process_request(
+ self, path: str, request_headers: Headers
+ ) -> Optional[HTTPResponse]:
+ """
+ Intercept the HTTP request and return an HTTP response if appropriate.
+
+ If ``process_request`` returns ``None``, the WebSocket handshake
+ continues. If it returns 3-uple containing a status code, response
+ headers and a response body, that HTTP response is sent and the
+ connection is closed. In that case:
+
+ * The HTTP status must be a :class:`~http.HTTPStatus`.
+ * HTTP headers must be a :class:`~websockets.http.Headers` instance, a
+ :class:`~collections.abc.Mapping`, or an iterable of ``(name,
+ value)`` pairs.
+ * The HTTP response body must be :class:`bytes`. It may be empty.
+
+ This coroutine may be overridden in a :class:`WebSocketServerProtocol`
+ subclass, for example:
+
+ * to return a HTTP 200 OK response on a given path; then a load
+ balancer can use this path for a health check;
+ * to authenticate the request and return a HTTP 401 Unauthorized or a
+ HTTP 403 Forbidden when authentication fails.
+
+ Instead of subclassing, it is possible to override this method by
+ passing a ``process_request`` argument to the :func:`serve` function
+ or the :class:`WebSocketServerProtocol` constructor. This is
+ equivalent, except ``process_request`` won't have access to the
+ protocol instance, so it can't store information for later use.
+
+ ``process_request`` is expected to complete quickly. If it may run for
+ a long time, then it should await :meth:`wait_closed` and exit if
+ :meth:`wait_closed` completes, or else it could prevent the server
+ from shutting down.
+
+ :param path: request path, including optional query string
+ :param request_headers: request headers
+
+ """
+ if self._process_request is not None:
+ response = self._process_request(path, request_headers)
+ if isinstance(response, Awaitable):
+ return await response
+ else:
+ # For backwards compatibility with 7.0.
+ warnings.warn(
+ "declare process_request as a coroutine", DeprecationWarning
+ )
+ return response # type: ignore
+ return None
+
+ @staticmethod
+ def process_origin(
+ headers: Headers, origins: Optional[Sequence[Optional[Origin]]] = None
+ ) -> Optional[Origin]:
+ """
+ Handle the Origin HTTP request header.
+
+ :param headers: request headers
+ :param origins: optional list of acceptable origins
+ :raises ~websockets.exceptions.InvalidOrigin: if the origin isn't
+ acceptable
+
+ """
+ # "The user agent MUST NOT include more than one Origin header field"
+ # per https://tools.ietf.org/html/rfc6454#section-7.3.
+ try:
+ origin = cast(Optional[Origin], headers.get("Origin"))
+ except MultipleValuesError as exc:
+ raise InvalidHeader("Origin", "more than one Origin header found") from exc
+ if origins is not None:
+ if origin not in origins:
+ raise InvalidOrigin(origin)
+ return origin
+
+ @staticmethod
+ def process_extensions(
+ headers: Headers,
+ available_extensions: Optional[Sequence[ServerExtensionFactory]],
+ ) -> Tuple[Optional[str], List[Extension]]:
+ """
+ Handle the Sec-WebSocket-Extensions HTTP request header.
+
+ Accept or reject each extension proposed in the client request.
+ Negotiate parameters for accepted extensions.
+
+ Return the Sec-WebSocket-Extensions HTTP response header and the list
+ of accepted extensions.
+
+ :rfc:`6455` leaves the rules up to the specification of each
+ :extension.
+
+ To provide this level of flexibility, for each extension proposed by
+ the client, we check for a match with each extension available in the
+ server configuration. If no match is found, the extension is ignored.
+
+ If several variants of the same extension are proposed by the client,
+ it may be accepted several times, which won't make sense in general.
+ Extensions must implement their own requirements. For this purpose,
+ the list of previously accepted extensions is provided.
+
+ This process doesn't allow the server to reorder extensions. It can
+ only select a subset of the extensions proposed by the client.
+
+ Other requirements, for example related to mandatory extensions or the
+ order of extensions, may be implemented by overriding this method.
+
+ :param headers: request headers
+ :param extensions: optional list of supported extensions
+ :raises ~websockets.exceptions.InvalidHandshake: to abort the
+ handshake with an HTTP 400 error code
+
+ """
+ response_header_value: Optional[str] = None
+
+ extension_headers: List[ExtensionHeader] = []
+ accepted_extensions: List[Extension] = []
+
+ header_values = headers.get_all("Sec-WebSocket-Extensions")
+
+ if header_values and available_extensions:
+
+ parsed_header_values: List[ExtensionHeader] = sum(
+ [parse_extension(header_value) for header_value in header_values], []
+ )
+
+ for name, request_params in parsed_header_values:
+
+ for ext_factory in available_extensions:
+
+ # Skip non-matching extensions based on their name.
+ if ext_factory.name != name:
+ continue
+
+ # Skip non-matching extensions based on their params.
+ try:
+ response_params, extension = ext_factory.process_request_params(
+ request_params, accepted_extensions
+ )
+ except NegotiationError:
+ continue
+
+ # Add matching extension to the final list.
+ extension_headers.append((name, response_params))
+ accepted_extensions.append(extension)
+
+ # Break out of the loop once we have a match.
+ break
+
+ # If we didn't break from the loop, no extension in our list
+ # matched what the client sent. The extension is declined.
+
+ # Serialize extension header.
+ if extension_headers:
+ response_header_value = build_extension(extension_headers)
+
+ return response_header_value, accepted_extensions
+
+ # Not @staticmethod because it calls self.select_subprotocol()
+ def process_subprotocol(
+ self, headers: Headers, available_subprotocols: Optional[Sequence[Subprotocol]]
+ ) -> Optional[Subprotocol]:
+ """
+ Handle the Sec-WebSocket-Protocol HTTP request header.
+
+ Return Sec-WebSocket-Protocol HTTP response header, which is the same
+ as the selected subprotocol.
+
+ :param headers: request headers
+ :param available_subprotocols: optional list of supported subprotocols
+ :raises ~websockets.exceptions.InvalidHandshake: to abort the
+ handshake with an HTTP 400 error code
+
+ """
+ subprotocol: Optional[Subprotocol] = None
+
+ header_values = headers.get_all("Sec-WebSocket-Protocol")
+
+ if header_values and available_subprotocols:
+
+ parsed_header_values: List[Subprotocol] = sum(
+ [parse_subprotocol(header_value) for header_value in header_values], []
+ )
+
+ subprotocol = self.select_subprotocol(
+ parsed_header_values, available_subprotocols
+ )
+
+ return subprotocol
+
+ def select_subprotocol(
+ self,
+ client_subprotocols: Sequence[Subprotocol],
+ server_subprotocols: Sequence[Subprotocol],
+ ) -> Optional[Subprotocol]:
+ """
+ Pick a subprotocol among those offered by the client.
+
+ If several subprotocols are supported by the client and the server,
+ the default implementation selects the preferred subprotocols by
+ giving equal value to the priorities of the client and the server.
+
+ If no subprotocol is supported by the client and the server, it
+ proceeds without a subprotocol.
+
+ This is unlikely to be the most useful implementation in practice, as
+ many servers providing a subprotocol will require that the client uses
+ that subprotocol. Such rules can be implemented in a subclass.
+
+ Instead of subclassing, it is possible to override this method by
+ passing a ``select_subprotocol`` argument to the :func:`serve`
+ function or the :class:`WebSocketServerProtocol` constructor.
+
+ :param client_subprotocols: list of subprotocols offered by the client
+ :param server_subprotocols: list of subprotocols available on the server
+
+ """
+ if self._select_subprotocol is not None:
+ return self._select_subprotocol(client_subprotocols, server_subprotocols)
+
+ subprotocols = set(client_subprotocols) & set(server_subprotocols)
+ if not subprotocols:
+ return None
+ priority = lambda p: (
+ client_subprotocols.index(p) + server_subprotocols.index(p)
+ )
+ return sorted(subprotocols, key=priority)[0]
+
+ async def handshake(
+ self,
+ origins: Optional[Sequence[Optional[Origin]]] = None,
+ available_extensions: Optional[Sequence[ServerExtensionFactory]] = None,
+ available_subprotocols: Optional[Sequence[Subprotocol]] = None,
+ extra_headers: Optional[HeadersLikeOrCallable] = None,
+ ) -> str:
+ """
+ Perform the server side of the opening handshake.
+
+ Return the path of the URI of the request.
+
+ :param origins: list of acceptable values of the Origin HTTP header;
+ include ``None`` if the lack of an origin is acceptable
+ :param available_extensions: list of supported extensions in the order
+ in which they should be used
+ :param available_subprotocols: list of supported subprotocols in order
+ of decreasing preference
+ :param extra_headers: sets additional HTTP response headers when the
+ handshake succeeds; it can be a :class:`~websockets.http.Headers`
+ instance, a :class:`~collections.abc.Mapping`, an iterable of
+ ``(name, value)`` pairs, or a callable taking the request path and
+ headers in arguments and returning one of the above.
+ :raises ~websockets.exceptions.InvalidHandshake: if the handshake
+ fails
+
+ """
+ path, request_headers = await self.read_http_request()
+
+ # Hook for customizing request handling, for example checking
+ # authentication or treating some paths as plain HTTP endpoints.
+ early_response_awaitable = self.process_request(path, request_headers)
+ if isinstance(early_response_awaitable, Awaitable):
+ early_response = await early_response_awaitable
+ else:
+ # For backwards compatibility with 7.0.
+ warnings.warn("declare process_request as a coroutine", DeprecationWarning)
+ early_response = early_response_awaitable # type: ignore
+
+ # Change the response to a 503 error if the server is shutting down.
+ if not self.ws_server.is_serving():
+ early_response = (
+ http.HTTPStatus.SERVICE_UNAVAILABLE,
+ [],
+ b"Server is shutting down.\n",
+ )
+
+ if early_response is not None:
+ raise AbortHandshake(*early_response)
+
+ key = check_request(request_headers)
+
+ self.origin = self.process_origin(request_headers, origins)
+
+ extensions_header, self.extensions = self.process_extensions(
+ request_headers, available_extensions
+ )
+
+ protocol_header = self.subprotocol = self.process_subprotocol(
+ request_headers, available_subprotocols
+ )
+
+ response_headers = Headers()
+
+ build_response(response_headers, key)
+
+ if extensions_header is not None:
+ response_headers["Sec-WebSocket-Extensions"] = extensions_header
+
+ if protocol_header is not None:
+ response_headers["Sec-WebSocket-Protocol"] = protocol_header
+
+ if callable(extra_headers):
+ extra_headers = extra_headers(path, self.request_headers)
+ if extra_headers is not None:
+ if isinstance(extra_headers, Headers):
+ extra_headers = extra_headers.raw_items()
+ elif isinstance(extra_headers, collections.abc.Mapping):
+ extra_headers = extra_headers.items()
+ for name, value in extra_headers:
+ response_headers[name] = value
+
+ response_headers.setdefault("Date", email.utils.formatdate(usegmt=True))
+ response_headers.setdefault("Server", USER_AGENT)
+
+ self.write_http_response(http.HTTPStatus.SWITCHING_PROTOCOLS, response_headers)
+
+ self.connection_open()
+
+ return path
+
+
+class WebSocketServer:
+ """
+ WebSocket server returned by :func:`serve`.
+
+ This class provides the same interface as
+ :class:`~asyncio.AbstractServer`, namely the
+ :meth:`~asyncio.AbstractServer.close` and
+ :meth:`~asyncio.AbstractServer.wait_closed` methods.
+
+ It keeps track of WebSocket connections in order to close them properly
+ when shutting down.
+
+ Instances of this class store a reference to the :class:`~asyncio.Server`
+ object returned by :meth:`~asyncio.loop.create_server` rather than inherit
+ from :class:`~asyncio.Server` in part because
+ :meth:`~asyncio.loop.create_server` doesn't support passing a custom
+ :class:`~asyncio.Server` class.
+
+ """
+
+ def __init__(self, loop: asyncio.AbstractEventLoop) -> None:
+ # Store a reference to loop to avoid relying on self.server._loop.
+ self.loop = loop
+
+ # Keep track of active connections.
+ self.websockets: Set[WebSocketServerProtocol] = set()
+
+ # Task responsible for closing the server and terminating connections.
+ self.close_task: Optional[asyncio.Task[None]] = None
+
+ # Completed when the server is closed and connections are terminated.
+ self.closed_waiter: asyncio.Future[None] = loop.create_future()
+
+ def wrap(self, server: asyncio.AbstractServer) -> None:
+ """
+ Attach to a given :class:`~asyncio.Server`.
+
+ Since :meth:`~asyncio.loop.create_server` doesn't support injecting a
+ custom ``Server`` class, the easiest solution that doesn't rely on
+ private :mod:`asyncio` APIs is to:
+
+ - instantiate a :class:`WebSocketServer`
+ - give the protocol factory a reference to that instance
+ - call :meth:`~asyncio.loop.create_server` with the factory
+ - attach the resulting :class:`~asyncio.Server` with this method
+
+ """
+ self.server = server
+
+ def register(self, protocol: WebSocketServerProtocol) -> None:
+ """
+ Register a connection with this server.
+
+ """
+ self.websockets.add(protocol)
+
+ def unregister(self, protocol: WebSocketServerProtocol) -> None:
+ """
+ Unregister a connection with this server.
+
+ """
+ self.websockets.remove(protocol)
+
+ def is_serving(self) -> bool:
+ """
+ Tell whether the server is accepting new connections or shutting down.
+
+ """
+ try:
+ # Python ≥ 3.7
+ return self.server.is_serving()
+ except AttributeError: # pragma: no cover
+ # Python < 3.7
+ return self.server.sockets is not None
+
+ def close(self) -> None:
+ """
+ Close the server.
+
+ This method:
+
+ * closes the underlying :class:`~asyncio.Server`;
+ * rejects new WebSocket connections with an HTTP 503 (service
+ unavailable) error; this happens when the server accepted the TCP
+ connection but didn't complete the WebSocket opening handshake prior
+ to closing;
+ * closes open WebSocket connections with close code 1001 (going away).
+
+ :meth:`close` is idempotent.
+
+ """
+ if self.close_task is None:
+ self.close_task = self.loop.create_task(self._close())
+
+ async def _close(self) -> None:
+ """
+ Implementation of :meth:`close`.
+
+ This calls :meth:`~asyncio.Server.close` on the underlying
+ :class:`~asyncio.Server` object to stop accepting new connections and
+ then closes open connections with close code 1001.
+
+ """
+ # Stop accepting new connections.
+ self.server.close()
+
+ # Wait until self.server.close() completes.
+ await self.server.wait_closed()
+
+ # Wait until all accepted connections reach connection_made() and call
+ # register(). See https://bugs.python.org/issue34852 for details.
+ await asyncio.sleep(
+ 0, loop=self.loop if sys.version_info[:2] < (3, 8) else None
+ )
+
+ # Close OPEN connections with status code 1001. Since the server was
+ # closed, handshake() closes OPENING conections with a HTTP 503 error.
+ # Wait until all connections are closed.
+
+ # asyncio.wait doesn't accept an empty first argument
+ if self.websockets:
+ await asyncio.wait(
+ [
+ asyncio.ensure_future(websocket.close(1001))
+ for websocket in self.websockets
+ ],
+ loop=self.loop if sys.version_info[:2] < (3, 8) else None,
+ )
+
+ # Wait until all connection handlers are complete.
+
+ # asyncio.wait doesn't accept an empty first argument.
+ if self.websockets:
+ await asyncio.wait(
+ [websocket.handler_task for websocket in self.websockets],
+ loop=self.loop if sys.version_info[:2] < (3, 8) else None,
+ )
+
+ # Tell wait_closed() to return.
+ self.closed_waiter.set_result(None)
+
+ async def wait_closed(self) -> None:
+ """
+ Wait until the server is closed.
+
+ When :meth:`wait_closed` returns, all TCP connections are closed and
+ all connection handlers have returned.
+
+ """
+ await asyncio.shield(self.closed_waiter)
+
+ @property
+ def sockets(self) -> Optional[List[socket.socket]]:
+ """
+ List of :class:`~socket.socket` objects the server is listening to.
+
+ ``None`` if the server is closed.
+
+ """
+ return self.server.sockets
+
+
+class Serve:
+ """
+
+ Create, start, and return a WebSocket server on ``host`` and ``port``.
+
+ Whenever a client connects, the server accepts the connection, creates a
+ :class:`WebSocketServerProtocol`, performs the opening handshake, and
+ delegates to the connection handler defined by ``ws_handler``. Once the
+ handler completes, either normally or with an exception, the server
+ performs the closing handshake and closes the connection.
+
+ Awaiting :func:`serve` yields a :class:`WebSocketServer`. This instance
+ provides :meth:`~WebSocketServer.close` and
+ :meth:`~WebSocketServer.wait_closed` methods for terminating the server
+ and cleaning up its resources.
+
+ When a server is closed with :meth:`~WebSocketServer.close`, it closes all
+ connections with close code 1001 (going away). Connections handlers, which
+ are running the ``ws_handler`` coroutine, will receive a
+ :exc:`~websockets.exceptions.ConnectionClosedOK` exception on their
+ current or next interaction with the WebSocket connection.
+
+ :func:`serve` can also be used as an asynchronous context manager::
+
+ stop = asyncio.Future() # set this future to exit the server
+
+ async with serve(...):
+ await stop
+
+ In this case, the server is shut down when exiting the context.
+
+ :func:`serve` is a wrapper around the event loop's
+ :meth:`~asyncio.loop.create_server` method. It creates and starts a
+ :class:`asyncio.Server` with :meth:`~asyncio.loop.create_server`. Then it
+ wraps the :class:`asyncio.Server` in a :class:`WebSocketServer` and
+ returns the :class:`WebSocketServer`.
+
+ ``ws_handler`` is the WebSocket handler. It must be a coroutine accepting
+ two arguments: the WebSocket connection, which is an instance of
+ :class:`WebSocketServerProtocol`, and the path of the request.
+
+ The ``host`` and ``port`` arguments, as well as unrecognized keyword
+ arguments, are passed to :meth:`~asyncio.loop.create_server`.
+
+ For example, you can set the ``ssl`` keyword argument to a
+ :class:`~ssl.SSLContext` to enable TLS.
+
+ ``create_protocol`` defaults to :class:`WebSocketServerProtocol`. It may
+ be replaced by a wrapper or a subclass to customize the protocol that
+ manages the connection.
+
+ The behavior of ``ping_interval``, ``ping_timeout``, ``close_timeout``,
+ ``max_size``, ``max_queue``, ``read_limit``, and ``write_limit`` is
+ described in :class:`WebSocketServerProtocol`.
+
+ :func:`serve` also accepts the following optional arguments:
+
+ * ``compression`` is a shortcut to configure compression extensions;
+ by default it enables the "permessage-deflate" extension; set it to
+ ``None`` to disable compression.
+ * ``origins`` defines acceptable Origin HTTP headers; include ``None`` in
+ the list if the lack of an origin is acceptable.
+ * ``extensions`` is a list of supported extensions in order of
+ decreasing preference.
+ * ``subprotocols`` is a list of supported subprotocols in order of
+ decreasing preference.
+ * ``extra_headers`` sets additional HTTP response headers when the
+ handshake succeeds; it can be a :class:`~websockets.http.Headers`
+ instance, a :class:`~collections.abc.Mapping`, an iterable of ``(name,
+ value)`` pairs, or a callable taking the request path and headers in
+ arguments and returning one of the above.
+ * ``process_request`` allows intercepting the HTTP request; it must be a
+ coroutine taking the request path and headers in argument; see
+ :meth:`~WebSocketServerProtocol.process_request` for details.
+ * ``select_subprotocol`` allows customizing the logic for selecting a
+ subprotocol; it must be a callable taking the subprotocols offered by
+ the client and available on the server in argument; see
+ :meth:`~WebSocketServerProtocol.select_subprotocol` for details.
+
+ Since there's no useful way to propagate exceptions triggered in handlers,
+ they're sent to the ``"websockets.server"`` logger instead.
+ Debugging is much easier if you configure logging to print them::
+
+ import logging
+ logger = logging.getLogger("websockets.server")
+ logger.setLevel(logging.ERROR)
+ logger.addHandler(logging.StreamHandler())
+
+ """
+
+ def __init__(
+ self,
+ ws_handler: Callable[[WebSocketServerProtocol, str], Awaitable[Any]],
+ host: Optional[Union[str, Sequence[str]]] = None,
+ port: Optional[int] = None,
+ *,
+ create_protocol: Optional[Callable[[Any], WebSocketServerProtocol]] = None,
+ ping_interval: Optional[float] = 20,
+ ping_timeout: Optional[float] = 20,
+ close_timeout: Optional[float] = None,
+ max_size: Optional[int] = 2 ** 20,
+ max_queue: Optional[int] = 2 ** 5,
+ read_limit: int = 2 ** 16,
+ write_limit: int = 2 ** 16,
+ loop: Optional[asyncio.AbstractEventLoop] = None,
+ compression: Optional[str] = "deflate",
+ origins: Optional[Sequence[Optional[Origin]]] = None,
+ extensions: Optional[Sequence[ServerExtensionFactory]] = None,
+ subprotocols: Optional[Sequence[Subprotocol]] = None,
+ extra_headers: Optional[HeadersLikeOrCallable] = None,
+ process_request: Optional[
+ Callable[[str, Headers], Awaitable[Optional[HTTPResponse]]]
+ ] = None,
+ select_subprotocol: Optional[
+ Callable[[Sequence[Subprotocol], Sequence[Subprotocol]], Subprotocol]
+ ] = None,
+ **kwargs: Any,
+ ) -> None:
+ # Backwards compatibility: close_timeout used to be called timeout.
+ timeout: Optional[float] = kwargs.pop("timeout", None)
+ if timeout is None:
+ timeout = 10
+ else:
+ warnings.warn("rename timeout to close_timeout", DeprecationWarning)
+ # If both are specified, timeout is ignored.
+ if close_timeout is None:
+ close_timeout = timeout
+
+ # Backwards compatibility: create_protocol used to be called klass.
+ klass: Optional[Type[WebSocketServerProtocol]] = kwargs.pop("klass", None)
+ if klass is None:
+ klass = WebSocketServerProtocol
+ else:
+ warnings.warn("rename klass to create_protocol", DeprecationWarning)
+ # If both are specified, klass is ignored.
+ if create_protocol is None:
+ create_protocol = klass
+
+ # Backwards compatibility: recv() used to return None on closed connections
+ legacy_recv: bool = kwargs.pop("legacy_recv", False)
+
+ if loop is None:
+ loop = asyncio.get_event_loop()
+
+ ws_server = WebSocketServer(loop)
+
+ secure = kwargs.get("ssl") is not None
+
+ if compression == "deflate":
+ extensions = enable_server_permessage_deflate(extensions)
+ elif compression is not None:
+ raise ValueError(f"unsupported compression: {compression}")
+
+ factory = functools.partial(
+ create_protocol,
+ ws_handler,
+ ws_server,
+ host=host,
+ port=port,
+ secure=secure,
+ ping_interval=ping_interval,
+ ping_timeout=ping_timeout,
+ close_timeout=close_timeout,
+ max_size=max_size,
+ max_queue=max_queue,
+ read_limit=read_limit,
+ write_limit=write_limit,
+ loop=loop,
+ legacy_recv=legacy_recv,
+ origins=origins,
+ extensions=extensions,
+ subprotocols=subprotocols,
+ extra_headers=extra_headers,
+ process_request=process_request,
+ select_subprotocol=select_subprotocol,
+ )
+
+ if kwargs.pop("unix", False):
+ path: Optional[str] = kwargs.pop("path", None)
+ # unix_serve(path) must not specify host and port parameters.
+ assert host is None and port is None
+ create_server = functools.partial(
+ loop.create_unix_server, factory, path, **kwargs
+ )
+ else:
+ create_server = functools.partial(
+ loop.create_server, factory, host, port, **kwargs
+ )
+
+ # This is a coroutine function.
+ self._create_server = create_server
+ self.ws_server = ws_server
+
+ # async with serve(...)
+
+ async def __aenter__(self) -> WebSocketServer:
+ return await self
+
+ async def __aexit__(
+ self,
+ exc_type: Optional[Type[BaseException]],
+ exc_value: Optional[BaseException],
+ traceback: Optional[TracebackType],
+ ) -> None:
+ self.ws_server.close()
+ await self.ws_server.wait_closed()
+
+ # await serve(...)
+
+ def __await__(self) -> Generator[Any, None, WebSocketServer]:
+ # Create a suitable iterator by calling __await__ on a coroutine.
+ return self.__await_impl__().__await__()
+
+ async def __await_impl__(self) -> WebSocketServer:
+ server = await self._create_server()
+ self.ws_server.wrap(server)
+ return self.ws_server
+
+ # yield from serve(...)
+
+ __iter__ = __await__
+
+
+serve = Serve
+
+
+def unix_serve(
+ ws_handler: Callable[[WebSocketServerProtocol, str], Awaitable[Any]],
+ path: Optional[str] = None,
+ **kwargs: Any,
+) -> Serve:
+ """
+ Similar to :func:`serve`, but for listening on Unix sockets.
+
+ This function calls the event loop's
+ :meth:`~asyncio.loop.create_unix_server` method.
+
+ It is only available on Unix.
+
+ It's useful for deploying a server behind a reverse proxy such as nginx.
+
+ :param path: file system path to the Unix socket
+
+ """
+ return serve(ws_handler, path=path, unix=True, **kwargs)
diff --git a/src/websockets/protocol.py b/src/websockets/protocol.py
deleted file mode 100644
index ae87c450b..000000000
--- a/src/websockets/protocol.py
+++ /dev/null
@@ -1,1251 +0,0 @@
-"""
-The :mod:`websockets.protocol` module handles WebSocket control and data
-frames as specified in `sections 4 to 8 of RFC 6455`_.
-
-.. _sections 4 to 8 of RFC 6455: http://tools.ietf.org/html/rfc6455#section-4
-
-"""
-
-import asyncio
-import binascii
-import codecs
-import collections
-import collections.abc
-import enum
-import logging
-import random
-import struct
-import sys
-import warnings
-
-from .compatibility import asyncio_ensure_future
-from .exceptions import (
- ConnectionClosed,
- InvalidState,
- PayloadTooBig,
- WebSocketProtocolError,
-)
-from .framing import *
-from .handshake import *
-
-
-__all__ = ['WebSocketCommonProtocol']
-
-logger = logging.getLogger(__name__)
-
-
-# On Python ≥ 3.7, silence a deprecation warning that we can't address before
-# dropping support for Python < 3.5.
-warnings.filterwarnings(
- action='ignore',
- message=r"'with \(yield from lock\)' is deprecated use 'async with lock' instead",
- category=DeprecationWarning,
-)
-
-
-# A WebSocket connection goes through the following four states, in order:
-
-
-class State(enum.IntEnum):
- CONNECTING, OPEN, CLOSING, CLOSED = range(4)
-
-
-# In order to ensure consistency, the code always checks the current value of
-# WebSocketCommonProtocol.state before assigning a new value and never yields
-# between the check and the assignment.
-
-
-class WebSocketCommonProtocol(asyncio.StreamReaderProtocol):
- """
- This class implements common parts of the WebSocket protocol.
-
- It assumes that the WebSocket connection is established. The handshake is
- managed in subclasses such as
- :class:`~websockets.server.WebSocketServerProtocol` and
- :class:`~websockets.client.WebSocketClientProtocol`.
-
- It runs a task that stores incoming data frames in a queue and deals with
- control frames automatically. It sends outgoing data frames and performs
- the closing handshake.
-
- On Python ≥ 3.6, :class:`WebSocketCommonProtocol` instances support
- asynchronous iteration::
-
- async for message in websocket:
- await process(message)
-
- The iterator yields incoming messages. It exits normally when the
- connection is closed with the close code 1000 (OK) or 1001 (going away).
- It raises a :exc:`~websockets.exceptions.ConnectionClosed` exception when
- the connection is closed with any other status code.
-
- The ``host``, ``port`` and ``secure`` parameters are simply stored as
- attributes for handlers that need them.
-
- Once the connection is open, a `Ping frame`_ is sent every
- ``ping_interval`` seconds. This serves as a keepalive. It helps keeping
- the connection open, especially in the presence of proxies with short
- timeouts. Set ``ping_interval`` to ``None`` to disable this behavior.
-
- .. _Ping frame: https://tools.ietf.org/html/rfc6455#section-5.5.2
-
- If the corresponding `Pong frame`_ isn't received within ``ping_timeout``
- seconds, the connection is considered unusable and is closed with status
- code 1011. This ensures that the remote endpoint remains responsive. Set
- ``ping_timeout`` to ``None`` to disable this behavior.
-
- .. _Pong frame: https://tools.ietf.org/html/rfc6455#section-5.5.3
-
- The ``close_timeout`` parameter defines a maximum wait time in seconds for
- completing the closing handshake and terminating the TCP connection.
- :meth:`close()` completes in at most ``4 * close_timeout`` on the server
- side and ``5 * close_timeout`` on the client side.
-
- ``close_timeout`` needs to be a parameter of the protocol because
- websockets usually calls :meth:`close()` implicitly:
-
- - on the server side, when the connection handler terminates,
- - on the client side, when exiting the context manager for the connection.
-
- To apply a timeout to any other API, wrap it in :func:`~asyncio.wait_for`.
-
- The ``max_size`` parameter enforces the maximum size for incoming messages
- in bytes. The default value is 1MB. ``None`` disables the limit. If a
- message larger than the maximum size is received, :meth:`recv()` will
- raise :exc:`~websockets.exceptions.ConnectionClosed` and the connection
- will be closed with status code 1009.
-
- The ``max_queue`` parameter sets the maximum length of the queue that holds
- incoming messages. The default value is 32. 0 disables the limit. Messages
- are added to an in-memory queue when they're received; then :meth:`recv()`
- pops from that queue. In order to prevent excessive memory consumption when
- messages are received faster than they can be processed, the queue must be
- bounded. If the queue fills up, the protocol stops processing incoming data
- until :meth:`recv()` is called. In this situation, various receive buffers
- (at least in ``asyncio`` and in the OS) will fill up, then the TCP receive
- window will shrink, slowing down transmission to avoid packet loss.
-
- Since Python can use up to 4 bytes of memory to represent a single
- character, each websocket connection may use up to ``4 * max_size *
- max_queue`` bytes of memory to store incoming messages. By default,
- this is 128MB. You may want to lower the limits, depending on your
- application's requirements.
-
- The ``read_limit`` argument sets the high-water limit of the buffer for
- incoming bytes. The low-water limit is half the high-water limit. The
- default value is 64kB, half of asyncio's default (based on the current
- implementation of :class:`~asyncio.StreamReader`).
-
- The ``write_limit`` argument sets the high-water limit of the buffer for
- outgoing bytes. The low-water limit is a quarter of the high-water limit.
- The default value is 64kB, equal to asyncio's default (based on the
- current implementation of ``FlowControlMixin``).
-
- As soon as the HTTP request and response in the opening handshake are
- processed:
-
- * the request path is available in the :attr:`path` attribute;
- * the request and response HTTP headers are available in the
- :attr:`request_headers` and :attr:`response_headers` attributes,
- which are :class:`~websockets.http.Headers` instances.
-
- These attributes must be treated as immutable.
-
- If a subprotocol was negotiated, it's available in the :attr:`subprotocol`
- attribute.
-
- Once the connection is closed, the status code is available in the
- :attr:`close_code` attribute and the reason in :attr:`close_reason`.
-
- """
-
- # There are only two differences between the client-side and the server-
- # side behavior: masking the payload and closing the underlying TCP
- # connection. Set is_client and side to pick a side.
- is_client = None
- side = 'undefined'
-
- def __init__(
- self,
- *,
- host=None,
- port=None,
- secure=None,
- ping_interval=20,
- ping_timeout=20,
- close_timeout=None,
- max_size=2 ** 20,
- max_queue=2 ** 5,
- read_limit=2 ** 16,
- write_limit=2 ** 16,
- loop=None,
- legacy_recv=False,
- timeout=10
- ):
- # Backwards-compatibility: close_timeout used to be called timeout.
- # If both are specified, timeout is ignored.
- if close_timeout is None:
- close_timeout = timeout
-
- self.host = host
- self.port = port
- self.secure = secure
- self.ping_interval = ping_interval
- self.ping_timeout = ping_timeout
- self.close_timeout = close_timeout
- self.max_size = max_size
- self.max_queue = max_queue
- self.read_limit = read_limit
- self.write_limit = write_limit
-
- # Store a reference to loop to avoid relying on self._loop, a private
- # attribute of StreamReaderProtocol, inherited from FlowControlMixin.
- if loop is None:
- loop = asyncio.get_event_loop()
- self.loop = loop
-
- self.legacy_recv = legacy_recv
-
- # Configure read buffer limits. The high-water limit is defined by
- # ``self.read_limit``. The ``limit`` argument controls the line length
- # limit and half the buffer limit of :class:`~asyncio.StreamReader`.
- # That's why it must be set to half of ``self.read_limit``.
- stream_reader = asyncio.StreamReader(limit=read_limit // 2, loop=loop)
- super().__init__(stream_reader, self.client_connected, loop)
-
- self.reader = None
- self.writer = None
- self._drain_lock = asyncio.Lock(loop=loop)
-
- # This class implements the data transfer and closing handshake, which
- # are shared between the client-side and the server-side.
- # Subclasses implement the opening handshake and, on success, execute
- # :meth:`connection_open()` to change the state to OPEN.
- self.state = State.CONNECTING
- logger.debug("%s - state = CONNECTING", self.side)
-
- # HTTP protocol parameters.
- self.path = None
- self.request_headers = None
- self.response_headers = None
-
- # WebSocket protocol parameters.
- self.extensions = []
- self.subprotocol = None
-
- # The close code and reason are set when receiving a close frame or
- # losing the TCP connection.
- self.close_code = None
- self.close_reason = ''
-
- # Completed when the connection state becomes CLOSED. Translates the
- # :meth:`connection_lost()` callback to a :class:`~asyncio.Future`
- # that can be awaited. (Other :class:`~asyncio.Protocol` callbacks are
- # translated by ``self.stream_reader``).
- self.connection_lost_waiter = asyncio.Future(loop=loop)
-
- # Queue of received messages.
- self.messages = collections.deque()
- self._pop_message_waiter = None
- self._put_message_waiter = None
-
- # Mapping of ping IDs to waiters, in chronological order.
- self.pings = collections.OrderedDict()
-
- # Task running the data transfer.
- self.transfer_data_task = None
-
- # Exception that occurred during data transfer, if any.
- self.transfer_data_exc = None
-
- # Task sending keepalive pings.
- self.keepalive_ping_task = None
-
- # Task closing the TCP connection.
- self.close_connection_task = None
-
- def client_connected(self, reader, writer):
- """
- Callback when the TCP connection is established.
-
- Record references to the stream reader and the stream writer to avoid
- using private attributes ``_stream_reader`` and ``_stream_writer`` of
- :class:`~asyncio.StreamReaderProtocol`.
-
- """
- self.reader = reader
- self.writer = writer
-
- def connection_open(self):
- """
- Callback when the WebSocket opening handshake completes.
-
- Enter the OPEN state and start the data transfer phase.
-
- """
- # 4.1. The WebSocket Connection is Established.
- assert self.state is State.CONNECTING
- self.state = State.OPEN
- logger.debug("%s - state = OPEN", self.side)
- # Start the task that receives incoming WebSocket messages.
- self.transfer_data_task = asyncio_ensure_future(
- self.transfer_data(), loop=self.loop
- )
- # Start the task that sends pings at regular intervals.
- self.keepalive_ping_task = asyncio_ensure_future(
- self.keepalive_ping(), loop=self.loop
- )
- # Start the task that eventually closes the TCP connection.
- self.close_connection_task = asyncio_ensure_future(
- self.close_connection(), loop=self.loop
- )
-
- # Public API
-
- @property
- def local_address(self):
- """
- Local address of the connection.
-
- This is a ``(host, port)`` tuple or ``None`` if the connection hasn't
- been established yet.
-
- """
- if self.writer is None:
- return None
- return self.writer.get_extra_info('sockname')
-
- @property
- def remote_address(self):
- """
- Remote address of the connection.
-
- This is a ``(host, port)`` tuple or ``None`` if the connection hasn't
- been established yet.
-
- """
- if self.writer is None:
- return None
- return self.writer.get_extra_info('peername')
-
- @property
- def open(self):
- """
- This property is ``True`` when the connection is usable.
-
- It may be used to detect disconnections but this is discouraged per
- the EAFP_ principle. When ``open`` is ``False``, using the connection
- raises a :exc:`~websockets.exceptions.ConnectionClosed` exception.
-
- .. _EAFP: https://docs.python.org/3/glossary.html#term-eafp
-
- """
- return self.state is State.OPEN and not self.transfer_data_task.done()
-
- @property
- def closed(self):
- """
- This property is ``True`` once the connection is closed.
-
- Be aware that both :attr:`open` and :attr`closed` are ``False`` during
- the opening and closing sequences.
-
- """
- return self.state is State.CLOSED
-
- @asyncio.coroutine
- def wait_closed(self):
- """
- Wait until the connection is closed.
-
- This is identical to :attr:`closed`, except it can be awaited.
-
- This can make it easier to handle connection termination, regardless
- of its cause, in tasks that interact with the WebSocket connection.
-
- """
- yield from asyncio.shield(self.connection_lost_waiter)
-
- @asyncio.coroutine
- def recv(self):
- """
- This coroutine receives the next message.
-
- It returns a :class:`str` for a text frame and :class:`bytes` for a
- binary frame.
-
- When the end of the message stream is reached, :meth:`recv` raises
- :exc:`~websockets.exceptions.ConnectionClosed`. This can happen after
- a normal connection closure, a protocol error or a network failure.
-
- .. versionchanged:: 3.0
-
- :meth:`recv` used to return ``None`` instead. Refer to the
- changelog for details.
-
- Canceling :meth:`recv` is safe. There's no risk of losing the next
- message. The next invocation of :meth:`recv` will return it. This
- makes it possible to enforce a timeout by wrapping :meth:`recv` in
- :func:`~asyncio.wait_for`.
-
- .. versionchanged:: 7.0
-
- Calling :meth:`recv` concurrently raises :exc:`RuntimeError`.
-
- """
- if self._pop_message_waiter is not None:
- raise RuntimeError(
- "cannot call recv() while another coroutine "
- "is already waiting for the next message"
- )
-
- # Don't yield from self.ensure_open() here:
- # - messages could be available in the queue even if the connection
- # is closed;
- # - messages could be received before the closing frame even if the
- # connection is closing.
-
- # Wait until there's a message in the queue (if necessary) or the
- # connection is closed.
- while len(self.messages) <= 0:
- pop_message_waiter = asyncio.Future(loop=self.loop)
- self._pop_message_waiter = pop_message_waiter
- try:
- # If asyncio.wait() is canceled, it doesn't cancel
- # pop_message_waiter and self.transfer_data_task.
- yield from asyncio.wait(
- [pop_message_waiter, self.transfer_data_task],
- loop=self.loop,
- return_when=asyncio.FIRST_COMPLETED,
- )
- finally:
- self._pop_message_waiter = None
-
- # If asyncio.wait(...) exited because self.transfer_data_task
- # completed before receiving a new message, raise a suitable
- # exception (or return None if legacy_recv is enabled).
- if not pop_message_waiter.done():
- if self.legacy_recv:
- return
- else:
- assert self.state in [State.CLOSING, State.CLOSED]
- # Wait until the connection is closed to raise
- # ConnectionClosed with the correct code and reason.
- yield from self.ensure_open()
-
- # Pop a message from the queue.
- message = self.messages.popleft()
-
- # Notify transfer_data().
- if self._put_message_waiter is not None:
- self._put_message_waiter.set_result(None)
- self._put_message_waiter = None
-
- return message
-
- @asyncio.coroutine
- def send(self, data):
- """
- This coroutine sends a message.
-
- It sends :class:`str` as a text frame and :class:`bytes` as a binary
- frame.
-
- It also accepts an iterable of :class:`str` or :class:`bytes`. Each
- item is treated as a message fragment and sent in its own frame. All
- items must be of the same type, or else :meth:`send` will raise a
- :exc:`TypeError` and the connection will be closed.
-
- It raises a :exc:`TypeError` for other inputs.
-
- """
- yield from self.ensure_open()
-
- # Unfragmented message (first because str and bytes are iterable).
-
- if isinstance(data, str):
- yield from self.write_frame(True, OP_TEXT, data.encode('utf-8'))
-
- elif isinstance(data, bytes):
- yield from self.write_frame(True, OP_BINARY, data)
-
- # Fragmented message -- regular iterator.
-
- elif isinstance(data, collections.abc.Iterable):
- iter_data = iter(data)
-
- # First fragment.
- try:
- data = next(iter_data)
- except StopIteration:
- return
- data_type = type(data)
- if isinstance(data, str):
- yield from self.write_frame(False, OP_TEXT, data.encode('utf-8'))
- encode_data = True
- elif isinstance(data, bytes):
- yield from self.write_frame(False, OP_BINARY, data)
- encode_data = False
- else:
- raise TypeError("data must be an iterable of bytes or str")
-
- # Other fragments.
- for data in iter_data:
- if type(data) != data_type:
- # We're half-way through a fragmented message and we can't
- # complete it. This makes the connection unusable.
- self.fail_connection(1011)
- raise TypeError("data contains inconsistent types")
- if encode_data:
- data = data.encode('utf-8')
- yield from self.write_frame(False, OP_CONT, data)
-
- # Final fragment.
- yield from self.write_frame(True, OP_CONT, type(data)())
-
- # Fragmented message -- asynchronous iterator
-
- # To be implemented after dropping support for Python 3.4.
-
- else:
- raise TypeError("data must be bytes, str, or iterable")
-
- @asyncio.coroutine
- def close(self, code=1000, reason=''):
- """
- This coroutine performs the closing handshake.
-
- It waits for the other end to complete the handshake and for the TCP
- connection to terminate. As a consequence, there's no need to await
- :meth:`wait_closed`; :meth:`close` already does it.
-
- :meth:`close` is idempotent: it doesn't do anything once the
- connection is closed.
-
- It's safe to wrap this coroutine in :func:`~asyncio.ensure_future`
- since errors during connection termination aren't particularly useful.
-
- ``code`` must be an :class:`int` and ``reason`` a :class:`str`.
-
- """
- try:
- yield from asyncio.wait_for(
- self.write_close_frame(serialize_close(code, reason)),
- self.close_timeout,
- loop=self.loop,
- )
- except asyncio.TimeoutError:
- # If the close frame cannot be sent because the send buffers
- # are full, the closing handshake won't complete anyway.
- # Fail the connection to shut down faster.
- self.fail_connection()
-
- # If no close frame is received within the timeout, wait_for() cancels
- # the data transfer task and raises TimeoutError.
-
- # If close() is called multiple times concurrently and one of these
- # calls hits the timeout, the data transfer task will be cancelled.
- # Other calls will receive a CancelledError here.
-
- try:
- # If close() is canceled during the wait, self.transfer_data_task
- # is canceled before the timeout elapses (on Python ≥ 3.4.3).
- # This helps closing connections when shutting down a server.
- yield from asyncio.wait_for(
- self.transfer_data_task, self.close_timeout, loop=self.loop
- )
- except (asyncio.TimeoutError, asyncio.CancelledError):
- pass
-
- # Wait for the close connection task to close the TCP connection.
- yield from asyncio.shield(self.close_connection_task)
-
- @asyncio.coroutine
- def ping(self, data=None):
- """
- This coroutine sends a ping.
-
- It returns a :class:`~asyncio.Future` which will be completed when the
- corresponding pong is received and which you may ignore if you don't
- want to wait.
-
- A ping may serve as a keepalive or as a check that the remote endpoint
- received all messages up to this point::
-
- pong_waiter = await ws.ping()
- await pong_waiter # only if you want to wait for the pong
-
- By default, the ping contains four random bytes. The content may be
- overridden with the optional ``data`` argument which must be of type
- :class:`str` (which will be encoded to UTF-8) or :class:`bytes`.
-
- """
- yield from self.ensure_open()
-
- if data is not None:
- data = encode_data(data)
-
- # Protect against duplicates if a payload is explicitly set.
- if data in self.pings:
- raise ValueError("Already waiting for a pong with the same data")
-
- # Generate a unique random payload otherwise.
- while data is None or data in self.pings:
- data = struct.pack('!I', random.getrandbits(32))
-
- self.pings[data] = asyncio.Future(loop=self.loop)
-
- yield from self.write_frame(True, OP_PING, data)
-
- return asyncio.shield(self.pings[data])
-
- @asyncio.coroutine
- def pong(self, data=b''):
- """
- This coroutine sends a pong.
-
- An unsolicited pong may serve as a unidirectional heartbeat.
-
- The content may be overridden with the optional ``data`` argument
- which must be of type :class:`str` (which will be encoded to UTF-8) or
- :class:`bytes`.
-
- """
- yield from self.ensure_open()
-
- data = encode_data(data)
-
- yield from self.write_frame(True, OP_PONG, data)
-
- # Private methods - no guarantees.
-
- @asyncio.coroutine
- def ensure_open(self):
- """
- Check that the WebSocket connection is open.
-
- Raise :exc:`~websockets.exceptions.ConnectionClosed` if it isn't.
-
- """
- # Handle cases from most common to least common for performance.
- if self.state is State.OPEN:
- # If self.transfer_data_task exited without a closing handshake,
- # self.close_connection_task may be closing it, going straight
- # from OPEN to CLOSED.
- if self.transfer_data_task.done():
- yield from asyncio.shield(self.close_connection_task)
- raise ConnectionClosed(
- self.close_code, self.close_reason
- ) from self.transfer_data_exc
- else:
- return
-
- if self.state is State.CLOSED:
- raise ConnectionClosed(
- self.close_code, self.close_reason
- ) from self.transfer_data_exc
-
- if self.state is State.CLOSING:
- # If we started the closing handshake, wait for its completion to
- # get the proper close code and status. self.close_connection_task
- # will complete within 4 or 5 * close_timeout after close(). The
- # CLOSING state also occurs when failing the connection. In that
- # case self.close_connection_task will complete even faster.
- if self.close_code is None:
- yield from asyncio.shield(self.close_connection_task)
- raise ConnectionClosed(
- self.close_code, self.close_reason
- ) from self.transfer_data_exc
-
- # Control may only reach this point in buggy third-party subclasses.
- assert self.state is State.CONNECTING
- raise InvalidState("WebSocket connection isn't established yet")
-
- @asyncio.coroutine
- def transfer_data(self):
- """
- Read incoming messages and put them in a queue.
-
- This coroutine runs in a task until the closing handshake is started.
-
- """
- try:
- while True:
- message = yield from self.read_message()
-
- # Exit the loop when receiving a close frame.
- if message is None:
- break
-
- # Wait until there's room in the queue (if necessary).
- while len(self.messages) >= self.max_queue:
- self._put_message_waiter = asyncio.Future(loop=self.loop)
- try:
- yield from self._put_message_waiter
- finally:
- self._put_message_waiter = None
-
- # Put the message in the queue.
- self.messages.append(message)
-
- # Notify recv().
- if self._pop_message_waiter is not None:
- self._pop_message_waiter.set_result(None)
- self._pop_message_waiter = None
-
- except asyncio.CancelledError as exc:
- self.transfer_data_exc = exc
- # If fail_connection() cancels this task, avoid logging the error
- # twice and failing the connection again.
- raise
-
- except WebSocketProtocolError as exc:
- self.transfer_data_exc = exc
- self.fail_connection(1002)
-
- except (ConnectionError, EOFError) as exc:
- # Reading data with self.reader.readexactly may raise:
- # - most subclasses of ConnectionError if the TCP connection
- # breaks, is reset, or is aborted;
- # - IncompleteReadError, a subclass of EOFError, if fewer
- # bytes are available than requested.
- self.transfer_data_exc = exc
- self.fail_connection(1006)
-
- except UnicodeDecodeError as exc:
- self.transfer_data_exc = exc
- self.fail_connection(1007)
-
- except PayloadTooBig as exc:
- self.transfer_data_exc = exc
- self.fail_connection(1009)
-
- except Exception as exc:
- # This shouldn't happen often because exceptions expected under
- # regular circumstances are handled above. If it does, consider
- # catching and handling more exceptions.
- logger.error("Error in data transfer", exc_info=True)
-
- self.transfer_data_exc = exc
- self.fail_connection(1011)
-
- @asyncio.coroutine
- def read_message(self):
- """
- Read a single message from the connection.
-
- Re-assemble data frames if the message is fragmented.
-
- Return ``None`` when the closing handshake is started.
-
- """
- frame = yield from self.read_data_frame(max_size=self.max_size)
-
- # A close frame was received.
- if frame is None:
- return
-
- if frame.opcode == OP_TEXT:
- text = True
- elif frame.opcode == OP_BINARY:
- text = False
- else: # frame.opcode == OP_CONT
- raise WebSocketProtocolError("Unexpected opcode")
-
- # Shortcut for the common case - no fragmentation
- if frame.fin:
- return frame.data.decode('utf-8') if text else frame.data
-
- # 5.4. Fragmentation
- chunks = []
- max_size = self.max_size
- if text:
- decoder = codecs.getincrementaldecoder('utf-8')(errors='strict')
- if max_size is None:
-
- def append(frame):
- nonlocal chunks
- chunks.append(decoder.decode(frame.data, frame.fin))
-
- else:
-
- def append(frame):
- nonlocal chunks, max_size
- chunks.append(decoder.decode(frame.data, frame.fin))
- max_size -= len(frame.data)
-
- else:
- if max_size is None:
-
- def append(frame):
- nonlocal chunks
- chunks.append(frame.data)
-
- else:
-
- def append(frame):
- nonlocal chunks, max_size
- chunks.append(frame.data)
- max_size -= len(frame.data)
-
- append(frame)
-
- while not frame.fin:
- frame = yield from self.read_data_frame(max_size=max_size)
- if frame is None:
- raise WebSocketProtocolError("Incomplete fragmented message")
- if frame.opcode != OP_CONT:
- raise WebSocketProtocolError("Unexpected opcode")
- append(frame)
-
- return ('' if text else b'').join(chunks)
-
- @asyncio.coroutine
- def read_data_frame(self, max_size):
- """
- Read a single data frame from the connection.
-
- Process control frames received before the next data frame.
-
- Return ``None`` if a close frame is encountered before any data frame.
-
- """
- # 6.2. Receiving Data
- while True:
- frame = yield from self.read_frame(max_size)
-
- # 5.5. Control Frames
- if frame.opcode == OP_CLOSE:
- # 7.1.5. The WebSocket Connection Close Code
- # 7.1.6. The WebSocket Connection Close Reason
- self.close_code, self.close_reason = parse_close(frame.data)
- # Echo the original data instead of re-serializing it with
- # serialize_close() because that fails when the close frame is
- # empty and parse_close() synthetizes a 1005 close code.
- yield from self.write_close_frame(frame.data)
- return
-
- elif frame.opcode == OP_PING:
- # Answer pings.
- # Replace by frame.data.hex() when dropping Python < 3.5.
- ping_hex = binascii.hexlify(frame.data).decode() or '[empty]'
- logger.debug(
- "%s - received ping, sending pong: %s", self.side, ping_hex
- )
- yield from self.pong(frame.data)
-
- elif frame.opcode == OP_PONG:
- # Acknowledge pings on solicited pongs.
- if frame.data in self.pings:
- # Acknowledge all pings up to the one matching this pong.
- ping_id = None
- ping_ids = []
- while ping_id != frame.data:
- ping_id, pong_waiter = self.pings.popitem(0)
- ping_ids.append(ping_id)
- pong_waiter.set_result(None)
- pong_hex = binascii.hexlify(frame.data).decode() or '[empty]'
- logger.debug(
- "%s - received solicited pong: %s", self.side, pong_hex
- )
- ping_ids = ping_ids[:-1]
- if ping_ids:
- pings_hex = ', '.join(
- binascii.hexlify(ping_id).decode() or '[empty]'
- for ping_id in ping_ids
- )
- plural = 's' if len(ping_ids) > 1 else ''
- logger.debug(
- "%s - acknowledged previous ping%s: %s",
- self.side,
- plural,
- pings_hex,
- )
- else:
- pong_hex = binascii.hexlify(frame.data).decode() or '[empty]'
- logger.debug(
- "%s - received unsolicited pong: %s", self.side, pong_hex
- )
-
- # 5.6. Data Frames
- else:
- return frame
-
- @asyncio.coroutine
- def read_frame(self, max_size):
- """
- Read a single frame from the connection.
-
- """
- frame = yield from Frame.read(
- self.reader.readexactly,
- mask=not self.is_client,
- max_size=max_size,
- extensions=self.extensions,
- )
- logger.debug("%s < %s", self.side, frame)
- return frame
-
- @asyncio.coroutine
- def write_frame(self, fin, opcode, data, *, _expected_state=State.OPEN):
- # Defensive assertion for protocol compliance.
- if self.state is not _expected_state: # pragma: no cover
- raise InvalidState(
- "Cannot write to a WebSocket " "in the {} state".format(self.state.name)
- )
-
- frame = Frame(fin, opcode, data)
- logger.debug("%s > %s", self.side, frame)
- frame.write(self.writer.write, mask=self.is_client, extensions=self.extensions)
-
- # Backport of https://github.com/python/asyncio/pull/280.
- # Remove when dropping support for Python < 3.6.
- if self.writer.transport is not None: # pragma: no cover
- if self.writer_is_closing():
- yield
-
- try:
- # drain() cannot be called concurrently by multiple coroutines:
- # http://bugs.python.org/issue29930. Remove this lock when no
- # version of Python where this bugs exists is supported anymore.
- with (yield from self._drain_lock):
- # Handle flow control automatically.
- yield from self.writer.drain()
- except ConnectionError:
- # Terminate the connection if the socket died.
- self.fail_connection()
- # Wait until the connection is closed to raise ConnectionClosed
- # with the correct code and reason.
- yield from self.ensure_open()
-
- def writer_is_closing(self):
- """
- Backport of https://github.com/python/asyncio/pull/291.
-
- Replace with ``self.writer.transport.is_closing()`` when dropping
- support for Python < 3.6 and with ``self.writer.is_closing()`` when
- https://bugs.python.org/issue31491 is fixed.
-
- """
- transport = self.writer.transport
- try:
- return transport.is_closing()
- except AttributeError: # pragma: no cover
- # This emulates what is_closing would return if it existed.
- try:
- return transport._closing
- except AttributeError:
- return transport._closed
-
- @asyncio.coroutine
- def write_close_frame(self, data=b''):
- """
- Write a close frame if and only if the connection state is OPEN.
-
- This dedicated coroutine must be used for writing close frames to
- ensure that at most one close frame is sent on a given connection.
-
- """
- # Test and set the connection state before sending the close frame to
- # avoid sending two frames in case of concurrent calls.
- if self.state is State.OPEN:
- # 7.1.3. The WebSocket Closing Handshake is Started
- self.state = State.CLOSING
- logger.debug("%s - state = CLOSING", self.side)
-
- # 7.1.2. Start the WebSocket Closing Handshake
- yield from self.write_frame(
- True, OP_CLOSE, data, _expected_state=State.CLOSING
- )
-
- @asyncio.coroutine
- def keepalive_ping(self):
- """
- Send a Ping frame and wait for a Pong frame at regular intervals.
-
- This coroutine exits when the connection terminates and one of the
- following happens:
- - :meth:`ping` raises :exc:`ConnectionClosed`, or
- - :meth:`close_connection` cancels :attr:`keepalive_ping_task`.
-
- """
- if self.ping_interval is None:
- return
-
- try:
- while True:
- yield from asyncio.sleep(self.ping_interval, loop=self.loop)
-
- # ping() cannot raise ConnectionClosed, only CancelledError:
- # - If the connection is CLOSING, keepalive_ping_task will be
- # canceled by close_connection() before ping() returns.
- # - If the connection is CLOSED, keepalive_ping_task must be
- # canceled already.
- ping_waiter = yield from self.ping()
-
- if self.ping_timeout is not None:
- try:
- yield from asyncio.wait_for(
- ping_waiter, self.ping_timeout, loop=self.loop
- )
- except asyncio.TimeoutError:
- logger.debug("%s ! timed out waiting for pong", self.side)
- self.fail_connection(1011)
- break
-
- except asyncio.CancelledError:
- raise
-
- except Exception:
- logger.warning("Unexpected exception in keepalive ping task", exc_info=True)
-
- @asyncio.coroutine
- def close_connection(self):
- """
- 7.1.1. Close the WebSocket Connection
-
- When the opening handshake succeeds, :meth:`connection_open` starts
- this coroutine in a task. It waits for the data transfer phase to
- complete then it closes the TCP connection cleanly.
-
- When the opening handshake fails, :meth:`fail_connection` does the
- same. There's no data transfer phase in that case.
-
- """
- try:
- # Wait for the data transfer phase to complete.
- if self.transfer_data_task is not None:
- try:
- yield from self.transfer_data_task
- except asyncio.CancelledError:
- pass
-
- # Cancel the keepalive ping task.
- if self.keepalive_ping_task is not None:
- self.keepalive_ping_task.cancel()
-
- # A client should wait for a TCP close from the server.
- if self.is_client and self.transfer_data_task is not None:
- if (yield from self.wait_for_connection_lost()):
- return
- logger.debug("%s ! timed out waiting for TCP close", self.side)
-
- # Half-close the TCP connection if possible (when there's no TLS).
- if self.writer.can_write_eof():
- logger.debug("%s x half-closing TCP connection", self.side)
- self.writer.write_eof()
-
- if (yield from self.wait_for_connection_lost()):
- return
- logger.debug("%s ! timed out waiting for TCP close", self.side)
-
- finally:
- # The try/finally ensures that the transport never remains open,
- # even if this coroutine is canceled (for example).
-
- # If connection_lost() was called, the TCP connection is closed.
- # However, if TLS is enabled, the transport still needs closing.
- # Else asyncio complains: ResourceWarning: unclosed transport.
- if self.connection_lost_waiter.done() and not self.secure:
- return
-
- # Close the TCP connection. Buffers are flushed asynchronously.
- logger.debug("%s x closing TCP connection", self.side)
- self.writer.close()
-
- if (yield from self.wait_for_connection_lost()):
- return
- logger.debug("%s ! timed out waiting for TCP close", self.side)
-
- # Abort the TCP connection. Buffers are discarded.
- logger.debug("%s x aborting TCP connection", self.side)
- self.writer.transport.abort()
-
- # connection_lost() is called quickly after aborting.
- yield from self.wait_for_connection_lost()
-
- @asyncio.coroutine
- def wait_for_connection_lost(self):
- """
- Wait until the TCP connection is closed or ``self.close_timeout`` elapses.
-
- Return ``True`` if the connection is closed and ``False`` otherwise.
-
- """
- if not self.connection_lost_waiter.done():
- try:
- yield from asyncio.wait_for(
- asyncio.shield(self.connection_lost_waiter),
- self.close_timeout,
- loop=self.loop,
- )
- except asyncio.TimeoutError:
- pass
- # Re-check self.connection_lost_waiter.done() synchronously because
- # connection_lost() could run between the moment the timeout occurs
- # and the moment this coroutine resumes running.
- return self.connection_lost_waiter.done()
-
- def fail_connection(self, code=1006, reason=''):
- """
- 7.1.7. Fail the WebSocket Connection
-
- This requires:
-
- 1. Stopping all processing of incoming data, which means cancelling
- :attr:`transfer_data_task`. The close code will be 1006 unless a
- close frame was received earlier.
-
- 2. Sending a close frame with an appropriate code if the opening
- handshake succeeded and the other side is likely to process it.
-
- 3. Closing the connection. :meth:`close_connection` takes care of
- this once :attr:`transfer_data_task` exits after being canceled.
-
- (The specification describes these steps in the opposite order.)
-
- """
- logger.debug(
- "%s ! failing WebSocket connection in the %s state: %d %s",
- self.side,
- self.state.name,
- code,
- reason or '[no reason]',
- )
-
- # Cancel transfer_data_task if the opening handshake succeeded.
- # cancel() is idempotent and ignored if the task is done already.
- if self.transfer_data_task is not None:
- self.transfer_data_task.cancel()
-
- # Send a close frame when the state is OPEN (a close frame was already
- # sent if it's CLOSING), except when failing the connection because of
- # an error reading from or writing to the network.
- # Don't send a close frame if the connection is broken.
- if code != 1006 and self.state is State.OPEN:
-
- frame_data = serialize_close(code, reason)
-
- # Write the close frame without draining the write buffer.
-
- # Keeping fail_connection() synchronous guarantees it can't
- # get stuck and simplifies the implementation of the callers.
- # Not drainig the write buffer is acceptable in this context.
-
- # This duplicates a few lines of code from write_close_frame()
- # and write_frame().
-
- self.state = State.CLOSING
- logger.debug("%s - state = CLOSING", self.side)
-
- frame = Frame(True, OP_CLOSE, frame_data)
- logger.debug("%s > %s", self.side, frame)
- frame.write(
- self.writer.write, mask=self.is_client, extensions=self.extensions
- )
-
- # Start close_connection_task if the opening handshake didn't succeed.
- if self.close_connection_task is None:
- self.close_connection_task = asyncio_ensure_future(
- self.close_connection(), loop=self.loop
- )
-
- def abort_keepalive_pings(self):
- """
- Raise ConnectionClosed in pending keepalive pings.
-
- They'll never receive a pong once the connection is closed.
-
- """
- assert self.state is State.CLOSED
- exc = ConnectionClosed(self.close_code, self.close_reason)
- exc.__cause__ = self.transfer_data_exc # emulate raise ... from ...
-
- for ping in self.pings.values():
- ping.set_exception(exc)
-
- if self.pings:
- pings_hex = ', '.join(
- binascii.hexlify(ping_id).decode() or '[empty]'
- for ping_id in self.pings
- )
- plural = 's' if len(self.pings) > 1 else ''
- logger.debug(
- "%s - aborted pending ping%s: %s", self.side, plural, pings_hex
- )
-
- # asyncio.StreamReaderProtocol methods
-
- def connection_made(self, transport):
- """
- Configure write buffer limits.
-
- The high-water limit is defined by ``self.write_limit``.
-
- The low-water limit currently defaults to ``self.write_limit // 4`` in
- :meth:`~asyncio.WriteTransport.set_write_buffer_limits`, which should
- be all right for reasonable use cases of this library.
-
- This is the earliest point where we can get hold of the transport,
- which means it's the best point for configuring it.
-
- """
- logger.debug("%s - event = connection_made(%s)", self.side, transport)
- transport.set_write_buffer_limits(self.write_limit)
- super().connection_made(transport)
-
- def eof_received(self):
- """
- Close the transport after receiving EOF.
-
- Since Python 3.5, `:meth:~StreamReaderProtocol.eof_received` returns
- ``True`` on non-TLS connections.
-
- See http://bugs.python.org/issue24539 for more information.
-
- This is inappropriate for websockets for at least three reasons:
-
- 1. The use case is to read data until EOF with self.reader.read(-1).
- Since websockets is a TLV protocol, this never happens.
-
- 2. It doesn't work on TLS connections. A falsy value must be
- returned to have the same behavior on TLS and plain connections.
-
- 3. The websockets protocol has its own closing handshake. Endpoints
- close the TCP connection after sending a close frame.
-
- As a consequence we revert to the previous, more useful behavior.
-
- """
- logger.debug("%s - event = eof_received()", self.side)
- super().eof_received()
- return
-
- def connection_lost(self, exc):
- """
- 7.1.4. The WebSocket Connection is Closed.
-
- """
- logger.debug("%s - event = connection_lost(%s)", self.side, exc)
- self.state = State.CLOSED
- logger.debug("%s - state = CLOSED", self.side)
- if self.close_code is None:
- self.close_code = 1006
- logger.debug(
- "%s x code = %d, reason = %s",
- self.side,
- self.close_code,
- self.close_reason or '[no reason]',
- )
- self.abort_keepalive_pings()
- # If self.connection_lost_waiter isn't pending, that's a bug, because:
- # - it's set only here in connection_lost() which is called only once;
- # - it must never be canceled.
- self.connection_lost_waiter.set_result(None)
- super().connection_lost(exc)
-
-
-if sys.version_info[:2] >= (3, 6): # pragma: no cover
- from .py36.protocol import __aiter__
-
- WebSocketCommonProtocol.__aiter__ = __aiter__
diff --git a/tests/py36/__init__.py b/src/websockets/py.typed
similarity index 100%
rename from tests/py36/__init__.py
rename to src/websockets/py.typed
diff --git a/src/websockets/py35/__init__.py b/src/websockets/py35/__init__.py
deleted file mode 100644
index 9612d9dd7..000000000
--- a/src/websockets/py35/__init__.py
+++ /dev/null
@@ -1,2 +0,0 @@
-# This package contains code using async / await syntax added in Python 3.5.
-# It cannot be imported on Python < 3.5 because it triggers syntax errors.
diff --git a/src/websockets/py35/client.py b/src/websockets/py35/client.py
deleted file mode 100644
index a016ba437..000000000
--- a/src/websockets/py35/client.py
+++ /dev/null
@@ -1,35 +0,0 @@
-async def __aenter__(self):
- return await self
-
-
-async def __aexit__(self, exc_type, exc_value, traceback):
- await self.ws_client.close()
-
-
-async def __await_impl__(self):
- # Duplicated with __iter__ because Python 3.7 requires an async function
- # (as explained in __await__ below) which Python 3.4 doesn't support.
- transport, protocol = await self._creating_connection
-
- try:
- await protocol.handshake(
- self._wsuri,
- origin=self._origin,
- available_extensions=protocol.available_extensions,
- available_subprotocols=protocol.available_subprotocols,
- extra_headers=protocol.extra_headers,
- )
- except Exception:
- protocol.fail_connection()
- await protocol.wait_closed()
- raise
-
- self.ws_client = protocol
- return protocol
-
-
-def __await__(self):
- # __await__() must return a type that I don't know how to obtain except
- # by calling __await__() on the return value of an async function.
- # I'm not finding a better way to take advantage of PEP 492.
- return __await_impl__(self).__await__()
diff --git a/src/websockets/py35/server.py b/src/websockets/py35/server.py
deleted file mode 100644
index 41a3675e3..000000000
--- a/src/websockets/py35/server.py
+++ /dev/null
@@ -1,22 +0,0 @@
-async def __aenter__(self):
- return await self
-
-
-async def __aexit__(self, exc_type, exc_value, traceback):
- self.ws_server.close()
- await self.ws_server.wait_closed()
-
-
-async def __await_impl__(self):
- # Duplicated with __iter__ because Python 3.7 requires an async function
- # (as explained in __await__ below) which Python 3.4 doesn't support.
- server = await self._creating_server
- self.ws_server.wrap(server)
- return self.ws_server
-
-
-def __await__(self):
- # __await__() must return a type that I don't know how to obtain except
- # by calling __await__() on the return value of an async function.
- # I'm not finding a better way to take advantage of PEP 492.
- return __await_impl__(self).__await__()
diff --git a/src/websockets/py36/__init__.py b/src/websockets/py36/__init__.py
deleted file mode 100644
index b9211bf87..000000000
--- a/src/websockets/py36/__init__.py
+++ /dev/null
@@ -1,2 +0,0 @@
-# This package contains code using async iteration added in Python 3.6.
-# It cannot be imported on Python < 3.6 because it triggers syntax errors.
diff --git a/src/websockets/py36/protocol.py b/src/websockets/py36/protocol.py
deleted file mode 100644
index f0784de05..000000000
--- a/src/websockets/py36/protocol.py
+++ /dev/null
@@ -1,20 +0,0 @@
-from ..exceptions import ConnectionClosed
-
-
-async def __aiter__(self):
- """
- Iterate on received messages.
-
- Exit normally when the connection is closed with code 1000.
-
- Raise an exception in other cases.
-
- """
- try:
- while True:
- yield await self.recv()
- except ConnectionClosed as exc:
- if exc.code == 1000 or exc.code == 1001:
- return
- else:
- raise
diff --git a/src/websockets/server.py b/src/websockets/server.py
index 556c270d4..f57d36b70 100644
--- a/src/websockets/server.py
+++ b/src/websockets/server.py
@@ -1,301 +1,247 @@
-"""
-The :mod:`websockets.server` module defines a simple WebSocket server API.
-
-"""
-
-import asyncio
-import collections.abc
+import base64
+import binascii
+import collections
import email.utils
+import http
import logging
-import sys
-import warnings
-
-from .compatibility import (
- BAD_REQUEST,
- FORBIDDEN,
- INTERNAL_SERVER_ERROR,
- SWITCHING_PROTOCOLS,
- UPGRADE_REQUIRED,
- asyncio_ensure_future,
-)
+from typing import Callable, Generator, List, Optional, Sequence, Tuple, Union, cast
+
+from .connection import CONNECTING, OPEN, SERVER, Connection
+from .datastructures import Headers, HeadersLike, MultipleValuesError
from .exceptions import (
- AbortHandshake,
- CancelHandshake,
InvalidHandshake,
InvalidHeader,
- InvalidMessage,
+ InvalidHeaderValue,
InvalidOrigin,
InvalidUpgrade,
NegotiationError,
)
-from .extensions.permessage_deflate import ServerPerMessageDeflateFactory
-from .handshake import build_response, check_request
-from .headers import build_extension_list, parse_extension_list, parse_subprotocol_list
-from .http import USER_AGENT, Headers, MultipleValuesError, read_request
-from .protocol import State, WebSocketCommonProtocol
+from .extensions.base import Extension, ServerExtensionFactory
+from .headers import (
+ build_extension,
+ parse_connection,
+ parse_extension,
+ parse_subprotocol,
+ parse_upgrade,
+)
+from .http import USER_AGENT
+from .http11 import Request, Response
+from .typing import (
+ ConnectionOption,
+ ExtensionHeader,
+ Origin,
+ Subprotocol,
+ UpgradeProtocol,
+)
+from .utils import accept_key
-__all__ = ['serve', 'unix_serve', 'WebSocketServerProtocol']
+# See #940 for why lazy_import isn't used here for backwards compatibility.
+from .legacy.server import * # isort:skip # noqa
-logger = logging.getLogger(__name__)
+__all__ = ["ServerConnection"]
+
+logger = logging.getLogger(__name__)
-class WebSocketServerProtocol(WebSocketCommonProtocol):
- """
- Complete WebSocket server implementation as an :class:`asyncio.Protocol`.
- This class inherits most of its methods from
- :class:`~websockets.protocol.WebSocketCommonProtocol`.
+HeadersLikeOrCallable = Union[HeadersLike, Callable[[str, Headers], HeadersLike]]
- For the sake of simplicity, it doesn't rely on a full HTTP implementation.
- Its support for HTTP responses is very limited.
- """
+class ServerConnection(Connection):
- is_client = False
- side = 'server'
+ side = SERVER
def __init__(
self,
- ws_handler,
- ws_server,
- *,
- origins=None,
- extensions=None,
- subprotocols=None,
- extra_headers=None,
- process_request=None,
- select_subprotocol=None,
- **kwds
+ origins: Optional[Sequence[Optional[Origin]]] = None,
+ extensions: Optional[Sequence[ServerExtensionFactory]] = None,
+ subprotocols: Optional[Sequence[Subprotocol]] = None,
+ extra_headers: Optional[HeadersLikeOrCallable] = None,
+ max_size: Optional[int] = 2 ** 20,
):
- # For backwards-compatibility with 6.0 or earlier.
- if origins is not None and '' in origins:
- warnings.warn("use None instead of '' in origins", DeprecationWarning)
- origins = [None if origin == '' else origin for origin in origins]
- self.ws_handler = ws_handler
- self.ws_server = ws_server
+ super().__init__(side=SERVER, state=CONNECTING, max_size=max_size)
self.origins = origins
self.available_extensions = extensions
self.available_subprotocols = subprotocols
self.extra_headers = extra_headers
- if process_request is not None:
- self.process_request = process_request
- if select_subprotocol is not None:
- self.select_subprotocol = select_subprotocol
- super().__init__(**kwds)
- def connection_made(self, transport):
+ def accept(self, request: Request) -> Response:
"""
- Register connection and initialize a task to handle it.
+ Create a WebSocket handshake response event to send to the client.
- """
- super().connection_made(transport)
- # Register the connection with the server before creating the handler
- # task. Registering at the beginning of the handler coroutine would
- # create a race condition between the creation of the task, which
- # schedules its execution, and the moment the handler starts running.
- self.ws_server.register(self)
- self.handler_task = asyncio_ensure_future(self.handler(), loop=self.loop)
-
- @asyncio.coroutine
- def handler(self):
- """
- Handle the lifecycle of a WebSocket connection.
-
- Since this method doesn't have a caller able to handle exceptions, it
- attemps to log relevant ones and guarantees that the TCP connection is
- closed before exiting.
+ If the connection cannot be established, the response rejects the
+ connection, which may be unexpected.
"""
+ # TODO: when changing Request to a dataclass, set the exception
+ # attribute on the request rather than the Response, which will
+ # be semantically more correct.
try:
+ key, extensions_header, protocol_header = self.process_request(request)
+ except InvalidOrigin as exc:
+ logger.debug("Invalid origin", exc_info=True)
+ return self.reject(
+ http.HTTPStatus.FORBIDDEN,
+ f"Failed to open a WebSocket connection: {exc}.\n",
+ )._replace(exception=exc)
+ except InvalidUpgrade as exc:
+ logger.debug("Invalid upgrade", exc_info=True)
+ return self.reject(
+ http.HTTPStatus.UPGRADE_REQUIRED,
+ (
+ f"Failed to open a WebSocket connection: {exc}.\n"
+ f"\n"
+ f"You cannot access a WebSocket server directly "
+ f"with a browser. You need a WebSocket client.\n"
+ ),
+ headers=Headers([("Upgrade", "websocket")]),
+ )._replace(exception=exc)
+ except InvalidHandshake as exc:
+ logger.debug("Invalid handshake", exc_info=True)
+ return self.reject(
+ http.HTTPStatus.BAD_REQUEST,
+ f"Failed to open a WebSocket connection: {exc}.\n",
+ )._replace(exception=exc)
+ except Exception as exc:
+ logger.warning("Error in opening handshake", exc_info=True)
+ return self.reject(
+ http.HTTPStatus.INTERNAL_SERVER_ERROR,
+ (
+ "Failed to open a WebSocket connection.\n"
+ "See server log for more information.\n"
+ ),
+ )._replace(exception=exc)
+
+ headers = Headers()
+
+ headers["Upgrade"] = "websocket"
+ headers["Connection"] = "Upgrade"
+ headers["Sec-WebSocket-Accept"] = accept_key(key)
- try:
- path = yield from self.handshake(
- origins=self.origins,
- available_extensions=self.available_extensions,
- available_subprotocols=self.available_subprotocols,
- extra_headers=self.extra_headers,
- )
- except ConnectionError:
- logger.debug("Connection error in opening handshake", exc_info=True)
- raise
- except CancelHandshake:
- self.fail_connection()
- yield from self.wait_closed()
- return
- except Exception as exc:
- if isinstance(exc, AbortHandshake):
- status, headers, body = exc.status, exc.headers, exc.body
- elif isinstance(exc, InvalidOrigin):
- logger.debug("Invalid origin", exc_info=True)
- status, headers, body = FORBIDDEN, [], (str(exc) + "\n").encode()
- elif isinstance(exc, InvalidUpgrade):
- logger.debug("Invalid upgrade", exc_info=True)
- status, headers, body = (
- UPGRADE_REQUIRED,
- [('Upgrade', 'websocket')],
- (str(exc) + "\n").encode(),
- )
- elif isinstance(exc, InvalidHandshake):
- logger.debug("Invalid handshake", exc_info=True)
- status, headers, body = (
- BAD_REQUEST,
- [],
- (str(exc) + "\n").encode(),
- )
- else:
- logger.warning("Error in opening handshake", exc_info=True)
- status, headers, body = (
- INTERNAL_SERVER_ERROR,
- [],
- b"See server log for more information.\n",
- )
-
- if not isinstance(headers, Headers):
- headers = Headers(headers)
-
- headers.setdefault('Date', email.utils.formatdate(usegmt=True))
- headers.setdefault('Server', USER_AGENT)
- headers.setdefault('Content-Length', str(len(body)))
- headers.setdefault('Content-Type', 'text/plain')
- headers.setdefault('Connection', 'close')
-
- yield from self.write_http_response(status, headers, body)
- self.fail_connection()
- yield from self.wait_closed()
- return
-
- try:
- yield from self.ws_handler(self, path)
- except Exception:
- logger.error("Error in connection handler", exc_info=True)
- if not self.closed:
- self.fail_connection(1011)
- raise
-
- try:
- yield from self.close()
- except ConnectionError:
- logger.debug("Connection error in closing handshake", exc_info=True)
- raise
- except Exception:
- logger.warning("Error in closing handshake", exc_info=True)
- raise
-
- except Exception:
- # Last-ditch attempt to avoid leaking connections on errors.
- try:
- self.writer.close()
- except Exception: # pragma: no cover
- pass
-
- finally:
- # Unregister the connection with the server when the handler task
- # terminates. Registration is tied to the lifecycle of the handler
- # task because the server waits for tasks attached to registered
- # connections before terminating.
- self.ws_server.unregister(self)
-
- @asyncio.coroutine
- def read_http_request(self):
- """
- Read request line and headers from the HTTP request.
-
- Raise :exc:`~websockets.exceptions.InvalidMessage` if the HTTP message
- is malformed or isn't an HTTP/1.1 GET request.
+ if extensions_header is not None:
+ headers["Sec-WebSocket-Extensions"] = extensions_header
- Don't attempt to read the request body because WebSocket handshake
- requests don't have one. If the request contains a body, it may be
- read from ``self.reader`` after this coroutine returns.
+ if protocol_header is not None:
+ headers["Sec-WebSocket-Protocol"] = protocol_header
- """
- try:
- path, headers = yield from read_request(self.reader)
- except ValueError as exc:
- raise InvalidMessage("Malformed HTTP message") from exc
+ extra_headers: Optional[HeadersLike]
+ if callable(self.extra_headers):
+ extra_headers = self.extra_headers(request.path, request.headers)
+ else:
+ extra_headers = self.extra_headers
+ if extra_headers is not None:
+ if isinstance(extra_headers, Headers):
+ extra_headers = extra_headers.raw_items()
+ elif isinstance(extra_headers, collections.abc.Mapping):
+ extra_headers = extra_headers.items()
+ for name, value in extra_headers:
+ headers[name] = value
- self.path = path
- self.request_headers = headers
+ headers.setdefault("Date", email.utils.formatdate(usegmt=True))
+ headers.setdefault("Server", USER_AGENT)
- return path, self.request_headers
+ return Response(101, "Switching Protocols", headers)
- @asyncio.coroutine
- def write_http_response(self, status, headers, body=None):
+ def process_request(
+ self, request: Request
+ ) -> Tuple[str, Optional[str], Optional[str]]:
"""
- Write status line and headers to the HTTP response.
+ Check a handshake request received from the client.
+
+ This function doesn't verify that the request is an HTTP/1.1 or higher GET
+ request and doesn't perform ``Host`` and ``Origin`` checks. These controls
+ are usually performed earlier in the HTTP request handling code. They're
+ the responsibility of the caller.
- This coroutine is also able to write a response body.
+ :param request: request
+ :returns: ``key`` which must be passed to :func:`build_response`
+ :raises ~websockets.exceptions.InvalidHandshake: if the handshake request
+ is invalid; then the server must return 400 Bad Request error
"""
- self.response_headers = headers
+ headers = request.headers
- # Since the status line and headers only contain ASCII characters,
- # we can keep this simple.
- response = 'HTTP/1.1 {status.value} {status.phrase}\r\n'.format(status=status)
- response += str(headers)
+ connection: List[ConnectionOption] = sum(
+ [parse_connection(value) for value in headers.get_all("Connection")], []
+ )
- self.writer.write(response.encode())
+ if not any(value.lower() == "upgrade" for value in connection):
+ raise InvalidUpgrade(
+ "Connection", ", ".join(connection) if connection else None
+ )
- if body is not None:
- self.writer.write(body)
+ upgrade: List[UpgradeProtocol] = sum(
+ [parse_upgrade(value) for value in headers.get_all("Upgrade")], []
+ )
- @asyncio.coroutine
- def process_request(self, path, request_headers):
- """
- Intercept the HTTP request and return an HTTP response if needed.
+ # For compatibility with non-strict implementations, ignore case when
+ # checking the Upgrade header. The RFC always uses "websocket", except
+ # in section 11.2. (IANA registration) where it uses "WebSocket".
+ if not (len(upgrade) == 1 and upgrade[0].lower() == "websocket"):
+ raise InvalidUpgrade("Upgrade", ", ".join(upgrade) if upgrade else None)
- ``request_headers`` is a :class:`~websockets.http.Headers` instance.
+ try:
+ key = headers["Sec-WebSocket-Key"]
+ except KeyError as exc:
+ raise InvalidHeader("Sec-WebSocket-Key") from exc
+ except MultipleValuesError as exc:
+ raise InvalidHeader(
+ "Sec-WebSocket-Key", "more than one Sec-WebSocket-Key header found"
+ ) from exc
- If this coroutine returns ``None``, the WebSocket handshake continues.
- If it returns a status code, headers and a response body, that HTTP
- response is sent and the connection is closed.
+ try:
+ raw_key = base64.b64decode(key.encode(), validate=True)
+ except binascii.Error as exc:
+ raise InvalidHeaderValue("Sec-WebSocket-Key", key) from exc
+ if len(raw_key) != 16:
+ raise InvalidHeaderValue("Sec-WebSocket-Key", key)
- The HTTP status must be a :class:`~http.HTTPStatus`.
- (:class:`~http.HTTPStatus` was added in Python 3.5. Use a compatible
- object on earlier versions. Look at ``SWITCHING_PROTOCOLS`` in
- ``websockets.compatibility`` for an example.)
+ try:
+ version = headers["Sec-WebSocket-Version"]
+ except KeyError as exc:
+ raise InvalidHeader("Sec-WebSocket-Version") from exc
+ except MultipleValuesError as exc:
+ raise InvalidHeader(
+ "Sec-WebSocket-Version",
+ "more than one Sec-WebSocket-Version header found",
+ ) from exc
- HTTP headers must be a :class:`~websockets.http.Headers` instance, a
- :class:`~collections.abc.Mapping`, or an iterable of ``(name, value)``
- pairs.
+ if version != "13":
+ raise InvalidHeaderValue("Sec-WebSocket-Version", version)
- The HTTP response body must be :class:`bytes`. It may be empty.
+ self.origin = self.process_origin(headers)
- This method may be overridden to check the request headers and set a
- different status, for example to authenticate the request and return
- ``HTTPStatus.UNAUTHORIZED`` or ``HTTPStatus.FORBIDDEN``.
+ extensions_header, self.extensions = self.process_extensions(headers)
- It is declared as a coroutine because such authentication checks are
- likely to require network requests.
+ protocol_header = self.subprotocol = self.process_subprotocol(headers)
- This coroutine may be overridden by passing a ``process_request``
- argument to the :class:`WebSocketServerProtocol` constructor or the
- :func:`serve` function.
+ return key, extensions_header, protocol_header
- """
-
- @staticmethod
- def process_origin(headers, origins=None):
+ def process_origin(self, headers: Headers) -> Optional[Origin]:
"""
Handle the Origin HTTP request header.
- Raise :exc:`~websockets.exceptions.InvalidOrigin` if the origin isn't
- acceptable.
+ :param headers: request headers
+ :raises ~websockets.exceptions.InvalidOrigin: if the origin isn't
+ acceptable
"""
# "The user agent MUST NOT include more than one Origin header field"
# per https://tools.ietf.org/html/rfc6454#section-7.3.
try:
- origin = headers.get('Origin')
- except MultipleValuesError:
- raise InvalidHeader('Origin', "more than one Origin header found")
- if origins is not None:
- if origin not in origins:
+ origin = cast(Optional[Origin], headers.get("Origin"))
+ except MultipleValuesError as exc:
+ raise InvalidHeader("Origin", "more than one Origin header found") from exc
+ if self.origins is not None:
+ if origin not in self.origins:
raise InvalidOrigin(origin)
return origin
- @staticmethod
- def process_extensions(headers, available_extensions):
+ def process_extensions(
+ self,
+ headers: Headers,
+ ) -> Tuple[Optional[str], List[Extension]]:
"""
Handle the Sec-WebSocket-Extensions HTTP request header.
@@ -305,10 +251,6 @@ def process_extensions(headers, available_extensions):
Return the Sec-WebSocket-Extensions HTTP response header and the list
of accepted extensions.
- Raise :exc:`~websockets.exceptions.InvalidHandshake` to abort the
- handshake with an HTTP 400 error code. (The default implementation
- never does this.)
-
:rfc:`6455` leaves the rules up to the specification of each
:extension.
@@ -317,7 +259,7 @@ def process_extensions(headers, available_extensions):
server configuration. If no match is found, the extension is ignored.
If several variants of the same extension are proposed by the client,
- it may be accepted severel times, which won't make sense in general.
+ it may be accepted several times, which won't make sense in general.
Extensions must implement their own requirements. For this purpose,
the list of previously accepted extensions is provided.
@@ -327,22 +269,27 @@ def process_extensions(headers, available_extensions):
Other requirements, for example related to mandatory extensions or the
order of extensions, may be implemented by overriding this method.
+ :param headers: request headers
+ :raises ~websockets.exceptions.InvalidHandshake: to abort the
+ handshake with an HTTP 400 error code
+
"""
- response_header = []
- accepted_extensions = []
+ response_header_value: Optional[str] = None
+
+ extension_headers: List[ExtensionHeader] = []
+ accepted_extensions: List[Extension] = []
- header_values = headers.get_all('Sec-WebSocket-Extensions')
+ header_values = headers.get_all("Sec-WebSocket-Extensions")
- if header_values and available_extensions:
+ if header_values and self.available_extensions:
- parsed_header_values = sum(
- [parse_extension_list(header_value) for header_value in header_values],
- [],
+ parsed_header_values: List[ExtensionHeader] = sum(
+ [parse_extension(header_value) for header_value in header_values], []
)
for name, request_params in parsed_header_values:
- for ext_factory in available_extensions:
+ for ext_factory in self.available_extensions:
# Skip non-matching extensions based on their name.
if ext_factory.name != name:
@@ -357,7 +304,7 @@ def process_extensions(headers, available_extensions):
continue
# Add matching extension to the final list.
- response_header.append((name, response_params))
+ extension_headers.append((name, response_params))
accepted_extensions.append(extension)
# Break out of the loop once we have a match.
@@ -367,44 +314,44 @@ def process_extensions(headers, available_extensions):
# matched what the client sent. The extension is declined.
# Serialize extension header.
- if response_header:
- response_header = build_extension_list(response_header)
- else:
- response_header = None
+ if extension_headers:
+ response_header_value = build_extension(extension_headers)
- return response_header, accepted_extensions
+ return response_header_value, accepted_extensions
- # Not @staticmethod because it calls self.select_subprotocol()
- def process_subprotocol(self, headers, available_subprotocols):
+ def process_subprotocol(self, headers: Headers) -> Optional[Subprotocol]:
"""
Handle the Sec-WebSocket-Protocol HTTP request header.
Return Sec-WebSocket-Protocol HTTP response header, which is the same
as the selected subprotocol.
+ :param headers: request headers
+ :raises ~websockets.exceptions.InvalidHandshake: to abort the
+ handshake with an HTTP 400 error code
+
"""
- subprotocol = None
+ subprotocol: Optional[Subprotocol] = None
- header_values = headers.get_all('Sec-WebSocket-Protocol')
+ header_values = headers.get_all("Sec-WebSocket-Protocol")
- if header_values and available_subprotocols:
+ if header_values and self.available_subprotocols:
- parsed_header_values = sum(
- [
- parse_subprotocol_list(header_value)
- for header_value in header_values
- ],
- [],
+ parsed_header_values: List[Subprotocol] = sum(
+ [parse_subprotocol(header_value) for header_value in header_values], []
)
subprotocol = self.select_subprotocol(
- parsed_header_values, available_subprotocols
+ parsed_header_values, self.available_subprotocols
)
return subprotocol
- @staticmethod
- def select_subprotocol(client_subprotocols, server_subprotocols):
+ def select_subprotocol(
+ self,
+ client_subprotocols: Sequence[Subprotocol],
+ server_subprotocols: Sequence[Subprotocol],
+ ) -> Optional[Subprotocol]:
"""
Pick a subprotocol among those offered by the client.
@@ -412,16 +359,15 @@ def select_subprotocol(client_subprotocols, server_subprotocols):
the default implementation selects the preferred subprotocols by
giving equal value to the priorities of the client and the server.
- If no subprotocols are supported by the client and the server, it
+ If no common subprotocol is supported by the client and the server, it
proceeds without a subprotocol.
This is unlikely to be the most useful implementation in practice, as
many servers providing a subprotocol will require that the client uses
- that subprotocol. Such rules can be implemented in a subclass.
+ that subprotocol.
- This method may be overridden by passing a ``select_subprotocol``
- argument to the :class:`WebSocketServerProtocol` constructor or the
- :func:`serve` function.
+ :param client_subprotocols: list of subprotocols offered by the client
+ :param server_subprotocols: list of subprotocols available on the server
"""
subprotocols = set(client_subprotocols) & set(server_subprotocols)
@@ -432,444 +378,52 @@ def select_subprotocol(client_subprotocols, server_subprotocols):
)
return sorted(subprotocols, key=priority)[0]
- @asyncio.coroutine
- def handshake(
+ def reject(
self,
- origins=None,
- available_extensions=None,
- available_subprotocols=None,
- extra_headers=None,
- ):
- """
- Perform the server side of the opening handshake.
-
- If provided, ``origins`` is a list of acceptable HTTP Origin values.
- Include ``None`` if the lack of an origin is acceptable.
-
- If provided, ``available_extensions`` is a list of supported
- extensions in the order in which they should be used.
-
- If provided, ``available_subprotocols`` is a list of supported
- subprotocols in order of decreasing preference.
-
- If provided, ``extra_headers`` sets additional HTTP response headers.
- It can be a :class:`~websockets.http.Headers` instance, a
- :class:`~collections.abc.Mapping`, an iterable of ``(name, value)``
- pairs, or a callable taking the request path and headers in arguments
- and returning one of the above.
-
- Raise :exc:`~websockets.exceptions.InvalidHandshake` if the handshake
- fails.
-
- Return the path of the URI of the request.
-
- """
- path, request_headers = yield from self.read_http_request()
-
- # Hook for customizing request handling, for example checking
- # authentication or treating some paths as plain HTTP endpoints.
- if asyncio.iscoroutinefunction(self.process_request):
- early_response = yield from self.process_request(path, request_headers)
- else:
- early_response = self.process_request(path, request_headers)
-
- # Give up immediately and don't attempt to write a HTTP response if
- # the TCP connection was closed while process_request() was running.
- # This happens if the server shuts down and calls fail_connection().
- if self.state != State.CONNECTING:
- raise CancelHandshake()
-
- if early_response is not None:
- raise AbortHandshake(*early_response)
-
- key = check_request(request_headers)
-
- self.origin = self.process_origin(request_headers, origins)
-
- extensions_header, self.extensions = self.process_extensions(
- request_headers, available_extensions
- )
-
- protocol_header = self.subprotocol = self.process_subprotocol(
- request_headers, available_subprotocols
- )
-
- response_headers = Headers()
-
- build_response(response_headers, key)
-
- if extensions_header is not None:
- response_headers['Sec-WebSocket-Extensions'] = extensions_header
-
- if protocol_header is not None:
- response_headers['Sec-WebSocket-Protocol'] = protocol_header
-
- if extra_headers is not None:
- if callable(extra_headers):
- extra_headers = extra_headers(path, self.request_headers)
- if isinstance(extra_headers, Headers):
- extra_headers = extra_headers.raw_items()
- elif isinstance(extra_headers, collections.abc.Mapping):
- extra_headers = extra_headers.items()
- for name, value in extra_headers:
- response_headers[name] = value
-
- response_headers.setdefault('Date', email.utils.formatdate(usegmt=True))
- response_headers.setdefault('Server', USER_AGENT)
-
- yield from self.write_http_response(SWITCHING_PROTOCOLS, response_headers)
-
- self.connection_open()
-
- return path
-
-
-class WebSocketServer:
- """
- Wrapper for :class:`~asyncio.Server` that closes connections on exit.
-
- This class provides the return type of :func:`~websockets.server.serve`.
-
- It mimics the interface of :class:`~asyncio.AbstractServer`, namely its
- :meth:`~asyncio.AbstractServer.close()` and
- :meth:`~asyncio.AbstractServer.wait_closed()` methods, to close WebSocket
- connections properly on exit, in addition to closing the underlying
- :class:`~asyncio.Server`.
-
- Instances of this class store a reference to the :class:`~asyncio.Server`
- object returned by :meth:`~asyncio.AbstractEventLoop.create_server` rather
- than inherit from :class:`~asyncio.Server` in part because
- :meth:`~asyncio.AbstractEventLoop.create_server` doesn't support passing a
- custom :class:`~asyncio.Server` class.
-
- """
-
- def __init__(self, loop):
- # Store a reference to loop to avoid relying on self.server._loop.
- self.loop = loop
-
- # Keep track of active connections.
- self.websockets = set()
-
- # Task responsible for closing the server and terminating connections.
- self.close_task = None
-
- # Completed when the server is closed and connections are terminated.
- self.closed_waiter = asyncio.Future(loop=loop)
-
- def wrap(self, server):
+ status: http.HTTPStatus,
+ text: str,
+ headers: Optional[Headers] = None,
+ exception: Optional[Exception] = None,
+ ) -> Response:
"""
- Attach to a given :class:`~asyncio.Server`.
-
- Since :meth:`~asyncio.AbstractEventLoop.create_server` doesn't support
- injecting a custom ``Server`` class, the easiest solution that doesn't
- rely on private :mod:`asyncio` APIs is to:
+ Create a HTTP response event to send to the client.
- - instantiate a :class:`WebSocketServer`
- - give the protocol factory a reference to that instance
- - call :meth:`~asyncio.AbstractEventLoop.create_server` with the
- factory
- - attach the resulting :class:`~asyncio.Server` with this method
-
- """
- self.server = server
+ A short plain text response is the best fallback when failing to
+ establish a WebSocket connection.
- def register(self, protocol):
"""
- Register a connection with this server.
+ body = text.encode()
+ if headers is None:
+ headers = Headers()
+ headers.setdefault("Date", email.utils.formatdate(usegmt=True))
+ headers.setdefault("Server", USER_AGENT)
+ headers.setdefault("Content-Length", str(len(body)))
+ headers.setdefault("Content-Type", "text/plain; charset=utf-8")
+ headers.setdefault("Connection", "close")
+ return Response(status.value, status.phrase, headers, body)
+ def send_response(self, response: Response) -> None:
"""
- self.websockets.add(protocol)
+ Send a WebSocket handshake response to the client.
- def unregister(self, protocol):
"""
- Unregister a connection with this server.
+ if response.status_code == 101:
+ self.set_state(OPEN)
- """
- self.websockets.remove(protocol)
-
- def close(self):
- """
- Close the server and terminate connections with close code 1001.
-
- This method is idempotent.
-
- """
- if self.close_task is None:
- self.close_task = asyncio_ensure_future(self._close(), loop=self.loop)
-
- @asyncio.coroutine
- def _close(self):
- """
- Implementation of :meth:`close`.
-
- This calls :meth:`~asyncio.Server.close` on the underlying
- :class:`~asyncio.Server` object to stop accepting new connections and
- then closes open connections with close code 1001.
-
- """
- # Stop accepting new connections.
- self.server.close()
-
- # Wait until self.server.close() completes.
- yield from self.server.wait_closed()
-
- # Wait until all accepted connections reach connection_made() and call
- # register(). See https://bugs.python.org/issue34852 for details.
- yield from asyncio.sleep(0)
-
- # Close open connections. fail_connection() will cancel the transfer
- # data task, which is expected to cause the handler task to terminate.
- for websocket in self.websockets:
- websocket.fail_connection(1001)
-
- # asyncio.wait doesn't accept an empty first argument.
- if self.websockets:
- # The connection handler can terminate before or after the
- # connection closes. Wait until both are done to avoid leaking
- # running tasks.
- # TODO: it would be nicer to wait only for the connection handler
- # and let the handler wait for the connection to close.
- yield from asyncio.wait(
- [websocket.handler_task for websocket in self.websockets]
- + [websocket.close_connection_task for websocket in self.websockets],
- loop=self.loop,
- )
-
- # Tell wait_closed() to return.
- self.closed_waiter.set_result(None)
-
- @asyncio.coroutine
- def wait_closed(self):
- """
- Wait until the server is closed and all connections are terminated.
-
- When :meth:`wait_closed()` returns, all TCP connections are closed and
- there are no pending tasks left.
-
- """
- yield from asyncio.shield(self.closed_waiter)
-
- @property
- def sockets(self):
- """
- List of :class:`~socket.socket` objects the server is listening to.
-
- ``None`` if the server is closed.
-
- """
- return self.server.sockets
-
-
-class Serve:
- """
- Create, start, and return a :class:`WebSocketServer`.
-
- :func:`serve` returns an awaitable. Awaiting it yields an instance of
- :class:`WebSocketServer` which provides
- :meth:`~websockets.server.WebSocketServer.close` and
- :meth:`~websockets.server.WebSocketServer.wait_closed` methods for
- terminating the server and cleaning up its resources.
-
- On Python ≥ 3.5, :func:`serve` can also be used as an asynchronous context
- manager. In this case, the server is shut down when exiting the context.
-
- :func:`serve` is a wrapper around the event loop's
- :meth:`~asyncio.AbstractEventLoop.create_server` method. Internally, it
- creates and starts a :class:`~asyncio.Server` object by calling
- :meth:`~asyncio.AbstractEventLoop.create_server`. The
- :class:`WebSocketServer` it returns keeps a reference to this object.
-
- The ``ws_handler`` argument is the WebSocket handler. It must be a
- coroutine accepting two arguments: a :class:`WebSocketServerProtocol` and
- the request URI.
-
- The ``host`` and ``port`` arguments, as well as unrecognized keyword
- arguments, are passed along to
- :meth:`~asyncio.AbstractEventLoop.create_server`. For example, you can set
- the ``ssl`` keyword argument to a :class:`~ssl.SSLContext` to enable TLS.
-
- The ``create_protocol`` parameter allows customizing the asyncio protocol
- that manages the connection. It should be a callable or class accepting
- the same arguments as :class:`WebSocketServerProtocol` and returning a
- :class:`WebSocketServerProtocol` instance. It defaults to
- :class:`WebSocketServerProtocol`.
-
- The behavior of the ``ping_interval``, ``ping_timeout``, ``close_timeout``,
- ``max_size``, ``max_queue``, ``read_limit``, and ``write_limit`` optional
- arguments is described in the documentation of
- :class:`~websockets.protocol.WebSocketCommonProtocol`.
-
- :func:`serve` also accepts the following optional arguments:
-
- * ``compression`` is a shortcut to configure compression extensions;
- by default it enables the "permessage-deflate" extension; set it to
- ``None`` to disable compression
- * ``origins`` defines acceptable Origin HTTP headers — include ``None`` if
- the lack of an origin is acceptable
- * ``extensions`` is a list of supported extensions in order of
- decreasing preference
- * ``subprotocols`` is a list of supported subprotocols in order of
- decreasing preference
- * ``extra_headers`` sets additional HTTP response headers — it can be a
- :class:`~websockets.http.Headers` instance, a
- :class:`~collections.abc.Mapping`, an iterable of ``(name, value)``
- pairs, or a callable taking the request path and headers in arguments
- and returning one of the above
- * ``process_request`` is a callable or a coroutine taking the request path
- and headers in argument, see
- :meth:`~WebSocketServerProtocol.process_request` for details
- * ``select_subprotocol`` is a callable taking the subprotocols offered by
- the client and available on the server in argument, see
- :meth:`~WebSocketServerProtocol.select_subprotocol` for details
-
- Whenever a client connects, the server accepts the connection, creates a
- :class:`WebSocketServerProtocol`, performs the opening handshake, and
- delegates to the WebSocket handler. Once the handler completes, the server
- performs the closing handshake and closes the connection.
-
- When a server is closed with :meth:`~WebSocketServer.close`, it closes all
- connections with close code 1001 (going away). WebSocket handlers — which
- are running the coroutine passed in the ``ws_handler`` — will receive a
- :exc:`~websockets.exceptions.ConnectionClosed` exception on their current
- or next interaction with the WebSocket connection.
-
- Since there's no useful way to propagate exceptions triggered in handlers,
- they're sent to the ``'websockets.server'`` logger instead. Debugging is
- much easier if you configure logging to print them::
-
- import logging
- logger = logging.getLogger('websockets.server')
- logger.setLevel(logging.ERROR)
- logger.addHandler(logging.StreamHandler())
-
- """
-
- def __init__(
- self,
- ws_handler,
- host=None,
- port=None,
- *,
- path=None,
- create_protocol=None,
- ping_interval=20,
- ping_timeout=20,
- close_timeout=None,
- max_size=2 ** 20,
- max_queue=2 ** 5,
- read_limit=2 ** 16,
- write_limit=2 ** 16,
- loop=None,
- legacy_recv=False,
- klass=WebSocketServerProtocol,
- timeout=10,
- compression='deflate',
- origins=None,
- extensions=None,
- subprotocols=None,
- extra_headers=None,
- process_request=None,
- select_subprotocol=None,
- **kwds
- ):
- # Backwards-compatibility: close_timeout used to be called timeout.
- # If both are specified, timeout is ignored.
- if close_timeout is None:
- close_timeout = timeout
-
- # Backwards-compatibility: create_protocol used to be called klass.
- # If both are specified, klass is ignored.
- if create_protocol is None:
- create_protocol = klass
-
- if loop is None:
- loop = asyncio.get_event_loop()
-
- ws_server = WebSocketServer(loop)
-
- secure = kwds.get('ssl') is not None
-
- if compression == 'deflate':
- if extensions is None:
- extensions = []
- if not any(
- ext_factory.name == ServerPerMessageDeflateFactory.name
- for ext_factory in extensions
- ):
- extensions.append(ServerPerMessageDeflateFactory())
- elif compression is not None:
- raise ValueError("Unsupported compression: {}".format(compression))
-
- factory = lambda: create_protocol(
- ws_handler,
- ws_server,
- host=host,
- port=port,
- secure=secure,
- ping_interval=ping_interval,
- ping_timeout=ping_timeout,
- close_timeout=close_timeout,
- max_size=max_size,
- max_queue=max_queue,
- read_limit=read_limit,
- write_limit=write_limit,
- loop=loop,
- legacy_recv=legacy_recv,
- origins=origins,
- extensions=extensions,
- subprotocols=subprotocols,
- extra_headers=extra_headers,
- process_request=process_request,
- select_subprotocol=select_subprotocol,
+ logger.debug(
+ "%s > HTTP/1.1 %d %s",
+ self.side,
+ response.status_code,
+ response.reason_phrase,
)
+ logger.debug("%s > %r", self.side, response.headers)
+ if response.body is not None:
+ logger.debug("%s > body (%d bytes)", self.side, len(response.body))
- if path is None:
- creating_server = loop.create_server(factory, host, port, **kwds)
- else:
- creating_server = loop.create_unix_server(factory, path, **kwds)
-
- # This is a coroutine object.
- self._creating_server = creating_server
- self.ws_server = ws_server
-
- @asyncio.coroutine
- def __iter__(self): # pragma: no cover
- server = yield from self._creating_server
- self.ws_server.wrap(server)
- return self.ws_server
-
-
-def unix_serve(ws_handler, path, **kwargs):
- """
- Similar to :func:`serve()`, but for listening on Unix sockets.
-
- This function calls the event loop's
- :meth:`~asyncio.AbstractEventLoop.create_unix_server` method.
-
- It is only available on Unix.
-
- It's useful for deploying a server behind a reverse proxy such as nginx.
-
- """
- return serve(ws_handler, path=path, **kwargs)
-
-
-# We can't define __await__ on Python < 3.5.1 because asyncio.ensure_future
-# didn't accept arbitrary awaitables until Python 3.5.1. We don't define
-# __aenter__ and __aexit__ either on Python < 3.5.1 to keep things simple.
-if sys.version_info[:3] <= (3, 5, 0): # pragma: no cover
-
- @asyncio.coroutine
- def serve(*args, **kwds):
- return Serve(*args, **kwds).__iter__()
-
- serve.__doc__ = Serve.__doc__
-
-else:
- from .py35.server import __aenter__, __aexit__, __await__
+ self.writes.append(response.serialize())
- Serve.__aenter__ = __aenter__
- Serve.__aexit__ = __aexit__
- Serve.__await__ = __await__
- serve = Serve
+ def parse(self) -> Generator[None, None, None]:
+ request = yield from Request.parse(self.reader.read_line)
+ assert self.state == CONNECTING
+ self.events.append(request)
+ yield from super().parse()
diff --git a/src/websockets/speedups.c b/src/websockets/speedups.c
index 4d7622231..fc328e528 100644
--- a/src/websockets/speedups.c
+++ b/src/websockets/speedups.c
@@ -10,46 +10,120 @@
static const Py_ssize_t MASK_LEN = 4;
+/* Similar to PyBytes_AsStringAndSize, but accepts more types */
+
+static int
+_PyBytesLike_AsStringAndSize(PyObject *obj, PyObject **tmp, char **buffer, Py_ssize_t *length)
+{
+ // This supports bytes, bytearrays, and memoryview objects,
+ // which are common data structures for handling byte streams.
+ // websockets.framing.prepare_data() returns only these types.
+ // If *tmp isn't NULL, the caller gets a new reference.
+ if (PyBytes_Check(obj))
+ {
+ *tmp = NULL;
+ *buffer = PyBytes_AS_STRING(obj);
+ *length = PyBytes_GET_SIZE(obj);
+ }
+ else if (PyByteArray_Check(obj))
+ {
+ *tmp = NULL;
+ *buffer = PyByteArray_AS_STRING(obj);
+ *length = PyByteArray_GET_SIZE(obj);
+ }
+ else if (PyMemoryView_Check(obj))
+ {
+ *tmp = PyMemoryView_GetContiguous(obj, PyBUF_READ, 'C');
+ if (*tmp == NULL)
+ {
+ return -1;
+ }
+ Py_buffer *mv_buf;
+ mv_buf = PyMemoryView_GET_BUFFER(*tmp);
+ *buffer = mv_buf->buf;
+ *length = mv_buf->len;
+ }
+ else
+ {
+ PyErr_Format(
+ PyExc_TypeError,
+ "expected a bytes-like object, %.200s found",
+ Py_TYPE(obj)->tp_name);
+ return -1;
+ }
+
+ return 0;
+}
+
+/* C implementation of websockets.utils.apply_mask */
+
static PyObject *
apply_mask(PyObject *self, PyObject *args, PyObject *kwds)
{
- // Inputs are treated as immutable, which causes an extra memory copy.
+ // In order to support various bytes-like types, accept any Python object.
static char *kwlist[] = {"data", "mask", NULL};
- const char *input;
+ PyObject *input_obj;
+ PyObject *mask_obj;
+
+ // A pointer to a char * + length will be extracted from the data and mask
+ // arguments, possibly via a Py_buffer.
+
+ PyObject *input_tmp = NULL;
+ char *input;
Py_ssize_t input_len;
- const char *mask;
+ PyObject *mask_tmp = NULL;
+ char *mask;
Py_ssize_t mask_len;
// Initialize a PyBytesObject then get a pointer to the underlying char *
// in order to avoid an extra memory copy in PyBytes_FromStringAndSize.
- PyObject *result;
+ PyObject *result = NULL;
char *output;
+
+ // Other variables.
+
Py_ssize_t i = 0;
+ // Parse inputs.
+
if (!PyArg_ParseTupleAndKeywords(
- args, kwds, "y#y#", kwlist, &input, &input_len, &mask, &mask_len))
+ args, kwds, "OO", kwlist, &input_obj, &mask_obj))
+ {
+ goto exit;
+ }
+
+ if (_PyBytesLike_AsStringAndSize(input_obj, &input_tmp, &input, &input_len) == -1)
{
- return NULL;
+ goto exit;
+ }
+
+ if (_PyBytesLike_AsStringAndSize(mask_obj, &mask_tmp, &mask, &mask_len) == -1)
+ {
+ goto exit;
}
if (mask_len != MASK_LEN)
{
PyErr_SetString(PyExc_ValueError, "mask must contain 4 bytes");
- return NULL;
+ goto exit;
}
+ // Create output.
+
result = PyBytes_FromStringAndSize(NULL, input_len);
if (result == NULL)
{
- return NULL;
+ goto exit;
}
// Since we juste created result, we don't need error checks.
output = PyBytes_AS_STRING(result);
+ // Perform the masking operation.
+
// Apparently GCC cannot figure out the following optimizations by itself.
// We need a new scope for MSVC 2010 (non C99 friendly)
@@ -96,6 +170,9 @@ apply_mask(PyObject *self, PyObject *args, PyObject *kwds)
output[i] = input[i] ^ mask[i & (MASK_LEN - 1)];
}
+exit:
+ Py_XDECREF(input_tmp);
+ Py_XDECREF(mask_tmp);
return result;
}
@@ -105,7 +182,7 @@ static PyMethodDef speedups_methods[] = {
"apply_mask",
(PyCFunction)apply_mask,
METH_VARARGS | METH_KEYWORDS,
- "Apply masking to websocket message.",
+ "Apply masking to the data of a WebSocket message.",
},
{NULL, NULL, 0, NULL}, /* Sentinel */
};
diff --git a/src/websockets/speedups.pyi b/src/websockets/speedups.pyi
new file mode 100644
index 000000000..821438a06
--- /dev/null
+++ b/src/websockets/speedups.pyi
@@ -0,0 +1 @@
+def apply_mask(data: bytes, mask: bytes) -> bytes: ...
diff --git a/src/websockets/streams.py b/src/websockets/streams.py
new file mode 100644
index 000000000..6f3163034
--- /dev/null
+++ b/src/websockets/streams.py
@@ -0,0 +1,115 @@
+from typing import Generator
+
+
+class StreamReader:
+ """
+ Generator-based stream reader.
+
+ This class doesn't support concurrent calls to :meth:`read_line()`,
+ :meth:`read_exact()`, or :meth:`read_to_eof()`. Make sure calls are
+ serialized.
+
+ """
+
+ def __init__(self) -> None:
+ self.buffer = bytearray()
+ self.eof = False
+
+ def read_line(self) -> Generator[None, None, bytes]:
+ """
+ Read a LF-terminated line from the stream.
+
+ The return value includes the LF character.
+
+ This is a generator-based coroutine.
+
+ :raises EOFError: if the stream ends without a LF
+
+ """
+ n = 0 # number of bytes to read
+ p = 0 # number of bytes without a newline
+ while True:
+ n = self.buffer.find(b"\n", p) + 1
+ if n > 0:
+ break
+ p = len(self.buffer)
+ if self.eof:
+ raise EOFError(f"stream ends after {p} bytes, before end of line")
+ yield
+ r = self.buffer[:n]
+ del self.buffer[:n]
+ return r
+
+ def read_exact(self, n: int) -> Generator[None, None, bytes]:
+ """
+ Read ``n`` bytes from the stream.
+
+ This is a generator-based coroutine.
+
+ :raises EOFError: if the stream ends in less than ``n`` bytes
+
+ """
+ assert n >= 0
+ while len(self.buffer) < n:
+ if self.eof:
+ p = len(self.buffer)
+ raise EOFError(f"stream ends after {p} bytes, expected {n} bytes")
+ yield
+ r = self.buffer[:n]
+ del self.buffer[:n]
+ return r
+
+ def read_to_eof(self) -> Generator[None, None, bytes]:
+ """
+ Read all bytes from the stream.
+
+ This is a generator-based coroutine.
+
+ """
+ while not self.eof:
+ yield
+ r = self.buffer[:]
+ del self.buffer[:]
+ return r
+
+ def at_eof(self) -> Generator[None, None, bool]:
+ """
+ Tell whether the stream has ended and all data was read.
+
+ This is a generator-based coroutine.
+
+ """
+ while True:
+ if self.buffer:
+ return False
+ if self.eof:
+ return True
+ # When all data was read but the stream hasn't ended, we can't
+ # tell if until either feed_data() or feed_eof() is called.
+ yield
+
+ def feed_data(self, data: bytes) -> None:
+ """
+ Write ``data`` to the stream.
+
+ :meth:`feed_data()` cannot be called after :meth:`feed_eof()`.
+
+ :raises EOFError: if the stream has ended
+
+ """
+ if self.eof:
+ raise EOFError("stream ended")
+ self.buffer += data
+
+ def feed_eof(self) -> None:
+ """
+ End the stream.
+
+ :meth:`feed_eof()` must be called at must once.
+
+ :raises EOFError: if the stream has ended
+
+ """
+ if self.eof:
+ raise EOFError("stream ended")
+ self.eof = True
diff --git a/src/websockets/typing.py b/src/websockets/typing.py
new file mode 100644
index 000000000..ca66a8c54
--- /dev/null
+++ b/src/websockets/typing.py
@@ -0,0 +1,55 @@
+from typing import List, NewType, Optional, Tuple, Union
+
+
+__all__ = ["Data", "Origin", "ExtensionHeader", "ExtensionParameter", "Subprotocol"]
+
+Data = Union[str, bytes]
+
+Data__doc__ = """
+Types supported in a WebSocket message:
+
+- :class:`str` for text messages
+- :class:`bytes` for binary messages
+
+"""
+# Remove try / except when dropping support for Python < 3.7
+try:
+ Data.__doc__ = Data__doc__
+except AttributeError: # pragma: no cover
+ pass
+
+
+Origin = NewType("Origin", str)
+Origin.__doc__ = """Value of a Origin header"""
+
+
+ExtensionName = NewType("ExtensionName", str)
+ExtensionName.__doc__ = """Name of a WebSocket extension"""
+
+
+ExtensionParameter = Tuple[str, Optional[str]]
+ExtensionParameter__doc__ = """Parameter of a WebSocket extension"""
+try:
+ ExtensionParameter.__doc__ = ExtensionParameter__doc__
+except AttributeError: # pragma: no cover
+ pass
+
+
+ExtensionHeader = Tuple[ExtensionName, List[ExtensionParameter]]
+ExtensionHeader__doc__ = """Extension in a Sec-WebSocket-Extensions header"""
+try:
+ ExtensionHeader.__doc__ = ExtensionHeader__doc__
+except AttributeError: # pragma: no cover
+ pass
+
+
+Subprotocol = NewType("Subprotocol", str)
+Subprotocol.__doc__ = """Subprotocol value in a Sec-WebSocket-Protocol header"""
+
+
+ConnectionOption = NewType("ConnectionOption", str)
+ConnectionOption.__doc__ = """Connection option in a Connection header"""
+
+
+UpgradeProtocol = NewType("UpgradeProtocol", str)
+UpgradeProtocol.__doc__ = """Upgrade protocol in an Upgrade header"""
diff --git a/src/websockets/uri.py b/src/websockets/uri.py
index d793fc6aa..ce21b445b 100644
--- a/src/websockets/uri.py
+++ b/src/websockets/uri.py
@@ -1,61 +1,99 @@
"""
-The :mod:`websockets.uri` module implements parsing of WebSocket URIs
-according to `section 3 of RFC 6455`_.
+:mod:`websockets.uri` parses WebSocket URIs.
+
+See `section 3 of RFC 6455`_.
.. _section 3 of RFC 6455: http://tools.ietf.org/html/rfc6455#section-3
"""
-import collections
import urllib.parse
+from typing import NamedTuple, Optional, Tuple
from .exceptions import InvalidURI
-__all__ = ['parse_uri', 'WebSocketURI']
+__all__ = ["parse_uri", "WebSocketURI"]
-WebSocketURI = collections.namedtuple(
- 'WebSocketURI', ['secure', 'host', 'port', 'resource_name', 'user_info']
-)
-WebSocketURI.__doc__ = """WebSocket URI.
-* ``secure`` is the secure flag
-* ``host`` is the lower-case host
-* ``port`` if the integer port, it's always provided even if it's the default
-* ``resource_name`` is the resource name, that is, the path and optional query
-* ``user_info`` is an ``(username, password)`` tuple when the URI contains
- `User Information`_, else ``None``.
+# Consider converting to a dataclass when dropping support for Python < 3.7.
-.. _User Information: https://tools.ietf.org/html/rfc3986#section-3.2.1
-"""
+class WebSocketURI(NamedTuple):
+ """
+ WebSocket URI.
+ :param bool secure: secure flag
+ :param str host: lower-case host
+ :param int port: port, always set even if it's the default
+ :param str resource_name: path and optional query
+ :param str user_info: ``(username, password)`` tuple when the URI contains
+ `User Information`_, else ``None``.
-def parse_uri(uri):
+ .. _User Information: https://tools.ietf.org/html/rfc3986#section-3.2.1
"""
- This function parses and validates a WebSocket URI.
- If the URI is valid, it returns a :class:`WebSocketURI`.
+ secure: bool
+ host: str
+ port: int
+ resource_name: str
+ user_info: Optional[Tuple[str, str]]
+
+
+# Work around https://bugs.python.org/issue19931
+
+WebSocketURI.secure.__doc__ = ""
+WebSocketURI.host.__doc__ = ""
+WebSocketURI.port.__doc__ = ""
+WebSocketURI.resource_name.__doc__ = ""
+WebSocketURI.user_info.__doc__ = ""
+
- Otherwise it raises an :exc:`~websockets.exceptions.InvalidURI` exception.
+# All characters from the gen-delims and sub-delims sets in RFC 3987.
+DELIMS = ":/?#[]@!$&'()*+,;="
+
+
+def parse_uri(uri: str) -> WebSocketURI:
+ """
+ Parse and validate a WebSocket URI.
+
+ :raises ValueError: if ``uri`` isn't a valid WebSocket URI.
"""
- uri = urllib.parse.urlparse(uri)
+ parsed = urllib.parse.urlparse(uri)
try:
- assert uri.scheme in ['ws', 'wss']
- assert uri.params == ''
- assert uri.fragment == ''
- assert uri.hostname is not None
+ assert parsed.scheme in ["ws", "wss"]
+ assert parsed.params == ""
+ assert parsed.fragment == ""
+ assert parsed.hostname is not None
except AssertionError as exc:
- raise InvalidURI("{} isn't a valid URI".format(uri)) from exc
-
- secure = uri.scheme == 'wss'
- host = uri.hostname
- port = uri.port or (443 if secure else 80)
- resource_name = uri.path or '/'
- if uri.query:
- resource_name += '?' + uri.query
+ raise InvalidURI(uri) from exc
+
+ secure = parsed.scheme == "wss"
+ host = parsed.hostname
+ port = parsed.port or (443 if secure else 80)
+ resource_name = parsed.path or "/"
+ if parsed.query:
+ resource_name += "?" + parsed.query
user_info = None
- if uri.username or uri.password:
- user_info = (uri.username, uri.password)
+ if parsed.username is not None:
+ # urllib.parse.urlparse accepts URLs with a username but without a
+ # password. This doesn't make sense for HTTP Basic Auth credentials.
+ if parsed.password is None:
+ raise InvalidURI(uri)
+ user_info = (parsed.username, parsed.password)
+
+ try:
+ uri.encode("ascii")
+ except UnicodeEncodeError:
+ # Input contains non-ASCII characters.
+ # It must be an IRI. Convert it to a URI.
+ host = host.encode("idna").decode()
+ resource_name = urllib.parse.quote(resource_name, safe=DELIMS)
+ if user_info is not None:
+ user_info = (
+ urllib.parse.quote(user_info[0], safe=DELIMS),
+ urllib.parse.quote(user_info[1], safe=DELIMS),
+ )
+
return WebSocketURI(secure, host, port, resource_name, user_info)
diff --git a/src/websockets/utils.py b/src/websockets/utils.py
index b4083dff4..59210e438 100644
--- a/src/websockets/utils.py
+++ b/src/websockets/utils.py
@@ -1,14 +1,44 @@
+import base64
+import hashlib
import itertools
+import secrets
-__all__ = ['apply_mask']
+__all__ = ["accept_key", "apply_mask"]
-def apply_mask(data, mask):
+GUID = "258EAFA5-E914-47DA-95CA-C5AB0DC85B11"
+
+
+def generate_key() -> str:
+ """
+ Generate a random key for the Sec-WebSocket-Key header.
+
"""
- Apply masking to websocket message.
+ key = secrets.token_bytes(16)
+ return base64.b64encode(key).decode()
+
+
+def accept_key(key: str) -> str:
+ """
+ Compute the value of the Sec-WebSocket-Accept header.
+
+ :param key: value of the Sec-WebSocket-Key header
+
+ """
+ sha1 = hashlib.sha1((key + GUID).encode()).digest()
+ return base64.b64encode(sha1).decode()
+
+
+def apply_mask(data: bytes, mask: bytes) -> bytes:
+ """
+ Apply masking to the data of a WebSocket message.
+
+ :param data: Data to mask
+ :param mask: 4-bytes mask
"""
if len(mask) != 4:
raise ValueError("mask must contain 4 bytes")
+
return bytes(b ^ m for b, m in zip(data, itertools.cycle(mask)))
diff --git a/src/websockets/version.py b/src/websockets/version.py
index fe9ed183b..a7901ef92 100644
--- a/src/websockets/version.py
+++ b/src/websockets/version.py
@@ -1 +1 @@
-version = '7.0'
+version = "9.1"
diff --git a/tests/__init__.py b/tests/__init__.py
index e69de29bb..dd78609f5 100644
--- a/tests/__init__.py
+++ b/tests/__init__.py
@@ -0,0 +1,5 @@
+import logging
+
+
+# Avoid displaying stack traces at the ERROR logging level.
+logging.basicConfig(level=logging.CRITICAL)
diff --git a/tests/extensions/test_base.py b/tests/extensions/test_base.py
index ba8657b65..0daa34211 100644
--- a/tests/extensions/test_base.py
+++ b/tests/extensions/test_base.py
@@ -1,4 +1,40 @@
+from websockets.exceptions import NegotiationError
from websockets.extensions.base import * # noqa
# Abstract classes don't provide any behavior to test.
+
+
+class ClientNoOpExtensionFactory:
+ name = "x-no-op"
+
+ def get_request_params(self):
+ return []
+
+ def process_response_params(self, params, accepted_extensions):
+ if params:
+ raise NegotiationError()
+ return NoOpExtension()
+
+
+class ServerNoOpExtensionFactory:
+ name = "x-no-op"
+
+ def __init__(self, params=None):
+ self.params = params or []
+
+ def process_request_params(self, params, accepted_extensions):
+ return self.params, NoOpExtension()
+
+
+class NoOpExtension:
+ name = "x-no-op"
+
+ def __repr__(self):
+ return "NoOpExtension()"
+
+ def decode(self, frame, *, max_size=None):
+ return frame
+
+ def encode(self, frame):
+ return frame
diff --git a/tests/extensions/test_permessage_deflate.py b/tests/extensions/test_permessage_deflate.py
index 0b7b78eae..908cd91a4 100644
--- a/tests/extensions/test_permessage_deflate.py
+++ b/tests/extensions/test_permessage_deflate.py
@@ -9,7 +9,7 @@
PayloadTooBig,
)
from websockets.extensions.permessage_deflate import *
-from websockets.framing import (
+from websockets.frames import (
OP_BINARY,
OP_CLOSE,
OP_CONT,
@@ -20,6 +20,8 @@
serialize_close,
)
+from .test_base import ClientNoOpExtensionFactory, ServerNoOpExtensionFactory
+
class ExtensionTestsMixin:
def assertExtensionEqual(self, extension1, extension2):
@@ -37,9 +39,230 @@ def assertExtensionEqual(self, extension1, extension2):
)
+class PerMessageDeflateTests(unittest.TestCase, ExtensionTestsMixin):
+ def setUp(self):
+ # Set up an instance of the permessage-deflate extension with the most
+ # common settings. Since the extension is symmetrical, this instance
+ # may be used for testing both encoding and decoding.
+ self.extension = PerMessageDeflate(False, False, 15, 15)
+
+ def test_name(self):
+ assert self.extension.name == "permessage-deflate"
+
+ def test_repr(self):
+ self.assertExtensionEqual(eval(repr(self.extension)), self.extension)
+
+ # Control frames aren't encoded or decoded.
+
+ def test_no_encode_decode_ping_frame(self):
+ frame = Frame(True, OP_PING, b"")
+
+ self.assertEqual(self.extension.encode(frame), frame)
+
+ self.assertEqual(self.extension.decode(frame), frame)
+
+ def test_no_encode_decode_pong_frame(self):
+ frame = Frame(True, OP_PONG, b"")
+
+ self.assertEqual(self.extension.encode(frame), frame)
+
+ self.assertEqual(self.extension.decode(frame), frame)
+
+ def test_no_encode_decode_close_frame(self):
+ frame = Frame(True, OP_CLOSE, serialize_close(1000, ""))
+
+ self.assertEqual(self.extension.encode(frame), frame)
+
+ self.assertEqual(self.extension.decode(frame), frame)
+
+ # Data frames are encoded and decoded.
+
+ def test_encode_decode_text_frame(self):
+ frame = Frame(True, OP_TEXT, "café".encode("utf-8"))
+
+ enc_frame = self.extension.encode(frame)
+
+ self.assertEqual(enc_frame, frame._replace(rsv1=True, data=b"JNL;\xbc\x12\x00"))
+
+ dec_frame = self.extension.decode(enc_frame)
+
+ self.assertEqual(dec_frame, frame)
+
+ def test_encode_decode_binary_frame(self):
+ frame = Frame(True, OP_BINARY, b"tea")
+
+ enc_frame = self.extension.encode(frame)
+
+ self.assertEqual(enc_frame, frame._replace(rsv1=True, data=b"*IM\x04\x00"))
+
+ dec_frame = self.extension.decode(enc_frame)
+
+ self.assertEqual(dec_frame, frame)
+
+ def test_encode_decode_fragmented_text_frame(self):
+ frame1 = Frame(False, OP_TEXT, "café".encode("utf-8"))
+ frame2 = Frame(False, OP_CONT, " & ".encode("utf-8"))
+ frame3 = Frame(True, OP_CONT, "croissants".encode("utf-8"))
+
+ enc_frame1 = self.extension.encode(frame1)
+ enc_frame2 = self.extension.encode(frame2)
+ enc_frame3 = self.extension.encode(frame3)
+
+ self.assertEqual(
+ enc_frame1,
+ frame1._replace(rsv1=True, data=b"JNL;\xbc\x12\x00\x00\x00\xff\xff"),
+ )
+ self.assertEqual(
+ enc_frame2, frame2._replace(data=b"RPS\x00\x00\x00\x00\xff\xff")
+ )
+ self.assertEqual(
+ enc_frame3, frame3._replace(data=b"J.\xca\xcf,.N\xcc+)\x06\x00")
+ )
+
+ dec_frame1 = self.extension.decode(enc_frame1)
+ dec_frame2 = self.extension.decode(enc_frame2)
+ dec_frame3 = self.extension.decode(enc_frame3)
+
+ self.assertEqual(dec_frame1, frame1)
+ self.assertEqual(dec_frame2, frame2)
+ self.assertEqual(dec_frame3, frame3)
+
+ def test_encode_decode_fragmented_binary_frame(self):
+ frame1 = Frame(False, OP_TEXT, b"tea ")
+ frame2 = Frame(True, OP_CONT, b"time")
+
+ enc_frame1 = self.extension.encode(frame1)
+ enc_frame2 = self.extension.encode(frame2)
+
+ self.assertEqual(
+ enc_frame1,
+ frame1._replace(rsv1=True, data=b"*IMT\x00\x00\x00\x00\xff\xff"),
+ )
+ self.assertEqual(
+ enc_frame2,
+ frame2._replace(data=b"*\xc9\xccM\x05\x00"),
+ )
+
+ dec_frame1 = self.extension.decode(enc_frame1)
+ dec_frame2 = self.extension.decode(enc_frame2)
+
+ self.assertEqual(dec_frame1, frame1)
+ self.assertEqual(dec_frame2, frame2)
+
+ def test_no_decode_text_frame(self):
+ frame = Frame(True, OP_TEXT, "café".encode("utf-8"))
+
+ # Try decoding a frame that wasn't encoded.
+ self.assertEqual(self.extension.decode(frame), frame)
+
+ def test_no_decode_binary_frame(self):
+ frame = Frame(True, OP_TEXT, b"tea")
+
+ # Try decoding a frame that wasn't encoded.
+ self.assertEqual(self.extension.decode(frame), frame)
+
+ def test_no_decode_fragmented_text_frame(self):
+ frame1 = Frame(False, OP_TEXT, "café".encode("utf-8"))
+ frame2 = Frame(False, OP_CONT, " & ".encode("utf-8"))
+ frame3 = Frame(True, OP_CONT, "croissants".encode("utf-8"))
+
+ dec_frame1 = self.extension.decode(frame1)
+ dec_frame2 = self.extension.decode(frame2)
+ dec_frame3 = self.extension.decode(frame3)
+
+ self.assertEqual(dec_frame1, frame1)
+ self.assertEqual(dec_frame2, frame2)
+ self.assertEqual(dec_frame3, frame3)
+
+ def test_no_decode_fragmented_binary_frame(self):
+ frame1 = Frame(False, OP_TEXT, b"tea ")
+ frame2 = Frame(True, OP_CONT, b"time")
+
+ dec_frame1 = self.extension.decode(frame1)
+ dec_frame2 = self.extension.decode(frame2)
+
+ self.assertEqual(dec_frame1, frame1)
+ self.assertEqual(dec_frame2, frame2)
+
+ def test_context_takeover(self):
+ frame = Frame(True, OP_TEXT, "café".encode("utf-8"))
+
+ enc_frame1 = self.extension.encode(frame)
+ enc_frame2 = self.extension.encode(frame)
+
+ self.assertEqual(enc_frame1.data, b"JNL;\xbc\x12\x00")
+ self.assertEqual(enc_frame2.data, b"J\x06\x11\x00\x00")
+
+ def test_remote_no_context_takeover(self):
+ # No context takeover when decoding messages.
+ self.extension = PerMessageDeflate(True, False, 15, 15)
+
+ frame = Frame(True, OP_TEXT, "café".encode("utf-8"))
+
+ enc_frame1 = self.extension.encode(frame)
+ enc_frame2 = self.extension.encode(frame)
+
+ self.assertEqual(enc_frame1.data, b"JNL;\xbc\x12\x00")
+ self.assertEqual(enc_frame2.data, b"J\x06\x11\x00\x00")
+
+ dec_frame1 = self.extension.decode(enc_frame1)
+ self.assertEqual(dec_frame1, frame)
+
+ with self.assertRaises(zlib.error) as exc:
+ self.extension.decode(enc_frame2)
+ self.assertIn("invalid distance too far back", str(exc.exception))
+
+ def test_local_no_context_takeover(self):
+ # No context takeover when encoding and decoding messages.
+ self.extension = PerMessageDeflate(True, True, 15, 15)
+
+ frame = Frame(True, OP_TEXT, "café".encode("utf-8"))
+
+ enc_frame1 = self.extension.encode(frame)
+ enc_frame2 = self.extension.encode(frame)
+
+ self.assertEqual(enc_frame1.data, b"JNL;\xbc\x12\x00")
+ self.assertEqual(enc_frame2.data, b"JNL;\xbc\x12\x00")
+
+ dec_frame1 = self.extension.decode(enc_frame1)
+ dec_frame2 = self.extension.decode(enc_frame2)
+
+ self.assertEqual(dec_frame1, frame)
+ self.assertEqual(dec_frame2, frame)
+
+ # Compression settings can be customized.
+
+ def test_compress_settings(self):
+ # Configure an extension so that no compression actually occurs.
+ extension = PerMessageDeflate(False, False, 15, 15, {"level": 0})
+
+ frame = Frame(True, OP_TEXT, "café".encode("utf-8"))
+
+ enc_frame = extension.encode(frame)
+
+ self.assertEqual(
+ enc_frame,
+ frame._replace(
+ rsv1=True, data=b"\x00\x05\x00\xfa\xffcaf\xc3\xa9\x00" # not compressed
+ ),
+ )
+
+ # Frames aren't decoded beyond max_size.
+
+ def test_decompress_max_size(self):
+ frame = Frame(True, OP_TEXT, ("a" * 20).encode("utf-8"))
+
+ enc_frame = self.extension.encode(frame)
+
+ self.assertEqual(enc_frame.data, b"JL\xc4\x04\x00\x00")
+
+ with self.assertRaises(PayloadTooBig):
+ self.extension.decode(enc_frame, max_size=10)
+
+
class ClientPerMessageDeflateFactoryTests(unittest.TestCase, ExtensionTestsMixin):
def test_name(self):
- assert ClientPerMessageDeflateFactory.name == 'permessage-deflate'
+ assert ClientPerMessageDeflateFactory.name == "permessage-deflate"
def test_init(self):
for config in [
@@ -48,7 +271,7 @@ def test_init(self):
(True, False, None, 8), # client_max_window_bits ≥ 8
(True, True, None, 15), # client_max_window_bits ≤ 15
(False, False, None, True), # client_max_window_bits
- (False, False, None, None, {'memLevel': 4}),
+ (False, False, None, None, {"memLevel": 4}),
]:
with self.subTest(config=config):
# This does not raise an exception.
@@ -61,7 +284,7 @@ def test_init_error(self):
(True, False, 16, 15), # server_max_window_bits > 15
(True, True, 15, 16), # client_max_window_bits > 15
(False, False, True, None), # server_max_window_bits
- (False, False, None, None, {'wbits': 11}),
+ (False, False, None, None, {"wbits": 11}),
]:
with self.subTest(config=config):
with self.assertRaises(ValueError):
@@ -72,22 +295,22 @@ def test_get_request_params(self):
# Test without any parameter
((False, False, None, None), []),
# Test server_no_context_takeover
- ((True, False, None, None), [('server_no_context_takeover', None)]),
+ ((True, False, None, None), [("server_no_context_takeover", None)]),
# Test client_no_context_takeover
- ((False, True, None, None), [('client_no_context_takeover', None)]),
+ ((False, True, None, None), [("client_no_context_takeover", None)]),
# Test server_max_window_bits
- ((False, False, 10, None), [('server_max_window_bits', '10')]),
+ ((False, False, 10, None), [("server_max_window_bits", "10")]),
# Test client_max_window_bits
- ((False, False, None, 10), [('client_max_window_bits', '10')]),
- ((False, False, None, True), [('client_max_window_bits', None)]),
+ ((False, False, None, 10), [("client_max_window_bits", "10")]),
+ ((False, False, None, True), [("client_max_window_bits", None)]),
# Test all parameters together
(
(True, True, 12, 12),
[
- ('server_no_context_takeover', None),
- ('client_no_context_takeover', None),
- ('server_max_window_bits', '12'),
- ('client_max_window_bits', '12'),
+ ("server_no_context_takeover", None),
+ ("client_no_context_takeover", None),
+ ("server_max_window_bits", "12"),
+ ("client_max_window_bits", "12"),
],
),
]:
@@ -99,167 +322,167 @@ def test_process_response_params(self):
for config, response_params, result in [
# Test without any parameter
((False, False, None, None), [], (False, False, 15, 15)),
- ((False, False, None, None), [('unknown', None)], InvalidParameterName),
+ ((False, False, None, None), [("unknown", None)], InvalidParameterName),
# Test server_no_context_takeover
(
(False, False, None, None),
- [('server_no_context_takeover', None)],
+ [("server_no_context_takeover", None)],
(True, False, 15, 15),
),
((True, False, None, None), [], NegotiationError),
(
(True, False, None, None),
- [('server_no_context_takeover', None)],
+ [("server_no_context_takeover", None)],
(True, False, 15, 15),
),
(
(True, False, None, None),
- [('server_no_context_takeover', None)] * 2,
+ [("server_no_context_takeover", None)] * 2,
DuplicateParameter,
),
(
(True, False, None, None),
- [('server_no_context_takeover', '42')],
+ [("server_no_context_takeover", "42")],
InvalidParameterValue,
),
# Test client_no_context_takeover
(
(False, False, None, None),
- [('client_no_context_takeover', None)],
+ [("client_no_context_takeover", None)],
(False, True, 15, 15),
),
((False, True, None, None), [], (False, True, 15, 15)),
(
(False, True, None, None),
- [('client_no_context_takeover', None)],
+ [("client_no_context_takeover", None)],
(False, True, 15, 15),
),
(
(False, True, None, None),
- [('client_no_context_takeover', None)] * 2,
+ [("client_no_context_takeover", None)] * 2,
DuplicateParameter,
),
(
(False, True, None, None),
- [('client_no_context_takeover', '42')],
+ [("client_no_context_takeover", "42")],
InvalidParameterValue,
),
# Test server_max_window_bits
(
(False, False, None, None),
- [('server_max_window_bits', '7')],
+ [("server_max_window_bits", "7")],
NegotiationError,
),
(
(False, False, None, None),
- [('server_max_window_bits', '10')],
+ [("server_max_window_bits", "10")],
(False, False, 10, 15),
),
(
(False, False, None, None),
- [('server_max_window_bits', '16')],
+ [("server_max_window_bits", "16")],
NegotiationError,
),
((False, False, 12, None), [], NegotiationError),
(
(False, False, 12, None),
- [('server_max_window_bits', '10')],
+ [("server_max_window_bits", "10")],
(False, False, 10, 15),
),
(
(False, False, 12, None),
- [('server_max_window_bits', '12')],
+ [("server_max_window_bits", "12")],
(False, False, 12, 15),
),
(
(False, False, 12, None),
- [('server_max_window_bits', '13')],
+ [("server_max_window_bits", "13")],
NegotiationError,
),
(
(False, False, 12, None),
- [('server_max_window_bits', '12')] * 2,
+ [("server_max_window_bits", "12")] * 2,
DuplicateParameter,
),
(
(False, False, 12, None),
- [('server_max_window_bits', '42')],
+ [("server_max_window_bits", "42")],
InvalidParameterValue,
),
# Test client_max_window_bits
(
(False, False, None, None),
- [('client_max_window_bits', '10')],
+ [("client_max_window_bits", "10")],
NegotiationError,
),
((False, False, None, True), [], (False, False, 15, 15)),
(
(False, False, None, True),
- [('client_max_window_bits', '7')],
+ [("client_max_window_bits", "7")],
NegotiationError,
),
(
(False, False, None, True),
- [('client_max_window_bits', '10')],
+ [("client_max_window_bits", "10")],
(False, False, 15, 10),
),
(
(False, False, None, True),
- [('client_max_window_bits', '16')],
+ [("client_max_window_bits", "16")],
NegotiationError,
),
((False, False, None, 12), [], (False, False, 15, 12)),
(
(False, False, None, 12),
- [('client_max_window_bits', '10')],
+ [("client_max_window_bits", "10")],
(False, False, 15, 10),
),
(
(False, False, None, 12),
- [('client_max_window_bits', '12')],
+ [("client_max_window_bits", "12")],
(False, False, 15, 12),
),
(
(False, False, None, 12),
- [('client_max_window_bits', '13')],
+ [("client_max_window_bits", "13")],
NegotiationError,
),
(
(False, False, None, 12),
- [('client_max_window_bits', '12')] * 2,
+ [("client_max_window_bits", "12")] * 2,
DuplicateParameter,
),
(
(False, False, None, 12),
- [('client_max_window_bits', '42')],
+ [("client_max_window_bits", "42")],
InvalidParameterValue,
),
# Test all parameters together
(
(True, True, 12, 12),
[
- ('server_no_context_takeover', None),
- ('client_no_context_takeover', None),
- ('server_max_window_bits', '10'),
- ('client_max_window_bits', '10'),
+ ("server_no_context_takeover", None),
+ ("client_no_context_takeover", None),
+ ("server_max_window_bits", "10"),
+ ("client_max_window_bits", "10"),
],
(True, True, 10, 10),
),
(
(False, False, None, True),
[
- ('server_no_context_takeover', None),
- ('client_no_context_takeover', None),
- ('server_max_window_bits', '10'),
- ('client_max_window_bits', '10'),
+ ("server_no_context_takeover", None),
+ ("client_no_context_takeover", None),
+ ("server_max_window_bits", "10"),
+ ("client_max_window_bits", "10"),
],
(True, True, 10, 10),
),
(
(True, True, 12, 12),
[
- ('server_no_context_takeover', None),
- ('server_max_window_bits', '12'),
+ ("server_no_context_takeover", None),
+ ("server_max_window_bits", "12"),
],
(True, True, 12, 12),
),
@@ -281,10 +504,56 @@ def test_process_response_params_deduplication(self):
[], [PerMessageDeflate(False, False, 15, 15)]
)
+ def test_enable_client_permessage_deflate(self):
+ for extensions, (
+ expected_len,
+ expected_position,
+ expected_compress_settings,
+ ) in [
+ (
+ None,
+ (1, 0, None),
+ ),
+ (
+ [],
+ (1, 0, None),
+ ),
+ (
+ [ClientNoOpExtensionFactory()],
+ (2, 1, None),
+ ),
+ (
+ [ClientPerMessageDeflateFactory(compress_settings={"level": 1})],
+ (1, 0, {"level": 1}),
+ ),
+ (
+ [
+ ClientPerMessageDeflateFactory(compress_settings={"level": 1}),
+ ClientNoOpExtensionFactory(),
+ ],
+ (2, 0, {"level": 1}),
+ ),
+ (
+ [
+ ClientNoOpExtensionFactory(),
+ ClientPerMessageDeflateFactory(compress_settings={"level": 1}),
+ ],
+ (2, 1, {"level": 1}),
+ ),
+ ]:
+ with self.subTest(extensions=extensions):
+ extensions = enable_client_permessage_deflate(extensions)
+ self.assertEqual(len(extensions), expected_len)
+ extension = extensions[expected_position]
+ self.assertIsInstance(extension, ClientPerMessageDeflateFactory)
+ self.assertEqual(
+ extension.compress_settings, expected_compress_settings
+ )
+
class ServerPerMessageDeflateFactoryTests(unittest.TestCase, ExtensionTestsMixin):
def test_name(self):
- assert ServerPerMessageDeflateFactory.name == 'permessage-deflate'
+ assert ServerPerMessageDeflateFactory.name == "permessage-deflate"
def test_init(self):
for config in [
@@ -292,7 +561,7 @@ def test_init(self):
(False, True, 15, None), # server_max_window_bits ≤ 15
(True, False, None, 8), # client_max_window_bits ≥ 8
(True, True, None, 15), # client_max_window_bits ≤ 15
- (False, False, None, None, {'memLevel': 4}),
+ (False, False, None, None, {"memLevel": 4}),
]:
with self.subTest(config=config):
# This does not raise an exception.
@@ -306,7 +575,7 @@ def test_init_error(self):
(True, True, 15, 16), # client_max_window_bits > 15
(False, False, None, True), # client_max_window_bits
(False, False, True, None), # server_max_window_bits
- (False, False, None, None, {'wbits': 11}),
+ (False, False, None, None, {"wbits": 11}),
]:
with self.subTest(config=config):
with self.assertRaises(ValueError):
@@ -320,186 +589,186 @@ def test_process_request_params(self):
((False, False, None, None), [], [], (False, False, 15, 15)),
(
(False, False, None, None),
- [('unknown', None)],
+ [("unknown", None)],
None,
InvalidParameterName,
),
# Test server_no_context_takeover
(
(False, False, None, None),
- [('server_no_context_takeover', None)],
- [('server_no_context_takeover', None)],
+ [("server_no_context_takeover", None)],
+ [("server_no_context_takeover", None)],
(False, True, 15, 15),
),
(
(True, False, None, None),
[],
- [('server_no_context_takeover', None)],
+ [("server_no_context_takeover", None)],
(False, True, 15, 15),
),
(
(True, False, None, None),
- [('server_no_context_takeover', None)],
- [('server_no_context_takeover', None)],
+ [("server_no_context_takeover", None)],
+ [("server_no_context_takeover", None)],
(False, True, 15, 15),
),
(
(True, False, None, None),
- [('server_no_context_takeover', None)] * 2,
+ [("server_no_context_takeover", None)] * 2,
None,
DuplicateParameter,
),
(
(True, False, None, None),
- [('server_no_context_takeover', '42')],
+ [("server_no_context_takeover", "42")],
None,
InvalidParameterValue,
),
# Test client_no_context_takeover
(
(False, False, None, None),
- [('client_no_context_takeover', None)],
- [('client_no_context_takeover', None)], # doesn't matter
+ [("client_no_context_takeover", None)],
+ [("client_no_context_takeover", None)], # doesn't matter
(True, False, 15, 15),
),
(
(False, True, None, None),
[],
- [('client_no_context_takeover', None)],
+ [("client_no_context_takeover", None)],
(True, False, 15, 15),
),
(
(False, True, None, None),
- [('client_no_context_takeover', None)],
- [('client_no_context_takeover', None)], # doesn't matter
+ [("client_no_context_takeover", None)],
+ [("client_no_context_takeover", None)], # doesn't matter
(True, False, 15, 15),
),
(
(False, True, None, None),
- [('client_no_context_takeover', None)] * 2,
+ [("client_no_context_takeover", None)] * 2,
None,
DuplicateParameter,
),
(
(False, True, None, None),
- [('client_no_context_takeover', '42')],
+ [("client_no_context_takeover", "42")],
None,
InvalidParameterValue,
),
# Test server_max_window_bits
(
(False, False, None, None),
- [('server_max_window_bits', '7')],
+ [("server_max_window_bits", "7")],
None,
NegotiationError,
),
(
(False, False, None, None),
- [('server_max_window_bits', '10')],
- [('server_max_window_bits', '10')],
+ [("server_max_window_bits", "10")],
+ [("server_max_window_bits", "10")],
(False, False, 15, 10),
),
(
(False, False, None, None),
- [('server_max_window_bits', '16')],
+ [("server_max_window_bits", "16")],
None,
NegotiationError,
),
(
(False, False, 12, None),
[],
- [('server_max_window_bits', '12')],
+ [("server_max_window_bits", "12")],
(False, False, 15, 12),
),
(
(False, False, 12, None),
- [('server_max_window_bits', '10')],
- [('server_max_window_bits', '10')],
+ [("server_max_window_bits", "10")],
+ [("server_max_window_bits", "10")],
(False, False, 15, 10),
),
(
(False, False, 12, None),
- [('server_max_window_bits', '12')],
- [('server_max_window_bits', '12')],
+ [("server_max_window_bits", "12")],
+ [("server_max_window_bits", "12")],
(False, False, 15, 12),
),
(
(False, False, 12, None),
- [('server_max_window_bits', '13')],
- [('server_max_window_bits', '12')],
+ [("server_max_window_bits", "13")],
+ [("server_max_window_bits", "12")],
(False, False, 15, 12),
),
(
(False, False, 12, None),
- [('server_max_window_bits', '12')] * 2,
+ [("server_max_window_bits", "12")] * 2,
None,
DuplicateParameter,
),
(
(False, False, 12, None),
- [('server_max_window_bits', '42')],
+ [("server_max_window_bits", "42")],
None,
InvalidParameterValue,
),
# Test client_max_window_bits
(
(False, False, None, None),
- [('client_max_window_bits', None)],
+ [("client_max_window_bits", None)],
[],
(False, False, 15, 15),
),
(
(False, False, None, None),
- [('client_max_window_bits', '7')],
+ [("client_max_window_bits", "7")],
None,
InvalidParameterValue,
),
(
(False, False, None, None),
- [('client_max_window_bits', '10')],
- [('client_max_window_bits', '10')], # doesn't matter
+ [("client_max_window_bits", "10")],
+ [("client_max_window_bits", "10")], # doesn't matter
(False, False, 10, 15),
),
(
(False, False, None, None),
- [('client_max_window_bits', '16')],
+ [("client_max_window_bits", "16")],
None,
InvalidParameterValue,
),
((False, False, None, 12), [], None, NegotiationError),
(
(False, False, None, 12),
- [('client_max_window_bits', None)],
- [('client_max_window_bits', '12')],
+ [("client_max_window_bits", None)],
+ [("client_max_window_bits", "12")],
(False, False, 12, 15),
),
(
(False, False, None, 12),
- [('client_max_window_bits', '10')],
- [('client_max_window_bits', '10')],
+ [("client_max_window_bits", "10")],
+ [("client_max_window_bits", "10")],
(False, False, 10, 15),
),
(
(False, False, None, 12),
- [('client_max_window_bits', '12')],
- [('client_max_window_bits', '12')], # doesn't matter
+ [("client_max_window_bits", "12")],
+ [("client_max_window_bits", "12")], # doesn't matter
(False, False, 12, 15),
),
(
(False, False, None, 12),
- [('client_max_window_bits', '13')],
- [('client_max_window_bits', '12')], # doesn't matter
+ [("client_max_window_bits", "13")],
+ [("client_max_window_bits", "12")], # doesn't matter
(False, False, 12, 15),
),
(
(False, False, None, 12),
- [('client_max_window_bits', '12')] * 2,
+ [("client_max_window_bits", "12")] * 2,
None,
DuplicateParameter,
),
(
(False, False, None, 12),
- [('client_max_window_bits', '42')],
+ [("client_max_window_bits", "42")],
None,
InvalidParameterValue,
),
@@ -507,43 +776,43 @@ def test_process_request_params(self):
(
(True, True, 12, 12),
[
- ('server_no_context_takeover', None),
- ('client_no_context_takeover', None),
- ('server_max_window_bits', '10'),
- ('client_max_window_bits', '10'),
+ ("server_no_context_takeover", None),
+ ("client_no_context_takeover", None),
+ ("server_max_window_bits", "10"),
+ ("client_max_window_bits", "10"),
],
[
- ('server_no_context_takeover', None),
- ('client_no_context_takeover', None),
- ('server_max_window_bits', '10'),
- ('client_max_window_bits', '10'),
+ ("server_no_context_takeover", None),
+ ("client_no_context_takeover", None),
+ ("server_max_window_bits", "10"),
+ ("client_max_window_bits", "10"),
],
(True, True, 10, 10),
),
(
(False, False, None, None),
[
- ('server_no_context_takeover', None),
- ('client_no_context_takeover', None),
- ('server_max_window_bits', '10'),
- ('client_max_window_bits', '10'),
+ ("server_no_context_takeover", None),
+ ("client_no_context_takeover", None),
+ ("server_max_window_bits", "10"),
+ ("client_max_window_bits", "10"),
],
[
- ('server_no_context_takeover', None),
- ('client_no_context_takeover', None),
- ('server_max_window_bits', '10'),
- ('client_max_window_bits', '10'),
+ ("server_no_context_takeover", None),
+ ("client_no_context_takeover", None),
+ ("server_max_window_bits", "10"),
+ ("client_max_window_bits", "10"),
],
(True, True, 10, 10),
),
(
(True, True, 12, 12),
- [('client_max_window_bits', None)],
+ [("client_max_window_bits", None)],
[
- ('server_no_context_takeover', None),
- ('client_no_context_takeover', None),
- ('server_max_window_bits', '12'),
- ('client_max_window_bits', '12'),
+ ("server_no_context_takeover", None),
+ ("client_no_context_takeover", None),
+ ("server_max_window_bits", "12"),
+ ("client_max_window_bits", "12"),
],
(True, True, 12, 12),
),
@@ -572,221 +841,48 @@ def test_process_response_params_deduplication(self):
[], [PerMessageDeflate(False, False, 15, 15)]
)
-
-class PerMessageDeflateTests(unittest.TestCase, ExtensionTestsMixin):
- def setUp(self):
- # Set up an instance of the permessage-deflate extension with the most
- # common settings. Since the extension is symmetrical, this instance
- # may be used for testing both encoding and decoding.
- self.extension = PerMessageDeflate(False, False, 15, 15)
-
- def test_name(self):
- assert self.extension.name == 'permessage-deflate'
-
- def test_repr(self):
- self.assertExtensionEqual(eval(repr(self.extension)), self.extension)
-
- # Control frames aren't encoded or decoded.
-
- def test_no_encode_decode_ping_frame(self):
- frame = Frame(True, OP_PING, b'')
-
- self.assertEqual(self.extension.encode(frame), frame)
-
- self.assertEqual(self.extension.decode(frame), frame)
-
- def test_no_encode_decode_pong_frame(self):
- frame = Frame(True, OP_PONG, b'')
-
- self.assertEqual(self.extension.encode(frame), frame)
-
- self.assertEqual(self.extension.decode(frame), frame)
-
- def test_no_encode_decode_close_frame(self):
- frame = Frame(True, OP_CLOSE, serialize_close(1000, ''))
-
- self.assertEqual(self.extension.encode(frame), frame)
-
- self.assertEqual(self.extension.decode(frame), frame)
-
- # Data frames are encoded and decoded.
-
- def test_encode_decode_text_frame(self):
- frame = Frame(True, OP_TEXT, 'café'.encode('utf-8'))
-
- enc_frame = self.extension.encode(frame)
-
- self.assertEqual(enc_frame, frame._replace(rsv1=True, data=b'JNL;\xbc\x12\x00'))
-
- dec_frame = self.extension.decode(enc_frame)
-
- self.assertEqual(dec_frame, frame)
-
- def test_encode_decode_binary_frame(self):
- frame = Frame(True, OP_BINARY, b'tea')
-
- enc_frame = self.extension.encode(frame)
-
- self.assertEqual(enc_frame, frame._replace(rsv1=True, data=b'*IM\x04\x00'))
-
- dec_frame = self.extension.decode(enc_frame)
-
- self.assertEqual(dec_frame, frame)
-
- def test_encode_decode_fragmented_text_frame(self):
- frame1 = Frame(False, OP_TEXT, 'café'.encode('utf-8'))
- frame2 = Frame(False, OP_CONT, ' & '.encode('utf-8'))
- frame3 = Frame(True, OP_CONT, 'croissants'.encode('utf-8'))
-
- enc_frame1 = self.extension.encode(frame1)
- enc_frame2 = self.extension.encode(frame2)
- enc_frame3 = self.extension.encode(frame3)
-
- self.assertEqual(
- enc_frame1,
- frame1._replace(rsv1=True, data=b'JNL;\xbc\x12\x00\x00\x00\xff\xff'),
- )
- self.assertEqual(
- enc_frame2, frame2._replace(rsv1=True, data=b'RPS\x00\x00\x00\x00\xff\xff')
- )
- self.assertEqual(
- enc_frame3, frame3._replace(rsv1=True, data=b'J.\xca\xcf,.N\xcc+)\x06\x00')
- )
-
- dec_frame1 = self.extension.decode(enc_frame1)
- dec_frame2 = self.extension.decode(enc_frame2)
- dec_frame3 = self.extension.decode(enc_frame3)
-
- self.assertEqual(dec_frame1, frame1)
- self.assertEqual(dec_frame2, frame2)
- self.assertEqual(dec_frame3, frame3)
-
- def test_encode_decode_fragmented_binary_frame(self):
- frame1 = Frame(False, OP_TEXT, b'tea ')
- frame2 = Frame(True, OP_CONT, b'time')
-
- enc_frame1 = self.extension.encode(frame1)
- enc_frame2 = self.extension.encode(frame2)
-
- self.assertEqual(
- enc_frame1, frame1._replace(rsv1=True, data=b'*IMT\x00\x00\x00\x00\xff\xff')
- )
- self.assertEqual(
- enc_frame2, frame2._replace(rsv1=True, data=b'*\xc9\xccM\x05\x00')
- )
-
- dec_frame1 = self.extension.decode(enc_frame1)
- dec_frame2 = self.extension.decode(enc_frame2)
-
- self.assertEqual(dec_frame1, frame1)
- self.assertEqual(dec_frame2, frame2)
-
- def test_no_decode_text_frame(self):
- frame = Frame(True, OP_TEXT, 'café'.encode('utf-8'))
-
- # Try decoding a frame that wasn't encoded.
- self.assertEqual(self.extension.decode(frame), frame)
-
- def test_no_decode_binary_frame(self):
- frame = Frame(True, OP_TEXT, b'tea')
-
- # Try decoding a frame that wasn't encoded.
- self.assertEqual(self.extension.decode(frame), frame)
-
- def test_no_decode_fragmented_text_frame(self):
- frame1 = Frame(False, OP_TEXT, 'café'.encode('utf-8'))
- frame2 = Frame(False, OP_CONT, ' & '.encode('utf-8'))
- frame3 = Frame(True, OP_CONT, 'croissants'.encode('utf-8'))
-
- dec_frame1 = self.extension.decode(frame1)
- dec_frame2 = self.extension.decode(frame2)
- dec_frame3 = self.extension.decode(frame3)
-
- self.assertEqual(dec_frame1, frame1)
- self.assertEqual(dec_frame2, frame2)
- self.assertEqual(dec_frame3, frame3)
-
- def test_no_decode_fragmented_binary_frame(self):
- frame1 = Frame(False, OP_TEXT, b'tea ')
- frame2 = Frame(True, OP_CONT, b'time')
-
- dec_frame1 = self.extension.decode(frame1)
- dec_frame2 = self.extension.decode(frame2)
-
- self.assertEqual(dec_frame1, frame1)
- self.assertEqual(dec_frame2, frame2)
-
- def test_context_takeover(self):
- frame = Frame(True, OP_TEXT, 'café'.encode('utf-8'))
-
- enc_frame1 = self.extension.encode(frame)
- enc_frame2 = self.extension.encode(frame)
-
- self.assertEqual(enc_frame1.data, b'JNL;\xbc\x12\x00')
- self.assertEqual(enc_frame2.data, b'J\x06\x11\x00\x00')
-
- def test_remote_no_context_takeover(self):
- # No context takeover when decoding messages.
- self.extension = PerMessageDeflate(True, False, 15, 15)
-
- frame = Frame(True, OP_TEXT, 'café'.encode('utf-8'))
-
- enc_frame1 = self.extension.encode(frame)
- enc_frame2 = self.extension.encode(frame)
-
- self.assertEqual(enc_frame1.data, b'JNL;\xbc\x12\x00')
- self.assertEqual(enc_frame2.data, b'J\x06\x11\x00\x00')
-
- dec_frame1 = self.extension.decode(enc_frame1)
- self.assertEqual(dec_frame1, frame)
-
- with self.assertRaises(zlib.error) as exc:
- self.extension.decode(enc_frame2)
- self.assertIn("invalid distance too far back", str(exc.exception))
-
- def test_local_no_context_takeover(self):
- # No context takeover when encoding and decoding messages.
- self.extension = PerMessageDeflate(True, True, 15, 15)
-
- frame = Frame(True, OP_TEXT, 'café'.encode('utf-8'))
-
- enc_frame1 = self.extension.encode(frame)
- enc_frame2 = self.extension.encode(frame)
-
- self.assertEqual(enc_frame1.data, b'JNL;\xbc\x12\x00')
- self.assertEqual(enc_frame2.data, b'JNL;\xbc\x12\x00')
-
- dec_frame1 = self.extension.decode(enc_frame1)
- dec_frame2 = self.extension.decode(enc_frame2)
-
- self.assertEqual(dec_frame1, frame)
- self.assertEqual(dec_frame2, frame)
-
- # Compression settings can be customized.
-
- def test_compress_settings(self):
- # Configure an extension so that no compression actually occurs.
- extension = PerMessageDeflate(False, False, 15, 15, {'level': 0})
-
- frame = Frame(True, OP_TEXT, 'café'.encode('utf-8'))
-
- enc_frame = extension.encode(frame)
-
- self.assertEqual(
- enc_frame,
- frame._replace(
- rsv1=True, data=b'\x00\x05\x00\xfa\xffcaf\xc3\xa9\x00' # not compressed
+ def test_enable_server_permessage_deflate(self):
+ for extensions, (
+ expected_len,
+ expected_position,
+ expected_compress_settings,
+ ) in [
+ (
+ None,
+ (1, 0, None),
),
- )
-
- # Frames aren't decoded beyond max_length.
-
- def test_decompress_max_size(self):
- frame = Frame(True, OP_TEXT, ('a' * 20).encode('utf-8'))
-
- enc_frame = self.extension.encode(frame)
-
- self.assertEqual(enc_frame.data, b'JL\xc4\x04\x00\x00')
-
- with self.assertRaises(PayloadTooBig):
- self.extension.decode(enc_frame, max_size=10)
+ (
+ [],
+ (1, 0, None),
+ ),
+ (
+ [ServerNoOpExtensionFactory()],
+ (2, 1, None),
+ ),
+ (
+ [ServerPerMessageDeflateFactory(compress_settings={"level": 1})],
+ (1, 0, {"level": 1}),
+ ),
+ (
+ [
+ ServerPerMessageDeflateFactory(compress_settings={"level": 1}),
+ ServerNoOpExtensionFactory(),
+ ],
+ (2, 0, {"level": 1}),
+ ),
+ (
+ [
+ ServerNoOpExtensionFactory(),
+ ServerPerMessageDeflateFactory(compress_settings={"level": 1}),
+ ],
+ (2, 1, {"level": 1}),
+ ),
+ ]:
+ with self.subTest(extensions=extensions):
+ extensions = enable_server_permessage_deflate(extensions)
+ self.assertEqual(len(extensions), expected_len)
+ extension = extensions[expected_position]
+ self.assertIsInstance(extension, ServerPerMessageDeflateFactory)
+ self.assertEqual(
+ extension.compress_settings, expected_compress_settings
+ )
diff --git a/tests/extensions/utils.py b/tests/extensions/utils.py
new file mode 100644
index 000000000..81990bb07
--- /dev/null
+++ b/tests/extensions/utils.py
@@ -0,0 +1,76 @@
+from websockets.exceptions import NegotiationError
+
+
+class OpExtension:
+ name = "x-op"
+
+ def __init__(self, op=None):
+ self.op = op
+
+ def decode(self, frame, *, max_size=None):
+ return frame # pragma: no cover
+
+ def encode(self, frame):
+ return frame # pragma: no cover
+
+ def __eq__(self, other):
+ return isinstance(other, OpExtension) and self.op == other.op
+
+
+class ClientOpExtensionFactory:
+ name = "x-op"
+
+ def __init__(self, op=None):
+ self.op = op
+
+ def get_request_params(self):
+ return [("op", self.op)]
+
+ def process_response_params(self, params, accepted_extensions):
+ if params != [("op", self.op)]:
+ raise NegotiationError()
+ return OpExtension(self.op)
+
+
+class ServerOpExtensionFactory:
+ name = "x-op"
+
+ def __init__(self, op=None):
+ self.op = op
+
+ def process_request_params(self, params, accepted_extensions):
+ if params != [("op", self.op)]:
+ raise NegotiationError()
+ return [("op", self.op)], OpExtension(self.op)
+
+
+class Rsv2Extension:
+ name = "x-rsv2"
+
+ def decode(self, frame, *, max_size=None):
+ assert frame.rsv2
+ return frame._replace(rsv2=False)
+
+ def encode(self, frame):
+ assert not frame.rsv2
+ return frame._replace(rsv2=True)
+
+ def __eq__(self, other):
+ return isinstance(other, Rsv2Extension)
+
+
+class ClientRsv2ExtensionFactory:
+ name = "x-rsv2"
+
+ def get_request_params(self):
+ return []
+
+ def process_response_params(self, params, accepted_extensions):
+ return Rsv2Extension()
+
+
+class ServerRsv2ExtensionFactory:
+ name = "x-rsv2"
+
+ def process_request_params(self, params, accepted_extensions):
+ return [], Rsv2Extension()
diff --git a/tests/test_speedups.py b/tests/legacy/__init__.py
similarity index 100%
rename from tests/test_speedups.py
rename to tests/legacy/__init__.py
diff --git a/tests/legacy/test_auth.py b/tests/legacy/test_auth.py
new file mode 100644
index 000000000..3d8eb90d7
--- /dev/null
+++ b/tests/legacy/test_auth.py
@@ -0,0 +1,167 @@
+import hmac
+import unittest
+import urllib.error
+
+from websockets.exceptions import InvalidStatusCode
+from websockets.headers import build_authorization_basic
+from websockets.legacy.auth import *
+from websockets.legacy.auth import is_credentials
+
+from .test_client_server import ClientServerTestsMixin, with_client, with_server
+from .utils import AsyncioTestCase
+
+
+class AuthTests(unittest.TestCase):
+ def test_is_credentials(self):
+ self.assertTrue(is_credentials(("username", "password")))
+
+ def test_is_not_credentials(self):
+ self.assertFalse(is_credentials(None))
+ self.assertFalse(is_credentials("username"))
+
+
+class CustomWebSocketServerProtocol(BasicAuthWebSocketServerProtocol):
+ async def process_request(self, path, request_headers):
+ type(self).used = True
+ return await super().process_request(path, request_headers)
+
+
+class AuthClientServerTests(ClientServerTestsMixin, AsyncioTestCase):
+
+ create_protocol = basic_auth_protocol_factory(
+ realm="auth-tests", credentials=("hello", "iloveyou")
+ )
+
+ @with_server(create_protocol=create_protocol)
+ @with_client(user_info=("hello", "iloveyou"))
+ def test_basic_auth(self):
+ req_headers = self.client.request_headers
+ resp_headers = self.client.response_headers
+ self.assertEqual(req_headers["Authorization"], "Basic aGVsbG86aWxvdmV5b3U=")
+ self.assertNotIn("WWW-Authenticate", resp_headers)
+
+ self.loop.run_until_complete(self.client.send("Hello!"))
+ self.loop.run_until_complete(self.client.recv())
+
+ def test_basic_auth_server_no_credentials(self):
+ with self.assertRaises(TypeError) as raised:
+ basic_auth_protocol_factory(realm="auth-tests", credentials=None)
+ self.assertEqual(
+ str(raised.exception), "provide either credentials or check_credentials"
+ )
+
+ def test_basic_auth_server_bad_credentials(self):
+ with self.assertRaises(TypeError) as raised:
+ basic_auth_protocol_factory(realm="auth-tests", credentials=42)
+ self.assertEqual(str(raised.exception), "invalid credentials argument: 42")
+
+ create_protocol_multiple_credentials = basic_auth_protocol_factory(
+ realm="auth-tests",
+ credentials=[("hello", "iloveyou"), ("goodbye", "stillloveu")],
+ )
+
+ @with_server(create_protocol=create_protocol_multiple_credentials)
+ @with_client(user_info=("hello", "iloveyou"))
+ def test_basic_auth_server_multiple_credentials(self):
+ self.loop.run_until_complete(self.client.send("Hello!"))
+ self.loop.run_until_complete(self.client.recv())
+
+ def test_basic_auth_bad_multiple_credentials(self):
+ with self.assertRaises(TypeError) as raised:
+ basic_auth_protocol_factory(
+ realm="auth-tests", credentials=[("hello", "iloveyou"), 42]
+ )
+ self.assertEqual(
+ str(raised.exception),
+ "invalid credentials argument: [('hello', 'iloveyou'), 42]",
+ )
+
+ async def check_credentials(username, password):
+ return hmac.compare_digest(password, "iloveyou")
+
+ create_protocol_check_credentials = basic_auth_protocol_factory(
+ realm="auth-tests",
+ check_credentials=check_credentials,
+ )
+
+ @with_server(create_protocol=create_protocol_check_credentials)
+ @with_client(user_info=("hello", "iloveyou"))
+ def test_basic_auth_check_credentials(self):
+ self.loop.run_until_complete(self.client.send("Hello!"))
+ self.loop.run_until_complete(self.client.recv())
+
+ create_protocol_custom_protocol = basic_auth_protocol_factory(
+ realm="auth-tests",
+ credentials=[("hello", "iloveyou")],
+ create_protocol=CustomWebSocketServerProtocol,
+ )
+
+ @with_server(create_protocol=create_protocol_custom_protocol)
+ @with_client(user_info=("hello", "iloveyou"))
+ def test_basic_auth_custom_protocol(self):
+ self.assertTrue(CustomWebSocketServerProtocol.used)
+ del CustomWebSocketServerProtocol.used
+ self.loop.run_until_complete(self.client.send("Hello!"))
+ self.loop.run_until_complete(self.client.recv())
+
+ @with_server(create_protocol=create_protocol)
+ def test_basic_auth_missing_credentials(self):
+ with self.assertRaises(InvalidStatusCode) as raised:
+ self.start_client()
+ self.assertEqual(raised.exception.status_code, 401)
+
+ @with_server(create_protocol=create_protocol)
+ def test_basic_auth_missing_credentials_details(self):
+ with self.assertRaises(urllib.error.HTTPError) as raised:
+ self.loop.run_until_complete(self.make_http_request())
+ self.assertEqual(raised.exception.code, 401)
+ self.assertEqual(
+ raised.exception.headers["WWW-Authenticate"],
+ 'Basic realm="auth-tests", charset="UTF-8"',
+ )
+ self.assertEqual(raised.exception.read().decode(), "Missing credentials\n")
+
+ @with_server(create_protocol=create_protocol)
+ def test_basic_auth_unsupported_credentials(self):
+ with self.assertRaises(InvalidStatusCode) as raised:
+ self.start_client(extra_headers={"Authorization": "Digest ..."})
+ self.assertEqual(raised.exception.status_code, 401)
+
+ @with_server(create_protocol=create_protocol)
+ def test_basic_auth_unsupported_credentials_details(self):
+ with self.assertRaises(urllib.error.HTTPError) as raised:
+ self.loop.run_until_complete(
+ self.make_http_request(headers={"Authorization": "Digest ..."})
+ )
+ self.assertEqual(raised.exception.code, 401)
+ self.assertEqual(
+ raised.exception.headers["WWW-Authenticate"],
+ 'Basic realm="auth-tests", charset="UTF-8"',
+ )
+ self.assertEqual(raised.exception.read().decode(), "Unsupported credentials\n")
+
+ @with_server(create_protocol=create_protocol)
+ def test_basic_auth_invalid_username(self):
+ with self.assertRaises(InvalidStatusCode) as raised:
+ self.start_client(user_info=("goodbye", "iloveyou"))
+ self.assertEqual(raised.exception.status_code, 401)
+
+ @with_server(create_protocol=create_protocol)
+ def test_basic_auth_invalid_password(self):
+ with self.assertRaises(InvalidStatusCode) as raised:
+ self.start_client(user_info=("hello", "ihateyou"))
+ self.assertEqual(raised.exception.status_code, 401)
+
+ @with_server(create_protocol=create_protocol)
+ def test_basic_auth_invalid_credentials_details(self):
+ with self.assertRaises(urllib.error.HTTPError) as raised:
+ authorization = build_authorization_basic("hello", "ihateyou")
+ self.loop.run_until_complete(
+ self.make_http_request(headers={"Authorization": authorization})
+ )
+ self.assertEqual(raised.exception.code, 401)
+ self.assertEqual(
+ raised.exception.headers["WWW-Authenticate"],
+ 'Basic realm="auth-tests", charset="UTF-8"',
+ )
+ self.assertEqual(raised.exception.read().decode(), "Invalid credentials\n")
diff --git a/tests/test_client_server.py b/tests/legacy/test_client_server.py
similarity index 50%
rename from tests/test_client_server.py
rename to tests/legacy/test_client_server.py
index dee44a662..499ea1d59 100644
--- a/tests/test_client_server.py
+++ b/tests/legacy/test_client_server.py
@@ -1,12 +1,11 @@
import asyncio
import contextlib
import functools
-import logging
+import http
import pathlib
import random
import socket
import ssl
-import sys
import tempfile
import unittest
import unittest.mock
@@ -14,11 +13,11 @@
import urllib.request
import warnings
-from websockets.client import *
-from websockets.compatibility import FORBIDDEN, OK, UNAUTHORIZED
+from websockets.datastructures import Headers
from websockets.exceptions import (
ConnectionClosed,
InvalidHandshake,
+ InvalidHeader,
InvalidStatusCode,
NegotiationError,
)
@@ -27,16 +26,20 @@
PerMessageDeflate,
ServerPerMessageDeflateFactory,
)
-from websockets.handshake import build_response
-from websockets.http import USER_AGENT, Headers, read_response
-from websockets.protocol import State
-from websockets.server import *
-
-from .test_protocol import MS
-
-
-# Avoid displaying stack traces at the ERROR logging level.
-logging.basicConfig(level=logging.CRITICAL)
+from websockets.http import USER_AGENT
+from websockets.legacy.client import *
+from websockets.legacy.handshake import build_response
+from websockets.legacy.http import read_response
+from websockets.legacy.protocol import State
+from websockets.legacy.server import *
+from websockets.uri import parse_uri
+
+from ..extensions.test_base import (
+ ClientNoOpExtensionFactory,
+ NoOpExtension,
+ ServerNoOpExtensionFactory,
+)
+from .utils import MS, AsyncioTestCase
# Generate TLS certificate with:
@@ -45,34 +48,34 @@
# $ cat test_localhost.key test_localhost.crt > test_localhost.pem
# $ rm test_localhost.key test_localhost.crt
-testcert = bytes(pathlib.Path(__file__).with_name('test_localhost.pem'))
-
-
-@asyncio.coroutine
-def handler(ws, path):
- if path == '/attributes':
- yield from ws.send(repr((ws.host, ws.port, ws.secure)))
- elif path == '/close_timeout':
- yield from ws.send(repr(ws.close_timeout))
- elif path == '/path':
- yield from ws.send(str(ws.path))
- elif path == '/headers':
- yield from ws.send(repr(ws.request_headers))
- yield from ws.send(repr(ws.response_headers))
- elif path == '/extensions':
- yield from ws.send(repr(ws.extensions))
- elif path == '/subprotocol':
- yield from ws.send(repr(ws.subprotocol))
- elif path == '/slow_stop':
- yield from ws.wait_closed()
- yield from asyncio.sleep(2 * MS)
+testcert = bytes(pathlib.Path(__file__).parent.with_name("test_localhost.pem"))
+
+
+async def handler(ws, path):
+ if path == "/deprecated_attributes":
+ await ws.recv() # delay that allows catching warnings
+ await ws.send(repr((ws.host, ws.port, ws.secure)))
+ elif path == "/close_timeout":
+ await ws.send(repr(ws.close_timeout))
+ elif path == "/path":
+ await ws.send(str(ws.path))
+ elif path == "/headers":
+ await ws.send(repr(ws.request_headers))
+ await ws.send(repr(ws.response_headers))
+ elif path == "/extensions":
+ await ws.send(repr(ws.extensions))
+ elif path == "/subprotocol":
+ await ws.send(repr(ws.subprotocol))
+ elif path == "/slow_stop":
+ await ws.wait_closed()
+ await asyncio.sleep(2 * MS)
else:
- yield from ws.send((yield from ws.recv()))
+ await ws.send((await ws.recv()))
@contextlib.contextmanager
-def temp_test_server(test, **kwds):
- test.start_server(**kwds)
+def temp_test_server(test, **kwargs):
+ test.start_server(**kwargs)
try:
yield
finally:
@@ -80,15 +83,26 @@ def temp_test_server(test, **kwds):
@contextlib.contextmanager
-def temp_test_client(test, *args, **kwds):
- test.start_client(*args, **kwds)
+def temp_test_redirecting_server(
+ test, status, include_location=True, force_insecure=False
+):
+ test.start_redirecting_server(status, include_location, force_insecure)
+ try:
+ yield
+ finally:
+ test.stop_redirecting_server()
+
+
+@contextlib.contextmanager
+def temp_test_client(test, *args, **kwargs):
+ test.start_client(*args, **kwargs)
try:
yield
finally:
test.stop_client()
-def with_manager(manager, *args, **kwds):
+def with_manager(manager, *args, **kwargs):
"""
Return a decorator that wraps a function with a context manager.
@@ -96,39 +110,39 @@ def with_manager(manager, *args, **kwds):
def decorate(func):
@functools.wraps(func)
- def _decorate(self, *_args, **_kwds):
- with manager(self, *args, **kwds):
- return func(self, *_args, **_kwds)
+ def _decorate(self, *_args, **_kwargs):
+ with manager(self, *args, **kwargs):
+ return func(self, *_args, **_kwargs)
return _decorate
return decorate
-def with_server(**kwds):
+def with_server(**kwargs):
"""
Return a decorator for TestCase methods that starts and stops a server.
"""
- return with_manager(temp_test_server, **kwds)
+ return with_manager(temp_test_server, **kwargs)
-def with_client(*args, **kwds):
+def with_client(*args, **kwargs):
"""
Return a decorator for TestCase methods that starts and stops a client.
"""
- return with_manager(temp_test_client, *args, **kwds)
+ return with_manager(temp_test_client, *args, **kwargs)
-def get_server_uri(server, secure=False, resource_name='/', user_info=None):
+def get_server_uri(server, secure=False, resource_name="/", user_info=None):
"""
Return a WebSocket URI for connecting to the given server.
"""
- proto = 'wss' if secure else 'ws'
+ proto = "wss" if secure else "ws"
- user_info = ':'.join(user_info) + '@' if user_info else ''
+ user_info = ":".join(user_info) + "@" if user_info else ""
# Pick a random socket in order to test both IPv4 and IPv6 on systems
# where both are available. Randomizing tests is usually a bad idea. If
@@ -137,44 +151,37 @@ def get_server_uri(server, secure=False, resource_name='/', user_info=None):
if server_socket.family == socket.AF_INET6: # pragma: no cover
host, port = server_socket.getsockname()[:2] # (no IPv6 on CI)
- host = '[{}]'.format(host)
+ host = f"[{host}]"
elif server_socket.family == socket.AF_INET:
host, port = server_socket.getsockname()
- elif server_socket.family == socket.AF_UNIX:
- # The host and port are ignored when connecting to a Unix socket.
- host, port = 'localhost', 0
else: # pragma: no cover
- raise ValueError("Expected an IPv6, IPv4, or Unix socket")
+ raise ValueError("expected an IPv6, IPv4, or Unix socket")
- return '{}://{}{}:{}{}'.format(proto, user_info, host, port, resource_name)
+ return f"{proto}://{user_info}{host}:{port}{resource_name}"
class UnauthorizedServerProtocol(WebSocketServerProtocol):
- @asyncio.coroutine
- def process_request(self, path, request_headers):
+ async def process_request(self, path, request_headers):
# Test returning headers as a Headers instance (1/3)
- return UNAUTHORIZED, Headers([('X-Access', 'denied')]), b''
+ return http.HTTPStatus.UNAUTHORIZED, Headers([("X-Access", "denied")]), b""
class ForbiddenServerProtocol(WebSocketServerProtocol):
- @asyncio.coroutine
- def process_request(self, path, request_headers):
+ async def process_request(self, path, request_headers):
# Test returning headers as a dict (2/3)
- return FORBIDDEN, {'X-Access': 'denied'}, b''
+ return http.HTTPStatus.FORBIDDEN, {"X-Access": "denied"}, b""
class HealthCheckServerProtocol(WebSocketServerProtocol):
- @asyncio.coroutine
- def process_request(self, path, request_headers):
+ async def process_request(self, path, request_headers):
# Test returning headers as a list of pairs (3/3)
- if path == '/__health__/':
- return OK, [('X-Access', 'OK')], b'status = green\n'
+ if path == "/__health__/":
+ return http.HTTPStatus.OK, [("X-Access", "OK")], b"status = green\n"
-class SlowServerProtocol(WebSocketServerProtocol):
- @asyncio.coroutine
- def process_request(self, path, request_headers):
- yield from asyncio.sleep(10 * MS)
+class SlowOpeningHandshakeProtocol(WebSocketServerProtocol):
+ async def process_request(self, path, request_headers):
+ await asyncio.sleep(10 * MS)
class FooClientProtocol(WebSocketClientProtocol):
@@ -185,75 +192,73 @@ class BarClientProtocol(WebSocketClientProtocol):
pass
-class ClientNoOpExtensionFactory:
- name = 'x-no-op'
-
- def get_request_params(self):
- return []
-
- def process_response_params(self, params, accepted_extensions):
- if params:
- raise NegotiationError()
- return NoOpExtension()
-
-
-class ServerNoOpExtensionFactory:
- name = 'x-no-op'
-
- def __init__(self, params=None):
- self.params = params or []
-
- def process_request_params(self, params, accepted_extensions):
- return self.params, NoOpExtension()
-
-
-class NoOpExtension:
- name = 'x-no-op'
-
- def __repr__(self):
- return 'NoOpExtension()'
-
- def decode(self, frame, *, max_size=None):
- return frame
-
- def encode(self, frame):
- return frame
-
-
-class ClientServerTests(unittest.TestCase):
+class ClientServerTestsMixin:
secure = False
def setUp(self):
- self.loop = asyncio.new_event_loop()
- asyncio.set_event_loop(self.loop)
+ super().setUp()
+ self.server = None
+ self.redirecting_server = None
- def tearDown(self):
- self.loop.close()
-
- def run_loop_once(self):
- # Process callbacks scheduled with call_soon by appending a callback
- # to stop the event loop then running it until it hits that callback.
- self.loop.call_soon(self.loop.stop)
- self.loop.run_forever()
+ @property
+ def server_context(self):
+ return None
- def start_server(self, **kwds):
+ def start_server(self, deprecation_warnings=None, **kwargs):
# Disable compression by default in tests.
- kwds.setdefault('compression', None)
+ kwargs.setdefault("compression", None)
# Disable pings by default in tests.
- kwds.setdefault('ping_interval', None)
- start_server = serve(handler, 'localhost', 0, **kwds)
- self.server = self.loop.run_until_complete(start_server)
+ kwargs.setdefault("ping_interval", None)
- def start_client(self, resource_name='/', user_info=None, **kwds):
+ with warnings.catch_warnings(record=True) as recorded_warnings:
+ start_server = serve(handler, "localhost", 0, **kwargs)
+ self.server = self.loop.run_until_complete(start_server)
+
+ expected_warnings = [] if deprecation_warnings is None else deprecation_warnings
+ self.assertDeprecationWarnings(recorded_warnings, expected_warnings)
+
+ def start_redirecting_server(
+ self, status, include_location=True, force_insecure=False
+ ):
+ async def process_request(path, headers):
+ server_uri = get_server_uri(self.server, self.secure, path)
+ if force_insecure:
+ server_uri = server_uri.replace("wss:", "ws:")
+ headers = {"Location": server_uri} if include_location else []
+ return status, headers, b""
+
+ start_server = serve(
+ handler,
+ "localhost",
+ 0,
+ compression=None,
+ ping_interval=None,
+ process_request=process_request,
+ ssl=self.server_context,
+ )
+ self.redirecting_server = self.loop.run_until_complete(start_server)
+
+ def start_client(
+ self, resource_name="/", user_info=None, deprecation_warnings=None, **kwargs
+ ):
# Disable compression by default in tests.
- kwds.setdefault('compression', None)
+ kwargs.setdefault("compression", None)
# Disable pings by default in tests.
- kwds.setdefault('ping_interval', None)
- secure = kwds.get('ssl') is not None
- server_uri = get_server_uri(self.server, secure, resource_name, user_info)
- start_client = connect(server_uri, **kwds)
- self.client = self.loop.run_until_complete(start_client)
+ kwargs.setdefault("ping_interval", None)
+ secure = kwargs.get("ssl") is not None
+ try:
+ server_uri = kwargs.pop("uri")
+ except KeyError:
+ server = self.redirecting_server if self.redirecting_server else self.server
+ server_uri = get_server_uri(server, secure, resource_name, user_info)
+
+ with warnings.catch_warnings(record=True) as recorded_warnings:
+ start_client = connect(server_uri, **kwargs)
+ self.client = self.loop.run_until_complete(start_client)
+
+ expected_warnings = [] if deprecation_warnings is None else deprecation_warnings
+ self.assertDeprecationWarnings(recorded_warnings, expected_warnings)
def stop_client(self):
try:
@@ -272,16 +277,81 @@ def stop_server(self):
except asyncio.TimeoutError: # pragma: no cover
self.fail("Server failed to stop")
+ def stop_redirecting_server(self):
+ self.redirecting_server.close()
+ try:
+ self.loop.run_until_complete(
+ asyncio.wait_for(self.redirecting_server.wait_closed(), timeout=1)
+ )
+ except asyncio.TimeoutError: # pragma: no cover
+ self.fail("Redirecting server failed to stop")
+ finally:
+ self.redirecting_server = None
+
@contextlib.contextmanager
- def temp_server(self, **kwds):
- with temp_test_server(self, **kwds):
+ def temp_server(self, **kwargs):
+ with temp_test_server(self, **kwargs):
yield
@contextlib.contextmanager
- def temp_client(self, *args, **kwds):
- with temp_test_client(self, *args, **kwds):
+ def temp_client(self, *args, **kwargs):
+ with temp_test_client(self, *args, **kwargs):
yield
+ def make_http_request(self, path="/", headers=None):
+ if headers is None:
+ headers = {}
+
+ # Set url to 'https?://:'.
+ url = get_server_uri(
+ self.server, resource_name=path, secure=self.secure
+ ).replace("ws", "http")
+
+ request = urllib.request.Request(url=url, headers=headers)
+
+ if self.secure:
+ open_health_check = functools.partial(
+ urllib.request.urlopen, request, context=self.client_context
+ )
+ else:
+ open_health_check = functools.partial(urllib.request.urlopen, request)
+
+ return self.loop.run_in_executor(None, open_health_check)
+
+
+class SecureClientServerTestsMixin(ClientServerTestsMixin):
+
+ secure = True
+
+ @property
+ def server_context(self):
+ ssl_context = ssl.SSLContext(ssl.PROTOCOL_TLS_SERVER)
+ ssl_context.load_cert_chain(testcert)
+ return ssl_context
+
+ @property
+ def client_context(self):
+ ssl_context = ssl.SSLContext(ssl.PROTOCOL_TLS_CLIENT)
+ ssl_context.load_verify_locations(testcert)
+ return ssl_context
+
+ def start_server(self, **kwargs):
+ kwargs.setdefault("ssl", self.server_context)
+ super().start_server(**kwargs)
+
+ def start_client(self, path="/", **kwargs):
+ kwargs.setdefault("ssl", self.client_context)
+ super().start_client(path, **kwargs)
+
+
+class CommonClientServerTests:
+ """
+ Mixin that defines most tests but doesn't inherit unittest.TestCase.
+
+ Tests are run by the ClientServerTests and SecureClientServerTests subclasses.
+
+ """
+
@with_server()
@with_client()
def test_basic(self):
@@ -289,6 +359,38 @@ def test_basic(self):
reply = self.loop.run_until_complete(self.client.recv())
self.assertEqual(reply, "Hello!")
+ @with_server()
+ def test_redirect(self):
+ redirect_statuses = [
+ http.HTTPStatus.MOVED_PERMANENTLY,
+ http.HTTPStatus.FOUND,
+ http.HTTPStatus.SEE_OTHER,
+ http.HTTPStatus.TEMPORARY_REDIRECT,
+ http.HTTPStatus.PERMANENT_REDIRECT,
+ ]
+ for status in redirect_statuses:
+ with temp_test_redirecting_server(self, status):
+ with temp_test_client(self):
+ self.loop.run_until_complete(self.client.send("Hello!"))
+ reply = self.loop.run_until_complete(self.client.recv())
+ self.assertEqual(reply, "Hello!")
+
+ def test_infinite_redirect(self):
+ with temp_test_redirecting_server(self, http.HTTPStatus.FOUND):
+ self.server = self.redirecting_server
+ with self.assertRaises(InvalidHandshake):
+ with temp_test_client(self):
+ self.fail("Did not raise") # pragma: no cover
+
+ @with_server()
+ def test_redirect_missing_location(self):
+ with temp_test_redirecting_server(
+ self, http.HTTPStatus.FOUND, include_location=False
+ ):
+ with self.assertRaises(InvalidHeader):
+ with temp_test_client(self):
+ self.fail("Did not raise") # pragma: no cover
+
def test_explicit_event_loop(self):
with self.temp_server(loop=self.loop):
with self.temp_client(loop=self.loop):
@@ -296,9 +398,21 @@ def test_explicit_event_loop(self):
reply = self.loop.run_until_complete(self.client.recv())
self.assertEqual(reply, "Hello!")
- # The way the legacy SSL implementation wraps sockets makes it extremely
- # hard to write a test for Python 3.4.
- @unittest.skipIf(sys.version_info[:2] <= (3, 4), 'this test requires Python 3.5+')
+ @with_server()
+ def test_explicit_host_port(self):
+ uri = get_server_uri(self.server, self.secure)
+ wsuri = parse_uri(uri)
+
+ # Change host and port to invalid values.
+ changed_uri = uri.replace(wsuri.host, "example.com").replace(
+ str(wsuri.port), str(65535 - wsuri.port)
+ )
+
+ with self.temp_client(uri=changed_uri, host=wsuri.host, port=wsuri.port):
+ self.loop.run_until_complete(self.client.send("Hello!"))
+ reply = self.loop.run_until_complete(self.client.recv())
+ self.assertEqual(reply, "Hello!")
+
@with_server()
def test_explicit_socket(self):
class TrackedSocket(socket.socket):
@@ -328,7 +442,7 @@ def send(self, *args, **kwargs):
with self.temp_client(
sock=client_socket,
# "You must set server_hostname when using ssl without a host"
- server_hostname='localhost' if self.secure else None,
+ server_hostname="localhost" if self.secure else None,
):
self.loop.run_until_complete(self.client.send("Hello!"))
reply = self.loop.run_until_complete(self.client.recv())
@@ -340,187 +454,252 @@ def send(self, *args, **kwargs):
finally:
client_socket.close()
- @unittest.skipUnless(hasattr(socket, 'AF_UNIX'), 'this test requires Unix sockets')
+ @unittest.skipUnless(hasattr(socket, "AF_UNIX"), "this test requires Unix sockets")
def test_unix_socket(self):
with tempfile.TemporaryDirectory() as temp_dir:
- path = bytes(pathlib.Path(temp_dir) / 'websockets')
+ path = bytes(pathlib.Path(temp_dir) / "websockets")
# Like self.start_server() but with unix_serve().
unix_server = unix_serve(handler, path)
self.server = self.loop.run_until_complete(unix_server)
-
- client_socket = socket.socket(socket.AF_UNIX)
- client_socket.connect(path)
-
try:
- with self.temp_client(sock=client_socket):
+ # Like self.start_client() but with unix_connect()
+ unix_client = unix_connect(path)
+ self.client = self.loop.run_until_complete(unix_client)
+ try:
self.loop.run_until_complete(self.client.send("Hello!"))
reply = self.loop.run_until_complete(self.client.recv())
self.assertEqual(reply, "Hello!")
-
+ finally:
+ self.stop_client()
finally:
- client_socket.close()
self.stop_server()
- @with_server(process_request=lambda p, rh: (OK, [], b'OK\n'))
+ async def process_request_OK(path, request_headers):
+ return http.HTTPStatus.OK, [], b"OK\n"
+
+ @with_server(process_request=process_request_OK)
def test_process_request_argument(self):
- response = self.loop.run_until_complete(self.make_http_request('/'))
+ response = self.loop.run_until_complete(self.make_http_request("/"))
+
+ with contextlib.closing(response):
+ self.assertEqual(response.code, 200)
+
+ def legacy_process_request_OK(path, request_headers):
+ return http.HTTPStatus.OK, [], b"OK\n"
+
+ @with_server(process_request=legacy_process_request_OK)
+ def test_process_request_argument_backwards_compatibility(self):
+ with warnings.catch_warnings(record=True) as recorded_warnings:
+ response = self.loop.run_until_complete(self.make_http_request("/"))
+
+ with contextlib.closing(response):
+ self.assertEqual(response.code, 200)
+
+ self.assertDeprecationWarnings(
+ recorded_warnings, ["declare process_request as a coroutine"]
+ )
+
+ class ProcessRequestOKServerProtocol(WebSocketServerProtocol):
+ async def process_request(self, path, request_headers):
+ return http.HTTPStatus.OK, [], b"OK\n"
+
+ @with_server(create_protocol=ProcessRequestOKServerProtocol)
+ def test_process_request_override(self):
+ response = self.loop.run_until_complete(self.make_http_request("/"))
+
+ with contextlib.closing(response):
+ self.assertEqual(response.code, 200)
+
+ class LegacyProcessRequestOKServerProtocol(WebSocketServerProtocol):
+ def process_request(self, path, request_headers):
+ return http.HTTPStatus.OK, [], b"OK\n"
+
+ @with_server(create_protocol=LegacyProcessRequestOKServerProtocol)
+ def test_process_request_override_backwards_compatibility(self):
+ with warnings.catch_warnings(record=True) as recorded_warnings:
+ response = self.loop.run_until_complete(self.make_http_request("/"))
with contextlib.closing(response):
self.assertEqual(response.code, 200)
+ self.assertDeprecationWarnings(
+ recorded_warnings, ["declare process_request as a coroutine"]
+ )
+
+ def select_subprotocol_chat(client_subprotocols, server_subprotocols):
+ return "chat"
+
@with_server(
- subprotocols=['superchat', 'chat'], select_subprotocol=lambda cs, ss: 'chat'
+ subprotocols=["superchat", "chat"], select_subprotocol=select_subprotocol_chat
)
- @with_client('/subprotocol', subprotocols=['superchat', 'chat'])
+ @with_client("/subprotocol", subprotocols=["superchat", "chat"])
def test_select_subprotocol_argument(self):
server_subprotocol = self.loop.run_until_complete(self.client.recv())
- self.assertEqual(server_subprotocol, repr('chat'))
- self.assertEqual(self.client.subprotocol, 'chat')
+ self.assertEqual(server_subprotocol, repr("chat"))
+ self.assertEqual(self.client.subprotocol, "chat")
+
+ class SelectSubprotocolChatServerProtocol(WebSocketServerProtocol):
+ def select_subprotocol(self, client_subprotocols, server_subprotocols):
+ return "chat"
+
+ @with_server(
+ subprotocols=["superchat", "chat"],
+ create_protocol=SelectSubprotocolChatServerProtocol,
+ )
+ @with_client("/subprotocol", subprotocols=["superchat", "chat"])
+ def test_select_subprotocol_override(self):
+ server_subprotocol = self.loop.run_until_complete(self.client.recv())
+ self.assertEqual(server_subprotocol, repr("chat"))
+ self.assertEqual(self.client.subprotocol, "chat")
@with_server()
- @with_client('/attributes')
- def test_protocol_attributes(self):
+ @with_client("/deprecated_attributes")
+ def test_protocol_deprecated_attributes(self):
# The test could be connecting with IPv6 or IPv4.
expected_client_attrs = [
server_socket.getsockname()[:2] + (self.secure,)
for server_socket in self.server.sockets
]
- client_attrs = (self.client.host, self.client.port, self.client.secure)
+ with warnings.catch_warnings(record=True) as recorded_warnings:
+ client_attrs = (self.client.host, self.client.port, self.client.secure)
+ self.assertDeprecationWarnings(
+ recorded_warnings,
+ [
+ "use remote_address[0] instead of host",
+ "use remote_address[1] instead of port",
+ "don't use secure",
+ ],
+ )
self.assertIn(client_attrs, expected_client_attrs)
- expected_server_attrs = ('localhost', 0, self.secure)
- server_attrs = self.loop.run_until_complete(self.client.recv())
+ expected_server_attrs = ("localhost", 0, self.secure)
+ with warnings.catch_warnings(record=True) as recorded_warnings:
+ self.loop.run_until_complete(self.client.send(""))
+ server_attrs = self.loop.run_until_complete(self.client.recv())
+ self.assertDeprecationWarnings(
+ recorded_warnings,
+ [
+ "use local_address[0] instead of host",
+ "use local_address[1] instead of port",
+ "don't use secure",
+ ],
+ )
self.assertEqual(server_attrs, repr(expected_server_attrs))
@with_server()
- @with_client('/path')
+ @with_client("/path")
def test_protocol_path(self):
client_path = self.client.path
- self.assertEqual(client_path, '/path')
+ self.assertEqual(client_path, "/path")
server_path = self.loop.run_until_complete(self.client.recv())
- self.assertEqual(server_path, '/path')
-
- @with_server()
- @with_client('/headers', user_info=('user', 'pass'))
- def test_protocol_basic_auth(self):
- self.assertEqual(
- self.client.request_headers['Authorization'], 'Basic dXNlcjpwYXNz'
- )
+ self.assertEqual(server_path, "/path")
@with_server()
- @with_client('/headers')
+ @with_client("/headers")
def test_protocol_headers(self):
client_req = self.client.request_headers
client_resp = self.client.response_headers
- self.assertEqual(client_req['User-Agent'], USER_AGENT)
- self.assertEqual(client_resp['Server'], USER_AGENT)
+ self.assertEqual(client_req["User-Agent"], USER_AGENT)
+ self.assertEqual(client_resp["Server"], USER_AGENT)
server_req = self.loop.run_until_complete(self.client.recv())
server_resp = self.loop.run_until_complete(self.client.recv())
self.assertEqual(server_req, repr(client_req))
self.assertEqual(server_resp, repr(client_resp))
@with_server()
- @with_client('/headers', extra_headers=Headers({'X-Spam': 'Eggs'}))
+ @with_client("/headers", extra_headers=Headers({"X-Spam": "Eggs"}))
def test_protocol_custom_request_headers(self):
req_headers = self.loop.run_until_complete(self.client.recv())
self.loop.run_until_complete(self.client.recv())
self.assertIn("('X-Spam', 'Eggs')", req_headers)
@with_server()
- @with_client('/headers', extra_headers={'X-Spam': 'Eggs'})
+ @with_client("/headers", extra_headers={"X-Spam": "Eggs"})
def test_protocol_custom_request_headers_dict(self):
req_headers = self.loop.run_until_complete(self.client.recv())
self.loop.run_until_complete(self.client.recv())
self.assertIn("('X-Spam', 'Eggs')", req_headers)
@with_server()
- @with_client('/headers', extra_headers=[('X-Spam', 'Eggs')])
+ @with_client("/headers", extra_headers=[("X-Spam", "Eggs")])
def test_protocol_custom_request_headers_list(self):
req_headers = self.loop.run_until_complete(self.client.recv())
self.loop.run_until_complete(self.client.recv())
self.assertIn("('X-Spam', 'Eggs')", req_headers)
@with_server()
- @with_client('/headers', extra_headers=[('User-Agent', 'Eggs')])
+ @with_client("/headers", extra_headers=[("User-Agent", "Eggs")])
def test_protocol_custom_request_user_agent(self):
req_headers = self.loop.run_until_complete(self.client.recv())
self.loop.run_until_complete(self.client.recv())
self.assertEqual(req_headers.count("User-Agent"), 1)
self.assertIn("('User-Agent', 'Eggs')", req_headers)
- @with_server(extra_headers=lambda p, r: Headers({'X-Spam': 'Eggs'}))
- @with_client('/headers')
+ @with_server(extra_headers=lambda p, r: Headers({"X-Spam": "Eggs"}))
+ @with_client("/headers")
def test_protocol_custom_response_headers_callable(self):
self.loop.run_until_complete(self.client.recv())
resp_headers = self.loop.run_until_complete(self.client.recv())
self.assertIn("('X-Spam', 'Eggs')", resp_headers)
- @with_server(extra_headers=lambda p, r: {'X-Spam': 'Eggs'})
- @with_client('/headers')
+ @with_server(extra_headers=lambda p, r: {"X-Spam": "Eggs"})
+ @with_client("/headers")
def test_protocol_custom_response_headers_callable_dict(self):
self.loop.run_until_complete(self.client.recv())
resp_headers = self.loop.run_until_complete(self.client.recv())
self.assertIn("('X-Spam', 'Eggs')", resp_headers)
- @with_server(extra_headers=lambda p, r: [('X-Spam', 'Eggs')])
- @with_client('/headers')
+ @with_server(extra_headers=lambda p, r: [("X-Spam", "Eggs")])
+ @with_client("/headers")
def test_protocol_custom_response_headers_callable_list(self):
self.loop.run_until_complete(self.client.recv())
resp_headers = self.loop.run_until_complete(self.client.recv())
self.assertIn("('X-Spam', 'Eggs')", resp_headers)
- @with_server(extra_headers=Headers({'X-Spam': 'Eggs'}))
- @with_client('/headers')
+ @with_server(extra_headers=lambda p, r: None)
+ @with_client("/headers")
+ def test_protocol_custom_response_headers_callable_none(self):
+ self.loop.run_until_complete(self.client.recv()) # doesn't crash
+ self.loop.run_until_complete(self.client.recv()) # nothing to check
+
+ @with_server(extra_headers=Headers({"X-Spam": "Eggs"}))
+ @with_client("/headers")
def test_protocol_custom_response_headers(self):
self.loop.run_until_complete(self.client.recv())
resp_headers = self.loop.run_until_complete(self.client.recv())
self.assertIn("('X-Spam', 'Eggs')", resp_headers)
- @with_server(extra_headers={'X-Spam': 'Eggs'})
- @with_client('/headers')
+ @with_server(extra_headers={"X-Spam": "Eggs"})
+ @with_client("/headers")
def test_protocol_custom_response_headers_dict(self):
self.loop.run_until_complete(self.client.recv())
resp_headers = self.loop.run_until_complete(self.client.recv())
self.assertIn("('X-Spam', 'Eggs')", resp_headers)
- @with_server(extra_headers=[('X-Spam', 'Eggs')])
- @with_client('/headers')
+ @with_server(extra_headers=[("X-Spam", "Eggs")])
+ @with_client("/headers")
def test_protocol_custom_response_headers_list(self):
self.loop.run_until_complete(self.client.recv())
resp_headers = self.loop.run_until_complete(self.client.recv())
self.assertIn("('X-Spam', 'Eggs')", resp_headers)
- @with_server(extra_headers=[('Server', 'Eggs')])
- @with_client('/headers')
+ @with_server(extra_headers=[("Server", "Eggs")])
+ @with_client("/headers")
def test_protocol_custom_response_user_agent(self):
self.loop.run_until_complete(self.client.recv())
resp_headers = self.loop.run_until_complete(self.client.recv())
self.assertEqual(resp_headers.count("Server"), 1)
self.assertIn("('Server', 'Eggs')", resp_headers)
- def make_http_request(self, path='/'):
- # Set url to 'https?://:'.
- url = get_server_uri(self.server, resource_name=path, secure=self.secure)
- url = url.replace('ws', 'http')
-
- if self.secure:
- open_health_check = functools.partial(
- urllib.request.urlopen, url, context=self.client_context
- )
- else:
- open_health_check = functools.partial(urllib.request.urlopen, url)
-
- return self.loop.run_in_executor(None, open_health_check)
-
@with_server(create_protocol=HealthCheckServerProtocol)
def test_http_request_http_endpoint(self):
# Making a HTTP request to a HTTP endpoint succeeds.
- response = self.loop.run_until_complete(self.make_http_request('/__health__/'))
+ response = self.loop.run_until_complete(self.make_http_request("/__health__/"))
with contextlib.closing(response):
self.assertEqual(response.code, 200)
- self.assertEqual(response.read(), b'status = green\n')
+ self.assertEqual(response.read(), b"status = green\n")
@with_server(create_protocol=HealthCheckServerProtocol)
def test_http_request_ws_endpoint(self):
@@ -529,13 +708,13 @@ def test_http_request_ws_endpoint(self):
self.loop.run_until_complete(self.make_http_request())
self.assertEqual(raised.exception.code, 426)
- self.assertEqual(raised.exception.headers['Upgrade'], 'websocket')
+ self.assertEqual(raised.exception.headers["Upgrade"], "websocket")
@with_server(create_protocol=HealthCheckServerProtocol)
def test_ws_connection_http_endpoint(self):
# Making a WS connection to a HTTP endpoint fails.
with self.assertRaises(InvalidStatusCode) as raised:
- self.start_client('/__health__/')
+ self.start_client("/__health__/")
self.assertEqual(raised.exception.status_code, 200)
@@ -556,112 +735,138 @@ def assert_client_raises_code(self, status_code):
def test_server_create_protocol(self):
self.assert_client_raises_code(401)
- @with_server(
- create_protocol=(
- lambda *args, **kwargs: UnauthorizedServerProtocol(*args, **kwargs)
- )
- )
+ def create_unauthorized_server_protocol(*args, **kwargs):
+ return UnauthorizedServerProtocol(*args, **kwargs)
+
+ @with_server(create_protocol=create_unauthorized_server_protocol)
def test_server_create_protocol_function(self):
self.assert_client_raises_code(401)
- @with_server(klass=UnauthorizedServerProtocol)
+ @with_server(
+ klass=UnauthorizedServerProtocol,
+ deprecation_warnings=["rename klass to create_protocol"],
+ )
def test_server_klass_backwards_compatibility(self):
self.assert_client_raises_code(401)
@with_server(
- create_protocol=ForbiddenServerProtocol, klass=UnauthorizedServerProtocol
+ create_protocol=ForbiddenServerProtocol,
+ klass=UnauthorizedServerProtocol,
+ deprecation_warnings=["rename klass to create_protocol"],
)
def test_server_create_protocol_over_klass(self):
self.assert_client_raises_code(403)
@with_server()
- @with_client('/path', create_protocol=FooClientProtocol)
+ @with_client("/path", create_protocol=FooClientProtocol)
def test_client_create_protocol(self):
self.assertIsInstance(self.client, FooClientProtocol)
@with_server()
@with_client(
- '/path',
+ "/path",
create_protocol=(lambda *args, **kwargs: FooClientProtocol(*args, **kwargs)),
)
def test_client_create_protocol_function(self):
self.assertIsInstance(self.client, FooClientProtocol)
@with_server()
- @with_client('/path', klass=FooClientProtocol)
+ @with_client(
+ "/path",
+ klass=FooClientProtocol,
+ deprecation_warnings=["rename klass to create_protocol"],
+ )
def test_client_klass(self):
self.assertIsInstance(self.client, FooClientProtocol)
@with_server()
- @with_client('/path', create_protocol=BarClientProtocol, klass=FooClientProtocol)
+ @with_client(
+ "/path",
+ create_protocol=BarClientProtocol,
+ klass=FooClientProtocol,
+ deprecation_warnings=["rename klass to create_protocol"],
+ )
def test_client_create_protocol_over_klass(self):
self.assertIsInstance(self.client, BarClientProtocol)
@with_server(close_timeout=7)
- @with_client('/close_timeout')
+ @with_client("/close_timeout")
def test_server_close_timeout(self):
close_timeout = self.loop.run_until_complete(self.client.recv())
self.assertEqual(eval(close_timeout), 7)
- @with_server(timeout=6)
- @with_client('/close_timeout')
+ @with_server(timeout=6, deprecation_warnings=["rename timeout to close_timeout"])
+ @with_client("/close_timeout")
def test_server_timeout_backwards_compatibility(self):
close_timeout = self.loop.run_until_complete(self.client.recv())
self.assertEqual(eval(close_timeout), 6)
- @with_server(close_timeout=7, timeout=6)
- @with_client('/close_timeout')
+ @with_server(
+ close_timeout=7,
+ timeout=6,
+ deprecation_warnings=["rename timeout to close_timeout"],
+ )
+ @with_client("/close_timeout")
def test_server_close_timeout_over_timeout(self):
close_timeout = self.loop.run_until_complete(self.client.recv())
self.assertEqual(eval(close_timeout), 7)
@with_server()
- @with_client('/close_timeout', close_timeout=7)
+ @with_client("/close_timeout", close_timeout=7)
def test_client_close_timeout(self):
self.assertEqual(self.client.close_timeout, 7)
@with_server()
- @with_client('/close_timeout', timeout=6)
+ @with_client(
+ "/close_timeout",
+ timeout=6,
+ deprecation_warnings=["rename timeout to close_timeout"],
+ )
def test_client_timeout_backwards_compatibility(self):
self.assertEqual(self.client.close_timeout, 6)
@with_server()
- @with_client('/close_timeout', close_timeout=7, timeout=6)
+ @with_client(
+ "/close_timeout",
+ close_timeout=7,
+ timeout=6,
+ deprecation_warnings=["rename timeout to close_timeout"],
+ )
def test_client_close_timeout_over_timeout(self):
self.assertEqual(self.client.close_timeout, 7)
@with_server()
- @with_client('/extensions')
+ @with_client("/extensions")
def test_no_extension(self):
server_extensions = self.loop.run_until_complete(self.client.recv())
self.assertEqual(server_extensions, repr([]))
self.assertEqual(repr(self.client.extensions), repr([]))
@with_server(extensions=[ServerNoOpExtensionFactory()])
- @with_client('/extensions', extensions=[ClientNoOpExtensionFactory()])
+ @with_client("/extensions", extensions=[ClientNoOpExtensionFactory()])
def test_extension(self):
server_extensions = self.loop.run_until_complete(self.client.recv())
self.assertEqual(server_extensions, repr([NoOpExtension()]))
self.assertEqual(repr(self.client.extensions), repr([NoOpExtension()]))
@with_server()
- @with_client('/extensions', extensions=[ClientNoOpExtensionFactory()])
+ @with_client("/extensions", extensions=[ClientNoOpExtensionFactory()])
def test_extension_not_accepted(self):
server_extensions = self.loop.run_until_complete(self.client.recv())
self.assertEqual(server_extensions, repr([]))
self.assertEqual(repr(self.client.extensions), repr([]))
@with_server(extensions=[ServerNoOpExtensionFactory()])
- @with_client('/extensions')
+ @with_client("/extensions")
def test_extension_not_requested(self):
server_extensions = self.loop.run_until_complete(self.client.recv())
self.assertEqual(server_extensions, repr([]))
self.assertEqual(repr(self.client.extensions), repr([]))
- @with_server(extensions=[ServerNoOpExtensionFactory([('foo', None)])])
+ @with_server(extensions=[ServerNoOpExtensionFactory([("foo", None)])])
def test_extension_client_rejection(self):
with self.assertRaises(NegotiationError):
- self.start_client('/extensions', extensions=[ClientNoOpExtensionFactory()])
+ self.start_client("/extensions", extensions=[ClientNoOpExtensionFactory()])
@with_server(
extensions=[
@@ -670,7 +875,7 @@ def test_extension_client_rejection(self):
ServerPerMessageDeflateFactory(),
]
)
- @with_client('/extensions', extensions=[ClientPerMessageDeflateFactory()])
+ @with_client("/extensions", extensions=[ClientPerMessageDeflateFactory()])
def test_extension_no_match_then_match(self):
# The order requested by the client has priority.
server_extensions = self.loop.run_until_complete(self.client.recv())
@@ -683,7 +888,7 @@ def test_extension_no_match_then_match(self):
)
@with_server(extensions=[ServerPerMessageDeflateFactory()])
- @with_client('/extensions', extensions=[ClientNoOpExtensionFactory()])
+ @with_client("/extensions", extensions=[ClientNoOpExtensionFactory()])
def test_extension_mismatch(self):
server_extensions = self.loop.run_until_complete(self.client.recv())
self.assertEqual(server_extensions, repr([]))
@@ -693,7 +898,7 @@ def test_extension_mismatch(self):
extensions=[ServerNoOpExtensionFactory(), ServerPerMessageDeflateFactory()]
)
@with_client(
- '/extensions',
+ "/extensions",
extensions=[ClientPerMessageDeflateFactory(), ClientNoOpExtensionFactory()],
)
def test_extension_order(self):
@@ -709,25 +914,25 @@ def test_extension_order(self):
)
@with_server(extensions=[ServerNoOpExtensionFactory()])
- @unittest.mock.patch.object(WebSocketServerProtocol, 'process_extensions')
+ @unittest.mock.patch.object(WebSocketServerProtocol, "process_extensions")
def test_extensions_error(self, _process_extensions):
- _process_extensions.return_value = 'x-no-op', [NoOpExtension()]
+ _process_extensions.return_value = "x-no-op", [NoOpExtension()]
with self.assertRaises(NegotiationError):
self.start_client(
- '/extensions', extensions=[ClientPerMessageDeflateFactory()]
+ "/extensions", extensions=[ClientPerMessageDeflateFactory()]
)
@with_server(extensions=[ServerNoOpExtensionFactory()])
- @unittest.mock.patch.object(WebSocketServerProtocol, 'process_extensions')
+ @unittest.mock.patch.object(WebSocketServerProtocol, "process_extensions")
def test_extensions_error_no_extensions(self, _process_extensions):
- _process_extensions.return_value = 'x-no-op', [NoOpExtension()]
+ _process_extensions.return_value = "x-no-op", [NoOpExtension()]
with self.assertRaises(InvalidHandshake):
- self.start_client('/extensions')
+ self.start_client("/extensions")
- @with_server(compression='deflate')
- @with_client('/extensions', compression='deflate')
+ @with_server(compression="deflate")
+ @with_client("/extensions", compression="deflate")
def test_compression_deflate(self):
server_extensions = self.loop.run_until_complete(self.client.recv())
self.assertEqual(
@@ -738,105 +943,79 @@ def test_compression_deflate(self):
repr([PerMessageDeflate(False, False, 15, 15)]),
)
- @with_server(
- extensions=[
- ServerPerMessageDeflateFactory(
- client_no_context_takeover=True, server_max_window_bits=10
- )
- ],
- compression='deflate', # overridden by explicit config
- )
- @with_client(
- '/extensions',
- extensions=[
- ClientPerMessageDeflateFactory(
- server_no_context_takeover=True, client_max_window_bits=12
- )
- ],
- compression='deflate', # overridden by explicit config
- )
- def test_compression_deflate_and_explicit_config(self):
- server_extensions = self.loop.run_until_complete(self.client.recv())
- self.assertEqual(
- server_extensions, repr([PerMessageDeflate(True, True, 12, 10)])
- )
- self.assertEqual(
- repr(self.client.extensions), repr([PerMessageDeflate(True, True, 10, 12)])
- )
-
def test_compression_unsupported_server(self):
with self.assertRaises(ValueError):
- self.loop.run_until_complete(self.start_server(compression='xz'))
+ self.start_server(compression="xz")
@with_server()
def test_compression_unsupported_client(self):
with self.assertRaises(ValueError):
- self.loop.run_until_complete(self.start_client(compression='xz'))
+ self.start_client(compression="xz")
@with_server()
- @with_client('/subprotocol')
+ @with_client("/subprotocol")
def test_no_subprotocol(self):
server_subprotocol = self.loop.run_until_complete(self.client.recv())
self.assertEqual(server_subprotocol, repr(None))
self.assertEqual(self.client.subprotocol, None)
- @with_server(subprotocols=['superchat', 'chat'])
- @with_client('/subprotocol', subprotocols=['otherchat', 'chat'])
+ @with_server(subprotocols=["superchat", "chat"])
+ @with_client("/subprotocol", subprotocols=["otherchat", "chat"])
def test_subprotocol(self):
server_subprotocol = self.loop.run_until_complete(self.client.recv())
- self.assertEqual(server_subprotocol, repr('chat'))
- self.assertEqual(self.client.subprotocol, 'chat')
+ self.assertEqual(server_subprotocol, repr("chat"))
+ self.assertEqual(self.client.subprotocol, "chat")
- @with_server(subprotocols=['superchat'])
- @with_client('/subprotocol', subprotocols=['otherchat'])
+ @with_server(subprotocols=["superchat"])
+ @with_client("/subprotocol", subprotocols=["otherchat"])
def test_subprotocol_not_accepted(self):
server_subprotocol = self.loop.run_until_complete(self.client.recv())
self.assertEqual(server_subprotocol, repr(None))
self.assertEqual(self.client.subprotocol, None)
@with_server()
- @with_client('/subprotocol', subprotocols=['otherchat', 'chat'])
+ @with_client("/subprotocol", subprotocols=["otherchat", "chat"])
def test_subprotocol_not_offered(self):
server_subprotocol = self.loop.run_until_complete(self.client.recv())
self.assertEqual(server_subprotocol, repr(None))
self.assertEqual(self.client.subprotocol, None)
- @with_server(subprotocols=['superchat', 'chat'])
- @with_client('/subprotocol')
+ @with_server(subprotocols=["superchat", "chat"])
+ @with_client("/subprotocol")
def test_subprotocol_not_requested(self):
server_subprotocol = self.loop.run_until_complete(self.client.recv())
self.assertEqual(server_subprotocol, repr(None))
self.assertEqual(self.client.subprotocol, None)
- @with_server(subprotocols=['superchat'])
- @unittest.mock.patch.object(WebSocketServerProtocol, 'process_subprotocol')
+ @with_server(subprotocols=["superchat"])
+ @unittest.mock.patch.object(WebSocketServerProtocol, "process_subprotocol")
def test_subprotocol_error(self, _process_subprotocol):
- _process_subprotocol.return_value = 'superchat'
+ _process_subprotocol.return_value = "superchat"
with self.assertRaises(NegotiationError):
- self.start_client('/subprotocol', subprotocols=['otherchat'])
+ self.start_client("/subprotocol", subprotocols=["otherchat"])
self.run_loop_once()
- @with_server(subprotocols=['superchat'])
- @unittest.mock.patch.object(WebSocketServerProtocol, 'process_subprotocol')
+ @with_server(subprotocols=["superchat"])
+ @unittest.mock.patch.object(WebSocketServerProtocol, "process_subprotocol")
def test_subprotocol_error_no_subprotocols(self, _process_subprotocol):
- _process_subprotocol.return_value = 'superchat'
+ _process_subprotocol.return_value = "superchat"
with self.assertRaises(InvalidHandshake):
- self.start_client('/subprotocol')
+ self.start_client("/subprotocol")
self.run_loop_once()
- @with_server(subprotocols=['superchat', 'chat'])
- @unittest.mock.patch.object(WebSocketServerProtocol, 'process_subprotocol')
+ @with_server(subprotocols=["superchat", "chat"])
+ @unittest.mock.patch.object(WebSocketServerProtocol, "process_subprotocol")
def test_subprotocol_error_two_subprotocols(self, _process_subprotocol):
- _process_subprotocol.return_value = 'superchat, chat'
+ _process_subprotocol.return_value = "superchat, chat"
with self.assertRaises(InvalidHandshake):
- self.start_client('/subprotocol', subprotocols=['superchat', 'chat'])
+ self.start_client("/subprotocol", subprotocols=["superchat", "chat"])
self.run_loop_once()
@with_server()
- @unittest.mock.patch('websockets.server.read_request')
+ @unittest.mock.patch("websockets.legacy.server.read_request")
def test_server_receives_malformed_request(self, _read_request):
_read_request.side_effect = ValueError("read_request failed")
@@ -844,7 +1023,7 @@ def test_server_receives_malformed_request(self, _read_request):
self.start_client()
@with_server()
- @unittest.mock.patch('websockets.client.read_response')
+ @unittest.mock.patch("websockets.legacy.client.read_response")
def test_client_receives_malformed_response(self, _read_response):
_read_response.side_effect = ValueError("read_response failed")
@@ -853,10 +1032,10 @@ def test_client_receives_malformed_response(self, _read_response):
self.run_loop_once()
@with_server()
- @unittest.mock.patch('websockets.client.build_request')
+ @unittest.mock.patch("websockets.legacy.client.build_request")
def test_client_sends_invalid_handshake_request(self, _build_request):
def wrong_build_request(headers):
- return '42'
+ return "42"
_build_request.side_effect = wrong_build_request
@@ -864,10 +1043,10 @@ def wrong_build_request(headers):
self.start_client()
@with_server()
- @unittest.mock.patch('websockets.server.build_response')
+ @unittest.mock.patch("websockets.legacy.server.build_response")
def test_server_sends_invalid_handshake_response(self, _build_response):
def wrong_build_response(headers, key):
- return build_response(headers, '42')
+ return build_response(headers, "42")
_build_response.side_effect = wrong_build_response
@@ -875,12 +1054,11 @@ def wrong_build_response(headers, key):
self.start_client()
@with_server()
- @unittest.mock.patch('websockets.client.read_response')
+ @unittest.mock.patch("websockets.legacy.client.read_response")
def test_server_does_not_switch_protocols(self, _read_response):
- @asyncio.coroutine
- def wrong_read_response(stream):
- status_code, headers = yield from read_response(stream)
- return 400, headers
+ async def wrong_read_response(stream):
+ status_code, reason, headers = await read_response(stream)
+ return 400, "Bad Request", headers
_read_response.side_effect = wrong_read_response
@@ -889,7 +1067,9 @@ def wrong_read_response(stream):
self.run_loop_once()
@with_server()
- @unittest.mock.patch('websockets.server.WebSocketServerProtocol.process_request')
+ @unittest.mock.patch(
+ "websockets.legacy.server.WebSocketServerProtocol.process_request"
+ )
def test_server_error_in_handshake(self, _process_request):
_process_request.side_effect = Exception("process_request crashed")
@@ -897,7 +1077,7 @@ def test_server_error_in_handshake(self, _process_request):
self.start_client()
@with_server()
- @unittest.mock.patch('websockets.server.WebSocketServerProtocol.send')
+ @unittest.mock.patch("websockets.legacy.server.WebSocketServerProtocol.send")
def test_server_handler_crashes(self, send):
send.side_effect = ValueError("send failed")
@@ -910,7 +1090,7 @@ def test_server_handler_crashes(self, send):
self.assertEqual(self.client.close_code, 1011)
@with_server()
- @unittest.mock.patch('websockets.server.WebSocketServerProtocol.close')
+ @unittest.mock.patch("websockets.legacy.server.WebSocketServerProtocol.close")
def test_server_close_crashes(self, close):
close.side_effect = ValueError("close failed")
@@ -924,49 +1104,42 @@ def test_server_close_crashes(self, close):
@with_server()
@with_client()
- @unittest.mock.patch.object(WebSocketClientProtocol, 'handshake')
+ @unittest.mock.patch.object(WebSocketClientProtocol, "handshake")
def test_client_closes_connection_before_handshake(self, handshake):
# We have mocked the handshake() method to prevent the client from
# performing the opening handshake. Force it to close the connection.
- self.client.writer.close()
+ self.client.transport.close()
# The server should stop properly anyway. It used to hang because the
# task handling the connection was waiting for the opening handshake.
- @with_server(create_protocol=SlowServerProtocol)
+ @with_server(create_protocol=SlowOpeningHandshakeProtocol)
def test_server_shuts_down_during_opening_handshake(self):
self.loop.call_later(5 * MS, self.server.close)
- with self.assertRaises(InvalidHandshake):
+ with self.assertRaises(InvalidStatusCode) as raised:
self.start_client()
+ exception = raised.exception
+ self.assertEqual(
+ str(exception), "server rejected WebSocket connection: HTTP 503"
+ )
+ self.assertEqual(exception.status_code, 503)
@with_server()
def test_server_shuts_down_during_connection_handling(self):
with self.temp_client():
+ server_ws = next(iter(self.server.websockets))
self.server.close()
with self.assertRaises(ConnectionClosed):
self.loop.run_until_complete(self.client.recv())
- # Websocket connection terminates with 1001 Going Away.
+ # Websocket connection closes properly with 1001 Going Away.
self.assertEqual(self.client.close_code, 1001)
-
- @with_server()
- @unittest.mock.patch('websockets.server.WebSocketServerProtocol.close')
- def test_server_shuts_down_during_connection_close(self, _close):
- _close.side_effect = asyncio.CancelledError
-
- self.server.closing = True
- with self.temp_client():
- self.loop.run_until_complete(self.client.send("Hello!"))
- reply = self.loop.run_until_complete(self.client.recv())
- self.assertEqual(reply, "Hello!")
-
- # Websocket connection terminates abnormally.
- self.assertEqual(self.client.close_code, 1006)
+ self.assertEqual(server_ws.close_code, 1001)
@with_server()
def test_server_shuts_down_waits_until_handlers_terminate(self):
# This handler waits a bit after the connection is closed in order
# to test that wait_closed() really waits for handlers to complete.
- self.start_client('/slow_stop')
+ self.start_client("/slow_stop")
server_ws = next(iter(self.server.websockets))
# Test that the handler task keeps running after close().
@@ -983,21 +1156,25 @@ def test_invalid_status_error_during_client_connect(self):
with self.assertRaises(InvalidStatusCode) as raised:
self.start_client()
exception = raised.exception
- self.assertEqual(str(exception), "Status code not 101: 403")
+ self.assertEqual(
+ str(exception), "server rejected WebSocket connection: HTTP 403"
+ )
self.assertEqual(exception.status_code, 403)
@with_server()
@unittest.mock.patch(
- 'websockets.server.WebSocketServerProtocol.write_http_response'
+ "websockets.legacy.server.WebSocketServerProtocol.write_http_response"
+ )
+ @unittest.mock.patch(
+ "websockets.legacy.server.WebSocketServerProtocol.read_http_request"
)
- @unittest.mock.patch('websockets.server.WebSocketServerProtocol.read_http_request')
def test_connection_error_during_opening_handshake(
self, _read_http_request, _write_http_response
):
_read_http_request.side_effect = ConnectionError
# This exception is currently platform-dependent. It was observed to
- # be ConnectionResetError on Linux in the non-SSL case, and
+ # be ConnectionResetError on Linux in the non-TLS case, and
# InvalidMessage otherwise (including both Linux and macOS). This
# doesn't matter though since this test is primarily for testing a
# code path on the server side.
@@ -1008,7 +1185,7 @@ def test_connection_error_during_opening_handshake(
_write_http_response.assert_not_called()
@with_server()
- @unittest.mock.patch('websockets.server.WebSocketServerProtocol.close')
+ @unittest.mock.patch("websockets.legacy.server.WebSocketServerProtocol.close")
def test_connection_error_during_closing_handshake(self, close):
close.side_effect = ConnectionError
@@ -1021,37 +1198,15 @@ def test_connection_error_during_closing_handshake(self, close):
self.assertEqual(self.client.close_code, 1006)
-class SSLClientServerTests(ClientServerTests):
-
- secure = True
-
- @property
- def server_context(self):
- # Change to ssl.PROTOCOL_TLS_SERVER when dropping Python < 3.6.
- ssl_context = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
- ssl_context.load_cert_chain(testcert)
- return ssl_context
-
- @property
- def client_context(self):
- # Change to ssl.PROTOCOL_TLS_CLIENT when dropping Python < 3.6.
- # Then remove verify_mode and check_hostname below.
- ssl_context = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
- ssl_context.load_verify_locations(testcert)
- ssl_context.verify_mode = ssl.CERT_REQUIRED
- # ssl.match_hostname can't match IP addresses on Python < 3.5.
- # We're using IP addresses to enforce testing of IPv4 and IPv6.
- if sys.version_info[:2] >= (3, 5): # pragma: no cover
- ssl_context.check_hostname = True
- return ssl_context
+class ClientServerTests(
+ CommonClientServerTests, ClientServerTestsMixin, AsyncioTestCase
+):
+ pass
- def start_server(self, **kwds):
- kwds.setdefault('ssl', self.server_context)
- super().start_server(**kwds)
- def start_client(self, path='/', **kwds):
- kwds.setdefault('ssl', self.client_context)
- super().start_client(path, **kwds)
+class SecureClientServerTests(
+ CommonClientServerTests, SecureClientServerTestsMixin, AsyncioTestCase
+):
# TLS over Unix sockets doesn't make sense.
test_unix_socket = None
@@ -1059,29 +1214,25 @@ def start_client(self, path='/', **kwds):
@with_server()
def test_ws_uri_is_rejected(self):
with self.assertRaises(ValueError):
- client = connect(
- get_server_uri(self.server, secure=False), ssl=self.client_context
- )
- # With Python ≥ 3.5, the exception is raised by connect() even
- # before awaiting. However, with Python 3.4 the exception is
- # raised only when awaiting.
- self.loop.run_until_complete(client) # pragma: no cover
+ connect(get_server_uri(self.server, secure=False), ssl=self.client_context)
+ @with_server()
+ def test_redirect_insecure(self):
+ with temp_test_redirecting_server(
+ self, http.HTTPStatus.FOUND, force_insecure=True
+ ):
+ with self.assertRaises(InvalidHandshake):
+ with temp_test_client(self):
+ self.fail("Did not raise") # pragma: no cover
-class ClientServerOriginTests(unittest.TestCase):
- def setUp(self):
- self.loop = asyncio.new_event_loop()
- asyncio.set_event_loop(self.loop)
-
- def tearDown(self):
- self.loop.close()
+class ClientServerOriginTests(AsyncioTestCase):
def test_checking_origin_succeeds(self):
server = self.loop.run_until_complete(
- serve(handler, 'localhost', 0, origins=['http://localhost'])
+ serve(handler, "localhost", 0, origins=["http://localhost"])
)
client = self.loop.run_until_complete(
- connect(get_server_uri(server), origin='http://localhost')
+ connect(get_server_uri(server), origin="http://localhost")
)
self.loop.run_until_complete(client.send("Hello!"))
@@ -1093,11 +1244,13 @@ def test_checking_origin_succeeds(self):
def test_checking_origin_fails(self):
server = self.loop.run_until_complete(
- serve(handler, 'localhost', 0, origins=['http://localhost'])
+ serve(handler, "localhost", 0, origins=["http://localhost"])
)
- with self.assertRaisesRegex(InvalidHandshake, "Status code not 101: 403"):
+ with self.assertRaisesRegex(
+ InvalidHandshake, "server rejected WebSocket connection: HTTP 403"
+ ):
self.loop.run_until_complete(
- connect(get_server_uri(server), origin='http://otherhost')
+ connect(get_server_uri(server), origin="http://otherhost")
)
server.close()
@@ -1105,14 +1258,16 @@ def test_checking_origin_fails(self):
def test_checking_origins_fails_with_multiple_headers(self):
server = self.loop.run_until_complete(
- serve(handler, 'localhost', 0, origins=['http://localhost'])
+ serve(handler, "localhost", 0, origins=["http://localhost"])
)
- with self.assertRaisesRegex(InvalidHandshake, "Status code not 101: 400"):
+ with self.assertRaisesRegex(
+ InvalidHandshake, "server rejected WebSocket connection: HTTP 400"
+ ):
self.loop.run_until_complete(
connect(
get_server_uri(server),
- origin='http://localhost',
- extra_headers=[('Origin', 'http://otherhost')],
+ origin="http://localhost",
+ extra_headers=[("Origin", "http://otherhost")],
)
)
@@ -1121,7 +1276,7 @@ def test_checking_origins_fails_with_multiple_headers(self):
def test_checking_lack_of_origin_succeeds(self):
server = self.loop.run_until_complete(
- serve(handler, 'localhost', 0, origins=[None])
+ serve(handler, "localhost", 0, origins=[None])
)
client = self.loop.run_until_complete(connect(get_server_uri(server)))
@@ -1135,14 +1290,13 @@ def test_checking_lack_of_origin_succeeds(self):
def test_checking_lack_of_origin_succeeds_backwards_compatibility(self):
with warnings.catch_warnings(record=True) as recorded_warnings:
server = self.loop.run_until_complete(
- serve(handler, 'localhost', 0, origins=[''])
+ serve(handler, "localhost", 0, origins=[""])
)
client = self.loop.run_until_complete(connect(get_server_uri(server)))
- self.assertEqual(len(recorded_warnings), 1)
- warning = recorded_warnings[0].message
- self.assertEqual(str(warning), "use None instead of '' in origins")
- self.assertEqual(type(warning), DeprecationWarning)
+ self.assertDeprecationWarnings(
+ recorded_warnings, ["use None instead of '' in origins"]
+ )
self.loop.run_until_complete(client.send("Hello!"))
self.assertEqual(self.loop.run_until_complete(client.recv()), "Hello!")
@@ -1152,24 +1306,53 @@ def test_checking_lack_of_origin_succeeds_backwards_compatibility(self):
self.loop.run_until_complete(server.wait_closed())
-class YieldFromTests(unittest.TestCase):
- def setUp(self):
- self.loop = asyncio.new_event_loop()
- asyncio.set_event_loop(self.loop)
+class YieldFromTests(AsyncioTestCase):
+ def test_client(self):
+ start_server = serve(handler, "localhost", 0)
+ server = self.loop.run_until_complete(start_server)
+
+ # @asyncio.coroutine is deprecated on Python ≥ 3.8
+ with warnings.catch_warnings(record=True):
+
+ @asyncio.coroutine
+ def run_client():
+ # Yield from connect.
+ client = yield from connect(get_server_uri(server))
+ self.assertEqual(client.state, State.OPEN)
+ yield from client.close()
+ self.assertEqual(client.state, State.CLOSED)
+
+ self.loop.run_until_complete(run_client())
+
+ server.close()
+ self.loop.run_until_complete(server.wait_closed())
+
+ def test_server(self):
+ # @asyncio.coroutine is deprecated on Python ≥ 3.8
+ with warnings.catch_warnings(record=True):
+
+ @asyncio.coroutine
+ def run_server():
+ # Yield from serve.
+ server = yield from serve(handler, "localhost", 0)
+ self.assertTrue(server.sockets)
+ server.close()
+ yield from server.wait_closed()
+ self.assertFalse(server.sockets)
+
+ self.loop.run_until_complete(run_server())
- def tearDown(self):
- self.loop.close()
+class AsyncAwaitTests(AsyncioTestCase):
def test_client(self):
- start_server = serve(handler, 'localhost', 0)
+ start_server = serve(handler, "localhost", 0)
server = self.loop.run_until_complete(start_server)
- @asyncio.coroutine
- def run_client():
- # Yield from connect.
- client = yield from connect(get_server_uri(server))
+ async def run_client():
+ # Await connect.
+ client = await connect(get_server_uri(server))
self.assertEqual(client.state, State.OPEN)
- yield from client.close()
+ await client.close()
self.assertEqual(client.state, State.CLOSED)
self.loop.run_until_complete(run_client())
@@ -1178,22 +1361,135 @@ def run_client():
self.loop.run_until_complete(server.wait_closed())
def test_server(self):
- @asyncio.coroutine
- def run_server():
- # Yield from serve.
- server = yield from serve(handler, 'localhost', 0)
+ async def run_server():
+ # Await serve.
+ server = await serve(handler, "localhost", 0)
self.assertTrue(server.sockets)
server.close()
- yield from server.wait_closed()
+ await server.wait_closed()
self.assertFalse(server.sockets)
self.loop.run_until_complete(run_server())
-if sys.version_info[:2] >= (3, 5): # pragma: no cover
- from .py35._test_client_server import AsyncAwaitTests # noqa
- from .py35._test_client_server import ContextManagerTests # noqa
+class ContextManagerTests(AsyncioTestCase):
+ def test_client(self):
+ start_server = serve(handler, "localhost", 0)
+ server = self.loop.run_until_complete(start_server)
+
+ async def run_client():
+ # Use connect as an asynchronous context manager.
+ async with connect(get_server_uri(server)) as client:
+ self.assertEqual(client.state, State.OPEN)
+
+ # Check that exiting the context manager closed the connection.
+ self.assertEqual(client.state, State.CLOSED)
+
+ self.loop.run_until_complete(run_client())
+
+ server.close()
+ self.loop.run_until_complete(server.wait_closed())
+
+ def test_server(self):
+ async def run_server():
+ # Use serve as an asynchronous context manager.
+ async with serve(handler, "localhost", 0) as server:
+ self.assertTrue(server.sockets)
+
+ # Check that exiting the context manager closed the server.
+ self.assertFalse(server.sockets)
+
+ self.loop.run_until_complete(run_server())
+
+ @unittest.skipUnless(hasattr(socket, "AF_UNIX"), "this test requires Unix sockets")
+ def test_unix_server(self):
+ async def run_server(path):
+ async with unix_serve(handler, path) as server:
+ self.assertTrue(server.sockets)
+
+ # Check that exiting the context manager closed the server.
+ self.assertFalse(server.sockets)
+
+ with tempfile.TemporaryDirectory() as temp_dir:
+ path = bytes(pathlib.Path(temp_dir) / "websockets")
+ self.loop.run_until_complete(run_server(path))
-if sys.version_info[:2] >= (3, 6): # pragma: no cover
- from .py36._test_client_server import AsyncIteratorTests # noqa
+class AsyncIteratorTests(AsyncioTestCase):
+
+ # This is a protocol-level feature, but since it's a high-level API, it is
+ # much easier to exercise at the client or server level.
+
+ MESSAGES = ["3", "2", "1", "Fire!"]
+
+ def test_iterate_on_messages(self):
+ async def handler(ws, path):
+ for message in self.MESSAGES:
+ await ws.send(message)
+
+ start_server = serve(handler, "localhost", 0)
+ server = self.loop.run_until_complete(start_server)
+
+ messages = []
+
+ async def run_client():
+ nonlocal messages
+ async with connect(get_server_uri(server)) as ws:
+ async for message in ws:
+ messages.append(message)
+
+ self.loop.run_until_complete(run_client())
+
+ self.assertEqual(messages, self.MESSAGES)
+
+ server.close()
+ self.loop.run_until_complete(server.wait_closed())
+
+ def test_iterate_on_messages_going_away_exit_ok(self):
+ async def handler(ws, path):
+ for message in self.MESSAGES:
+ await ws.send(message)
+ await ws.close(1001)
+
+ start_server = serve(handler, "localhost", 0)
+ server = self.loop.run_until_complete(start_server)
+
+ messages = []
+
+ async def run_client():
+ nonlocal messages
+ async with connect(get_server_uri(server)) as ws:
+ async for message in ws:
+ messages.append(message)
+
+ self.loop.run_until_complete(run_client())
+
+ self.assertEqual(messages, self.MESSAGES)
+
+ server.close()
+ self.loop.run_until_complete(server.wait_closed())
+
+ def test_iterate_on_messages_internal_error_exit_not_ok(self):
+ async def handler(ws, path):
+ for message in self.MESSAGES:
+ await ws.send(message)
+ await ws.close(1011)
+
+ start_server = serve(handler, "localhost", 0)
+ server = self.loop.run_until_complete(start_server)
+
+ messages = []
+
+ async def run_client():
+ nonlocal messages
+ async with connect(get_server_uri(server)) as ws:
+ async for message in ws:
+ messages.append(message)
+
+ with self.assertRaises(ConnectionClosed):
+ self.loop.run_until_complete(run_client())
+
+ self.assertEqual(messages, self.MESSAGES)
+
+ server.close()
+ self.loop.run_until_complete(server.wait_closed())
diff --git a/tests/legacy/test_framing.py b/tests/legacy/test_framing.py
new file mode 100644
index 000000000..ac870c79e
--- /dev/null
+++ b/tests/legacy/test_framing.py
@@ -0,0 +1,171 @@
+import asyncio
+import codecs
+import unittest
+import unittest.mock
+import warnings
+
+from websockets.exceptions import PayloadTooBig, ProtocolError
+from websockets.frames import OP_BINARY, OP_CLOSE, OP_PING, OP_PONG, OP_TEXT
+from websockets.legacy.framing import *
+
+from .utils import AsyncioTestCase
+
+
+class FramingTests(AsyncioTestCase):
+ def decode(self, message, mask=False, max_size=None, extensions=None):
+ stream = asyncio.StreamReader(loop=self.loop)
+ stream.feed_data(message)
+ stream.feed_eof()
+ with warnings.catch_warnings(record=True):
+ frame = self.loop.run_until_complete(
+ Frame.read(
+ stream.readexactly,
+ mask=mask,
+ max_size=max_size,
+ extensions=extensions,
+ )
+ )
+ # Make sure all the data was consumed.
+ self.assertTrue(stream.at_eof())
+ return frame
+
+ def encode(self, frame, mask=False, extensions=None):
+ write = unittest.mock.Mock()
+ with warnings.catch_warnings(record=True):
+ frame.write(write, mask=mask, extensions=extensions)
+ # Ensure the entire frame is sent with a single call to write().
+ # Multiple calls cause TCP fragmentation and degrade performance.
+ self.assertEqual(write.call_count, 1)
+ # The frame data is the single positional argument of that call.
+ self.assertEqual(len(write.call_args[0]), 1)
+ self.assertEqual(len(write.call_args[1]), 0)
+ return write.call_args[0][0]
+
+ def round_trip(self, message, expected, mask=False, extensions=None):
+ decoded = self.decode(message, mask, extensions=extensions)
+ self.assertEqual(decoded, expected)
+ encoded = self.encode(decoded, mask, extensions=extensions)
+ if mask: # non-deterministic encoding
+ decoded = self.decode(encoded, mask, extensions=extensions)
+ self.assertEqual(decoded, expected)
+ else: # deterministic encoding
+ self.assertEqual(encoded, message)
+
+ def test_text(self):
+ self.round_trip(b"\x81\x04Spam", Frame(True, OP_TEXT, b"Spam"))
+
+ def test_text_masked(self):
+ self.round_trip(
+ b"\x81\x84\x5b\xfb\xe1\xa8\x08\x8b\x80\xc5",
+ Frame(True, OP_TEXT, b"Spam"),
+ mask=True,
+ )
+
+ def test_binary(self):
+ self.round_trip(b"\x82\x04Eggs", Frame(True, OP_BINARY, b"Eggs"))
+
+ def test_binary_masked(self):
+ self.round_trip(
+ b"\x82\x84\x53\xcd\xe2\x89\x16\xaa\x85\xfa",
+ Frame(True, OP_BINARY, b"Eggs"),
+ mask=True,
+ )
+
+ def test_non_ascii_text(self):
+ self.round_trip(
+ b"\x81\x05caf\xc3\xa9", Frame(True, OP_TEXT, "café".encode("utf-8"))
+ )
+
+ def test_non_ascii_text_masked(self):
+ self.round_trip(
+ b"\x81\x85\x64\xbe\xee\x7e\x07\xdf\x88\xbd\xcd",
+ Frame(True, OP_TEXT, "café".encode("utf-8")),
+ mask=True,
+ )
+
+ def test_close(self):
+ self.round_trip(b"\x88\x00", Frame(True, OP_CLOSE, b""))
+
+ def test_ping(self):
+ self.round_trip(b"\x89\x04ping", Frame(True, OP_PING, b"ping"))
+
+ def test_pong(self):
+ self.round_trip(b"\x8a\x04pong", Frame(True, OP_PONG, b"pong"))
+
+ def test_long(self):
+ self.round_trip(
+ b"\x82\x7e\x00\x7e" + 126 * b"a", Frame(True, OP_BINARY, 126 * b"a")
+ )
+
+ def test_very_long(self):
+ self.round_trip(
+ b"\x82\x7f\x00\x00\x00\x00\x00\x01\x00\x00" + 65536 * b"a",
+ Frame(True, OP_BINARY, 65536 * b"a"),
+ )
+
+ def test_payload_too_big(self):
+ with self.assertRaises(PayloadTooBig):
+ self.decode(b"\x82\x7e\x04\x01" + 1025 * b"a", max_size=1024)
+
+ def test_bad_reserved_bits(self):
+ for encoded in [b"\xc0\x00", b"\xa0\x00", b"\x90\x00"]:
+ with self.subTest(encoded=encoded):
+ with self.assertRaises(ProtocolError):
+ self.decode(encoded)
+
+ def test_good_opcode(self):
+ for opcode in list(range(0x00, 0x03)) + list(range(0x08, 0x0B)):
+ encoded = bytes([0x80 | opcode, 0])
+ with self.subTest(encoded=encoded):
+ self.decode(encoded) # does not raise an exception
+
+ def test_bad_opcode(self):
+ for opcode in list(range(0x03, 0x08)) + list(range(0x0B, 0x10)):
+ encoded = bytes([0x80 | opcode, 0])
+ with self.subTest(encoded=encoded):
+ with self.assertRaises(ProtocolError):
+ self.decode(encoded)
+
+ def test_mask_flag(self):
+ # Mask flag correctly set.
+ self.decode(b"\x80\x80\x00\x00\x00\x00", mask=True)
+ # Mask flag incorrectly unset.
+ with self.assertRaises(ProtocolError):
+ self.decode(b"\x80\x80\x00\x00\x00\x00")
+ # Mask flag correctly unset.
+ self.decode(b"\x80\x00")
+ # Mask flag incorrectly set.
+ with self.assertRaises(ProtocolError):
+ self.decode(b"\x80\x00", mask=True)
+
+ def test_control_frame_max_length(self):
+ # At maximum allowed length.
+ self.decode(b"\x88\x7e\x00\x7d" + 125 * b"a")
+ # Above maximum allowed length.
+ with self.assertRaises(ProtocolError):
+ self.decode(b"\x88\x7e\x00\x7e" + 126 * b"a")
+
+ def test_fragmented_control_frame(self):
+ # Fin bit correctly set.
+ self.decode(b"\x88\x00")
+ # Fin bit incorrectly unset.
+ with self.assertRaises(ProtocolError):
+ self.decode(b"\x08\x00")
+
+ def test_extensions(self):
+ class Rot13:
+ @staticmethod
+ def encode(frame):
+ assert frame.opcode == OP_TEXT
+ text = frame.data.decode()
+ data = codecs.encode(text, "rot13").encode()
+ return frame._replace(data=data)
+
+ # This extensions is symmetrical.
+ @staticmethod
+ def decode(frame, *, max_size=None):
+ return Rot13.encode(frame)
+
+ self.round_trip(
+ b"\x81\x05uryyb", Frame(True, OP_TEXT, b"hello"), extensions=[Rot13()]
+ )
diff --git a/tests/test_handshake.py b/tests/legacy/test_handshake.py
similarity index 71%
rename from tests/test_handshake.py
rename to tests/legacy/test_handshake.py
index a0cb55a9e..661ae64fc 100644
--- a/tests/test_handshake.py
+++ b/tests/legacy/test_handshake.py
@@ -1,24 +1,18 @@
import contextlib
import unittest
+from websockets.datastructures import Headers
from websockets.exceptions import (
InvalidHandshake,
InvalidHeader,
InvalidHeaderValue,
InvalidUpgrade,
)
-from websockets.handshake import *
-from websockets.handshake import accept # private API
-from websockets.http import Headers
+from websockets.legacy.handshake import *
+from websockets.utils import accept_key
class HandshakeTests(unittest.TestCase):
- def test_accept(self):
- # Test vector from RFC 6455
- key = "dGhlIHNhbXBsZSBub25jZQ=="
- acc = "s3pPLMBiTxaQ9kYGzzhZRbK+xOo="
- self.assertEqual(accept(key), acc)
-
def test_round_trip(self):
request_headers = Headers()
request_key = build_request(request_headers)
@@ -58,70 +52,70 @@ def assertInvalidRequestHeaders(self, exc_type):
def test_request_invalid_connection(self):
with self.assertInvalidRequestHeaders(InvalidUpgrade) as headers:
- del headers['Connection']
- headers['Connection'] = 'Downgrade'
+ del headers["Connection"]
+ headers["Connection"] = "Downgrade"
def test_request_missing_connection(self):
with self.assertInvalidRequestHeaders(InvalidUpgrade) as headers:
- del headers['Connection']
+ del headers["Connection"]
def test_request_additional_connection(self):
with self.assertValidRequestHeaders() as headers:
- headers['Connection'] = 'close'
+ headers["Connection"] = "close"
def test_request_invalid_upgrade(self):
with self.assertInvalidRequestHeaders(InvalidUpgrade) as headers:
- del headers['Upgrade']
- headers['Upgrade'] = 'socketweb'
+ del headers["Upgrade"]
+ headers["Upgrade"] = "socketweb"
def test_request_missing_upgrade(self):
with self.assertInvalidRequestHeaders(InvalidUpgrade) as headers:
- del headers['Upgrade']
+ del headers["Upgrade"]
def test_request_additional_upgrade(self):
with self.assertInvalidRequestHeaders(InvalidUpgrade) as headers:
- headers['Upgrade'] = 'socketweb'
+ headers["Upgrade"] = "socketweb"
def test_request_invalid_key_not_base64(self):
with self.assertInvalidRequestHeaders(InvalidHeaderValue) as headers:
- del headers['Sec-WebSocket-Key']
- headers['Sec-WebSocket-Key'] = "!@#$%^&*()"
+ del headers["Sec-WebSocket-Key"]
+ headers["Sec-WebSocket-Key"] = "!@#$%^&*()"
def test_request_invalid_key_not_well_padded(self):
with self.assertInvalidRequestHeaders(InvalidHeaderValue) as headers:
- del headers['Sec-WebSocket-Key']
- headers['Sec-WebSocket-Key'] = "CSIRmL8dWYxeAdr/XpEHRw"
+ del headers["Sec-WebSocket-Key"]
+ headers["Sec-WebSocket-Key"] = "CSIRmL8dWYxeAdr/XpEHRw"
def test_request_invalid_key_not_16_bytes_long(self):
with self.assertInvalidRequestHeaders(InvalidHeaderValue) as headers:
- del headers['Sec-WebSocket-Key']
- headers['Sec-WebSocket-Key'] = "ZLpprpvK4PE="
+ del headers["Sec-WebSocket-Key"]
+ headers["Sec-WebSocket-Key"] = "ZLpprpvK4PE="
def test_request_missing_key(self):
with self.assertInvalidRequestHeaders(InvalidHeader) as headers:
- del headers['Sec-WebSocket-Key']
+ del headers["Sec-WebSocket-Key"]
def test_request_additional_key(self):
with self.assertInvalidRequestHeaders(InvalidHeader) as headers:
# This duplicates the Sec-WebSocket-Key header.
- headers['Sec-WebSocket-Key'] = headers['Sec-WebSocket-Key']
+ headers["Sec-WebSocket-Key"] = headers["Sec-WebSocket-Key"]
def test_request_invalid_version(self):
with self.assertInvalidRequestHeaders(InvalidHeaderValue) as headers:
- del headers['Sec-WebSocket-Version']
- headers['Sec-WebSocket-Version'] = '42'
+ del headers["Sec-WebSocket-Version"]
+ headers["Sec-WebSocket-Version"] = "42"
def test_request_missing_version(self):
with self.assertInvalidRequestHeaders(InvalidHeader) as headers:
- del headers['Sec-WebSocket-Version']
+ del headers["Sec-WebSocket-Version"]
def test_request_additional_version(self):
with self.assertInvalidRequestHeaders(InvalidHeader) as headers:
# This duplicates the Sec-WebSocket-Version header.
- headers['Sec-WebSocket-Version'] = headers['Sec-WebSocket-Version']
+ headers["Sec-WebSocket-Version"] = headers["Sec-WebSocket-Version"]
@contextlib.contextmanager
- def assertValidResponseHeaders(self, key='CSIRmL8dWYxeAdr/XpEHRw=='):
+ def assertValidResponseHeaders(self, key="CSIRmL8dWYxeAdr/XpEHRw=="):
"""
Provide response headers for modification.
@@ -134,7 +128,7 @@ def assertValidResponseHeaders(self, key='CSIRmL8dWYxeAdr/XpEHRw=='):
check_response(headers, key)
@contextlib.contextmanager
- def assertInvalidResponseHeaders(self, exc_type, key='CSIRmL8dWYxeAdr/XpEHRw=='):
+ def assertInvalidResponseHeaders(self, exc_type, key="CSIRmL8dWYxeAdr/XpEHRw=="):
"""
Provide response headers for modification.
@@ -150,41 +144,41 @@ def assertInvalidResponseHeaders(self, exc_type, key='CSIRmL8dWYxeAdr/XpEHRw==')
def test_response_invalid_connection(self):
with self.assertInvalidResponseHeaders(InvalidUpgrade) as headers:
- del headers['Connection']
- headers['Connection'] = 'Downgrade'
+ del headers["Connection"]
+ headers["Connection"] = "Downgrade"
def test_response_missing_connection(self):
with self.assertInvalidResponseHeaders(InvalidUpgrade) as headers:
- del headers['Connection']
+ del headers["Connection"]
def test_response_additional_connection(self):
with self.assertValidResponseHeaders() as headers:
- headers['Connection'] = 'close'
+ headers["Connection"] = "close"
def test_response_invalid_upgrade(self):
with self.assertInvalidResponseHeaders(InvalidUpgrade) as headers:
- del headers['Upgrade']
- headers['Upgrade'] = 'socketweb'
+ del headers["Upgrade"]
+ headers["Upgrade"] = "socketweb"
def test_response_missing_upgrade(self):
with self.assertInvalidResponseHeaders(InvalidUpgrade) as headers:
- del headers['Upgrade']
+ del headers["Upgrade"]
def test_response_additional_upgrade(self):
with self.assertInvalidResponseHeaders(InvalidUpgrade) as headers:
- headers['Upgrade'] = 'socketweb'
+ headers["Upgrade"] = "socketweb"
def test_response_invalid_accept(self):
with self.assertInvalidResponseHeaders(InvalidHeaderValue) as headers:
- del headers['Sec-WebSocket-Accept']
+ del headers["Sec-WebSocket-Accept"]
other_key = "1Eq4UDEFQYg3YspNgqxv5g=="
- headers['Sec-WebSocket-Accept'] = accept(other_key)
+ headers["Sec-WebSocket-Accept"] = accept_key(other_key)
def test_response_missing_accept(self):
with self.assertInvalidResponseHeaders(InvalidHeader) as headers:
- del headers['Sec-WebSocket-Accept']
+ del headers["Sec-WebSocket-Accept"]
def test_response_additional_accept(self):
with self.assertInvalidResponseHeaders(InvalidHeader) as headers:
# This duplicates the Sec-WebSocket-Accept header.
- headers['Sec-WebSocket-Accept'] = headers['Sec-WebSocket-Accept']
+ headers["Sec-WebSocket-Accept"] = headers["Sec-WebSocket-Accept"]
diff --git a/tests/legacy/test_http.py b/tests/legacy/test_http.py
new file mode 100644
index 000000000..5c9adc97f
--- /dev/null
+++ b/tests/legacy/test_http.py
@@ -0,0 +1,135 @@
+import asyncio
+
+from websockets.exceptions import SecurityError
+from websockets.legacy.http import *
+from websockets.legacy.http import read_headers
+
+from .utils import AsyncioTestCase
+
+
+class HTTPAsyncTests(AsyncioTestCase):
+ def setUp(self):
+ super().setUp()
+ self.stream = asyncio.StreamReader(loop=self.loop)
+
+ async def test_read_request(self):
+ # Example from the protocol overview in RFC 6455
+ self.stream.feed_data(
+ b"GET /chat HTTP/1.1\r\n"
+ b"Host: server.example.com\r\n"
+ b"Upgrade: websocket\r\n"
+ b"Connection: Upgrade\r\n"
+ b"Sec-WebSocket-Key: dGhlIHNhbXBsZSBub25jZQ==\r\n"
+ b"Origin: http://example.com\r\n"
+ b"Sec-WebSocket-Protocol: chat, superchat\r\n"
+ b"Sec-WebSocket-Version: 13\r\n"
+ b"\r\n"
+ )
+ path, headers = await read_request(self.stream)
+ self.assertEqual(path, "/chat")
+ self.assertEqual(headers["Upgrade"], "websocket")
+
+ async def test_read_request_empty(self):
+ self.stream.feed_eof()
+ with self.assertRaisesRegex(
+ EOFError, "connection closed while reading HTTP request line"
+ ):
+ await read_request(self.stream)
+
+ async def test_read_request_invalid_request_line(self):
+ self.stream.feed_data(b"GET /\r\n\r\n")
+ with self.assertRaisesRegex(ValueError, "invalid HTTP request line: GET /"):
+ await read_request(self.stream)
+
+ async def test_read_request_unsupported_method(self):
+ self.stream.feed_data(b"OPTIONS * HTTP/1.1\r\n\r\n")
+ with self.assertRaisesRegex(ValueError, "unsupported HTTP method: OPTIONS"):
+ await read_request(self.stream)
+
+ async def test_read_request_unsupported_version(self):
+ self.stream.feed_data(b"GET /chat HTTP/1.0\r\n\r\n")
+ with self.assertRaisesRegex(ValueError, "unsupported HTTP version: HTTP/1.0"):
+ await read_request(self.stream)
+
+ async def test_read_request_invalid_header(self):
+ self.stream.feed_data(b"GET /chat HTTP/1.1\r\nOops\r\n")
+ with self.assertRaisesRegex(ValueError, "invalid HTTP header line: Oops"):
+ await read_request(self.stream)
+
+ async def test_read_response(self):
+ # Example from the protocol overview in RFC 6455
+ self.stream.feed_data(
+ b"HTTP/1.1 101 Switching Protocols\r\n"
+ b"Upgrade: websocket\r\n"
+ b"Connection: Upgrade\r\n"
+ b"Sec-WebSocket-Accept: s3pPLMBiTxaQ9kYGzzhZRbK+xOo=\r\n"
+ b"Sec-WebSocket-Protocol: chat\r\n"
+ b"\r\n"
+ )
+ status_code, reason, headers = await read_response(self.stream)
+ self.assertEqual(status_code, 101)
+ self.assertEqual(reason, "Switching Protocols")
+ self.assertEqual(headers["Upgrade"], "websocket")
+
+ async def test_read_response_empty(self):
+ self.stream.feed_eof()
+ with self.assertRaisesRegex(
+ EOFError, "connection closed while reading HTTP status line"
+ ):
+ await read_response(self.stream)
+
+ async def test_read_request_invalid_status_line(self):
+ self.stream.feed_data(b"Hello!\r\n")
+ with self.assertRaisesRegex(ValueError, "invalid HTTP status line: Hello!"):
+ await read_response(self.stream)
+
+ async def test_read_response_unsupported_version(self):
+ self.stream.feed_data(b"HTTP/1.0 400 Bad Request\r\n\r\n")
+ with self.assertRaisesRegex(ValueError, "unsupported HTTP version: HTTP/1.0"):
+ await read_response(self.stream)
+
+ async def test_read_response_invalid_status(self):
+ self.stream.feed_data(b"HTTP/1.1 OMG WTF\r\n\r\n")
+ with self.assertRaisesRegex(ValueError, "invalid HTTP status code: OMG"):
+ await read_response(self.stream)
+
+ async def test_read_response_unsupported_status(self):
+ self.stream.feed_data(b"HTTP/1.1 007 My name is Bond\r\n\r\n")
+ with self.assertRaisesRegex(ValueError, "unsupported HTTP status code: 007"):
+ await read_response(self.stream)
+
+ async def test_read_response_invalid_reason(self):
+ self.stream.feed_data(b"HTTP/1.1 200 \x7f\r\n\r\n")
+ with self.assertRaisesRegex(ValueError, "invalid HTTP reason phrase: \\x7f"):
+ await read_response(self.stream)
+
+ async def test_read_response_invalid_header(self):
+ self.stream.feed_data(b"HTTP/1.1 500 Internal Server Error\r\nOops\r\n")
+ with self.assertRaisesRegex(ValueError, "invalid HTTP header line: Oops"):
+ await read_response(self.stream)
+
+ async def test_header_name(self):
+ self.stream.feed_data(b"foo bar: baz qux\r\n\r\n")
+ with self.assertRaises(ValueError):
+ await read_headers(self.stream)
+
+ async def test_header_value(self):
+ self.stream.feed_data(b"foo: \x00\x00\x0f\r\n\r\n")
+ with self.assertRaises(ValueError):
+ await read_headers(self.stream)
+
+ async def test_headers_limit(self):
+ self.stream.feed_data(b"foo: bar\r\n" * 257 + b"\r\n")
+ with self.assertRaises(SecurityError):
+ await read_headers(self.stream)
+
+ async def test_line_limit(self):
+ # Header line contains 5 + 4104 + 2 = 4111 bytes.
+ self.stream.feed_data(b"foo: " + b"a" * 4104 + b"\r\n\r\n")
+ with self.assertRaises(SecurityError):
+ await read_headers(self.stream)
+
+ async def test_line_ending(self):
+ self.stream.feed_data(b"foo: bar\n\n")
+ with self.assertRaises(EOFError):
+ await read_headers(self.stream)
diff --git a/tests/test_protocol.py b/tests/legacy/test_protocol.py
similarity index 63%
rename from tests/test_protocol.py
rename to tests/legacy/test_protocol.py
index aee3289ea..a89bcc88b 100644
--- a/tests/test_protocol.py
+++ b/tests/legacy/test_protocol.py
@@ -1,32 +1,29 @@
import asyncio
import contextlib
-import functools
-import logging
-import os
-import time
+import sys
import unittest
import unittest.mock
+import warnings
-from websockets.compatibility import asyncio_ensure_future
from websockets.exceptions import ConnectionClosed, InvalidState
-from websockets.framing import *
-from websockets.protocol import State, WebSocketCommonProtocol
+from websockets.frames import (
+ OP_BINARY,
+ OP_CLOSE,
+ OP_CONT,
+ OP_PING,
+ OP_PONG,
+ OP_TEXT,
+ serialize_close,
+)
+from websockets.legacy.framing import Frame
+from websockets.legacy.protocol import State, WebSocketCommonProtocol
+from .utils import MS, AsyncioTestCase
-# Avoid displaying stack traces at the ERROR logging level.
-logging.basicConfig(level=logging.CRITICAL)
-
-# Unit for timeouts. May be increased on slow machines by setting the
-# WEBSOCKETS_TESTS_TIMEOUT_FACTOR environment variable.
-MS = 0.001 * int(os.environ.get('WEBSOCKETS_TESTS_TIMEOUT_FACTOR', 1))
-
-# asyncio's debug mode has a 10x performance penalty for this test suite.
-if os.environ.get('PYTHONASYNCIODEBUG'): # pragma: no cover
- MS *= 10
-
-# Ensure that timeouts are larger than the clock's resolution (for Windows).
-MS = max(MS, 2.5 * time.get_clock_info('monotonic').resolution)
+async def async_iterable(iterable):
+ for item in iterable:
+ yield item
class TransportMock(unittest.mock.Mock):
@@ -67,9 +64,6 @@ def write_eof(self):
self.loop.call_soon(self.close)
self._eof = True
- def is_closing(self):
- return self._closing
-
def close(self):
# Simulate how actual transports drop the connection.
if not self._closing:
@@ -92,8 +86,6 @@ class CommonTests:
def setUp(self):
super().setUp()
- self.loop = asyncio.new_event_loop()
- asyncio.set_event_loop(self.loop)
# Disable pings to make it easier to test what frames are sent exactly.
self.protocol = WebSocketCommonProtocol(ping_interval=None)
self.transport = TransportMock()
@@ -102,46 +94,36 @@ def setUp(self):
def tearDown(self):
self.transport.close()
self.loop.run_until_complete(self.protocol.close())
- self.loop.close()
super().tearDown()
# Utilities for writing tests.
- def run_loop_once(self):
- # Process callbacks scheduled with call_soon by appending a callback
- # to stop the event loop then running it until it hits that callback.
- self.loop.call_soon(self.loop.stop)
- self.loop.run_forever()
-
def make_drain_slow(self, delay=MS):
- # Process connection_made in order to initialize self.protocol.writer.
+ # Process connection_made in order to initialize self.protocol.transport.
self.run_loop_once()
- original_drain = self.protocol.writer.drain
-
- @asyncio.coroutine
- def delayed_drain():
- yield from asyncio.sleep(delay, loop=self.loop)
- yield from original_drain()
+ original_drain = self.protocol._drain
- self.protocol.writer.drain = delayed_drain
+ async def delayed_drain():
+ await asyncio.sleep(
+ delay, loop=self.loop if sys.version_info[:2] < (3, 8) else None
+ )
+ await original_drain()
- close_frame = Frame(True, OP_CLOSE, serialize_close(1000, 'close'))
- local_close = Frame(True, OP_CLOSE, serialize_close(1000, 'local'))
- remote_close = Frame(True, OP_CLOSE, serialize_close(1000, 'remote'))
+ self.protocol._drain = delayed_drain
- @property
- def ensure_future(self):
- return functools.partial(asyncio_ensure_future, loop=self.loop)
+ close_frame = Frame(True, OP_CLOSE, serialize_close(1000, "close"))
+ local_close = Frame(True, OP_CLOSE, serialize_close(1000, "local"))
+ remote_close = Frame(True, OP_CLOSE, serialize_close(1000, "remote"))
def receive_frame(self, frame):
"""
Make the protocol receive a frame.
"""
- writer = self.protocol.data_received
+ write = self.protocol.data_received
mask = not self.protocol.is_client
- frame.write(writer, mask=mask)
+ frame.write(write, mask=mask)
def receive_eof(self):
"""
@@ -166,7 +148,7 @@ def receive_eof_if_client(self):
if self.protocol.is_client:
self.receive_eof()
- def close_connection(self, code=1000, reason='close'):
+ def close_connection(self, code=1000, reason="close"):
"""
Execute a closing handshake.
@@ -184,7 +166,7 @@ def close_connection(self, code=1000, reason='close'):
assert self.protocol.state is State.CLOSED
- def half_close_connection_local(self, code=1000, reason='close'):
+ def half_close_connection_local(self, code=1000, reason="close"):
"""
Start a closing handshake but do not complete it.
@@ -197,7 +179,7 @@ def half_close_connection_local(self, code=1000, reason='close'):
"""
close_frame_data = serialize_close(code, reason)
# Trigger the closing handshake from the local endpoint.
- close_task = self.ensure_future(self.protocol.close(code, reason))
+ close_task = self.loop.create_task(self.protocol.close(code, reason))
self.run_loop_once() # wait_for executes
self.run_loop_once() # write_frame executes
# Empty the outgoing data stream so we can make assertions later on.
@@ -215,7 +197,7 @@ def half_close_connection_local(self, code=1000, reason='close'):
# This task must be awaited or canceled by the caller.
return close_task
- def half_close_connection_remote(self, code=1000, reason='close'):
+ def half_close_connection_remote(self, code=1000, reason="close"):
"""
Receive a closing handshake but do not complete it.
@@ -310,7 +292,7 @@ def assertConnectionFailed(self, code, message):
self.assertEqual(self.protocol.state, State.CLOSED)
# No close frame was received.
self.assertEqual(self.protocol.close_code, 1006)
- self.assertEqual(self.protocol.close_reason, '')
+ self.assertEqual(self.protocol.close_reason, "")
# A close frame was sent -- unless the connection was already lost.
if code == 1006:
self.assertNoFrameSent()
@@ -323,42 +305,55 @@ def assertCompletesWithin(self, min_time, max_time):
yield
t1 = self.loop.time()
dt = t1 - t0
- self.assertGreaterEqual(dt, min_time, "Too fast: {} < {}".format(dt, min_time))
- self.assertLess(dt, max_time, "Too slow: {} >= {}".format(dt, max_time))
+ self.assertGreaterEqual(dt, min_time, f"Too fast: {dt} < {min_time}")
+ self.assertLess(dt, max_time, f"Too slow: {dt} >= {max_time}")
+
+ # Test constructor.
+
+ def test_timeout_backwards_compatibility(self):
+ with warnings.catch_warnings(record=True) as recorded_warnings:
+ protocol = WebSocketCommonProtocol(timeout=5)
+
+ self.assertEqual(protocol.close_timeout, 5)
+
+ self.assertEqual(len(recorded_warnings), 1)
+ warning = recorded_warnings[0].message
+ self.assertEqual(str(warning), "rename timeout to close_timeout")
+ self.assertEqual(type(warning), DeprecationWarning)
# Test public attributes.
def test_local_address(self):
- get_extra_info = unittest.mock.Mock(return_value=('host', 4312))
+ get_extra_info = unittest.mock.Mock(return_value=("host", 4312))
self.transport.get_extra_info = get_extra_info
- self.assertEqual(self.protocol.local_address, ('host', 4312))
- get_extra_info.assert_called_with('sockname', None)
+ self.assertEqual(self.protocol.local_address, ("host", 4312))
+ get_extra_info.assert_called_with("sockname")
def test_local_address_before_connection(self):
# Emulate the situation before connection_open() runs.
- self.protocol.writer, _writer = None, self.protocol.writer
-
+ _transport = self.protocol.transport
+ del self.protocol.transport
try:
self.assertEqual(self.protocol.local_address, None)
finally:
- self.protocol.writer = _writer
+ self.protocol.transport = _transport
def test_remote_address(self):
- get_extra_info = unittest.mock.Mock(return_value=('host', 4312))
+ get_extra_info = unittest.mock.Mock(return_value=("host", 4312))
self.transport.get_extra_info = get_extra_info
- self.assertEqual(self.protocol.remote_address, ('host', 4312))
- get_extra_info.assert_called_with('peername', None)
+ self.assertEqual(self.protocol.remote_address, ("host", 4312))
+ get_extra_info.assert_called_with("peername")
def test_remote_address_before_connection(self):
# Emulate the situation before connection_open() runs.
- self.protocol.writer, _writer = None, self.protocol.writer
-
+ _transport = self.protocol.transport
+ del self.protocol.transport
try:
self.assertEqual(self.protocol.remote_address, None)
finally:
- self.protocol.writer = _writer
+ self.protocol.transport = _transport
def test_open(self):
self.assertTrue(self.protocol.open)
@@ -371,7 +366,7 @@ def test_closed(self):
self.assertTrue(self.protocol.closed)
def test_wait_closed(self):
- wait_closed = asyncio_ensure_future(self.protocol.wait_closed())
+ wait_closed = self.loop.create_task(self.protocol.wait_closed())
self.assertFalse(wait_closed.done())
self.close_connection()
self.assertTrue(wait_closed.done())
@@ -379,14 +374,14 @@ def test_wait_closed(self):
# Test the recv coroutine.
def test_recv_text(self):
- self.receive_frame(Frame(True, OP_TEXT, 'café'.encode('utf-8')))
+ self.receive_frame(Frame(True, OP_TEXT, "café".encode("utf-8")))
data = self.loop.run_until_complete(self.protocol.recv())
- self.assertEqual(data, 'café')
+ self.assertEqual(data, "café")
def test_recv_binary(self):
- self.receive_frame(Frame(True, OP_BINARY, b'tea'))
+ self.receive_frame(Frame(True, OP_BINARY, b"tea"))
data = self.loop.run_until_complete(self.protocol.recv())
- self.assertEqual(data, b'tea')
+ self.assertEqual(data, b"tea")
def test_recv_on_closing_connection_local(self):
close_task = self.half_close_connection_local()
@@ -409,131 +404,186 @@ def test_recv_on_closed_connection(self):
self.loop.run_until_complete(self.protocol.recv())
def test_recv_protocol_error(self):
- self.receive_frame(Frame(True, OP_CONT, 'café'.encode('utf-8')))
+ self.receive_frame(Frame(True, OP_CONT, "café".encode("utf-8")))
self.process_invalid_frames()
- self.assertConnectionFailed(1002, '')
+ self.assertConnectionFailed(1002, "")
def test_recv_unicode_error(self):
- self.receive_frame(Frame(True, OP_TEXT, 'café'.encode('latin-1')))
+ self.receive_frame(Frame(True, OP_TEXT, "café".encode("latin-1")))
self.process_invalid_frames()
- self.assertConnectionFailed(1007, '')
+ self.assertConnectionFailed(1007, "")
def test_recv_text_payload_too_big(self):
self.protocol.max_size = 1024
- self.receive_frame(Frame(True, OP_TEXT, 'café'.encode('utf-8') * 205))
+ self.receive_frame(Frame(True, OP_TEXT, "café".encode("utf-8") * 205))
self.process_invalid_frames()
- self.assertConnectionFailed(1009, '')
+ self.assertConnectionFailed(1009, "")
def test_recv_binary_payload_too_big(self):
self.protocol.max_size = 1024
- self.receive_frame(Frame(True, OP_BINARY, b'tea' * 342))
+ self.receive_frame(Frame(True, OP_BINARY, b"tea" * 342))
self.process_invalid_frames()
- self.assertConnectionFailed(1009, '')
+ self.assertConnectionFailed(1009, "")
def test_recv_text_no_max_size(self):
self.protocol.max_size = None # for test coverage
- self.receive_frame(Frame(True, OP_TEXT, 'café'.encode('utf-8') * 205))
+ self.receive_frame(Frame(True, OP_TEXT, "café".encode("utf-8") * 205))
data = self.loop.run_until_complete(self.protocol.recv())
- self.assertEqual(data, 'café' * 205)
+ self.assertEqual(data, "café" * 205)
def test_recv_binary_no_max_size(self):
self.protocol.max_size = None # for test coverage
- self.receive_frame(Frame(True, OP_BINARY, b'tea' * 342))
+ self.receive_frame(Frame(True, OP_BINARY, b"tea" * 342))
data = self.loop.run_until_complete(self.protocol.recv())
- self.assertEqual(data, b'tea' * 342)
+ self.assertEqual(data, b"tea" * 342)
def test_recv_queue_empty(self):
- recv = self.ensure_future(self.protocol.recv())
+ recv = self.loop.create_task(self.protocol.recv())
with self.assertRaises(asyncio.TimeoutError):
self.loop.run_until_complete(
asyncio.wait_for(asyncio.shield(recv), timeout=MS)
)
- self.receive_frame(Frame(True, OP_TEXT, 'café'.encode('utf-8')))
+ self.receive_frame(Frame(True, OP_TEXT, "café".encode("utf-8")))
data = self.loop.run_until_complete(recv)
- self.assertEqual(data, 'café')
+ self.assertEqual(data, "café")
def test_recv_queue_full(self):
self.protocol.max_queue = 2
# Test internals because it's hard to verify buffers from the outside.
self.assertEqual(list(self.protocol.messages), [])
- self.receive_frame(Frame(True, OP_TEXT, 'café'.encode('utf-8')))
+ self.receive_frame(Frame(True, OP_TEXT, "café".encode("utf-8")))
self.run_loop_once()
- self.assertEqual(list(self.protocol.messages), ['café'])
+ self.assertEqual(list(self.protocol.messages), ["café"])
- self.receive_frame(Frame(True, OP_BINARY, b'tea'))
+ self.receive_frame(Frame(True, OP_BINARY, b"tea"))
self.run_loop_once()
- self.assertEqual(list(self.protocol.messages), ['café', b'tea'])
+ self.assertEqual(list(self.protocol.messages), ["café", b"tea"])
- self.receive_frame(Frame(True, OP_BINARY, b'milk'))
+ self.receive_frame(Frame(True, OP_BINARY, b"milk"))
self.run_loop_once()
- self.assertEqual(list(self.protocol.messages), ['café', b'tea'])
+ self.assertEqual(list(self.protocol.messages), ["café", b"tea"])
self.loop.run_until_complete(self.protocol.recv())
- self.assertEqual(list(self.protocol.messages), [b'tea', b'milk'])
+ self.run_loop_once()
+ self.assertEqual(list(self.protocol.messages), [b"tea", b"milk"])
self.loop.run_until_complete(self.protocol.recv())
- self.assertEqual(list(self.protocol.messages), [b'milk'])
+ self.run_loop_once()
+ self.assertEqual(list(self.protocol.messages), [b"milk"])
self.loop.run_until_complete(self.protocol.recv())
+ self.run_loop_once()
+ self.assertEqual(list(self.protocol.messages), [])
+
+ def test_recv_queue_no_limit(self):
+ self.protocol.max_queue = None
+
+ for _ in range(100):
+ self.receive_frame(Frame(True, OP_TEXT, "café".encode("utf-8")))
+ self.run_loop_once()
+
+ # Incoming message queue can contain at least 100 messages.
+ self.assertEqual(list(self.protocol.messages), ["café"] * 100)
+
+ for _ in range(100):
+ self.loop.run_until_complete(self.protocol.recv())
+
self.assertEqual(list(self.protocol.messages), [])
def test_recv_other_error(self):
- @asyncio.coroutine
- def read_message():
+ async def read_message():
raise Exception("BOOM")
self.protocol.read_message = read_message
self.process_invalid_frames()
- self.assertConnectionFailed(1011, '')
+ self.assertConnectionFailed(1011, "")
def test_recv_canceled(self):
- recv = self.ensure_future(self.protocol.recv())
+ recv = self.loop.create_task(self.protocol.recv())
self.loop.call_soon(recv.cancel)
with self.assertRaises(asyncio.CancelledError):
self.loop.run_until_complete(recv)
# The next frame doesn't disappear in a vacuum (it used to).
- self.receive_frame(Frame(True, OP_TEXT, 'café'.encode('utf-8')))
+ self.receive_frame(Frame(True, OP_TEXT, "café".encode("utf-8")))
data = self.loop.run_until_complete(self.protocol.recv())
- self.assertEqual(data, 'café')
+ self.assertEqual(data, "café")
def test_recv_canceled_race_condition(self):
- recv = self.ensure_future(
- asyncio.wait_for(self.protocol.recv(), timeout=0.000001)
+ recv = self.loop.create_task(
+ asyncio.wait_for(self.protocol.recv(), timeout=0.000_001)
)
self.loop.call_soon(
- self.receive_frame, Frame(True, OP_TEXT, 'café'.encode('utf-8'))
+ self.receive_frame, Frame(True, OP_TEXT, "café".encode("utf-8"))
)
with self.assertRaises(asyncio.TimeoutError):
self.loop.run_until_complete(recv)
# The previous frame doesn't disappear in a vacuum (it used to).
- self.receive_frame(Frame(True, OP_TEXT, 'tea'.encode('utf-8')))
+ self.receive_frame(Frame(True, OP_TEXT, "tea".encode("utf-8")))
data = self.loop.run_until_complete(self.protocol.recv())
# If we're getting "tea" there, it means "café" was swallowed (ha, ha).
- self.assertEqual(data, 'café')
+ self.assertEqual(data, "café")
+
+ def test_recv_when_transfer_data_cancelled(self):
+ # Clog incoming queue.
+ self.protocol.max_queue = 1
+ self.receive_frame(Frame(True, OP_TEXT, "café".encode("utf-8")))
+ self.receive_frame(Frame(True, OP_BINARY, b"tea"))
+ self.run_loop_once()
+
+ # Flow control kicks in (check with an implementation detail).
+ self.assertFalse(self.protocol._put_message_waiter.done())
+
+ # Schedule recv().
+ recv = self.loop.create_task(self.protocol.recv())
+
+ # Cancel transfer_data_task (again, implementation detail).
+ self.protocol.fail_connection()
+ self.run_loop_once()
+ self.assertTrue(self.protocol.transfer_data_task.cancelled())
+
+ # recv() completes properly.
+ self.assertEqual(self.loop.run_until_complete(recv), "café")
def test_recv_prevents_concurrent_calls(self):
- recv = self.ensure_future(self.protocol.recv())
+ recv = self.loop.create_task(self.protocol.recv())
- with self.assertRaises(RuntimeError):
+ with self.assertRaises(RuntimeError) as raised:
self.loop.run_until_complete(self.protocol.recv())
-
+ self.assertEqual(
+ str(raised.exception),
+ "cannot call recv while another coroutine "
+ "is already waiting for the next message",
+ )
recv.cancel()
# Test the send coroutine.
def test_send_text(self):
- self.loop.run_until_complete(self.protocol.send('café'))
- self.assertOneFrameSent(True, OP_TEXT, 'café'.encode('utf-8'))
+ self.loop.run_until_complete(self.protocol.send("café"))
+ self.assertOneFrameSent(True, OP_TEXT, "café".encode("utf-8"))
def test_send_binary(self):
- self.loop.run_until_complete(self.protocol.send(b'tea'))
- self.assertOneFrameSent(True, OP_BINARY, b'tea')
+ self.loop.run_until_complete(self.protocol.send(b"tea"))
+ self.assertOneFrameSent(True, OP_BINARY, b"tea")
+
+ def test_send_binary_from_bytearray(self):
+ self.loop.run_until_complete(self.protocol.send(bytearray(b"tea")))
+ self.assertOneFrameSent(True, OP_BINARY, b"tea")
+
+ def test_send_binary_from_memoryview(self):
+ self.loop.run_until_complete(self.protocol.send(memoryview(b"tea")))
+ self.assertOneFrameSent(True, OP_BINARY, b"tea")
+
+ def test_send_dict(self):
+ with self.assertRaises(TypeError):
+ self.loop.run_until_complete(self.protocol.send({"not": "encoded"}))
+ self.assertNoFrameSent()
def test_send_type_error(self):
with self.assertRaises(TypeError):
@@ -541,17 +591,33 @@ def test_send_type_error(self):
self.assertNoFrameSent()
def test_send_iterable_text(self):
- self.loop.run_until_complete(self.protocol.send(['ca', 'fé']))
+ self.loop.run_until_complete(self.protocol.send(["ca", "fé"]))
self.assertFramesSent(
- (False, OP_TEXT, 'ca'.encode('utf-8')),
- (False, OP_CONT, 'fé'.encode('utf-8')),
- (True, OP_CONT, ''.encode('utf-8')),
+ (False, OP_TEXT, "ca".encode("utf-8")),
+ (False, OP_CONT, "fé".encode("utf-8")),
+ (True, OP_CONT, "".encode("utf-8")),
)
def test_send_iterable_binary(self):
- self.loop.run_until_complete(self.protocol.send([b'te', b'a']))
+ self.loop.run_until_complete(self.protocol.send([b"te", b"a"]))
+ self.assertFramesSent(
+ (False, OP_BINARY, b"te"), (False, OP_CONT, b"a"), (True, OP_CONT, b"")
+ )
+
+ def test_send_iterable_binary_from_bytearray(self):
+ self.loop.run_until_complete(
+ self.protocol.send([bytearray(b"te"), bytearray(b"a")])
+ )
+ self.assertFramesSent(
+ (False, OP_BINARY, b"te"), (False, OP_CONT, b"a"), (True, OP_CONT, b"")
+ )
+
+ def test_send_iterable_binary_from_memoryview(self):
+ self.loop.run_until_complete(
+ self.protocol.send([memoryview(b"te"), memoryview(b"a")])
+ )
self.assertFramesSent(
- (False, OP_BINARY, b'te'), (False, OP_CONT, b'a'), (True, OP_CONT, b'')
+ (False, OP_BINARY, b"te"), (False, OP_CONT, b"a"), (True, OP_CONT, b"")
)
def test_send_empty_iterable(self):
@@ -565,17 +631,104 @@ def test_send_iterable_type_error(self):
def test_send_iterable_mixed_type_error(self):
with self.assertRaises(TypeError):
- self.loop.run_until_complete(self.protocol.send(['café', b'tea']))
+ self.loop.run_until_complete(self.protocol.send(["café", b"tea"]))
+ self.assertFramesSent(
+ (False, OP_TEXT, "café".encode("utf-8")),
+ (True, OP_CLOSE, serialize_close(1011, "")),
+ )
+
+ def test_send_iterable_prevents_concurrent_send(self):
+ self.make_drain_slow(2 * MS)
+
+ async def send_iterable():
+ await self.protocol.send(["ca", "fé"])
+
+ async def send_concurrent():
+ await asyncio.sleep(MS)
+ await self.protocol.send(b"tea")
+
+ self.loop.run_until_complete(asyncio.gather(send_iterable(), send_concurrent()))
self.assertFramesSent(
- (False, OP_TEXT, 'café'.encode('utf-8')),
- (True, OP_CLOSE, serialize_close(1011, '')),
+ (False, OP_TEXT, "ca".encode("utf-8")),
+ (False, OP_CONT, "fé".encode("utf-8")),
+ (True, OP_CONT, "".encode("utf-8")),
+ (True, OP_BINARY, b"tea"),
+ )
+
+ def test_send_async_iterable_text(self):
+ self.loop.run_until_complete(self.protocol.send(async_iterable(["ca", "fé"])))
+ self.assertFramesSent(
+ (False, OP_TEXT, "ca".encode("utf-8")),
+ (False, OP_CONT, "fé".encode("utf-8")),
+ (True, OP_CONT, "".encode("utf-8")),
+ )
+
+ def test_send_async_iterable_binary(self):
+ self.loop.run_until_complete(self.protocol.send(async_iterable([b"te", b"a"])))
+ self.assertFramesSent(
+ (False, OP_BINARY, b"te"), (False, OP_CONT, b"a"), (True, OP_CONT, b"")
+ )
+
+ def test_send_async_iterable_binary_from_bytearray(self):
+ self.loop.run_until_complete(
+ self.protocol.send(async_iterable([bytearray(b"te"), bytearray(b"a")]))
+ )
+ self.assertFramesSent(
+ (False, OP_BINARY, b"te"), (False, OP_CONT, b"a"), (True, OP_CONT, b"")
+ )
+
+ def test_send_async_iterable_binary_from_memoryview(self):
+ self.loop.run_until_complete(
+ self.protocol.send(async_iterable([memoryview(b"te"), memoryview(b"a")]))
+ )
+ self.assertFramesSent(
+ (False, OP_BINARY, b"te"), (False, OP_CONT, b"a"), (True, OP_CONT, b"")
+ )
+
+ def test_send_empty_async_iterable(self):
+ self.loop.run_until_complete(self.protocol.send(async_iterable([])))
+ self.assertNoFrameSent()
+
+ def test_send_async_iterable_type_error(self):
+ with self.assertRaises(TypeError):
+ self.loop.run_until_complete(self.protocol.send(async_iterable([42])))
+ self.assertNoFrameSent()
+
+ def test_send_async_iterable_mixed_type_error(self):
+ with self.assertRaises(TypeError):
+ self.loop.run_until_complete(
+ self.protocol.send(async_iterable(["café", b"tea"]))
+ )
+ self.assertFramesSent(
+ (False, OP_TEXT, "café".encode("utf-8")),
+ (True, OP_CLOSE, serialize_close(1011, "")),
+ )
+
+ def test_send_async_iterable_prevents_concurrent_send(self):
+ self.make_drain_slow(2 * MS)
+
+ async def send_async_iterable():
+ await self.protocol.send(async_iterable(["ca", "fé"]))
+
+ async def send_concurrent():
+ await asyncio.sleep(MS)
+ await self.protocol.send(b"tea")
+
+ self.loop.run_until_complete(
+ asyncio.gather(send_async_iterable(), send_concurrent())
+ )
+ self.assertFramesSent(
+ (False, OP_TEXT, "ca".encode("utf-8")),
+ (False, OP_CONT, "fé".encode("utf-8")),
+ (True, OP_CONT, "".encode("utf-8")),
+ (True, OP_BINARY, b"tea"),
)
def test_send_on_closing_connection_local(self):
close_task = self.half_close_connection_local()
with self.assertRaises(ConnectionClosed):
- self.loop.run_until_complete(self.protocol.send('foobar'))
+ self.loop.run_until_complete(self.protocol.send("foobar"))
self.assertNoFrameSent()
@@ -585,7 +738,7 @@ def test_send_on_closing_connection_remote(self):
self.half_close_connection_remote()
with self.assertRaises(ConnectionClosed):
- self.loop.run_until_complete(self.protocol.send('foobar'))
+ self.loop.run_until_complete(self.protocol.send("foobar"))
self.assertNoFrameSent()
@@ -593,7 +746,7 @@ def test_send_on_closed_connection(self):
self.close_connection()
with self.assertRaises(ConnectionClosed):
- self.loop.run_until_complete(self.protocol.send('foobar'))
+ self.loop.run_until_complete(self.protocol.send("foobar"))
self.assertNoFrameSent()
@@ -609,12 +762,20 @@ def test_ping_default(self):
self.assertOneFrameSent(True, OP_PING, ping_data)
def test_ping_text(self):
- self.loop.run_until_complete(self.protocol.ping('café'))
- self.assertOneFrameSent(True, OP_PING, 'café'.encode('utf-8'))
+ self.loop.run_until_complete(self.protocol.ping("café"))
+ self.assertOneFrameSent(True, OP_PING, "café".encode("utf-8"))
def test_ping_binary(self):
- self.loop.run_until_complete(self.protocol.ping(b'tea'))
- self.assertOneFrameSent(True, OP_PING, b'tea')
+ self.loop.run_until_complete(self.protocol.ping(b"tea"))
+ self.assertOneFrameSent(True, OP_PING, b"tea")
+
+ def test_ping_binary_from_bytearray(self):
+ self.loop.run_until_complete(self.protocol.ping(bytearray(b"tea")))
+ self.assertOneFrameSent(True, OP_PING, b"tea")
+
+ def test_ping_binary_from_memoryview(self):
+ self.loop.run_until_complete(self.protocol.ping(memoryview(b"tea")))
+ self.assertOneFrameSent(True, OP_PING, b"tea")
def test_ping_type_error(self):
with self.assertRaises(TypeError):
@@ -651,15 +812,23 @@ def test_ping_on_closed_connection(self):
def test_pong_default(self):
self.loop.run_until_complete(self.protocol.pong())
- self.assertOneFrameSent(True, OP_PONG, b'')
+ self.assertOneFrameSent(True, OP_PONG, b"")
def test_pong_text(self):
- self.loop.run_until_complete(self.protocol.pong('café'))
- self.assertOneFrameSent(True, OP_PONG, 'café'.encode('utf-8'))
+ self.loop.run_until_complete(self.protocol.pong("café"))
+ self.assertOneFrameSent(True, OP_PONG, "café".encode("utf-8"))
def test_pong_binary(self):
- self.loop.run_until_complete(self.protocol.pong(b'tea'))
- self.assertOneFrameSent(True, OP_PONG, b'tea')
+ self.loop.run_until_complete(self.protocol.pong(b"tea"))
+ self.assertOneFrameSent(True, OP_PONG, b"tea")
+
+ def test_pong_binary_from_bytearray(self):
+ self.loop.run_until_complete(self.protocol.pong(bytearray(b"tea")))
+ self.assertOneFrameSent(True, OP_PONG, b"tea")
+
+ def test_pong_binary_from_memoryview(self):
+ self.loop.run_until_complete(self.protocol.pong(memoryview(b"tea")))
+ self.assertOneFrameSent(True, OP_PONG, b"tea")
def test_pong_type_error(self):
with self.assertRaises(TypeError):
@@ -695,12 +864,12 @@ def test_pong_on_closed_connection(self):
# Test the protocol's logic for acknowledging pings with pongs.
def test_answer_ping(self):
- self.receive_frame(Frame(True, OP_PING, b'test'))
+ self.receive_frame(Frame(True, OP_PING, b"test"))
self.run_loop_once()
- self.assertOneFrameSent(True, OP_PONG, b'test')
+ self.assertOneFrameSent(True, OP_PONG, b"test")
def test_ignore_pong(self):
- self.receive_frame(Frame(True, OP_PONG, b'test'))
+ self.receive_frame(Frame(True, OP_PONG, b"test"))
self.run_loop_once()
self.assertNoFrameSent()
@@ -723,13 +892,23 @@ def test_abort_ping(self):
self.assertTrue(ping.done())
self.assertIsInstance(ping.exception(), ConnectionClosed)
+ def test_abort_ping_does_not_log_exception_if_not_retreived(self):
+ self.loop.run_until_complete(self.protocol.ping())
+ # Get the internal Future, which isn't directly returned by ping().
+ (ping,) = self.protocol.pings.values()
+ # Remove the frame from the buffer, else close_connection() complains.
+ self.last_sent_frame()
+ self.close_connection()
+ # Check a private attribute, for lack of a better solution.
+ self.assertFalse(ping._log_traceback)
+
def test_acknowledge_previous_pings(self):
pings = [
(self.loop.run_until_complete(self.protocol.ping()), self.last_sent_frame())
for i in range(3)
]
# Unsolicited pong doesn't acknowledge pings
- self.receive_frame(Frame(True, OP_PONG, b''))
+ self.receive_frame(Frame(True, OP_PONG, b""))
self.run_loop_once()
self.run_loop_once()
self.assertFalse(pings[0][0].done())
@@ -743,6 +922,31 @@ def test_acknowledge_previous_pings(self):
self.assertTrue(pings[1][0].done())
self.assertFalse(pings[2][0].done())
+ def test_acknowledge_aborted_ping(self):
+ ping = self.loop.run_until_complete(self.protocol.ping())
+ ping_frame = self.last_sent_frame()
+ # Clog incoming queue. This lets connection_lost() abort pending pings
+ # with a ConnectionClosed exception before transfer_data_task
+ # terminates and close_connection cancels keepalive_ping_task.
+ self.protocol.max_queue = 1
+ self.receive_frame(Frame(True, OP_TEXT, b"1"))
+ self.receive_frame(Frame(True, OP_TEXT, b"2"))
+ # Add pong frame to the queue.
+ pong_frame = Frame(True, OP_PONG, ping_frame.data)
+ self.receive_frame(pong_frame)
+ # Connection drops.
+ self.receive_eof()
+ self.loop.run_until_complete(self.protocol.wait_closed())
+ # Ping receives a ConnectionClosed exception.
+ with self.assertRaises(ConnectionClosed):
+ ping.result()
+
+ # transfer_data doesn't crash, which would be logged.
+ with self.assertNoLogs():
+ # Unclog incoming queue.
+ self.loop.run_until_complete(self.protocol.recv())
+ self.loop.run_until_complete(self.protocol.recv())
+
def test_canceled_ping(self):
ping = self.loop.run_until_complete(self.protocol.ping())
ping_frame = self.last_sent_frame()
@@ -754,84 +958,84 @@ def test_canceled_ping(self):
self.assertTrue(ping.cancelled())
def test_duplicate_ping(self):
- self.loop.run_until_complete(self.protocol.ping(b'foobar'))
- self.assertOneFrameSent(True, OP_PING, b'foobar')
+ self.loop.run_until_complete(self.protocol.ping(b"foobar"))
+ self.assertOneFrameSent(True, OP_PING, b"foobar")
with self.assertRaises(ValueError):
- self.loop.run_until_complete(self.protocol.ping(b'foobar'))
+ self.loop.run_until_complete(self.protocol.ping(b"foobar"))
self.assertNoFrameSent()
# Test the protocol's logic for rebuilding fragmented messages.
def test_fragmented_text(self):
- self.receive_frame(Frame(False, OP_TEXT, 'ca'.encode('utf-8')))
- self.receive_frame(Frame(True, OP_CONT, 'fé'.encode('utf-8')))
+ self.receive_frame(Frame(False, OP_TEXT, "ca".encode("utf-8")))
+ self.receive_frame(Frame(True, OP_CONT, "fé".encode("utf-8")))
data = self.loop.run_until_complete(self.protocol.recv())
- self.assertEqual(data, 'café')
+ self.assertEqual(data, "café")
def test_fragmented_binary(self):
- self.receive_frame(Frame(False, OP_BINARY, b't'))
- self.receive_frame(Frame(False, OP_CONT, b'e'))
- self.receive_frame(Frame(True, OP_CONT, b'a'))
+ self.receive_frame(Frame(False, OP_BINARY, b"t"))
+ self.receive_frame(Frame(False, OP_CONT, b"e"))
+ self.receive_frame(Frame(True, OP_CONT, b"a"))
data = self.loop.run_until_complete(self.protocol.recv())
- self.assertEqual(data, b'tea')
+ self.assertEqual(data, b"tea")
def test_fragmented_text_payload_too_big(self):
self.protocol.max_size = 1024
- self.receive_frame(Frame(False, OP_TEXT, 'café'.encode('utf-8') * 100))
- self.receive_frame(Frame(True, OP_CONT, 'café'.encode('utf-8') * 105))
+ self.receive_frame(Frame(False, OP_TEXT, "café".encode("utf-8") * 100))
+ self.receive_frame(Frame(True, OP_CONT, "café".encode("utf-8") * 105))
self.process_invalid_frames()
- self.assertConnectionFailed(1009, '')
+ self.assertConnectionFailed(1009, "")
def test_fragmented_binary_payload_too_big(self):
self.protocol.max_size = 1024
- self.receive_frame(Frame(False, OP_BINARY, b'tea' * 171))
- self.receive_frame(Frame(True, OP_CONT, b'tea' * 171))
+ self.receive_frame(Frame(False, OP_BINARY, b"tea" * 171))
+ self.receive_frame(Frame(True, OP_CONT, b"tea" * 171))
self.process_invalid_frames()
- self.assertConnectionFailed(1009, '')
+ self.assertConnectionFailed(1009, "")
def test_fragmented_text_no_max_size(self):
self.protocol.max_size = None # for test coverage
- self.receive_frame(Frame(False, OP_TEXT, 'café'.encode('utf-8') * 100))
- self.receive_frame(Frame(True, OP_CONT, 'café'.encode('utf-8') * 105))
+ self.receive_frame(Frame(False, OP_TEXT, "café".encode("utf-8") * 100))
+ self.receive_frame(Frame(True, OP_CONT, "café".encode("utf-8") * 105))
data = self.loop.run_until_complete(self.protocol.recv())
- self.assertEqual(data, 'café' * 205)
+ self.assertEqual(data, "café" * 205)
def test_fragmented_binary_no_max_size(self):
self.protocol.max_size = None # for test coverage
- self.receive_frame(Frame(False, OP_BINARY, b'tea' * 171))
- self.receive_frame(Frame(True, OP_CONT, b'tea' * 171))
+ self.receive_frame(Frame(False, OP_BINARY, b"tea" * 171))
+ self.receive_frame(Frame(True, OP_CONT, b"tea" * 171))
data = self.loop.run_until_complete(self.protocol.recv())
- self.assertEqual(data, b'tea' * 342)
+ self.assertEqual(data, b"tea" * 342)
def test_control_frame_within_fragmented_text(self):
- self.receive_frame(Frame(False, OP_TEXT, 'ca'.encode('utf-8')))
- self.receive_frame(Frame(True, OP_PING, b''))
- self.receive_frame(Frame(True, OP_CONT, 'fé'.encode('utf-8')))
+ self.receive_frame(Frame(False, OP_TEXT, "ca".encode("utf-8")))
+ self.receive_frame(Frame(True, OP_PING, b""))
+ self.receive_frame(Frame(True, OP_CONT, "fé".encode("utf-8")))
data = self.loop.run_until_complete(self.protocol.recv())
- self.assertEqual(data, 'café')
- self.assertOneFrameSent(True, OP_PONG, b'')
+ self.assertEqual(data, "café")
+ self.assertOneFrameSent(True, OP_PONG, b"")
def test_unterminated_fragmented_text(self):
- self.receive_frame(Frame(False, OP_TEXT, 'ca'.encode('utf-8')))
+ self.receive_frame(Frame(False, OP_TEXT, "ca".encode("utf-8")))
# Missing the second part of the fragmented frame.
- self.receive_frame(Frame(True, OP_BINARY, b'tea'))
+ self.receive_frame(Frame(True, OP_BINARY, b"tea"))
self.process_invalid_frames()
- self.assertConnectionFailed(1002, '')
+ self.assertConnectionFailed(1002, "")
def test_close_handshake_in_fragmented_text(self):
- self.receive_frame(Frame(False, OP_TEXT, 'ca'.encode('utf-8')))
- self.receive_frame(Frame(True, OP_CLOSE, b''))
+ self.receive_frame(Frame(False, OP_TEXT, "ca".encode("utf-8")))
+ self.receive_frame(Frame(True, OP_CLOSE, b""))
self.process_invalid_frames()
# The RFC may have overlooked this case: it says that control frames
# can be interjected in the middle of a fragmented message and that a
# close frame must be echoed. Even though there's an unterminated
# message, technically, the closing handshake was successful.
- self.assertConnectionClosed(1005, '')
+ self.assertConnectionClosed(1005, "")
def test_connection_close_in_fragmented_text(self):
- self.receive_frame(Frame(False, OP_TEXT, 'ca'.encode('utf-8')))
+ self.receive_frame(Frame(False, OP_TEXT, "ca".encode("utf-8")))
self.process_invalid_frames()
- self.assertConnectionFailed(1006, '')
+ self.assertConnectionFailed(1006, "")
# Test miscellaneous code paths to ensure full coverage.
@@ -839,7 +1043,7 @@ def test_connection_lost(self):
# Test calling connection_lost without going through close_connection.
self.protocol.connection_lost(None)
- self.assertConnectionFailed(1006, '')
+ self.assertConnectionFailed(1006, "")
def test_ensure_open_before_opening_handshake(self):
# Simulate a bug by forcibly reverting the protocol state.
@@ -881,7 +1085,7 @@ def test_connection_closed_attributes(self):
connection_closed_exc = context.exception
self.assertEqual(connection_closed_exc.code, 1000)
- self.assertEqual(connection_closed_exc.reason, 'close')
+ self.assertEqual(connection_closed_exc.reason, "close")
# Test the protocol logic for sending keepalive pings.
@@ -906,13 +1110,13 @@ def test_keepalive_ping(self):
# Ping is sent at 3ms and acknowledged at 4ms.
self.loop.run_until_complete(asyncio.sleep(4 * MS))
- ping_1, = tuple(self.protocol.pings)
+ (ping_1,) = tuple(self.protocol.pings)
self.assertOneFrameSent(True, OP_PING, ping_1)
self.receive_frame(Frame(True, OP_PONG, ping_1))
# Next ping is sent at 7ms.
self.loop.run_until_complete(asyncio.sleep(4 * MS))
- ping_2, = tuple(self.protocol.pings)
+ (ping_2,) = tuple(self.protocol.pings)
self.assertOneFrameSent(True, OP_PING, ping_2)
# The keepalive ping task goes on.
@@ -923,12 +1127,12 @@ def test_keepalive_ping_not_acknowledged_closes_connection(self):
# Ping is sent at 3ms and not acknowleged.
self.loop.run_until_complete(asyncio.sleep(4 * MS))
- ping_1, = tuple(self.protocol.pings)
+ (ping_1,) = tuple(self.protocol.pings)
self.assertOneFrameSent(True, OP_PING, ping_1)
# Connection is closed at 6ms.
self.loop.run_until_complete(asyncio.sleep(4 * MS))
- self.assertOneFrameSent(True, OP_CLOSE, serialize_close(1011, ''))
+ self.assertOneFrameSent(True, OP_CLOSE, serialize_close(1011, ""))
# The keepalive ping task is complete.
self.assertEqual(self.protocol.keepalive_ping_task.result(), None)
@@ -953,6 +1157,31 @@ def test_keepalive_ping_stops_when_connection_closed(self):
# The keepalive ping task terminated.
self.assertTrue(self.protocol.keepalive_ping_task.cancelled())
+ def test_keepalive_ping_does_not_crash_when_connection_lost(self):
+ self.restart_protocol_with_keepalive_ping()
+ # Clog incoming queue. This lets connection_lost() abort pending pings
+ # with a ConnectionClosed exception before transfer_data_task
+ # terminates and close_connection cancels keepalive_ping_task.
+ self.protocol.max_queue = 1
+ self.receive_frame(Frame(True, OP_TEXT, b"1"))
+ self.receive_frame(Frame(True, OP_TEXT, b"2"))
+ # Ping is sent at 3ms.
+ self.loop.run_until_complete(asyncio.sleep(4 * MS))
+ (ping_waiter,) = tuple(self.protocol.pings.values())
+ # Connection drops.
+ self.receive_eof()
+ self.loop.run_until_complete(self.protocol.wait_closed())
+
+ # The ping waiter receives a ConnectionClosed exception.
+ with self.assertRaises(ConnectionClosed):
+ ping_waiter.result()
+ # The keepalive ping task terminated properly.
+ self.assertIsNone(self.protocol.keepalive_ping_task.result())
+
+ # Unclog incoming queue to terminate the test quickly.
+ self.loop.run_until_complete(self.protocol.recv())
+ self.loop.run_until_complete(self.protocol.recv())
+
def test_keepalive_ping_with_no_ping_interval(self):
self.restart_protocol_with_keepalive_ping(ping_interval=None)
@@ -965,7 +1194,7 @@ def test_keepalive_ping_with_no_ping_timeout(self):
# Ping is sent at 3ms and not acknowleged.
self.loop.run_until_complete(asyncio.sleep(4 * MS))
- ping_1, = tuple(self.protocol.pings)
+ (ping_1,) = tuple(self.protocol.pings)
self.assertOneFrameSent(True, OP_PING, ping_1)
# Next ping is sent at 7ms anyway.
@@ -980,8 +1209,7 @@ def test_keepalive_ping_with_no_ping_timeout(self):
def test_keepalive_ping_unexpected_error(self):
self.restart_protocol_with_keepalive_ping()
- @asyncio.coroutine
- def ping():
+ async def ping():
raise Exception("BOOM")
self.protocol.ping = ping
@@ -1001,15 +1229,15 @@ def test_local_close(self):
self.loop.call_later(MS, self.receive_eof_if_client)
# Run the closing handshake.
- self.loop.run_until_complete(self.protocol.close(reason='close'))
+ self.loop.run_until_complete(self.protocol.close(reason="close"))
- self.assertConnectionClosed(1000, 'close')
+ self.assertConnectionClosed(1000, "close")
self.assertOneFrameSent(*self.close_frame)
# Closing the connection again is a no-op.
- self.loop.run_until_complete(self.protocol.close(reason='oh noes!'))
+ self.loop.run_until_complete(self.protocol.close(reason="oh noes!"))
- self.assertConnectionClosed(1000, 'close')
+ self.assertConnectionClosed(1000, "close")
self.assertNoFrameSent()
def test_remote_close(self):
@@ -1022,15 +1250,28 @@ def test_remote_close(self):
with self.assertRaises(ConnectionClosed):
self.loop.run_until_complete(self.protocol.recv())
- self.assertConnectionClosed(1000, 'close')
+ self.assertConnectionClosed(1000, "close")
self.assertOneFrameSent(*self.close_frame)
# Closing the connection again is a no-op.
- self.loop.run_until_complete(self.protocol.close(reason='oh noes!'))
+ self.loop.run_until_complete(self.protocol.close(reason="oh noes!"))
- self.assertConnectionClosed(1000, 'close')
+ self.assertConnectionClosed(1000, "close")
self.assertNoFrameSent()
+ def test_remote_close_and_connection_lost(self):
+ self.make_drain_slow()
+ # Drop the connection right after receiving a close frame,
+ # which prevents echoing the close frame properly.
+ self.receive_frame(self.close_frame)
+ self.receive_eof()
+
+ with self.assertNoLogs():
+ self.loop.run_until_complete(self.protocol.close(reason="oh noes!"))
+
+ self.assertConnectionClosed(1000, "close")
+ self.assertOneFrameSent(*self.close_frame)
+
def test_simultaneous_close(self):
# Receive the incoming close frame right after self.protocol.close()
# starts executing. This reproduces the error described in:
@@ -1038,62 +1279,62 @@ def test_simultaneous_close(self):
self.loop.call_soon(self.receive_frame, self.remote_close)
self.loop.call_soon(self.receive_eof_if_client)
- self.loop.run_until_complete(self.protocol.close(reason='local'))
+ self.loop.run_until_complete(self.protocol.close(reason="local"))
- self.assertConnectionClosed(1000, 'remote')
+ self.assertConnectionClosed(1000, "remote")
# The current implementation sends a close frame in response to the
# close frame received from the remote end. It skips the close frame
# that should be sent as a result of calling close().
self.assertOneFrameSent(*self.remote_close)
def test_close_preserves_incoming_frames(self):
- self.receive_frame(Frame(True, OP_TEXT, b'hello'))
+ self.receive_frame(Frame(True, OP_TEXT, b"hello"))
self.loop.call_later(MS, self.receive_frame, self.close_frame)
self.loop.call_later(MS, self.receive_eof_if_client)
- self.loop.run_until_complete(self.protocol.close(reason='close'))
+ self.loop.run_until_complete(self.protocol.close(reason="close"))
- self.assertConnectionClosed(1000, 'close')
+ self.assertConnectionClosed(1000, "close")
self.assertOneFrameSent(*self.close_frame)
next_message = self.loop.run_until_complete(self.protocol.recv())
- self.assertEqual(next_message, 'hello')
+ self.assertEqual(next_message, "hello")
def test_close_protocol_error(self):
- invalid_close_frame = Frame(True, OP_CLOSE, b'\x00')
+ invalid_close_frame = Frame(True, OP_CLOSE, b"\x00")
self.receive_frame(invalid_close_frame)
self.receive_eof_if_client()
self.run_loop_once()
- self.loop.run_until_complete(self.protocol.close(reason='close'))
+ self.loop.run_until_complete(self.protocol.close(reason="close"))
- self.assertConnectionFailed(1002, '')
+ self.assertConnectionFailed(1002, "")
def test_close_connection_lost(self):
self.receive_eof()
self.run_loop_once()
- self.loop.run_until_complete(self.protocol.close(reason='close'))
+ self.loop.run_until_complete(self.protocol.close(reason="close"))
- self.assertConnectionFailed(1006, '')
+ self.assertConnectionFailed(1006, "")
def test_local_close_during_recv(self):
- recv = self.ensure_future(self.protocol.recv())
+ recv = self.loop.create_task(self.protocol.recv())
self.loop.call_later(MS, self.receive_frame, self.close_frame)
self.loop.call_later(MS, self.receive_eof_if_client)
- self.loop.run_until_complete(self.protocol.close(reason='close'))
+ self.loop.run_until_complete(self.protocol.close(reason="close"))
with self.assertRaises(ConnectionClosed):
self.loop.run_until_complete(recv)
- self.assertConnectionClosed(1000, 'close')
+ self.assertConnectionClosed(1000, "close")
# There is no test_remote_close_during_recv because it would be identical
# to test_remote_close.
def test_remote_close_during_send(self):
self.make_drain_slow()
- send = self.ensure_future(self.protocol.send('hello'))
+ send = self.loop.create_task(self.protocol.send("hello"))
self.receive_frame(self.close_frame)
self.receive_eof()
@@ -1101,17 +1342,17 @@ def test_remote_close_during_send(self):
with self.assertRaises(ConnectionClosed):
self.loop.run_until_complete(send)
- self.assertConnectionClosed(1000, 'close')
+ self.assertConnectionClosed(1000, "close")
# There is no test_local_close_during_send because this cannot really
# happen, considering that writes are serialized.
-class ServerTests(CommonTests, unittest.TestCase):
+class ServerTests(CommonTests, AsyncioTestCase):
def setUp(self):
super().setUp()
self.protocol.is_client = False
- self.protocol.side = 'server'
+ self.protocol.side = "server"
def test_local_close_send_close_frame_timeout(self):
self.protocol.close_timeout = 10 * MS
@@ -1119,16 +1360,16 @@ def test_local_close_send_close_frame_timeout(self):
# If we can't send a close frame, time out in 10ms.
# Check the timing within -1/+9ms for robustness.
with self.assertCompletesWithin(9 * MS, 19 * MS):
- self.loop.run_until_complete(self.protocol.close(reason='close'))
- self.assertConnectionClosed(1006, '')
+ self.loop.run_until_complete(self.protocol.close(reason="close"))
+ self.assertConnectionClosed(1006, "")
def test_local_close_receive_close_frame_timeout(self):
self.protocol.close_timeout = 10 * MS
# If the client doesn't send a close frame, time out in 10ms.
# Check the timing within -1/+9ms for robustness.
with self.assertCompletesWithin(9 * MS, 19 * MS):
- self.loop.run_until_complete(self.protocol.close(reason='close'))
- self.assertConnectionClosed(1006, '')
+ self.loop.run_until_complete(self.protocol.close(reason="close"))
+ self.assertConnectionClosed(1006, "")
def test_local_close_connection_lost_timeout_after_write_eof(self):
self.protocol.close_timeout = 10 * MS
@@ -1139,8 +1380,8 @@ def test_local_close_connection_lost_timeout_after_write_eof(self):
# HACK: disable write_eof => other end drops connection emulation.
self.transport._eof = True
self.receive_frame(self.close_frame)
- self.loop.run_until_complete(self.protocol.close(reason='close'))
- self.assertConnectionClosed(1000, 'close')
+ self.loop.run_until_complete(self.protocol.close(reason="close"))
+ self.assertConnectionClosed(1000, "close")
def test_local_close_connection_lost_timeout_after_close(self):
self.protocol.close_timeout = 10 * MS
@@ -1154,15 +1395,15 @@ def test_local_close_connection_lost_timeout_after_close(self):
# HACK: disable close => other end drops connection emulation.
self.transport._closing = True
self.receive_frame(self.close_frame)
- self.loop.run_until_complete(self.protocol.close(reason='close'))
- self.assertConnectionClosed(1000, 'close')
+ self.loop.run_until_complete(self.protocol.close(reason="close"))
+ self.assertConnectionClosed(1000, "close")
-class ClientTests(CommonTests, unittest.TestCase):
+class ClientTests(CommonTests, AsyncioTestCase):
def setUp(self):
super().setUp()
self.protocol.is_client = True
- self.protocol.side = 'client'
+ self.protocol.side = "client"
def test_local_close_send_close_frame_timeout(self):
self.protocol.close_timeout = 10 * MS
@@ -1172,8 +1413,8 @@ def test_local_close_send_close_frame_timeout(self):
# - 10ms waiting for receiving a half-close
# Check the timing within -1/+9ms for robustness.
with self.assertCompletesWithin(19 * MS, 29 * MS):
- self.loop.run_until_complete(self.protocol.close(reason='close'))
- self.assertConnectionClosed(1006, '')
+ self.loop.run_until_complete(self.protocol.close(reason="close"))
+ self.assertConnectionClosed(1006, "")
def test_local_close_receive_close_frame_timeout(self):
self.protocol.close_timeout = 10 * MS
@@ -1182,8 +1423,8 @@ def test_local_close_receive_close_frame_timeout(self):
# - 10ms waiting for receiving a half-close
# Check the timing within -1/+9ms for robustness.
with self.assertCompletesWithin(19 * MS, 29 * MS):
- self.loop.run_until_complete(self.protocol.close(reason='close'))
- self.assertConnectionClosed(1006, '')
+ self.loop.run_until_complete(self.protocol.close(reason="close"))
+ self.assertConnectionClosed(1006, "")
def test_local_close_connection_lost_timeout_after_write_eof(self):
self.protocol.close_timeout = 10 * MS
@@ -1196,8 +1437,8 @@ def test_local_close_connection_lost_timeout_after_write_eof(self):
# HACK: disable write_eof => other end drops connection emulation.
self.transport._eof = True
self.receive_frame(self.close_frame)
- self.loop.run_until_complete(self.protocol.close(reason='close'))
- self.assertConnectionClosed(1000, 'close')
+ self.loop.run_until_complete(self.protocol.close(reason="close"))
+ self.assertConnectionClosed(1000, "close")
def test_local_close_connection_lost_timeout_after_close(self):
self.protocol.close_timeout = 10 * MS
@@ -1214,5 +1455,5 @@ def test_local_close_connection_lost_timeout_after_close(self):
# HACK: disable close => other end drops connection emulation.
self.transport._closing = True
self.receive_frame(self.close_frame)
- self.loop.run_until_complete(self.protocol.close(reason='close'))
- self.assertConnectionClosed(1000, 'close')
+ self.loop.run_until_complete(self.protocol.close(reason="close"))
+ self.assertConnectionClosed(1000, "close")
diff --git a/tests/legacy/utils.py b/tests/legacy/utils.py
new file mode 100644
index 000000000..983a91edf
--- /dev/null
+++ b/tests/legacy/utils.py
@@ -0,0 +1,93 @@
+import asyncio
+import contextlib
+import functools
+import logging
+import os
+import time
+import unittest
+
+
+class AsyncioTestCase(unittest.TestCase):
+ """
+ Base class for tests that sets up an isolated event loop for each test.
+
+ """
+
+ def __init_subclass__(cls, **kwargs):
+ """
+ Convert test coroutines to test functions.
+
+ This supports asychronous tests transparently.
+
+ """
+ super().__init_subclass__(**kwargs)
+ for name in unittest.defaultTestLoader.getTestCaseNames(cls):
+ test = getattr(cls, name)
+ if asyncio.iscoroutinefunction(test):
+ setattr(cls, name, cls.convert_async_to_sync(test))
+
+ @staticmethod
+ def convert_async_to_sync(test):
+ """
+ Convert a test coroutine to a test function.
+
+ """
+
+ @functools.wraps(test)
+ def test_func(self, *args, **kwargs):
+ return self.loop.run_until_complete(test(self, *args, **kwargs))
+
+ return test_func
+
+ def setUp(self):
+ super().setUp()
+ self.loop = asyncio.new_event_loop()
+ asyncio.set_event_loop(self.loop)
+
+ def tearDown(self):
+ self.loop.close()
+ super().tearDown()
+
+ def run_loop_once(self):
+ # Process callbacks scheduled with call_soon by appending a callback
+ # to stop the event loop then running it until it hits that callback.
+ self.loop.call_soon(self.loop.stop)
+ self.loop.run_forever()
+
+ @contextlib.contextmanager
+ def assertNoLogs(self, logger="websockets", level=logging.ERROR):
+ """
+ No message is logged on the given logger with at least the given level.
+
+ """
+ with self.assertLogs(logger, level) as logs:
+ # We want to test that no log message is emitted
+ # but assertLogs expects at least one log message.
+ logging.getLogger(logger).log(level, "dummy")
+ yield
+
+ level_name = logging.getLevelName(level)
+ self.assertEqual(logs.output, [f"{level_name}:{logger}:dummy"])
+
+ def assertDeprecationWarnings(self, recorded_warnings, expected_warnings):
+ """
+ Check recorded deprecation warnings match a list of expected messages.
+
+ """
+ self.assertEqual(len(recorded_warnings), len(expected_warnings))
+ for recorded, expected in zip(recorded_warnings, expected_warnings):
+ actual = recorded.message
+ self.assertEqual(str(actual), expected)
+ self.assertEqual(type(actual), DeprecationWarning)
+
+
+# Unit for timeouts. May be increased on slow machines by setting the
+# WEBSOCKETS_TESTS_TIMEOUT_FACTOR environment variable.
+MS = 0.001 * int(os.environ.get("WEBSOCKETS_TESTS_TIMEOUT_FACTOR", 1))
+
+# asyncio's debug mode has a 10x performance penalty for this test suite.
+if os.environ.get("PYTHONASYNCIODEBUG"): # pragma: no cover
+ MS *= 10
+
+# Ensure that timeouts are larger than the clock's resolution (for Windows).
+MS = max(MS, 2.5 * time.get_clock_info("monotonic").resolution)
diff --git a/tests/py35/_test_client_server.py b/tests/py35/_test_client_server.py
deleted file mode 100644
index 46e9111a5..000000000
--- a/tests/py35/_test_client_server.py
+++ /dev/null
@@ -1,112 +0,0 @@
-# Tests containing Python 3.5+ syntax, extracted from test_client_server.py.
-
-import asyncio
-import pathlib
-import socket
-import sys
-import tempfile
-import unittest
-
-from websockets.client import *
-from websockets.protocol import State
-from websockets.server import *
-
-from ..test_client_server import get_server_uri, handler
-
-
-class AsyncAwaitTests(unittest.TestCase):
- def setUp(self):
- self.loop = asyncio.new_event_loop()
- asyncio.set_event_loop(self.loop)
-
- def tearDown(self):
- self.loop.close()
-
- def test_client(self):
- start_server = serve(handler, 'localhost', 0)
- server = self.loop.run_until_complete(start_server)
-
- async def run_client():
- # Await connect.
- client = await connect(get_server_uri(server))
- self.assertEqual(client.state, State.OPEN)
- await client.close()
- self.assertEqual(client.state, State.CLOSED)
-
- self.loop.run_until_complete(run_client())
-
- server.close()
- self.loop.run_until_complete(server.wait_closed())
-
- def test_server(self):
- async def run_server():
- # Await serve.
- server = await serve(handler, 'localhost', 0)
- self.assertTrue(server.sockets)
- server.close()
- await server.wait_closed()
- self.assertFalse(server.sockets)
-
- self.loop.run_until_complete(run_server())
-
-
-class ContextManagerTests(unittest.TestCase):
- def setUp(self):
- self.loop = asyncio.new_event_loop()
- asyncio.set_event_loop(self.loop)
-
- def tearDown(self):
- self.loop.close()
-
- # Asynchronous context managers are only enabled on Python ≥ 3.5.1.
- @unittest.skipIf(
- sys.version_info[:3] <= (3, 5, 0), 'this test requires Python 3.5.1+'
- )
- def test_client(self):
- start_server = serve(handler, 'localhost', 0)
- server = self.loop.run_until_complete(start_server)
-
- async def run_client():
- # Use connect as an asynchronous context manager.
- async with connect(get_server_uri(server)) as client:
- self.assertEqual(client.state, State.OPEN)
-
- # Check that exiting the context manager closed the connection.
- self.assertEqual(client.state, State.CLOSED)
-
- self.loop.run_until_complete(run_client())
-
- server.close()
- self.loop.run_until_complete(server.wait_closed())
-
- # Asynchronous context managers are only enabled on Python ≥ 3.5.1.
- @unittest.skipIf(
- sys.version_info[:3] <= (3, 5, 0), 'this test requires Python 3.5.1+'
- )
- def test_server(self):
- async def run_server():
- # Use serve as an asynchronous context manager.
- async with serve(handler, 'localhost', 0) as server:
- self.assertTrue(server.sockets)
-
- # Check that exiting the context manager closed the server.
- self.assertFalse(server.sockets)
-
- self.loop.run_until_complete(run_server())
-
- # Asynchronous context managers are only enabled on Python ≥ 3.5.1.
- @unittest.skipIf(
- sys.version_info[:3] <= (3, 5, 0), 'this test requires Python 3.5.1+'
- )
- @unittest.skipUnless(hasattr(socket, 'AF_UNIX'), 'this test requires Unix sockets')
- def test_unix_server(self):
- async def run_server(path):
- async with unix_serve(handler, path) as server:
- self.assertTrue(server.sockets)
-
- # Check that exiting the context manager closed the server.
- self.assertFalse(server.sockets)
-
- with tempfile.TemporaryDirectory() as temp_dir:
- path = bytes(pathlib.Path(temp_dir) / 'websockets')
- self.loop.run_until_complete(run_server(path))
diff --git a/tests/py36/_test_client_server.py b/tests/py36/_test_client_server.py
deleted file mode 100644
index f38fbe6f6..000000000
--- a/tests/py36/_test_client_server.py
+++ /dev/null
@@ -1,105 +0,0 @@
-# Tests containing Python 3.6+ syntax, extracted from test_client_server.py.
-
-import asyncio
-import sys
-import unittest
-
-from websockets.client import *
-from websockets.exceptions import ConnectionClosed
-from websockets.server import *
-
-from ..test_client_server import get_server_uri
-
-
-# Fail at import time, not just at run time, to prevent test
-# discovery.
-if sys.version_info[:2] < (3, 6): # pragma: no cover
- raise ImportError("Python 3.6+ only")
-
-
-MESSAGES = ['3', '2', '1', 'Fire!']
-
-
-class AsyncIteratorTests(unittest.TestCase):
-
- # This is a protocol-level feature, but since it's a high-level API, it is
- # much easier to exercise at the client or server level.
-
- def setUp(self):
- self.loop = asyncio.new_event_loop()
- asyncio.set_event_loop(self.loop)
-
- def tearDown(self):
- self.loop.close()
-
- def test_iterate_on_messages(self):
- async def handler(ws, path):
- for message in MESSAGES:
- await ws.send(message)
-
- start_server = serve(handler, 'localhost', 0)
- server = self.loop.run_until_complete(start_server)
-
- messages = []
-
- async def run_client():
- nonlocal messages
- async with connect(get_server_uri(server)) as ws:
- async for message in ws:
- messages.append(message)
-
- self.loop.run_until_complete(run_client())
-
- self.assertEqual(messages, MESSAGES)
-
- server.close()
- self.loop.run_until_complete(server.wait_closed())
-
- def test_iterate_on_messages_going_away_exit_ok(self):
- async def handler(ws, path):
- for message in MESSAGES:
- await ws.send(message)
- await ws.close(1001)
-
- start_server = serve(handler, 'localhost', 0)
- server = self.loop.run_until_complete(start_server)
-
- messages = []
-
- async def run_client():
- nonlocal messages
- async with connect(get_server_uri(server)) as ws:
- async for message in ws:
- messages.append(message)
-
- self.loop.run_until_complete(run_client())
-
- self.assertEqual(messages, MESSAGES)
-
- server.close()
- self.loop.run_until_complete(server.wait_closed())
-
- def test_iterate_on_messages_internal_error_exit_not_ok(self):
- async def handler(ws, path):
- for message in MESSAGES:
- await ws.send(message)
- await ws.close(1011)
-
- start_server = serve(handler, 'localhost', 0)
- server = self.loop.run_until_complete(start_server)
-
- messages = []
-
- async def run_client():
- nonlocal messages
- async with connect(get_server_uri(server)) as ws:
- async for message in ws:
- messages.append(message)
-
- with self.assertRaises(ConnectionClosed):
- self.loop.run_until_complete(run_client())
-
- self.assertEqual(messages, MESSAGES)
-
- server.close()
- self.loop.run_until_complete(server.wait_closed())
diff --git a/tests/test_auth.py b/tests/test_auth.py
new file mode 100644
index 000000000..d5a8bd9ad
--- /dev/null
+++ b/tests/test_auth.py
@@ -0,0 +1 @@
+from websockets.auth import * # noqa
diff --git a/tests/test_client.py b/tests/test_client.py
new file mode 100644
index 000000000..747594bf3
--- /dev/null
+++ b/tests/test_client.py
@@ -0,0 +1,570 @@
+import unittest
+import unittest.mock
+
+from websockets.client import *
+from websockets.connection import CONNECTING, OPEN
+from websockets.datastructures import Headers
+from websockets.exceptions import InvalidHandshake, InvalidHeader
+from websockets.http import USER_AGENT
+from websockets.http11 import Request, Response
+from websockets.utils import accept_key
+
+from .extensions.utils import (
+ ClientOpExtensionFactory,
+ ClientRsv2ExtensionFactory,
+ OpExtension,
+ Rsv2Extension,
+)
+from .test_utils import ACCEPT, KEY
+from .utils import DATE
+
+
+class ConnectTests(unittest.TestCase):
+ def test_send_connect(self):
+ with unittest.mock.patch("websockets.client.generate_key", return_value=KEY):
+ client = ClientConnection("wss://example.com/test")
+ request = client.connect()
+ self.assertIsInstance(request, Request)
+ client.send_request(request)
+ self.assertEqual(
+ client.data_to_send(),
+ [
+ f"GET /test HTTP/1.1\r\n"
+ f"Host: example.com\r\n"
+ f"Upgrade: websocket\r\n"
+ f"Connection: Upgrade\r\n"
+ f"Sec-WebSocket-Key: {KEY}\r\n"
+ f"Sec-WebSocket-Version: 13\r\n"
+ f"User-Agent: {USER_AGENT}\r\n"
+ f"\r\n".encode()
+ ],
+ )
+
+ def test_connect_request(self):
+ with unittest.mock.patch("websockets.client.generate_key", return_value=KEY):
+ client = ClientConnection("wss://example.com/test")
+ request = client.connect()
+ self.assertEqual(request.path, "/test")
+ self.assertEqual(
+ request.headers,
+ Headers(
+ {
+ "Host": "example.com",
+ "Upgrade": "websocket",
+ "Connection": "Upgrade",
+ "Sec-WebSocket-Key": KEY,
+ "Sec-WebSocket-Version": "13",
+ "User-Agent": USER_AGENT,
+ }
+ ),
+ )
+
+ def test_path(self):
+ client = ClientConnection("wss://example.com/endpoint?test=1")
+ request = client.connect()
+
+ self.assertEqual(request.path, "/endpoint?test=1")
+
+ def test_port(self):
+ for uri, host in [
+ ("ws://example.com/", "example.com"),
+ ("ws://example.com:80/", "example.com"),
+ ("ws://example.com:8080/", "example.com:8080"),
+ ("wss://example.com/", "example.com"),
+ ("wss://example.com:443/", "example.com"),
+ ("wss://example.com:8443/", "example.com:8443"),
+ ]:
+ with self.subTest(uri=uri):
+ client = ClientConnection(uri)
+ request = client.connect()
+
+ self.assertEqual(request.headers["Host"], host)
+
+ def test_user_info(self):
+ client = ClientConnection("wss://hello:iloveyou@example.com/")
+ request = client.connect()
+
+ self.assertEqual(request.headers["Authorization"], "Basic aGVsbG86aWxvdmV5b3U=")
+
+ def test_origin(self):
+ client = ClientConnection("wss://example.com/", origin="https://example.com")
+ request = client.connect()
+
+ self.assertEqual(request.headers["Origin"], "https://example.com")
+
+ def test_extensions(self):
+ client = ClientConnection(
+ "wss://example.com/", extensions=[ClientOpExtensionFactory()]
+ )
+ request = client.connect()
+
+ self.assertEqual(request.headers["Sec-WebSocket-Extensions"], "x-op; op")
+
+ def test_subprotocols(self):
+ client = ClientConnection("wss://example.com/", subprotocols=["chat"])
+ request = client.connect()
+
+ self.assertEqual(request.headers["Sec-WebSocket-Protocol"], "chat")
+
+ def test_extra_headers(self):
+ for extra_headers in [
+ Headers({"X-Spam": "Eggs"}),
+ {"X-Spam": "Eggs"},
+ [("X-Spam", "Eggs")],
+ ]:
+ with self.subTest(extra_headers=extra_headers):
+ client = ClientConnection(
+ "wss://example.com/", extra_headers=extra_headers
+ )
+ request = client.connect()
+
+ self.assertEqual(request.headers["X-Spam"], "Eggs")
+
+ def test_extra_headers_overrides_user_agent(self):
+ client = ClientConnection(
+ "wss://example.com/", extra_headers={"User-Agent": "Other"}
+ )
+ request = client.connect()
+
+ self.assertEqual(request.headers["User-Agent"], "Other")
+
+
+class AcceptRejectTests(unittest.TestCase):
+ def test_receive_accept(self):
+ with unittest.mock.patch("websockets.client.generate_key", return_value=KEY):
+ client = ClientConnection("ws://example.com/test")
+ client.connect()
+ client.receive_data(
+ (
+ f"HTTP/1.1 101 Switching Protocols\r\n"
+ f"Upgrade: websocket\r\n"
+ f"Connection: Upgrade\r\n"
+ f"Sec-WebSocket-Accept: {ACCEPT}\r\n"
+ f"Date: {DATE}\r\n"
+ f"Server: {USER_AGENT}\r\n"
+ f"\r\n"
+ ).encode(),
+ )
+ [response] = client.events_received()
+ self.assertIsInstance(response, Response)
+ self.assertEqual(client.state, OPEN)
+
+ def test_receive_reject(self):
+ with unittest.mock.patch("websockets.client.generate_key", return_value=KEY):
+ client = ClientConnection("ws://example.com/test")
+ client.connect()
+ client.receive_data(
+ (
+ f"HTTP/1.1 404 Not Found\r\n"
+ f"Date: {DATE}\r\n"
+ f"Server: {USER_AGENT}\r\n"
+ f"Content-Length: 13\r\n"
+ f"Content-Type: text/plain; charset=utf-8\r\n"
+ f"Connection: close\r\n"
+ f"\r\n"
+ f"Sorry folks.\n"
+ ).encode(),
+ )
+ [response] = client.events_received()
+ self.assertIsInstance(response, Response)
+ self.assertEqual(client.state, CONNECTING)
+
+ def test_accept_response(self):
+ with unittest.mock.patch("websockets.client.generate_key", return_value=KEY):
+ client = ClientConnection("ws://example.com/test")
+ client.connect()
+ client.receive_data(
+ (
+ f"HTTP/1.1 101 Switching Protocols\r\n"
+ f"Upgrade: websocket\r\n"
+ f"Connection: Upgrade\r\n"
+ f"Sec-WebSocket-Accept: {ACCEPT}\r\n"
+ f"Date: {DATE}\r\n"
+ f"Server: {USER_AGENT}\r\n"
+ f"\r\n"
+ ).encode(),
+ )
+ [response] = client.events_received()
+ self.assertEqual(response.status_code, 101)
+ self.assertEqual(response.reason_phrase, "Switching Protocols")
+ self.assertEqual(
+ response.headers,
+ Headers(
+ {
+ "Upgrade": "websocket",
+ "Connection": "Upgrade",
+ "Sec-WebSocket-Accept": ACCEPT,
+ "Date": DATE,
+ "Server": USER_AGENT,
+ }
+ ),
+ )
+ self.assertIsNone(response.body)
+
+ def test_reject_response(self):
+ with unittest.mock.patch("websockets.client.generate_key", return_value=KEY):
+ client = ClientConnection("ws://example.com/test")
+ client.connect()
+ client.receive_data(
+ (
+ f"HTTP/1.1 404 Not Found\r\n"
+ f"Date: {DATE}\r\n"
+ f"Server: {USER_AGENT}\r\n"
+ f"Content-Length: 13\r\n"
+ f"Content-Type: text/plain; charset=utf-8\r\n"
+ f"Connection: close\r\n"
+ f"\r\n"
+ f"Sorry folks.\n"
+ ).encode(),
+ )
+ [response] = client.events_received()
+ self.assertEqual(response.status_code, 404)
+ self.assertEqual(response.reason_phrase, "Not Found")
+ self.assertEqual(
+ response.headers,
+ Headers(
+ {
+ "Date": DATE,
+ "Server": USER_AGENT,
+ "Content-Length": "13",
+ "Content-Type": "text/plain; charset=utf-8",
+ "Connection": "close",
+ }
+ ),
+ )
+ self.assertEqual(response.body, b"Sorry folks.\n")
+
+ def make_accept_response(self, client):
+ request = client.connect()
+ return Response(
+ status_code=101,
+ reason_phrase="Switching Protocols",
+ headers=Headers(
+ {
+ "Upgrade": "websocket",
+ "Connection": "Upgrade",
+ "Sec-WebSocket-Accept": accept_key(
+ request.headers["Sec-WebSocket-Key"]
+ ),
+ }
+ ),
+ )
+
+ def test_basic(self):
+ client = ClientConnection("wss://example.com/")
+ response = self.make_accept_response(client)
+ client.receive_data(response.serialize())
+ [response] = client.events_received()
+
+ self.assertEqual(client.state, OPEN)
+
+ def test_missing_connection(self):
+ client = ClientConnection("wss://example.com/")
+ response = self.make_accept_response(client)
+ del response.headers["Connection"]
+ client.receive_data(response.serialize())
+ [response] = client.events_received()
+
+ self.assertEqual(client.state, CONNECTING)
+ with self.assertRaises(InvalidHeader) as raised:
+ raise response.exception
+ self.assertEqual(str(raised.exception), "missing Connection header")
+
+ def test_invalid_connection(self):
+ client = ClientConnection("wss://example.com/")
+ response = self.make_accept_response(client)
+ del response.headers["Connection"]
+ response.headers["Connection"] = "close"
+ client.receive_data(response.serialize())
+ [response] = client.events_received()
+
+ self.assertEqual(client.state, CONNECTING)
+ with self.assertRaises(InvalidHeader) as raised:
+ raise response.exception
+ self.assertEqual(str(raised.exception), "invalid Connection header: close")
+
+ def test_missing_upgrade(self):
+ client = ClientConnection("wss://example.com/")
+ response = self.make_accept_response(client)
+ del response.headers["Upgrade"]
+ client.receive_data(response.serialize())
+ [response] = client.events_received()
+
+ self.assertEqual(client.state, CONNECTING)
+ with self.assertRaises(InvalidHeader) as raised:
+ raise response.exception
+ self.assertEqual(str(raised.exception), "missing Upgrade header")
+
+ def test_invalid_upgrade(self):
+ client = ClientConnection("wss://example.com/")
+ response = self.make_accept_response(client)
+ del response.headers["Upgrade"]
+ response.headers["Upgrade"] = "h2c"
+ client.receive_data(response.serialize())
+ [response] = client.events_received()
+
+ self.assertEqual(client.state, CONNECTING)
+ with self.assertRaises(InvalidHeader) as raised:
+ raise response.exception
+ self.assertEqual(str(raised.exception), "invalid Upgrade header: h2c")
+
+ def test_missing_accept(self):
+ client = ClientConnection("wss://example.com/")
+ response = self.make_accept_response(client)
+ del response.headers["Sec-WebSocket-Accept"]
+ client.receive_data(response.serialize())
+ [response] = client.events_received()
+
+ self.assertEqual(client.state, CONNECTING)
+ with self.assertRaises(InvalidHeader) as raised:
+ raise response.exception
+ self.assertEqual(str(raised.exception), "missing Sec-WebSocket-Accept header")
+
+ def test_multiple_accept(self):
+ client = ClientConnection("wss://example.com/")
+ response = self.make_accept_response(client)
+ response.headers["Sec-WebSocket-Accept"] = ACCEPT
+ client.receive_data(response.serialize())
+ [response] = client.events_received()
+
+ self.assertEqual(client.state, CONNECTING)
+ with self.assertRaises(InvalidHeader) as raised:
+ raise response.exception
+ self.assertEqual(
+ str(raised.exception),
+ "invalid Sec-WebSocket-Accept header: "
+ "more than one Sec-WebSocket-Accept header found",
+ )
+
+ def test_invalid_accept(self):
+ client = ClientConnection("wss://example.com/")
+ response = self.make_accept_response(client)
+ del response.headers["Sec-WebSocket-Accept"]
+ response.headers["Sec-WebSocket-Accept"] = ACCEPT
+ client.receive_data(response.serialize())
+ [response] = client.events_received()
+
+ self.assertEqual(client.state, CONNECTING)
+ with self.assertRaises(InvalidHeader) as raised:
+ raise response.exception
+ self.assertEqual(
+ str(raised.exception), f"invalid Sec-WebSocket-Accept header: {ACCEPT}"
+ )
+
+ def test_no_extensions(self):
+ client = ClientConnection("wss://example.com/")
+ response = self.make_accept_response(client)
+ client.receive_data(response.serialize())
+ [response] = client.events_received()
+
+ self.assertEqual(client.state, OPEN)
+ self.assertEqual(client.extensions, [])
+
+ def test_no_extension(self):
+ client = ClientConnection(
+ "wss://example.com/", extensions=[ClientOpExtensionFactory()]
+ )
+ response = self.make_accept_response(client)
+ response.headers["Sec-WebSocket-Extensions"] = "x-op; op"
+ client.receive_data(response.serialize())
+ [response] = client.events_received()
+
+ self.assertEqual(client.state, OPEN)
+ self.assertEqual(client.extensions, [OpExtension()])
+
+ def test_extension(self):
+ client = ClientConnection(
+ "wss://example.com/", extensions=[ClientRsv2ExtensionFactory()]
+ )
+ response = self.make_accept_response(client)
+ response.headers["Sec-WebSocket-Extensions"] = "x-rsv2"
+ client.receive_data(response.serialize())
+ [response] = client.events_received()
+
+ self.assertEqual(client.state, OPEN)
+ self.assertEqual(client.extensions, [Rsv2Extension()])
+
+ def test_unexpected_extension(self):
+ client = ClientConnection("wss://example.com/")
+ response = self.make_accept_response(client)
+ response.headers["Sec-WebSocket-Extensions"] = "x-op; op"
+ client.receive_data(response.serialize())
+ [response] = client.events_received()
+
+ self.assertEqual(client.state, CONNECTING)
+ with self.assertRaises(InvalidHandshake) as raised:
+ raise response.exception
+ self.assertEqual(str(raised.exception), "no extensions supported")
+
+ def test_unsupported_extension(self):
+ client = ClientConnection(
+ "wss://example.com/", extensions=[ClientRsv2ExtensionFactory()]
+ )
+ response = self.make_accept_response(client)
+ response.headers["Sec-WebSocket-Extensions"] = "x-op; op"
+ client.receive_data(response.serialize())
+ [response] = client.events_received()
+
+ self.assertEqual(client.state, CONNECTING)
+ with self.assertRaises(InvalidHandshake) as raised:
+ raise response.exception
+ self.assertEqual(
+ str(raised.exception),
+ "Unsupported extension: name = x-op, params = [('op', None)]",
+ )
+
+ def test_supported_extension_parameters(self):
+ client = ClientConnection(
+ "wss://example.com/", extensions=[ClientOpExtensionFactory("this")]
+ )
+ response = self.make_accept_response(client)
+ response.headers["Sec-WebSocket-Extensions"] = "x-op; op=this"
+ client.receive_data(response.serialize())
+ [response] = client.events_received()
+
+ self.assertEqual(client.state, OPEN)
+ self.assertEqual(client.extensions, [OpExtension("this")])
+
+ def test_unsupported_extension_parameters(self):
+ client = ClientConnection(
+ "wss://example.com/", extensions=[ClientOpExtensionFactory("this")]
+ )
+ response = self.make_accept_response(client)
+ response.headers["Sec-WebSocket-Extensions"] = "x-op; op=that"
+ client.receive_data(response.serialize())
+ [response] = client.events_received()
+
+ self.assertEqual(client.state, CONNECTING)
+ with self.assertRaises(InvalidHandshake) as raised:
+ raise response.exception
+ self.assertEqual(
+ str(raised.exception),
+ "Unsupported extension: name = x-op, params = [('op', 'that')]",
+ )
+
+ def test_multiple_supported_extension_parameters(self):
+ client = ClientConnection(
+ "wss://example.com/",
+ extensions=[
+ ClientOpExtensionFactory("this"),
+ ClientOpExtensionFactory("that"),
+ ],
+ )
+ response = self.make_accept_response(client)
+ response.headers["Sec-WebSocket-Extensions"] = "x-op; op=that"
+ client.receive_data(response.serialize())
+ [response] = client.events_received()
+
+ self.assertEqual(client.state, OPEN)
+ self.assertEqual(client.extensions, [OpExtension("that")])
+
+ def test_multiple_extensions(self):
+ client = ClientConnection(
+ "wss://example.com/",
+ extensions=[ClientOpExtensionFactory(), ClientRsv2ExtensionFactory()],
+ )
+ response = self.make_accept_response(client)
+ response.headers["Sec-WebSocket-Extensions"] = "x-op; op"
+ response.headers["Sec-WebSocket-Extensions"] = "x-rsv2"
+ client.receive_data(response.serialize())
+ [response] = client.events_received()
+
+ self.assertEqual(client.state, OPEN)
+ self.assertEqual(client.extensions, [OpExtension(), Rsv2Extension()])
+
+ def test_multiple_extensions_order(self):
+ client = ClientConnection(
+ "wss://example.com/",
+ extensions=[ClientOpExtensionFactory(), ClientRsv2ExtensionFactory()],
+ )
+ response = self.make_accept_response(client)
+ response.headers["Sec-WebSocket-Extensions"] = "x-rsv2"
+ response.headers["Sec-WebSocket-Extensions"] = "x-op; op"
+ client.receive_data(response.serialize())
+ [response] = client.events_received()
+
+ self.assertEqual(client.state, OPEN)
+ self.assertEqual(client.extensions, [Rsv2Extension(), OpExtension()])
+
+ def test_no_subprotocols(self):
+ client = ClientConnection("wss://example.com/")
+ response = self.make_accept_response(client)
+ client.receive_data(response.serialize())
+ [response] = client.events_received()
+
+ self.assertEqual(client.state, OPEN)
+ self.assertIsNone(client.subprotocol)
+
+ def test_no_subprotocol(self):
+ client = ClientConnection("wss://example.com/", subprotocols=["chat"])
+ response = self.make_accept_response(client)
+ client.receive_data(response.serialize())
+ [response] = client.events_received()
+
+ self.assertEqual(client.state, OPEN)
+ self.assertIsNone(client.subprotocol)
+
+ def test_subprotocol(self):
+ client = ClientConnection("wss://example.com/", subprotocols=["chat"])
+ response = self.make_accept_response(client)
+ response.headers["Sec-WebSocket-Protocol"] = "chat"
+ client.receive_data(response.serialize())
+ [response] = client.events_received()
+
+ self.assertEqual(client.state, OPEN)
+ self.assertEqual(client.subprotocol, "chat")
+
+ def test_unexpected_subprotocol(self):
+ client = ClientConnection("wss://example.com/")
+ response = self.make_accept_response(client)
+ response.headers["Sec-WebSocket-Protocol"] = "chat"
+ client.receive_data(response.serialize())
+ [response] = client.events_received()
+
+ self.assertEqual(client.state, CONNECTING)
+ with self.assertRaises(InvalidHandshake) as raised:
+ raise response.exception
+ self.assertEqual(str(raised.exception), "no subprotocols supported")
+
+ def test_multiple_subprotocols(self):
+ client = ClientConnection(
+ "wss://example.com/", subprotocols=["superchat", "chat"]
+ )
+ response = self.make_accept_response(client)
+ response.headers["Sec-WebSocket-Protocol"] = "superchat"
+ response.headers["Sec-WebSocket-Protocol"] = "chat"
+ client.receive_data(response.serialize())
+ [response] = client.events_received()
+
+ self.assertEqual(client.state, CONNECTING)
+ with self.assertRaises(InvalidHandshake) as raised:
+ raise response.exception
+ self.assertEqual(
+ str(raised.exception), "multiple subprotocols: superchat, chat"
+ )
+
+ def test_supported_subprotocol(self):
+ client = ClientConnection(
+ "wss://example.com/", subprotocols=["superchat", "chat"]
+ )
+ response = self.make_accept_response(client)
+ response.headers["Sec-WebSocket-Protocol"] = "chat"
+ client.receive_data(response.serialize())
+ [response] = client.events_received()
+
+ self.assertEqual(client.state, OPEN)
+ self.assertEqual(client.subprotocol, "chat")
+
+ def test_unsupported_subprotocol(self):
+ client = ClientConnection(
+ "wss://example.com/", subprotocols=["superchat", "chat"]
+ )
+ response = self.make_accept_response(client)
+ response.headers["Sec-WebSocket-Protocol"] = "otherchat"
+ client.receive_data(response.serialize())
+ [response] = client.events_received()
+
+ self.assertEqual(client.state, CONNECTING)
+ with self.assertRaises(InvalidHandshake) as raised:
+ raise response.exception
+ self.assertEqual(str(raised.exception), "unsupported subprotocol: otherchat")
diff --git a/tests/test_connection.py b/tests/test_connection.py
new file mode 100644
index 000000000..3e39a3f9e
--- /dev/null
+++ b/tests/test_connection.py
@@ -0,0 +1,1486 @@
+import unittest.mock
+
+from websockets.connection import *
+from websockets.exceptions import InvalidState, PayloadTooBig, ProtocolError
+from websockets.frames import (
+ OP_BINARY,
+ OP_CLOSE,
+ OP_CONT,
+ OP_PING,
+ OP_PONG,
+ OP_TEXT,
+ Frame,
+ serialize_close,
+)
+
+from .extensions.utils import Rsv2Extension
+from .test_frames import FramesTestCase
+
+
+class ConnectionTestCase(FramesTestCase):
+ def assertFrameSent(self, connection, frame, eof=False):
+ """
+ Outgoing data for ``connection`` contains the given frame.
+
+ ``frame`` may be ``None`` if no frame is expected.
+
+ When ``eof`` is ``True``, the end of the stream is also expected.
+
+ """
+ frames_sent = [
+ None
+ if write is SEND_EOF
+ else self.parse(
+ write,
+ mask=connection.side is Side.CLIENT,
+ extensions=connection.extensions,
+ )
+ for write in connection.data_to_send()
+ ]
+ frames_expected = [] if frame is None else [frame]
+ if eof:
+ frames_expected += [None]
+ self.assertEqual(frames_sent, frames_expected)
+
+ def assertFrameReceived(self, connection, frame):
+ """
+ Incoming data for ``connection`` contains the given frame.
+
+ ``frame`` may be ``None`` if no frame is expected.
+
+ """
+ frames_received = connection.events_received()
+ frames_expected = [] if frame is None else [frame]
+ self.assertEqual(frames_received, frames_expected)
+
+ def assertConnectionClosing(self, connection, code=None, reason=""):
+ """
+ Incoming data caused the "Start the WebSocket Closing Handshake" process.
+
+ """
+ close_frame = Frame(
+ True,
+ OP_CLOSE,
+ b"" if code is None else serialize_close(code, reason),
+ )
+ # A close frame was received.
+ self.assertFrameReceived(connection, close_frame)
+ # A close frame and possibly the end of stream were sent.
+ self.assertFrameSent(
+ connection, close_frame, eof=connection.side is Side.SERVER
+ )
+
+ def assertConnectionFailing(self, connection, code=None, reason=""):
+ """
+ Incoming data caused the "Fail the WebSocket Connection" process.
+
+ """
+ close_frame = Frame(
+ True,
+ OP_CLOSE,
+ b"" if code is None else serialize_close(code, reason),
+ )
+ # No frame was received.
+ self.assertFrameReceived(connection, None)
+ # A close frame and the end of stream were sent.
+ self.assertFrameSent(connection, close_frame, eof=True)
+
+
+class MaskingTests(ConnectionTestCase):
+ """
+ Test frame masking.
+
+ 5.1. Overview
+
+ """
+
+ unmasked_text_frame_date = b"\x81\x04Spam"
+ masked_text_frame_data = b"\x81\x84\x00\xff\x00\xff\x53\x8f\x61\x92"
+
+ def test_client_sends_masked_frame(self):
+ client = Connection(Side.CLIENT)
+ with self.enforce_mask(b"\x00\xff\x00\xff"):
+ client.send_text(b"Spam", True)
+ self.assertEqual(client.data_to_send(), [self.masked_text_frame_data])
+
+ def test_server_sends_unmasked_frame(self):
+ server = Connection(Side.SERVER)
+ server.send_text(b"Spam", True)
+ self.assertEqual(server.data_to_send(), [self.unmasked_text_frame_date])
+
+ def test_client_receives_unmasked_frame(self):
+ client = Connection(Side.CLIENT)
+ client.receive_data(self.unmasked_text_frame_date)
+ self.assertFrameReceived(
+ client,
+ Frame(True, OP_TEXT, b"Spam"),
+ )
+
+ def test_server_receives_masked_frame(self):
+ server = Connection(Side.SERVER)
+ server.receive_data(self.masked_text_frame_data)
+ self.assertFrameReceived(
+ server,
+ Frame(True, OP_TEXT, b"Spam"),
+ )
+
+ def test_client_receives_masked_frame(self):
+ client = Connection(Side.CLIENT)
+ with self.assertRaises(ProtocolError) as raised:
+ client.receive_data(self.masked_text_frame_data)
+ self.assertEqual(str(raised.exception), "incorrect masking")
+ self.assertConnectionFailing(client, 1002, "incorrect masking")
+
+ def test_server_receives_unmasked_frame(self):
+ server = Connection(Side.SERVER)
+ with self.assertRaises(ProtocolError) as raised:
+ server.receive_data(self.unmasked_text_frame_date)
+ self.assertEqual(str(raised.exception), "incorrect masking")
+ self.assertConnectionFailing(server, 1002, "incorrect masking")
+
+
+class ContinuationTests(ConnectionTestCase):
+ """
+ Test continuation frames without text or binary frames.
+
+ """
+
+ def test_client_sends_unexpected_continuation(self):
+ client = Connection(Side.CLIENT)
+ with self.assertRaises(ProtocolError) as raised:
+ client.send_continuation(b"", fin=False)
+ self.assertEqual(str(raised.exception), "unexpected continuation frame")
+
+ def test_server_sends_unexpected_continuation(self):
+ server = Connection(Side.SERVER)
+ with self.assertRaises(ProtocolError) as raised:
+ server.send_continuation(b"", fin=False)
+ self.assertEqual(str(raised.exception), "unexpected continuation frame")
+
+ def test_client_receives_unexpected_continuation(self):
+ client = Connection(Side.CLIENT)
+ with self.assertRaises(ProtocolError) as raised:
+ client.receive_data(b"\x00\x00")
+ self.assertEqual(str(raised.exception), "unexpected continuation frame")
+ self.assertConnectionFailing(client, 1002, "unexpected continuation frame")
+
+ def test_server_receives_unexpected_continuation(self):
+ server = Connection(Side.SERVER)
+ with self.assertRaises(ProtocolError) as raised:
+ server.receive_data(b"\x00\x80\x00\x00\x00\x00")
+ self.assertEqual(str(raised.exception), "unexpected continuation frame")
+ self.assertConnectionFailing(server, 1002, "unexpected continuation frame")
+
+ def test_client_sends_continuation_after_sending_close(self):
+ client = Connection(Side.CLIENT)
+ # Since it isn't possible to send a close frame in a fragmented
+ # message (see test_client_send_close_in_fragmented_message), in fact,
+ # this is the same test as test_client_sends_unexpected_continuation.
+ with self.enforce_mask(b"\x00\x00\x00\x00"):
+ client.send_close(1001)
+ self.assertEqual(client.data_to_send(), [b"\x88\x82\x00\x00\x00\x00\x03\xe9"])
+ with self.assertRaises(ProtocolError) as raised:
+ client.send_continuation(b"", fin=False)
+ self.assertEqual(str(raised.exception), "unexpected continuation frame")
+
+ def test_server_sends_continuation_after_sending_close(self):
+ # Since it isn't possible to send a close frame in a fragmented
+ # message (see test_server_send_close_in_fragmented_message), in fact,
+ # this is the same test as test_server_sends_unexpected_continuation.
+ server = Connection(Side.SERVER)
+ server.send_close(1000)
+ self.assertEqual(server.data_to_send(), [b"\x88\x02\x03\xe8", b""])
+ with self.assertRaises(ProtocolError) as raised:
+ server.send_continuation(b"", fin=False)
+ self.assertEqual(str(raised.exception), "unexpected continuation frame")
+
+ def test_client_receives_continuation_after_receiving_close(self):
+ client = Connection(Side.CLIENT)
+ client.receive_data(b"\x88\x02\x03\xe8")
+ self.assertConnectionClosing(client, 1000)
+ with self.assertRaises(ProtocolError) as raised:
+ client.receive_data(b"\x00\x00")
+ self.assertEqual(str(raised.exception), "data frame after close frame")
+
+ def test_server_receives_continuation_after_receiving_close(self):
+ server = Connection(Side.SERVER)
+ server.receive_data(b"\x88\x82\x00\x00\x00\x00\x03\xe9")
+ self.assertConnectionClosing(server, 1001)
+ with self.assertRaises(ProtocolError) as raised:
+ server.receive_data(b"\x00\x80\x00\xff\x00\xff")
+ self.assertEqual(str(raised.exception), "data frame after close frame")
+
+
+class TextTests(ConnectionTestCase):
+ """
+ Test text frames and continuation frames.
+
+ """
+
+ def test_client_sends_text(self):
+ client = Connection(Side.CLIENT)
+ with self.enforce_mask(b"\x00\x00\x00\x00"):
+ client.send_text("😀".encode())
+ self.assertEqual(
+ client.data_to_send(), [b"\x81\x84\x00\x00\x00\x00\xf0\x9f\x98\x80"]
+ )
+
+ def test_server_sends_text(self):
+ server = Connection(Side.SERVER)
+ server.send_text("😀".encode())
+ self.assertEqual(server.data_to_send(), [b"\x81\x04\xf0\x9f\x98\x80"])
+
+ def test_client_receives_text(self):
+ client = Connection(Side.CLIENT)
+ client.receive_data(b"\x81\x04\xf0\x9f\x98\x80")
+ self.assertFrameReceived(
+ client,
+ Frame(True, OP_TEXT, "😀".encode()),
+ )
+
+ def test_server_receives_text(self):
+ server = Connection(Side.SERVER)
+ server.receive_data(b"\x81\x84\x00\x00\x00\x00\xf0\x9f\x98\x80")
+ self.assertFrameReceived(
+ server,
+ Frame(True, OP_TEXT, "😀".encode()),
+ )
+
+ def test_client_receives_text_over_size_limit(self):
+ client = Connection(Side.CLIENT, max_size=3)
+ with self.assertRaises(PayloadTooBig) as raised:
+ client.receive_data(b"\x81\x04\xf0\x9f\x98\x80")
+ self.assertEqual(str(raised.exception), "over size limit (4 > 3 bytes)")
+ self.assertConnectionFailing(client, 1009, "over size limit (4 > 3 bytes)")
+
+ def test_server_receives_text_over_size_limit(self):
+ server = Connection(Side.SERVER, max_size=3)
+ with self.assertRaises(PayloadTooBig) as raised:
+ server.receive_data(b"\x81\x84\x00\x00\x00\x00\xf0\x9f\x98\x80")
+ self.assertEqual(str(raised.exception), "over size limit (4 > 3 bytes)")
+ self.assertConnectionFailing(server, 1009, "over size limit (4 > 3 bytes)")
+
+ def test_client_receives_text_without_size_limit(self):
+ client = Connection(Side.CLIENT, max_size=None)
+ client.receive_data(b"\x81\x04\xf0\x9f\x98\x80")
+ self.assertFrameReceived(
+ client,
+ Frame(True, OP_TEXT, "😀".encode()),
+ )
+
+ def test_server_receives_text_without_size_limit(self):
+ server = Connection(Side.SERVER, max_size=None)
+ server.receive_data(b"\x81\x84\x00\x00\x00\x00\xf0\x9f\x98\x80")
+ self.assertFrameReceived(
+ server,
+ Frame(True, OP_TEXT, "😀".encode()),
+ )
+
+ def test_client_sends_fragmented_text(self):
+ client = Connection(Side.CLIENT)
+ with self.enforce_mask(b"\x00\x00\x00\x00"):
+ client.send_text("😀".encode()[:2], fin=False)
+ self.assertEqual(client.data_to_send(), [b"\x01\x82\x00\x00\x00\x00\xf0\x9f"])
+ with self.enforce_mask(b"\x00\x00\x00\x00"):
+ client.send_continuation("😀😀".encode()[2:6], fin=False)
+ self.assertEqual(
+ client.data_to_send(), [b"\x00\x84\x00\x00\x00\x00\x98\x80\xf0\x9f"]
+ )
+ with self.enforce_mask(b"\x00\x00\x00\x00"):
+ client.send_continuation("😀".encode()[2:], fin=True)
+ self.assertEqual(client.data_to_send(), [b"\x80\x82\x00\x00\x00\x00\x98\x80"])
+
+ def test_server_sends_fragmented_text(self):
+ server = Connection(Side.SERVER)
+ server.send_text("😀".encode()[:2], fin=False)
+ self.assertEqual(server.data_to_send(), [b"\x01\x02\xf0\x9f"])
+ server.send_continuation("😀😀".encode()[2:6], fin=False)
+ self.assertEqual(server.data_to_send(), [b"\x00\x04\x98\x80\xf0\x9f"])
+ server.send_continuation("😀".encode()[2:], fin=True)
+ self.assertEqual(server.data_to_send(), [b"\x80\x02\x98\x80"])
+
+ def test_client_receives_fragmented_text(self):
+ client = Connection(Side.CLIENT)
+ client.receive_data(b"\x01\x02\xf0\x9f")
+ self.assertFrameReceived(
+ client,
+ Frame(False, OP_TEXT, "😀".encode()[:2]),
+ )
+ client.receive_data(b"\x00\x04\x98\x80\xf0\x9f")
+ self.assertFrameReceived(
+ client,
+ Frame(False, OP_CONT, "😀😀".encode()[2:6]),
+ )
+ client.receive_data(b"\x80\x02\x98\x80")
+ self.assertFrameReceived(
+ client,
+ Frame(True, OP_CONT, "😀".encode()[2:]),
+ )
+
+ def test_server_receives_fragmented_text(self):
+ server = Connection(Side.SERVER)
+ server.receive_data(b"\x01\x82\x00\x00\x00\x00\xf0\x9f")
+ self.assertFrameReceived(
+ server,
+ Frame(False, OP_TEXT, "😀".encode()[:2]),
+ )
+ server.receive_data(b"\x00\x84\x00\x00\x00\x00\x98\x80\xf0\x9f")
+ self.assertFrameReceived(
+ server,
+ Frame(False, OP_CONT, "😀😀".encode()[2:6]),
+ )
+ server.receive_data(b"\x80\x82\x00\x00\x00\x00\x98\x80")
+ self.assertFrameReceived(
+ server,
+ Frame(True, OP_CONT, "😀".encode()[2:]),
+ )
+
+ def test_client_receives_fragmented_text_over_size_limit(self):
+ client = Connection(Side.CLIENT, max_size=3)
+ client.receive_data(b"\x01\x02\xf0\x9f")
+ self.assertFrameReceived(
+ client,
+ Frame(False, OP_TEXT, "😀".encode()[:2]),
+ )
+ with self.assertRaises(PayloadTooBig) as raised:
+ client.receive_data(b"\x80\x02\x98\x80")
+ self.assertEqual(str(raised.exception), "over size limit (2 > 1 bytes)")
+ self.assertConnectionFailing(client, 1009, "over size limit (2 > 1 bytes)")
+
+ def test_server_receives_fragmented_text_over_size_limit(self):
+ server = Connection(Side.SERVER, max_size=3)
+ server.receive_data(b"\x01\x82\x00\x00\x00\x00\xf0\x9f")
+ self.assertFrameReceived(
+ server,
+ Frame(False, OP_TEXT, "😀".encode()[:2]),
+ )
+ with self.assertRaises(PayloadTooBig) as raised:
+ server.receive_data(b"\x80\x82\x00\x00\x00\x00\x98\x80")
+ self.assertEqual(str(raised.exception), "over size limit (2 > 1 bytes)")
+ self.assertConnectionFailing(server, 1009, "over size limit (2 > 1 bytes)")
+
+ def test_client_receives_fragmented_text_without_size_limit(self):
+ client = Connection(Side.CLIENT, max_size=None)
+ client.receive_data(b"\x01\x02\xf0\x9f")
+ self.assertFrameReceived(
+ client,
+ Frame(False, OP_TEXT, "😀".encode()[:2]),
+ )
+ client.receive_data(b"\x00\x04\x98\x80\xf0\x9f")
+ self.assertFrameReceived(
+ client,
+ Frame(False, OP_CONT, "😀😀".encode()[2:6]),
+ )
+ client.receive_data(b"\x80\x02\x98\x80")
+ self.assertFrameReceived(
+ client,
+ Frame(True, OP_CONT, "😀".encode()[2:]),
+ )
+
+ def test_server_receives_fragmented_text_without_size_limit(self):
+ server = Connection(Side.SERVER, max_size=None)
+ server.receive_data(b"\x01\x82\x00\x00\x00\x00\xf0\x9f")
+ self.assertFrameReceived(
+ server,
+ Frame(False, OP_TEXT, "😀".encode()[:2]),
+ )
+ server.receive_data(b"\x00\x84\x00\x00\x00\x00\x98\x80\xf0\x9f")
+ self.assertFrameReceived(
+ server,
+ Frame(False, OP_CONT, "😀😀".encode()[2:6]),
+ )
+ server.receive_data(b"\x80\x82\x00\x00\x00\x00\x98\x80")
+ self.assertFrameReceived(
+ server,
+ Frame(True, OP_CONT, "😀".encode()[2:]),
+ )
+
+ def test_client_sends_unexpected_text(self):
+ client = Connection(Side.CLIENT)
+ client.send_text(b"", fin=False)
+ with self.assertRaises(ProtocolError) as raised:
+ client.send_text(b"", fin=False)
+ self.assertEqual(str(raised.exception), "expected a continuation frame")
+
+ def test_server_sends_unexpected_text(self):
+ server = Connection(Side.SERVER)
+ server.send_text(b"", fin=False)
+ with self.assertRaises(ProtocolError) as raised:
+ server.send_text(b"", fin=False)
+ self.assertEqual(str(raised.exception), "expected a continuation frame")
+
+ def test_client_receives_unexpected_text(self):
+ client = Connection(Side.CLIENT)
+ client.receive_data(b"\x01\x00")
+ self.assertFrameReceived(
+ client,
+ Frame(False, OP_TEXT, b""),
+ )
+ with self.assertRaises(ProtocolError) as raised:
+ client.receive_data(b"\x01\x00")
+ self.assertEqual(str(raised.exception), "expected a continuation frame")
+ self.assertConnectionFailing(client, 1002, "expected a continuation frame")
+
+ def test_server_receives_unexpected_text(self):
+ server = Connection(Side.SERVER)
+ server.receive_data(b"\x01\x80\x00\x00\x00\x00")
+ self.assertFrameReceived(
+ server,
+ Frame(False, OP_TEXT, b""),
+ )
+ with self.assertRaises(ProtocolError) as raised:
+ server.receive_data(b"\x01\x80\x00\x00\x00\x00")
+ self.assertEqual(str(raised.exception), "expected a continuation frame")
+ self.assertConnectionFailing(server, 1002, "expected a continuation frame")
+
+ def test_client_sends_text_after_sending_close(self):
+ client = Connection(Side.CLIENT)
+ with self.enforce_mask(b"\x00\x00\x00\x00"):
+ client.send_close(1001)
+ self.assertEqual(client.data_to_send(), [b"\x88\x82\x00\x00\x00\x00\x03\xe9"])
+ with self.assertRaises(InvalidState):
+ client.send_text(b"")
+
+ def test_server_sends_text_after_sending_close(self):
+ server = Connection(Side.SERVER)
+ server.send_close(1000)
+ self.assertEqual(server.data_to_send(), [b"\x88\x02\x03\xe8", b""])
+ with self.assertRaises(InvalidState):
+ server.send_text(b"")
+
+ def test_client_receives_text_after_receiving_close(self):
+ client = Connection(Side.CLIENT)
+ client.receive_data(b"\x88\x02\x03\xe8")
+ self.assertConnectionClosing(client, 1000)
+ with self.assertRaises(ProtocolError) as raised:
+ client.receive_data(b"\x81\x00")
+ self.assertEqual(str(raised.exception), "data frame after close frame")
+
+ def test_server_receives_text_after_receiving_close(self):
+ server = Connection(Side.SERVER)
+ server.receive_data(b"\x88\x82\x00\x00\x00\x00\x03\xe9")
+ self.assertConnectionClosing(server, 1001)
+ with self.assertRaises(ProtocolError) as raised:
+ server.receive_data(b"\x81\x80\x00\xff\x00\xff")
+ self.assertEqual(str(raised.exception), "data frame after close frame")
+
+
+class BinaryTests(ConnectionTestCase):
+ """
+ Test binary frames and continuation frames.
+
+ """
+
+ def test_client_sends_binary(self):
+ client = Connection(Side.CLIENT)
+ with self.enforce_mask(b"\x00\x00\x00\x00"):
+ client.send_binary(b"\x01\x02\xfe\xff")
+ self.assertEqual(
+ client.data_to_send(), [b"\x82\x84\x00\x00\x00\x00\x01\x02\xfe\xff"]
+ )
+
+ def test_server_sends_binary(self):
+ server = Connection(Side.SERVER)
+ server.send_binary(b"\x01\x02\xfe\xff")
+ self.assertEqual(server.data_to_send(), [b"\x82\x04\x01\x02\xfe\xff"])
+
+ def test_client_receives_binary(self):
+ client = Connection(Side.CLIENT)
+ client.receive_data(b"\x82\x04\x01\x02\xfe\xff")
+ self.assertFrameReceived(
+ client,
+ Frame(True, OP_BINARY, b"\x01\x02\xfe\xff"),
+ )
+
+ def test_server_receives_binary(self):
+ server = Connection(Side.SERVER)
+ server.receive_data(b"\x82\x84\x00\x00\x00\x00\x01\x02\xfe\xff")
+ self.assertFrameReceived(
+ server,
+ Frame(True, OP_BINARY, b"\x01\x02\xfe\xff"),
+ )
+
+ def test_client_receives_binary_over_size_limit(self):
+ client = Connection(Side.CLIENT, max_size=3)
+ with self.assertRaises(PayloadTooBig) as raised:
+ client.receive_data(b"\x82\x04\x01\x02\xfe\xff")
+ self.assertEqual(str(raised.exception), "over size limit (4 > 3 bytes)")
+ self.assertConnectionFailing(client, 1009, "over size limit (4 > 3 bytes)")
+
+ def test_server_receives_binary_over_size_limit(self):
+ server = Connection(Side.SERVER, max_size=3)
+ with self.assertRaises(PayloadTooBig) as raised:
+ server.receive_data(b"\x82\x84\x00\x00\x00\x00\x01\x02\xfe\xff")
+ self.assertEqual(str(raised.exception), "over size limit (4 > 3 bytes)")
+ self.assertConnectionFailing(server, 1009, "over size limit (4 > 3 bytes)")
+
+ def test_client_sends_fragmented_binary(self):
+ client = Connection(Side.CLIENT)
+ with self.enforce_mask(b"\x00\x00\x00\x00"):
+ client.send_binary(b"\x01\x02", fin=False)
+ self.assertEqual(client.data_to_send(), [b"\x02\x82\x00\x00\x00\x00\x01\x02"])
+ with self.enforce_mask(b"\x00\x00\x00\x00"):
+ client.send_continuation(b"\xee\xff\x01\x02", fin=False)
+ self.assertEqual(
+ client.data_to_send(), [b"\x00\x84\x00\x00\x00\x00\xee\xff\x01\x02"]
+ )
+ with self.enforce_mask(b"\x00\x00\x00\x00"):
+ client.send_continuation(b"\xee\xff", fin=True)
+ self.assertEqual(client.data_to_send(), [b"\x80\x82\x00\x00\x00\x00\xee\xff"])
+
+ def test_server_sends_fragmented_binary(self):
+ server = Connection(Side.SERVER)
+ server.send_binary(b"\x01\x02", fin=False)
+ self.assertEqual(server.data_to_send(), [b"\x02\x02\x01\x02"])
+ server.send_continuation(b"\xee\xff\x01\x02", fin=False)
+ self.assertEqual(server.data_to_send(), [b"\x00\x04\xee\xff\x01\x02"])
+ server.send_continuation(b"\xee\xff", fin=True)
+ self.assertEqual(server.data_to_send(), [b"\x80\x02\xee\xff"])
+
+ def test_client_receives_fragmented_binary(self):
+ client = Connection(Side.CLIENT)
+ client.receive_data(b"\x02\x02\x01\x02")
+ self.assertFrameReceived(
+ client,
+ Frame(False, OP_BINARY, b"\x01\x02"),
+ )
+ client.receive_data(b"\x00\x04\xfe\xff\x01\x02")
+ self.assertFrameReceived(
+ client,
+ Frame(False, OP_CONT, b"\xfe\xff\x01\x02"),
+ )
+ client.receive_data(b"\x80\x02\xfe\xff")
+ self.assertFrameReceived(
+ client,
+ Frame(True, OP_CONT, b"\xfe\xff"),
+ )
+
+ def test_server_receives_fragmented_binary(self):
+ server = Connection(Side.SERVER)
+ server.receive_data(b"\x02\x82\x00\x00\x00\x00\x01\x02")
+ self.assertFrameReceived(
+ server,
+ Frame(False, OP_BINARY, b"\x01\x02"),
+ )
+ server.receive_data(b"\x00\x84\x00\x00\x00\x00\xee\xff\x01\x02")
+ self.assertFrameReceived(
+ server,
+ Frame(False, OP_CONT, b"\xee\xff\x01\x02"),
+ )
+ server.receive_data(b"\x80\x82\x00\x00\x00\x00\xfe\xff")
+ self.assertFrameReceived(
+ server,
+ Frame(True, OP_CONT, b"\xfe\xff"),
+ )
+
+ def test_client_receives_fragmented_binary_over_size_limit(self):
+ client = Connection(Side.CLIENT, max_size=3)
+ client.receive_data(b"\x02\x02\x01\x02")
+ self.assertFrameReceived(
+ client,
+ Frame(False, OP_BINARY, b"\x01\x02"),
+ )
+ with self.assertRaises(PayloadTooBig) as raised:
+ client.receive_data(b"\x80\x02\xfe\xff")
+ self.assertEqual(str(raised.exception), "over size limit (2 > 1 bytes)")
+ self.assertConnectionFailing(client, 1009, "over size limit (2 > 1 bytes)")
+
+ def test_server_receives_fragmented_binary_over_size_limit(self):
+ server = Connection(Side.SERVER, max_size=3)
+ server.receive_data(b"\x02\x82\x00\x00\x00\x00\x01\x02")
+ self.assertFrameReceived(
+ server,
+ Frame(False, OP_BINARY, b"\x01\x02"),
+ )
+ with self.assertRaises(PayloadTooBig) as raised:
+ server.receive_data(b"\x80\x82\x00\x00\x00\x00\xfe\xff")
+ self.assertEqual(str(raised.exception), "over size limit (2 > 1 bytes)")
+ self.assertConnectionFailing(server, 1009, "over size limit (2 > 1 bytes)")
+
+ def test_client_sends_unexpected_binary(self):
+ client = Connection(Side.CLIENT)
+ client.send_binary(b"", fin=False)
+ with self.assertRaises(ProtocolError) as raised:
+ client.send_binary(b"", fin=False)
+ self.assertEqual(str(raised.exception), "expected a continuation frame")
+
+ def test_server_sends_unexpected_binary(self):
+ server = Connection(Side.SERVER)
+ server.send_binary(b"", fin=False)
+ with self.assertRaises(ProtocolError) as raised:
+ server.send_binary(b"", fin=False)
+ self.assertEqual(str(raised.exception), "expected a continuation frame")
+
+ def test_client_receives_unexpected_binary(self):
+ client = Connection(Side.CLIENT)
+ client.receive_data(b"\x02\x00")
+ self.assertFrameReceived(
+ client,
+ Frame(False, OP_BINARY, b""),
+ )
+ with self.assertRaises(ProtocolError) as raised:
+ client.receive_data(b"\x02\x00")
+ self.assertEqual(str(raised.exception), "expected a continuation frame")
+ self.assertConnectionFailing(client, 1002, "expected a continuation frame")
+
+ def test_server_receives_unexpected_binary(self):
+ server = Connection(Side.SERVER)
+ server.receive_data(b"\x02\x80\x00\x00\x00\x00")
+ self.assertFrameReceived(
+ server,
+ Frame(False, OP_BINARY, b""),
+ )
+ with self.assertRaises(ProtocolError) as raised:
+ server.receive_data(b"\x02\x80\x00\x00\x00\x00")
+ self.assertEqual(str(raised.exception), "expected a continuation frame")
+ self.assertConnectionFailing(server, 1002, "expected a continuation frame")
+
+ def test_client_sends_binary_after_sending_close(self):
+ client = Connection(Side.CLIENT)
+ with self.enforce_mask(b"\x00\x00\x00\x00"):
+ client.send_close(1001)
+ self.assertEqual(client.data_to_send(), [b"\x88\x82\x00\x00\x00\x00\x03\xe9"])
+ with self.assertRaises(InvalidState):
+ client.send_binary(b"")
+
+ def test_server_sends_binary_after_sending_close(self):
+ server = Connection(Side.SERVER)
+ server.send_close(1000)
+ self.assertEqual(server.data_to_send(), [b"\x88\x02\x03\xe8", b""])
+ with self.assertRaises(InvalidState):
+ server.send_binary(b"")
+
+ def test_client_receives_binary_after_receiving_close(self):
+ client = Connection(Side.CLIENT)
+ client.receive_data(b"\x88\x02\x03\xe8")
+ self.assertConnectionClosing(client, 1000)
+ with self.assertRaises(ProtocolError) as raised:
+ client.receive_data(b"\x82\x00")
+ self.assertEqual(str(raised.exception), "data frame after close frame")
+
+ def test_server_receives_binary_after_receiving_close(self):
+ server = Connection(Side.SERVER)
+ server.receive_data(b"\x88\x82\x00\x00\x00\x00\x03\xe9")
+ self.assertConnectionClosing(server, 1001)
+ with self.assertRaises(ProtocolError) as raised:
+ server.receive_data(b"\x82\x80\x00\xff\x00\xff")
+ self.assertEqual(str(raised.exception), "data frame after close frame")
+
+
+class CloseTests(ConnectionTestCase):
+ """
+ Test close frames. See 5.5.1. Close in RFC 6544.
+
+ """
+
+ def test_client_sends_close(self):
+ client = Connection(Side.CLIENT)
+ with self.enforce_mask(b"\x3c\x3c\x3c\x3c"):
+ client.send_close()
+ self.assertEqual(client.data_to_send(), [b"\x88\x80\x3c\x3c\x3c\x3c"])
+ self.assertIs(client.state, State.CLOSING)
+
+ def test_server_sends_close(self):
+ server = Connection(Side.SERVER)
+ server.send_close()
+ self.assertEqual(server.data_to_send(), [b"\x88\x00", b""])
+ self.assertIs(server.state, State.CLOSING)
+
+ def test_client_receives_close(self):
+ client = Connection(Side.CLIENT)
+ with self.enforce_mask(b"\x3c\x3c\x3c\x3c"):
+ client.receive_data(b"\x88\x00")
+ self.assertEqual(client.events_received(), [Frame(True, OP_CLOSE, b"")])
+ self.assertEqual(client.data_to_send(), [b"\x88\x80\x3c\x3c\x3c\x3c"])
+ self.assertIs(client.state, State.CLOSING)
+
+ def test_server_receives_close(self):
+ server = Connection(Side.SERVER)
+ server.receive_data(b"\x88\x80\x3c\x3c\x3c\x3c")
+ self.assertEqual(server.events_received(), [Frame(True, OP_CLOSE, b"")])
+ self.assertEqual(server.data_to_send(), [b"\x88\x00", b""])
+ self.assertIs(server.state, State.CLOSING)
+
+ def test_client_sends_close_then_receives_close(self):
+ # Client-initiated close handshake on the client side.
+ client = Connection(Side.CLIENT)
+
+ client.send_close()
+ self.assertFrameReceived(client, None)
+ self.assertFrameSent(client, Frame(True, OP_CLOSE, b""))
+
+ client.receive_data(b"\x88\x00")
+ self.assertFrameReceived(client, Frame(True, OP_CLOSE, b""))
+ self.assertFrameSent(client, None)
+
+ client.receive_eof()
+ self.assertFrameReceived(client, None)
+ self.assertFrameSent(client, None, eof=True)
+
+ def test_server_sends_close_then_receives_close(self):
+ # Server-initiated close handshake on the server side.
+ server = Connection(Side.SERVER)
+
+ server.send_close()
+ self.assertFrameReceived(server, None)
+ self.assertFrameSent(server, Frame(True, OP_CLOSE, b""), eof=True)
+
+ server.receive_data(b"\x88\x80\x3c\x3c\x3c\x3c")
+ self.assertFrameReceived(server, Frame(True, OP_CLOSE, b""))
+ self.assertFrameSent(server, None)
+
+ server.receive_eof()
+ self.assertFrameReceived(server, None)
+ self.assertFrameSent(server, None)
+
+ def test_client_receives_close_then_sends_close(self):
+ # Server-initiated close handshake on the client side.
+ client = Connection(Side.CLIENT)
+
+ client.receive_data(b"\x88\x00")
+ self.assertFrameReceived(client, Frame(True, OP_CLOSE, b""))
+ self.assertFrameSent(client, Frame(True, OP_CLOSE, b""))
+
+ client.receive_eof()
+ self.assertFrameReceived(client, None)
+ self.assertFrameSent(client, None, eof=True)
+
+ def test_server_receives_close_then_sends_close(self):
+ # Client-initiated close handshake on the server side.
+ server = Connection(Side.SERVER)
+
+ server.receive_data(b"\x88\x80\x3c\x3c\x3c\x3c")
+ self.assertFrameReceived(server, Frame(True, OP_CLOSE, b""))
+ self.assertFrameSent(server, Frame(True, OP_CLOSE, b""), eof=True)
+
+ server.receive_eof()
+ self.assertFrameReceived(server, None)
+ self.assertFrameSent(server, None)
+
+ def test_client_sends_close_with_code(self):
+ client = Connection(Side.CLIENT)
+ with self.enforce_mask(b"\x00\x00\x00\x00"):
+ client.send_close(1001)
+ self.assertEqual(client.data_to_send(), [b"\x88\x82\x00\x00\x00\x00\x03\xe9"])
+ self.assertIs(client.state, State.CLOSING)
+
+ def test_server_sends_close_with_code(self):
+ server = Connection(Side.SERVER)
+ server.send_close(1000)
+ self.assertEqual(server.data_to_send(), [b"\x88\x02\x03\xe8", b""])
+ self.assertIs(server.state, State.CLOSING)
+
+ def test_client_receives_close_with_code(self):
+ client = Connection(Side.CLIENT)
+ client.receive_data(b"\x88\x02\x03\xe8")
+ self.assertConnectionClosing(client, 1000, "")
+ self.assertIs(client.state, State.CLOSING)
+
+ def test_server_receives_close_with_code(self):
+ server = Connection(Side.SERVER)
+ server.receive_data(b"\x88\x82\x00\x00\x00\x00\x03\xe9")
+ self.assertConnectionClosing(server, 1001, "")
+ self.assertIs(server.state, State.CLOSING)
+
+ def test_client_sends_close_with_code_and_reason(self):
+ client = Connection(Side.CLIENT)
+ with self.enforce_mask(b"\x00\x00\x00\x00"):
+ client.send_close(1001, "going away")
+ self.assertEqual(
+ client.data_to_send(), [b"\x88\x8c\x00\x00\x00\x00\x03\xe9going away"]
+ )
+ self.assertIs(client.state, State.CLOSING)
+
+ def test_server_sends_close_with_code_and_reason(self):
+ server = Connection(Side.SERVER)
+ server.send_close(1000, "OK")
+ self.assertEqual(server.data_to_send(), [b"\x88\x04\x03\xe8OK", b""])
+ self.assertIs(server.state, State.CLOSING)
+
+ def test_client_receives_close_with_code_and_reason(self):
+ client = Connection(Side.CLIENT)
+ client.receive_data(b"\x88\x04\x03\xe8OK")
+ self.assertConnectionClosing(client, 1000, "OK")
+ self.assertIs(client.state, State.CLOSING)
+
+ def test_server_receives_close_with_code_and_reason(self):
+ server = Connection(Side.SERVER)
+ server.receive_data(b"\x88\x8c\x00\x00\x00\x00\x03\xe9going away")
+ self.assertConnectionClosing(server, 1001, "going away")
+ self.assertIs(server.state, State.CLOSING)
+
+ def test_client_sends_close_with_reason_only(self):
+ client = Connection(Side.CLIENT)
+ with self.assertRaises(ValueError) as raised:
+ client.send_close(reason="going away")
+ self.assertEqual(str(raised.exception), "cannot send a reason without a code")
+
+ def test_server_sends_close_with_reason_only(self):
+ server = Connection(Side.SERVER)
+ with self.assertRaises(ValueError) as raised:
+ server.send_close(reason="OK")
+ self.assertEqual(str(raised.exception), "cannot send a reason without a code")
+
+ def test_client_receives_close_with_truncated_code(self):
+ client = Connection(Side.CLIENT)
+ with self.assertRaises(ProtocolError) as raised:
+ client.receive_data(b"\x88\x01\x03")
+ self.assertEqual(str(raised.exception), "close frame too short")
+ self.assertConnectionFailing(client, 1002, "close frame too short")
+ self.assertIs(client.state, State.CLOSING)
+
+ def test_server_receives_close_with_truncated_code(self):
+ server = Connection(Side.SERVER)
+ with self.assertRaises(ProtocolError) as raised:
+ server.receive_data(b"\x88\x81\x00\x00\x00\x00\x03")
+ self.assertEqual(str(raised.exception), "close frame too short")
+ self.assertConnectionFailing(server, 1002, "close frame too short")
+ self.assertIs(server.state, State.CLOSING)
+
+ def test_client_receives_close_with_non_utf8_reason(self):
+ client = Connection(Side.CLIENT)
+ with self.assertRaises(UnicodeDecodeError) as raised:
+ client.receive_data(b"\x88\x04\x03\xe8\xff\xff")
+ self.assertEqual(
+ str(raised.exception),
+ "'utf-8' codec can't decode byte 0xff in position 0: invalid start byte",
+ )
+ self.assertConnectionFailing(client, 1007, "invalid start byte at position 0")
+ self.assertIs(client.state, State.CLOSING)
+
+ def test_server_receives_close_with_non_utf8_reason(self):
+ server = Connection(Side.SERVER)
+ with self.assertRaises(UnicodeDecodeError) as raised:
+ server.receive_data(b"\x88\x84\x00\x00\x00\x00\x03\xe9\xff\xff")
+ self.assertEqual(
+ str(raised.exception),
+ "'utf-8' codec can't decode byte 0xff in position 0: invalid start byte",
+ )
+ self.assertConnectionFailing(server, 1007, "invalid start byte at position 0")
+ self.assertIs(server.state, State.CLOSING)
+
+
+class PingTests(ConnectionTestCase):
+ """
+ Test ping. See 5.5.2. Ping in RFC 6544.
+
+ """
+
+ def test_client_sends_ping(self):
+ client = Connection(Side.CLIENT)
+ with self.enforce_mask(b"\x00\x44\x88\xcc"):
+ client.send_ping(b"")
+ self.assertEqual(client.data_to_send(), [b"\x89\x80\x00\x44\x88\xcc"])
+
+ def test_server_sends_ping(self):
+ server = Connection(Side.SERVER)
+ server.send_ping(b"")
+ self.assertEqual(server.data_to_send(), [b"\x89\x00"])
+
+ def test_client_receives_ping(self):
+ client = Connection(Side.CLIENT)
+ client.receive_data(b"\x89\x00")
+ self.assertFrameReceived(
+ client,
+ Frame(True, OP_PING, b""),
+ )
+ self.assertFrameSent(
+ client,
+ Frame(True, OP_PONG, b""),
+ )
+
+ def test_server_receives_ping(self):
+ server = Connection(Side.SERVER)
+ server.receive_data(b"\x89\x80\x00\x44\x88\xcc")
+ self.assertFrameReceived(
+ server,
+ Frame(True, OP_PING, b""),
+ )
+ self.assertFrameSent(
+ server,
+ Frame(True, OP_PONG, b""),
+ )
+
+ def test_client_sends_ping_with_data(self):
+ client = Connection(Side.CLIENT)
+ with self.enforce_mask(b"\x00\x44\x88\xcc"):
+ client.send_ping(b"\x22\x66\xaa\xee")
+ self.assertEqual(
+ client.data_to_send(), [b"\x89\x84\x00\x44\x88\xcc\x22\x22\x22\x22"]
+ )
+
+ def test_server_sends_ping_with_data(self):
+ server = Connection(Side.SERVER)
+ server.send_ping(b"\x22\x66\xaa\xee")
+ self.assertEqual(server.data_to_send(), [b"\x89\x04\x22\x66\xaa\xee"])
+
+ def test_client_receives_ping_with_data(self):
+ client = Connection(Side.CLIENT)
+ client.receive_data(b"\x89\x04\x22\x66\xaa\xee")
+ self.assertFrameReceived(
+ client,
+ Frame(True, OP_PING, b"\x22\x66\xaa\xee"),
+ )
+ self.assertFrameSent(
+ client,
+ Frame(True, OP_PONG, b"\x22\x66\xaa\xee"),
+ )
+
+ def test_server_receives_ping_with_data(self):
+ server = Connection(Side.SERVER)
+ server.receive_data(b"\x89\x84\x00\x44\x88\xcc\x22\x22\x22\x22")
+ self.assertFrameReceived(
+ server,
+ Frame(True, OP_PING, b"\x22\x66\xaa\xee"),
+ )
+ self.assertFrameSent(
+ server,
+ Frame(True, OP_PONG, b"\x22\x66\xaa\xee"),
+ )
+
+ def test_client_sends_fragmented_ping_frame(self):
+ client = Connection(Side.CLIENT)
+ # This is only possible through a private API.
+ with self.assertRaises(ProtocolError) as raised:
+ client.send_frame(Frame(False, OP_PING, b""))
+ self.assertEqual(str(raised.exception), "fragmented control frame")
+
+ def test_server_sends_fragmented_ping_frame(self):
+ server = Connection(Side.SERVER)
+ # This is only possible through a private API.
+ with self.assertRaises(ProtocolError) as raised:
+ server.send_frame(Frame(False, OP_PING, b""))
+ self.assertEqual(str(raised.exception), "fragmented control frame")
+
+ def test_client_receives_fragmented_ping_frame(self):
+ client = Connection(Side.CLIENT)
+ with self.assertRaises(ProtocolError) as raised:
+ client.receive_data(b"\x09\x00")
+ self.assertEqual(str(raised.exception), "fragmented control frame")
+ self.assertConnectionFailing(client, 1002, "fragmented control frame")
+
+ def test_server_receives_fragmented_ping_frame(self):
+ server = Connection(Side.SERVER)
+ with self.assertRaises(ProtocolError) as raised:
+ server.receive_data(b"\x09\x80\x3c\x3c\x3c\x3c")
+ self.assertEqual(str(raised.exception), "fragmented control frame")
+ self.assertConnectionFailing(server, 1002, "fragmented control frame")
+
+ def test_client_sends_ping_after_sending_close(self):
+ client = Connection(Side.CLIENT)
+ with self.enforce_mask(b"\x00\x00\x00\x00"):
+ client.send_close(1001)
+ self.assertEqual(client.data_to_send(), [b"\x88\x82\x00\x00\x00\x00\x03\xe9"])
+ # The spec says: "An endpoint MAY send a Ping frame any time (...)
+ # before the connection is closed" but websockets doesn't support
+ # sending a Ping frame after a Close frame.
+ with self.assertRaises(InvalidState) as raised:
+ client.send_ping(b"")
+ self.assertEqual(
+ str(raised.exception), "cannot write to a WebSocket in the CLOSING state"
+ )
+
+ def test_server_sends_ping_after_sending_close(self):
+ server = Connection(Side.SERVER)
+ server.send_close(1000)
+ self.assertEqual(server.data_to_send(), [b"\x88\x02\x03\xe8", b""])
+ # The spec says: "An endpoint MAY send a Ping frame any time (...)
+ # before the connection is closed" but websockets doesn't support
+ # sending a Ping frame after a Close frame.
+ with self.assertRaises(InvalidState) as raised:
+ server.send_ping(b"")
+ self.assertEqual(
+ str(raised.exception), "cannot write to a WebSocket in the CLOSING state"
+ )
+
+ def test_client_receives_ping_after_receiving_close(self):
+ client = Connection(Side.CLIENT)
+ client.receive_data(b"\x88\x02\x03\xe8")
+ self.assertConnectionClosing(client, 1000)
+ client.receive_data(b"\x89\x04\x22\x66\xaa\xee")
+ self.assertFrameReceived(
+ client,
+ Frame(True, OP_PING, b"\x22\x66\xaa\xee"),
+ )
+ self.assertFrameSent(client, None)
+
+ def test_server_receives_ping_after_receiving_close(self):
+ server = Connection(Side.SERVER)
+ server.receive_data(b"\x88\x82\x00\x00\x00\x00\x03\xe9")
+ self.assertConnectionClosing(server, 1001)
+ server.receive_data(b"\x89\x84\x00\x44\x88\xcc\x22\x22\x22\x22")
+ self.assertFrameReceived(
+ server,
+ Frame(True, OP_PING, b"\x22\x66\xaa\xee"),
+ )
+ self.assertFrameSent(server, None)
+
+
+class PongTests(ConnectionTestCase):
+ """
+ Test pong frames. See 5.5.3. Pong in RFC 6544.
+
+ """
+
+ def test_client_sends_pong(self):
+ client = Connection(Side.CLIENT)
+ with self.enforce_mask(b"\x00\x44\x88\xcc"):
+ client.send_pong(b"")
+ self.assertEqual(client.data_to_send(), [b"\x8a\x80\x00\x44\x88\xcc"])
+
+ def test_server_sends_pong(self):
+ server = Connection(Side.SERVER)
+ server.send_pong(b"")
+ self.assertEqual(server.data_to_send(), [b"\x8a\x00"])
+
+ def test_client_receives_pong(self):
+ client = Connection(Side.CLIENT)
+ client.receive_data(b"\x8a\x00")
+ self.assertFrameReceived(
+ client,
+ Frame(True, OP_PONG, b""),
+ )
+
+ def test_server_receives_pong(self):
+ server = Connection(Side.SERVER)
+ server.receive_data(b"\x8a\x80\x00\x44\x88\xcc")
+ self.assertFrameReceived(
+ server,
+ Frame(True, OP_PONG, b""),
+ )
+
+ def test_client_sends_pong_with_data(self):
+ client = Connection(Side.CLIENT)
+ with self.enforce_mask(b"\x00\x44\x88\xcc"):
+ client.send_pong(b"\x22\x66\xaa\xee")
+ self.assertEqual(
+ client.data_to_send(), [b"\x8a\x84\x00\x44\x88\xcc\x22\x22\x22\x22"]
+ )
+
+ def test_server_sends_pong_with_data(self):
+ server = Connection(Side.SERVER)
+ server.send_pong(b"\x22\x66\xaa\xee")
+ self.assertEqual(server.data_to_send(), [b"\x8a\x04\x22\x66\xaa\xee"])
+
+ def test_client_receives_pong_with_data(self):
+ client = Connection(Side.CLIENT)
+ client.receive_data(b"\x8a\x04\x22\x66\xaa\xee")
+ self.assertFrameReceived(
+ client,
+ Frame(True, OP_PONG, b"\x22\x66\xaa\xee"),
+ )
+
+ def test_server_receives_pong_with_data(self):
+ server = Connection(Side.SERVER)
+ server.receive_data(b"\x8a\x84\x00\x44\x88\xcc\x22\x22\x22\x22")
+ self.assertFrameReceived(
+ server,
+ Frame(True, OP_PONG, b"\x22\x66\xaa\xee"),
+ )
+
+ def test_client_sends_fragmented_pong_frame(self):
+ client = Connection(Side.CLIENT)
+ # This is only possible through a private API.
+ with self.assertRaises(ProtocolError) as raised:
+ client.send_frame(Frame(False, OP_PONG, b""))
+ self.assertEqual(str(raised.exception), "fragmented control frame")
+
+ def test_server_sends_fragmented_pong_frame(self):
+ server = Connection(Side.SERVER)
+ # This is only possible through a private API.
+ with self.assertRaises(ProtocolError) as raised:
+ server.send_frame(Frame(False, OP_PONG, b""))
+ self.assertEqual(str(raised.exception), "fragmented control frame")
+
+ def test_client_receives_fragmented_pong_frame(self):
+ client = Connection(Side.CLIENT)
+ with self.assertRaises(ProtocolError) as raised:
+ client.receive_data(b"\x0a\x00")
+ self.assertEqual(str(raised.exception), "fragmented control frame")
+ self.assertConnectionFailing(client, 1002, "fragmented control frame")
+
+ def test_server_receives_fragmented_pong_frame(self):
+ server = Connection(Side.SERVER)
+ with self.assertRaises(ProtocolError) as raised:
+ server.receive_data(b"\x0a\x80\x3c\x3c\x3c\x3c")
+ self.assertEqual(str(raised.exception), "fragmented control frame")
+ self.assertConnectionFailing(server, 1002, "fragmented control frame")
+
+ def test_client_sends_pong_after_sending_close(self):
+ client = Connection(Side.CLIENT)
+ with self.enforce_mask(b"\x00\x00\x00\x00"):
+ client.send_close(1001)
+ self.assertEqual(client.data_to_send(), [b"\x88\x82\x00\x00\x00\x00\x03\xe9"])
+ # websockets doesn't support sending a Pong frame after a Close frame.
+ with self.assertRaises(InvalidState):
+ client.send_pong(b"")
+
+ def test_server_sends_pong_after_sending_close(self):
+ server = Connection(Side.SERVER)
+ server.send_close(1000)
+ self.assertEqual(server.data_to_send(), [b"\x88\x02\x03\xe8", b""])
+ # websockets doesn't support sending a Pong frame after a Close frame.
+ with self.assertRaises(InvalidState):
+ server.send_pong(b"")
+
+ def test_client_receives_pong_after_receiving_close(self):
+ client = Connection(Side.CLIENT)
+ client.receive_data(b"\x88\x02\x03\xe8")
+ self.assertConnectionClosing(client, 1000)
+ client.receive_data(b"\x8a\x04\x22\x66\xaa\xee")
+ self.assertFrameReceived(
+ client,
+ Frame(True, OP_PONG, b"\x22\x66\xaa\xee"),
+ )
+
+ def test_server_receives_pong_after_receiving_close(self):
+ server = Connection(Side.SERVER)
+ server.receive_data(b"\x88\x82\x00\x00\x00\x00\x03\xe9")
+ self.assertConnectionClosing(server, 1001)
+ server.receive_data(b"\x8a\x84\x00\x44\x88\xcc\x22\x22\x22\x22")
+ self.assertFrameReceived(
+ server,
+ Frame(True, OP_PONG, b"\x22\x66\xaa\xee"),
+ )
+
+
+class FragmentationTests(ConnectionTestCase):
+ """
+ Test message fragmentation.
+
+ See 5.4. Fragmentation in RFC 6544.
+
+ """
+
+ def test_client_send_ping_pong_in_fragmented_message(self):
+ client = Connection(Side.CLIENT)
+ client.send_text(b"Spam", fin=False)
+ self.assertFrameSent(client, Frame(False, OP_TEXT, b"Spam"))
+ client.send_ping(b"Ping")
+ self.assertFrameSent(client, Frame(True, OP_PING, b"Ping"))
+ client.send_continuation(b"Ham", fin=False)
+ self.assertFrameSent(client, Frame(False, OP_CONT, b"Ham"))
+ client.send_pong(b"Pong")
+ self.assertFrameSent(client, Frame(True, OP_PONG, b"Pong"))
+ client.send_continuation(b"Eggs", fin=True)
+ self.assertFrameSent(client, Frame(True, OP_CONT, b"Eggs"))
+
+ def test_server_send_ping_pong_in_fragmented_message(self):
+ server = Connection(Side.SERVER)
+ server.send_text(b"Spam", fin=False)
+ self.assertFrameSent(server, Frame(False, OP_TEXT, b"Spam"))
+ server.send_ping(b"Ping")
+ self.assertFrameSent(server, Frame(True, OP_PING, b"Ping"))
+ server.send_continuation(b"Ham", fin=False)
+ self.assertFrameSent(server, Frame(False, OP_CONT, b"Ham"))
+ server.send_pong(b"Pong")
+ self.assertFrameSent(server, Frame(True, OP_PONG, b"Pong"))
+ server.send_continuation(b"Eggs", fin=True)
+ self.assertFrameSent(server, Frame(True, OP_CONT, b"Eggs"))
+
+ def test_client_receive_ping_pong_in_fragmented_message(self):
+ client = Connection(Side.CLIENT)
+ client.receive_data(b"\x01\x04Spam")
+ self.assertFrameReceived(
+ client,
+ Frame(False, OP_TEXT, b"Spam"),
+ )
+ client.receive_data(b"\x89\x04Ping")
+ self.assertFrameReceived(
+ client,
+ Frame(True, OP_PING, b"Ping"),
+ )
+ self.assertFrameSent(
+ client,
+ Frame(True, OP_PONG, b"Ping"),
+ )
+ client.receive_data(b"\x00\x03Ham")
+ self.assertFrameReceived(
+ client,
+ Frame(False, OP_CONT, b"Ham"),
+ )
+ client.receive_data(b"\x8a\x04Pong")
+ self.assertFrameReceived(
+ client,
+ Frame(True, OP_PONG, b"Pong"),
+ )
+ client.receive_data(b"\x80\x04Eggs")
+ self.assertFrameReceived(
+ client,
+ Frame(True, OP_CONT, b"Eggs"),
+ )
+
+ def test_server_receive_ping_pong_in_fragmented_message(self):
+ server = Connection(Side.SERVER)
+ server.receive_data(b"\x01\x84\x00\x00\x00\x00Spam")
+ self.assertFrameReceived(
+ server,
+ Frame(False, OP_TEXT, b"Spam"),
+ )
+ server.receive_data(b"\x89\x84\x00\x00\x00\x00Ping")
+ self.assertFrameReceived(
+ server,
+ Frame(True, OP_PING, b"Ping"),
+ )
+ self.assertFrameSent(
+ server,
+ Frame(True, OP_PONG, b"Ping"),
+ )
+ server.receive_data(b"\x00\x83\x00\x00\x00\x00Ham")
+ self.assertFrameReceived(
+ server,
+ Frame(False, OP_CONT, b"Ham"),
+ )
+ server.receive_data(b"\x8a\x84\x00\x00\x00\x00Pong")
+ self.assertFrameReceived(
+ server,
+ Frame(True, OP_PONG, b"Pong"),
+ )
+ server.receive_data(b"\x80\x84\x00\x00\x00\x00Eggs")
+ self.assertFrameReceived(
+ server,
+ Frame(True, OP_CONT, b"Eggs"),
+ )
+
+ def test_client_send_close_in_fragmented_message(self):
+ client = Connection(Side.CLIENT)
+ client.send_text(b"Spam", fin=False)
+ self.assertFrameSent(client, Frame(False, OP_TEXT, b"Spam"))
+ # The spec says: "An endpoint MUST be capable of handling control
+ # frames in the middle of a fragmented message." However, since the
+ # endpoint must not send a data frame after a close frame, a close
+ # frame can't be "in the middle" of a fragmented message.
+ with self.assertRaises(ProtocolError) as raised:
+ client.send_close(1001)
+ self.assertEqual(str(raised.exception), "expected a continuation frame")
+ client.send_continuation(b"Eggs", fin=True)
+
+ def test_server_send_close_in_fragmented_message(self):
+ server = Connection(Side.CLIENT)
+ server.send_text(b"Spam", fin=False)
+ self.assertFrameSent(server, Frame(False, OP_TEXT, b"Spam"))
+ # The spec says: "An endpoint MUST be capable of handling control
+ # frames in the middle of a fragmented message." However, since the
+ # endpoint must not send a data frame after a close frame, a close
+ # frame can't be "in the middle" of a fragmented message.
+ with self.assertRaises(ProtocolError) as raised:
+ server.send_close(1000)
+ self.assertEqual(str(raised.exception), "expected a continuation frame")
+
+ def test_client_receive_close_in_fragmented_message(self):
+ client = Connection(Side.CLIENT)
+ client.receive_data(b"\x01\x04Spam")
+ self.assertFrameReceived(
+ client,
+ Frame(False, OP_TEXT, b"Spam"),
+ )
+ # The spec says: "An endpoint MUST be capable of handling control
+ # frames in the middle of a fragmented message." However, since the
+ # endpoint must not send a data frame after a close frame, a close
+ # frame can't be "in the middle" of a fragmented message.
+ with self.assertRaises(ProtocolError) as raised:
+ client.receive_data(b"\x88\x02\x03\xe8")
+ self.assertEqual(str(raised.exception), "incomplete fragmented message")
+ self.assertConnectionFailing(client, 1002, "incomplete fragmented message")
+
+ def test_server_receive_close_in_fragmented_message(self):
+ server = Connection(Side.SERVER)
+ server.receive_data(b"\x01\x84\x00\x00\x00\x00Spam")
+ self.assertFrameReceived(
+ server,
+ Frame(False, OP_TEXT, b"Spam"),
+ )
+ # The spec says: "An endpoint MUST be capable of handling control
+ # frames in the middle of a fragmented message." However, since the
+ # endpoint must not send a data frame after a close frame, a close
+ # frame can't be "in the middle" of a fragmented message.
+ with self.assertRaises(ProtocolError) as raised:
+ server.receive_data(b"\x88\x82\x00\x00\x00\x00\x03\xe9")
+ self.assertEqual(str(raised.exception), "incomplete fragmented message")
+ self.assertConnectionFailing(server, 1002, "incomplete fragmented message")
+
+
+class EOFTests(ConnectionTestCase):
+ """
+ Test connection termination.
+
+ """
+
+ def test_client_receives_eof(self):
+ client = Connection(Side.CLIENT)
+ client.receive_data(b"\x88\x00")
+ self.assertConnectionClosing(client)
+ client.receive_eof() # does not raise an exception
+
+ def test_server_receives_eof(self):
+ server = Connection(Side.SERVER)
+ server.receive_data(b"\x88\x80\x3c\x3c\x3c\x3c")
+ self.assertConnectionClosing(server)
+ server.receive_eof() # does not raise an exception
+
+ def test_client_receives_eof_between_frames(self):
+ client = Connection(Side.CLIENT)
+ with self.assertRaises(EOFError) as raised:
+ client.receive_eof()
+ self.assertEqual(str(raised.exception), "unexpected end of stream")
+
+ def test_server_receives_eof_between_frames(self):
+ server = Connection(Side.SERVER)
+ with self.assertRaises(EOFError) as raised:
+ server.receive_eof()
+ self.assertEqual(str(raised.exception), "unexpected end of stream")
+
+ def test_client_receives_eof_inside_frame(self):
+ client = Connection(Side.CLIENT)
+ client.receive_data(b"\x81")
+ with self.assertRaises(EOFError) as raised:
+ client.receive_eof()
+ self.assertEqual(
+ str(raised.exception), "stream ends after 1 bytes, expected 2 bytes"
+ )
+
+ def test_server_receives_eof_inside_frame(self):
+ server = Connection(Side.SERVER)
+ server.receive_data(b"\x81")
+ with self.assertRaises(EOFError) as raised:
+ server.receive_eof()
+ self.assertEqual(
+ str(raised.exception), "stream ends after 1 bytes, expected 2 bytes"
+ )
+
+ def test_client_receives_data_after_exception(self):
+ client = Connection(Side.CLIENT)
+ with self.assertRaises(ProtocolError) as raised:
+ client.receive_data(b"\xff\xff")
+ self.assertEqual(str(raised.exception), "invalid opcode")
+ with self.assertRaises(RuntimeError) as raised:
+ client.receive_data(b"\x00\x00")
+ self.assertEqual(
+ str(raised.exception), "cannot receive data or EOF after an error"
+ )
+
+ def test_server_receives_data_after_exception(self):
+ server = Connection(Side.SERVER)
+ with self.assertRaises(ProtocolError) as raised:
+ server.receive_data(b"\xff\xff")
+ self.assertEqual(str(raised.exception), "invalid opcode")
+ with self.assertRaises(RuntimeError) as raised:
+ server.receive_data(b"\x00\x00")
+ self.assertEqual(
+ str(raised.exception), "cannot receive data or EOF after an error"
+ )
+
+ def test_client_receives_eof_after_exception(self):
+ client = Connection(Side.CLIENT)
+ with self.assertRaises(ProtocolError) as raised:
+ client.receive_data(b"\xff\xff")
+ self.assertEqual(str(raised.exception), "invalid opcode")
+ with self.assertRaises(RuntimeError) as raised:
+ client.receive_eof()
+ self.assertEqual(
+ str(raised.exception), "cannot receive data or EOF after an error"
+ )
+
+ def test_server_receives_eof_after_exception(self):
+ server = Connection(Side.SERVER)
+ with self.assertRaises(ProtocolError) as raised:
+ server.receive_data(b"\xff\xff")
+ self.assertEqual(str(raised.exception), "invalid opcode")
+ with self.assertRaises(RuntimeError) as raised:
+ server.receive_eof()
+ self.assertEqual(
+ str(raised.exception), "cannot receive data or EOF after an error"
+ )
+
+ def test_client_receives_data_after_eof(self):
+ client = Connection(Side.CLIENT)
+ client.receive_data(b"\x88\x00")
+ self.assertConnectionClosing(client)
+ client.receive_eof()
+ with self.assertRaises(EOFError) as raised:
+ client.receive_data(b"\x88\x00")
+ self.assertEqual(str(raised.exception), "stream ended")
+
+ def test_server_receives_data_after_eof(self):
+ server = Connection(Side.SERVER)
+ server.receive_data(b"\x88\x80\x3c\x3c\x3c\x3c")
+ self.assertConnectionClosing(server)
+ server.receive_eof()
+ with self.assertRaises(EOFError) as raised:
+ server.receive_data(b"\x88\x80\x00\x00\x00\x00")
+ self.assertEqual(str(raised.exception), "stream ended")
+
+ def test_client_receives_eof_after_eof(self):
+ client = Connection(Side.CLIENT)
+ client.receive_data(b"\x88\x00")
+ self.assertConnectionClosing(client)
+ client.receive_eof()
+ with self.assertRaises(EOFError) as raised:
+ client.receive_eof()
+ self.assertEqual(str(raised.exception), "stream ended")
+
+ def test_server_receives_eof_after_eof(self):
+ server = Connection(Side.SERVER)
+ server.receive_data(b"\x88\x80\x3c\x3c\x3c\x3c")
+ self.assertConnectionClosing(server)
+ server.receive_eof()
+ with self.assertRaises(EOFError) as raised:
+ server.receive_eof()
+ self.assertEqual(str(raised.exception), "stream ended")
+
+
+class ErrorTests(ConnectionTestCase):
+ """
+ Test other error cases.
+
+ """
+
+ def test_client_hits_internal_error_reading_frame(self):
+ client = Connection(Side.CLIENT)
+ # This isn't supposed to happen, so we're simulating it.
+ with unittest.mock.patch("struct.unpack", side_effect=RuntimeError("BOOM")):
+ with self.assertRaises(RuntimeError) as raised:
+ client.receive_data(b"\x81\x00")
+ self.assertEqual(str(raised.exception), "BOOM")
+ self.assertConnectionFailing(client, 1011, "")
+
+ def test_server_hits_internal_error_reading_frame(self):
+ server = Connection(Side.SERVER)
+ # This isn't supposed to happen, so we're simulating it.
+ with unittest.mock.patch("struct.unpack", side_effect=RuntimeError("BOOM")):
+ with self.assertRaises(RuntimeError) as raised:
+ server.receive_data(b"\x81\x80\x00\x00\x00\x00")
+ self.assertEqual(str(raised.exception), "BOOM")
+ self.assertConnectionFailing(server, 1011, "")
+
+
+class ExtensionsTests(ConnectionTestCase):
+ """
+ Test how extensions affect frames.
+
+ """
+
+ def test_client_extension_encodes_frame(self):
+ client = Connection(Side.CLIENT)
+ client.extensions = [Rsv2Extension()]
+ with self.enforce_mask(b"\x00\x44\x88\xcc"):
+ client.send_ping(b"")
+ self.assertEqual(client.data_to_send(), [b"\xa9\x80\x00\x44\x88\xcc"])
+
+ def test_server_extension_encodes_frame(self):
+ server = Connection(Side.SERVER)
+ server.extensions = [Rsv2Extension()]
+ server.send_ping(b"")
+ self.assertEqual(server.data_to_send(), [b"\xa9\x00"])
+
+ def test_client_extension_decodes_frame(self):
+ client = Connection(Side.CLIENT)
+ client.extensions = [Rsv2Extension()]
+ client.receive_data(b"\xaa\x00")
+ self.assertEqual(client.events_received(), [Frame(True, OP_PONG, b"")])
+
+ def test_server_extension_decodes_frame(self):
+ server = Connection(Side.SERVER)
+ server.extensions = [Rsv2Extension()]
+ server.receive_data(b"\xaa\x80\x00\x44\x88\xcc")
+ self.assertEqual(server.events_received(), [Frame(True, OP_PONG, b"")])
diff --git a/tests/test_datastructures.py b/tests/test_datastructures.py
new file mode 100644
index 000000000..628cbcb02
--- /dev/null
+++ b/tests/test_datastructures.py
@@ -0,0 +1,131 @@
+import unittest
+
+from websockets.datastructures import *
+
+
+class HeadersTests(unittest.TestCase):
+ def setUp(self):
+ self.headers = Headers([("Connection", "Upgrade"), ("Server", "websockets")])
+
+ def test_str(self):
+ self.assertEqual(
+ str(self.headers), "Connection: Upgrade\r\nServer: websockets\r\n\r\n"
+ )
+
+ def test_repr(self):
+ self.assertEqual(
+ repr(self.headers),
+ "Headers([('Connection', 'Upgrade'), ('Server', 'websockets')])",
+ )
+
+ def test_copy(self):
+ self.assertEqual(repr(self.headers.copy()), repr(self.headers))
+
+ def test_serialize(self):
+ self.assertEqual(
+ self.headers.serialize(),
+ b"Connection: Upgrade\r\nServer: websockets\r\n\r\n",
+ )
+
+ def test_multiple_values_error_str(self):
+ self.assertEqual(str(MultipleValuesError("Connection")), "'Connection'")
+ self.assertEqual(str(MultipleValuesError()), "")
+
+ def test_contains(self):
+ self.assertIn("Server", self.headers)
+
+ def test_contains_case_insensitive(self):
+ self.assertIn("server", self.headers)
+
+ def test_contains_not_found(self):
+ self.assertNotIn("Date", self.headers)
+
+ def test_contains_non_string_key(self):
+ self.assertNotIn(42, self.headers)
+
+ def test_iter(self):
+ self.assertEqual(set(iter(self.headers)), {"connection", "server"})
+
+ def test_len(self):
+ self.assertEqual(len(self.headers), 2)
+
+ def test_getitem(self):
+ self.assertEqual(self.headers["Server"], "websockets")
+
+ def test_getitem_case_insensitive(self):
+ self.assertEqual(self.headers["server"], "websockets")
+
+ def test_getitem_key_error(self):
+ with self.assertRaises(KeyError):
+ self.headers["Upgrade"]
+
+ def test_getitem_multiple_values_error(self):
+ self.headers["Server"] = "2"
+ with self.assertRaises(MultipleValuesError):
+ self.headers["Server"]
+
+ def test_setitem(self):
+ self.headers["Upgrade"] = "websocket"
+ self.assertEqual(self.headers["Upgrade"], "websocket")
+
+ def test_setitem_case_insensitive(self):
+ self.headers["upgrade"] = "websocket"
+ self.assertEqual(self.headers["Upgrade"], "websocket")
+
+ def test_setitem_multiple_values(self):
+ self.headers["Connection"] = "close"
+ with self.assertRaises(MultipleValuesError):
+ self.headers["Connection"]
+
+ def test_delitem(self):
+ del self.headers["Connection"]
+ with self.assertRaises(KeyError):
+ self.headers["Connection"]
+
+ def test_delitem_case_insensitive(self):
+ del self.headers["connection"]
+ with self.assertRaises(KeyError):
+ self.headers["Connection"]
+
+ def test_delitem_multiple_values(self):
+ self.headers["Connection"] = "close"
+ del self.headers["Connection"]
+ with self.assertRaises(KeyError):
+ self.headers["Connection"]
+
+ def test_eq(self):
+ other_headers = Headers([("Connection", "Upgrade"), ("Server", "websockets")])
+ self.assertEqual(self.headers, other_headers)
+
+ def test_eq_not_equal(self):
+ other_headers = Headers([("Connection", "close"), ("Server", "websockets")])
+ self.assertNotEqual(self.headers, other_headers)
+
+ def test_eq_other_type(self):
+ self.assertNotEqual(
+ self.headers, "Connection: Upgrade\r\nServer: websockets\r\n\r\n"
+ )
+
+ def test_clear(self):
+ self.headers.clear()
+ self.assertFalse(self.headers)
+ self.assertEqual(self.headers, Headers())
+
+ def test_get_all(self):
+ self.assertEqual(self.headers.get_all("Connection"), ["Upgrade"])
+
+ def test_get_all_case_insensitive(self):
+ self.assertEqual(self.headers.get_all("connection"), ["Upgrade"])
+
+ def test_get_all_no_values(self):
+ self.assertEqual(self.headers.get_all("Upgrade"), [])
+
+ def test_get_all_multiple_values(self):
+ self.headers["Connection"] = "close"
+ self.assertEqual(self.headers.get_all("Connection"), ["Upgrade", "close"])
+
+ def test_raw_items(self):
+ self.assertEqual(
+ list(self.headers.raw_items()),
+ [("Connection", "Upgrade"), ("Server", "websockets")],
+ )
diff --git a/tests/test_exceptions.py b/tests/test_exceptions.py
index 7b935491b..b800d4f91 100644
--- a/tests/test_exceptions.py
+++ b/tests/test_exceptions.py
@@ -1,7 +1,7 @@
import unittest
+from websockets.datastructures import Headers
from websockets.exceptions import *
-from websockets.http import Headers
class ExceptionsTests(unittest.TestCase):
@@ -9,122 +9,135 @@ def test_str(self):
for exception, exception_str in [
# fmt: off
(
- InvalidHandshake("Invalid request"),
- "Invalid request",
+ WebSocketException("something went wrong"),
+ "something went wrong",
),
(
- AbortHandshake(200, Headers(), b'OK\n'),
- "HTTP 200, 0 headers, 3 bytes",
+ ConnectionClosed(1000, ""),
+ "code = 1000 (OK), no reason",
),
(
- InvalidMessage("Malformed HTTP message"),
- "Malformed HTTP message",
+ ConnectionClosed(1006, None),
+ "code = 1006 (connection closed abnormally [internal]), no reason"
),
(
- InvalidHeader('Name'),
- "Missing Name header",
+ ConnectionClosed(3000, None),
+ "code = 3000 (registered), no reason"
),
(
- InvalidHeader('Name', None),
- "Missing Name header",
+ ConnectionClosed(4000, None),
+ "code = 4000 (private use), no reason"
),
(
- InvalidHeader('Name', ''),
- "Empty Name header",
+ ConnectionClosedError(1016, None),
+ "code = 1016 (unknown), no reason"
),
(
- InvalidHeader('Name', 'Value'),
- "Invalid Name header: Value",
+ ConnectionClosedOK(1001, "bye"),
+ "code = 1001 (going away), reason = bye",
),
(
- InvalidHeaderFormat(
- 'Sec-WebSocket-Protocol', "expected token", 'a=|', 3
- ),
- "Invalid Sec-WebSocket-Protocol header: "
- "expected token at 3 in a=|",
+ InvalidHandshake("invalid request"),
+ "invalid request",
),
(
- InvalidHeaderValue('Sec-WebSocket-Version', '42'),
- "Invalid Sec-WebSocket-Version header: 42",
+ SecurityError("redirect from WSS to WS"),
+ "redirect from WSS to WS",
),
-
(
- InvalidUpgrade('Upgrade'),
- "Missing Upgrade header",
+ InvalidMessage("malformed HTTP message"),
+ "malformed HTTP message",
),
(
- InvalidUpgrade('Connection', 'websocket'),
- "Invalid Connection header: websocket",
+ InvalidHeader("Name"),
+ "missing Name header",
),
(
- InvalidOrigin('http://bad.origin'),
- 'Invalid Origin header: http://bad.origin',
+ InvalidHeader("Name", None),
+ "missing Name header",
),
(
- InvalidStatusCode(403),
- "Status code not 101: 403",
+ InvalidHeader("Name", ""),
+ "empty Name header",
),
(
- NegotiationError("Unsupported subprotocol: spam"),
- "Unsupported subprotocol: spam",
+ InvalidHeader("Name", "Value"),
+ "invalid Name header: Value",
),
(
- InvalidParameterName('|'),
- "Invalid parameter name: |",
+ InvalidHeaderFormat(
+ "Sec-WebSocket-Protocol", "expected token", "a=|", 3
+ ),
+ "invalid Sec-WebSocket-Protocol header: "
+ "expected token at 3 in a=|",
),
(
- InvalidParameterValue('a', '|'),
- "Invalid value for parameter a: |",
+ InvalidHeaderValue("Sec-WebSocket-Version", "42"),
+ "invalid Sec-WebSocket-Version header: 42",
),
(
- DuplicateParameter('a'),
- "Duplicate parameter: a",
+ InvalidOrigin("http://bad.origin"),
+ "invalid Origin header: http://bad.origin",
),
(
- InvalidState("WebSocket connection isn't established yet"),
- "WebSocket connection isn't established yet",
+ InvalidUpgrade("Upgrade"),
+ "missing Upgrade header",
),
(
- ConnectionClosed(1000, ''),
- "WebSocket connection is closed: code = 1000 "
- "(OK), no reason",
+ InvalidUpgrade("Connection", "websocket"),
+ "invalid Connection header: websocket",
),
(
- ConnectionClosed(1001, 'bye'),
- "WebSocket connection is closed: code = 1001 "
- "(going away), reason = bye",
+ InvalidStatusCode(403),
+ "server rejected WebSocket connection: HTTP 403",
),
(
- ConnectionClosed(1006, None),
- "WebSocket connection is closed: code = 1006 "
- "(connection closed abnormally [internal]), no reason"
+ NegotiationError("unsupported subprotocol: spam"),
+ "unsupported subprotocol: spam",
),
(
- ConnectionClosed(1016, None),
- "WebSocket connection is closed: code = 1016 "
- "(unknown), no reason"
+ DuplicateParameter("a"),
+ "duplicate parameter: a",
),
(
- ConnectionClosed(3000, None),
- "WebSocket connection is closed: code = 3000 "
- "(registered), no reason"
+ InvalidParameterName("|"),
+ "invalid parameter name: |",
),
(
- ConnectionClosed(4000, None),
- "WebSocket connection is closed: code = 4000 "
- "(private use), no reason"
+ InvalidParameterValue("a", None),
+ "missing value for parameter a",
+ ),
+ (
+ InvalidParameterValue("a", ""),
+ "empty value for parameter a",
+ ),
+ (
+ InvalidParameterValue("a", "|"),
+ "invalid value for parameter a: |",
+ ),
+ (
+ AbortHandshake(200, Headers(), b"OK\n"),
+ "HTTP 200, 0 headers, 3 bytes",
+ ),
+ (
+ RedirectHandshake("wss://example.com"),
+ "redirect to wss://example.com",
+ ),
+ (
+ InvalidState("WebSocket connection isn't established yet"),
+ "WebSocket connection isn't established yet",
),
(
- InvalidURI("| isn't a valid URI"),
+ InvalidURI("|"),
"| isn't a valid URI",
),
(
- PayloadTooBig("Payload length exceeds limit: 2 > 1 bytes"),
- "Payload length exceeds limit: 2 > 1 bytes",
+ PayloadTooBig("payload length exceeds limit: 2 > 1 bytes"),
+ "payload length exceeds limit: 2 > 1 bytes",
),
(
- WebSocketProtocolError("Invalid opcode: 7"),
- "Invalid opcode: 7",
+ ProtocolError("invalid opcode: 7"),
+ "invalid opcode: 7",
),
# fmt: on
]:
diff --git a/tests/test_exports.py b/tests/test_exports.py
new file mode 100644
index 000000000..568c50c54
--- /dev/null
+++ b/tests/test_exports.py
@@ -0,0 +1,33 @@
+import unittest
+
+import websockets
+import websockets.client
+import websockets.exceptions
+import websockets.legacy.auth
+import websockets.legacy.client
+import websockets.legacy.protocol
+import websockets.legacy.server
+import websockets.server
+import websockets.typing
+import websockets.uri
+
+
+combined_exports = (
+ websockets.legacy.auth.__all__
+ + websockets.legacy.client.__all__
+ + websockets.legacy.protocol.__all__
+ + websockets.legacy.server.__all__
+ + websockets.client.__all__
+ + websockets.exceptions.__all__
+ + websockets.server.__all__
+ + websockets.typing.__all__
+ + websockets.uri.__all__
+)
+
+
+class TestExportsAllSubmodules(unittest.TestCase):
+ def test_top_level_module_reexports_all_submodule_exports(self):
+ self.assertEqual(set(combined_exports), set(websockets.__all__))
+
+ def test_submodule_exports_are_globally_unique(self):
+ self.assertEqual(len(set(combined_exports)), len(combined_exports))
diff --git a/tests/test_frames.py b/tests/test_frames.py
new file mode 100644
index 000000000..13a712322
--- /dev/null
+++ b/tests/test_frames.py
@@ -0,0 +1,280 @@
+import codecs
+import unittest
+import unittest.mock
+
+from websockets.exceptions import PayloadTooBig, ProtocolError
+from websockets.frames import *
+from websockets.streams import StreamReader
+
+from .utils import GeneratorTestCase
+
+
+class FramesTestCase(GeneratorTestCase):
+ def enforce_mask(self, mask):
+ return unittest.mock.patch("secrets.token_bytes", return_value=mask)
+
+ def parse(self, data, mask, max_size=None, extensions=None):
+ """
+ Parse a frame from a bytestring.
+
+ """
+ reader = StreamReader()
+ reader.feed_data(data)
+ reader.feed_eof()
+ parser = Frame.parse(
+ reader.read_exact, mask=mask, max_size=max_size, extensions=extensions
+ )
+ return self.assertGeneratorReturns(parser)
+
+ def assertFrameData(self, frame, data, mask, extensions=None):
+ """
+ Serializing frame yields data. Parsing data yields frame.
+
+ """
+ # Compare frames first, because test failures are easier to read,
+ # especially when mask = True.
+ parsed = self.parse(data, mask=mask, extensions=extensions)
+ self.assertEqual(parsed, frame)
+
+ # Make masking deterministic by reusing the same "random" mask.
+ # This has an effect only when mask is True.
+ mask_bytes = data[2:6] if mask else b""
+ with self.enforce_mask(mask_bytes):
+ serialized = frame.serialize(mask=mask, extensions=extensions)
+ self.assertEqual(serialized, data)
+
+
+class FrameTests(FramesTestCase):
+ def test_text_unmasked(self):
+ self.assertFrameData(
+ Frame(True, OP_TEXT, b"Spam"),
+ b"\x81\x04Spam",
+ mask=False,
+ )
+
+ def test_text_masked(self):
+ self.assertFrameData(
+ Frame(True, OP_TEXT, b"Spam"),
+ b"\x81\x84\x5b\xfb\xe1\xa8\x08\x8b\x80\xc5",
+ mask=True,
+ )
+
+ def test_binary_unmasked(self):
+ self.assertFrameData(
+ Frame(True, OP_BINARY, b"Eggs"),
+ b"\x82\x04Eggs",
+ mask=False,
+ )
+
+ def test_binary_masked(self):
+ self.assertFrameData(
+ Frame(True, OP_BINARY, b"Eggs"),
+ b"\x82\x84\x53\xcd\xe2\x89\x16\xaa\x85\xfa",
+ mask=True,
+ )
+
+ def test_non_ascii_text_unmasked(self):
+ self.assertFrameData(
+ Frame(True, OP_TEXT, "café".encode("utf-8")),
+ b"\x81\x05caf\xc3\xa9",
+ mask=False,
+ )
+
+ def test_non_ascii_text_masked(self):
+ self.assertFrameData(
+ Frame(True, OP_TEXT, "café".encode("utf-8")),
+ b"\x81\x85\x64\xbe\xee\x7e\x07\xdf\x88\xbd\xcd",
+ mask=True,
+ )
+
+ def test_close(self):
+ self.assertFrameData(
+ Frame(True, OP_CLOSE, b""),
+ b"\x88\x00",
+ mask=False,
+ )
+
+ def test_ping(self):
+ self.assertFrameData(
+ Frame(True, OP_PING, b"ping"),
+ b"\x89\x04ping",
+ mask=False,
+ )
+
+ def test_pong(self):
+ self.assertFrameData(
+ Frame(True, OP_PONG, b"pong"),
+ b"\x8a\x04pong",
+ mask=False,
+ )
+
+ def test_long(self):
+ self.assertFrameData(
+ Frame(True, OP_BINARY, 126 * b"a"),
+ b"\x82\x7e\x00\x7e" + 126 * b"a",
+ mask=False,
+ )
+
+ def test_very_long(self):
+ self.assertFrameData(
+ Frame(True, OP_BINARY, 65536 * b"a"),
+ b"\x82\x7f\x00\x00\x00\x00\x00\x01\x00\x00" + 65536 * b"a",
+ mask=False,
+ )
+
+ def test_payload_too_big(self):
+ with self.assertRaises(PayloadTooBig):
+ self.parse(b"\x82\x7e\x04\x01" + 1025 * b"a", mask=False, max_size=1024)
+
+ def test_bad_reserved_bits(self):
+ for data in [b"\xc0\x00", b"\xa0\x00", b"\x90\x00"]:
+ with self.subTest(data=data):
+ with self.assertRaises(ProtocolError):
+ self.parse(data, mask=False)
+
+ def test_good_opcode(self):
+ for opcode in list(range(0x00, 0x03)) + list(range(0x08, 0x0B)):
+ data = bytes([0x80 | opcode, 0])
+ with self.subTest(data=data):
+ self.parse(data, mask=False) # does not raise an exception
+
+ def test_bad_opcode(self):
+ for opcode in list(range(0x03, 0x08)) + list(range(0x0B, 0x10)):
+ data = bytes([0x80 | opcode, 0])
+ with self.subTest(data=data):
+ with self.assertRaises(ProtocolError):
+ self.parse(data, mask=False)
+
+ def test_mask_flag(self):
+ # Mask flag correctly set.
+ self.parse(b"\x80\x80\x00\x00\x00\x00", mask=True)
+ # Mask flag incorrectly unset.
+ with self.assertRaises(ProtocolError):
+ self.parse(b"\x80\x80\x00\x00\x00\x00", mask=False)
+ # Mask flag correctly unset.
+ self.parse(b"\x80\x00", mask=False)
+ # Mask flag incorrectly set.
+ with self.assertRaises(ProtocolError):
+ self.parse(b"\x80\x00", mask=True)
+
+ def test_control_frame_max_length(self):
+ # At maximum allowed length.
+ self.parse(b"\x88\x7e\x00\x7d" + 125 * b"a", mask=False)
+ # Above maximum allowed length.
+ with self.assertRaises(ProtocolError):
+ self.parse(b"\x88\x7e\x00\x7e" + 126 * b"a", mask=False)
+
+ def test_fragmented_control_frame(self):
+ # Fin bit correctly set.
+ self.parse(b"\x88\x00", mask=False)
+ # Fin bit incorrectly unset.
+ with self.assertRaises(ProtocolError):
+ self.parse(b"\x08\x00", mask=False)
+
+ def test_extensions(self):
+ class Rot13:
+ @staticmethod
+ def encode(frame):
+ assert frame.opcode == OP_TEXT
+ text = frame.data.decode()
+ data = codecs.encode(text, "rot13").encode()
+ return frame._replace(data=data)
+
+ # This extensions is symmetrical.
+ @staticmethod
+ def decode(frame, *, max_size=None):
+ return Rot13.encode(frame)
+
+ self.assertFrameData(
+ Frame(True, OP_TEXT, b"hello"),
+ b"\x81\x05uryyb",
+ mask=False,
+ extensions=[Rot13()],
+ )
+
+
+class PrepareDataTests(unittest.TestCase):
+ def test_prepare_data_str(self):
+ self.assertEqual(
+ prepare_data("café"),
+ (OP_TEXT, b"caf\xc3\xa9"),
+ )
+
+ def test_prepare_data_bytes(self):
+ self.assertEqual(
+ prepare_data(b"tea"),
+ (OP_BINARY, b"tea"),
+ )
+
+ def test_prepare_data_bytearray(self):
+ self.assertEqual(
+ prepare_data(bytearray(b"tea")),
+ (OP_BINARY, bytearray(b"tea")),
+ )
+
+ def test_prepare_data_memoryview(self):
+ self.assertEqual(
+ prepare_data(memoryview(b"tea")),
+ (OP_BINARY, memoryview(b"tea")),
+ )
+
+ def test_prepare_data_list(self):
+ with self.assertRaises(TypeError):
+ prepare_data([])
+
+ def test_prepare_data_none(self):
+ with self.assertRaises(TypeError):
+ prepare_data(None)
+
+
+class PrepareCtrlTests(unittest.TestCase):
+ def test_prepare_ctrl_str(self):
+ self.assertEqual(prepare_ctrl("café"), b"caf\xc3\xa9")
+
+ def test_prepare_ctrl_bytes(self):
+ self.assertEqual(prepare_ctrl(b"tea"), b"tea")
+
+ def test_prepare_ctrl_bytearray(self):
+ self.assertEqual(prepare_ctrl(bytearray(b"tea")), b"tea")
+
+ def test_prepare_ctrl_memoryview(self):
+ self.assertEqual(prepare_ctrl(memoryview(b"tea")), b"tea")
+
+ def test_prepare_ctrl_list(self):
+ with self.assertRaises(TypeError):
+ prepare_ctrl([])
+
+ def test_prepare_ctrl_none(self):
+ with self.assertRaises(TypeError):
+ prepare_ctrl(None)
+
+
+class ParseAndSerializeCloseTests(unittest.TestCase):
+ def assertCloseData(self, code, reason, data):
+ """
+ Serializing code / reason yields data. Parsing data yields code / reason.
+
+ """
+ serialized = serialize_close(code, reason)
+ self.assertEqual(serialized, data)
+ parsed = parse_close(data)
+ self.assertEqual(parsed, (code, reason))
+
+ def test_parse_close_and_serialize_close(self):
+ self.assertCloseData(1000, "", b"\x03\xe8")
+ self.assertCloseData(1000, "OK", b"\x03\xe8OK")
+
+ def test_parse_close_empty(self):
+ self.assertEqual(parse_close(b""), (1005, ""))
+
+ def test_parse_close_errors(self):
+ with self.assertRaises(ProtocolError):
+ parse_close(b"\x03")
+ with self.assertRaises(ProtocolError):
+ parse_close(b"\x03\xe7")
+ with self.assertRaises(UnicodeDecodeError):
+ parse_close(b"\x03\xe8\xff\xff")
+
+ def test_serialize_close_errors(self):
+ with self.assertRaises(ProtocolError):
+ serialize_close(999, "")
diff --git a/tests/test_framing.py b/tests/test_framing.py
deleted file mode 100644
index 9da64f14c..000000000
--- a/tests/test_framing.py
+++ /dev/null
@@ -1,207 +0,0 @@
-import asyncio
-import codecs
-import unittest
-import unittest.mock
-
-from websockets.exceptions import PayloadTooBig, WebSocketProtocolError
-from websockets.framing import *
-
-
-class FramingTests(unittest.TestCase):
- def setUp(self):
- self.loop = asyncio.new_event_loop()
- asyncio.set_event_loop(self.loop)
-
- def tearDown(self):
- self.loop.close()
-
- def decode(self, message, mask=False, max_size=None, extensions=None):
- self.stream = asyncio.StreamReader(loop=self.loop)
- self.stream.feed_data(message)
- self.stream.feed_eof()
- frame = self.loop.run_until_complete(
- Frame.read(
- self.stream.readexactly,
- mask=mask,
- max_size=max_size,
- extensions=extensions,
- )
- )
- # Make sure all the data was consumed.
- self.assertTrue(self.stream.at_eof())
- return frame
-
- def encode(self, frame, mask=False, extensions=None):
- writer = unittest.mock.Mock()
- frame.write(writer, mask=mask, extensions=extensions)
- # Ensure the entire frame is sent with a single call to writer().
- # Multiple calls cause TCP fragmentation and degrade performance.
- self.assertEqual(writer.call_count, 1)
- # The frame data is the single positional argument of that call.
- self.assertEqual(len(writer.call_args[0]), 1)
- self.assertEqual(len(writer.call_args[1]), 0)
- return writer.call_args[0][0]
-
- def round_trip(self, message, expected, mask=False, extensions=None):
- decoded = self.decode(message, mask, extensions=extensions)
- self.assertEqual(decoded, expected)
- encoded = self.encode(decoded, mask, extensions=extensions)
- if mask: # non-deterministic encoding
- decoded = self.decode(encoded, mask, extensions=extensions)
- self.assertEqual(decoded, expected)
- else: # deterministic encoding
- self.assertEqual(encoded, message)
-
- def round_trip_close(self, data, code, reason):
- parsed = parse_close(data)
- self.assertEqual(parsed, (code, reason))
- serialized = serialize_close(code, reason)
- self.assertEqual(serialized, data)
-
- def test_text(self):
- self.round_trip(b'\x81\x04Spam', Frame(True, OP_TEXT, b'Spam'))
-
- def test_text_masked(self):
- self.round_trip(
- b'\x81\x84\x5b\xfb\xe1\xa8\x08\x8b\x80\xc5',
- Frame(True, OP_TEXT, b'Spam'),
- mask=True,
- )
-
- def test_binary(self):
- self.round_trip(b'\x82\x04Eggs', Frame(True, OP_BINARY, b'Eggs'))
-
- def test_binary_masked(self):
- self.round_trip(
- b'\x82\x84\x53\xcd\xe2\x89\x16\xaa\x85\xfa',
- Frame(True, OP_BINARY, b'Eggs'),
- mask=True,
- )
-
- def test_non_ascii_text(self):
- self.round_trip(
- b'\x81\x05caf\xc3\xa9', Frame(True, OP_TEXT, 'café'.encode('utf-8'))
- )
-
- def test_non_ascii_text_masked(self):
- self.round_trip(
- b'\x81\x85\x64\xbe\xee\x7e\x07\xdf\x88\xbd\xcd',
- Frame(True, OP_TEXT, 'café'.encode('utf-8')),
- mask=True,
- )
-
- def test_close(self):
- self.round_trip(b'\x88\x00', Frame(True, OP_CLOSE, b''))
-
- def test_ping(self):
- self.round_trip(b'\x89\x04ping', Frame(True, OP_PING, b'ping'))
-
- def test_pong(self):
- self.round_trip(b'\x8a\x04pong', Frame(True, OP_PONG, b'pong'))
-
- def test_long(self):
- self.round_trip(
- b'\x82\x7e\x00\x7e' + 126 * b'a', Frame(True, OP_BINARY, 126 * b'a')
- )
-
- def test_very_long(self):
- self.round_trip(
- b'\x82\x7f\x00\x00\x00\x00\x00\x01\x00\x00' + 65536 * b'a',
- Frame(True, OP_BINARY, 65536 * b'a'),
- )
-
- def test_payload_too_big(self):
- with self.assertRaises(PayloadTooBig):
- self.decode(b'\x82\x7e\x04\x01' + 1025 * b'a', max_size=1024)
-
- def test_bad_reserved_bits(self):
- for encoded in [b'\xc0\x00', b'\xa0\x00', b'\x90\x00']:
- with self.subTest(encoded=encoded):
- with self.assertRaises(WebSocketProtocolError):
- self.decode(encoded)
-
- def test_good_opcode(self):
- for opcode in list(range(0x00, 0x03)) + list(range(0x08, 0x0B)):
- encoded = bytes([0x80 | opcode, 0])
- with self.subTest(encoded=encoded):
- self.decode(encoded) # does not raise an exception
-
- def test_bad_opcode(self):
- for opcode in list(range(0x03, 0x08)) + list(range(0x0B, 0x10)):
- encoded = bytes([0x80 | opcode, 0])
- with self.subTest(encoded=encoded):
- with self.assertRaises(WebSocketProtocolError):
- self.decode(encoded)
-
- def test_mask_flag(self):
- # Mask flag correctly set.
- self.decode(b'\x80\x80\x00\x00\x00\x00', mask=True)
- # Mask flag incorrectly unset.
- with self.assertRaises(WebSocketProtocolError):
- self.decode(b'\x80\x80\x00\x00\x00\x00')
- # Mask flag correctly unset.
- self.decode(b'\x80\x00')
- # Mask flag incorrectly set.
- with self.assertRaises(WebSocketProtocolError):
- self.decode(b'\x80\x00', mask=True)
-
- def test_control_frame_max_length(self):
- # At maximum allowed length.
- self.decode(b'\x88\x7e\x00\x7d' + 125 * b'a')
- # Above maximum allowed length.
- with self.assertRaises(WebSocketProtocolError):
- self.decode(b'\x88\x7e\x00\x7e' + 126 * b'a')
-
- def test_encode_data_str(self):
- self.assertEqual(encode_data('café'), b'caf\xc3\xa9')
-
- def test_encode_data_bytes(self):
- self.assertEqual(encode_data(b'tea'), b'tea')
-
- def test_encode_data_other(self):
- with self.assertRaises(TypeError):
- encode_data(None)
-
- def test_fragmented_control_frame(self):
- # Fin bit correctly set.
- self.decode(b'\x88\x00')
- # Fin bit incorrectly unset.
- with self.assertRaises(WebSocketProtocolError):
- self.decode(b'\x08\x00')
-
- def test_parse_close_and_serialize_close(self):
- self.round_trip_close(b'\x03\xe8', 1000, '')
- self.round_trip_close(b'\x03\xe8OK', 1000, 'OK')
-
- def test_parse_close_empty(self):
- self.assertEqual(parse_close(b''), (1005, ''))
-
- def test_parse_close_errors(self):
- with self.assertRaises(WebSocketProtocolError):
- parse_close(b'\x03')
- with self.assertRaises(WebSocketProtocolError):
- parse_close(b'\x03\xe7')
- with self.assertRaises(UnicodeDecodeError):
- parse_close(b'\x03\xe8\xff\xff')
-
- def test_serialize_close_errors(self):
- with self.assertRaises(WebSocketProtocolError):
- serialize_close(999, '')
-
- def test_extensions(self):
- class Rot13:
- @staticmethod
- def encode(frame):
- assert frame.opcode == OP_TEXT
- text = frame.data.decode()
- data = codecs.encode(text, 'rot13').encode()
- return frame._replace(data=data)
-
- # This extensions is symmetrical.
- @staticmethod
- def decode(frame, *, max_size=None):
- return Rot13.encode(frame)
-
- self.round_trip(
- b'\x81\x05uryyb', Frame(True, OP_TEXT, b'hello'), extensions=[Rot13()]
- )
diff --git a/tests/test_headers.py b/tests/test_headers.py
index 7d52b9f74..26d85fa5e 100644
--- a/tests/test_headers.py
+++ b/tests/test_headers.py
@@ -1,24 +1,23 @@
import unittest
-from websockets.exceptions import InvalidHeaderFormat
+from websockets.exceptions import InvalidHeaderFormat, InvalidHeaderValue
from websockets.headers import *
-from websockets.headers import build_basic_auth
class HeadersTests(unittest.TestCase):
def test_parse_connection(self):
for header, parsed in [
# Realistic use cases
- ('Upgrade', ['Upgrade']), # Safari, Chrome
- ('keep-alive, Upgrade', ['keep-alive', 'Upgrade']), # Firefox
+ ("Upgrade", ["Upgrade"]), # Safari, Chrome
+ ("keep-alive, Upgrade", ["keep-alive", "Upgrade"]), # Firefox
# Pathological example
- (',,\t, , ,Upgrade ,,', ['Upgrade']),
+ (",,\t, , ,Upgrade ,,", ["Upgrade"]),
]:
with self.subTest(header=header):
self.assertEqual(parse_connection(header), parsed)
- def test_parse_connection_invalid_header(self):
- for header in ['???', 'keep-alive; Upgrade']:
+ def test_parse_connection_invalid_header_format(self):
+ for header in ["???", "keep-alive; Upgrade"]:
with self.subTest(header=header):
with self.assertRaises(InvalidHeaderFormat):
parse_connection(header)
@@ -26,110 +25,161 @@ def test_parse_connection_invalid_header(self):
def test_parse_upgrade(self):
for header, parsed in [
# Realistic use case
- ('websocket', ['websocket']),
+ ("websocket", ["websocket"]),
# Synthetic example
- ('http/3.0, websocket', ['http/3.0', 'websocket']),
+ ("http/3.0, websocket", ["http/3.0", "websocket"]),
# Pathological example
- (',, WebSocket, \t,,', ['WebSocket']),
+ (",, WebSocket, \t,,", ["WebSocket"]),
]:
with self.subTest(header=header):
self.assertEqual(parse_upgrade(header), parsed)
- def test_parse_upgrade_invalid_header(self):
- for header in ['???', 'websocket 2', 'http/3.0; websocket']:
+ def test_parse_upgrade_invalid_header_format(self):
+ for header in ["???", "websocket 2", "http/3.0; websocket"]:
with self.subTest(header=header):
with self.assertRaises(InvalidHeaderFormat):
parse_upgrade(header)
- def test_parse_extension_list(self):
+ def test_parse_extension(self):
for header, parsed in [
# Synthetic examples
- ('foo', [('foo', [])]),
- ('foo, bar', [('foo', []), ('bar', [])]),
+ ("foo", [("foo", [])]),
+ ("foo, bar", [("foo", []), ("bar", [])]),
(
'foo; name; token=token; quoted-string="quoted-string", '
- 'bar; quux; quuux',
+ "bar; quux; quuux",
[
(
- 'foo',
+ "foo",
[
- ('name', None),
- ('token', 'token'),
- ('quoted-string', 'quoted-string'),
+ ("name", None),
+ ("token", "token"),
+ ("quoted-string", "quoted-string"),
],
),
- ('bar', [('quux', None), ('quuux', None)]),
+ ("bar", [("quux", None), ("quuux", None)]),
],
),
# Pathological example
(
- ',\t, , ,foo ;bar = 42,, baz,,',
- [('foo', [('bar', '42')]), ('baz', [])],
+ ",\t, , ,foo ;bar = 42,, baz,,",
+ [("foo", [("bar", "42")]), ("baz", [])],
),
# Realistic use cases for permessage-deflate
- ('permessage-deflate', [('permessage-deflate', [])]),
+ ("permessage-deflate", [("permessage-deflate", [])]),
(
- 'permessage-deflate; client_max_window_bits',
- [('permessage-deflate', [('client_max_window_bits', None)])],
+ "permessage-deflate; client_max_window_bits",
+ [("permessage-deflate", [("client_max_window_bits", None)])],
),
(
- 'permessage-deflate; server_max_window_bits=10',
- [('permessage-deflate', [('server_max_window_bits', '10')])],
+ "permessage-deflate; server_max_window_bits=10",
+ [("permessage-deflate", [("server_max_window_bits", "10")])],
),
]:
with self.subTest(header=header):
- self.assertEqual(parse_extension_list(header), parsed)
- # Also ensure that build_extension_list round-trips cleanly.
- unparsed = build_extension_list(parsed)
- self.assertEqual(parse_extension_list(unparsed), parsed)
+ self.assertEqual(parse_extension(header), parsed)
+ # Also ensure that build_extension round-trips cleanly.
+ unparsed = build_extension(parsed)
+ self.assertEqual(parse_extension(unparsed), parsed)
- def test_parse_extension_list_invalid_header(self):
+ def test_parse_extension_invalid_header_format(self):
for header in [
# Truncated examples
- '',
- ',\t,',
- 'foo;',
- 'foo; bar;',
- 'foo; bar=',
+ "",
+ ",\t,",
+ "foo;",
+ "foo; bar;",
+ "foo; bar=",
'foo; bar="baz',
# Wrong delimiter
- 'foo, bar, baz=quux; quuux',
+ "foo, bar, baz=quux; quuux",
# Value in quoted string parameter that isn't a token
'foo; bar=" "',
]:
with self.subTest(header=header):
with self.assertRaises(InvalidHeaderFormat):
- parse_extension_list(header)
+ parse_extension(header)
- def test_parse_subprotocol_list(self):
+ def test_parse_subprotocol(self):
for header, parsed in [
# Synthetic examples
- ('foo', ['foo']),
- ('foo, bar', ['foo', 'bar']),
+ ("foo", ["foo"]),
+ ("foo, bar", ["foo", "bar"]),
# Pathological example
- (',\t, , ,foo ,, bar,baz,,', ['foo', 'bar', 'baz']),
+ (",\t, , ,foo ,, bar,baz,,", ["foo", "bar", "baz"]),
]:
with self.subTest(header=header):
- self.assertEqual(parse_subprotocol_list(header), parsed)
- # Also ensure that build_subprotocol_list round-trips cleanly.
- unparsed = build_subprotocol_list(parsed)
- self.assertEqual(parse_subprotocol_list(unparsed), parsed)
+ self.assertEqual(parse_subprotocol(header), parsed)
+ # Also ensure that build_subprotocol round-trips cleanly.
+ unparsed = build_subprotocol(parsed)
+ self.assertEqual(parse_subprotocol(unparsed), parsed)
- def test_parse_subprotocol_list_invalid_header(self):
+ def test_parse_subprotocol_invalid_header(self):
for header in [
# Truncated examples
- '',
- ',\t,'
+ "",
+ ",\t,"
# Wrong delimiter
- 'foo; bar',
+ "foo; bar",
]:
with self.subTest(header=header):
with self.assertRaises(InvalidHeaderFormat):
- parse_subprotocol_list(header)
+ parse_subprotocol(header)
- def test_build_basic_auth(self):
- # Test vector from RFC 7617.
+ def test_build_www_authenticate_basic(self):
+ # Test vector from RFC 7617
self.assertEqual(
- build_basic_auth("Aladdin", "open sesame"),
- 'Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==',
+ build_www_authenticate_basic("foo"), 'Basic realm="foo", charset="UTF-8"'
)
+
+ def test_build_www_authenticate_basic_invalid_realm(self):
+ # Realm contains a control character forbidden in quoted-string encoding
+ with self.assertRaises(ValueError):
+ build_www_authenticate_basic("\u0007")
+
+ def test_build_authorization_basic(self):
+ # Test vector from RFC 7617
+ self.assertEqual(
+ build_authorization_basic("Aladdin", "open sesame"),
+ "Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==",
+ )
+
+ def test_build_authorization_basic_utf8(self):
+ # Test vector from RFC 7617
+ self.assertEqual(
+ build_authorization_basic("test", "123£"), "Basic dGVzdDoxMjPCow=="
+ )
+
+ def test_parse_authorization_basic(self):
+ for header, parsed in [
+ ("Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==", ("Aladdin", "open sesame")),
+ # Password contains non-ASCII character
+ ("Basic dGVzdDoxMjPCow==", ("test", "123£")),
+ # Password contains a colon
+ ("Basic YWxhZGRpbjpvcGVuOnNlc2FtZQ==", ("aladdin", "open:sesame")),
+ # Scheme name must be case insensitive
+ ("basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==", ("Aladdin", "open sesame")),
+ ]:
+ with self.subTest(header=header):
+ self.assertEqual(parse_authorization_basic(header), parsed)
+
+ def test_parse_authorization_basic_invalid_header_format(self):
+ for header in [
+ "// Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==",
+ "Basic\tQWxhZGRpbjpvcGVuIHNlc2FtZQ==",
+ "Basic ****************************",
+ "Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ== //",
+ ]:
+ with self.subTest(header=header):
+ with self.assertRaises(InvalidHeaderFormat):
+ parse_authorization_basic(header)
+
+ def test_parse_authorization_basic_invalid_header_value(self):
+ for header in [
+ "Digest ...",
+ "Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ",
+ "Basic QWxhZGNlc2FtZQ==",
+ ]:
+ with self.subTest(header=header):
+ with self.assertRaises(InvalidHeaderValue):
+ parse_authorization_basic(header)
diff --git a/tests/test_http.py b/tests/test_http.py
index b18e24a26..ca7c1c0a4 100644
--- a/tests/test_http.py
+++ b/tests/test_http.py
@@ -1,211 +1,27 @@
-import asyncio
import unittest
from websockets.http import *
-from websockets.http import read_headers
-class HTTPAsyncTests(unittest.TestCase):
- def setUp(self):
- super().setUp()
- self.loop = asyncio.new_event_loop()
- asyncio.set_event_loop(self.loop)
- self.stream = asyncio.StreamReader(loop=self.loop)
-
- def tearDown(self):
- self.loop.close()
- super().tearDown()
-
- def test_read_request(self):
- # Example from the protocol overview in RFC 6455
- self.stream.feed_data(
- b'GET /chat HTTP/1.1\r\n'
- b'Host: server.example.com\r\n'
- b'Upgrade: websocket\r\n'
- b'Connection: Upgrade\r\n'
- b'Sec-WebSocket-Key: dGhlIHNhbXBsZSBub25jZQ==\r\n'
- b'Origin: http://example.com\r\n'
- b'Sec-WebSocket-Protocol: chat, superchat\r\n'
- b'Sec-WebSocket-Version: 13\r\n'
- b'\r\n'
- )
- path, headers = self.loop.run_until_complete(read_request(self.stream))
- self.assertEqual(path, '/chat')
- self.assertEqual(headers['Upgrade'], 'websocket')
-
- def test_read_response(self):
- # Example from the protocol overview in RFC 6455
- self.stream.feed_data(
- b'HTTP/1.1 101 Switching Protocols\r\n'
- b'Upgrade: websocket\r\n'
- b'Connection: Upgrade\r\n'
- b'Sec-WebSocket-Accept: s3pPLMBiTxaQ9kYGzzhZRbK+xOo=\r\n'
- b'Sec-WebSocket-Protocol: chat\r\n'
- b'\r\n'
- )
- status_code, headers = self.loop.run_until_complete(read_response(self.stream))
- self.assertEqual(status_code, 101)
- self.assertEqual(headers['Upgrade'], 'websocket')
-
- def test_request_method(self):
- self.stream.feed_data(b'OPTIONS * HTTP/1.1\r\n\r\n')
- with self.assertRaises(ValueError):
- self.loop.run_until_complete(read_request(self.stream))
-
- def test_request_version(self):
- self.stream.feed_data(b'GET /chat HTTP/1.0\r\n\r\n')
- with self.assertRaises(ValueError):
- self.loop.run_until_complete(read_request(self.stream))
-
- def test_response_version(self):
- self.stream.feed_data(b'HTTP/1.0 400 Bad Request\r\n\r\n')
- with self.assertRaises(ValueError):
- self.loop.run_until_complete(read_response(self.stream))
-
- def test_response_status(self):
- self.stream.feed_data(b'HTTP/1.1 007 My name is Bond\r\n\r\n')
- with self.assertRaises(ValueError):
- self.loop.run_until_complete(read_response(self.stream))
-
- def test_response_reason(self):
- self.stream.feed_data(b'HTTP/1.1 200 \x7f\r\n\r\n')
- with self.assertRaises(ValueError):
- self.loop.run_until_complete(read_response(self.stream))
-
- def test_header_name(self):
- self.stream.feed_data(b'foo bar: baz qux\r\n\r\n')
- with self.assertRaises(ValueError):
- self.loop.run_until_complete(read_headers(self.stream))
-
- def test_header_value(self):
- self.stream.feed_data(b'foo: \x00\x00\x0f\r\n\r\n')
- with self.assertRaises(ValueError):
- self.loop.run_until_complete(read_headers(self.stream))
-
- def test_headers_limit(self):
- self.stream.feed_data(b'foo: bar\r\n' * 257 + b'\r\n')
- with self.assertRaises(ValueError):
- self.loop.run_until_complete(read_headers(self.stream))
-
- def test_line_limit(self):
- # Header line contains 5 + 4090 + 2 = 4097 bytes.
- self.stream.feed_data(b'foo: ' + b'a' * 4090 + b'\r\n\r\n')
- with self.assertRaises(ValueError):
- self.loop.run_until_complete(read_headers(self.stream))
-
- def test_line_ending(self):
- self.stream.feed_data(b'foo: bar\n\n')
- with self.assertRaises(ValueError):
- self.loop.run_until_complete(read_headers(self.stream))
-
-
-class HeadersTests(unittest.TestCase):
- def setUp(self):
- self.headers = Headers([('Connection', 'Upgrade'), ('Server', USER_AGENT)])
-
- def test_str(self):
- self.assertEqual(
- str(self.headers),
- "Connection: Upgrade\r\nServer: {}\r\n\r\n".format(USER_AGENT),
- )
-
- def test_repr(self):
- self.assertEqual(
- repr(self.headers),
- "Headers([('Connection', 'Upgrade'), "
- "('Server', '{}')])".format(USER_AGENT),
- )
-
- def test_multiple_values_error_str(self):
- self.assertEqual(str(MultipleValuesError('Connection')), "'Connection'")
- self.assertEqual(str(MultipleValuesError()), "")
-
- def test_contains(self):
- self.assertIn('Server', self.headers)
-
- def test_contains_case_insensitive(self):
- self.assertIn('server', self.headers)
-
- def test_contains_not_found(self):
- self.assertNotIn('Date', self.headers)
-
- def test_iter(self):
- self.assertEqual(set(iter(self.headers)), {'connection', 'server'})
-
- def test_len(self):
- self.assertEqual(len(self.headers), 2)
-
- def test_getitem(self):
- self.assertEqual(self.headers['Server'], USER_AGENT)
-
- def test_getitem_case_insensitive(self):
- self.assertEqual(self.headers['server'], USER_AGENT)
-
- def test_getitem_key_error(self):
- with self.assertRaises(KeyError):
- self.headers['Upgrade']
-
- def test_getitem_multiple_values_error(self):
- self.headers['Server'] = '2'
- with self.assertRaises(MultipleValuesError):
- self.headers['Server']
-
- def test_setitem(self):
- self.headers['Upgrade'] = 'websocket'
- self.assertEqual(self.headers['Upgrade'], 'websocket')
-
- def test_setitem_case_insensitive(self):
- self.headers['upgrade'] = 'websocket'
- self.assertEqual(self.headers['Upgrade'], 'websocket')
-
- def test_setitem_multiple_values(self):
- self.headers['Connection'] = 'close'
- with self.assertRaises(MultipleValuesError):
- self.headers['Connection']
-
- def test_delitem(self):
- del self.headers['Connection']
- with self.assertRaises(KeyError):
- self.headers['Connection']
-
- def test_delitem_case_insensitive(self):
- del self.headers['connection']
- with self.assertRaises(KeyError):
- self.headers['Connection']
-
- def test_delitem_multiple_values(self):
- self.headers['Connection'] = 'close'
- del self.headers['Connection']
- with self.assertRaises(KeyError):
- self.headers['Connection']
-
- def test_eq(self):
- other_headers = self.headers.copy()
- self.assertEqual(self.headers, other_headers)
-
- def test_eq_not_equal(self):
- self.assertNotEqual(self.headers, [])
-
- def test_clear(self):
- self.headers.clear()
- self.assertFalse(self.headers)
- self.assertEqual(self.headers, Headers())
-
- def test_get_all(self):
- self.assertEqual(self.headers.get_all('Connection'), ['Upgrade'])
-
- def test_get_all_case_insensitive(self):
- self.assertEqual(self.headers.get_all('connection'), ['Upgrade'])
-
- def test_get_all_no_values(self):
- self.assertEqual(self.headers.get_all('Upgrade'), [])
-
- def test_get_all_multiple_values(self):
- self.headers['Connection'] = 'close'
- self.assertEqual(self.headers.get_all('Connection'), ['Upgrade', 'close'])
-
- def test_raw_items(self):
- self.assertEqual(
- list(self.headers.raw_items()),
- [('Connection', 'Upgrade'), ('Server', USER_AGENT)],
- )
+class HTTPTests(unittest.TestCase):
+ def test_build_host(self):
+ for (host, port, secure), result in [
+ (("localhost", 80, False), "localhost"),
+ (("localhost", 8000, False), "localhost:8000"),
+ (("localhost", 443, True), "localhost"),
+ (("localhost", 8443, True), "localhost:8443"),
+ (("example.com", 80, False), "example.com"),
+ (("example.com", 8000, False), "example.com:8000"),
+ (("example.com", 443, True), "example.com"),
+ (("example.com", 8443, True), "example.com:8443"),
+ (("127.0.0.1", 80, False), "127.0.0.1"),
+ (("127.0.0.1", 8000, False), "127.0.0.1:8000"),
+ (("127.0.0.1", 443, True), "127.0.0.1"),
+ (("127.0.0.1", 8443, True), "127.0.0.1:8443"),
+ (("::1", 80, False), "[::1]"),
+ (("::1", 8000, False), "[::1]:8000"),
+ (("::1", 443, True), "[::1]"),
+ (("::1", 8443, True), "[::1]:8443"),
+ ]:
+ with self.subTest(host=host, port=port, secure=secure):
+ self.assertEqual(build_host(host, port, secure), result)
diff --git a/tests/test_http11.py b/tests/test_http11.py
new file mode 100644
index 000000000..1cca2053f
--- /dev/null
+++ b/tests/test_http11.py
@@ -0,0 +1,305 @@
+from websockets.datastructures import Headers
+from websockets.exceptions import SecurityError
+from websockets.http11 import *
+from websockets.http11 import parse_headers
+from websockets.streams import StreamReader
+
+from .utils import GeneratorTestCase
+
+
+class RequestTests(GeneratorTestCase):
+ def setUp(self):
+ super().setUp()
+ self.reader = StreamReader()
+
+ def parse(self):
+ return Request.parse(self.reader.read_line)
+
+ def test_parse(self):
+ # Example from the protocol overview in RFC 6455
+ self.reader.feed_data(
+ b"GET /chat HTTP/1.1\r\n"
+ b"Host: server.example.com\r\n"
+ b"Upgrade: websocket\r\n"
+ b"Connection: Upgrade\r\n"
+ b"Sec-WebSocket-Key: dGhlIHNhbXBsZSBub25jZQ==\r\n"
+ b"Origin: http://example.com\r\n"
+ b"Sec-WebSocket-Protocol: chat, superchat\r\n"
+ b"Sec-WebSocket-Version: 13\r\n"
+ b"\r\n"
+ )
+ request = self.assertGeneratorReturns(self.parse())
+ self.assertEqual(request.path, "/chat")
+ self.assertEqual(request.headers["Upgrade"], "websocket")
+
+ def test_parse_empty(self):
+ self.reader.feed_eof()
+ with self.assertRaises(EOFError) as raised:
+ next(self.parse())
+ self.assertEqual(
+ str(raised.exception),
+ "connection closed while reading HTTP request line",
+ )
+
+ def test_parse_invalid_request_line(self):
+ self.reader.feed_data(b"GET /\r\n\r\n")
+ with self.assertRaises(ValueError) as raised:
+ next(self.parse())
+ self.assertEqual(
+ str(raised.exception),
+ "invalid HTTP request line: GET /",
+ )
+
+ def test_parse_unsupported_method(self):
+ self.reader.feed_data(b"OPTIONS * HTTP/1.1\r\n\r\n")
+ with self.assertRaises(ValueError) as raised:
+ next(self.parse())
+ self.assertEqual(
+ str(raised.exception),
+ "unsupported HTTP method: OPTIONS",
+ )
+
+ def test_parse_unsupported_version(self):
+ self.reader.feed_data(b"GET /chat HTTP/1.0\r\n\r\n")
+ with self.assertRaises(ValueError) as raised:
+ next(self.parse())
+ self.assertEqual(
+ str(raised.exception),
+ "unsupported HTTP version: HTTP/1.0",
+ )
+
+ def test_parse_invalid_header(self):
+ self.reader.feed_data(b"GET /chat HTTP/1.1\r\nOops\r\n")
+ with self.assertRaises(ValueError) as raised:
+ next(self.parse())
+ self.assertEqual(
+ str(raised.exception),
+ "invalid HTTP header line: Oops",
+ )
+
+ def test_serialize(self):
+ # Example from the protocol overview in RFC 6455
+ request = Request(
+ "/chat",
+ Headers(
+ [
+ ("Host", "server.example.com"),
+ ("Upgrade", "websocket"),
+ ("Connection", "Upgrade"),
+ ("Sec-WebSocket-Key", "dGhlIHNhbXBsZSBub25jZQ=="),
+ ("Origin", "http://example.com"),
+ ("Sec-WebSocket-Protocol", "chat, superchat"),
+ ("Sec-WebSocket-Version", "13"),
+ ]
+ ),
+ )
+ self.assertEqual(
+ request.serialize(),
+ b"GET /chat HTTP/1.1\r\n"
+ b"Host: server.example.com\r\n"
+ b"Upgrade: websocket\r\n"
+ b"Connection: Upgrade\r\n"
+ b"Sec-WebSocket-Key: dGhlIHNhbXBsZSBub25jZQ==\r\n"
+ b"Origin: http://example.com\r\n"
+ b"Sec-WebSocket-Protocol: chat, superchat\r\n"
+ b"Sec-WebSocket-Version: 13\r\n"
+ b"\r\n",
+ )
+
+
+class ResponseTests(GeneratorTestCase):
+ def setUp(self):
+ super().setUp()
+ self.reader = StreamReader()
+
+ def parse(self):
+ return Response.parse(
+ self.reader.read_line, self.reader.read_exact, self.reader.read_to_eof
+ )
+
+ def test_parse(self):
+ # Example from the protocol overview in RFC 6455
+ self.reader.feed_data(
+ b"HTTP/1.1 101 Switching Protocols\r\n"
+ b"Upgrade: websocket\r\n"
+ b"Connection: Upgrade\r\n"
+ b"Sec-WebSocket-Accept: s3pPLMBiTxaQ9kYGzzhZRbK+xOo=\r\n"
+ b"Sec-WebSocket-Protocol: chat\r\n"
+ b"\r\n"
+ )
+ response = self.assertGeneratorReturns(self.parse())
+ self.assertEqual(response.status_code, 101)
+ self.assertEqual(response.reason_phrase, "Switching Protocols")
+ self.assertEqual(response.headers["Upgrade"], "websocket")
+ self.assertIsNone(response.body)
+
+ def test_parse_empty(self):
+ self.reader.feed_eof()
+ with self.assertRaises(EOFError) as raised:
+ next(self.parse())
+ self.assertEqual(
+ str(raised.exception), "connection closed while reading HTTP status line"
+ )
+
+ def test_parse_invalid_status_line(self):
+ self.reader.feed_data(b"Hello!\r\n")
+ with self.assertRaises(ValueError) as raised:
+ next(self.parse())
+ self.assertEqual(
+ str(raised.exception),
+ "invalid HTTP status line: Hello!",
+ )
+
+ def test_parse_unsupported_version(self):
+ self.reader.feed_data(b"HTTP/1.0 400 Bad Request\r\n\r\n")
+ with self.assertRaises(ValueError) as raised:
+ next(self.parse())
+ self.assertEqual(
+ str(raised.exception),
+ "unsupported HTTP version: HTTP/1.0",
+ )
+
+ def test_parse_invalid_status(self):
+ self.reader.feed_data(b"HTTP/1.1 OMG WTF\r\n\r\n")
+ with self.assertRaises(ValueError) as raised:
+ next(self.parse())
+ self.assertEqual(
+ str(raised.exception),
+ "invalid HTTP status code: OMG",
+ )
+
+ def test_parse_unsupported_status(self):
+ self.reader.feed_data(b"HTTP/1.1 007 My name is Bond\r\n\r\n")
+ with self.assertRaises(ValueError) as raised:
+ next(self.parse())
+ self.assertEqual(
+ str(raised.exception),
+ "unsupported HTTP status code: 007",
+ )
+
+ def test_parse_invalid_reason(self):
+ self.reader.feed_data(b"HTTP/1.1 200 \x7f\r\n\r\n")
+ with self.assertRaises(ValueError) as raised:
+ next(self.parse())
+ self.assertEqual(
+ str(raised.exception),
+ "invalid HTTP reason phrase: \x7f",
+ )
+
+ def test_parse_invalid_header(self):
+ self.reader.feed_data(b"HTTP/1.1 500 Internal Server Error\r\nOops\r\n")
+ with self.assertRaises(ValueError) as raised:
+ next(self.parse())
+ self.assertEqual(
+ str(raised.exception),
+ "invalid HTTP header line: Oops",
+ )
+
+ def test_parse_body_with_content_length(self):
+ self.reader.feed_data(
+ b"HTTP/1.1 200 OK\r\nContent-Length: 13\r\n\r\nHello world!\n"
+ )
+ response = self.assertGeneratorReturns(self.parse())
+ self.assertEqual(response.body, b"Hello world!\n")
+
+ def test_parse_body_without_content_length(self):
+ self.reader.feed_data(b"HTTP/1.1 200 OK\r\n\r\nHello world!\n")
+ gen = self.parse()
+ self.assertGeneratorRunning(gen)
+ self.reader.feed_eof()
+ response = self.assertGeneratorReturns(gen)
+ self.assertEqual(response.body, b"Hello world!\n")
+
+ def test_parse_body_with_transfer_encoding(self):
+ self.reader.feed_data(b"HTTP/1.1 200 OK\r\nTransfer-Encoding: chunked\r\n\r\n")
+ with self.assertRaises(NotImplementedError) as raised:
+ next(self.parse())
+ self.assertEqual(
+ str(raised.exception),
+ "transfer codings aren't supported",
+ )
+
+ def test_parse_body_no_content(self):
+ self.reader.feed_data(b"HTTP/1.1 204 No Content\r\n\r\n")
+ response = self.assertGeneratorReturns(self.parse())
+ self.assertIsNone(response.body)
+
+ def test_parse_body_not_modified(self):
+ self.reader.feed_data(b"HTTP/1.1 304 Not Modified\r\n\r\n")
+ response = self.assertGeneratorReturns(self.parse())
+ self.assertIsNone(response.body)
+
+ def test_serialize(self):
+ # Example from the protocol overview in RFC 6455
+ response = Response(
+ 101,
+ "Switching Protocols",
+ Headers(
+ [
+ ("Upgrade", "websocket"),
+ ("Connection", "Upgrade"),
+ ("Sec-WebSocket-Accept", "s3pPLMBiTxaQ9kYGzzhZRbK+xOo="),
+ ("Sec-WebSocket-Protocol", "chat"),
+ ]
+ ),
+ )
+ self.assertEqual(
+ response.serialize(),
+ b"HTTP/1.1 101 Switching Protocols\r\n"
+ b"Upgrade: websocket\r\n"
+ b"Connection: Upgrade\r\n"
+ b"Sec-WebSocket-Accept: s3pPLMBiTxaQ9kYGzzhZRbK+xOo=\r\n"
+ b"Sec-WebSocket-Protocol: chat\r\n"
+ b"\r\n",
+ )
+
+ def test_serialize_with_body(self):
+ response = Response(
+ 200,
+ "OK",
+ Headers([("Content-Length", "13"), ("Content-Type", "text/plain")]),
+ b"Hello world!\n",
+ )
+ self.assertEqual(
+ response.serialize(),
+ b"HTTP/1.1 200 OK\r\n"
+ b"Content-Length: 13\r\n"
+ b"Content-Type: text/plain\r\n"
+ b"\r\n"
+ b"Hello world!\n",
+ )
+
+
+class HeadersTests(GeneratorTestCase):
+ def setUp(self):
+ super().setUp()
+ self.reader = StreamReader()
+
+ def parse_headers(self):
+ return parse_headers(self.reader.read_line)
+
+ def test_parse_invalid_name(self):
+ self.reader.feed_data(b"foo bar: baz qux\r\n\r\n")
+ with self.assertRaises(ValueError):
+ next(self.parse_headers())
+
+ def test_parse_invalid_value(self):
+ self.reader.feed_data(b"foo: \x00\x00\x0f\r\n\r\n")
+ with self.assertRaises(ValueError):
+ next(self.parse_headers())
+
+ def test_parse_too_long_value(self):
+ self.reader.feed_data(b"foo: bar\r\n" * 257 + b"\r\n")
+ with self.assertRaises(SecurityError):
+ next(self.parse_headers())
+
+ def test_parse_too_long_line(self):
+ # Header line contains 5 + 4104 + 2 = 4111 bytes.
+ self.reader.feed_data(b"foo: " + b"a" * 4104 + b"\r\n\r\n")
+ with self.assertRaises(SecurityError):
+ next(self.parse_headers())
+
+ def test_parse_invalid_line_ending(self):
+ self.reader.feed_data(b"foo: bar\n\n")
+ with self.assertRaises(EOFError):
+ next(self.parse_headers())
diff --git a/tests/test_imports.py b/tests/test_imports.py
new file mode 100644
index 000000000..d84808902
--- /dev/null
+++ b/tests/test_imports.py
@@ -0,0 +1,68 @@
+import sys
+import types
+import unittest
+import warnings
+
+from websockets.imports import *
+
+
+foo = object()
+
+bar = object()
+
+
+class ImportsTests(unittest.TestCase):
+ def setUp(self):
+ self.mod = types.ModuleType("tests.test_imports.test_alias")
+ self.mod.__package__ = self.mod.__name__
+
+ def test_get_alias(self):
+ lazy_import(
+ vars(self.mod),
+ aliases={"foo": "...test_imports"},
+ )
+
+ self.assertEqual(self.mod.foo, foo)
+
+ def test_get_deprecated_alias(self):
+ lazy_import(
+ vars(self.mod),
+ deprecated_aliases={"bar": "...test_imports"},
+ )
+
+ with warnings.catch_warnings(record=True) as recorded_warnings:
+ self.assertEqual(self.mod.bar, bar)
+
+ # No warnings raised on pre-PEP 526 Python.
+ if sys.version_info[:2] < (3, 7): # pragma: no cover
+ return
+
+ self.assertEqual(len(recorded_warnings), 1)
+ warning = recorded_warnings[0].message
+ self.assertEqual(
+ str(warning), "tests.test_imports.test_alias.bar is deprecated"
+ )
+ self.assertEqual(type(warning), DeprecationWarning)
+
+ def test_dir(self):
+ lazy_import(
+ vars(self.mod),
+ aliases={"foo": "...test_imports"},
+ deprecated_aliases={"bar": "...test_imports"},
+ )
+
+ self.assertEqual(
+ [item for item in dir(self.mod) if not item[:2] == item[-2:] == "__"],
+ ["bar", "foo"],
+ )
+
+ def test_attribute_error(self):
+ lazy_import(vars(self.mod))
+
+ with self.assertRaises(AttributeError) as raised:
+ self.mod.foo
+
+ self.assertEqual(
+ str(raised.exception),
+ "module 'tests.test_imports.test_alias' has no attribute 'foo'",
+ )
diff --git a/tests/test_server.py b/tests/test_server.py
new file mode 100644
index 000000000..ad56a37bc
--- /dev/null
+++ b/tests/test_server.py
@@ -0,0 +1,627 @@
+import http
+import unittest
+import unittest.mock
+
+from websockets.connection import CONNECTING, OPEN
+from websockets.datastructures import Headers
+from websockets.exceptions import InvalidHeader, InvalidOrigin, InvalidUpgrade
+from websockets.http import USER_AGENT
+from websockets.http11 import Request, Response
+from websockets.server import *
+
+from .extensions.utils import (
+ OpExtension,
+ Rsv2Extension,
+ ServerOpExtensionFactory,
+ ServerRsv2ExtensionFactory,
+)
+from .test_utils import ACCEPT, KEY
+from .utils import DATE
+
+
+class ConnectTests(unittest.TestCase):
+ def test_receive_connect(self):
+ server = ServerConnection()
+ server.receive_data(
+ (
+ f"GET /test HTTP/1.1\r\n"
+ f"Host: example.com\r\n"
+ f"Upgrade: websocket\r\n"
+ f"Connection: Upgrade\r\n"
+ f"Sec-WebSocket-Key: {KEY}\r\n"
+ f"Sec-WebSocket-Version: 13\r\n"
+ f"User-Agent: {USER_AGENT}\r\n"
+ f"\r\n"
+ ).encode(),
+ )
+ [request] = server.events_received()
+ self.assertIsInstance(request, Request)
+
+ def test_connect_request(self):
+ server = ServerConnection()
+ server.receive_data(
+ (
+ f"GET /test HTTP/1.1\r\n"
+ f"Host: example.com\r\n"
+ f"Upgrade: websocket\r\n"
+ f"Connection: Upgrade\r\n"
+ f"Sec-WebSocket-Key: {KEY}\r\n"
+ f"Sec-WebSocket-Version: 13\r\n"
+ f"User-Agent: {USER_AGENT}\r\n"
+ f"\r\n"
+ ).encode(),
+ )
+ [request] = server.events_received()
+ self.assertEqual(request.path, "/test")
+ self.assertEqual(
+ request.headers,
+ Headers(
+ {
+ "Host": "example.com",
+ "Upgrade": "websocket",
+ "Connection": "Upgrade",
+ "Sec-WebSocket-Key": KEY,
+ "Sec-WebSocket-Version": "13",
+ "User-Agent": USER_AGENT,
+ }
+ ),
+ )
+
+
+class AcceptRejectTests(unittest.TestCase):
+ def make_request(self):
+ return Request(
+ path="/test",
+ headers=Headers(
+ {
+ "Host": "example.com",
+ "Upgrade": "websocket",
+ "Connection": "Upgrade",
+ "Sec-WebSocket-Key": KEY,
+ "Sec-WebSocket-Version": "13",
+ "User-Agent": USER_AGENT,
+ }
+ ),
+ )
+
+ def test_send_accept(self):
+ server = ServerConnection()
+ with unittest.mock.patch("email.utils.formatdate", return_value=DATE):
+ response = server.accept(self.make_request())
+ self.assertIsInstance(response, Response)
+ server.send_response(response)
+ self.assertEqual(
+ server.data_to_send(),
+ [
+ f"HTTP/1.1 101 Switching Protocols\r\n"
+ f"Upgrade: websocket\r\n"
+ f"Connection: Upgrade\r\n"
+ f"Sec-WebSocket-Accept: {ACCEPT}\r\n"
+ f"Date: {DATE}\r\n"
+ f"Server: {USER_AGENT}\r\n"
+ f"\r\n".encode()
+ ],
+ )
+ self.assertEqual(server.state, OPEN)
+
+ def test_send_reject(self):
+ server = ServerConnection()
+ with unittest.mock.patch("email.utils.formatdate", return_value=DATE):
+ response = server.reject(http.HTTPStatus.NOT_FOUND, "Sorry folks.\n")
+ self.assertIsInstance(response, Response)
+ server.send_response(response)
+ self.assertEqual(
+ server.data_to_send(),
+ [
+ f"HTTP/1.1 404 Not Found\r\n"
+ f"Date: {DATE}\r\n"
+ f"Server: {USER_AGENT}\r\n"
+ f"Content-Length: 13\r\n"
+ f"Content-Type: text/plain; charset=utf-8\r\n"
+ f"Connection: close\r\n"
+ f"\r\n"
+ f"Sorry folks.\n".encode()
+ ],
+ )
+ self.assertEqual(server.state, CONNECTING)
+
+ def test_accept_response(self):
+ server = ServerConnection()
+ with unittest.mock.patch("email.utils.formatdate", return_value=DATE):
+ response = server.accept(self.make_request())
+ self.assertIsInstance(response, Response)
+ self.assertEqual(response.status_code, 101)
+ self.assertEqual(response.reason_phrase, "Switching Protocols")
+ self.assertEqual(
+ response.headers,
+ Headers(
+ {
+ "Upgrade": "websocket",
+ "Connection": "Upgrade",
+ "Sec-WebSocket-Accept": ACCEPT,
+ "Date": DATE,
+ "Server": USER_AGENT,
+ }
+ ),
+ )
+ self.assertIsNone(response.body)
+
+ def test_reject_response(self):
+ server = ServerConnection()
+ with unittest.mock.patch("email.utils.formatdate", return_value=DATE):
+ response = server.reject(http.HTTPStatus.NOT_FOUND, "Sorry folks.\n")
+ self.assertIsInstance(response, Response)
+ self.assertEqual(response.status_code, 404)
+ self.assertEqual(response.reason_phrase, "Not Found")
+ self.assertEqual(
+ response.headers,
+ Headers(
+ {
+ "Date": DATE,
+ "Server": USER_AGENT,
+ "Content-Length": "13",
+ "Content-Type": "text/plain; charset=utf-8",
+ "Connection": "close",
+ }
+ ),
+ )
+ self.assertEqual(response.body, b"Sorry folks.\n")
+
+ def test_basic(self):
+ server = ServerConnection()
+ request = self.make_request()
+ response = server.accept(request)
+
+ self.assertEqual(response.status_code, 101)
+
+ def test_unexpected_exception(self):
+ server = ServerConnection()
+ request = self.make_request()
+ with unittest.mock.patch(
+ "websockets.server.ServerConnection.process_request",
+ side_effect=Exception("BOOM"),
+ ):
+ response = server.accept(request)
+
+ self.assertEqual(response.status_code, 500)
+ with self.assertRaises(Exception) as raised:
+ raise response.exception
+ self.assertEqual(str(raised.exception), "BOOM")
+
+ def test_missing_connection(self):
+ server = ServerConnection()
+ request = self.make_request()
+ del request.headers["Connection"]
+ response = server.accept(request)
+
+ self.assertEqual(response.status_code, 426)
+ self.assertEqual(response.headers["Upgrade"], "websocket")
+ with self.assertRaises(InvalidUpgrade) as raised:
+ raise response.exception
+ self.assertEqual(str(raised.exception), "missing Connection header")
+
+ def test_invalid_connection(self):
+ server = ServerConnection()
+ request = self.make_request()
+ del request.headers["Connection"]
+ request.headers["Connection"] = "close"
+ response = server.accept(request)
+
+ self.assertEqual(response.status_code, 426)
+ self.assertEqual(response.headers["Upgrade"], "websocket")
+ with self.assertRaises(InvalidUpgrade) as raised:
+ raise response.exception
+ self.assertEqual(str(raised.exception), "invalid Connection header: close")
+
+ def test_missing_upgrade(self):
+ server = ServerConnection()
+ request = self.make_request()
+ del request.headers["Upgrade"]
+ response = server.accept(request)
+
+ self.assertEqual(response.status_code, 426)
+ self.assertEqual(response.headers["Upgrade"], "websocket")
+ with self.assertRaises(InvalidUpgrade) as raised:
+ raise response.exception
+ self.assertEqual(str(raised.exception), "missing Upgrade header")
+
+ def test_invalid_upgrade(self):
+ server = ServerConnection()
+ request = self.make_request()
+ del request.headers["Upgrade"]
+ request.headers["Upgrade"] = "h2c"
+ response = server.accept(request)
+
+ self.assertEqual(response.status_code, 426)
+ self.assertEqual(response.headers["Upgrade"], "websocket")
+ with self.assertRaises(InvalidUpgrade) as raised:
+ raise response.exception
+ self.assertEqual(str(raised.exception), "invalid Upgrade header: h2c")
+
+ def test_missing_key(self):
+ server = ServerConnection()
+ request = self.make_request()
+ del request.headers["Sec-WebSocket-Key"]
+ response = server.accept(request)
+
+ self.assertEqual(response.status_code, 400)
+ with self.assertRaises(InvalidHeader) as raised:
+ raise response.exception
+ self.assertEqual(str(raised.exception), "missing Sec-WebSocket-Key header")
+
+ def test_multiple_key(self):
+ server = ServerConnection()
+ request = self.make_request()
+ request.headers["Sec-WebSocket-Key"] = KEY
+ response = server.accept(request)
+
+ self.assertEqual(response.status_code, 400)
+ with self.assertRaises(InvalidHeader) as raised:
+ raise response.exception
+ self.assertEqual(
+ str(raised.exception),
+ "invalid Sec-WebSocket-Key header: "
+ "more than one Sec-WebSocket-Key header found",
+ )
+
+ def test_invalid_key(self):
+ server = ServerConnection()
+ request = self.make_request()
+ del request.headers["Sec-WebSocket-Key"]
+ request.headers["Sec-WebSocket-Key"] = "not Base64 data!"
+ response = server.accept(request)
+
+ self.assertEqual(response.status_code, 400)
+ with self.assertRaises(InvalidHeader) as raised:
+ raise response.exception
+ self.assertEqual(
+ str(raised.exception), "invalid Sec-WebSocket-Key header: not Base64 data!"
+ )
+
+ def test_truncated_key(self):
+ server = ServerConnection()
+ request = self.make_request()
+ del request.headers["Sec-WebSocket-Key"]
+ request.headers["Sec-WebSocket-Key"] = KEY[
+ :16
+ ] # 12 bytes instead of 16, Base64-encoded
+ response = server.accept(request)
+
+ self.assertEqual(response.status_code, 400)
+ with self.assertRaises(InvalidHeader) as raised:
+ raise response.exception
+ self.assertEqual(
+ str(raised.exception), f"invalid Sec-WebSocket-Key header: {KEY[:16]}"
+ )
+
+ def test_missing_version(self):
+ server = ServerConnection()
+ request = self.make_request()
+ del request.headers["Sec-WebSocket-Version"]
+ response = server.accept(request)
+
+ self.assertEqual(response.status_code, 400)
+ with self.assertRaises(InvalidHeader) as raised:
+ raise response.exception
+ self.assertEqual(str(raised.exception), "missing Sec-WebSocket-Version header")
+
+ def test_multiple_version(self):
+ server = ServerConnection()
+ request = self.make_request()
+ request.headers["Sec-WebSocket-Version"] = "11"
+ response = server.accept(request)
+
+ self.assertEqual(response.status_code, 400)
+ with self.assertRaises(InvalidHeader) as raised:
+ raise response.exception
+ self.assertEqual(
+ str(raised.exception),
+ "invalid Sec-WebSocket-Version header: "
+ "more than one Sec-WebSocket-Version header found",
+ )
+
+ def test_invalid_version(self):
+ server = ServerConnection()
+ request = self.make_request()
+ del request.headers["Sec-WebSocket-Version"]
+ request.headers["Sec-WebSocket-Version"] = "11"
+ response = server.accept(request)
+
+ self.assertEqual(response.status_code, 400)
+ with self.assertRaises(InvalidHeader) as raised:
+ raise response.exception
+ self.assertEqual(
+ str(raised.exception), "invalid Sec-WebSocket-Version header: 11"
+ )
+
+ def test_no_origin(self):
+ server = ServerConnection(origins=["https://example.com"])
+ request = self.make_request()
+ response = server.accept(request)
+
+ self.assertEqual(response.status_code, 403)
+ with self.assertRaises(InvalidOrigin) as raised:
+ raise response.exception
+ self.assertEqual(str(raised.exception), "missing Origin header")
+
+ def test_origin(self):
+ server = ServerConnection(origins=["https://example.com"])
+ request = self.make_request()
+ request.headers["Origin"] = "https://example.com"
+ response = server.accept(request)
+
+ self.assertEqual(response.status_code, 101)
+ self.assertEqual(server.origin, "https://example.com")
+
+ def test_unexpected_origin(self):
+ server = ServerConnection(origins=["https://example.com"])
+ request = self.make_request()
+ request.headers["Origin"] = "https://other.example.com"
+ response = server.accept(request)
+
+ self.assertEqual(response.status_code, 403)
+ with self.assertRaises(InvalidOrigin) as raised:
+ raise response.exception
+ self.assertEqual(
+ str(raised.exception), "invalid Origin header: https://other.example.com"
+ )
+
+ def test_multiple_origin(self):
+ server = ServerConnection(
+ origins=["https://example.com", "https://other.example.com"]
+ )
+ request = self.make_request()
+ request.headers["Origin"] = "https://example.com"
+ request.headers["Origin"] = "https://other.example.com"
+ response = server.accept(request)
+
+ # This is prohibited by the HTTP specification, so the return code is
+ # 400 Bad Request rather than 403 Forbidden.
+ self.assertEqual(response.status_code, 400)
+ with self.assertRaises(InvalidHeader) as raised:
+ raise response.exception
+ self.assertEqual(
+ str(raised.exception),
+ "invalid Origin header: more than one Origin header found",
+ )
+
+ def test_supported_origin(self):
+ server = ServerConnection(
+ origins=["https://example.com", "https://other.example.com"]
+ )
+ request = self.make_request()
+ request.headers["Origin"] = "https://other.example.com"
+ response = server.accept(request)
+
+ self.assertEqual(response.status_code, 101)
+ self.assertEqual(server.origin, "https://other.example.com")
+
+ def test_unsupported_origin(self):
+ server = ServerConnection(
+ origins=["https://example.com", "https://other.example.com"]
+ )
+ request = self.make_request()
+ request.headers["Origin"] = "https://original.example.com"
+ response = server.accept(request)
+
+ self.assertEqual(response.status_code, 403)
+ with self.assertRaises(InvalidOrigin) as raised:
+ raise response.exception
+ self.assertEqual(
+ str(raised.exception), "invalid Origin header: https://original.example.com"
+ )
+
+ def test_no_origin_accepted(self):
+ server = ServerConnection(origins=[None])
+ request = self.make_request()
+ response = server.accept(request)
+
+ self.assertEqual(response.status_code, 101)
+ self.assertIsNone(server.origin)
+
+ def test_no_extensions(self):
+ server = ServerConnection()
+ request = self.make_request()
+ response = server.accept(request)
+
+ self.assertEqual(response.status_code, 101)
+ self.assertNotIn("Sec-WebSocket-Extensions", response.headers)
+ self.assertEqual(server.extensions, [])
+
+ def test_no_extension(self):
+ server = ServerConnection(extensions=[ServerOpExtensionFactory()])
+ request = self.make_request()
+ response = server.accept(request)
+
+ self.assertEqual(response.status_code, 101)
+ self.assertNotIn("Sec-WebSocket-Extensions", response.headers)
+ self.assertEqual(server.extensions, [])
+
+ def test_extension(self):
+ server = ServerConnection(extensions=[ServerOpExtensionFactory()])
+ request = self.make_request()
+ request.headers["Sec-WebSocket-Extensions"] = "x-op; op"
+ response = server.accept(request)
+
+ self.assertEqual(response.status_code, 101)
+ self.assertEqual(response.headers["Sec-WebSocket-Extensions"], "x-op; op")
+ self.assertEqual(server.extensions, [OpExtension()])
+
+ def test_unexpected_extension(self):
+ server = ServerConnection()
+ request = self.make_request()
+ request.headers["Sec-WebSocket-Extensions"] = "x-op; op"
+ response = server.accept(request)
+
+ self.assertEqual(response.status_code, 101)
+ self.assertNotIn("Sec-WebSocket-Extensions", response.headers)
+ self.assertEqual(server.extensions, [])
+
+ def test_unsupported_extension(self):
+ server = ServerConnection(extensions=[ServerRsv2ExtensionFactory()])
+ request = self.make_request()
+ request.headers["Sec-WebSocket-Extensions"] = "x-op; op"
+ response = server.accept(request)
+
+ self.assertEqual(response.status_code, 101)
+ self.assertNotIn("Sec-WebSocket-Extensions", response.headers)
+ self.assertEqual(server.extensions, [])
+
+ def test_supported_extension_parameters(self):
+ server = ServerConnection(extensions=[ServerOpExtensionFactory("this")])
+ request = self.make_request()
+ request.headers["Sec-WebSocket-Extensions"] = "x-op; op=this"
+ response = server.accept(request)
+
+ self.assertEqual(response.status_code, 101)
+ self.assertEqual(response.headers["Sec-WebSocket-Extensions"], "x-op; op=this")
+ self.assertEqual(server.extensions, [OpExtension("this")])
+
+ def test_unsupported_extension_parameters(self):
+ server = ServerConnection(extensions=[ServerOpExtensionFactory("this")])
+ request = self.make_request()
+ request.headers["Sec-WebSocket-Extensions"] = "x-op; op=that"
+ response = server.accept(request)
+
+ self.assertEqual(response.status_code, 101)
+ self.assertNotIn("Sec-WebSocket-Extensions", response.headers)
+ self.assertEqual(server.extensions, [])
+
+ def test_multiple_supported_extension_parameters(self):
+ server = ServerConnection(
+ extensions=[
+ ServerOpExtensionFactory("this"),
+ ServerOpExtensionFactory("that"),
+ ]
+ )
+ request = self.make_request()
+ request.headers["Sec-WebSocket-Extensions"] = "x-op; op=that"
+ response = server.accept(request)
+
+ self.assertEqual(response.status_code, 101)
+ self.assertEqual(response.headers["Sec-WebSocket-Extensions"], "x-op; op=that")
+ self.assertEqual(server.extensions, [OpExtension("that")])
+
+ def test_multiple_extensions(self):
+ server = ServerConnection(
+ extensions=[ServerOpExtensionFactory(), ServerRsv2ExtensionFactory()]
+ )
+ request = self.make_request()
+ request.headers["Sec-WebSocket-Extensions"] = "x-op; op"
+ request.headers["Sec-WebSocket-Extensions"] = "x-rsv2"
+ response = server.accept(request)
+
+ self.assertEqual(response.status_code, 101)
+ self.assertEqual(
+ response.headers["Sec-WebSocket-Extensions"], "x-op; op, x-rsv2"
+ )
+ self.assertEqual(server.extensions, [OpExtension(), Rsv2Extension()])
+
+ def test_multiple_extensions_order(self):
+ server = ServerConnection(
+ extensions=[ServerOpExtensionFactory(), ServerRsv2ExtensionFactory()]
+ )
+ request = self.make_request()
+ request.headers["Sec-WebSocket-Extensions"] = "x-rsv2"
+ request.headers["Sec-WebSocket-Extensions"] = "x-op; op"
+ response = server.accept(request)
+
+ self.assertEqual(response.status_code, 101)
+ self.assertEqual(
+ response.headers["Sec-WebSocket-Extensions"], "x-rsv2, x-op; op"
+ )
+ self.assertEqual(server.extensions, [Rsv2Extension(), OpExtension()])
+
+ def test_no_subprotocols(self):
+ server = ServerConnection()
+ request = self.make_request()
+ response = server.accept(request)
+
+ self.assertEqual(response.status_code, 101)
+ self.assertNotIn("Sec-WebSocket-Protocol", response.headers)
+ self.assertIsNone(server.subprotocol)
+
+ def test_no_subprotocol(self):
+ server = ServerConnection(subprotocols=["chat"])
+ request = self.make_request()
+ response = server.accept(request)
+
+ self.assertEqual(response.status_code, 101)
+ self.assertNotIn("Sec-WebSocket-Protocol", response.headers)
+ self.assertIsNone(server.subprotocol)
+
+ def test_subprotocol(self):
+ server = ServerConnection(subprotocols=["chat"])
+ request = self.make_request()
+ request.headers["Sec-WebSocket-Protocol"] = "chat"
+ response = server.accept(request)
+
+ self.assertEqual(response.status_code, 101)
+ self.assertEqual(response.headers["Sec-WebSocket-Protocol"], "chat")
+ self.assertEqual(server.subprotocol, "chat")
+
+ def test_unexpected_subprotocol(self):
+ server = ServerConnection()
+ request = self.make_request()
+ request.headers["Sec-WebSocket-Protocol"] = "chat"
+ response = server.accept(request)
+
+ self.assertEqual(response.status_code, 101)
+ self.assertNotIn("Sec-WebSocket-Protocol", response.headers)
+ self.assertIsNone(server.subprotocol)
+
+ def test_multiple_subprotocols(self):
+ server = ServerConnection(subprotocols=["superchat", "chat"])
+ request = self.make_request()
+ request.headers["Sec-WebSocket-Protocol"] = "superchat"
+ request.headers["Sec-WebSocket-Protocol"] = "chat"
+ response = server.accept(request)
+
+ self.assertEqual(response.status_code, 101)
+ self.assertEqual(response.headers["Sec-WebSocket-Protocol"], "superchat")
+ self.assertEqual(server.subprotocol, "superchat")
+
+ def test_supported_subprotocol(self):
+ server = ServerConnection(subprotocols=["superchat", "chat"])
+ request = self.make_request()
+ request.headers["Sec-WebSocket-Protocol"] = "chat"
+ response = server.accept(request)
+
+ self.assertEqual(response.status_code, 101)
+ self.assertEqual(response.headers["Sec-WebSocket-Protocol"], "chat")
+ self.assertEqual(server.subprotocol, "chat")
+
+ def test_unsupported_subprotocol(self):
+ server = ServerConnection(subprotocols=["superchat", "chat"])
+ request = self.make_request()
+ request.headers["Sec-WebSocket-Protocol"] = "otherchat"
+ response = server.accept(request)
+
+ self.assertEqual(response.status_code, 101)
+ self.assertNotIn("Sec-WebSocket-Protocol", response.headers)
+ self.assertIsNone(server.subprotocol)
+
+ def test_extra_headers(self):
+ for extra_headers in [
+ Headers({"X-Spam": "Eggs"}),
+ {"X-Spam": "Eggs"},
+ [("X-Spam", "Eggs")],
+ lambda path, headers: Headers({"X-Spam": "Eggs"}),
+ lambda path, headers: {"X-Spam": "Eggs"},
+ lambda path, headers: [("X-Spam", "Eggs")],
+ ]:
+ with self.subTest(extra_headers=extra_headers):
+ server = ServerConnection(extra_headers=extra_headers)
+ request = self.make_request()
+ response = server.accept(request)
+
+ self.assertEqual(response.status_code, 101)
+ self.assertEqual(response.headers["X-Spam"], "Eggs")
+
+ def test_extra_headers_overrides_server(self):
+ server = ServerConnection(extra_headers={"Server": "Other"})
+ request = self.make_request()
+ response = server.accept(request)
+
+ self.assertEqual(response.status_code, 101)
+ self.assertEqual(response.headers["Server"], "Other")
diff --git a/tests/test_streams.py b/tests/test_streams.py
new file mode 100644
index 000000000..566deb2db
--- /dev/null
+++ b/tests/test_streams.py
@@ -0,0 +1,146 @@
+from websockets.streams import StreamReader
+
+from .utils import GeneratorTestCase
+
+
+class StreamReaderTests(GeneratorTestCase):
+ def setUp(self):
+ self.reader = StreamReader()
+
+ def test_read_line(self):
+ self.reader.feed_data(b"spam\neggs\n")
+
+ gen = self.reader.read_line()
+ line = self.assertGeneratorReturns(gen)
+ self.assertEqual(line, b"spam\n")
+
+ gen = self.reader.read_line()
+ line = self.assertGeneratorReturns(gen)
+ self.assertEqual(line, b"eggs\n")
+
+ def test_read_line_need_more_data(self):
+ self.reader.feed_data(b"spa")
+
+ gen = self.reader.read_line()
+ self.assertGeneratorRunning(gen)
+ self.reader.feed_data(b"m\neg")
+ line = self.assertGeneratorReturns(gen)
+ self.assertEqual(line, b"spam\n")
+
+ gen = self.reader.read_line()
+ self.assertGeneratorRunning(gen)
+ self.reader.feed_data(b"gs\n")
+ line = self.assertGeneratorReturns(gen)
+ self.assertEqual(line, b"eggs\n")
+
+ def test_read_line_not_enough_data(self):
+ self.reader.feed_data(b"spa")
+ self.reader.feed_eof()
+
+ gen = self.reader.read_line()
+ with self.assertRaises(EOFError) as raised:
+ next(gen)
+ self.assertEqual(
+ str(raised.exception), "stream ends after 3 bytes, before end of line"
+ )
+
+ def test_read_exact(self):
+ self.reader.feed_data(b"spameggs")
+
+ gen = self.reader.read_exact(4)
+ data = self.assertGeneratorReturns(gen)
+ self.assertEqual(data, b"spam")
+
+ gen = self.reader.read_exact(4)
+ data = self.assertGeneratorReturns(gen)
+ self.assertEqual(data, b"eggs")
+
+ def test_read_exact_need_more_data(self):
+ self.reader.feed_data(b"spa")
+
+ gen = self.reader.read_exact(4)
+ self.assertGeneratorRunning(gen)
+ self.reader.feed_data(b"meg")
+ data = self.assertGeneratorReturns(gen)
+ self.assertEqual(data, b"spam")
+
+ gen = self.reader.read_exact(4)
+ self.assertGeneratorRunning(gen)
+ self.reader.feed_data(b"gs")
+ data = self.assertGeneratorReturns(gen)
+ self.assertEqual(data, b"eggs")
+
+ def test_read_exact_not_enough_data(self):
+ self.reader.feed_data(b"spa")
+ self.reader.feed_eof()
+
+ gen = self.reader.read_exact(4)
+ with self.assertRaises(EOFError) as raised:
+ next(gen)
+ self.assertEqual(
+ str(raised.exception), "stream ends after 3 bytes, expected 4 bytes"
+ )
+
+ def test_read_to_eof(self):
+ gen = self.reader.read_to_eof()
+
+ self.reader.feed_data(b"spam")
+ self.assertGeneratorRunning(gen)
+
+ self.reader.feed_eof()
+ data = self.assertGeneratorReturns(gen)
+ self.assertEqual(data, b"spam")
+
+ def test_read_to_eof_at_eof(self):
+ self.reader.feed_eof()
+
+ gen = self.reader.read_to_eof()
+ data = self.assertGeneratorReturns(gen)
+ self.assertEqual(data, b"")
+
+ def test_at_eof_after_feed_data(self):
+ gen = self.reader.at_eof()
+ self.assertGeneratorRunning(gen)
+ self.reader.feed_data(b"spam")
+ eof = self.assertGeneratorReturns(gen)
+ self.assertFalse(eof)
+
+ def test_at_eof_after_feed_eof(self):
+ gen = self.reader.at_eof()
+ self.assertGeneratorRunning(gen)
+ self.reader.feed_eof()
+ eof = self.assertGeneratorReturns(gen)
+ self.assertTrue(eof)
+
+ def test_feed_data_after_feed_data(self):
+ self.reader.feed_data(b"spam")
+ self.reader.feed_data(b"eggs")
+
+ gen = self.reader.read_exact(8)
+ data = self.assertGeneratorReturns(gen)
+ self.assertEqual(data, b"spameggs")
+ gen = self.reader.at_eof()
+ self.assertGeneratorRunning(gen)
+
+ def test_feed_eof_after_feed_data(self):
+ self.reader.feed_data(b"spam")
+ self.reader.feed_eof()
+
+ gen = self.reader.read_exact(4)
+ data = self.assertGeneratorReturns(gen)
+ self.assertEqual(data, b"spam")
+ gen = self.reader.at_eof()
+ eof = self.assertGeneratorReturns(gen)
+ self.assertTrue(eof)
+
+ def test_feed_data_after_feed_eof(self):
+ self.reader.feed_eof()
+ with self.assertRaises(EOFError) as raised:
+ self.reader.feed_data(b"spam")
+ self.assertEqual(str(raised.exception), "stream ended")
+
+ def test_feed_eof_after_feed_eof(self):
+ self.reader.feed_eof()
+ with self.assertRaises(EOFError) as raised:
+ self.reader.feed_eof()
+ self.assertEqual(str(raised.exception), "stream ended")
diff --git a/tests/test_typing.py b/tests/test_typing.py
new file mode 100644
index 000000000..6eb1fe6c5
--- /dev/null
+++ b/tests/test_typing.py
@@ -0,0 +1 @@
+from websockets.typing import * # noqa
diff --git a/tests/test_uri.py b/tests/test_uri.py
index ad4ec4013..9eeb8431d 100644
--- a/tests/test_uri.py
+++ b/tests/test_uri.py
@@ -5,17 +5,23 @@
VALID_URIS = [
- ('ws://localhost/', (False, 'localhost', 80, '/', None)),
- ('wss://localhost/', (True, 'localhost', 443, '/', None)),
- ('ws://localhost/path?query', (False, 'localhost', 80, '/path?query', None)),
- ('WS://LOCALHOST/PATH?QUERY', (False, 'localhost', 80, '/PATH?QUERY', None)),
- ('ws://user:pass@localhost/', (False, 'localhost', 80, '/', ('user', 'pass'))),
+ ("ws://localhost/", (False, "localhost", 80, "/", None)),
+ ("wss://localhost/", (True, "localhost", 443, "/", None)),
+ ("ws://localhost/path?query", (False, "localhost", 80, "/path?query", None)),
+ ("WS://LOCALHOST/PATH?QUERY", (False, "localhost", 80, "/PATH?QUERY", None)),
+ ("ws://user:pass@localhost/", (False, "localhost", 80, "/", ("user", "pass"))),
+ ("ws://høst/", (False, "xn--hst-0na", 80, "/", None)),
+ (
+ "ws://üser:påss@høst/πass",
+ (False, "xn--hst-0na", 80, "/%CF%80ass", ("%C3%BCser", "p%C3%A5ss")),
+ ),
]
INVALID_URIS = [
- 'http://localhost/',
- 'https://localhost/',
- 'ws://localhost/path#fragment',
+ "http://localhost/",
+ "https://localhost/",
+ "ws://localhost/path#fragment",
+ "ws://user@localhost/",
]
diff --git a/tests/test_utils.py b/tests/test_utils.py
index c7699232e..a9ea8dcbd 100644
--- a/tests/test_utils.py
+++ b/tests/test_utils.py
@@ -1,35 +1,78 @@
+import base64
+import itertools
import unittest
-from websockets.utils import apply_mask as py_apply_mask
+from websockets.utils import accept_key, apply_mask as py_apply_mask, generate_key
+
+
+# Test vector from RFC 6455
+KEY = "dGhlIHNhbXBsZSBub25jZQ=="
+ACCEPT = "s3pPLMBiTxaQ9kYGzzhZRbK+xOo="
class UtilsTests(unittest.TestCase):
+ def test_generate_key(self):
+ key = generate_key()
+ self.assertEqual(len(base64.b64decode(key.encode())), 16)
+
+ def test_accept_key(self):
+ self.assertEqual(accept_key(KEY), ACCEPT)
+
+
+class ApplyMaskTests(unittest.TestCase):
@staticmethod
def apply_mask(*args, **kwargs):
return py_apply_mask(*args, **kwargs)
+ apply_mask_type_combos = list(itertools.product([bytes, bytearray], repeat=2))
+
+ apply_mask_test_values = [
+ (b"", b"1234", b""),
+ (b"aBcDe", b"\x00\x00\x00\x00", b"aBcDe"),
+ (b"abcdABCD", b"1234", b"PPPPpppp"),
+ (b"abcdABCD" * 10, b"1234", b"PPPPpppp" * 10),
+ ]
+
def test_apply_mask(self):
- for data_in, mask, data_out in [
- (b'', b'1234', b''),
- (b'aBcDe', b'\x00\x00\x00\x00', b'aBcDe'),
- (b'abcdABCD', b'1234', b'PPPPpppp'),
- (b'abcdABCD' * 10, b'1234', b'PPPPpppp' * 10),
- ]:
- with self.subTest(data_in=data_in, mask=mask):
- self.assertEqual(self.apply_mask(data_in, mask), data_out)
+ for data_type, mask_type in self.apply_mask_type_combos:
+ for data_in, mask, data_out in self.apply_mask_test_values:
+ data_in, mask = data_type(data_in), mask_type(mask)
+
+ with self.subTest(data_in=data_in, mask=mask):
+ result = self.apply_mask(data_in, mask)
+ self.assertEqual(result, data_out)
+
+ def test_apply_mask_memoryview(self):
+ for mask_type in [bytes, bytearray]:
+ for data_in, mask, data_out in self.apply_mask_test_values:
+ data_in, mask = memoryview(data_in), mask_type(mask)
+
+ with self.subTest(data_in=data_in, mask=mask):
+ result = self.apply_mask(data_in, mask)
+ self.assertEqual(result, data_out)
+
+ def test_apply_mask_non_contiguous_memoryview(self):
+ for mask_type in [bytes, bytearray]:
+ for data_in, mask, data_out in self.apply_mask_test_values:
+ data_in, mask = memoryview(data_in)[::-1], mask_type(mask)[::-1]
+ data_out = data_out[::-1]
+
+ with self.subTest(data_in=data_in, mask=mask):
+ result = self.apply_mask(data_in, mask)
+ self.assertEqual(result, data_out)
def test_apply_mask_check_input_types(self):
- for data_in, mask in [(None, None), (b'abcd', None), (None, b'abcd')]:
+ for data_in, mask in [(None, None), (b"abcd", None), (None, b"abcd")]:
with self.subTest(data_in=data_in, mask=mask):
with self.assertRaises(TypeError):
self.apply_mask(data_in, mask)
def test_apply_mask_check_mask_length(self):
for data_in, mask in [
- (b'', b''),
- (b'abcd', b'123'),
- (b'', b'aBcDe'),
- (b'12345678', b'12345678'),
+ (b"", b""),
+ (b"abcd", b"123"),
+ (b"", b"aBcDe"),
+ (b"12345678", b"12345678"),
]:
with self.subTest(data_in=data_in, mask=mask):
with self.assertRaises(ValueError):
@@ -42,7 +85,7 @@ def test_apply_mask_check_mask_length(self):
pass
else:
- class SpeedupsTests(UtilsTests):
+ class SpeedupsTests(ApplyMaskTests):
@staticmethod
def apply_mask(*args, **kwargs):
return c_apply_mask(*args, **kwargs)
diff --git a/tests/utils.py b/tests/utils.py
new file mode 100644
index 000000000..ac891a0fd
--- /dev/null
+++ b/tests/utils.py
@@ -0,0 +1,23 @@
+import email.utils
+import unittest
+
+
+DATE = email.utils.formatdate(usegmt=True)
+
+
+class GeneratorTestCase(unittest.TestCase):
+ def assertGeneratorRunning(self, gen):
+ """
+ Check that a generator-based coroutine hasn't completed yet.
+
+ """
+ next(gen)
+
+ def assertGeneratorReturns(self, gen):
+ """
+ Check that a generator-based coroutine completes and return its value.
+
+ """
+ with self.assertRaises(StopIteration) as raised:
+ next(gen)
+ return raised.exception.value
diff --git a/tox.ini b/tox.ini
index 6cff294e5..b5488e5b0 100644
--- a/tox.ini
+++ b/tox.ini
@@ -1,5 +1,5 @@
[tox]
-envlist = py34,py35,py36,py37,coverage,black,flake8,isort
+envlist = py36,py37,py38,py39,coverage,black,flake8,isort,mypy
[testenv]
commands = python -W default -m unittest {posargs}
@@ -12,7 +12,7 @@ commands =
deps = coverage
[testenv:black]
-commands = black --check --skip-string-normalization src tests
+commands = black --check src tests
deps = black
[testenv:flake8]
@@ -20,5 +20,9 @@ commands = flake8 src tests
deps = flake8
[testenv:isort]
-commands = isort --check-only --recursive src tests
+commands = isort --check-only src tests
deps = isort
+
+[testenv:mypy]
+commands = mypy --strict src
+deps = mypy
+