2019-05-21 23:42:19 +01:00
|
|
|
"""
|
|
|
|
1. Create a simple Sanic app
|
2019-05-27 00:11:52 +01:00
|
|
|
0. Run with an ASGI server:
|
2019-05-21 23:42:19 +01:00
|
|
|
$ uvicorn run_asgi:app
|
|
|
|
or
|
|
|
|
$ hypercorn run_asgi:app
|
|
|
|
"""
|
|
|
|
|
2019-05-27 00:11:52 +01:00
|
|
|
from pathlib import Path
|
2019-05-21 23:42:19 +01:00
|
|
|
|
2020-10-25 13:01:53 +00:00
|
|
|
from sanic import Sanic, response
|
2019-05-21 23:42:19 +01:00
|
|
|
|
2020-12-14 07:23:13 +00:00
|
|
|
|
2021-12-23 22:30:27 +00:00
|
|
|
app = Sanic("Example")
|
2019-05-21 23:42:19 +01:00
|
|
|
|
2019-05-26 22:57:50 +01:00
|
|
|
|
|
|
|
@app.route("/text")
|
2019-05-27 00:11:52 +01:00
|
|
|
def handler_text(request):
|
2019-05-26 22:57:50 +01:00
|
|
|
return response.text("Hello")
|
|
|
|
|
2019-05-21 23:42:19 +01:00
|
|
|
|
2019-05-26 22:57:50 +01:00
|
|
|
@app.route("/json")
|
2019-05-27 00:11:52 +01:00
|
|
|
def handler_json(request):
|
|
|
|
return response.json({"foo": "bar"})
|
2019-05-21 23:42:19 +01:00
|
|
|
|
|
|
|
|
2019-05-26 22:57:50 +01:00
|
|
|
@app.websocket("/ws")
|
2019-05-27 00:11:52 +01:00
|
|
|
async def handler_ws(request, ws):
|
2019-05-21 23:42:19 +01:00
|
|
|
name = "<someone>"
|
|
|
|
while True:
|
|
|
|
data = f"Hello {name}"
|
|
|
|
await ws.send(data)
|
|
|
|
name = await ws.recv()
|
|
|
|
|
|
|
|
if not name:
|
|
|
|
break
|
|
|
|
|
|
|
|
|
2019-05-26 22:57:50 +01:00
|
|
|
@app.route("/file")
|
2019-05-27 00:11:52 +01:00
|
|
|
async def handler_file(request):
|
|
|
|
return await response.file(Path("../") / "setup.py")
|
2019-05-26 22:57:50 +01:00
|
|
|
|
|
|
|
|
|
|
|
@app.route("/file_stream")
|
2019-05-27 00:11:52 +01:00
|
|
|
async def handler_file_stream(request):
|
2020-12-14 07:23:13 +00:00
|
|
|
return await response.file_stream(
|
|
|
|
Path("../") / "setup.py", chunk_size=1024
|
|
|
|
)
|
2019-05-27 00:11:52 +01:00
|
|
|
|
|
|
|
|
Streaming Server (#1876)
* Streaming request by async for.
* Make all requests streaming and preload body for non-streaming handlers.
* Cleanup of code and avoid mixing streaming responses.
* Async http protocol loop.
* Change of test: don't require early bad request error but only after CRLF-CRLF.
* Add back streaming requests.
* Rewritten request body parser.
* Misc. cleanup, down to 4 failing tests.
* All tests OK.
* Entirely remove request body queue.
* Let black f*ckup the layout
* Better testing error messages on protocol errors.
* Remove StreamBuffer tests because the type is about to be removed.
* Remove tests using the deprecated get_headers function that can no longer be supported. Chunked mode is now autodetected, so do not put content-length header if chunked mode is preferred.
* Major refactoring of HTTP protocol handling (new module http.py added), all requests made streaming. A few compatibility issues and a lot of cleanup to be done remain, 16 tests failing.
* Terminate check_timeouts once connection_task finishes.
* Code cleanup, 14 tests failing.
* Much cleanup, 12 failing...
* Even more cleanup and error checking, 8 failing tests.
* Remove keep-alive header from responses. First of all, it should say timeout=<value> which wasn't the case with existing implementation, and secondly none of the other web servers I tried include this header.
* Everything but CustomServer OK.
* Linter
* Disable custom protocol test
* Remove unnecessary variables, optimise performance.
* A test was missing that body_init/body_push/body_finish are never called. Rewritten using receive_body and case switching to make it fail if bypassed.
* Minor fixes.
* Remove unused code.
* Py 3.8 check for deprecated loop argument.
* Fix a middleware cancellation handling test with py38.
* Linter 'n fixes
* Typing
* Stricter handling of request header size
* More specific error messages on Payload Too Large.
* Init http.response = None
* Messages further tuned.
* Always try to consume request body, plus minor cleanup.
* Add a missing check in case of close_if_idle on a dead connection.
* Avoid error messages on PayloadTooLarge.
* Add test for new API.
* json takes str, not bytes
* Default to no maximum request size for streaming handlers.
* Fix chunked mode crash.
* Header values should be strictly ASCII but both UTF-8 and Latin-1 exist. Use UTF-8B to
cope with all.
* Refactoring and cleanup.
* Unify response header processing of ASGI and asyncio modes.
* Avoid special handling of StreamingHTTPResponse.
* 35 % speedup in HTTP/1.1 response formatting (not so much overall effect).
* Duplicate set-cookie headers were being produced.
* Cleanup processed_headers some more.
* Linting
* Import ordering
* Response middleware ran by async request.respond().
* Need to check if transport is closing to avoid getting stuck in sending loops after peer has disconnected.
* Middleware and error handling refactoring.
* Linter
* Fix tracking of HTTP stage when writing to transport fails.
* Add clarifying comment
* Add a check for request body functions and a test for NotImplementedError.
* Linter and typing
* These must be tuples + hack mypy warnings away.
* New streaming test and minor fixes.
* Constant receive buffer size.
* 256 KiB send and receive buffers.
* Revert "256 KiB send and receive buffers."
This reverts commit abc1e3edb21a5e6925fa4c856657559608a8d65b.
* app.handle_exception already sends the response.
* Improved handling of errors during request.
* An odd hack to avoid an httpx limitation that causes test failures.
* Limit request header size to 8 KiB at most.
* Remove unnecessary use of format string.
* Cleanup tests
* Remove artifact
* Fix type checking
* Mark test for skipping
* Cleanup some edge cases
* Add ignore_body flag to safe methods
* Add unit tests for timeout logic
* Add unit tests for timeout logic
* Fix Mock usage in timeout test
* Change logging test to only logger in handler
* Windows py3.8 logging issue with current testing client
* Add test_header_size_exceeded
* Resolve merge conflicts
* Add request middleware to hard exception handling
* Add request middleware to hard exception handling
* Request middleware on exception handlers
* Linting
* Cleanup deprecations
Co-authored-by: L. Kärkkäinen <tronic@users.noreply.github.com>
Co-authored-by: Adam Hopkins <admhpkns@gmail.com>
2021-01-10 22:45:36 +00:00
|
|
|
@app.post("/stream", stream=True)
|
2019-05-27 00:11:52 +01:00
|
|
|
async def handler_stream(request):
|
|
|
|
while True:
|
|
|
|
body = await request.stream.read()
|
|
|
|
if body is None:
|
|
|
|
break
|
|
|
|
body = body.decode("utf-8").replace("1", "A")
|
Streaming Server (#1876)
* Streaming request by async for.
* Make all requests streaming and preload body for non-streaming handlers.
* Cleanup of code and avoid mixing streaming responses.
* Async http protocol loop.
* Change of test: don't require early bad request error but only after CRLF-CRLF.
* Add back streaming requests.
* Rewritten request body parser.
* Misc. cleanup, down to 4 failing tests.
* All tests OK.
* Entirely remove request body queue.
* Let black f*ckup the layout
* Better testing error messages on protocol errors.
* Remove StreamBuffer tests because the type is about to be removed.
* Remove tests using the deprecated get_headers function that can no longer be supported. Chunked mode is now autodetected, so do not put content-length header if chunked mode is preferred.
* Major refactoring of HTTP protocol handling (new module http.py added), all requests made streaming. A few compatibility issues and a lot of cleanup to be done remain, 16 tests failing.
* Terminate check_timeouts once connection_task finishes.
* Code cleanup, 14 tests failing.
* Much cleanup, 12 failing...
* Even more cleanup and error checking, 8 failing tests.
* Remove keep-alive header from responses. First of all, it should say timeout=<value> which wasn't the case with existing implementation, and secondly none of the other web servers I tried include this header.
* Everything but CustomServer OK.
* Linter
* Disable custom protocol test
* Remove unnecessary variables, optimise performance.
* A test was missing that body_init/body_push/body_finish are never called. Rewritten using receive_body and case switching to make it fail if bypassed.
* Minor fixes.
* Remove unused code.
* Py 3.8 check for deprecated loop argument.
* Fix a middleware cancellation handling test with py38.
* Linter 'n fixes
* Typing
* Stricter handling of request header size
* More specific error messages on Payload Too Large.
* Init http.response = None
* Messages further tuned.
* Always try to consume request body, plus minor cleanup.
* Add a missing check in case of close_if_idle on a dead connection.
* Avoid error messages on PayloadTooLarge.
* Add test for new API.
* json takes str, not bytes
* Default to no maximum request size for streaming handlers.
* Fix chunked mode crash.
* Header values should be strictly ASCII but both UTF-8 and Latin-1 exist. Use UTF-8B to
cope with all.
* Refactoring and cleanup.
* Unify response header processing of ASGI and asyncio modes.
* Avoid special handling of StreamingHTTPResponse.
* 35 % speedup in HTTP/1.1 response formatting (not so much overall effect).
* Duplicate set-cookie headers were being produced.
* Cleanup processed_headers some more.
* Linting
* Import ordering
* Response middleware ran by async request.respond().
* Need to check if transport is closing to avoid getting stuck in sending loops after peer has disconnected.
* Middleware and error handling refactoring.
* Linter
* Fix tracking of HTTP stage when writing to transport fails.
* Add clarifying comment
* Add a check for request body functions and a test for NotImplementedError.
* Linter and typing
* These must be tuples + hack mypy warnings away.
* New streaming test and minor fixes.
* Constant receive buffer size.
* 256 KiB send and receive buffers.
* Revert "256 KiB send and receive buffers."
This reverts commit abc1e3edb21a5e6925fa4c856657559608a8d65b.
* app.handle_exception already sends the response.
* Improved handling of errors during request.
* An odd hack to avoid an httpx limitation that causes test failures.
* Limit request header size to 8 KiB at most.
* Remove unnecessary use of format string.
* Cleanup tests
* Remove artifact
* Fix type checking
* Mark test for skipping
* Cleanup some edge cases
* Add ignore_body flag to safe methods
* Add unit tests for timeout logic
* Add unit tests for timeout logic
* Fix Mock usage in timeout test
* Change logging test to only logger in handler
* Windows py3.8 logging issue with current testing client
* Add test_header_size_exceeded
* Resolve merge conflicts
* Add request middleware to hard exception handling
* Add request middleware to hard exception handling
* Request middleware on exception handlers
* Linting
* Cleanup deprecations
Co-authored-by: L. Kärkkäinen <tronic@users.noreply.github.com>
Co-authored-by: Adam Hopkins <admhpkns@gmail.com>
2021-01-10 22:45:36 +00:00
|
|
|
await response.write(body)
|
2019-06-04 10:59:15 +01:00
|
|
|
return response.stream(body)
|
2019-05-27 10:33:25 +01:00
|
|
|
|
|
|
|
|
2021-11-23 21:00:25 +00:00
|
|
|
@app.before_server_start
|
2019-05-27 10:33:25 +01:00
|
|
|
async def listener_before_server_start(*args, **kwargs):
|
|
|
|
print("before_server_start")
|
|
|
|
|
|
|
|
|
2021-11-23 21:00:25 +00:00
|
|
|
@app.after_server_start
|
2019-05-27 10:33:25 +01:00
|
|
|
async def listener_after_server_start(*args, **kwargs):
|
|
|
|
print("after_server_start")
|
|
|
|
|
|
|
|
|
2021-11-23 21:00:25 +00:00
|
|
|
@app.before_server_stop
|
2019-05-27 10:33:25 +01:00
|
|
|
async def listener_before_server_stop(*args, **kwargs):
|
|
|
|
print("before_server_stop")
|
|
|
|
|
|
|
|
|
2021-11-23 21:00:25 +00:00
|
|
|
@app.after_server_stop
|
2019-05-27 10:33:25 +01:00
|
|
|
async def listener_after_server_stop(*args, **kwargs):
|
|
|
|
print("after_server_stop")
|
|
|
|
|
|
|
|
|
2021-11-23 21:00:25 +00:00
|
|
|
@app.on_request
|
2019-05-27 10:33:25 +01:00
|
|
|
async def print_on_request(request):
|
|
|
|
print("print_on_request")
|
|
|
|
|
|
|
|
|
2021-11-23 21:00:25 +00:00
|
|
|
@app.on_response
|
2019-05-27 10:33:25 +01:00
|
|
|
async def print_on_response(request, response):
|
|
|
|
print("print_on_response")
|