first commit
This commit is contained in:
unknown committed
commit
5d3b2f218b
2817 files changed
+516548
No files matched your search
@@ -0,0 +1 @@
|
||||
pip
|
||||
@@ -0,0 +1,21 @@
|
||||
The MIT License (MIT)
|
||||
|
||||
Copyright (c) 2018 Hyperion Gray
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in
|
||||
all copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
THE SOFTWARE.
|
||||
@@ -0,0 +1,123 @@
|
||||
Metadata-Version: 2.1
|
||||
Name: trio-websocket
|
||||
Version: 0.12.2
|
||||
Summary: WebSocket library for Trio
|
||||
Home-page: https://github.com/python-trio/trio-websocket
|
||||
Author: Mark E. Haase
|
||||
Author-email: mehaase@gmail.com
|
||||
Project-URL: Bug Reports, https://github.com/python-trio/trio-websocket/issues
|
||||
Project-URL: Source, https://github.com/python-trio/trio-websocket
|
||||
Keywords: websocket client server trio
|
||||
Classifier: Development Status :: 3 - Alpha
|
||||
Classifier: Intended Audience :: Developers
|
||||
Classifier: Topic :: Software Development :: Libraries
|
||||
Classifier: License :: OSI Approved :: MIT License
|
||||
Classifier: Programming Language :: Python :: 3.8
|
||||
Classifier: Programming Language :: Python :: 3.9
|
||||
Classifier: Programming Language :: Python :: 3.10
|
||||
Classifier: Programming Language :: Python :: 3.11
|
||||
Classifier: Programming Language :: Python :: 3.12
|
||||
Classifier: Programming Language :: Python :: 3.13
|
||||
Classifier: Programming Language :: Python :: Implementation :: CPython
|
||||
Classifier: Programming Language :: Python :: Implementation :: PyPy
|
||||
Classifier: Typing :: Typed
|
||||
Requires-Python: >=3.8
|
||||
Description-Content-Type: text/markdown
|
||||
License-File: LICENSE
|
||||
Requires-Dist: outcome >=1.2.0
|
||||
Requires-Dist: trio >=0.11
|
||||
Requires-Dist: wsproto >=0.14
|
||||
Requires-Dist: exceptiongroup ; python_version < "3.11"
|
||||
|
||||
# Trio WebSocket
|
||||
|
||||
This library implements both server and client aspects of the [the WebSocket
|
||||
protocol](https://tools.ietf.org/html/rfc6455), striving for safety,
|
||||
correctness, and ergonomics. It is based on the [wsproto
|
||||
project](https://wsproto.readthedocs.io/en/latest/), which is a
|
||||
[Sans-IO](https://sans-io.readthedocs.io/) state machine that implements the
|
||||
majority of the WebSocket protocol, including framing, codecs, and events. This
|
||||
library handles I/O using [the Trio
|
||||
framework](https://trio.readthedocs.io/en/latest/). This library passes the
|
||||
[Autobahn Test Suite](https://github.com/crossbario/autobahn-testsuite).
|
||||
|
||||
This README contains a brief introduction to the project. Full documentation [is
|
||||
available here](https://trio-websocket.readthedocs.io).
|
||||
|
||||
[](https://pypi.org/project/trio-websocket/)
|
||||
|
||||
[](https://github.com/python-trio/trio-websocket/actions/workflows/ci.yml)
|
||||
[](https://trio-websocket.readthedocs.io)
|
||||
[](https://gitter.im/python-trio/general)
|
||||
|
||||
## Status
|
||||
**This project is on life-support maintenance.** If you're interested in helping to maintain and contribute, please reach out on [Gitter](https://gitter.im/python-trio/general) or contribute in issues and pull requests.
|
||||
|
||||
## Alternatives
|
||||
|
||||
If you happen to only need a server, using Quart via the [quart-trio](https://github.com/pgjones/quart-trio)
|
||||
extension may suffice. While trio-websocket is more flexible, Quart covers
|
||||
both HTTP and WebSocket within a single framework, and serving both from the
|
||||
same port is straightforward. There has yet to be a performance comparison.
|
||||
|
||||
## Installation
|
||||
|
||||
This library requires Python 3.8 or greater. To install from PyPI:
|
||||
|
||||
pip install trio-websocket
|
||||
|
||||
## Client Example
|
||||
|
||||
This example demonstrates how to open a WebSocket URL:
|
||||
|
||||
```python
|
||||
import trio
|
||||
from sys import stderr
|
||||
from trio_websocket import open_websocket_url
|
||||
|
||||
|
||||
async def main():
|
||||
try:
|
||||
async with open_websocket_url('wss://echo.websocket.org') as ws:
|
||||
await ws.send_message('hello world!')
|
||||
message = await ws.get_message()
|
||||
print('Received message: %s' % message)
|
||||
except OSError as ose:
|
||||
print('Connection attempt failed: %s' % ose, file=stderr)
|
||||
|
||||
trio.run(main)
|
||||
```
|
||||
|
||||
The WebSocket context manager connects automatically before entering the block
|
||||
and disconnects automatically before exiting the block. The full API offers a
|
||||
lot of flexibility and additional options.
|
||||
|
||||
## Server Example
|
||||
|
||||
A WebSocket server requires a bind address, a port, and a coroutine to handle
|
||||
incoming connections. This example demonstrates an "echo server" that replies to
|
||||
each incoming message with an identical outgoing message.
|
||||
|
||||
```python
|
||||
import trio
|
||||
from trio_websocket import serve_websocket, ConnectionClosed
|
||||
|
||||
async def echo_server(request):
|
||||
ws = await request.accept()
|
||||
while True:
|
||||
try:
|
||||
message = await ws.get_message()
|
||||
await ws.send_message(message)
|
||||
except ConnectionClosed:
|
||||
break
|
||||
|
||||
async def main():
|
||||
await serve_websocket(echo_server, '127.0.0.1', 8000, ssl_context=None)
|
||||
|
||||
trio.run(main)
|
||||
```
|
||||
|
||||
The server's handler ``echo_server(…)`` receives a connection request object.
|
||||
This object can be used to inspect the client's request and modify the
|
||||
handshake, then it can be exchanged for an actual WebSocket object ``ws``.
|
||||
Again, the full API offers a lot of flexibility and additional options.
|
||||
@@ -0,0 +1,13 @@
|
||||
trio_websocket-0.12.2.dist-info/INSTALLER,sha256=zuuue4knoyJ-UwPPXg8fezS7VCrXJQrAP7zeNuwvFQg,4
|
||||
trio_websocket-0.12.2.dist-info/LICENSE,sha256=LV4_xQa2yHrZO3e5qnYAmlj-pyvl-1bmgDvAjLKIeZk,1080
|
||||
trio_websocket-0.12.2.dist-info/METADATA,sha256=8aBAHmZXOCxESFQlYmPWFdqJpKTV7WssbF4WeK7hNmA,5078
|
||||
trio_websocket-0.12.2.dist-info/RECORD,,
|
||||
trio_websocket-0.12.2.dist-info/WHEEL,sha256=P9jw-gEje8ByB7_hXoICnHtVCrEwMQh-630tKvQWehc,91
|
||||
trio_websocket-0.12.2.dist-info/top_level.txt,sha256=Q1lPttKnadThXspRJagWH0QGxlu9GKeG1ae5iO2aPAM,15
|
||||
trio_websocket/__init__.py,sha256=z2uXvmKsB8l5bwPuw5Jscc3HdS2IjiUNX7bKcwWMgno,831
|
||||
trio_websocket/__pycache__/__init__.cpython-38.pyc,,
|
||||
trio_websocket/__pycache__/_impl.cpython-38.pyc,,
|
||||
trio_websocket/__pycache__/_version.cpython-38.pyc,,
|
||||
trio_websocket/_impl.py,sha256=ThUvthDruJRZZEsZsj3x6Ro8wv-fk8tT-kCnydBx1tw,72543
|
||||
trio_websocket/_version.py,sha256=KzYlv9mV5BAclb_b4mb6NprSS8L9Xd0qsNzjQFwnp30,23
|
||||
trio_websocket/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
||||
@@ -0,0 +1,5 @@
|
||||
Wheel-Version: 1.0
|
||||
Generator: setuptools (75.3.0)
|
||||
Root-Is-Purelib: true
|
||||
Tag: py3-none-any
|
||||
|
||||
@@ -0,0 +1 @@
|
||||
trio_websocket
|
||||
Reference in new issue
Block a user