Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/abersheeran/a2wsgi
Convert WSGI app to ASGI app or ASGI app to WSGI app.
https://github.com/abersheeran/a2wsgi
asgi wsgi
Last synced: 4 days ago
JSON representation
Convert WSGI app to ASGI app or ASGI app to WSGI app.
- Host: GitHub
- URL: https://github.com/abersheeran/a2wsgi
- Owner: abersheeran
- License: apache-2.0
- Created: 2020-05-02T08:07:10.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-05-07T16:17:46.000Z (9 months ago)
- Last Synced: 2024-05-21T00:07:14.441Z (8 months ago)
- Topics: asgi, wsgi
- Language: Python
- Homepage:
- Size: 230 KB
- Stars: 198
- Watchers: 5
- Forks: 18
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# a2wsgi
Convert WSGI app to ASGI app or ASGI app to WSGI app.
Pure Python. Only depend on the standard library.
Compared with other converters, the advantage is that a2wsgi will not accumulate the requested content or response content in the memory, so you don't have to worry about the memory limit caused by a2wsgi. This problem exists in converters implemented by uvicorn/startlette or hypercorn.
## Install
```
pip install a2wsgi
```
## How to use
### `WSGIMiddleware`
Convert WSGI app to ASGI app:
```python
from a2wsgi import WSGIMiddleware
ASGI_APP = WSGIMiddleware(WSGI_APP)
```
WSGIMiddleware executes WSGI applications with a thread pool of up to 10 threads by default. If you want to increase or decrease this number, just like `WSGIMiddleware(..., workers=15)`.
WSGIMiddleware utilizes a queue to direct traffic from the WSGI App to the client. To adjust the queue size, simply specify the send_queue_size parameter (default to `10`) during initialization, like so: WSGIMiddleware(..., send_queue_size=15). This enable developers to balance memory usage and application responsiveness.
### `ASGIMiddleware`
Convert ASGI app to WSGI app:
```python
from a2wsgi import ASGIMiddleware
WSGI_APP = ASGIMiddleware(ASGI_APP)
```
`ASGIMiddleware` will wait for the ASGI application's Background Task to complete before returning the last null byte. But sometimes you may not want to wait indefinitely for the execution of the Background Task of the ASGI application, then you only need to give the parameter `ASGIMiddleware(..., wait_time=5.0)`, after the time exceeds, the ASGI task corresponding to the request will be tried to cancel, and the last null byte will be returned.
You can also specify your own event loop through the `loop` parameter instead of the default event loop. Like `ASGIMiddleware(..., loop=faster_loop)`
### Access the original `Scope`/`Environ`
Sometimes you may need to access the original WSGI Environ in the ASGI application, just use `scope["wsgi_environ"]`; it is also easy to access the ASGI Scope in the WSGI Application, use `environ["asgi.scope"]`.
## Benchmark
Run `pytest ./benchmark.py -s` to compare the performance of `a2wsgi` and `uvicorn.middleware.wsgi.WSGIMiddleware` / `asgiref.wsgi.WsgiToAsgi`.
## Why a2wsgi
### Convert WSGI app to ASGI app
You can convert an existing WSGI project to an ASGI project to make it easier to migrate from WSGI applications to ASGI applications.
### Convert ASGI app to WSGI app
There is a lot of support for WSGI. Converting ASGI to WSGI, you will be able to use many existing services to deploy ASGI applications.
## Compatibility list
This list quickly demonstrates the compatibility of some common frameworks for users who are unfamiliar with the WSGI and ASGI protocols.
- WSGI: [Django(wsgi)](https://docs.djangoproject.com/en/3.0/howto/deployment/wsgi/)/[Kuí(wsgi)](https://kui.aber.sh/wsgi/)/[Pyramid](https://trypyramid.com/)/[Bottle](https://bottlepy.org/)/[Flask](https://flask.palletsprojects.com/)
- ASGI: [Django(asgi)](https://docs.djangoproject.com/en/3.0/howto/deployment/asgi/)/[Kuí(asgi)](https://kui.aber.sh/asgi/)/[Starlette](https://www.starlette.io/)/[FastAPI](https://fastapi.tiangolo.com/)/[Sanic](https://sanic.readthedocs.io/en/stable/)/[Quart](https://pgjones.gitlab.io/quart/)
- **Unsupport**: [aiohttp](https://docs.aiohttp.org/en/stable/)