Compare commits
12 Commits
monitor-re
...
middleware
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
38b4ccf2bc | ||
|
|
8b970dd490 | ||
|
|
c9be17e8da | ||
|
|
19f642b364 | ||
|
|
c4c39cb082 | ||
|
|
c7bac72137 | ||
|
|
beb5c62767 | ||
|
|
09b59d34fe | ||
|
|
78bc475bb1 | ||
|
|
b59131504b | ||
|
|
782e0881e5 | ||
|
|
c72cbe4326 |
66
.github/ISSUE_TEMPLATE/bug-report.yml
vendored
66
.github/ISSUE_TEMPLATE/bug-report.yml
vendored
@@ -1,66 +0,0 @@
|
|||||||
name: 🐞 Bug report
|
|
||||||
description: Create a report to help us improve
|
|
||||||
labels: ["bug", "triage"]
|
|
||||||
body:
|
|
||||||
- type: checkboxes
|
|
||||||
id: existing
|
|
||||||
attributes:
|
|
||||||
label: Is there an existing issue for this?
|
|
||||||
description: Please search to see if an issue already exists for the bug you encountered.
|
|
||||||
options:
|
|
||||||
- label: I have searched the existing issues
|
|
||||||
required: true
|
|
||||||
- type: textarea
|
|
||||||
id: description
|
|
||||||
attributes:
|
|
||||||
label: Describe the bug
|
|
||||||
description: A clear and concise description of what the bug is, make sure to paste any exceptions and tracebacks using markdown code-block syntax to make it easier to read.
|
|
||||||
validations:
|
|
||||||
required: true
|
|
||||||
- type: textarea
|
|
||||||
id: code
|
|
||||||
attributes:
|
|
||||||
label: Code snippet
|
|
||||||
description: Relevant source code, make sure to remove what is not necessary.
|
|
||||||
validations:
|
|
||||||
required: false
|
|
||||||
- type: textarea
|
|
||||||
id: expected
|
|
||||||
attributes:
|
|
||||||
label: Expected Behavior
|
|
||||||
description: A concise description of what you expected to happen.
|
|
||||||
validations:
|
|
||||||
required: false
|
|
||||||
- type: dropdown
|
|
||||||
id: running
|
|
||||||
attributes:
|
|
||||||
label: How do you run Sanic?
|
|
||||||
options:
|
|
||||||
- Sanic CLI
|
|
||||||
- As a module
|
|
||||||
- As a script (`app.run` or `Sanic.serve`)
|
|
||||||
- ASGI
|
|
||||||
validations:
|
|
||||||
required: true
|
|
||||||
- type: input
|
|
||||||
id: os
|
|
||||||
attributes:
|
|
||||||
label: Operating System
|
|
||||||
description: What OS?
|
|
||||||
validations:
|
|
||||||
required: true
|
|
||||||
- type: input
|
|
||||||
id: version
|
|
||||||
attributes:
|
|
||||||
label: Sanic Version
|
|
||||||
description: Check startup logs or try `sanic --version`
|
|
||||||
validations:
|
|
||||||
required: true
|
|
||||||
- type: textarea
|
|
||||||
id: additional
|
|
||||||
attributes:
|
|
||||||
label: Additional context
|
|
||||||
description: Add any other context about the problem here.
|
|
||||||
validations:
|
|
||||||
required: false
|
|
||||||
|
|
||||||
27
.github/ISSUE_TEMPLATE/bug_report.md
vendored
Normal file
27
.github/ISSUE_TEMPLATE/bug_report.md
vendored
Normal file
@@ -0,0 +1,27 @@
|
|||||||
|
---
|
||||||
|
name: Bug report
|
||||||
|
about: Create a report to help us improve
|
||||||
|
labels: ["bug"]
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
**Describe the bug**
|
||||||
|
<!-- A clear and concise description of what the bug is, make sure to paste any exceptions and tracebacks. -->
|
||||||
|
|
||||||
|
|
||||||
|
**Code snippet**
|
||||||
|
<!-- Relevant source code, make sure to remove what is not necessary. -->
|
||||||
|
|
||||||
|
|
||||||
|
**Expected behavior**
|
||||||
|
<!-- A clear and concise description of what you expected to happen. -->
|
||||||
|
|
||||||
|
|
||||||
|
**Environment (please complete the following information):**
|
||||||
|
<!-- Please provide the information below. Instead, you can copy and paste the message that Sanic shows on startup. If you do, please remember to format it with ``` -->
|
||||||
|
- OS:
|
||||||
|
- Sanic Version:
|
||||||
|
|
||||||
|
|
||||||
|
**Additional context**
|
||||||
|
<!-- Add any other context about the problem here. -->
|
||||||
2
.github/ISSUE_TEMPLATE/config.yml
vendored
2
.github/ISSUE_TEMPLATE/config.yml
vendored
@@ -1,4 +1,4 @@
|
|||||||
blank_issues_enabled: false
|
blank_issues_enabled: true
|
||||||
contact_links:
|
contact_links:
|
||||||
- name: Questions and Help
|
- name: Questions and Help
|
||||||
url: https://community.sanicframework.org/c/questions-and-help
|
url: https://community.sanicframework.org/c/questions-and-help
|
||||||
|
|||||||
34
.github/ISSUE_TEMPLATE/feature-request.yml
vendored
34
.github/ISSUE_TEMPLATE/feature-request.yml
vendored
@@ -1,34 +0,0 @@
|
|||||||
name: 🌟 Feature request
|
|
||||||
description: Suggest an enhancement for Sanic
|
|
||||||
labels: ["feature request"]
|
|
||||||
body:
|
|
||||||
- type: checkboxes
|
|
||||||
id: existing
|
|
||||||
attributes:
|
|
||||||
label: Is there an existing issue for this?
|
|
||||||
description: Please search to see if an issue already exists for the enhancement you are proposing.
|
|
||||||
options:
|
|
||||||
- label: I have searched the existing issues
|
|
||||||
required: true
|
|
||||||
- type: textarea
|
|
||||||
id: description
|
|
||||||
attributes:
|
|
||||||
label: Is your feature request related to a problem? Please describe.
|
|
||||||
description: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
|
|
||||||
validations:
|
|
||||||
required: false
|
|
||||||
- type: textarea
|
|
||||||
id: code
|
|
||||||
attributes:
|
|
||||||
label: Describe the solution you'd like
|
|
||||||
description: A clear and concise description of what you want to happen.
|
|
||||||
validations:
|
|
||||||
required: true
|
|
||||||
- type: textarea
|
|
||||||
id: additional
|
|
||||||
attributes:
|
|
||||||
label: Additional context
|
|
||||||
description: Add any other context about the problem here.
|
|
||||||
validations:
|
|
||||||
required: false
|
|
||||||
|
|
||||||
17
.github/ISSUE_TEMPLATE/feature_request.md
vendored
Normal file
17
.github/ISSUE_TEMPLATE/feature_request.md
vendored
Normal file
@@ -0,0 +1,17 @@
|
|||||||
|
---
|
||||||
|
name: Feature request
|
||||||
|
about: Suggest an idea for Sanic
|
||||||
|
labels: ["feature request"]
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
**Is your feature request related to a problem? Please describe.**
|
||||||
|
<!-- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] -->
|
||||||
|
|
||||||
|
|
||||||
|
**Describe the solution you'd like**
|
||||||
|
<!-- A clear and concise description of what you want to happen. -->
|
||||||
|
|
||||||
|
|
||||||
|
**Additional context**
|
||||||
|
<!-- Add any other context or sample code about the feature request here. -->
|
||||||
@@ -102,6 +102,9 @@ Installation
|
|||||||
If you are running on a clean install of Fedora 28 or above, please make sure you have the ``redhat-rpm-config`` package installed in case if you want to
|
If you are running on a clean install of Fedora 28 or above, please make sure you have the ``redhat-rpm-config`` package installed in case if you want to
|
||||||
use ``sanic`` with ``ujson`` dependency.
|
use ``sanic`` with ``ujson`` dependency.
|
||||||
|
|
||||||
|
.. note::
|
||||||
|
|
||||||
|
Windows support is currently "experimental" and on a best-effort basis. Multiple workers are also not currently supported on Windows (see `Issue #1517 <https://github.com/sanic-org/sanic/issues/1517>`_), but setting ``workers=1`` should launch the server successfully.
|
||||||
|
|
||||||
Hello World Example
|
Hello World Example
|
||||||
-------------------
|
-------------------
|
||||||
|
|||||||
@@ -7,8 +7,7 @@ Sanic releases long term support release once a year in December. LTS releases r
|
|||||||
|
|
||||||
| Version | LTS | Supported |
|
| Version | LTS | Supported |
|
||||||
| ------- | ------------- | ----------------------- |
|
| ------- | ------------- | ----------------------- |
|
||||||
| 22.9 | | :white_check_mark: |
|
| 22.6 | | :white_check_mark: |
|
||||||
| 22.6 | | :x: |
|
|
||||||
| 22.3 | | :x: |
|
| 22.3 | | :x: |
|
||||||
| 21.12 | until 2023-12 | :white_check_mark: |
|
| 21.12 | until 2023-12 | :white_check_mark: |
|
||||||
| 21.9 | | :x: |
|
| 21.9 | | :x: |
|
||||||
|
|||||||
9
docs/_static/custom.css
vendored
9
docs/_static/custom.css
vendored
@@ -2,12 +2,3 @@
|
|||||||
.wy-nav-top {
|
.wy-nav-top {
|
||||||
background: #444444;
|
background: #444444;
|
||||||
}
|
}
|
||||||
|
|
||||||
#changelog section {
|
|
||||||
padding-left: 3rem;
|
|
||||||
}
|
|
||||||
|
|
||||||
#changelog section h2,
|
|
||||||
#changelog section h3 {
|
|
||||||
margin-left: -3rem;
|
|
||||||
}
|
|
||||||
|
|||||||
@@ -1,7 +1,6 @@
|
|||||||
📜 Changelog
|
📜 Changelog
|
||||||
============
|
============
|
||||||
|
|
||||||
.. mdinclude:: ./releases/22/22.9.md
|
|
||||||
.. mdinclude:: ./releases/22/22.6.md
|
.. mdinclude:: ./releases/22/22.6.md
|
||||||
.. mdinclude:: ./releases/22/22.3.md
|
.. mdinclude:: ./releases/22/22.3.md
|
||||||
.. mdinclude:: ./releases/21/21.12.md
|
.. mdinclude:: ./releases/21/21.12.md
|
||||||
|
|||||||
@@ -1,17 +1,6 @@
|
|||||||
## Version 22.6.2
|
## Version 22.6.0 🔶
|
||||||
|
|
||||||
### Bugfixes
|
_Current version_
|
||||||
|
|
||||||
- [#2522](https://github.com/sanic-org/sanic/pull/2522) Always show server location in ASGI
|
|
||||||
|
|
||||||
## Version 22.6.1
|
|
||||||
|
|
||||||
### Bugfixes
|
|
||||||
|
|
||||||
- [#2477](https://github.com/sanic-org/sanic/pull/2477) Sanic static directory fails when folder name ends with ".."
|
|
||||||
|
|
||||||
|
|
||||||
## Version 22.6.0
|
|
||||||
|
|
||||||
### Features
|
### Features
|
||||||
- [#2378](https://github.com/sanic-org/sanic/pull/2378) Introduce HTTP/3 and autogeneration of TLS certificates in `DEBUG` mode
|
- [#2378](https://github.com/sanic-org/sanic/pull/2378) Introduce HTTP/3 and autogeneration of TLS certificates in `DEBUG` mode
|
||||||
|
|||||||
@@ -1,47 +0,0 @@
|
|||||||
## Version 22.9.0 🔶
|
|
||||||
|
|
||||||
_Current version_
|
|
||||||
|
|
||||||
### Features
|
|
||||||
|
|
||||||
- [#2445](https://github.com/sanic-org/sanic/pull/2445) Add custom loads function
|
|
||||||
- [#2490](https://github.com/sanic-org/sanic/pull/2490) Make `WebsocketImplProtocol` async iterable
|
|
||||||
- [#2499](https://github.com/sanic-org/sanic/pull/2499) Sanic Server WorkerManager refactor
|
|
||||||
- [#2506](https://github.com/sanic-org/sanic/pull/2506) Use `pathlib` for path resolution (for static file serving)
|
|
||||||
- [#2508](https://github.com/sanic-org/sanic/pull/2508) Use `path.parts` instead of `match` (for static file serving)
|
|
||||||
- [#2513](https://github.com/sanic-org/sanic/pull/2513) Better request cancel handling
|
|
||||||
- [#2516](https://github.com/sanic-org/sanic/pull/2516) Add request properties for HTTP method info:
|
|
||||||
- `request.is_safe`
|
|
||||||
- `request.is_idempotent`
|
|
||||||
- `request.is_cacheable`
|
|
||||||
- *See* [MDN docs](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods) *for more information about when these apply*
|
|
||||||
- [#2522](https://github.com/sanic-org/sanic/pull/2522) Always show server location in ASGI
|
|
||||||
- [#2526](https://github.com/sanic-org/sanic/pull/2526) Cache control support for static files for returning 304 when appropriate
|
|
||||||
- [#2533](https://github.com/sanic-org/sanic/pull/2533) Refactor `_static_request_handler`
|
|
||||||
- [#2540](https://github.com/sanic-org/sanic/pull/2540) Add signals before and after handler execution
|
|
||||||
- `http.handler.before`
|
|
||||||
- `http.handler.after`
|
|
||||||
- [#2542](https://github.com/sanic-org/sanic/pull/2542) Add *[redacted]* to CLI :)
|
|
||||||
- [#2546](https://github.com/sanic-org/sanic/pull/2546) Add deprecation warning filter
|
|
||||||
- [#2550](https://github.com/sanic-org/sanic/pull/2550) Middleware priority and performance enhancements
|
|
||||||
|
|
||||||
### Bugfixes
|
|
||||||
|
|
||||||
- [#2495](https://github.com/sanic-org/sanic/pull/2495) Prevent directory traversion with static files
|
|
||||||
- [#2515](https://github.com/sanic-org/sanic/pull/2515) Do not apply double slash to paths in certain static dirs in Blueprints
|
|
||||||
|
|
||||||
### Deprecations and Removals
|
|
||||||
|
|
||||||
- [#2525](https://github.com/sanic-org/sanic/pull/2525) Warn on duplicate route names, will be prevented outright in v23.3
|
|
||||||
- [#2537](https://github.com/sanic-org/sanic/pull/2537) Raise warning and deprecation notice on duplicate exceptions, will be prevented outright in v23.3
|
|
||||||
|
|
||||||
### Developer infrastructure
|
|
||||||
|
|
||||||
- [#2504](https://github.com/sanic-org/sanic/pull/2504) Cleanup test suite
|
|
||||||
- [#2505](https://github.com/sanic-org/sanic/pull/2505) Replace Unsupported Python Version Number from the Contributing Doc
|
|
||||||
- [#2530](https://github.com/sanic-org/sanic/pull/2530) Do not include tests folder in installed package resolver
|
|
||||||
|
|
||||||
### Improved Documentation
|
|
||||||
|
|
||||||
- [#2502](https://github.com/sanic-org/sanic/pull/2502) Fix a few typos
|
|
||||||
- [#2517](https://github.com/sanic-org/sanic/pull/2517) [#2536](https://github.com/sanic-org/sanic/pull/2536) Add some type hints
|
|
||||||
@@ -1 +1 @@
|
|||||||
__version__ = "22.12.0a0"
|
__version__ = "22.9.1"
|
||||||
|
|||||||
405
sanic/app.py
405
sanic/app.py
@@ -21,7 +21,6 @@ from functools import partial
|
|||||||
from inspect import isawaitable
|
from inspect import isawaitable
|
||||||
from os import environ
|
from os import environ
|
||||||
from socket import socket
|
from socket import socket
|
||||||
from traceback import format_exc
|
|
||||||
from types import SimpleNamespace
|
from types import SimpleNamespace
|
||||||
from typing import (
|
from typing import (
|
||||||
TYPE_CHECKING,
|
TYPE_CHECKING,
|
||||||
@@ -47,21 +46,16 @@ from sanic_routing.exceptions import FinalizationError, NotFound
|
|||||||
from sanic_routing.route import Route
|
from sanic_routing.route import Route
|
||||||
|
|
||||||
from sanic.application.ext import setup_ext
|
from sanic.application.ext import setup_ext
|
||||||
from sanic.application.state import ApplicationState, ServerStage
|
from sanic.application.state import ApplicationState, Mode, ServerStage
|
||||||
from sanic.asgi import ASGIApp
|
from sanic.asgi import ASGIApp
|
||||||
from sanic.base.root import BaseSanic
|
from sanic.base.root import BaseSanic
|
||||||
from sanic.blueprint_group import BlueprintGroup
|
from sanic.blueprint_group import BlueprintGroup
|
||||||
from sanic.blueprints import Blueprint
|
from sanic.blueprints import Blueprint
|
||||||
from sanic.compat import OS_IS_WINDOWS, enable_windows_color_support
|
from sanic.compat import OS_IS_WINDOWS, enable_windows_color_support
|
||||||
from sanic.config import SANIC_PREFIX, Config
|
from sanic.config import SANIC_PREFIX, Config
|
||||||
from sanic.exceptions import (
|
from sanic.exceptions import BadRequest, SanicException, URLBuildError
|
||||||
BadRequest,
|
|
||||||
SanicException,
|
|
||||||
ServerError,
|
|
||||||
URLBuildError,
|
|
||||||
)
|
|
||||||
from sanic.handlers import ErrorHandler
|
from sanic.handlers import ErrorHandler
|
||||||
from sanic.helpers import Default
|
from sanic.helpers import _default
|
||||||
from sanic.http import Stage
|
from sanic.http import Stage
|
||||||
from sanic.log import (
|
from sanic.log import (
|
||||||
LOGGING_CONFIG_DEFAULTS,
|
LOGGING_CONFIG_DEFAULTS,
|
||||||
@@ -83,7 +77,7 @@ from sanic.models.futures import (
|
|||||||
from sanic.models.handler_types import ListenerType, MiddlewareType
|
from sanic.models.handler_types import ListenerType, MiddlewareType
|
||||||
from sanic.models.handler_types import Sanic as SanicVar
|
from sanic.models.handler_types import Sanic as SanicVar
|
||||||
from sanic.request import Request
|
from sanic.request import Request
|
||||||
from sanic.response import BaseHTTPResponse, HTTPResponse, ResponseStream
|
from sanic.response import BaseHTTPResponse
|
||||||
from sanic.router import Router
|
from sanic.router import Router
|
||||||
from sanic.server.websockets.impl import ConnectionClosed
|
from sanic.server.websockets.impl import ConnectionClosed
|
||||||
from sanic.signals import Signal, SignalRouter
|
from sanic.signals import Signal, SignalRouter
|
||||||
@@ -158,6 +152,7 @@ class Sanic(BaseSanic, StartupMixin, metaclass=TouchUpMeta):
|
|||||||
)
|
)
|
||||||
|
|
||||||
_app_registry: Dict[str, "Sanic"] = {}
|
_app_registry: Dict[str, "Sanic"] = {}
|
||||||
|
_uvloop_setting = None # TODO: Remove in v22.6
|
||||||
test_mode = False
|
test_mode = False
|
||||||
|
|
||||||
def __init__(
|
def __init__(
|
||||||
@@ -393,8 +388,8 @@ class Sanic(BaseSanic, StartupMixin, metaclass=TouchUpMeta):
|
|||||||
routes = [routes]
|
routes = [routes]
|
||||||
|
|
||||||
for r in routes:
|
for r in routes:
|
||||||
r.extra.websocket = websocket
|
r.ctx.websocket = websocket
|
||||||
r.extra.static = params.get("static", False)
|
r.ctx.static = params.get("static", False)
|
||||||
r.ctx.__dict__.update(ctx)
|
r.ctx.__dict__.update(ctx)
|
||||||
|
|
||||||
return routes
|
return routes
|
||||||
@@ -480,14 +475,15 @@ class Sanic(BaseSanic, StartupMixin, metaclass=TouchUpMeta):
|
|||||||
for item in blueprint:
|
for item in blueprint:
|
||||||
params = {**options}
|
params = {**options}
|
||||||
if isinstance(blueprint, BlueprintGroup):
|
if isinstance(blueprint, BlueprintGroup):
|
||||||
|
if blueprint.url_prefix:
|
||||||
merge_from = [
|
merge_from = [
|
||||||
options.get("url_prefix", ""),
|
options.get("url_prefix", ""),
|
||||||
blueprint.url_prefix or "",
|
blueprint.url_prefix,
|
||||||
]
|
]
|
||||||
if not isinstance(item, BlueprintGroup):
|
if not isinstance(item, BlueprintGroup):
|
||||||
merge_from.append(item.url_prefix or "")
|
merge_from.append(item.url_prefix or "")
|
||||||
merged_prefix = "/".join(
|
merged_prefix = "/".join(
|
||||||
u.strip("/") for u in merge_from if u
|
u.strip("/") for u in merge_from
|
||||||
).rstrip("/")
|
).rstrip("/")
|
||||||
params["url_prefix"] = f"/{merged_prefix}"
|
params["url_prefix"] = f"/{merged_prefix}"
|
||||||
|
|
||||||
@@ -587,7 +583,7 @@ class Sanic(BaseSanic, StartupMixin, metaclass=TouchUpMeta):
|
|||||||
|
|
||||||
uri = route.path
|
uri = route.path
|
||||||
|
|
||||||
if getattr(route.extra, "static", None):
|
if getattr(route.ctx, "static", None):
|
||||||
filename = kwargs.pop("filename", "")
|
filename = kwargs.pop("filename", "")
|
||||||
# it's static folder
|
# it's static folder
|
||||||
if "__file_uri__" in uri:
|
if "__file_uri__" in uri:
|
||||||
@@ -620,18 +616,18 @@ class Sanic(BaseSanic, StartupMixin, metaclass=TouchUpMeta):
|
|||||||
host = kwargs.pop("_host", None)
|
host = kwargs.pop("_host", None)
|
||||||
external = kwargs.pop("_external", False) or bool(host)
|
external = kwargs.pop("_external", False) or bool(host)
|
||||||
scheme = kwargs.pop("_scheme", "")
|
scheme = kwargs.pop("_scheme", "")
|
||||||
if route.extra.hosts and external:
|
if route.ctx.hosts and external:
|
||||||
if not host and len(route.extra.hosts) > 1:
|
if not host and len(route.ctx.hosts) > 1:
|
||||||
raise ValueError(
|
raise ValueError(
|
||||||
f"Host is ambiguous: {', '.join(route.extra.hosts)}"
|
f"Host is ambiguous: {', '.join(route.ctx.hosts)}"
|
||||||
)
|
)
|
||||||
elif host and host not in route.extra.hosts:
|
elif host and host not in route.ctx.hosts:
|
||||||
raise ValueError(
|
raise ValueError(
|
||||||
f"Requested host ({host}) is not available for this "
|
f"Requested host ({host}) is not available for this "
|
||||||
f"route: {route.extra.hosts}"
|
f"route: {route.ctx.hosts}"
|
||||||
)
|
)
|
||||||
elif not host:
|
elif not host:
|
||||||
host = list(route.extra.hosts)[0]
|
host = list(route.ctx.hosts)[0]
|
||||||
|
|
||||||
if scheme and not external:
|
if scheme and not external:
|
||||||
raise ValueError("When specifying _scheme, _external must be True")
|
raise ValueError("When specifying _scheme, _external must be True")
|
||||||
@@ -712,276 +708,10 @@ class Sanic(BaseSanic, StartupMixin, metaclass=TouchUpMeta):
|
|||||||
exception: BaseException,
|
exception: BaseException,
|
||||||
run_middleware: bool = True,
|
run_middleware: bool = True,
|
||||||
): # no cov
|
): # no cov
|
||||||
"""
|
raise NotImplementedError
|
||||||
A handler that catches specific exceptions and outputs a response.
|
|
||||||
|
|
||||||
:param request: The current request object
|
|
||||||
:param exception: The exception that was raised
|
|
||||||
:raises ServerError: response 500
|
|
||||||
"""
|
|
||||||
response = None
|
|
||||||
await self.dispatch(
|
|
||||||
"http.lifecycle.exception",
|
|
||||||
inline=True,
|
|
||||||
context={"request": request, "exception": exception},
|
|
||||||
)
|
|
||||||
|
|
||||||
if (
|
|
||||||
request.stream is not None
|
|
||||||
and request.stream.stage is not Stage.HANDLER
|
|
||||||
):
|
|
||||||
error_logger.exception(exception, exc_info=True)
|
|
||||||
logger.error(
|
|
||||||
"The error response will not be sent to the client for "
|
|
||||||
f'the following exception:"{exception}". A previous response '
|
|
||||||
"has at least partially been sent."
|
|
||||||
)
|
|
||||||
|
|
||||||
handler = self.error_handler._lookup(
|
|
||||||
exception, request.name if request else None
|
|
||||||
)
|
|
||||||
if handler:
|
|
||||||
logger.warning(
|
|
||||||
"An error occurred while handling the request after at "
|
|
||||||
"least some part of the response was sent to the client. "
|
|
||||||
"The response from your custom exception handler "
|
|
||||||
f"{handler.__name__} will not be sent to the client."
|
|
||||||
"Exception handlers should only be used to generate the "
|
|
||||||
"exception responses. If you would like to perform any "
|
|
||||||
"other action on a raised exception, consider using a "
|
|
||||||
"signal handler like "
|
|
||||||
'`@app.signal("http.lifecycle.exception")`\n'
|
|
||||||
"For further information, please see the docs: "
|
|
||||||
"https://sanicframework.org/en/guide/advanced/"
|
|
||||||
"signals.html",
|
|
||||||
)
|
|
||||||
return
|
|
||||||
|
|
||||||
# -------------------------------------------- #
|
|
||||||
# Request Middleware
|
|
||||||
# -------------------------------------------- #
|
|
||||||
if run_middleware:
|
|
||||||
middleware = (
|
|
||||||
request.route and request.route.extra.request_middleware
|
|
||||||
) or self.request_middleware
|
|
||||||
response = await self._run_request_middleware(request, middleware)
|
|
||||||
# No middleware results
|
|
||||||
if not response:
|
|
||||||
try:
|
|
||||||
response = self.error_handler.response(request, exception)
|
|
||||||
if isawaitable(response):
|
|
||||||
response = await response
|
|
||||||
except Exception as e:
|
|
||||||
if isinstance(e, SanicException):
|
|
||||||
response = self.error_handler.default(request, e)
|
|
||||||
elif self.debug:
|
|
||||||
response = HTTPResponse(
|
|
||||||
(
|
|
||||||
f"Error while handling error: {e}\n"
|
|
||||||
f"Stack: {format_exc()}"
|
|
||||||
),
|
|
||||||
status=500,
|
|
||||||
)
|
|
||||||
else:
|
|
||||||
response = HTTPResponse(
|
|
||||||
"An error occurred while handling an error", status=500
|
|
||||||
)
|
|
||||||
if response is not None:
|
|
||||||
try:
|
|
||||||
request.reset_response()
|
|
||||||
response = await request.respond(response)
|
|
||||||
except BaseException:
|
|
||||||
# Skip response middleware
|
|
||||||
if request.stream:
|
|
||||||
request.stream.respond(response)
|
|
||||||
await response.send(end_stream=True)
|
|
||||||
raise
|
|
||||||
else:
|
|
||||||
if request.stream:
|
|
||||||
response = request.stream.response
|
|
||||||
|
|
||||||
# Marked for cleanup and DRY with handle_request/handle_exception
|
|
||||||
# when ResponseStream is no longer supporder
|
|
||||||
if isinstance(response, BaseHTTPResponse):
|
|
||||||
await self.dispatch(
|
|
||||||
"http.lifecycle.response",
|
|
||||||
inline=True,
|
|
||||||
context={
|
|
||||||
"request": request,
|
|
||||||
"response": response,
|
|
||||||
},
|
|
||||||
)
|
|
||||||
await response.send(end_stream=True)
|
|
||||||
elif isinstance(response, ResponseStream):
|
|
||||||
resp = await response(request)
|
|
||||||
await self.dispatch(
|
|
||||||
"http.lifecycle.response",
|
|
||||||
inline=True,
|
|
||||||
context={
|
|
||||||
"request": request,
|
|
||||||
"response": resp,
|
|
||||||
},
|
|
||||||
)
|
|
||||||
await response.eof()
|
|
||||||
else:
|
|
||||||
raise ServerError(
|
|
||||||
f"Invalid response type {response!r} (need HTTPResponse)"
|
|
||||||
)
|
|
||||||
|
|
||||||
async def handle_request(self, request: Request): # no cov
|
async def handle_request(self, request: Request): # no cov
|
||||||
"""Take a request from the HTTP Server and return a response object
|
raise NotImplementedError
|
||||||
to be sent back The HTTP Server only expects a response object, so
|
|
||||||
exception handling must be done here
|
|
||||||
|
|
||||||
:param request: HTTP Request object
|
|
||||||
:return: Nothing
|
|
||||||
"""
|
|
||||||
await self.dispatch(
|
|
||||||
"http.lifecycle.handle",
|
|
||||||
inline=True,
|
|
||||||
context={"request": request},
|
|
||||||
)
|
|
||||||
|
|
||||||
# Define `response` var here to remove warnings about
|
|
||||||
# allocation before assignment below.
|
|
||||||
response: Optional[
|
|
||||||
Union[
|
|
||||||
BaseHTTPResponse,
|
|
||||||
Coroutine[Any, Any, Optional[BaseHTTPResponse]],
|
|
||||||
]
|
|
||||||
] = None
|
|
||||||
run_middleware = True
|
|
||||||
try:
|
|
||||||
|
|
||||||
await self.dispatch(
|
|
||||||
"http.routing.before",
|
|
||||||
inline=True,
|
|
||||||
context={"request": request},
|
|
||||||
)
|
|
||||||
# Fetch handler from router
|
|
||||||
route, handler, kwargs = self.router.get(
|
|
||||||
request.path,
|
|
||||||
request.method,
|
|
||||||
request.headers.getone("host", None),
|
|
||||||
)
|
|
||||||
|
|
||||||
request._match_info = {**kwargs}
|
|
||||||
request.route = route
|
|
||||||
|
|
||||||
await self.dispatch(
|
|
||||||
"http.routing.after",
|
|
||||||
inline=True,
|
|
||||||
context={
|
|
||||||
"request": request,
|
|
||||||
"route": route,
|
|
||||||
"kwargs": kwargs,
|
|
||||||
"handler": handler,
|
|
||||||
},
|
|
||||||
)
|
|
||||||
|
|
||||||
if (
|
|
||||||
request.stream
|
|
||||||
and request.stream.request_body
|
|
||||||
and not route.extra.ignore_body
|
|
||||||
):
|
|
||||||
|
|
||||||
if hasattr(handler, "is_stream"):
|
|
||||||
# Streaming handler: lift the size limit
|
|
||||||
request.stream.request_max_size = float("inf")
|
|
||||||
else:
|
|
||||||
# Non-streaming handler: preload body
|
|
||||||
await request.receive_body()
|
|
||||||
|
|
||||||
# -------------------------------------------- #
|
|
||||||
# Request Middleware
|
|
||||||
# -------------------------------------------- #
|
|
||||||
run_middleware = False
|
|
||||||
if request.route.extra.request_middleware:
|
|
||||||
response = await self._run_request_middleware(
|
|
||||||
request, request.route.extra.request_middleware
|
|
||||||
)
|
|
||||||
|
|
||||||
# No middleware results
|
|
||||||
if not response:
|
|
||||||
# -------------------------------------------- #
|
|
||||||
# Execute Handler
|
|
||||||
# -------------------------------------------- #
|
|
||||||
|
|
||||||
if handler is None:
|
|
||||||
raise ServerError(
|
|
||||||
(
|
|
||||||
"'None' was returned while requesting a "
|
|
||||||
"handler from the router"
|
|
||||||
)
|
|
||||||
)
|
|
||||||
|
|
||||||
# Run response handler
|
|
||||||
await self.dispatch(
|
|
||||||
"http.handler.before",
|
|
||||||
inline=True,
|
|
||||||
context={"request": request},
|
|
||||||
)
|
|
||||||
response = handler(request, **request.match_info)
|
|
||||||
if isawaitable(response):
|
|
||||||
response = await response
|
|
||||||
await self.dispatch(
|
|
||||||
"http.handler.after",
|
|
||||||
inline=True,
|
|
||||||
context={"request": request},
|
|
||||||
)
|
|
||||||
|
|
||||||
if request.responded:
|
|
||||||
if response is not None:
|
|
||||||
error_logger.error(
|
|
||||||
"The response object returned by the route handler "
|
|
||||||
"will not be sent to client. The request has already "
|
|
||||||
"been responded to."
|
|
||||||
)
|
|
||||||
if request.stream is not None:
|
|
||||||
response = request.stream.response
|
|
||||||
elif response is not None:
|
|
||||||
response = await request.respond(response) # type: ignore
|
|
||||||
elif not hasattr(handler, "is_websocket"):
|
|
||||||
response = request.stream.response # type: ignore
|
|
||||||
|
|
||||||
# Marked for cleanup and DRY with handle_request/handle_exception
|
|
||||||
# when ResponseStream is no longer supporder
|
|
||||||
if isinstance(response, BaseHTTPResponse):
|
|
||||||
await self.dispatch(
|
|
||||||
"http.lifecycle.response",
|
|
||||||
inline=True,
|
|
||||||
context={
|
|
||||||
"request": request,
|
|
||||||
"response": response,
|
|
||||||
},
|
|
||||||
)
|
|
||||||
...
|
|
||||||
await response.send(end_stream=True)
|
|
||||||
elif isinstance(response, ResponseStream):
|
|
||||||
resp = await response(request) # type: ignore
|
|
||||||
await self.dispatch(
|
|
||||||
"http.lifecycle.response",
|
|
||||||
inline=True,
|
|
||||||
context={
|
|
||||||
"request": request,
|
|
||||||
"response": resp,
|
|
||||||
},
|
|
||||||
)
|
|
||||||
await response.eof() # type: ignore
|
|
||||||
else:
|
|
||||||
if not hasattr(handler, "is_websocket"):
|
|
||||||
raise ServerError(
|
|
||||||
f"Invalid response type {response!r} "
|
|
||||||
"(need HTTPResponse)"
|
|
||||||
)
|
|
||||||
|
|
||||||
except CancelledError:
|
|
||||||
raise
|
|
||||||
except Exception as e:
|
|
||||||
# Response Generation Failed
|
|
||||||
await self.handle_exception(
|
|
||||||
request, e, run_middleware=run_middleware
|
|
||||||
)
|
|
||||||
|
|
||||||
async def _websocket_handler(
|
async def _websocket_handler(
|
||||||
self, handler, request, *args, subprotocols=None, **kwargs
|
self, handler, request, *args, subprotocols=None, **kwargs
|
||||||
@@ -1344,6 +1074,18 @@ class Sanic(BaseSanic, StartupMixin, metaclass=TouchUpMeta):
|
|||||||
def debug(self):
|
def debug(self):
|
||||||
return self.state.is_debug
|
return self.state.is_debug
|
||||||
|
|
||||||
|
@debug.setter
|
||||||
|
def debug(self, value: bool):
|
||||||
|
deprecation(
|
||||||
|
"Setting the value of a Sanic application's debug value directly "
|
||||||
|
"is deprecated and will be removed in v22.9. Please set it using "
|
||||||
|
"the CLI, app.run, app.prepare, or directly set "
|
||||||
|
"app.state.mode to Mode.DEBUG.",
|
||||||
|
22.9,
|
||||||
|
)
|
||||||
|
mode = Mode.DEBUG if value else Mode.PRODUCTION
|
||||||
|
self.state.mode = mode
|
||||||
|
|
||||||
@property
|
@property
|
||||||
def auto_reload(self):
|
def auto_reload(self):
|
||||||
return self.config.AUTO_RELOAD
|
return self.config.AUTO_RELOAD
|
||||||
@@ -1360,6 +1102,58 @@ class Sanic(BaseSanic, StartupMixin, metaclass=TouchUpMeta):
|
|||||||
"""
|
"""
|
||||||
return self._state
|
return self._state
|
||||||
|
|
||||||
|
@property
|
||||||
|
def is_running(self):
|
||||||
|
deprecation(
|
||||||
|
"Use of the is_running property is no longer used by Sanic "
|
||||||
|
"internally. The property is now deprecated and will be removed "
|
||||||
|
"in version 22.9. You may continue to set the property for your "
|
||||||
|
"own needs until that time. If you would like to check whether "
|
||||||
|
"the application is operational, please use app.state.stage. More "
|
||||||
|
"information is available at ___.",
|
||||||
|
22.9,
|
||||||
|
)
|
||||||
|
return self.state.is_running
|
||||||
|
|
||||||
|
@is_running.setter
|
||||||
|
def is_running(self, value: bool):
|
||||||
|
deprecation(
|
||||||
|
"Use of the is_running property is no longer used by Sanic "
|
||||||
|
"internally. The property is now deprecated and will be removed "
|
||||||
|
"in version 22.9. You may continue to set the property for your "
|
||||||
|
"own needs until that time. If you would like to check whether "
|
||||||
|
"the application is operational, please use app.state.stage. More "
|
||||||
|
"information is available at ___.",
|
||||||
|
22.9,
|
||||||
|
)
|
||||||
|
self.state.is_running = value
|
||||||
|
|
||||||
|
@property
|
||||||
|
def is_stopping(self):
|
||||||
|
deprecation(
|
||||||
|
"Use of the is_stopping property is no longer used by Sanic "
|
||||||
|
"internally. The property is now deprecated and will be removed "
|
||||||
|
"in version 22.9. You may continue to set the property for your "
|
||||||
|
"own needs until that time. If you would like to check whether "
|
||||||
|
"the application is operational, please use app.state.stage. More "
|
||||||
|
"information is available at ___.",
|
||||||
|
22.9,
|
||||||
|
)
|
||||||
|
return self.state.is_stopping
|
||||||
|
|
||||||
|
@is_stopping.setter
|
||||||
|
def is_stopping(self, value: bool):
|
||||||
|
deprecation(
|
||||||
|
"Use of the is_stopping property is no longer used by Sanic "
|
||||||
|
"internally. The property is now deprecated and will be removed "
|
||||||
|
"in version 22.9. You may continue to set the property for your "
|
||||||
|
"own needs until that time. If you would like to check whether "
|
||||||
|
"the application is operational, please use app.state.stage. More "
|
||||||
|
"information is available at ___.",
|
||||||
|
22.9,
|
||||||
|
)
|
||||||
|
self.state.is_stopping = value
|
||||||
|
|
||||||
@property
|
@property
|
||||||
def reload_dirs(self):
|
def reload_dirs(self):
|
||||||
return self.state.reload_dirs
|
return self.state.reload_dirs
|
||||||
@@ -1452,24 +1246,7 @@ class Sanic(BaseSanic, StartupMixin, metaclass=TouchUpMeta):
|
|||||||
return cls.get_app("__mp_main__", force_create=force_create)
|
return cls.get_app("__mp_main__", force_create=force_create)
|
||||||
if force_create:
|
if force_create:
|
||||||
return cls(name)
|
return cls(name)
|
||||||
raise SanicException(
|
raise SanicException(f'Sanic app name "{name}" not found.')
|
||||||
f"Sanic app name '{name}' not found.\n"
|
|
||||||
"App instantiation must occur outside "
|
|
||||||
"if __name__ == '__main__' "
|
|
||||||
"block or by using an AppLoader.\nSee "
|
|
||||||
"https://sanic.dev/en/guide/deployment/app-loader.html"
|
|
||||||
" for more details."
|
|
||||||
)
|
|
||||||
|
|
||||||
@classmethod
|
|
||||||
def _check_uvloop_conflict(cls) -> None:
|
|
||||||
values = {app.config.USE_UVLOOP for app in cls._app_registry.values()}
|
|
||||||
if len(values) > 1:
|
|
||||||
error_logger.warning(
|
|
||||||
"It looks like you're running several apps with different "
|
|
||||||
"uvloop settings. This is not supported and may lead to "
|
|
||||||
"unintended behaviour."
|
|
||||||
)
|
|
||||||
|
|
||||||
# -------------------------------------------------------------------- #
|
# -------------------------------------------------------------------- #
|
||||||
# Lifecycle
|
# Lifecycle
|
||||||
@@ -1501,7 +1278,7 @@ class Sanic(BaseSanic, StartupMixin, metaclass=TouchUpMeta):
|
|||||||
|
|
||||||
if self.state.is_debug and self.config.TOUCHUP is not True:
|
if self.state.is_debug and self.config.TOUCHUP is not True:
|
||||||
self.config.TOUCHUP = False
|
self.config.TOUCHUP = False
|
||||||
elif isinstance(self.config.TOUCHUP, Default):
|
elif self.config.TOUCHUP is _default:
|
||||||
self.config.TOUCHUP = True
|
self.config.TOUCHUP = True
|
||||||
|
|
||||||
# Setup routers
|
# Setup routers
|
||||||
@@ -1520,7 +1297,17 @@ class Sanic(BaseSanic, StartupMixin, metaclass=TouchUpMeta):
|
|||||||
23.3,
|
23.3,
|
||||||
)
|
)
|
||||||
|
|
||||||
Sanic._check_uvloop_conflict()
|
# TODO: Replace in v22.6 to check against apps in app registry
|
||||||
|
if (
|
||||||
|
self.__class__._uvloop_setting is not None
|
||||||
|
and self.__class__._uvloop_setting != self.config.USE_UVLOOP
|
||||||
|
):
|
||||||
|
error_logger.warning(
|
||||||
|
"It looks like you're running several apps with different "
|
||||||
|
"uvloop settings. This is not supported and may lead to "
|
||||||
|
"unintended behaviour."
|
||||||
|
)
|
||||||
|
self.__class__._uvloop_setting = self.config.USE_UVLOOP
|
||||||
|
|
||||||
# Startup time optimizations
|
# Startup time optimizations
|
||||||
if self.state.primary:
|
if self.state.primary:
|
||||||
|
|||||||
@@ -8,6 +8,11 @@ from typing import TYPE_CHECKING
|
|||||||
if TYPE_CHECKING:
|
if TYPE_CHECKING:
|
||||||
from sanic import Sanic
|
from sanic import Sanic
|
||||||
|
|
||||||
|
try:
|
||||||
|
from sanic_ext import Extend # type: ignore
|
||||||
|
except ImportError:
|
||||||
|
...
|
||||||
|
|
||||||
|
|
||||||
def setup_ext(app: Sanic, *, fail: bool = False, **kwargs):
|
def setup_ext(app: Sanic, *, fail: bool = False, **kwargs):
|
||||||
if not app.config.AUTO_EXTEND:
|
if not app.config.AUTO_EXTEND:
|
||||||
@@ -28,7 +33,7 @@ def setup_ext(app: Sanic, *, fail: bool = False, **kwargs):
|
|||||||
return
|
return
|
||||||
|
|
||||||
if not getattr(app, "_ext", None):
|
if not getattr(app, "_ext", None):
|
||||||
Ext = getattr(sanic_ext, "Extend")
|
Ext: Extend = getattr(sanic_ext, "Extend")
|
||||||
app._ext = Ext(app, **kwargs)
|
app._ext = Ext(app, **kwargs)
|
||||||
|
|
||||||
return app.ext
|
return app.ext
|
||||||
|
|||||||
@@ -7,7 +7,8 @@ from urllib.parse import quote
|
|||||||
|
|
||||||
from sanic.compat import Header
|
from sanic.compat import Header
|
||||||
from sanic.exceptions import ServerError
|
from sanic.exceptions import ServerError
|
||||||
from sanic.helpers import Default
|
from sanic.handlers import RequestManager
|
||||||
|
from sanic.helpers import _default
|
||||||
from sanic.http import Stage
|
from sanic.http import Stage
|
||||||
from sanic.log import logger
|
from sanic.log import logger
|
||||||
from sanic.models.asgi import ASGIReceive, ASGIScope, ASGISend, MockTransport
|
from sanic.models.asgi import ASGIReceive, ASGIScope, ASGISend, MockTransport
|
||||||
@@ -61,7 +62,7 @@ class Lifespan:
|
|||||||
await self.asgi_app.sanic_app._server_event("init", "before")
|
await self.asgi_app.sanic_app._server_event("init", "before")
|
||||||
await self.asgi_app.sanic_app._server_event("init", "after")
|
await self.asgi_app.sanic_app._server_event("init", "after")
|
||||||
|
|
||||||
if not isinstance(self.asgi_app.sanic_app.config.USE_UVLOOP, Default):
|
if self.asgi_app.sanic_app.config.USE_UVLOOP is not _default:
|
||||||
warnings.warn(
|
warnings.warn(
|
||||||
"You have set the USE_UVLOOP configuration option, but Sanic "
|
"You have set the USE_UVLOOP configuration option, but Sanic "
|
||||||
"cannot control the event loop when running in ASGI mode."
|
"cannot control the event loop when running in ASGI mode."
|
||||||
@@ -230,11 +231,9 @@ class ASGIApp:
|
|||||||
"""
|
"""
|
||||||
Handle the incoming request.
|
Handle the incoming request.
|
||||||
"""
|
"""
|
||||||
|
manager = RequestManager.create(self.request)
|
||||||
try:
|
try:
|
||||||
self.stage = Stage.HANDLER
|
self.stage = Stage.HANDLER
|
||||||
await self.sanic_app.handle_request(self.request)
|
await manager.handle()
|
||||||
except Exception as e:
|
except Exception as e:
|
||||||
try:
|
await manager.error(e)
|
||||||
await self.sanic_app.handle_exception(self.request, e)
|
|
||||||
except Exception as exc:
|
|
||||||
await self.sanic_app.handle_exception(self.request, exc, False)
|
|
||||||
|
|||||||
@@ -406,7 +406,7 @@ class Blueprint(BaseSanic):
|
|||||||
|
|
||||||
self.routes += [route for route in routes if isinstance(route, Route)]
|
self.routes += [route for route in routes if isinstance(route, Route)]
|
||||||
self.websocket_routes += [
|
self.websocket_routes += [
|
||||||
route for route in self.routes if route.extra.websocket
|
route for route in self.routes if route.ctx.websocket
|
||||||
]
|
]
|
||||||
self.middlewares += middleware
|
self.middlewares += middleware
|
||||||
self.exceptions += exception_handlers
|
self.exceptions += exception_handlers
|
||||||
|
|||||||
@@ -3,7 +3,6 @@ import os
|
|||||||
import signal
|
import signal
|
||||||
import sys
|
import sys
|
||||||
|
|
||||||
from enum import Enum
|
|
||||||
from typing import Awaitable
|
from typing import Awaitable
|
||||||
|
|
||||||
from multidict import CIMultiDict # type: ignore
|
from multidict import CIMultiDict # type: ignore
|
||||||
@@ -20,31 +19,6 @@ except ImportError:
|
|||||||
pass
|
pass
|
||||||
|
|
||||||
|
|
||||||
# Python 3.11 changed the way Enum formatting works for mixed-in types.
|
|
||||||
if sys.version_info < (3, 11, 0):
|
|
||||||
|
|
||||||
class StrEnum(str, Enum):
|
|
||||||
pass
|
|
||||||
|
|
||||||
else:
|
|
||||||
from enum import StrEnum # type: ignore # noqa
|
|
||||||
|
|
||||||
|
|
||||||
class UpperStrEnum(StrEnum):
|
|
||||||
def _generate_next_value_(name, start, count, last_values):
|
|
||||||
return name.upper()
|
|
||||||
|
|
||||||
def __eq__(self, value: object) -> bool:
|
|
||||||
value = str(value).upper()
|
|
||||||
return super().__eq__(value)
|
|
||||||
|
|
||||||
def __hash__(self) -> int:
|
|
||||||
return hash(self.value)
|
|
||||||
|
|
||||||
def __str__(self) -> str:
|
|
||||||
return self.value
|
|
||||||
|
|
||||||
|
|
||||||
def enable_windows_color_support():
|
def enable_windows_color_support():
|
||||||
import ctypes
|
import ctypes
|
||||||
|
|
||||||
|
|||||||
@@ -8,11 +8,11 @@ from pathlib import Path
|
|||||||
from typing import Any, Callable, Dict, Optional, Sequence, Union
|
from typing import Any, Callable, Dict, Optional, Sequence, Union
|
||||||
from warnings import filterwarnings
|
from warnings import filterwarnings
|
||||||
|
|
||||||
from sanic.constants import LocalCertCreator, RestartOrder
|
from sanic.constants import LocalCertCreator
|
||||||
from sanic.errorpages import DEFAULT_FORMAT, check_error_format
|
from sanic.errorpages import DEFAULT_FORMAT, check_error_format
|
||||||
from sanic.helpers import Default, _default
|
from sanic.helpers import Default, _default
|
||||||
from sanic.http import Http
|
from sanic.http import Http
|
||||||
from sanic.log import error_logger
|
from sanic.log import deprecation, error_logger
|
||||||
from sanic.utils import load_module_from_file_location, str_to_bool
|
from sanic.utils import load_module_from_file_location, str_to_bool
|
||||||
|
|
||||||
|
|
||||||
@@ -63,7 +63,6 @@ DEFAULT_CONFIG = {
|
|||||||
"REQUEST_MAX_SIZE": 100000000, # 100 megabytes
|
"REQUEST_MAX_SIZE": 100000000, # 100 megabytes
|
||||||
"REQUEST_TIMEOUT": 60, # 60 seconds
|
"REQUEST_TIMEOUT": 60, # 60 seconds
|
||||||
"RESPONSE_TIMEOUT": 60, # 60 seconds
|
"RESPONSE_TIMEOUT": 60, # 60 seconds
|
||||||
"RESTART_ORDER": RestartOrder.SHUTDOWN_FIRST,
|
|
||||||
"TLS_CERT_PASSWORD": "",
|
"TLS_CERT_PASSWORD": "",
|
||||||
"TOUCHUP": _default,
|
"TOUCHUP": _default,
|
||||||
"USE_UVLOOP": _default,
|
"USE_UVLOOP": _default,
|
||||||
@@ -72,6 +71,10 @@ DEFAULT_CONFIG = {
|
|||||||
"WEBSOCKET_PING_TIMEOUT": 20,
|
"WEBSOCKET_PING_TIMEOUT": 20,
|
||||||
}
|
}
|
||||||
|
|
||||||
|
# These values will be removed from the Config object in v22.6 and moved
|
||||||
|
# to the application state
|
||||||
|
DEPRECATED_CONFIG = ("SERVER_RUNNING", "RELOADER_PROCESS", "RELOADED_FILES")
|
||||||
|
|
||||||
|
|
||||||
class DescriptorMeta(type):
|
class DescriptorMeta(type):
|
||||||
def __init__(cls, *_):
|
def __init__(cls, *_):
|
||||||
@@ -111,7 +114,6 @@ class Config(dict, metaclass=DescriptorMeta):
|
|||||||
REQUEST_MAX_SIZE: int
|
REQUEST_MAX_SIZE: int
|
||||||
REQUEST_TIMEOUT: int
|
REQUEST_TIMEOUT: int
|
||||||
RESPONSE_TIMEOUT: int
|
RESPONSE_TIMEOUT: int
|
||||||
RESTART_ORDER: Union[str, RestartOrder]
|
|
||||||
SERVER_NAME: str
|
SERVER_NAME: str
|
||||||
TLS_CERT_PASSWORD: str
|
TLS_CERT_PASSWORD: str
|
||||||
TOUCHUP: Union[Default, bool]
|
TOUCHUP: Union[Default, bool]
|
||||||
@@ -130,7 +132,6 @@ class Config(dict, metaclass=DescriptorMeta):
|
|||||||
):
|
):
|
||||||
defaults = defaults or {}
|
defaults = defaults or {}
|
||||||
super().__init__({**DEFAULT_CONFIG, **defaults})
|
super().__init__({**DEFAULT_CONFIG, **defaults})
|
||||||
self._configure_warnings()
|
|
||||||
|
|
||||||
self._converters = [str, str_to_bool, float, int]
|
self._converters = [str, str_to_bool, float, int]
|
||||||
|
|
||||||
@@ -148,6 +149,7 @@ class Config(dict, metaclass=DescriptorMeta):
|
|||||||
self.load_environment_vars(SANIC_PREFIX)
|
self.load_environment_vars(SANIC_PREFIX)
|
||||||
|
|
||||||
self._configure_header_size()
|
self._configure_header_size()
|
||||||
|
self._configure_warnings()
|
||||||
self._check_error_format()
|
self._check_error_format()
|
||||||
self._init = True
|
self._init = True
|
||||||
|
|
||||||
@@ -196,16 +198,12 @@ class Config(dict, metaclass=DescriptorMeta):
|
|||||||
self.LOCAL_CERT_CREATOR = LocalCertCreator[
|
self.LOCAL_CERT_CREATOR = LocalCertCreator[
|
||||||
self.LOCAL_CERT_CREATOR.upper()
|
self.LOCAL_CERT_CREATOR.upper()
|
||||||
]
|
]
|
||||||
elif attr == "RESTART_ORDER" and not isinstance(
|
|
||||||
self.RESTART_ORDER, RestartOrder
|
|
||||||
):
|
|
||||||
self.RESTART_ORDER = RestartOrder[self.RESTART_ORDER.upper()]
|
|
||||||
elif attr == "DEPRECATION_FILTER":
|
elif attr == "DEPRECATION_FILTER":
|
||||||
self._configure_warnings()
|
self._configure_warnings()
|
||||||
|
|
||||||
@property
|
@property
|
||||||
def FALLBACK_ERROR_FORMAT(self) -> str:
|
def FALLBACK_ERROR_FORMAT(self) -> str:
|
||||||
if isinstance(self._FALLBACK_ERROR_FORMAT, Default):
|
if self._FALLBACK_ERROR_FORMAT is _default:
|
||||||
return DEFAULT_FORMAT
|
return DEFAULT_FORMAT
|
||||||
return self._FALLBACK_ERROR_FORMAT
|
return self._FALLBACK_ERROR_FORMAT
|
||||||
|
|
||||||
@@ -213,7 +211,7 @@ class Config(dict, metaclass=DescriptorMeta):
|
|||||||
def FALLBACK_ERROR_FORMAT(self, value):
|
def FALLBACK_ERROR_FORMAT(self, value):
|
||||||
self._check_error_format(value)
|
self._check_error_format(value)
|
||||||
if (
|
if (
|
||||||
not isinstance(self._FALLBACK_ERROR_FORMAT, Default)
|
self._FALLBACK_ERROR_FORMAT is not _default
|
||||||
and value != self._FALLBACK_ERROR_FORMAT
|
and value != self._FALLBACK_ERROR_FORMAT
|
||||||
):
|
):
|
||||||
error_logger.warning(
|
error_logger.warning(
|
||||||
@@ -243,9 +241,7 @@ class Config(dict, metaclass=DescriptorMeta):
|
|||||||
"""
|
"""
|
||||||
Looks for prefixed environment variables and applies them to the
|
Looks for prefixed environment variables and applies them to the
|
||||||
configuration if present. This is called automatically when Sanic
|
configuration if present. This is called automatically when Sanic
|
||||||
starts up to load environment variables into config. Environment
|
starts up to load environment variables into config.
|
||||||
variables should start with the defined prefix and should only
|
|
||||||
contain uppercase letters.
|
|
||||||
|
|
||||||
It will automatically hydrate the following types:
|
It will automatically hydrate the following types:
|
||||||
|
|
||||||
@@ -271,9 +267,12 @@ class Config(dict, metaclass=DescriptorMeta):
|
|||||||
`See user guide re: config
|
`See user guide re: config
|
||||||
<https://sanicframework.org/guide/deployment/configuration.html>`__
|
<https://sanicframework.org/guide/deployment/configuration.html>`__
|
||||||
"""
|
"""
|
||||||
|
lower_case_var_found = False
|
||||||
for key, value in environ.items():
|
for key, value in environ.items():
|
||||||
if not key.startswith(prefix) or not key.isupper():
|
if not key.startswith(prefix):
|
||||||
continue
|
continue
|
||||||
|
if not key.isupper():
|
||||||
|
lower_case_var_found = True
|
||||||
|
|
||||||
_, config_key = key.split(prefix, 1)
|
_, config_key = key.split(prefix, 1)
|
||||||
|
|
||||||
@@ -283,6 +282,12 @@ class Config(dict, metaclass=DescriptorMeta):
|
|||||||
break
|
break
|
||||||
except ValueError:
|
except ValueError:
|
||||||
pass
|
pass
|
||||||
|
if lower_case_var_found:
|
||||||
|
deprecation(
|
||||||
|
"Lowercase environment variables will not be "
|
||||||
|
"loaded into Sanic config beginning in v22.9.",
|
||||||
|
22.9,
|
||||||
|
)
|
||||||
|
|
||||||
def update_config(self, config: Union[bytes, str, dict, Any]):
|
def update_config(self, config: Union[bytes, str, dict, Any]):
|
||||||
"""
|
"""
|
||||||
|
|||||||
@@ -1,9 +1,19 @@
|
|||||||
from enum import auto
|
from enum import Enum, auto
|
||||||
|
|
||||||
from sanic.compat import UpperStrEnum
|
|
||||||
|
|
||||||
|
|
||||||
class HTTPMethod(UpperStrEnum):
|
class HTTPMethod(str, Enum):
|
||||||
|
def _generate_next_value_(name, start, count, last_values):
|
||||||
|
return name.upper()
|
||||||
|
|
||||||
|
def __eq__(self, value: object) -> bool:
|
||||||
|
value = str(value).upper()
|
||||||
|
return super().__eq__(value)
|
||||||
|
|
||||||
|
def __hash__(self) -> int:
|
||||||
|
return hash(self.value)
|
||||||
|
|
||||||
|
def __str__(self) -> str:
|
||||||
|
return self.value
|
||||||
|
|
||||||
GET = auto()
|
GET = auto()
|
||||||
POST = auto()
|
POST = auto()
|
||||||
@@ -14,19 +24,15 @@ class HTTPMethod(UpperStrEnum):
|
|||||||
DELETE = auto()
|
DELETE = auto()
|
||||||
|
|
||||||
|
|
||||||
class LocalCertCreator(UpperStrEnum):
|
class LocalCertCreator(str, Enum):
|
||||||
|
def _generate_next_value_(name, start, count, last_values):
|
||||||
|
return name.upper()
|
||||||
|
|
||||||
AUTO = auto()
|
AUTO = auto()
|
||||||
TRUSTME = auto()
|
TRUSTME = auto()
|
||||||
MKCERT = auto()
|
MKCERT = auto()
|
||||||
|
|
||||||
|
|
||||||
class RestartOrder(UpperStrEnum):
|
|
||||||
|
|
||||||
SHUTDOWN_FIRST = auto()
|
|
||||||
STARTUP_FIRST = auto()
|
|
||||||
|
|
||||||
|
|
||||||
HTTP_METHODS = tuple(HTTPMethod.__members__.values())
|
HTTP_METHODS = tuple(HTTPMethod.__members__.values())
|
||||||
SAFE_HTTP_METHODS = (HTTPMethod.GET, HTTPMethod.HEAD, HTTPMethod.OPTIONS)
|
SAFE_HTTP_METHODS = (HTTPMethod.GET, HTTPMethod.HEAD, HTTPMethod.OPTIONS)
|
||||||
IDEMPOTENT_HTTP_METHODS = (
|
IDEMPOTENT_HTTP_METHODS = (
|
||||||
|
|||||||
@@ -448,8 +448,8 @@ def exception_response(
|
|||||||
# from the route
|
# from the route
|
||||||
if request.route:
|
if request.route:
|
||||||
try:
|
try:
|
||||||
if request.route.extra.error_format:
|
if request.route.ctx.error_format:
|
||||||
render_format = request.route.extra.error_format
|
render_format = request.route.ctx.error_format
|
||||||
except AttributeError:
|
except AttributeError:
|
||||||
...
|
...
|
||||||
|
|
||||||
|
|||||||
@@ -8,10 +8,6 @@ class RequestCancelled(CancelledError):
|
|||||||
quiet = True
|
quiet = True
|
||||||
|
|
||||||
|
|
||||||
class ServerKilled(Exception):
|
|
||||||
...
|
|
||||||
|
|
||||||
|
|
||||||
class SanicException(Exception):
|
class SanicException(Exception):
|
||||||
message: str = ""
|
message: str = ""
|
||||||
|
|
||||||
|
|||||||
@@ -1,16 +1,317 @@
|
|||||||
from __future__ import annotations
|
from __future__ import annotations
|
||||||
|
|
||||||
|
from functools import partial
|
||||||
|
from inspect import isawaitable
|
||||||
|
from traceback import format_exc
|
||||||
from typing import Dict, List, Optional, Tuple, Type
|
from typing import Dict, List, Optional, Tuple, Type
|
||||||
|
|
||||||
|
from sanic_routing import Route
|
||||||
|
|
||||||
from sanic.errorpages import BaseRenderer, TextRenderer, exception_response
|
from sanic.errorpages import BaseRenderer, TextRenderer, exception_response
|
||||||
from sanic.exceptions import (
|
from sanic.exceptions import (
|
||||||
HeaderNotFound,
|
HeaderNotFound,
|
||||||
InvalidRangeType,
|
InvalidRangeType,
|
||||||
RangeNotSatisfiable,
|
RangeNotSatisfiable,
|
||||||
|
SanicException,
|
||||||
|
ServerError,
|
||||||
)
|
)
|
||||||
from sanic.log import deprecation, error_logger
|
from sanic.http.constants import Stage
|
||||||
|
from sanic.log import deprecation, error_logger, logger
|
||||||
from sanic.models.handler_types import RouteHandler
|
from sanic.models.handler_types import RouteHandler
|
||||||
from sanic.response import text
|
from sanic.request import Request
|
||||||
|
from sanic.response import BaseHTTPResponse, HTTPResponse, ResponseStream, text
|
||||||
|
from sanic.touchup import TouchUpMeta
|
||||||
|
|
||||||
|
|
||||||
|
class RequestHandler:
|
||||||
|
def __init__(self, func, request_middleware, response_middleware):
|
||||||
|
self.func = func.func if isinstance(func, RequestHandler) else func
|
||||||
|
self.request_middleware = request_middleware
|
||||||
|
self.response_middleware = response_middleware
|
||||||
|
|
||||||
|
def __call__(self, *args, **kwargs):
|
||||||
|
return self.func(*args, **kwargs)
|
||||||
|
|
||||||
|
|
||||||
|
class RequestManager(metaclass=TouchUpMeta):
|
||||||
|
__touchup__ = (
|
||||||
|
"cleanup",
|
||||||
|
"run_request_middleware",
|
||||||
|
"run_response_middleware",
|
||||||
|
)
|
||||||
|
__slots__ = (
|
||||||
|
"handler",
|
||||||
|
"request_middleware_run",
|
||||||
|
"request_middleware",
|
||||||
|
"request",
|
||||||
|
"response_middleware_run",
|
||||||
|
"response_middleware",
|
||||||
|
)
|
||||||
|
request: Request
|
||||||
|
|
||||||
|
def __init__(self, request: Request):
|
||||||
|
self.request_middleware_run = False
|
||||||
|
self.response_middleware_run = False
|
||||||
|
self.handler = self._noop
|
||||||
|
self.set_request(request)
|
||||||
|
|
||||||
|
@classmethod
|
||||||
|
def create(cls, request: Request) -> RequestManager:
|
||||||
|
return cls(request)
|
||||||
|
|
||||||
|
def set_request(self, request: Request):
|
||||||
|
request._manager = self
|
||||||
|
self.request = request
|
||||||
|
self.request_middleware = request.app.request_middleware
|
||||||
|
self.response_middleware = request.app.response_middleware
|
||||||
|
|
||||||
|
async def handle(self):
|
||||||
|
route = self.resolve_route()
|
||||||
|
|
||||||
|
if self.handler is None:
|
||||||
|
await self.error(
|
||||||
|
ServerError(
|
||||||
|
(
|
||||||
|
"'None' was returned while requesting a "
|
||||||
|
"handler from the router"
|
||||||
|
)
|
||||||
|
)
|
||||||
|
)
|
||||||
|
return
|
||||||
|
|
||||||
|
if (
|
||||||
|
self.request.stream
|
||||||
|
and self.request.stream.request_body
|
||||||
|
and not route.ctx.ignore_body
|
||||||
|
):
|
||||||
|
await self.receive_body()
|
||||||
|
|
||||||
|
await self.lifecycle(
|
||||||
|
partial(self.handler, self.request, **self.request.match_info)
|
||||||
|
)
|
||||||
|
|
||||||
|
async def lifecycle(self, handler, raise_exception: bool = False):
|
||||||
|
response: Optional[BaseHTTPResponse] = None
|
||||||
|
if not self.request_middleware_run and self.request_middleware:
|
||||||
|
response = await self.run(
|
||||||
|
self.run_request_middleware, raise_exception
|
||||||
|
)
|
||||||
|
|
||||||
|
if not response:
|
||||||
|
# Run response handler
|
||||||
|
response = await self.run(handler, raise_exception)
|
||||||
|
|
||||||
|
if not self.response_middleware_run and self.response_middleware:
|
||||||
|
response = await self.run(
|
||||||
|
partial(self.run_response_middleware, response),
|
||||||
|
raise_exception,
|
||||||
|
)
|
||||||
|
|
||||||
|
await self.cleanup(response)
|
||||||
|
|
||||||
|
async def run(
|
||||||
|
self, operation, raise_exception: bool = False
|
||||||
|
) -> Optional[BaseHTTPResponse]:
|
||||||
|
try:
|
||||||
|
response = operation()
|
||||||
|
if isawaitable(response):
|
||||||
|
response = await response
|
||||||
|
except Exception as e:
|
||||||
|
if raise_exception:
|
||||||
|
raise
|
||||||
|
response = await self.error(e)
|
||||||
|
return response
|
||||||
|
|
||||||
|
async def error(self, exception: Exception):
|
||||||
|
error_handler = self.request.app.error_handler
|
||||||
|
if (
|
||||||
|
self.request.stream is not None
|
||||||
|
and self.request.stream.stage is not Stage.HANDLER
|
||||||
|
):
|
||||||
|
error_logger.exception(exception, exc_info=True)
|
||||||
|
logger.error(
|
||||||
|
"The error response will not be sent to the client for "
|
||||||
|
f'the following exception:"{exception}". A previous response '
|
||||||
|
"has at least partially been sent."
|
||||||
|
)
|
||||||
|
|
||||||
|
handler = error_handler._lookup(
|
||||||
|
exception, self.request.name if self.request else None
|
||||||
|
)
|
||||||
|
if handler:
|
||||||
|
logger.warning(
|
||||||
|
"An error occurred while handling the request after at "
|
||||||
|
"least some part of the response was sent to the client. "
|
||||||
|
"The response from your custom exception handler "
|
||||||
|
f"{handler.__name__} will not be sent to the client."
|
||||||
|
"Exception handlers should only be used to generate the "
|
||||||
|
"exception responses. If you would like to perform any "
|
||||||
|
"other action on a raised exception, consider using a "
|
||||||
|
"signal handler like "
|
||||||
|
'`@app.signal("http.lifecycle.exception")`\n'
|
||||||
|
"For further information, please see the docs: "
|
||||||
|
"https://sanicframework.org/en/guide/advanced/"
|
||||||
|
"signals.html",
|
||||||
|
)
|
||||||
|
return
|
||||||
|
|
||||||
|
try:
|
||||||
|
await self.lifecycle(
|
||||||
|
partial(error_handler.response, self.request, exception), True
|
||||||
|
)
|
||||||
|
except Exception as e:
|
||||||
|
if isinstance(e, SanicException):
|
||||||
|
response = error_handler.default(self.request, e)
|
||||||
|
elif self.request.app.debug:
|
||||||
|
response = HTTPResponse(
|
||||||
|
(
|
||||||
|
f"Error while handling error: {e}\n"
|
||||||
|
f"Stack: {format_exc()}"
|
||||||
|
),
|
||||||
|
status=500,
|
||||||
|
)
|
||||||
|
else:
|
||||||
|
error_logger.exception(e)
|
||||||
|
response = HTTPResponse(
|
||||||
|
"An error occurred while handling an error", status=500
|
||||||
|
)
|
||||||
|
return response
|
||||||
|
return None
|
||||||
|
|
||||||
|
async def cleanup(self, response: Optional[BaseHTTPResponse]):
|
||||||
|
if self.request.responded:
|
||||||
|
if response is not None:
|
||||||
|
error_logger.error(
|
||||||
|
"The response object returned by the route handler "
|
||||||
|
"will not be sent to client. The request has already "
|
||||||
|
"been responded to."
|
||||||
|
)
|
||||||
|
if self.request.stream is not None:
|
||||||
|
response = self.request.stream.response
|
||||||
|
elif response is not None:
|
||||||
|
self.request.reset_response()
|
||||||
|
response = await self.request.respond(response) # type: ignore
|
||||||
|
elif not hasattr(self.handler, "is_websocket"):
|
||||||
|
response = self.request.stream.response # type: ignore
|
||||||
|
|
||||||
|
if isinstance(response, BaseHTTPResponse):
|
||||||
|
await self.request.app.dispatch(
|
||||||
|
"http.lifecycle.response",
|
||||||
|
inline=True,
|
||||||
|
context={"request": self.request, "response": response},
|
||||||
|
)
|
||||||
|
await response.send(end_stream=True)
|
||||||
|
elif isinstance(response, ResponseStream):
|
||||||
|
await response(self.request) # type: ignore
|
||||||
|
await response.eof() # type: ignore
|
||||||
|
await self.request.app.dispatch(
|
||||||
|
"http.lifecycle.response",
|
||||||
|
inline=True,
|
||||||
|
context={"request": self.request, "response": response},
|
||||||
|
)
|
||||||
|
else:
|
||||||
|
if not hasattr(self.handler, "is_websocket"):
|
||||||
|
raise ServerError(
|
||||||
|
f"Invalid response type {response!r} "
|
||||||
|
"(need HTTPResponse)"
|
||||||
|
)
|
||||||
|
|
||||||
|
async def receive_body(self):
|
||||||
|
if hasattr(self.handler, "is_stream"):
|
||||||
|
# Streaming handler: lift the size limit
|
||||||
|
self.request.stream.request_max_size = float("inf")
|
||||||
|
else:
|
||||||
|
# Non-streaming handler: preload body
|
||||||
|
await self.request.receive_body()
|
||||||
|
|
||||||
|
async def run_request_middleware(self) -> Optional[BaseHTTPResponse]:
|
||||||
|
self.request._request_middleware_started = True
|
||||||
|
self.request_middleware_run = True
|
||||||
|
|
||||||
|
for middleware in self.request_middleware:
|
||||||
|
await self.request.app.dispatch(
|
||||||
|
"http.middleware.before",
|
||||||
|
inline=True,
|
||||||
|
context={"request": self.request, "response": None},
|
||||||
|
condition={"attach_to": "request"},
|
||||||
|
)
|
||||||
|
|
||||||
|
try:
|
||||||
|
response = await self.run(partial(middleware, self.request))
|
||||||
|
except Exception:
|
||||||
|
error_logger.exception(
|
||||||
|
"Exception occurred in one of request middleware handlers"
|
||||||
|
)
|
||||||
|
raise
|
||||||
|
|
||||||
|
await self.request.app.dispatch(
|
||||||
|
"http.middleware.after",
|
||||||
|
inline=True,
|
||||||
|
context={"request": self.request, "response": None},
|
||||||
|
condition={"attach_to": "request"},
|
||||||
|
)
|
||||||
|
|
||||||
|
if response:
|
||||||
|
return response
|
||||||
|
return None
|
||||||
|
|
||||||
|
async def run_response_middleware(
|
||||||
|
self, response: BaseHTTPResponse
|
||||||
|
) -> BaseHTTPResponse:
|
||||||
|
self.response_middleware_run = True
|
||||||
|
for middleware in self.response_middleware:
|
||||||
|
await self.request.app.dispatch(
|
||||||
|
"http.middleware.before",
|
||||||
|
inline=True,
|
||||||
|
context={"request": self.request, "response": None},
|
||||||
|
condition={"attach_to": "request"},
|
||||||
|
)
|
||||||
|
|
||||||
|
try:
|
||||||
|
resp = await self.run(
|
||||||
|
partial(middleware, self.request, response), True
|
||||||
|
)
|
||||||
|
except Exception as e:
|
||||||
|
error_logger.exception(
|
||||||
|
"Exception occurred in one of response middleware handlers"
|
||||||
|
)
|
||||||
|
await self.error(e)
|
||||||
|
resp = None
|
||||||
|
|
||||||
|
await self.request.app.dispatch(
|
||||||
|
"http.middleware.after",
|
||||||
|
inline=True,
|
||||||
|
context={"request": self.request, "response": None},
|
||||||
|
condition={"attach_to": "request"},
|
||||||
|
)
|
||||||
|
|
||||||
|
if resp:
|
||||||
|
return resp
|
||||||
|
return response
|
||||||
|
|
||||||
|
def resolve_route(self) -> Route:
|
||||||
|
# Fetch handler from router
|
||||||
|
route, handler, kwargs = self.request.app.router.get(
|
||||||
|
self.request.path,
|
||||||
|
self.request.method,
|
||||||
|
self.request.headers.getone("host", None),
|
||||||
|
)
|
||||||
|
|
||||||
|
self.request._match_info = {**kwargs}
|
||||||
|
self.request.route = route
|
||||||
|
self.handler = handler
|
||||||
|
|
||||||
|
if handler and handler.request_middleware:
|
||||||
|
self.request_middleware = handler.request_middleware
|
||||||
|
|
||||||
|
if handler and handler.response_middleware:
|
||||||
|
self.response_middleware = handler.response_middleware
|
||||||
|
|
||||||
|
return route
|
||||||
|
|
||||||
|
@staticmethod
|
||||||
|
def _noop(_):
|
||||||
|
...
|
||||||
|
|
||||||
|
|
||||||
class ErrorHandler:
|
class ErrorHandler:
|
||||||
|
|||||||
@@ -16,7 +16,6 @@ from sanic.exceptions import (
|
|||||||
PayloadTooLarge,
|
PayloadTooLarge,
|
||||||
RequestCancelled,
|
RequestCancelled,
|
||||||
ServerError,
|
ServerError,
|
||||||
ServiceUnavailable,
|
|
||||||
)
|
)
|
||||||
from sanic.headers import format_http1_response
|
from sanic.headers import format_http1_response
|
||||||
from sanic.helpers import has_message_body
|
from sanic.helpers import has_message_body
|
||||||
@@ -125,7 +124,8 @@ class Http(Stream, metaclass=TouchUpMeta):
|
|||||||
|
|
||||||
self.stage = Stage.HANDLER
|
self.stage = Stage.HANDLER
|
||||||
self.request.conn_info = self.protocol.conn_info
|
self.request.conn_info = self.protocol.conn_info
|
||||||
await self.protocol.request_handler(self.request)
|
|
||||||
|
await self.request.manager.handle()
|
||||||
|
|
||||||
# Handler finished, response should've been sent
|
# Handler finished, response should've been sent
|
||||||
if self.stage is Stage.HANDLER and not self.upgrade_websocket:
|
if self.stage is Stage.HANDLER and not self.upgrade_websocket:
|
||||||
@@ -251,6 +251,7 @@ class Http(Stream, metaclass=TouchUpMeta):
|
|||||||
transport=self.protocol.transport,
|
transport=self.protocol.transport,
|
||||||
app=self.protocol.app,
|
app=self.protocol.app,
|
||||||
)
|
)
|
||||||
|
self.protocol.request_handler.create(request)
|
||||||
self.protocol.request_class._current.set(request)
|
self.protocol.request_class._current.set(request)
|
||||||
await self.dispatch(
|
await self.dispatch(
|
||||||
"http.lifecycle.request",
|
"http.lifecycle.request",
|
||||||
@@ -424,18 +425,11 @@ class Http(Stream, metaclass=TouchUpMeta):
|
|||||||
|
|
||||||
# From request and handler states we can respond, otherwise be silent
|
# From request and handler states we can respond, otherwise be silent
|
||||||
if self.stage is Stage.HANDLER:
|
if self.stage is Stage.HANDLER:
|
||||||
app = self.protocol.app
|
|
||||||
|
|
||||||
if self.request is None:
|
if self.request is None:
|
||||||
self.create_empty_request()
|
self.create_empty_request()
|
||||||
|
self.protocol.request_handler.create(self.request)
|
||||||
|
|
||||||
request_middleware = not isinstance(exception, ServiceUnavailable)
|
await self.request.manager.error(exception)
|
||||||
try:
|
|
||||||
await app.handle_exception(
|
|
||||||
self.request, exception, request_middleware
|
|
||||||
)
|
|
||||||
except Exception as e:
|
|
||||||
await app.handle_exception(self.request, e, False)
|
|
||||||
|
|
||||||
def create_empty_request(self) -> None:
|
def create_empty_request(self) -> None:
|
||||||
"""
|
"""
|
||||||
|
|||||||
@@ -72,8 +72,7 @@ def get_ssl_context(
|
|||||||
"without passing a TLS certificate. If you are developing "
|
"without passing a TLS certificate. If you are developing "
|
||||||
"locally, please enable DEVELOPMENT mode and Sanic will "
|
"locally, please enable DEVELOPMENT mode and Sanic will "
|
||||||
"generate a localhost TLS certificate. For more information "
|
"generate a localhost TLS certificate. For more information "
|
||||||
"please see: https://sanic.dev/en/guide/deployment/development."
|
"please see: ___."
|
||||||
"html#automatic-tls-certificate."
|
|
||||||
)
|
)
|
||||||
|
|
||||||
creator = CertCreator.select(
|
creator = CertCreator.select(
|
||||||
@@ -152,8 +151,7 @@ class CertCreator(ABC):
|
|||||||
raise SanicException(
|
raise SanicException(
|
||||||
"Sanic could not find package to create a TLS certificate. "
|
"Sanic could not find package to create a TLS certificate. "
|
||||||
"You must have either mkcert or trustme installed. See "
|
"You must have either mkcert or trustme installed. See "
|
||||||
"https://sanic.dev/en/guide/deployment/development.html"
|
"_____ for more details."
|
||||||
"#automatic-tls-certificate for more details."
|
|
||||||
)
|
)
|
||||||
|
|
||||||
return creator
|
return creator
|
||||||
@@ -205,8 +203,7 @@ class MkcertCreator(CertCreator):
|
|||||||
"to proceed. Installation instructions can be found here: "
|
"to proceed. Installation instructions can be found here: "
|
||||||
"https://github.com/FiloSottile/mkcert.\n"
|
"https://github.com/FiloSottile/mkcert.\n"
|
||||||
"Find out more information about your options here: "
|
"Find out more information about your options here: "
|
||||||
"https://sanic.dev/en/guide/deployment/development.html#"
|
"_____"
|
||||||
"automatic-tls-certificate"
|
|
||||||
) from e
|
) from e
|
||||||
|
|
||||||
def generate_cert(self, localhost: str) -> ssl.SSLContext:
|
def generate_cert(self, localhost: str) -> ssl.SSLContext:
|
||||||
@@ -263,8 +260,7 @@ class TrustmeCreator(CertCreator):
|
|||||||
"to proceed. Installation instructions can be found here: "
|
"to proceed. Installation instructions can be found here: "
|
||||||
"https://github.com/python-trio/trustme.\n"
|
"https://github.com/python-trio/trustme.\n"
|
||||||
"Find out more information about your options here: "
|
"Find out more information about your options here: "
|
||||||
"https://sanic.dev/en/guide/deployment/development.html#"
|
"_____"
|
||||||
"automatic-tls-certificate"
|
|
||||||
)
|
)
|
||||||
|
|
||||||
def generate_cert(self, localhost: str) -> ssl.SSLContext:
|
def generate_cert(self, localhost: str) -> ssl.SSLContext:
|
||||||
|
|||||||
17
sanic/log.py
17
sanic/log.py
@@ -1,10 +1,11 @@
|
|||||||
import logging
|
import logging
|
||||||
import sys
|
import sys
|
||||||
|
|
||||||
|
from enum import Enum
|
||||||
from typing import Any, Dict
|
from typing import Any, Dict
|
||||||
from warnings import warn
|
from warnings import warn
|
||||||
|
|
||||||
from sanic.compat import StrEnum, is_atty
|
from sanic.compat import is_atty
|
||||||
|
|
||||||
|
|
||||||
LOGGING_CONFIG_DEFAULTS: Dict[str, Any] = dict( # no cov
|
LOGGING_CONFIG_DEFAULTS: Dict[str, Any] = dict( # no cov
|
||||||
@@ -24,12 +25,6 @@ LOGGING_CONFIG_DEFAULTS: Dict[str, Any] = dict( # no cov
|
|||||||
"propagate": True,
|
"propagate": True,
|
||||||
"qualname": "sanic.access",
|
"qualname": "sanic.access",
|
||||||
},
|
},
|
||||||
"sanic.server": {
|
|
||||||
"level": "INFO",
|
|
||||||
"handlers": ["console"],
|
|
||||||
"propagate": True,
|
|
||||||
"qualname": "sanic.server",
|
|
||||||
},
|
|
||||||
},
|
},
|
||||||
handlers={
|
handlers={
|
||||||
"console": {
|
"console": {
|
||||||
@@ -67,7 +62,7 @@ Defult logging configuration
|
|||||||
"""
|
"""
|
||||||
|
|
||||||
|
|
||||||
class Colors(StrEnum): # no cov
|
class Colors(str, Enum): # no cov
|
||||||
END = "\033[0m"
|
END = "\033[0m"
|
||||||
BOLD = "\033[1m"
|
BOLD = "\033[1m"
|
||||||
BLUE = "\033[34m"
|
BLUE = "\033[34m"
|
||||||
@@ -106,12 +101,6 @@ Logger used by Sanic for access logging
|
|||||||
"""
|
"""
|
||||||
access_logger.addFilter(_verbosity_filter)
|
access_logger.addFilter(_verbosity_filter)
|
||||||
|
|
||||||
server_logger = logging.getLogger("sanic.server") # no cov
|
|
||||||
"""
|
|
||||||
Logger used by Sanic for server related messages
|
|
||||||
"""
|
|
||||||
logger.addFilter(_verbosity_filter)
|
|
||||||
|
|
||||||
|
|
||||||
def deprecation(message: str, version: float): # no cov
|
def deprecation(message: str, version: float): # no cov
|
||||||
version_info = f"[DEPRECATION v{version}] "
|
version_info = f"[DEPRECATION v{version}] "
|
||||||
|
|||||||
@@ -21,7 +21,7 @@ class Middleware:
|
|||||||
def __init__(
|
def __init__(
|
||||||
self,
|
self,
|
||||||
func: MiddlewareType,
|
func: MiddlewareType,
|
||||||
location: MiddlewareLocation,
|
location: MiddlewareLocation = MiddlewareLocation.REQUEST,
|
||||||
priority: int = 0,
|
priority: int = 0,
|
||||||
) -> None:
|
) -> None:
|
||||||
self.func = func
|
self.func = func
|
||||||
@@ -33,9 +33,10 @@ class Middleware:
|
|||||||
return self.func(*args, **kwargs)
|
return self.func(*args, **kwargs)
|
||||||
|
|
||||||
def __repr__(self) -> str:
|
def __repr__(self) -> str:
|
||||||
|
name = getattr(self.func, "__name__", str(self.func))
|
||||||
return (
|
return (
|
||||||
f"{self.__class__.__name__}("
|
f"{self.__class__.__name__}("
|
||||||
f"func=<function {self.func.__name__}>, "
|
f"func=<function {name}>, "
|
||||||
f"priority={self.priority}, "
|
f"priority={self.priority}, "
|
||||||
f"location={self.location.name})"
|
f"location={self.location.name})"
|
||||||
)
|
)
|
||||||
@@ -63,4 +64,3 @@ class Middleware:
|
|||||||
@classmethod
|
@classmethod
|
||||||
def reset_count(cls):
|
def reset_count(cls):
|
||||||
cls._counter = count()
|
cls._counter = count()
|
||||||
cls.count = next(cls._counter)
|
|
||||||
|
|||||||
@@ -4,6 +4,7 @@ from operator import attrgetter
|
|||||||
from typing import List
|
from typing import List
|
||||||
|
|
||||||
from sanic.base.meta import SanicMeta
|
from sanic.base.meta import SanicMeta
|
||||||
|
from sanic.handlers import RequestHandler
|
||||||
from sanic.middleware import Middleware, MiddlewareLocation
|
from sanic.middleware import Middleware, MiddlewareLocation
|
||||||
from sanic.models.futures import FutureMiddleware
|
from sanic.models.futures import FutureMiddleware
|
||||||
from sanic.router import Router
|
from sanic.router import Router
|
||||||
@@ -104,19 +105,23 @@ class MiddlewareMixin(metaclass=SanicMeta):
|
|||||||
self.named_response_middleware.get(route.name, deque()),
|
self.named_response_middleware.get(route.name, deque()),
|
||||||
location=MiddlewareLocation.RESPONSE,
|
location=MiddlewareLocation.RESPONSE,
|
||||||
)
|
)
|
||||||
route.extra.request_middleware = deque(
|
|
||||||
|
route.handler = RequestHandler(
|
||||||
|
route.handler,
|
||||||
|
deque(
|
||||||
sorted(
|
sorted(
|
||||||
request_middleware,
|
request_middleware,
|
||||||
key=attrgetter("order"),
|
key=attrgetter("order"),
|
||||||
reverse=True,
|
reverse=True,
|
||||||
)
|
)
|
||||||
)
|
),
|
||||||
route.extra.response_middleware = deque(
|
deque(
|
||||||
sorted(
|
sorted(
|
||||||
response_middleware,
|
response_middleware,
|
||||||
key=attrgetter("order"),
|
key=attrgetter("order"),
|
||||||
reverse=True,
|
reverse=True,
|
||||||
)[::-1]
|
)[::-1]
|
||||||
|
),
|
||||||
)
|
)
|
||||||
request_middleware = Middleware.convert(
|
request_middleware = Middleware.convert(
|
||||||
self.request_middleware,
|
self.request_middleware,
|
||||||
|
|||||||
@@ -1,16 +1,15 @@
|
|||||||
from ast import NodeVisitor, Return, parse
|
from ast import NodeVisitor, Return, parse
|
||||||
from contextlib import suppress
|
from contextlib import suppress
|
||||||
from email.utils import formatdate
|
|
||||||
from functools import partial, wraps
|
from functools import partial, wraps
|
||||||
from inspect import getsource, signature
|
from inspect import getsource, signature
|
||||||
from mimetypes import guess_type
|
from mimetypes import guess_type
|
||||||
from os import path
|
from os import path
|
||||||
from pathlib import Path, PurePath
|
from pathlib import Path, PurePath
|
||||||
from textwrap import dedent
|
from textwrap import dedent
|
||||||
|
from time import gmtime, strftime
|
||||||
from typing import (
|
from typing import (
|
||||||
Any,
|
Any,
|
||||||
Callable,
|
Callable,
|
||||||
Dict,
|
|
||||||
Iterable,
|
Iterable,
|
||||||
List,
|
List,
|
||||||
Optional,
|
Optional,
|
||||||
@@ -32,13 +31,21 @@ from sanic.handlers import ContentRangeHandler
|
|||||||
from sanic.log import error_logger
|
from sanic.log import error_logger
|
||||||
from sanic.models.futures import FutureRoute, FutureStatic
|
from sanic.models.futures import FutureRoute, FutureStatic
|
||||||
from sanic.models.handler_types import RouteHandler
|
from sanic.models.handler_types import RouteHandler
|
||||||
from sanic.response import HTTPResponse, file, file_stream, validate_file
|
from sanic.response import HTTPResponse, file, file_stream
|
||||||
from sanic.types import HashableDict
|
from sanic.types import HashableDict
|
||||||
|
|
||||||
|
|
||||||
RouteWrapper = Callable[
|
RouteWrapper = Callable[
|
||||||
[RouteHandler], Union[RouteHandler, Tuple[Route, RouteHandler]]
|
[RouteHandler], Union[RouteHandler, Tuple[Route, RouteHandler]]
|
||||||
]
|
]
|
||||||
|
RESTRICTED_ROUTE_CONTEXT = (
|
||||||
|
"ignore_body",
|
||||||
|
"stream",
|
||||||
|
"hosts",
|
||||||
|
"static",
|
||||||
|
"error_format",
|
||||||
|
"websocket",
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
class RouteMixin(metaclass=SanicMeta):
|
class RouteMixin(metaclass=SanicMeta):
|
||||||
@@ -783,9 +790,24 @@ class RouteMixin(metaclass=SanicMeta):
|
|||||||
|
|
||||||
return name
|
return name
|
||||||
|
|
||||||
async def _get_file_path(self, file_or_directory, __file_uri__, not_found):
|
async def _static_request_handler(
|
||||||
|
self,
|
||||||
|
file_or_directory,
|
||||||
|
use_modified_since,
|
||||||
|
use_content_range,
|
||||||
|
stream_large_files,
|
||||||
|
request,
|
||||||
|
content_type=None,
|
||||||
|
__file_uri__=None,
|
||||||
|
):
|
||||||
|
# Merge served directory and requested file if provided
|
||||||
file_path_raw = Path(unquote(file_or_directory))
|
file_path_raw = Path(unquote(file_or_directory))
|
||||||
root_path = file_path = file_path_raw.resolve()
|
root_path = file_path = file_path_raw.resolve()
|
||||||
|
not_found = FileNotFound(
|
||||||
|
"File not found",
|
||||||
|
path=file_or_directory,
|
||||||
|
relative_url=__file_uri__,
|
||||||
|
)
|
||||||
|
|
||||||
if __file_uri__:
|
if __file_uri__:
|
||||||
# Strip all / that in the beginning of the URL to help prevent
|
# Strip all / that in the beginning of the URL to help prevent
|
||||||
@@ -812,29 +834,6 @@ class RouteMixin(metaclass=SanicMeta):
|
|||||||
f"relative_url={__file_uri__}"
|
f"relative_url={__file_uri__}"
|
||||||
)
|
)
|
||||||
raise not_found
|
raise not_found
|
||||||
return file_path
|
|
||||||
|
|
||||||
async def _static_request_handler(
|
|
||||||
self,
|
|
||||||
file_or_directory,
|
|
||||||
use_modified_since,
|
|
||||||
use_content_range,
|
|
||||||
stream_large_files,
|
|
||||||
request,
|
|
||||||
content_type=None,
|
|
||||||
__file_uri__=None,
|
|
||||||
):
|
|
||||||
not_found = FileNotFound(
|
|
||||||
"File not found",
|
|
||||||
path=file_or_directory,
|
|
||||||
relative_url=__file_uri__,
|
|
||||||
)
|
|
||||||
|
|
||||||
# Merge served directory and requested file if provided
|
|
||||||
file_path = await self._get_file_path(
|
|
||||||
file_or_directory, __file_uri__, not_found
|
|
||||||
)
|
|
||||||
|
|
||||||
try:
|
try:
|
||||||
headers = {}
|
headers = {}
|
||||||
# Check if the client has been sent this file before
|
# Check if the client has been sent this file before
|
||||||
@@ -842,13 +841,15 @@ class RouteMixin(metaclass=SanicMeta):
|
|||||||
stats = None
|
stats = None
|
||||||
if use_modified_since:
|
if use_modified_since:
|
||||||
stats = await stat_async(file_path)
|
stats = await stat_async(file_path)
|
||||||
modified_since = stats.st_mtime
|
modified_since = strftime(
|
||||||
response = await validate_file(request.headers, modified_since)
|
"%a, %d %b %Y %H:%M:%S GMT", gmtime(stats.st_mtime)
|
||||||
if response:
|
|
||||||
return response
|
|
||||||
headers["Last-Modified"] = formatdate(
|
|
||||||
modified_since, usegmt=True
|
|
||||||
)
|
)
|
||||||
|
if (
|
||||||
|
request.headers.getone("if-modified-since", None)
|
||||||
|
== modified_since
|
||||||
|
):
|
||||||
|
return HTTPResponse(status=304)
|
||||||
|
headers["Last-Modified"] = modified_since
|
||||||
_range = None
|
_range = None
|
||||||
if use_content_range:
|
if use_content_range:
|
||||||
_range = None
|
_range = None
|
||||||
@@ -863,7 +864,8 @@ class RouteMixin(metaclass=SanicMeta):
|
|||||||
pass
|
pass
|
||||||
else:
|
else:
|
||||||
del headers["Content-Length"]
|
del headers["Content-Length"]
|
||||||
headers.update(_range.headers)
|
for key, value in _range.headers.items():
|
||||||
|
headers[key] = value
|
||||||
|
|
||||||
if "content-type" not in headers:
|
if "content-type" not in headers:
|
||||||
content_type = (
|
content_type = (
|
||||||
@@ -1039,12 +1041,24 @@ class RouteMixin(metaclass=SanicMeta):
|
|||||||
|
|
||||||
return types
|
return types
|
||||||
|
|
||||||
def _build_route_context(self, raw: Dict[str, Any]) -> HashableDict:
|
def _build_route_context(self, raw):
|
||||||
ctx_kwargs = {
|
ctx_kwargs = {
|
||||||
key.replace("ctx_", ""): raw.pop(key)
|
key.replace("ctx_", ""): raw.pop(key)
|
||||||
for key in {**raw}.keys()
|
for key in {**raw}.keys()
|
||||||
if key.startswith("ctx_")
|
if key.startswith("ctx_")
|
||||||
}
|
}
|
||||||
|
restricted = [
|
||||||
|
key for key in ctx_kwargs.keys() if key in RESTRICTED_ROUTE_CONTEXT
|
||||||
|
]
|
||||||
|
if restricted:
|
||||||
|
restricted_arguments = ", ".join(restricted)
|
||||||
|
raise AttributeError(
|
||||||
|
"Cannot use restricted route context: "
|
||||||
|
f"{restricted_arguments}. This limitation is only in place "
|
||||||
|
"until v22.9 when the restricted names will no longer be in"
|
||||||
|
"conflict. See https://github.com/sanic-org/sanic/issues/2303 "
|
||||||
|
"for more information."
|
||||||
|
)
|
||||||
if raw:
|
if raw:
|
||||||
unexpected_arguments = ", ".join(raw.keys())
|
unexpected_arguments = ", ".join(raw.keys())
|
||||||
raise TypeError(
|
raise TypeError(
|
||||||
|
|||||||
@@ -19,7 +19,7 @@ from importlib import import_module
|
|||||||
from multiprocessing import Manager, Pipe, get_context
|
from multiprocessing import Manager, Pipe, get_context
|
||||||
from multiprocessing.context import BaseContext
|
from multiprocessing.context import BaseContext
|
||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
from socket import SHUT_RDWR, socket
|
from socket import socket
|
||||||
from ssl import SSLContext
|
from ssl import SSLContext
|
||||||
from typing import (
|
from typing import (
|
||||||
TYPE_CHECKING,
|
TYPE_CHECKING,
|
||||||
@@ -35,15 +35,12 @@ from typing import (
|
|||||||
cast,
|
cast,
|
||||||
)
|
)
|
||||||
|
|
||||||
from sanic.application.ext import setup_ext
|
|
||||||
from sanic.application.logo import get_logo
|
from sanic.application.logo import get_logo
|
||||||
from sanic.application.motd import MOTD
|
from sanic.application.motd import MOTD
|
||||||
from sanic.application.state import ApplicationServerInfo, Mode, ServerStage
|
from sanic.application.state import ApplicationServerInfo, Mode, ServerStage
|
||||||
from sanic.base.meta import SanicMeta
|
from sanic.base.meta import SanicMeta
|
||||||
from sanic.compat import OS_IS_WINDOWS, is_atty
|
from sanic.compat import OS_IS_WINDOWS, is_atty
|
||||||
from sanic.constants import RestartOrder
|
from sanic.helpers import _default
|
||||||
from sanic.exceptions import ServerKilled
|
|
||||||
from sanic.helpers import Default
|
|
||||||
from sanic.http.constants import HTTP
|
from sanic.http.constants import HTTP
|
||||||
from sanic.http.tls import get_ssl_context, process_to_context
|
from sanic.http.tls import get_ssl_context, process_to_context
|
||||||
from sanic.http.tls.context import SanicSSLContext
|
from sanic.http.tls.context import SanicSSLContext
|
||||||
@@ -93,8 +90,7 @@ class StartupMixin(metaclass=SanicMeta):
|
|||||||
def setup_loop(self):
|
def setup_loop(self):
|
||||||
if not self.asgi:
|
if not self.asgi:
|
||||||
if self.config.USE_UVLOOP is True or (
|
if self.config.USE_UVLOOP is True or (
|
||||||
isinstance(self.config.USE_UVLOOP, Default)
|
self.config.USE_UVLOOP is _default and not OS_IS_WINDOWS
|
||||||
and not OS_IS_WINDOWS
|
|
||||||
):
|
):
|
||||||
try_use_uvloop()
|
try_use_uvloop()
|
||||||
elif OS_IS_WINDOWS:
|
elif OS_IS_WINDOWS:
|
||||||
@@ -434,7 +430,7 @@ class StartupMixin(metaclass=SanicMeta):
|
|||||||
run_async=return_asyncio_server,
|
run_async=return_asyncio_server,
|
||||||
)
|
)
|
||||||
|
|
||||||
if not isinstance(self.config.USE_UVLOOP, Default):
|
if self.config.USE_UVLOOP is not _default:
|
||||||
error_logger.warning(
|
error_logger.warning(
|
||||||
"You are trying to change the uvloop configuration, but "
|
"You are trying to change the uvloop configuration, but "
|
||||||
"this is only effective when using the run(...) method. "
|
"this is only effective when using the run(...) method. "
|
||||||
@@ -562,6 +558,7 @@ class StartupMixin(metaclass=SanicMeta):
|
|||||||
|
|
||||||
def motd(
|
def motd(
|
||||||
self,
|
self,
|
||||||
|
serve_location: str = "",
|
||||||
server_settings: Optional[Dict[str, Any]] = None,
|
server_settings: Optional[Dict[str, Any]] = None,
|
||||||
):
|
):
|
||||||
if (
|
if (
|
||||||
@@ -571,6 +568,13 @@ class StartupMixin(metaclass=SanicMeta):
|
|||||||
or os.environ.get("SANIC_SERVER_RUNNING")
|
or os.environ.get("SANIC_SERVER_RUNNING")
|
||||||
):
|
):
|
||||||
return
|
return
|
||||||
|
if serve_location:
|
||||||
|
deprecation(
|
||||||
|
"Specifying a serve_location in the MOTD is deprecated and "
|
||||||
|
"will be removed.",
|
||||||
|
22.9,
|
||||||
|
)
|
||||||
|
else:
|
||||||
serve_location = self.get_server_location(server_settings)
|
serve_location = self.get_server_location(server_settings)
|
||||||
if self.config.MOTD:
|
if self.config.MOTD:
|
||||||
logo = get_logo(coffee=self.state.coffee)
|
logo = get_logo(coffee=self.state.coffee)
|
||||||
@@ -736,18 +740,15 @@ class StartupMixin(metaclass=SanicMeta):
|
|||||||
except IndexError:
|
except IndexError:
|
||||||
raise RuntimeError(
|
raise RuntimeError(
|
||||||
f"No server information found for {primary.name}. Perhaps you "
|
f"No server information found for {primary.name}. Perhaps you "
|
||||||
"need to run app.prepare(...)?"
|
"need to run app.prepare(...)?\n"
|
||||||
|
"See ____ for more information."
|
||||||
) from None
|
) from None
|
||||||
|
|
||||||
socks = []
|
socks = []
|
||||||
sync_manager = Manager()
|
sync_manager = Manager()
|
||||||
setup_ext(primary)
|
|
||||||
exit_code = 0
|
|
||||||
try:
|
try:
|
||||||
primary_server_info.settings.pop("main_start", None)
|
main_start = primary_server_info.settings.pop("main_start", None)
|
||||||
primary_server_info.settings.pop("main_stop", None)
|
main_stop = primary_server_info.settings.pop("main_stop", None)
|
||||||
main_start = primary.listeners.get("main_process_start")
|
|
||||||
main_stop = primary.listeners.get("main_process_stop")
|
|
||||||
app = primary_server_info.settings.pop("app")
|
app = primary_server_info.settings.pop("app")
|
||||||
app.setup_loop()
|
app.setup_loop()
|
||||||
loop = new_event_loop()
|
loop = new_event_loop()
|
||||||
@@ -815,7 +816,6 @@ class StartupMixin(metaclass=SanicMeta):
|
|||||||
cls._get_context(),
|
cls._get_context(),
|
||||||
(monitor_pub, monitor_sub),
|
(monitor_pub, monitor_sub),
|
||||||
worker_state,
|
worker_state,
|
||||||
cast(RestartOrder, primary.config.RESTART_ORDER),
|
|
||||||
)
|
)
|
||||||
if cls.should_auto_reload():
|
if cls.should_auto_reload():
|
||||||
reload_dirs: Set[Path] = primary.state.reload_dirs.union(
|
reload_dirs: Set[Path] = primary.state.reload_dirs.union(
|
||||||
@@ -853,8 +853,6 @@ class StartupMixin(metaclass=SanicMeta):
|
|||||||
trigger_events(ready, loop, primary)
|
trigger_events(ready, loop, primary)
|
||||||
|
|
||||||
manager.run()
|
manager.run()
|
||||||
except ServerKilled:
|
|
||||||
exit_code = 1
|
|
||||||
except BaseException:
|
except BaseException:
|
||||||
kwargs = primary_server_info.settings
|
kwargs = primary_server_info.settings
|
||||||
error_logger.exception(
|
error_logger.exception(
|
||||||
@@ -870,7 +868,6 @@ class StartupMixin(metaclass=SanicMeta):
|
|||||||
|
|
||||||
sync_manager.shutdown()
|
sync_manager.shutdown()
|
||||||
for sock in socks:
|
for sock in socks:
|
||||||
sock.shutdown(SHUT_RDWR)
|
|
||||||
sock.close()
|
sock.close()
|
||||||
socks = []
|
socks = []
|
||||||
trigger_events(main_stop, loop, primary)
|
trigger_events(main_stop, loop, primary)
|
||||||
@@ -880,8 +877,6 @@ class StartupMixin(metaclass=SanicMeta):
|
|||||||
unix = kwargs.get("unix")
|
unix = kwargs.get("unix")
|
||||||
if unix:
|
if unix:
|
||||||
remove_unix_socket(unix)
|
remove_unix_socket(unix)
|
||||||
if exit_code:
|
|
||||||
os._exit(exit_code)
|
|
||||||
|
|
||||||
@classmethod
|
@classmethod
|
||||||
def serve_single(cls, primary: Optional[Sanic] = None) -> None:
|
def serve_single(cls, primary: Optional[Sanic] = None) -> None:
|
||||||
|
|||||||
@@ -1,6 +1,7 @@
|
|||||||
from __future__ import annotations
|
from __future__ import annotations
|
||||||
|
|
||||||
from contextvars import ContextVar
|
from contextvars import ContextVar
|
||||||
|
from functools import partial
|
||||||
from inspect import isawaitable
|
from inspect import isawaitable
|
||||||
from typing import (
|
from typing import (
|
||||||
TYPE_CHECKING,
|
TYPE_CHECKING,
|
||||||
@@ -23,6 +24,7 @@ from sanic.models.http_types import Credentials
|
|||||||
|
|
||||||
|
|
||||||
if TYPE_CHECKING:
|
if TYPE_CHECKING:
|
||||||
|
from sanic.handlers import RequestManager
|
||||||
from sanic.server import ConnInfo
|
from sanic.server import ConnInfo
|
||||||
from sanic.app import Sanic
|
from sanic.app import Sanic
|
||||||
|
|
||||||
@@ -37,7 +39,7 @@ from urllib.parse import parse_qs, parse_qsl, unquote, urlunparse
|
|||||||
from httptools import parse_url
|
from httptools import parse_url
|
||||||
from httptools.parser.errors import HttpParserInvalidURLError
|
from httptools.parser.errors import HttpParserInvalidURLError
|
||||||
|
|
||||||
from sanic.compat import CancelledErrors, Header
|
from sanic.compat import Header
|
||||||
from sanic.constants import (
|
from sanic.constants import (
|
||||||
CACHEABLE_HTTP_METHODS,
|
CACHEABLE_HTTP_METHODS,
|
||||||
DEFAULT_HTTP_CONTENT_TYPE,
|
DEFAULT_HTTP_CONTENT_TYPE,
|
||||||
@@ -99,12 +101,12 @@ class Request:
|
|||||||
"_cookies",
|
"_cookies",
|
||||||
"_id",
|
"_id",
|
||||||
"_ip",
|
"_ip",
|
||||||
|
"_manager",
|
||||||
"_parsed_url",
|
"_parsed_url",
|
||||||
"_port",
|
"_port",
|
||||||
"_protocol",
|
"_protocol",
|
||||||
"_remote_addr",
|
"_remote_addr",
|
||||||
"_request_middleware_started",
|
"_request_middleware_started",
|
||||||
"_response_middleware_started",
|
|
||||||
"_scheme",
|
"_scheme",
|
||||||
"_socket",
|
"_socket",
|
||||||
"_stream_id",
|
"_stream_id",
|
||||||
@@ -180,10 +182,10 @@ class Request:
|
|||||||
Tuple[bool, bool, str, str], List[Tuple[str, str]]
|
Tuple[bool, bool, str, str], List[Tuple[str, str]]
|
||||||
] = defaultdict(list)
|
] = defaultdict(list)
|
||||||
self._request_middleware_started = False
|
self._request_middleware_started = False
|
||||||
self._response_middleware_started = False
|
|
||||||
self.responded: bool = False
|
self.responded: bool = False
|
||||||
self.route: Optional[Route] = None
|
self.route: Optional[Route] = None
|
||||||
self.stream: Optional[Stream] = None
|
self.stream: Optional[Stream] = None
|
||||||
|
self._manager: Optional[RequestManager] = None
|
||||||
self._cookies: Optional[Dict[str, str]] = None
|
self._cookies: Optional[Dict[str, str]] = None
|
||||||
self._match_info: Dict[str, Any] = {}
|
self._match_info: Dict[str, Any] = {}
|
||||||
self._protocol = None
|
self._protocol = None
|
||||||
@@ -227,7 +229,7 @@ class Request:
|
|||||||
"Request.request_middleware_started has been deprecated and will"
|
"Request.request_middleware_started has been deprecated and will"
|
||||||
"be removed. You should set a flag on the request context using"
|
"be removed. You should set a flag on the request context using"
|
||||||
"either middleware or signals if you need this feature.",
|
"either middleware or signals if you need this feature.",
|
||||||
23.3,
|
22.3,
|
||||||
)
|
)
|
||||||
return self._request_middleware_started
|
return self._request_middleware_started
|
||||||
|
|
||||||
@@ -245,6 +247,10 @@ class Request:
|
|||||||
)
|
)
|
||||||
return self._stream_id
|
return self._stream_id
|
||||||
|
|
||||||
|
@property
|
||||||
|
def manager(self):
|
||||||
|
return self._manager
|
||||||
|
|
||||||
def reset_response(self):
|
def reset_response(self):
|
||||||
try:
|
try:
|
||||||
if (
|
if (
|
||||||
@@ -335,20 +341,13 @@ class Request:
|
|||||||
if isawaitable(response):
|
if isawaitable(response):
|
||||||
response = await response # type: ignore
|
response = await response # type: ignore
|
||||||
# Run response middleware
|
# Run response middleware
|
||||||
try:
|
if (
|
||||||
middleware = (
|
self._manager
|
||||||
self.route and self.route.extra.response_middleware
|
and not self._manager.response_middleware_run
|
||||||
) or self.app.response_middleware
|
and self._manager.response_middleware
|
||||||
if middleware and not self._response_middleware_started:
|
):
|
||||||
self._response_middleware_started = True
|
response = await self._manager.run(
|
||||||
response = await self.app._run_response_middleware(
|
partial(self._manager.run_response_middleware, response)
|
||||||
self, response, middleware
|
|
||||||
)
|
|
||||||
except CancelledErrors:
|
|
||||||
raise
|
|
||||||
except Exception:
|
|
||||||
error_logger.exception(
|
|
||||||
"Exception occurred in one of response middleware handlers"
|
|
||||||
)
|
)
|
||||||
self.responded = True
|
self.responded = True
|
||||||
return response
|
return response
|
||||||
|
|||||||
@@ -2,20 +2,212 @@ from __future__ import annotations
|
|||||||
|
|
||||||
from datetime import datetime, timezone
|
from datetime import datetime, timezone
|
||||||
from email.utils import formatdate, parsedate_to_datetime
|
from email.utils import formatdate, parsedate_to_datetime
|
||||||
|
from functools import partial
|
||||||
from mimetypes import guess_type
|
from mimetypes import guess_type
|
||||||
from os import path
|
from os import path
|
||||||
from pathlib import PurePath
|
from pathlib import PurePath
|
||||||
from time import time
|
from time import time
|
||||||
from typing import Any, AnyStr, Callable, Dict, Optional, Union
|
from typing import (
|
||||||
|
TYPE_CHECKING,
|
||||||
|
Any,
|
||||||
|
AnyStr,
|
||||||
|
Callable,
|
||||||
|
Coroutine,
|
||||||
|
Dict,
|
||||||
|
Iterator,
|
||||||
|
Optional,
|
||||||
|
Tuple,
|
||||||
|
TypeVar,
|
||||||
|
Union,
|
||||||
|
)
|
||||||
from urllib.parse import quote_plus
|
from urllib.parse import quote_plus
|
||||||
|
|
||||||
from sanic.compat import Header, open_async, stat_async
|
from sanic.compat import Header, open_async, stat_async
|
||||||
from sanic.constants import DEFAULT_HTTP_CONTENT_TYPE
|
from sanic.constants import DEFAULT_HTTP_CONTENT_TYPE
|
||||||
from sanic.helpers import Default, _default
|
from sanic.cookies import CookieJar
|
||||||
|
from sanic.exceptions import SanicException, ServerError
|
||||||
|
from sanic.helpers import (
|
||||||
|
Default,
|
||||||
|
_default,
|
||||||
|
has_message_body,
|
||||||
|
remove_entity_headers,
|
||||||
|
)
|
||||||
|
from sanic.http import Http
|
||||||
from sanic.log import logger
|
from sanic.log import logger
|
||||||
from sanic.models.protocol_types import HTMLProtocol, Range
|
from sanic.models.protocol_types import HTMLProtocol, Range
|
||||||
|
|
||||||
from .types import HTTPResponse, JSONResponse, ResponseStream
|
|
||||||
|
if TYPE_CHECKING:
|
||||||
|
from sanic.asgi import ASGIApp
|
||||||
|
from sanic.http.http3 import HTTPReceiver
|
||||||
|
from sanic.request import Request
|
||||||
|
else:
|
||||||
|
Request = TypeVar("Request")
|
||||||
|
|
||||||
|
|
||||||
|
try:
|
||||||
|
from ujson import dumps as json_dumps
|
||||||
|
except ImportError:
|
||||||
|
# This is done in order to ensure that the JSON response is
|
||||||
|
# kept consistent across both ujson and inbuilt json usage.
|
||||||
|
from json import dumps
|
||||||
|
|
||||||
|
json_dumps = partial(dumps, separators=(",", ":"))
|
||||||
|
|
||||||
|
|
||||||
|
class BaseHTTPResponse:
|
||||||
|
"""
|
||||||
|
The base class for all HTTP Responses
|
||||||
|
"""
|
||||||
|
|
||||||
|
__slots__ = (
|
||||||
|
"asgi",
|
||||||
|
"body",
|
||||||
|
"content_type",
|
||||||
|
"stream",
|
||||||
|
"status",
|
||||||
|
"headers",
|
||||||
|
"_cookies",
|
||||||
|
)
|
||||||
|
|
||||||
|
_dumps = json_dumps
|
||||||
|
|
||||||
|
def __init__(self):
|
||||||
|
self.asgi: bool = False
|
||||||
|
self.body: Optional[bytes] = None
|
||||||
|
self.content_type: Optional[str] = None
|
||||||
|
self.stream: Optional[Union[Http, ASGIApp, HTTPReceiver]] = None
|
||||||
|
self.status: int = None
|
||||||
|
self.headers = Header({})
|
||||||
|
self._cookies: Optional[CookieJar] = None
|
||||||
|
|
||||||
|
def __repr__(self):
|
||||||
|
class_name = self.__class__.__name__
|
||||||
|
return f"<{class_name}: {self.status} {self.content_type}>"
|
||||||
|
|
||||||
|
def _encode_body(self, data: Optional[AnyStr]):
|
||||||
|
if data is None:
|
||||||
|
return b""
|
||||||
|
return (
|
||||||
|
data.encode() if hasattr(data, "encode") else data # type: ignore
|
||||||
|
)
|
||||||
|
|
||||||
|
@property
|
||||||
|
def cookies(self) -> CookieJar:
|
||||||
|
"""
|
||||||
|
The response cookies. Cookies should be set and written as follows:
|
||||||
|
|
||||||
|
.. code-block:: python
|
||||||
|
|
||||||
|
response.cookies["test"] = "It worked!"
|
||||||
|
response.cookies["test"]["domain"] = ".yummy-yummy-cookie.com"
|
||||||
|
response.cookies["test"]["httponly"] = True
|
||||||
|
|
||||||
|
`See user guide re: cookies
|
||||||
|
<https://sanicframework.org/guide/basics/cookies.html>`__
|
||||||
|
|
||||||
|
:return: the cookie jar
|
||||||
|
:rtype: CookieJar
|
||||||
|
"""
|
||||||
|
if self._cookies is None:
|
||||||
|
self._cookies = CookieJar(self.headers)
|
||||||
|
return self._cookies
|
||||||
|
|
||||||
|
@property
|
||||||
|
def processed_headers(self) -> Iterator[Tuple[bytes, bytes]]:
|
||||||
|
"""
|
||||||
|
Obtain a list of header tuples encoded in bytes for sending.
|
||||||
|
|
||||||
|
Add and remove headers based on status and content_type.
|
||||||
|
|
||||||
|
:return: response headers
|
||||||
|
:rtype: Tuple[Tuple[bytes, bytes], ...]
|
||||||
|
"""
|
||||||
|
# TODO: Make a blacklist set of header names and then filter with that
|
||||||
|
if self.status in (304, 412): # Not Modified, Precondition Failed
|
||||||
|
self.headers = remove_entity_headers(self.headers)
|
||||||
|
if has_message_body(self.status):
|
||||||
|
self.headers.setdefault("content-type", self.content_type)
|
||||||
|
# Encode headers into bytes
|
||||||
|
return (
|
||||||
|
(name.encode("ascii"), f"{value}".encode(errors="surrogateescape"))
|
||||||
|
for name, value in self.headers.items()
|
||||||
|
)
|
||||||
|
|
||||||
|
async def send(
|
||||||
|
self,
|
||||||
|
data: Optional[AnyStr] = None,
|
||||||
|
end_stream: Optional[bool] = None,
|
||||||
|
) -> None:
|
||||||
|
"""
|
||||||
|
Send any pending response headers and the given data as body.
|
||||||
|
|
||||||
|
:param data: str or bytes to be written
|
||||||
|
:param end_stream: whether to close the stream after this block
|
||||||
|
"""
|
||||||
|
if data is None and end_stream is None:
|
||||||
|
end_stream = True
|
||||||
|
if self.stream is None:
|
||||||
|
raise SanicException(
|
||||||
|
"No stream is connected to the response object instance."
|
||||||
|
)
|
||||||
|
if self.stream.send is None:
|
||||||
|
if end_stream and not data:
|
||||||
|
return
|
||||||
|
raise ServerError(
|
||||||
|
"Response stream was ended, no more response data is "
|
||||||
|
"allowed to be sent."
|
||||||
|
)
|
||||||
|
data = (
|
||||||
|
data.encode() # type: ignore
|
||||||
|
if hasattr(data, "encode")
|
||||||
|
else data or b""
|
||||||
|
)
|
||||||
|
await self.stream.send(
|
||||||
|
data, # type: ignore
|
||||||
|
end_stream=end_stream or False,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
class HTTPResponse(BaseHTTPResponse):
|
||||||
|
"""
|
||||||
|
HTTP response to be sent back to the client.
|
||||||
|
|
||||||
|
:param body: the body content to be returned
|
||||||
|
:type body: Optional[bytes]
|
||||||
|
:param status: HTTP response number. **Default=200**
|
||||||
|
:type status: int
|
||||||
|
:param headers: headers to be returned
|
||||||
|
:type headers: Optional;
|
||||||
|
:param content_type: content type to be returned (as a header)
|
||||||
|
:type content_type: Optional[str]
|
||||||
|
"""
|
||||||
|
|
||||||
|
__slots__ = ()
|
||||||
|
|
||||||
|
def __init__(
|
||||||
|
self,
|
||||||
|
body: Optional[AnyStr] = None,
|
||||||
|
status: int = 200,
|
||||||
|
headers: Optional[Union[Header, Dict[str, str]]] = None,
|
||||||
|
content_type: Optional[str] = None,
|
||||||
|
):
|
||||||
|
super().__init__()
|
||||||
|
|
||||||
|
self.content_type: Optional[str] = content_type
|
||||||
|
self.body = self._encode_body(body)
|
||||||
|
self.status = status
|
||||||
|
self.headers = Header(headers or {})
|
||||||
|
self._cookies = None
|
||||||
|
|
||||||
|
async def eof(self):
|
||||||
|
await self.send("", True)
|
||||||
|
|
||||||
|
async def __aenter__(self):
|
||||||
|
return self.send
|
||||||
|
|
||||||
|
async def __aexit__(self, *_):
|
||||||
|
await self.eof()
|
||||||
|
|
||||||
|
|
||||||
def empty(
|
def empty(
|
||||||
@@ -37,7 +229,7 @@ def json(
|
|||||||
content_type: str = "application/json",
|
content_type: str = "application/json",
|
||||||
dumps: Optional[Callable[..., str]] = None,
|
dumps: Optional[Callable[..., str]] = None,
|
||||||
**kwargs: Any,
|
**kwargs: Any,
|
||||||
) -> JSONResponse:
|
) -> HTTPResponse:
|
||||||
"""
|
"""
|
||||||
Returns response object with body in json format.
|
Returns response object with body in json format.
|
||||||
|
|
||||||
@@ -46,14 +238,13 @@ def json(
|
|||||||
:param headers: Custom Headers.
|
:param headers: Custom Headers.
|
||||||
:param kwargs: Remaining arguments that are passed to the json encoder.
|
:param kwargs: Remaining arguments that are passed to the json encoder.
|
||||||
"""
|
"""
|
||||||
|
if not dumps:
|
||||||
return JSONResponse(
|
dumps = BaseHTTPResponse._dumps
|
||||||
body,
|
return HTTPResponse(
|
||||||
status=status,
|
dumps(body, **kwargs),
|
||||||
headers=headers,
|
headers=headers,
|
||||||
|
status=status,
|
||||||
content_type=content_type,
|
content_type=content_type,
|
||||||
dumps=dumps,
|
|
||||||
**kwargs,
|
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
@@ -274,6 +465,80 @@ def redirect(
|
|||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
|
class ResponseStream:
|
||||||
|
"""
|
||||||
|
ResponseStream is a compat layer to bridge the gap after the deprecation
|
||||||
|
of StreamingHTTPResponse. It will be removed when:
|
||||||
|
- file_stream is moved to new style streaming
|
||||||
|
- file and file_stream are combined into a single API
|
||||||
|
"""
|
||||||
|
|
||||||
|
__slots__ = (
|
||||||
|
"_cookies",
|
||||||
|
"content_type",
|
||||||
|
"headers",
|
||||||
|
"request",
|
||||||
|
"response",
|
||||||
|
"status",
|
||||||
|
"streaming_fn",
|
||||||
|
)
|
||||||
|
|
||||||
|
def __init__(
|
||||||
|
self,
|
||||||
|
streaming_fn: Callable[
|
||||||
|
[Union[BaseHTTPResponse, ResponseStream]],
|
||||||
|
Coroutine[Any, Any, None],
|
||||||
|
],
|
||||||
|
status: int = 200,
|
||||||
|
headers: Optional[Union[Header, Dict[str, str]]] = None,
|
||||||
|
content_type: Optional[str] = None,
|
||||||
|
):
|
||||||
|
self.streaming_fn = streaming_fn
|
||||||
|
self.status = status
|
||||||
|
self.headers = headers or Header()
|
||||||
|
self.content_type = content_type
|
||||||
|
self.request: Optional[Request] = None
|
||||||
|
self._cookies: Optional[CookieJar] = None
|
||||||
|
|
||||||
|
async def write(self, message: str):
|
||||||
|
await self.response.send(message)
|
||||||
|
|
||||||
|
async def stream(self) -> HTTPResponse:
|
||||||
|
if not self.request:
|
||||||
|
raise ServerError("Attempted response to unknown request")
|
||||||
|
self.response = await self.request.respond(
|
||||||
|
headers=self.headers,
|
||||||
|
status=self.status,
|
||||||
|
content_type=self.content_type,
|
||||||
|
)
|
||||||
|
await self.streaming_fn(self)
|
||||||
|
return self.response
|
||||||
|
|
||||||
|
async def eof(self) -> None:
|
||||||
|
await self.response.eof()
|
||||||
|
|
||||||
|
@property
|
||||||
|
def cookies(self) -> CookieJar:
|
||||||
|
if self._cookies is None:
|
||||||
|
self._cookies = CookieJar(self.headers)
|
||||||
|
return self._cookies
|
||||||
|
|
||||||
|
@property
|
||||||
|
def processed_headers(self):
|
||||||
|
return self.response.processed_headers
|
||||||
|
|
||||||
|
@property
|
||||||
|
def body(self):
|
||||||
|
return self.response.body
|
||||||
|
|
||||||
|
def __call__(self, request: Request) -> ResponseStream:
|
||||||
|
self.request = request
|
||||||
|
return self
|
||||||
|
|
||||||
|
def __await__(self):
|
||||||
|
return self.stream().__await__()
|
||||||
|
|
||||||
|
|
||||||
async def file_stream(
|
async def file_stream(
|
||||||
location: Union[str, PurePath],
|
location: Union[str, PurePath],
|
||||||
status: int = 200,
|
status: int = 200,
|
||||||
@@ -1,36 +0,0 @@
|
|||||||
from .convenience import (
|
|
||||||
empty,
|
|
||||||
file,
|
|
||||||
file_stream,
|
|
||||||
html,
|
|
||||||
json,
|
|
||||||
raw,
|
|
||||||
redirect,
|
|
||||||
text,
|
|
||||||
validate_file,
|
|
||||||
)
|
|
||||||
from .types import (
|
|
||||||
BaseHTTPResponse,
|
|
||||||
HTTPResponse,
|
|
||||||
JSONResponse,
|
|
||||||
ResponseStream,
|
|
||||||
json_dumps,
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
__all__ = (
|
|
||||||
"BaseHTTPResponse",
|
|
||||||
"HTTPResponse",
|
|
||||||
"JSONResponse",
|
|
||||||
"ResponseStream",
|
|
||||||
"empty",
|
|
||||||
"json",
|
|
||||||
"text",
|
|
||||||
"raw",
|
|
||||||
"html",
|
|
||||||
"validate_file",
|
|
||||||
"file",
|
|
||||||
"redirect",
|
|
||||||
"file_stream",
|
|
||||||
"json_dumps",
|
|
||||||
)
|
|
||||||
@@ -1,453 +0,0 @@
|
|||||||
from __future__ import annotations
|
|
||||||
|
|
||||||
from functools import partial
|
|
||||||
from typing import (
|
|
||||||
TYPE_CHECKING,
|
|
||||||
Any,
|
|
||||||
AnyStr,
|
|
||||||
Callable,
|
|
||||||
Coroutine,
|
|
||||||
Dict,
|
|
||||||
Iterator,
|
|
||||||
Optional,
|
|
||||||
Tuple,
|
|
||||||
TypeVar,
|
|
||||||
Union,
|
|
||||||
)
|
|
||||||
|
|
||||||
from sanic.compat import Header
|
|
||||||
from sanic.cookies import CookieJar
|
|
||||||
from sanic.exceptions import SanicException, ServerError
|
|
||||||
from sanic.helpers import (
|
|
||||||
Default,
|
|
||||||
_default,
|
|
||||||
has_message_body,
|
|
||||||
remove_entity_headers,
|
|
||||||
)
|
|
||||||
from sanic.http import Http
|
|
||||||
|
|
||||||
|
|
||||||
if TYPE_CHECKING:
|
|
||||||
from sanic.asgi import ASGIApp
|
|
||||||
from sanic.http.http3 import HTTPReceiver
|
|
||||||
from sanic.request import Request
|
|
||||||
else:
|
|
||||||
Request = TypeVar("Request")
|
|
||||||
|
|
||||||
|
|
||||||
try:
|
|
||||||
from ujson import dumps as json_dumps
|
|
||||||
except ImportError:
|
|
||||||
# This is done in order to ensure that the JSON response is
|
|
||||||
# kept consistent across both ujson and inbuilt json usage.
|
|
||||||
from json import dumps
|
|
||||||
|
|
||||||
json_dumps = partial(dumps, separators=(",", ":"))
|
|
||||||
|
|
||||||
|
|
||||||
class BaseHTTPResponse:
|
|
||||||
"""
|
|
||||||
The base class for all HTTP Responses
|
|
||||||
"""
|
|
||||||
|
|
||||||
__slots__ = (
|
|
||||||
"asgi",
|
|
||||||
"body",
|
|
||||||
"content_type",
|
|
||||||
"stream",
|
|
||||||
"status",
|
|
||||||
"headers",
|
|
||||||
"_cookies",
|
|
||||||
)
|
|
||||||
|
|
||||||
_dumps = json_dumps
|
|
||||||
|
|
||||||
def __init__(self):
|
|
||||||
self.asgi: bool = False
|
|
||||||
self.body: Optional[bytes] = None
|
|
||||||
self.content_type: Optional[str] = None
|
|
||||||
self.stream: Optional[Union[Http, ASGIApp, HTTPReceiver]] = None
|
|
||||||
self.status: int = None
|
|
||||||
self.headers = Header({})
|
|
||||||
self._cookies: Optional[CookieJar] = None
|
|
||||||
|
|
||||||
def __repr__(self):
|
|
||||||
class_name = self.__class__.__name__
|
|
||||||
return f"<{class_name}: {self.status} {self.content_type}>"
|
|
||||||
|
|
||||||
def _encode_body(self, data: Optional[AnyStr]):
|
|
||||||
if data is None:
|
|
||||||
return b""
|
|
||||||
return (
|
|
||||||
data.encode() if hasattr(data, "encode") else data # type: ignore
|
|
||||||
)
|
|
||||||
|
|
||||||
@property
|
|
||||||
def cookies(self) -> CookieJar:
|
|
||||||
"""
|
|
||||||
The response cookies. Cookies should be set and written as follows:
|
|
||||||
|
|
||||||
.. code-block:: python
|
|
||||||
|
|
||||||
response.cookies["test"] = "It worked!"
|
|
||||||
response.cookies["test"]["domain"] = ".yummy-yummy-cookie.com"
|
|
||||||
response.cookies["test"]["httponly"] = True
|
|
||||||
|
|
||||||
`See user guide re: cookies
|
|
||||||
<https://sanic.dev/en/guide/basics/cookies.html>`
|
|
||||||
|
|
||||||
:return: the cookie jar
|
|
||||||
:rtype: CookieJar
|
|
||||||
"""
|
|
||||||
if self._cookies is None:
|
|
||||||
self._cookies = CookieJar(self.headers)
|
|
||||||
return self._cookies
|
|
||||||
|
|
||||||
@property
|
|
||||||
def processed_headers(self) -> Iterator[Tuple[bytes, bytes]]:
|
|
||||||
"""
|
|
||||||
Obtain a list of header tuples encoded in bytes for sending.
|
|
||||||
|
|
||||||
Add and remove headers based on status and content_type.
|
|
||||||
|
|
||||||
:return: response headers
|
|
||||||
:rtype: Tuple[Tuple[bytes, bytes], ...]
|
|
||||||
"""
|
|
||||||
# TODO: Make a blacklist set of header names and then filter with that
|
|
||||||
if self.status in (304, 412): # Not Modified, Precondition Failed
|
|
||||||
self.headers = remove_entity_headers(self.headers)
|
|
||||||
if has_message_body(self.status):
|
|
||||||
self.headers.setdefault("content-type", self.content_type)
|
|
||||||
# Encode headers into bytes
|
|
||||||
return (
|
|
||||||
(name.encode("ascii"), f"{value}".encode(errors="surrogateescape"))
|
|
||||||
for name, value in self.headers.items()
|
|
||||||
)
|
|
||||||
|
|
||||||
async def send(
|
|
||||||
self,
|
|
||||||
data: Optional[AnyStr] = None,
|
|
||||||
end_stream: Optional[bool] = None,
|
|
||||||
) -> None:
|
|
||||||
"""
|
|
||||||
Send any pending response headers and the given data as body.
|
|
||||||
|
|
||||||
:param data: str or bytes to be written
|
|
||||||
:param end_stream: whether to close the stream after this block
|
|
||||||
"""
|
|
||||||
if data is None and end_stream is None:
|
|
||||||
end_stream = True
|
|
||||||
if self.stream is None:
|
|
||||||
raise SanicException(
|
|
||||||
"No stream is connected to the response object instance."
|
|
||||||
)
|
|
||||||
if self.stream.send is None:
|
|
||||||
if end_stream and not data:
|
|
||||||
return
|
|
||||||
raise ServerError(
|
|
||||||
"Response stream was ended, no more response data is "
|
|
||||||
"allowed to be sent."
|
|
||||||
)
|
|
||||||
data = (
|
|
||||||
data.encode() # type: ignore
|
|
||||||
if hasattr(data, "encode")
|
|
||||||
else data or b""
|
|
||||||
)
|
|
||||||
await self.stream.send(
|
|
||||||
data, # type: ignore
|
|
||||||
end_stream=end_stream or False,
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
class HTTPResponse(BaseHTTPResponse):
|
|
||||||
"""
|
|
||||||
HTTP response to be sent back to the client.
|
|
||||||
|
|
||||||
:param body: the body content to be returned
|
|
||||||
:type body: Optional[bytes]
|
|
||||||
:param status: HTTP response number. **Default=200**
|
|
||||||
:type status: int
|
|
||||||
:param headers: headers to be returned
|
|
||||||
:type headers: Optional;
|
|
||||||
:param content_type: content type to be returned (as a header)
|
|
||||||
:type content_type: Optional[str]
|
|
||||||
"""
|
|
||||||
|
|
||||||
__slots__ = ()
|
|
||||||
|
|
||||||
def __init__(
|
|
||||||
self,
|
|
||||||
body: Optional[Any] = None,
|
|
||||||
status: int = 200,
|
|
||||||
headers: Optional[Union[Header, Dict[str, str]]] = None,
|
|
||||||
content_type: Optional[str] = None,
|
|
||||||
):
|
|
||||||
super().__init__()
|
|
||||||
|
|
||||||
self.content_type: Optional[str] = content_type
|
|
||||||
self.body = self._encode_body(body)
|
|
||||||
self.status = status
|
|
||||||
self.headers = Header(headers or {})
|
|
||||||
self._cookies = None
|
|
||||||
|
|
||||||
async def eof(self):
|
|
||||||
await self.send("", True)
|
|
||||||
|
|
||||||
async def __aenter__(self):
|
|
||||||
return self.send
|
|
||||||
|
|
||||||
async def __aexit__(self, *_):
|
|
||||||
await self.eof()
|
|
||||||
|
|
||||||
|
|
||||||
class JSONResponse(HTTPResponse):
|
|
||||||
"""
|
|
||||||
HTTP response to be sent back to the client, when the response
|
|
||||||
is of json type. Offers several utilities to manipulate common
|
|
||||||
json data types.
|
|
||||||
|
|
||||||
:param body: the body content to be returned
|
|
||||||
:type body: Optional[Any]
|
|
||||||
:param status: HTTP response number. **Default=200**
|
|
||||||
:type status: int
|
|
||||||
:param headers: headers to be returned
|
|
||||||
:type headers: Optional
|
|
||||||
:param content_type: content type to be returned (as a header)
|
|
||||||
:type content_type: Optional[str]
|
|
||||||
:param dumps: json.dumps function to use
|
|
||||||
:type dumps: Optional[Callable]
|
|
||||||
"""
|
|
||||||
|
|
||||||
__slots__ = (
|
|
||||||
"_body",
|
|
||||||
"_body_manually_set",
|
|
||||||
"_initialized",
|
|
||||||
"_raw_body",
|
|
||||||
"_use_dumps",
|
|
||||||
"_use_dumps_kwargs",
|
|
||||||
)
|
|
||||||
|
|
||||||
def __init__(
|
|
||||||
self,
|
|
||||||
body: Optional[Any] = None,
|
|
||||||
status: int = 200,
|
|
||||||
headers: Optional[Union[Header, Dict[str, str]]] = None,
|
|
||||||
content_type: Optional[str] = None,
|
|
||||||
dumps: Optional[Callable[..., str]] = None,
|
|
||||||
**kwargs: Any,
|
|
||||||
):
|
|
||||||
self._initialized = False
|
|
||||||
self._body_manually_set = False
|
|
||||||
|
|
||||||
self._use_dumps = dumps or BaseHTTPResponse._dumps
|
|
||||||
self._use_dumps_kwargs = kwargs
|
|
||||||
|
|
||||||
self._raw_body = body
|
|
||||||
|
|
||||||
super().__init__(
|
|
||||||
self._encode_body(self._use_dumps(body, **self._use_dumps_kwargs)),
|
|
||||||
headers=headers,
|
|
||||||
status=status,
|
|
||||||
content_type=content_type,
|
|
||||||
)
|
|
||||||
|
|
||||||
self._initialized = True
|
|
||||||
|
|
||||||
def _check_body_not_manually_set(self):
|
|
||||||
if self._body_manually_set:
|
|
||||||
raise SanicException(
|
|
||||||
"Cannot use raw_body after body has been manually set."
|
|
||||||
)
|
|
||||||
|
|
||||||
@property
|
|
||||||
def raw_body(self) -> Optional[Any]:
|
|
||||||
"""Returns the raw body, as long as body has not been manually
|
|
||||||
set previously.
|
|
||||||
|
|
||||||
NOTE: This object should not be mutated, as it will not be
|
|
||||||
reflected in the response body. If you need to mutate the
|
|
||||||
response body, consider using one of the provided methods in
|
|
||||||
this class or alternatively call set_body() with the mutated
|
|
||||||
object afterwards or set the raw_body property to it.
|
|
||||||
"""
|
|
||||||
|
|
||||||
self._check_body_not_manually_set()
|
|
||||||
return self._raw_body
|
|
||||||
|
|
||||||
@raw_body.setter
|
|
||||||
def raw_body(self, value: Any):
|
|
||||||
self._body_manually_set = False
|
|
||||||
self._body = self._encode_body(
|
|
||||||
self._use_dumps(value, **self._use_dumps_kwargs)
|
|
||||||
)
|
|
||||||
self._raw_body = value
|
|
||||||
|
|
||||||
@property # type: ignore
|
|
||||||
def body(self) -> Optional[bytes]: # type: ignore
|
|
||||||
return self._body
|
|
||||||
|
|
||||||
@body.setter
|
|
||||||
def body(self, value: Optional[bytes]):
|
|
||||||
self._body = value
|
|
||||||
if not self._initialized:
|
|
||||||
return
|
|
||||||
self._body_manually_set = True
|
|
||||||
|
|
||||||
def set_body(
|
|
||||||
self,
|
|
||||||
body: Any,
|
|
||||||
dumps: Optional[Callable[..., str]] = None,
|
|
||||||
**dumps_kwargs: Any,
|
|
||||||
) -> None:
|
|
||||||
"""Sets a new response body using the given dumps function
|
|
||||||
and kwargs, or falling back to the defaults given when
|
|
||||||
creating the object if none are specified.
|
|
||||||
"""
|
|
||||||
|
|
||||||
self._body_manually_set = False
|
|
||||||
self._raw_body = body
|
|
||||||
|
|
||||||
use_dumps = dumps or self._use_dumps
|
|
||||||
use_dumps_kwargs = dumps_kwargs if dumps else self._use_dumps_kwargs
|
|
||||||
|
|
||||||
self._body = self._encode_body(use_dumps(body, **use_dumps_kwargs))
|
|
||||||
|
|
||||||
def append(self, value: Any) -> None:
|
|
||||||
"""Appends a value to the response raw_body, ensuring that
|
|
||||||
body is kept up to date. This can only be used if raw_body
|
|
||||||
is a list.
|
|
||||||
"""
|
|
||||||
|
|
||||||
self._check_body_not_manually_set()
|
|
||||||
|
|
||||||
if not isinstance(self._raw_body, list):
|
|
||||||
raise SanicException("Cannot append to a non-list object.")
|
|
||||||
|
|
||||||
self._raw_body.append(value)
|
|
||||||
self.raw_body = self._raw_body
|
|
||||||
|
|
||||||
def extend(self, value: Any) -> None:
|
|
||||||
"""Extends the response's raw_body with the given values, ensuring
|
|
||||||
that body is kept up to date. This can only be used if raw_body is
|
|
||||||
a list.
|
|
||||||
"""
|
|
||||||
|
|
||||||
self._check_body_not_manually_set()
|
|
||||||
|
|
||||||
if not isinstance(self._raw_body, list):
|
|
||||||
raise SanicException("Cannot extend a non-list object.")
|
|
||||||
|
|
||||||
self._raw_body.extend(value)
|
|
||||||
self.raw_body = self._raw_body
|
|
||||||
|
|
||||||
def update(self, *args, **kwargs) -> None:
|
|
||||||
"""Updates the response's raw_body with the given values, ensuring
|
|
||||||
that body is kept up to date. This can only be used if raw_body is
|
|
||||||
a dict.
|
|
||||||
"""
|
|
||||||
|
|
||||||
self._check_body_not_manually_set()
|
|
||||||
|
|
||||||
if not isinstance(self._raw_body, dict):
|
|
||||||
raise SanicException("Cannot update a non-dict object.")
|
|
||||||
|
|
||||||
self._raw_body.update(*args, **kwargs)
|
|
||||||
self.raw_body = self._raw_body
|
|
||||||
|
|
||||||
def pop(self, key: Any, default: Any = _default) -> Any:
|
|
||||||
"""Pops a key from the response's raw_body, ensuring that body is
|
|
||||||
kept up to date. This can only be used if raw_body is a dict or a
|
|
||||||
list.
|
|
||||||
"""
|
|
||||||
|
|
||||||
self._check_body_not_manually_set()
|
|
||||||
|
|
||||||
if not isinstance(self._raw_body, (list, dict)):
|
|
||||||
raise SanicException(
|
|
||||||
"Cannot pop from a non-list and non-dict object."
|
|
||||||
)
|
|
||||||
|
|
||||||
if isinstance(default, Default):
|
|
||||||
value = self._raw_body.pop(key)
|
|
||||||
elif isinstance(self._raw_body, list):
|
|
||||||
raise TypeError("pop doesn't accept a default argument for lists")
|
|
||||||
else:
|
|
||||||
value = self._raw_body.pop(key, default)
|
|
||||||
|
|
||||||
self.raw_body = self._raw_body
|
|
||||||
|
|
||||||
return value
|
|
||||||
|
|
||||||
|
|
||||||
class ResponseStream:
|
|
||||||
"""
|
|
||||||
ResponseStream is a compat layer to bridge the gap after the deprecation
|
|
||||||
of StreamingHTTPResponse. It will be removed when:
|
|
||||||
- file_stream is moved to new style streaming
|
|
||||||
- file and file_stream are combined into a single API
|
|
||||||
"""
|
|
||||||
|
|
||||||
__slots__ = (
|
|
||||||
"_cookies",
|
|
||||||
"content_type",
|
|
||||||
"headers",
|
|
||||||
"request",
|
|
||||||
"response",
|
|
||||||
"status",
|
|
||||||
"streaming_fn",
|
|
||||||
)
|
|
||||||
|
|
||||||
def __init__(
|
|
||||||
self,
|
|
||||||
streaming_fn: Callable[
|
|
||||||
[Union[BaseHTTPResponse, ResponseStream]],
|
|
||||||
Coroutine[Any, Any, None],
|
|
||||||
],
|
|
||||||
status: int = 200,
|
|
||||||
headers: Optional[Union[Header, Dict[str, str]]] = None,
|
|
||||||
content_type: Optional[str] = None,
|
|
||||||
):
|
|
||||||
self.streaming_fn = streaming_fn
|
|
||||||
self.status = status
|
|
||||||
self.headers = headers or Header()
|
|
||||||
self.content_type = content_type
|
|
||||||
self.request: Optional[Request] = None
|
|
||||||
self._cookies: Optional[CookieJar] = None
|
|
||||||
|
|
||||||
async def write(self, message: str):
|
|
||||||
await self.response.send(message)
|
|
||||||
|
|
||||||
async def stream(self) -> HTTPResponse:
|
|
||||||
if not self.request:
|
|
||||||
raise ServerError("Attempted response to unknown request")
|
|
||||||
self.response = await self.request.respond(
|
|
||||||
headers=self.headers,
|
|
||||||
status=self.status,
|
|
||||||
content_type=self.content_type,
|
|
||||||
)
|
|
||||||
await self.streaming_fn(self)
|
|
||||||
return self.response
|
|
||||||
|
|
||||||
async def eof(self) -> None:
|
|
||||||
await self.response.eof()
|
|
||||||
|
|
||||||
@property
|
|
||||||
def cookies(self) -> CookieJar:
|
|
||||||
if self._cookies is None:
|
|
||||||
self._cookies = CookieJar(self.headers)
|
|
||||||
return self._cookies
|
|
||||||
|
|
||||||
@property
|
|
||||||
def processed_headers(self):
|
|
||||||
return self.response.processed_headers
|
|
||||||
|
|
||||||
@property
|
|
||||||
def body(self):
|
|
||||||
return self.response.body
|
|
||||||
|
|
||||||
def __call__(self, request: Request) -> ResponseStream:
|
|
||||||
self.request = request
|
|
||||||
return self
|
|
||||||
|
|
||||||
def __await__(self):
|
|
||||||
return self.stream().__await__()
|
|
||||||
@@ -13,6 +13,7 @@ from sanic_routing.route import Route
|
|||||||
from sanic.constants import HTTP_METHODS
|
from sanic.constants import HTTP_METHODS
|
||||||
from sanic.errorpages import check_error_format
|
from sanic.errorpages import check_error_format
|
||||||
from sanic.exceptions import MethodNotAllowed, NotFound, SanicException
|
from sanic.exceptions import MethodNotAllowed, NotFound, SanicException
|
||||||
|
from sanic.handlers import RequestHandler
|
||||||
from sanic.models.handler_types import RouteHandler
|
from sanic.models.handler_types import RouteHandler
|
||||||
|
|
||||||
|
|
||||||
@@ -31,9 +32,11 @@ class Router(BaseRouter):
|
|||||||
|
|
||||||
def _get(
|
def _get(
|
||||||
self, path: str, method: str, host: Optional[str]
|
self, path: str, method: str, host: Optional[str]
|
||||||
) -> Tuple[Route, RouteHandler, Dict[str, Any]]:
|
) -> Tuple[Route, RequestHandler, Dict[str, Any]]:
|
||||||
try:
|
try:
|
||||||
return self.resolve(
|
# We know this will always be RequestHandler, so we can ignore
|
||||||
|
# typing issue here
|
||||||
|
return self.resolve( # type: ignore
|
||||||
path=path,
|
path=path,
|
||||||
method=method,
|
method=method,
|
||||||
extra={"host": host} if host else None,
|
extra={"host": host} if host else None,
|
||||||
@@ -50,7 +53,7 @@ class Router(BaseRouter):
|
|||||||
@lru_cache(maxsize=ROUTER_CACHE_SIZE)
|
@lru_cache(maxsize=ROUTER_CACHE_SIZE)
|
||||||
def get( # type: ignore
|
def get( # type: ignore
|
||||||
self, path: str, method: str, host: Optional[str]
|
self, path: str, method: str, host: Optional[str]
|
||||||
) -> Tuple[Route, RouteHandler, Dict[str, Any]]:
|
) -> Tuple[Route, RequestHandler, Dict[str, Any]]:
|
||||||
"""
|
"""
|
||||||
Retrieve a `Route` object containing the details about how to handle
|
Retrieve a `Route` object containing the details about how to handle
|
||||||
a response for a given request
|
a response for a given request
|
||||||
@@ -59,7 +62,7 @@ class Router(BaseRouter):
|
|||||||
:type request: Request
|
:type request: Request
|
||||||
:return: details needed for handling the request and returning the
|
:return: details needed for handling the request and returning the
|
||||||
correct response
|
correct response
|
||||||
:rtype: Tuple[ Route, RouteHandler, Dict[str, Any]]
|
:rtype: Tuple[ Route, RequestHandler, Dict[str, Any]]
|
||||||
"""
|
"""
|
||||||
return self._get(path, method, host)
|
return self._get(path, method, host)
|
||||||
|
|
||||||
@@ -114,7 +117,7 @@ class Router(BaseRouter):
|
|||||||
|
|
||||||
params = dict(
|
params = dict(
|
||||||
path=uri,
|
path=uri,
|
||||||
handler=handler,
|
handler=RequestHandler(handler, [], []),
|
||||||
methods=frozenset(map(str, methods)) if methods else None,
|
methods=frozenset(map(str, methods)) if methods else None,
|
||||||
name=name,
|
name=name,
|
||||||
strict=strict_slashes,
|
strict=strict_slashes,
|
||||||
@@ -133,14 +136,14 @@ class Router(BaseRouter):
|
|||||||
params.update({"requirements": {"host": host}})
|
params.update({"requirements": {"host": host}})
|
||||||
|
|
||||||
route = super().add(**params) # type: ignore
|
route = super().add(**params) # type: ignore
|
||||||
route.extra.ignore_body = ignore_body
|
route.ctx.ignore_body = ignore_body
|
||||||
route.extra.stream = stream
|
route.ctx.stream = stream
|
||||||
route.extra.hosts = hosts
|
route.ctx.hosts = hosts
|
||||||
route.extra.static = static
|
route.ctx.static = static
|
||||||
route.extra.error_format = error_format
|
route.ctx.error_format = error_format
|
||||||
|
|
||||||
if error_format:
|
if error_format:
|
||||||
check_error_format(route.extra.error_format)
|
check_error_format(route.ctx.error_format)
|
||||||
|
|
||||||
routes.append(route)
|
routes.append(route)
|
||||||
|
|
||||||
|
|||||||
@@ -2,6 +2,7 @@ from __future__ import annotations
|
|||||||
|
|
||||||
from typing import TYPE_CHECKING, Optional
|
from typing import TYPE_CHECKING, Optional
|
||||||
|
|
||||||
|
from sanic.handlers import RequestManager
|
||||||
from sanic.http.constants import HTTP
|
from sanic.http.constants import HTTP
|
||||||
from sanic.http.http3 import Http3
|
from sanic.http.http3 import Http3
|
||||||
from sanic.touchup.meta import TouchUpMeta
|
from sanic.touchup.meta import TouchUpMeta
|
||||||
@@ -57,7 +58,7 @@ class HttpProtocolMixin:
|
|||||||
def _setup(self):
|
def _setup(self):
|
||||||
self.request: Optional[Request] = None
|
self.request: Optional[Request] = None
|
||||||
self.access_log = self.app.config.ACCESS_LOG
|
self.access_log = self.app.config.ACCESS_LOG
|
||||||
self.request_handler = self.app.handle_request
|
self.request_handler = RequestManager
|
||||||
self.error_handler = self.app.error_handler
|
self.error_handler = self.app.error_handler
|
||||||
self.request_timeout = self.app.config.REQUEST_TIMEOUT
|
self.request_timeout = self.app.config.REQUEST_TIMEOUT
|
||||||
self.response_timeout = self.app.config.RESPONSE_TIMEOUT
|
self.response_timeout = self.app.config.RESPONSE_TIMEOUT
|
||||||
|
|||||||
@@ -1,13 +1,7 @@
|
|||||||
from typing import TYPE_CHECKING, Optional, Sequence, cast
|
from typing import TYPE_CHECKING, Optional, Sequence, cast
|
||||||
|
|
||||||
|
from websockets.connection import CLOSED, CLOSING, OPEN
|
||||||
try: # websockets < 11.0
|
from websockets.server import ServerConnection
|
||||||
from websockets.connection import State
|
|
||||||
from websockets.server import ServerConnection as ServerProtocol
|
|
||||||
except ImportError: # websockets >= 11.0
|
|
||||||
from websockets.protocol import State # type: ignore
|
|
||||||
from websockets.server import ServerProtocol # type: ignore
|
|
||||||
|
|
||||||
from websockets.typing import Subprotocol
|
from websockets.typing import Subprotocol
|
||||||
|
|
||||||
from sanic.exceptions import ServerError
|
from sanic.exceptions import ServerError
|
||||||
@@ -21,11 +15,6 @@ if TYPE_CHECKING:
|
|||||||
from websockets import http11
|
from websockets import http11
|
||||||
|
|
||||||
|
|
||||||
OPEN = State.OPEN
|
|
||||||
CLOSING = State.CLOSING
|
|
||||||
CLOSED = State.CLOSED
|
|
||||||
|
|
||||||
|
|
||||||
class WebSocketProtocol(HttpProtocol):
|
class WebSocketProtocol(HttpProtocol):
|
||||||
__slots__ = (
|
__slots__ = (
|
||||||
"websocket",
|
"websocket",
|
||||||
@@ -85,7 +74,7 @@ class WebSocketProtocol(HttpProtocol):
|
|||||||
# Called by Sanic Server when shutting down
|
# Called by Sanic Server when shutting down
|
||||||
# If we've upgraded to websocket, shut it down
|
# If we've upgraded to websocket, shut it down
|
||||||
if self.websocket is not None:
|
if self.websocket is not None:
|
||||||
if self.websocket.ws_proto.state in (CLOSING, CLOSED):
|
if self.websocket.connection.state in (CLOSING, CLOSED):
|
||||||
return True
|
return True
|
||||||
elif self.websocket.loop is not None:
|
elif self.websocket.loop is not None:
|
||||||
self.websocket.loop.create_task(self.websocket.close(1001))
|
self.websocket.loop.create_task(self.websocket.close(1001))
|
||||||
@@ -101,7 +90,7 @@ class WebSocketProtocol(HttpProtocol):
|
|||||||
try:
|
try:
|
||||||
if subprotocols is not None:
|
if subprotocols is not None:
|
||||||
# subprotocols can be a set or frozenset,
|
# subprotocols can be a set or frozenset,
|
||||||
# but ServerProtocol needs a list
|
# but ServerConnection needs a list
|
||||||
subprotocols = cast(
|
subprotocols = cast(
|
||||||
Optional[Sequence[Subprotocol]],
|
Optional[Sequence[Subprotocol]],
|
||||||
list(
|
list(
|
||||||
@@ -111,13 +100,13 @@ class WebSocketProtocol(HttpProtocol):
|
|||||||
]
|
]
|
||||||
),
|
),
|
||||||
)
|
)
|
||||||
ws_proto = ServerProtocol(
|
ws_conn = ServerConnection(
|
||||||
max_size=self.websocket_max_size,
|
max_size=self.websocket_max_size,
|
||||||
subprotocols=subprotocols,
|
subprotocols=subprotocols,
|
||||||
state=OPEN,
|
state=OPEN,
|
||||||
logger=logger,
|
logger=logger,
|
||||||
)
|
)
|
||||||
resp: "http11.Response" = ws_proto.accept(request)
|
resp: "http11.Response" = ws_conn.accept(request)
|
||||||
except Exception:
|
except Exception:
|
||||||
msg = (
|
msg = (
|
||||||
"Failed to open a WebSocket connection.\n"
|
"Failed to open a WebSocket connection.\n"
|
||||||
@@ -140,7 +129,7 @@ class WebSocketProtocol(HttpProtocol):
|
|||||||
else:
|
else:
|
||||||
raise ServerError(resp.body, resp.status_code)
|
raise ServerError(resp.body, resp.status_code)
|
||||||
self.websocket = WebsocketImplProtocol(
|
self.websocket = WebsocketImplProtocol(
|
||||||
ws_proto,
|
ws_conn,
|
||||||
ping_interval=self.websocket_ping_interval,
|
ping_interval=self.websocket_ping_interval,
|
||||||
ping_timeout=self.websocket_ping_timeout,
|
ping_timeout=self.websocket_ping_timeout,
|
||||||
close_timeout=self.websocket_timeout,
|
close_timeout=self.websocket_timeout,
|
||||||
|
|||||||
@@ -27,7 +27,7 @@ from signal import signal as signal_func
|
|||||||
from sanic.application.ext import setup_ext
|
from sanic.application.ext import setup_ext
|
||||||
from sanic.compat import OS_IS_WINDOWS, ctrlc_workaround_for_windows
|
from sanic.compat import OS_IS_WINDOWS, ctrlc_workaround_for_windows
|
||||||
from sanic.http.http3 import SessionTicketStore, get_config
|
from sanic.http.http3 import SessionTicketStore, get_config
|
||||||
from sanic.log import error_logger, server_logger
|
from sanic.log import error_logger, logger
|
||||||
from sanic.models.server_types import Signal
|
from sanic.models.server_types import Signal
|
||||||
from sanic.server.async_server import AsyncioServer
|
from sanic.server.async_server import AsyncioServer
|
||||||
from sanic.server.protocols.http_protocol import Http3Protocol, HttpProtocol
|
from sanic.server.protocols.http_protocol import Http3Protocol, HttpProtocol
|
||||||
@@ -149,12 +149,12 @@ def _setup_system_signals(
|
|||||||
def _run_server_forever(loop, before_stop, after_stop, cleanup, unix):
|
def _run_server_forever(loop, before_stop, after_stop, cleanup, unix):
|
||||||
pid = os.getpid()
|
pid = os.getpid()
|
||||||
try:
|
try:
|
||||||
server_logger.info("Starting worker [%s]", pid)
|
logger.info("Starting worker [%s]", pid)
|
||||||
loop.run_forever()
|
loop.run_forever()
|
||||||
except KeyboardInterrupt:
|
except KeyboardInterrupt:
|
||||||
pass
|
pass
|
||||||
finally:
|
finally:
|
||||||
server_logger.info("Stopping worker [%s]", pid)
|
logger.info("Stopping worker [%s]", pid)
|
||||||
|
|
||||||
loop.run_until_complete(before_stop())
|
loop.run_until_complete(before_stop())
|
||||||
|
|
||||||
@@ -372,9 +372,7 @@ def serve_multiple(server_settings, workers):
|
|||||||
processes = []
|
processes = []
|
||||||
|
|
||||||
def sig_handler(signal, frame):
|
def sig_handler(signal, frame):
|
||||||
server_logger.info(
|
logger.info("Received signal %s. Shutting down.", Signals(signal).name)
|
||||||
"Received signal %s. Shutting down.", Signals(signal).name
|
|
||||||
)
|
|
||||||
for process in processes:
|
for process in processes:
|
||||||
os.kill(process.pid, SIGTERM)
|
os.kill(process.pid, SIGTERM)
|
||||||
|
|
||||||
|
|||||||
@@ -113,16 +113,13 @@ def configure_socket(
|
|||||||
backlog=backlog,
|
backlog=backlog,
|
||||||
)
|
)
|
||||||
except OSError as e: # no cov
|
except OSError as e: # no cov
|
||||||
error = ServerError(
|
raise ServerError(
|
||||||
f"Sanic server could not start: {e}.\n\n"
|
f"Sanic server could not start: {e}.\n"
|
||||||
"This may have happened if you are running Sanic in the "
|
"This may have happened if you are running Sanic in the "
|
||||||
"global scope and not inside of a "
|
"global scope and not inside of a "
|
||||||
'`if __name__ == "__main__"` block.\n\nSee more information: '
|
'`if __name__ == "__main__"` block. See more information: '
|
||||||
"https://sanic.dev/en/guide/deployment/manager.html#"
|
"____."
|
||||||
"how-sanic-server-starts-processes\n"
|
) from e
|
||||||
)
|
|
||||||
error.quiet = True
|
|
||||||
raise error
|
|
||||||
sock.set_inheritable(True)
|
sock.set_inheritable(True)
|
||||||
server_settings["sock"] = sock
|
server_settings["sock"] = sock
|
||||||
server_settings["host"] = None
|
server_settings["host"] = None
|
||||||
|
|||||||
@@ -12,37 +12,21 @@ from typing import (
|
|||||||
Union,
|
Union,
|
||||||
)
|
)
|
||||||
|
|
||||||
from websockets.exceptions import (
|
from websockets.connection import CLOSED, CLOSING, OPEN, Event
|
||||||
ConnectionClosed,
|
from websockets.exceptions import ConnectionClosed, ConnectionClosedError
|
||||||
ConnectionClosedError,
|
|
||||||
ConnectionClosedOK,
|
|
||||||
)
|
|
||||||
from websockets.frames import Frame, Opcode
|
from websockets.frames import Frame, Opcode
|
||||||
|
from websockets.server import ServerConnection
|
||||||
|
|
||||||
try: # websockets < 11.0
|
|
||||||
from websockets.connection import Event, State
|
|
||||||
from websockets.server import ServerConnection as ServerProtocol
|
|
||||||
except ImportError: # websockets >= 11.0
|
|
||||||
from websockets.protocol import Event, State # type: ignore
|
|
||||||
from websockets.server import ServerProtocol # type: ignore
|
|
||||||
|
|
||||||
from websockets.typing import Data
|
from websockets.typing import Data
|
||||||
|
|
||||||
from sanic.log import deprecation, error_logger, logger
|
from sanic.log import error_logger, logger
|
||||||
from sanic.server.protocols.base_protocol import SanicProtocol
|
from sanic.server.protocols.base_protocol import SanicProtocol
|
||||||
|
|
||||||
from ...exceptions import ServerError, WebsocketClosed
|
from ...exceptions import ServerError, WebsocketClosed
|
||||||
from .frame import WebsocketFrameAssembler
|
from .frame import WebsocketFrameAssembler
|
||||||
|
|
||||||
|
|
||||||
OPEN = State.OPEN
|
|
||||||
CLOSING = State.CLOSING
|
|
||||||
CLOSED = State.CLOSED
|
|
||||||
|
|
||||||
|
|
||||||
class WebsocketImplProtocol:
|
class WebsocketImplProtocol:
|
||||||
ws_proto: ServerProtocol
|
connection: ServerConnection
|
||||||
io_proto: Optional[SanicProtocol]
|
io_proto: Optional[SanicProtocol]
|
||||||
loop: Optional[asyncio.AbstractEventLoop]
|
loop: Optional[asyncio.AbstractEventLoop]
|
||||||
max_queue: int
|
max_queue: int
|
||||||
@@ -68,14 +52,14 @@ class WebsocketImplProtocol:
|
|||||||
|
|
||||||
def __init__(
|
def __init__(
|
||||||
self,
|
self,
|
||||||
ws_proto,
|
connection,
|
||||||
max_queue=None,
|
max_queue=None,
|
||||||
ping_interval: Optional[float] = 20,
|
ping_interval: Optional[float] = 20,
|
||||||
ping_timeout: Optional[float] = 20,
|
ping_timeout: Optional[float] = 20,
|
||||||
close_timeout: float = 10,
|
close_timeout: float = 10,
|
||||||
loop=None,
|
loop=None,
|
||||||
):
|
):
|
||||||
self.ws_proto = ws_proto
|
self.connection = connection
|
||||||
self.io_proto = None
|
self.io_proto = None
|
||||||
self.loop = None
|
self.loop = None
|
||||||
self.max_queue = max_queue
|
self.max_queue = max_queue
|
||||||
@@ -97,16 +81,7 @@ class WebsocketImplProtocol:
|
|||||||
|
|
||||||
@property
|
@property
|
||||||
def subprotocol(self):
|
def subprotocol(self):
|
||||||
return self.ws_proto.subprotocol
|
return self.connection.subprotocol
|
||||||
|
|
||||||
@property
|
|
||||||
def connection(self):
|
|
||||||
deprecation(
|
|
||||||
"The connection property has been deprecated and will be removed. "
|
|
||||||
"Please use the ws_proto property instead going forward.",
|
|
||||||
22.6,
|
|
||||||
)
|
|
||||||
return self.ws_proto
|
|
||||||
|
|
||||||
def pause_frames(self):
|
def pause_frames(self):
|
||||||
if not self.can_pause:
|
if not self.can_pause:
|
||||||
@@ -320,15 +295,15 @@ class WebsocketImplProtocol:
|
|||||||
# Not draining the write buffer is acceptable in this context.
|
# Not draining the write buffer is acceptable in this context.
|
||||||
|
|
||||||
# clear the send buffer
|
# clear the send buffer
|
||||||
_ = self.ws_proto.data_to_send()
|
_ = self.connection.data_to_send()
|
||||||
# If we're not already CLOSED or CLOSING, then send the close.
|
# If we're not already CLOSED or CLOSING, then send the close.
|
||||||
if self.ws_proto.state is OPEN:
|
if self.connection.state is OPEN:
|
||||||
if code in (1000, 1001):
|
if code in (1000, 1001):
|
||||||
self.ws_proto.send_close(code, reason)
|
self.connection.send_close(code, reason)
|
||||||
else:
|
else:
|
||||||
self.ws_proto.fail(code, reason)
|
self.connection.fail(code, reason)
|
||||||
try:
|
try:
|
||||||
data_to_send = self.ws_proto.data_to_send()
|
data_to_send = self.connection.data_to_send()
|
||||||
while (
|
while (
|
||||||
len(data_to_send)
|
len(data_to_send)
|
||||||
and self.io_proto
|
and self.io_proto
|
||||||
@@ -342,7 +317,7 @@ class WebsocketImplProtocol:
|
|||||||
...
|
...
|
||||||
if code == 1006:
|
if code == 1006:
|
||||||
# Special case: 1006 consider the transport already closed
|
# Special case: 1006 consider the transport already closed
|
||||||
self.ws_proto.state = CLOSED
|
self.connection.state = CLOSED
|
||||||
if self.data_finished_fut and not self.data_finished_fut.done():
|
if self.data_finished_fut and not self.data_finished_fut.done():
|
||||||
# We have a graceful auto-closer. Use it to close the connection.
|
# We have a graceful auto-closer. Use it to close the connection.
|
||||||
self.data_finished_fut.cancel()
|
self.data_finished_fut.cancel()
|
||||||
@@ -363,10 +338,10 @@ class WebsocketImplProtocol:
|
|||||||
# In Python Version 3.7: pause_reading is idempotent
|
# In Python Version 3.7: pause_reading is idempotent
|
||||||
# i.e. it can be called when the transport is already paused or closed.
|
# i.e. it can be called when the transport is already paused or closed.
|
||||||
self.io_proto.transport.pause_reading()
|
self.io_proto.transport.pause_reading()
|
||||||
if self.ws_proto.state == OPEN:
|
if self.connection.state == OPEN:
|
||||||
data_to_send = self.ws_proto.data_to_send()
|
data_to_send = self.connection.data_to_send()
|
||||||
self.ws_proto.send_close(code, reason)
|
self.connection.send_close(code, reason)
|
||||||
data_to_send.extend(self.ws_proto.data_to_send())
|
data_to_send.extend(self.connection.data_to_send())
|
||||||
try:
|
try:
|
||||||
while (
|
while (
|
||||||
len(data_to_send)
|
len(data_to_send)
|
||||||
@@ -475,7 +450,7 @@ class WebsocketImplProtocol:
|
|||||||
Raise ConnectionClosed in pending keepalive pings.
|
Raise ConnectionClosed in pending keepalive pings.
|
||||||
They'll never receive a pong once the connection is closed.
|
They'll never receive a pong once the connection is closed.
|
||||||
"""
|
"""
|
||||||
if self.ws_proto.state is not CLOSED:
|
if self.connection.state is not CLOSED:
|
||||||
raise ServerError(
|
raise ServerError(
|
||||||
"Webscoket about_pings should only be called "
|
"Webscoket about_pings should only be called "
|
||||||
"after connection state is changed to CLOSED"
|
"after connection state is changed to CLOSED"
|
||||||
@@ -504,9 +479,9 @@ class WebsocketImplProtocol:
|
|||||||
self.fail_connection(code, reason)
|
self.fail_connection(code, reason)
|
||||||
return
|
return
|
||||||
async with self.conn_mutex:
|
async with self.conn_mutex:
|
||||||
if self.ws_proto.state is OPEN:
|
if self.connection.state is OPEN:
|
||||||
self.ws_proto.send_close(code, reason)
|
self.connection.send_close(code, reason)
|
||||||
data_to_send = self.ws_proto.data_to_send()
|
data_to_send = self.connection.data_to_send()
|
||||||
await self.send_data(data_to_send)
|
await self.send_data(data_to_send)
|
||||||
|
|
||||||
async def recv(self, timeout: Optional[float] = None) -> Optional[Data]:
|
async def recv(self, timeout: Optional[float] = None) -> Optional[Data]:
|
||||||
@@ -536,7 +511,7 @@ class WebsocketImplProtocol:
|
|||||||
"already waiting for the next message"
|
"already waiting for the next message"
|
||||||
)
|
)
|
||||||
await self.recv_lock.acquire()
|
await self.recv_lock.acquire()
|
||||||
if self.ws_proto.state is CLOSED:
|
if self.connection.state is CLOSED:
|
||||||
self.recv_lock.release()
|
self.recv_lock.release()
|
||||||
raise WebsocketClosed(
|
raise WebsocketClosed(
|
||||||
"Cannot receive from websocket interface after it is closed."
|
"Cannot receive from websocket interface after it is closed."
|
||||||
@@ -587,7 +562,7 @@ class WebsocketImplProtocol:
|
|||||||
"for the next message"
|
"for the next message"
|
||||||
)
|
)
|
||||||
await self.recv_lock.acquire()
|
await self.recv_lock.acquire()
|
||||||
if self.ws_proto.state is CLOSED:
|
if self.connection.state is CLOSED:
|
||||||
self.recv_lock.release()
|
self.recv_lock.release()
|
||||||
raise WebsocketClosed(
|
raise WebsocketClosed(
|
||||||
"Cannot receive from websocket interface after it is closed."
|
"Cannot receive from websocket interface after it is closed."
|
||||||
@@ -646,7 +621,7 @@ class WebsocketImplProtocol:
|
|||||||
"is already waiting for the next message"
|
"is already waiting for the next message"
|
||||||
)
|
)
|
||||||
await self.recv_lock.acquire()
|
await self.recv_lock.acquire()
|
||||||
if self.ws_proto.state is CLOSED:
|
if self.connection.state is CLOSED:
|
||||||
self.recv_lock.release()
|
self.recv_lock.release()
|
||||||
raise WebsocketClosed(
|
raise WebsocketClosed(
|
||||||
"Cannot receive from websocket interface after it is closed."
|
"Cannot receive from websocket interface after it is closed."
|
||||||
@@ -687,7 +662,7 @@ class WebsocketImplProtocol:
|
|||||||
"""
|
"""
|
||||||
async with self.conn_mutex:
|
async with self.conn_mutex:
|
||||||
|
|
||||||
if self.ws_proto.state in (CLOSED, CLOSING):
|
if self.connection.state in (CLOSED, CLOSING):
|
||||||
raise WebsocketClosed(
|
raise WebsocketClosed(
|
||||||
"Cannot write to websocket interface after it is closed."
|
"Cannot write to websocket interface after it is closed."
|
||||||
)
|
)
|
||||||
@@ -700,12 +675,12 @@ class WebsocketImplProtocol:
|
|||||||
# strings and bytes-like objects are iterable.
|
# strings and bytes-like objects are iterable.
|
||||||
|
|
||||||
if isinstance(message, str):
|
if isinstance(message, str):
|
||||||
self.ws_proto.send_text(message.encode("utf-8"))
|
self.connection.send_text(message.encode("utf-8"))
|
||||||
await self.send_data(self.ws_proto.data_to_send())
|
await self.send_data(self.connection.data_to_send())
|
||||||
|
|
||||||
elif isinstance(message, (bytes, bytearray, memoryview)):
|
elif isinstance(message, (bytes, bytearray, memoryview)):
|
||||||
self.ws_proto.send_binary(message)
|
self.connection.send_binary(message)
|
||||||
await self.send_data(self.ws_proto.data_to_send())
|
await self.send_data(self.connection.data_to_send())
|
||||||
|
|
||||||
elif isinstance(message, Mapping):
|
elif isinstance(message, Mapping):
|
||||||
# Catch a common mistake -- passing a dict to send().
|
# Catch a common mistake -- passing a dict to send().
|
||||||
@@ -734,7 +709,7 @@ class WebsocketImplProtocol:
|
|||||||
(which will be encoded to UTF-8) or a bytes-like object.
|
(which will be encoded to UTF-8) or a bytes-like object.
|
||||||
"""
|
"""
|
||||||
async with self.conn_mutex:
|
async with self.conn_mutex:
|
||||||
if self.ws_proto.state in (CLOSED, CLOSING):
|
if self.connection.state in (CLOSED, CLOSING):
|
||||||
raise WebsocketClosed(
|
raise WebsocketClosed(
|
||||||
"Cannot send a ping when the websocket interface "
|
"Cannot send a ping when the websocket interface "
|
||||||
"is closed."
|
"is closed."
|
||||||
@@ -762,8 +737,8 @@ class WebsocketImplProtocol:
|
|||||||
|
|
||||||
self.pings[data] = self.io_proto.loop.create_future()
|
self.pings[data] = self.io_proto.loop.create_future()
|
||||||
|
|
||||||
self.ws_proto.send_ping(data)
|
self.connection.send_ping(data)
|
||||||
await self.send_data(self.ws_proto.data_to_send())
|
await self.send_data(self.connection.data_to_send())
|
||||||
|
|
||||||
return asyncio.shield(self.pings[data])
|
return asyncio.shield(self.pings[data])
|
||||||
|
|
||||||
@@ -775,15 +750,15 @@ class WebsocketImplProtocol:
|
|||||||
be a string (which will be encoded to UTF-8) or a bytes-like object.
|
be a string (which will be encoded to UTF-8) or a bytes-like object.
|
||||||
"""
|
"""
|
||||||
async with self.conn_mutex:
|
async with self.conn_mutex:
|
||||||
if self.ws_proto.state in (CLOSED, CLOSING):
|
if self.connection.state in (CLOSED, CLOSING):
|
||||||
# Cannot send pong after transport is shutting down
|
# Cannot send pong after transport is shutting down
|
||||||
return
|
return
|
||||||
if isinstance(data, str):
|
if isinstance(data, str):
|
||||||
data = data.encode("utf-8")
|
data = data.encode("utf-8")
|
||||||
elif isinstance(data, (bytearray, memoryview)):
|
elif isinstance(data, (bytearray, memoryview)):
|
||||||
data = bytes(data)
|
data = bytes(data)
|
||||||
self.ws_proto.send_pong(data)
|
self.connection.send_pong(data)
|
||||||
await self.send_data(self.ws_proto.data_to_send())
|
await self.send_data(self.connection.data_to_send())
|
||||||
|
|
||||||
async def send_data(self, data_to_send):
|
async def send_data(self, data_to_send):
|
||||||
for data in data_to_send:
|
for data in data_to_send:
|
||||||
@@ -805,7 +780,7 @@ class WebsocketImplProtocol:
|
|||||||
SanicProtocol.close(self.io_proto, timeout=1.0)
|
SanicProtocol.close(self.io_proto, timeout=1.0)
|
||||||
|
|
||||||
async def async_data_received(self, data_to_send, events_to_process):
|
async def async_data_received(self, data_to_send, events_to_process):
|
||||||
if self.ws_proto.state in (OPEN, CLOSING) and len(data_to_send) > 0:
|
if self.connection.state in (OPEN, CLOSING) and len(data_to_send) > 0:
|
||||||
# receiving data can generate data to send (eg, pong for a ping)
|
# receiving data can generate data to send (eg, pong for a ping)
|
||||||
# send connection.data_to_send()
|
# send connection.data_to_send()
|
||||||
await self.send_data(data_to_send)
|
await self.send_data(data_to_send)
|
||||||
@@ -813,9 +788,9 @@ class WebsocketImplProtocol:
|
|||||||
await self.process_events(events_to_process)
|
await self.process_events(events_to_process)
|
||||||
|
|
||||||
def data_received(self, data):
|
def data_received(self, data):
|
||||||
self.ws_proto.receive_data(data)
|
self.connection.receive_data(data)
|
||||||
data_to_send = self.ws_proto.data_to_send()
|
data_to_send = self.connection.data_to_send()
|
||||||
events_to_process = self.ws_proto.events_received()
|
events_to_process = self.connection.events_received()
|
||||||
if len(data_to_send) > 0 or len(events_to_process) > 0:
|
if len(data_to_send) > 0 or len(events_to_process) > 0:
|
||||||
asyncio.create_task(
|
asyncio.create_task(
|
||||||
self.async_data_received(data_to_send, events_to_process)
|
self.async_data_received(data_to_send, events_to_process)
|
||||||
@@ -824,7 +799,7 @@ class WebsocketImplProtocol:
|
|||||||
async def async_eof_received(self, data_to_send, events_to_process):
|
async def async_eof_received(self, data_to_send, events_to_process):
|
||||||
# receiving EOF can generate data to send
|
# receiving EOF can generate data to send
|
||||||
# send connection.data_to_send()
|
# send connection.data_to_send()
|
||||||
if self.ws_proto.state in (OPEN, CLOSING) and len(data_to_send) > 0:
|
if self.connection.state in (OPEN, CLOSING) and len(data_to_send) > 0:
|
||||||
await self.send_data(data_to_send)
|
await self.send_data(data_to_send)
|
||||||
if len(events_to_process) > 0:
|
if len(events_to_process) > 0:
|
||||||
await self.process_events(events_to_process)
|
await self.process_events(events_to_process)
|
||||||
@@ -844,9 +819,9 @@ class WebsocketImplProtocol:
|
|||||||
SanicProtocol.close(self.io_proto, timeout=1.0)
|
SanicProtocol.close(self.io_proto, timeout=1.0)
|
||||||
|
|
||||||
def eof_received(self) -> Optional[bool]:
|
def eof_received(self) -> Optional[bool]:
|
||||||
self.ws_proto.receive_eof()
|
self.connection.receive_eof()
|
||||||
data_to_send = self.ws_proto.data_to_send()
|
data_to_send = self.connection.data_to_send()
|
||||||
events_to_process = self.ws_proto.events_received()
|
events_to_process = self.connection.events_received()
|
||||||
asyncio.create_task(
|
asyncio.create_task(
|
||||||
self.async_eof_received(data_to_send, events_to_process)
|
self.async_eof_received(data_to_send, events_to_process)
|
||||||
)
|
)
|
||||||
@@ -856,19 +831,12 @@ class WebsocketImplProtocol:
|
|||||||
"""
|
"""
|
||||||
The WebSocket Connection is Closed.
|
The WebSocket Connection is Closed.
|
||||||
"""
|
"""
|
||||||
if not self.ws_proto.state == CLOSED:
|
if not self.connection.state == CLOSED:
|
||||||
# signal to the websocket connection handler
|
# signal to the websocket connection handler
|
||||||
# we've lost the connection
|
# we've lost the connection
|
||||||
self.ws_proto.fail(code=1006)
|
self.connection.fail(code=1006)
|
||||||
self.ws_proto.state = CLOSED
|
self.connection.state = CLOSED
|
||||||
|
|
||||||
self.abort_pings()
|
self.abort_pings()
|
||||||
if self.connection_lost_waiter:
|
if self.connection_lost_waiter:
|
||||||
self.connection_lost_waiter.set_result(None)
|
self.connection_lost_waiter.set_result(None)
|
||||||
|
|
||||||
async def __aiter__(self):
|
|
||||||
try:
|
|
||||||
while True:
|
|
||||||
yield await self.recv()
|
|
||||||
except ConnectionClosedOK:
|
|
||||||
return
|
|
||||||
|
|||||||
@@ -44,9 +44,7 @@ class SharedContext(SimpleNamespace):
|
|||||||
f"{Colors.YELLOW}with type {Colors.PURPLE}{type(value)} "
|
f"{Colors.YELLOW}with type {Colors.PURPLE}{type(value)} "
|
||||||
f"{Colors.YELLOW}was added to shared_ctx. It may not "
|
f"{Colors.YELLOW}was added to shared_ctx. It may not "
|
||||||
"not function as intended. Consider using the regular "
|
"not function as intended. Consider using the regular "
|
||||||
f"ctx.\nFor more information, please see https://sanic.dev/en"
|
f"ctx. For more information, please see ____.{Colors.END}"
|
||||||
"/guide/deployment/manager.html#using-shared-context-between-"
|
|
||||||
f"worker-processes.{Colors.END}"
|
|
||||||
)
|
)
|
||||||
|
|
||||||
@property
|
@property
|
||||||
|
|||||||
@@ -73,7 +73,7 @@ class Inspector:
|
|||||||
|
|
||||||
def state_to_json(self):
|
def state_to_json(self):
|
||||||
output = {"info": self.app_info}
|
output = {"info": self.app_info}
|
||||||
output["workers"] = self.make_safe(dict(self.worker_state))
|
output["workers"] = self._make_safe(dict(self.worker_state))
|
||||||
return output
|
return output
|
||||||
|
|
||||||
def reload(self):
|
def reload(self):
|
||||||
@@ -84,11 +84,10 @@ class Inspector:
|
|||||||
message = "__TERMINATE__"
|
message = "__TERMINATE__"
|
||||||
self._publisher.send(message)
|
self._publisher.send(message)
|
||||||
|
|
||||||
@staticmethod
|
def _make_safe(self, obj: Dict[str, Any]) -> Dict[str, Any]:
|
||||||
def make_safe(obj: Dict[str, Any]) -> Dict[str, Any]:
|
|
||||||
for key, value in obj.items():
|
for key, value in obj.items():
|
||||||
if isinstance(value, dict):
|
if isinstance(value, dict):
|
||||||
obj[key] = Inspector.make_safe(value)
|
obj[key] = self._make_safe(value)
|
||||||
elif isinstance(value, datetime):
|
elif isinstance(value, datetime):
|
||||||
obj[key] = value.isoformat()
|
obj[key] = value.isoformat()
|
||||||
return obj
|
return obj
|
||||||
|
|||||||
@@ -5,10 +5,18 @@ import sys
|
|||||||
|
|
||||||
from importlib import import_module
|
from importlib import import_module
|
||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
from typing import TYPE_CHECKING, Any, Callable, Dict, Optional, Union, cast
|
from typing import (
|
||||||
|
TYPE_CHECKING,
|
||||||
|
Any,
|
||||||
|
Callable,
|
||||||
|
Dict,
|
||||||
|
Optional,
|
||||||
|
Type,
|
||||||
|
Union,
|
||||||
|
cast,
|
||||||
|
)
|
||||||
|
|
||||||
from sanic.http.tls.context import process_to_context
|
from sanic.http.tls.creators import CertCreator, MkcertCreator, TrustmeCreator
|
||||||
from sanic.http.tls.creators import MkcertCreator, TrustmeCreator
|
|
||||||
|
|
||||||
|
|
||||||
if TYPE_CHECKING:
|
if TYPE_CHECKING:
|
||||||
@@ -98,30 +106,21 @@ class AppLoader:
|
|||||||
|
|
||||||
|
|
||||||
class CertLoader:
|
class CertLoader:
|
||||||
_creators = {
|
_creator_class: Type[CertCreator]
|
||||||
"mkcert": MkcertCreator,
|
|
||||||
"trustme": TrustmeCreator,
|
|
||||||
}
|
|
||||||
|
|
||||||
def __init__(self, ssl_data: Dict[str, Union[str, os.PathLike]]):
|
def __init__(self, ssl_data: Dict[str, Union[str, os.PathLike]]):
|
||||||
self._ssl_data = ssl_data
|
creator_name = ssl_data.get("creator")
|
||||||
|
if creator_name not in ("mkcert", "trustme"):
|
||||||
creator_name = cast(str, ssl_data.get("creator"))
|
|
||||||
|
|
||||||
self._creator_class = self._creators.get(creator_name)
|
|
||||||
if not creator_name:
|
|
||||||
return
|
|
||||||
|
|
||||||
if not self._creator_class:
|
|
||||||
raise RuntimeError(f"Unknown certificate creator: {creator_name}")
|
raise RuntimeError(f"Unknown certificate creator: {creator_name}")
|
||||||
|
elif creator_name == "mkcert":
|
||||||
|
self._creator_class = MkcertCreator
|
||||||
|
elif creator_name == "trustme":
|
||||||
|
self._creator_class = TrustmeCreator
|
||||||
|
|
||||||
self._key = ssl_data["key"]
|
self._key = ssl_data["key"]
|
||||||
self._cert = ssl_data["cert"]
|
self._cert = ssl_data["cert"]
|
||||||
self._localhost = cast(str, ssl_data["localhost"])
|
self._localhost = cast(str, ssl_data["localhost"])
|
||||||
|
|
||||||
def load(self, app: SanicApp):
|
def load(self, app: SanicApp):
|
||||||
if not self._creator_class:
|
|
||||||
return process_to_context(self._ssl_data)
|
|
||||||
|
|
||||||
creator = self._creator_class(app, self._key, self._cert)
|
creator = self._creator_class(app, self._key, self._cert)
|
||||||
return creator.generate_cert(self._localhost)
|
return creator.generate_cert(self._localhost)
|
||||||
|
|||||||
@@ -1,12 +1,12 @@
|
|||||||
import os
|
import os
|
||||||
|
import sys
|
||||||
|
|
||||||
from signal import SIGINT, SIGTERM, Signals
|
from signal import SIGINT, SIGTERM, Signals
|
||||||
from signal import signal as signal_func
|
from signal import signal as signal_func
|
||||||
|
from time import sleep
|
||||||
from typing import List, Optional
|
from typing import List, Optional
|
||||||
|
|
||||||
from sanic.compat import OS_IS_WINDOWS
|
from sanic.compat import OS_IS_WINDOWS
|
||||||
from sanic.constants import RestartOrder
|
|
||||||
from sanic.exceptions import ServerKilled
|
|
||||||
from sanic.log import error_logger, logger
|
from sanic.log import error_logger, logger
|
||||||
from sanic.worker.process import ProcessState, Worker, WorkerProcess
|
from sanic.worker.process import ProcessState, Worker, WorkerProcess
|
||||||
|
|
||||||
@@ -18,8 +18,7 @@ else:
|
|||||||
|
|
||||||
|
|
||||||
class WorkerManager:
|
class WorkerManager:
|
||||||
THRESHOLD = 300 # == 30 seconds
|
THRESHOLD = 50
|
||||||
MAIN_IDENT = "Sanic-Main"
|
|
||||||
|
|
||||||
def __init__(
|
def __init__(
|
||||||
self,
|
self,
|
||||||
@@ -29,7 +28,6 @@ class WorkerManager:
|
|||||||
context,
|
context,
|
||||||
monitor_pubsub,
|
monitor_pubsub,
|
||||||
worker_state,
|
worker_state,
|
||||||
restart_order: RestartOrder = RestartOrder.SHUTDOWN_FIRST,
|
|
||||||
):
|
):
|
||||||
self.num_server = number
|
self.num_server = number
|
||||||
self.context = context
|
self.context = context
|
||||||
@@ -37,9 +35,8 @@ class WorkerManager:
|
|||||||
self.durable: List[Worker] = []
|
self.durable: List[Worker] = []
|
||||||
self.monitor_publisher, self.monitor_subscriber = monitor_pubsub
|
self.monitor_publisher, self.monitor_subscriber = monitor_pubsub
|
||||||
self.worker_state = worker_state
|
self.worker_state = worker_state
|
||||||
self.worker_state[self.MAIN_IDENT] = {"pid": self.pid}
|
self.worker_state["Sanic-Main"] = {"pid": self.pid}
|
||||||
self.terminated = False
|
self.terminated = False
|
||||||
self.restart_order = restart_order
|
|
||||||
|
|
||||||
if number == 0:
|
if number == 0:
|
||||||
raise RuntimeError("Cannot serve with no workers")
|
raise RuntimeError("Cannot serve with no workers")
|
||||||
@@ -58,14 +55,7 @@ class WorkerManager:
|
|||||||
def manage(self, ident, func, kwargs, transient=False):
|
def manage(self, ident, func, kwargs, transient=False):
|
||||||
container = self.transient if transient else self.durable
|
container = self.transient if transient else self.durable
|
||||||
container.append(
|
container.append(
|
||||||
Worker(
|
Worker(ident, func, kwargs, self.context, self.worker_state)
|
||||||
ident,
|
|
||||||
func,
|
|
||||||
kwargs,
|
|
||||||
self.context,
|
|
||||||
self.worker_state,
|
|
||||||
self.restart_order,
|
|
||||||
)
|
|
||||||
)
|
)
|
||||||
|
|
||||||
def run(self):
|
def run(self):
|
||||||
@@ -133,50 +123,20 @@ class WorkerManager:
|
|||||||
process_names=process_names,
|
process_names=process_names,
|
||||||
reloaded_files=reloaded_files,
|
reloaded_files=reloaded_files,
|
||||||
)
|
)
|
||||||
self._sync_states()
|
|
||||||
except InterruptedError:
|
except InterruptedError:
|
||||||
if not OS_IS_WINDOWS:
|
if not OS_IS_WINDOWS:
|
||||||
raise
|
raise
|
||||||
break
|
break
|
||||||
|
|
||||||
def _sync_states(self):
|
|
||||||
for process in self.processes:
|
|
||||||
state = self.worker_state[process.name].get("state")
|
|
||||||
if state and process.state.name != state:
|
|
||||||
process.set_state(ProcessState[state], True)
|
|
||||||
|
|
||||||
def wait_for_ack(self): # no cov
|
def wait_for_ack(self): # no cov
|
||||||
misses = 0
|
misses = 0
|
||||||
message = (
|
|
||||||
"It seems that one or more of your workers failed to come "
|
|
||||||
"online in the allowed time. Sanic is shutting down to avoid a "
|
|
||||||
f"deadlock. The current threshold is {self.THRESHOLD / 10}s. "
|
|
||||||
"If this problem persists, please check out the documentation "
|
|
||||||
"___."
|
|
||||||
)
|
|
||||||
while not self._all_workers_ack():
|
while not self._all_workers_ack():
|
||||||
if self.monitor_subscriber.poll(0.1):
|
sleep(0.1)
|
||||||
monitor_msg = self.monitor_subscriber.recv()
|
|
||||||
if monitor_msg != "__TERMINATE_EARLY__":
|
|
||||||
self.monitor_publisher.send(monitor_msg)
|
|
||||||
continue
|
|
||||||
misses = self.THRESHOLD
|
|
||||||
message = (
|
|
||||||
"One of your worker processes terminated before startup "
|
|
||||||
"was completed. Please solve any errors experienced "
|
|
||||||
"during startup. If you do not see an exception traceback "
|
|
||||||
"in your error logs, try running Sanic in in a single "
|
|
||||||
"process using --single-process or single_process=True. "
|
|
||||||
"Once you are confident that the server is able to start "
|
|
||||||
"without errors you can switch back to multiprocess mode."
|
|
||||||
)
|
|
||||||
misses += 1
|
misses += 1
|
||||||
if misses > self.THRESHOLD:
|
if misses > self.THRESHOLD:
|
||||||
error_logger.error(
|
error_logger.error("Not all workers are ack. Shutting down.")
|
||||||
"Not all workers acknowledged a successful startup. "
|
|
||||||
"Shutting down.\n\n" + message
|
|
||||||
)
|
|
||||||
self.kill()
|
self.kill()
|
||||||
|
sys.exit(1)
|
||||||
|
|
||||||
@property
|
@property
|
||||||
def workers(self):
|
def workers(self):
|
||||||
@@ -196,9 +156,7 @@ class WorkerManager:
|
|||||||
|
|
||||||
def kill(self):
|
def kill(self):
|
||||||
for process in self.processes:
|
for process in self.processes:
|
||||||
logger.info("Killing %s [%s]", process.name, process.pid)
|
|
||||||
os.kill(process.pid, SIGKILL)
|
os.kill(process.pid, SIGKILL)
|
||||||
raise ServerKilled
|
|
||||||
|
|
||||||
def shutdown_signal(self, signal, frame):
|
def shutdown_signal(self, signal, frame):
|
||||||
logger.info("Received signal %s. Shutting down.", Signals(signal).name)
|
logger.info("Received signal %s. Shutting down.", Signals(signal).name)
|
||||||
|
|||||||
@@ -21,21 +21,15 @@ class WorkerMultiplexer:
|
|||||||
"state": ProcessState.ACKED.name,
|
"state": ProcessState.ACKED.name,
|
||||||
}
|
}
|
||||||
|
|
||||||
def restart(self, name: str = "", all_workers: bool = False):
|
def restart(self, name: str = ""):
|
||||||
if name and all_workers:
|
|
||||||
raise ValueError(
|
|
||||||
"Ambiguous restart with both a named process and"
|
|
||||||
" all_workers=True"
|
|
||||||
)
|
|
||||||
if not name:
|
if not name:
|
||||||
name = "__ALL_PROCESSES__:" if all_workers else self.name
|
name = self.name
|
||||||
self._monitor_publisher.send(name)
|
self._monitor_publisher.send(name)
|
||||||
|
|
||||||
reload = restart # no cov
|
reload = restart # no cov
|
||||||
|
|
||||||
def terminate(self, early: bool = False):
|
def terminate(self):
|
||||||
message = "__TERMINATE_EARLY__" if early else "__TERMINATE__"
|
self._monitor_publisher.send("__TERMINATE__")
|
||||||
self._monitor_publisher.send(message)
|
|
||||||
|
|
||||||
@property
|
@property
|
||||||
def pid(self) -> int:
|
def pid(self) -> int:
|
||||||
|
|||||||
@@ -4,10 +4,8 @@ from datetime import datetime, timezone
|
|||||||
from enum import IntEnum, auto
|
from enum import IntEnum, auto
|
||||||
from multiprocessing.context import BaseContext
|
from multiprocessing.context import BaseContext
|
||||||
from signal import SIGINT
|
from signal import SIGINT
|
||||||
from threading import Thread
|
|
||||||
from typing import Any, Dict, Set
|
from typing import Any, Dict, Set
|
||||||
|
|
||||||
from sanic.constants import RestartOrder
|
|
||||||
from sanic.log import Colors, logger
|
from sanic.log import Colors, logger
|
||||||
|
|
||||||
|
|
||||||
@@ -18,8 +16,6 @@ def get_now():
|
|||||||
|
|
||||||
class ProcessState(IntEnum):
|
class ProcessState(IntEnum):
|
||||||
IDLE = auto()
|
IDLE = auto()
|
||||||
RESTARTING = auto()
|
|
||||||
STARTING = auto()
|
|
||||||
STARTED = auto()
|
STARTED = auto()
|
||||||
ACKED = auto()
|
ACKED = auto()
|
||||||
JOINED = auto()
|
JOINED = auto()
|
||||||
@@ -29,22 +25,13 @@ class ProcessState(IntEnum):
|
|||||||
class WorkerProcess:
|
class WorkerProcess:
|
||||||
SERVER_LABEL = "Server"
|
SERVER_LABEL = "Server"
|
||||||
|
|
||||||
def __init__(
|
def __init__(self, factory, name, target, kwargs, worker_state):
|
||||||
self,
|
|
||||||
factory,
|
|
||||||
name,
|
|
||||||
target,
|
|
||||||
kwargs,
|
|
||||||
worker_state,
|
|
||||||
restart_order: RestartOrder,
|
|
||||||
):
|
|
||||||
self.state = ProcessState.IDLE
|
self.state = ProcessState.IDLE
|
||||||
self.factory = factory
|
self.factory = factory
|
||||||
self.name = name
|
self.name = name
|
||||||
self.target = target
|
self.target = target
|
||||||
self.kwargs = kwargs
|
self.kwargs = kwargs
|
||||||
self.worker_state = worker_state
|
self.worker_state = worker_state
|
||||||
self.restart_order = restart_order
|
|
||||||
if self.name not in self.worker_state:
|
if self.name not in self.worker_state:
|
||||||
self.worker_state[self.name] = {
|
self.worker_state[self.name] = {
|
||||||
"server": self.SERVER_LABEL in self.name
|
"server": self.SERVER_LABEL in self.name
|
||||||
@@ -67,9 +54,8 @@ class WorkerProcess:
|
|||||||
f"{Colors.SANIC}%s{Colors.END}",
|
f"{Colors.SANIC}%s{Colors.END}",
|
||||||
self.name,
|
self.name,
|
||||||
)
|
)
|
||||||
self.set_state(ProcessState.STARTING)
|
|
||||||
self._current_process.start()
|
|
||||||
self.set_state(ProcessState.STARTED)
|
self.set_state(ProcessState.STARTED)
|
||||||
|
self._process.start()
|
||||||
if not self.worker_state[self.name].get("starts"):
|
if not self.worker_state[self.name].get("starts"):
|
||||||
self.worker_state[self.name] = {
|
self.worker_state[self.name] = {
|
||||||
**self.worker_state[self.name],
|
**self.worker_state[self.name],
|
||||||
@@ -81,7 +67,7 @@ class WorkerProcess:
|
|||||||
|
|
||||||
def join(self):
|
def join(self):
|
||||||
self.set_state(ProcessState.JOINED)
|
self.set_state(ProcessState.JOINED)
|
||||||
self._current_process.join()
|
self._process.join()
|
||||||
|
|
||||||
def terminate(self):
|
def terminate(self):
|
||||||
if self.state is not ProcessState.TERMINATED:
|
if self.state is not ProcessState.TERMINATED:
|
||||||
@@ -94,6 +80,7 @@ class WorkerProcess:
|
|||||||
)
|
)
|
||||||
self.set_state(ProcessState.TERMINATED, force=True)
|
self.set_state(ProcessState.TERMINATED, force=True)
|
||||||
try:
|
try:
|
||||||
|
# self._process.terminate()
|
||||||
os.kill(self.pid, SIGINT)
|
os.kill(self.pid, SIGINT)
|
||||||
del self.worker_state[self.name]
|
del self.worker_state[self.name]
|
||||||
except (KeyError, AttributeError, ProcessLookupError):
|
except (KeyError, AttributeError, ProcessLookupError):
|
||||||
@@ -106,11 +93,8 @@ class WorkerProcess:
|
|||||||
self.name,
|
self.name,
|
||||||
self.pid,
|
self.pid,
|
||||||
)
|
)
|
||||||
self.set_state(ProcessState.RESTARTING, force=True)
|
self._process.terminate()
|
||||||
if self.restart_order is RestartOrder.SHUTDOWN_FIRST:
|
self.set_state(ProcessState.IDLE, force=True)
|
||||||
self._terminate_now()
|
|
||||||
else:
|
|
||||||
self._old_process = self._current_process
|
|
||||||
self.kwargs.update(
|
self.kwargs.update(
|
||||||
{"config": {k.upper(): v for k, v in kwargs.items()}}
|
{"config": {k.upper(): v for k, v in kwargs.items()}}
|
||||||
)
|
)
|
||||||
@@ -120,9 +104,6 @@ class WorkerProcess:
|
|||||||
except AttributeError:
|
except AttributeError:
|
||||||
raise RuntimeError("Restart failed")
|
raise RuntimeError("Restart failed")
|
||||||
|
|
||||||
if self.restart_order is RestartOrder.STARTUP_FIRST:
|
|
||||||
self._terminate_soon()
|
|
||||||
|
|
||||||
self.worker_state[self.name] = {
|
self.worker_state[self.name] = {
|
||||||
**self.worker_state[self.name],
|
**self.worker_state[self.name],
|
||||||
"pid": self.pid,
|
"pid": self.pid,
|
||||||
@@ -130,59 +111,16 @@ class WorkerProcess:
|
|||||||
"restart_at": get_now(),
|
"restart_at": get_now(),
|
||||||
}
|
}
|
||||||
|
|
||||||
def _terminate_now(self):
|
|
||||||
logger.debug(
|
|
||||||
f"{Colors.BLUE}Begin restart termination: "
|
|
||||||
f"{Colors.BOLD}{Colors.SANIC}"
|
|
||||||
f"%s {Colors.BLUE}[%s]{Colors.END}",
|
|
||||||
self.name,
|
|
||||||
self._current_process.pid,
|
|
||||||
)
|
|
||||||
self._current_process.terminate()
|
|
||||||
|
|
||||||
def _terminate_soon(self):
|
|
||||||
logger.debug(
|
|
||||||
f"{Colors.BLUE}Begin restart termination: "
|
|
||||||
f"{Colors.BOLD}{Colors.SANIC}"
|
|
||||||
f"%s {Colors.BLUE}[%s]{Colors.END}",
|
|
||||||
self.name,
|
|
||||||
self._current_process.pid,
|
|
||||||
)
|
|
||||||
termination_thread = Thread(target=self._wait_to_terminate)
|
|
||||||
termination_thread.start()
|
|
||||||
|
|
||||||
def _wait_to_terminate(self):
|
|
||||||
logger.debug(
|
|
||||||
f"{Colors.BLUE}Waiting for process to be acked: "
|
|
||||||
f"{Colors.BOLD}{Colors.SANIC}"
|
|
||||||
f"%s {Colors.BLUE}[%s]{Colors.END}",
|
|
||||||
self.name,
|
|
||||||
self._old_process.pid,
|
|
||||||
)
|
|
||||||
# TODO: Add a timeout?
|
|
||||||
while self.state is not ProcessState.ACKED:
|
|
||||||
...
|
|
||||||
else:
|
|
||||||
logger.debug(
|
|
||||||
f"{Colors.BLUE}Process acked. Terminating: "
|
|
||||||
f"{Colors.BOLD}{Colors.SANIC}"
|
|
||||||
f"%s {Colors.BLUE}[%s]{Colors.END}",
|
|
||||||
self.name,
|
|
||||||
self._old_process.pid,
|
|
||||||
)
|
|
||||||
self._old_process.terminate()
|
|
||||||
delattr(self, "_old_process")
|
|
||||||
|
|
||||||
def is_alive(self):
|
def is_alive(self):
|
||||||
try:
|
try:
|
||||||
return self._current_process.is_alive()
|
return self._process.is_alive()
|
||||||
except AssertionError:
|
except AssertionError:
|
||||||
return False
|
return False
|
||||||
|
|
||||||
def spawn(self):
|
def spawn(self):
|
||||||
if self.state not in (ProcessState.IDLE, ProcessState.RESTARTING):
|
if self.state is not ProcessState.IDLE:
|
||||||
raise Exception("Cannot spawn a worker process until it is idle.")
|
raise Exception("Cannot spawn a worker process until it is idle.")
|
||||||
self._current_process = self.factory(
|
self._process = self.factory(
|
||||||
name=self.name,
|
name=self.name,
|
||||||
target=self.target,
|
target=self.target,
|
||||||
kwargs=self.kwargs,
|
kwargs=self.kwargs,
|
||||||
@@ -191,12 +129,10 @@ class WorkerProcess:
|
|||||||
|
|
||||||
@property
|
@property
|
||||||
def pid(self):
|
def pid(self):
|
||||||
return self._current_process.pid
|
return self._process.pid
|
||||||
|
|
||||||
|
|
||||||
class Worker:
|
class Worker:
|
||||||
WORKER_PREFIX = "Sanic-"
|
|
||||||
|
|
||||||
def __init__(
|
def __init__(
|
||||||
self,
|
self,
|
||||||
ident: str,
|
ident: str,
|
||||||
@@ -204,25 +140,22 @@ class Worker:
|
|||||||
server_settings,
|
server_settings,
|
||||||
context: BaseContext,
|
context: BaseContext,
|
||||||
worker_state: Dict[str, Any],
|
worker_state: Dict[str, Any],
|
||||||
restart_order: RestartOrder,
|
|
||||||
):
|
):
|
||||||
self.ident = f"{self.WORKER_PREFIX}{ident}"
|
self.ident = ident
|
||||||
self.context = context
|
self.context = context
|
||||||
self.serve = serve
|
self.serve = serve
|
||||||
self.server_settings = server_settings
|
self.server_settings = server_settings
|
||||||
self.worker_state = worker_state
|
self.worker_state = worker_state
|
||||||
self.processes: Set[WorkerProcess] = set()
|
self.processes: Set[WorkerProcess] = set()
|
||||||
self.restart_order = restart_order
|
|
||||||
self.create_process()
|
self.create_process()
|
||||||
|
|
||||||
def create_process(self) -> WorkerProcess:
|
def create_process(self) -> WorkerProcess:
|
||||||
process = WorkerProcess(
|
process = WorkerProcess(
|
||||||
factory=self.context.Process,
|
factory=self.context.Process,
|
||||||
name=f"{self.ident}-{len(self.processes)}",
|
name=f"Sanic-{self.ident}-{len(self.processes)}",
|
||||||
target=self.serve,
|
target=self.serve,
|
||||||
kwargs={**self.server_settings},
|
kwargs={**self.server_settings},
|
||||||
worker_state=self.worker_state,
|
worker_state=self.worker_state,
|
||||||
restart_order=self.restart_order,
|
|
||||||
)
|
)
|
||||||
self.processes.add(process)
|
self.processes.add(process)
|
||||||
return process
|
return process
|
||||||
|
|||||||
@@ -9,7 +9,6 @@ from multiprocessing.connection import Connection
|
|||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
from signal import SIGINT, SIGTERM
|
from signal import SIGINT, SIGTERM
|
||||||
from signal import signal as signal_func
|
from signal import signal as signal_func
|
||||||
from time import sleep
|
|
||||||
from typing import Dict, Set
|
from typing import Dict, Set
|
||||||
|
|
||||||
from sanic.server.events import trigger_events
|
from sanic.server.events import trigger_events
|
||||||
@@ -63,7 +62,6 @@ class Reloader:
|
|||||||
self.reload(",".join(changed) if changed else "unknown")
|
self.reload(",".join(changed) if changed else "unknown")
|
||||||
if after_trigger:
|
if after_trigger:
|
||||||
trigger_events(after_trigger, loop, app)
|
trigger_events(after_trigger, loop, app)
|
||||||
sleep(self.interval)
|
|
||||||
else:
|
else:
|
||||||
if reloader_stop:
|
if reloader_stop:
|
||||||
trigger_events(reloader_stop, loop, app)
|
trigger_events(reloader_stop, loop, app)
|
||||||
|
|||||||
@@ -1,7 +1,6 @@
|
|||||||
import asyncio
|
import asyncio
|
||||||
import os
|
import os
|
||||||
import socket
|
import socket
|
||||||
import warnings
|
|
||||||
|
|
||||||
from functools import partial
|
from functools import partial
|
||||||
from multiprocessing.connection import Connection
|
from multiprocessing.connection import Connection
|
||||||
@@ -11,7 +10,6 @@ from typing import Any, Dict, List, Optional, Type, Union
|
|||||||
from sanic.application.constants import ServerStage
|
from sanic.application.constants import ServerStage
|
||||||
from sanic.application.state import ApplicationServerInfo
|
from sanic.application.state import ApplicationServerInfo
|
||||||
from sanic.http.constants import HTTP
|
from sanic.http.constants import HTTP
|
||||||
from sanic.log import error_logger
|
|
||||||
from sanic.models.server_types import Signal
|
from sanic.models.server_types import Signal
|
||||||
from sanic.server.protocols.http_protocol import HttpProtocol
|
from sanic.server.protocols.http_protocol import HttpProtocol
|
||||||
from sanic.server.runners import _serve_http_1, _serve_http_3
|
from sanic.server.runners import _serve_http_1, _serve_http_3
|
||||||
@@ -47,7 +45,6 @@ def worker_serve(
|
|||||||
config=None,
|
config=None,
|
||||||
passthru: Optional[Dict[str, Any]] = None,
|
passthru: Optional[Dict[str, Any]] = None,
|
||||||
):
|
):
|
||||||
try:
|
|
||||||
from sanic import Sanic
|
from sanic import Sanic
|
||||||
|
|
||||||
if app_loader:
|
if app_loader:
|
||||||
@@ -83,9 +80,7 @@ def worker_serve(
|
|||||||
# Hydrate apps with any passed server info
|
# Hydrate apps with any passed server info
|
||||||
|
|
||||||
if monitor_publisher is None:
|
if monitor_publisher is None:
|
||||||
raise RuntimeError(
|
raise RuntimeError("No restart publisher found in worker process")
|
||||||
"No restart publisher found in worker process"
|
|
||||||
)
|
|
||||||
if worker_state is None:
|
if worker_state is None:
|
||||||
raise RuntimeError("No worker state found in worker process")
|
raise RuntimeError("No worker state found in worker process")
|
||||||
|
|
||||||
@@ -93,9 +88,7 @@ def worker_serve(
|
|||||||
apps = list(Sanic._app_registry.values())
|
apps = list(Sanic._app_registry.values())
|
||||||
app.before_server_start(partial(app._start_servers, apps=apps))
|
app.before_server_start(partial(app._start_servers, apps=apps))
|
||||||
for a in apps:
|
for a in apps:
|
||||||
a.multiplexer = WorkerMultiplexer(
|
a.multiplexer = WorkerMultiplexer(monitor_publisher, worker_state)
|
||||||
monitor_publisher, worker_state
|
|
||||||
)
|
|
||||||
|
|
||||||
if app.debug:
|
if app.debug:
|
||||||
loop.set_debug(app.debug)
|
loop.set_debug(app.debug)
|
||||||
@@ -129,11 +122,3 @@ def worker_serve(
|
|||||||
state,
|
state,
|
||||||
asyncio_server_kwargs,
|
asyncio_server_kwargs,
|
||||||
)
|
)
|
||||||
except Exception as e:
|
|
||||||
warnings.simplefilter("ignore", category=RuntimeWarning)
|
|
||||||
if monitor_publisher:
|
|
||||||
error_logger.exception(e)
|
|
||||||
multiplexer = WorkerMultiplexer(monitor_publisher, {})
|
|
||||||
multiplexer.terminate(True)
|
|
||||||
else:
|
|
||||||
raise e
|
|
||||||
|
|||||||
6
setup.py
6
setup.py
@@ -81,7 +81,7 @@ env_dependency = (
|
|||||||
'; sys_platform != "win32" ' 'and implementation_name == "cpython"'
|
'; sys_platform != "win32" ' 'and implementation_name == "cpython"'
|
||||||
)
|
)
|
||||||
ujson = "ujson>=1.35" + env_dependency
|
ujson = "ujson>=1.35" + env_dependency
|
||||||
uvloop = "uvloop>=0.15.0" + env_dependency
|
uvloop = "uvloop>=0.5.3" + env_dependency
|
||||||
types_ujson = "types-ujson" + env_dependency
|
types_ujson = "types-ujson" + env_dependency
|
||||||
requirements = [
|
requirements = [
|
||||||
"sanic-routing>=22.8.0",
|
"sanic-routing>=22.8.0",
|
||||||
@@ -94,8 +94,8 @@ requirements = [
|
|||||||
]
|
]
|
||||||
|
|
||||||
tests_require = [
|
tests_require = [
|
||||||
"sanic-testing>=22.9.0",
|
"sanic-testing>=22.9.0b1",
|
||||||
"pytest==7.1.*",
|
"pytest",
|
||||||
"coverage",
|
"coverage",
|
||||||
"beautifulsoup4",
|
"beautifulsoup4",
|
||||||
"pytest-sanic",
|
"pytest-sanic",
|
||||||
|
|||||||
@@ -15,10 +15,9 @@ from sanic import Sanic
|
|||||||
from sanic.compat import OS_IS_WINDOWS
|
from sanic.compat import OS_IS_WINDOWS
|
||||||
from sanic.config import Config
|
from sanic.config import Config
|
||||||
from sanic.exceptions import SanicException
|
from sanic.exceptions import SanicException
|
||||||
from sanic.helpers import Default
|
from sanic.helpers import _default
|
||||||
from sanic.log import LOGGING_CONFIG_DEFAULTS
|
from sanic.log import LOGGING_CONFIG_DEFAULTS
|
||||||
from sanic.response import text
|
from sanic.response import text
|
||||||
from sanic.router import Route
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture(autouse=True)
|
@pytest.fixture(autouse=True)
|
||||||
@@ -153,13 +152,11 @@ def test_app_route_raise_value_error(app: Sanic):
|
|||||||
|
|
||||||
|
|
||||||
def test_app_handle_request_handler_is_none(app: Sanic, monkeypatch):
|
def test_app_handle_request_handler_is_none(app: Sanic, monkeypatch):
|
||||||
app.config.TOUCHUP = False
|
mock = Mock()
|
||||||
route = Mock(spec=Route)
|
mock.handler = None
|
||||||
route.extra.request_middleware = []
|
|
||||||
route.extra.response_middleware = []
|
|
||||||
|
|
||||||
def mockreturn(*args, **kwargs):
|
def mockreturn(*args, **kwargs):
|
||||||
return route, None, {}
|
return mock, None, {}
|
||||||
|
|
||||||
monkeypatch.setattr(app.router, "get", mockreturn)
|
monkeypatch.setattr(app.router, "get", mockreturn)
|
||||||
|
|
||||||
@@ -347,13 +344,7 @@ def test_app_registry_retrieval_from_multiple():
|
|||||||
|
|
||||||
def test_get_app_does_not_exist():
|
def test_get_app_does_not_exist():
|
||||||
with pytest.raises(
|
with pytest.raises(
|
||||||
SanicException,
|
SanicException, match='Sanic app name "does-not-exist" not found.'
|
||||||
match="Sanic app name 'does-not-exist' not found.\n"
|
|
||||||
"App instantiation must occur outside "
|
|
||||||
"if __name__ == '__main__' "
|
|
||||||
"block or by using an AppLoader.\nSee "
|
|
||||||
"https://sanic.dev/en/guide/deployment/app-loader.html"
|
|
||||||
" for more details.",
|
|
||||||
):
|
):
|
||||||
Sanic.get_app("does-not-exist")
|
Sanic.get_app("does-not-exist")
|
||||||
|
|
||||||
@@ -497,9 +488,7 @@ def test_uvloop_cannot_never_called_with_create_server(caplog, monkeypatch):
|
|||||||
)
|
)
|
||||||
|
|
||||||
counter = Counter([(r[1], r[2]) for r in caplog.record_tuples])
|
counter = Counter([(r[1], r[2]) for r in caplog.record_tuples])
|
||||||
modified = sum(
|
modified = sum(1 for app in apps if app.config.USE_UVLOOP is not _default)
|
||||||
1 for app in apps if not isinstance(app.config.USE_UVLOOP, Default)
|
|
||||||
)
|
|
||||||
|
|
||||||
assert counter[(logging.WARNING, message)] == modified
|
assert counter[(logging.WARNING, message)] == modified
|
||||||
|
|
||||||
@@ -533,7 +522,7 @@ def test_multiple_uvloop_configs_display_warning(caplog):
|
|||||||
|
|
||||||
counter = Counter([(r[1], r[2]) for r in caplog.record_tuples])
|
counter = Counter([(r[1], r[2]) for r in caplog.record_tuples])
|
||||||
|
|
||||||
assert counter[(logging.WARNING, message)] == 3
|
assert counter[(logging.WARNING, message)] == 2
|
||||||
|
|
||||||
|
|
||||||
def test_cannot_run_fast_and_workers(app: Sanic):
|
def test_cannot_run_fast_and_workers(app: Sanic):
|
||||||
|
|||||||
@@ -323,20 +323,3 @@ def test_bp_group_properties():
|
|||||||
assert "api/v1/grouped/bp2/" in routes
|
assert "api/v1/grouped/bp2/" in routes
|
||||||
assert "api/v1/primary/grouped/bp1" in routes
|
assert "api/v1/primary/grouped/bp1" in routes
|
||||||
assert "api/v1/primary/grouped/bp2" in routes
|
assert "api/v1/primary/grouped/bp2" in routes
|
||||||
|
|
||||||
|
|
||||||
def test_nested_bp_group_properties():
|
|
||||||
one = Blueprint("one", url_prefix="/one")
|
|
||||||
two = Blueprint.group(one)
|
|
||||||
three = Blueprint.group(two, url_prefix="/three")
|
|
||||||
|
|
||||||
@one.route("/four")
|
|
||||||
def handler(request):
|
|
||||||
return text("pi")
|
|
||||||
|
|
||||||
app = Sanic("PropTest")
|
|
||||||
app.blueprint(three)
|
|
||||||
app.router.finalize()
|
|
||||||
|
|
||||||
routes = [route.path for route in app.router.routes]
|
|
||||||
assert routes == ["three/one/four"]
|
|
||||||
|
|||||||
@@ -14,7 +14,7 @@ from pytest import MonkeyPatch
|
|||||||
|
|
||||||
from sanic import Sanic
|
from sanic import Sanic
|
||||||
from sanic.config import DEFAULT_CONFIG, Config
|
from sanic.config import DEFAULT_CONFIG, Config
|
||||||
from sanic.constants import LocalCertCreator, RestartOrder
|
from sanic.constants import LocalCertCreator
|
||||||
from sanic.exceptions import PyFileError
|
from sanic.exceptions import PyFileError
|
||||||
|
|
||||||
|
|
||||||
@@ -125,9 +125,14 @@ def test_env_w_custom_converter():
|
|||||||
|
|
||||||
|
|
||||||
def test_env_lowercase():
|
def test_env_lowercase():
|
||||||
|
with pytest.warns(None) as record:
|
||||||
environ["SANIC_test_answer"] = "42"
|
environ["SANIC_test_answer"] = "42"
|
||||||
app = Sanic(name="Test")
|
app = Sanic(name="Test")
|
||||||
assert "test_answer" not in app.config
|
assert app.config.test_answer == 42
|
||||||
|
assert str(record[0].message) == (
|
||||||
|
"[DEPRECATION v22.9] Lowercase environment variables will not be "
|
||||||
|
"loaded into Sanic config beginning in v22.9."
|
||||||
|
)
|
||||||
del environ["SANIC_test_answer"]
|
del environ["SANIC_test_answer"]
|
||||||
|
|
||||||
|
|
||||||
@@ -436,19 +441,3 @@ def test_convert_local_cert_creator(passed, expected):
|
|||||||
app = Sanic("Test")
|
app = Sanic("Test")
|
||||||
assert app.config.LOCAL_CERT_CREATOR is expected
|
assert app.config.LOCAL_CERT_CREATOR is expected
|
||||||
del os.environ["SANIC_LOCAL_CERT_CREATOR"]
|
del os.environ["SANIC_LOCAL_CERT_CREATOR"]
|
||||||
|
|
||||||
|
|
||||||
@pytest.mark.parametrize(
|
|
||||||
"passed,expected",
|
|
||||||
(
|
|
||||||
("shutdown_first", RestartOrder.SHUTDOWN_FIRST),
|
|
||||||
("startup_first", RestartOrder.STARTUP_FIRST),
|
|
||||||
("SHUTDOWN_FIRST", RestartOrder.SHUTDOWN_FIRST),
|
|
||||||
("STARTUP_FIRST", RestartOrder.STARTUP_FIRST),
|
|
||||||
),
|
|
||||||
)
|
|
||||||
def test_convert_restart_order(passed, expected):
|
|
||||||
os.environ["SANIC_RESTART_ORDER"] = passed
|
|
||||||
app = Sanic("Test")
|
|
||||||
assert app.config.RESTART_ORDER is expected
|
|
||||||
del os.environ["SANIC_RESTART_ORDER"]
|
|
||||||
|
|||||||
@@ -97,15 +97,15 @@ def test_auto_fallback_with_content_type(app):
|
|||||||
def test_route_error_format_set_on_auto(app):
|
def test_route_error_format_set_on_auto(app):
|
||||||
@app.get("/text")
|
@app.get("/text")
|
||||||
def text_response(request):
|
def text_response(request):
|
||||||
return text(request.route.extra.error_format)
|
return text(request.route.ctx.error_format)
|
||||||
|
|
||||||
@app.get("/json")
|
@app.get("/json")
|
||||||
def json_response(request):
|
def json_response(request):
|
||||||
return json({"format": request.route.extra.error_format})
|
return json({"format": request.route.ctx.error_format})
|
||||||
|
|
||||||
@app.get("/html")
|
@app.get("/html")
|
||||||
def html_response(request):
|
def html_response(request):
|
||||||
return html(request.route.extra.error_format)
|
return html(request.route.ctx.error_format)
|
||||||
|
|
||||||
_, response = app.test_client.get("/text")
|
_, response = app.test_client.get("/text")
|
||||||
assert response.text == "text"
|
assert response.text == "text"
|
||||||
|
|||||||
@@ -10,7 +10,7 @@ import pytest
|
|||||||
import sanic
|
import sanic
|
||||||
|
|
||||||
from sanic import Sanic
|
from sanic import Sanic
|
||||||
from sanic.log import LOGGING_CONFIG_DEFAULTS, Colors, logger
|
from sanic.log import LOGGING_CONFIG_DEFAULTS, logger
|
||||||
from sanic.response import text
|
from sanic.response import text
|
||||||
|
|
||||||
|
|
||||||
@@ -250,14 +250,3 @@ def test_verbosity(app, caplog, app_verbosity, log_verbosity, exists):
|
|||||||
|
|
||||||
if app_verbosity == 0:
|
if app_verbosity == 0:
|
||||||
assert ("sanic.root", logging.INFO, "DEFAULT") in caplog.record_tuples
|
assert ("sanic.root", logging.INFO, "DEFAULT") in caplog.record_tuples
|
||||||
|
|
||||||
|
|
||||||
def test_colors_enum_format():
|
|
||||||
assert f"{Colors.END}" == Colors.END.value
|
|
||||||
assert f"{Colors.BOLD}" == Colors.BOLD.value
|
|
||||||
assert f"{Colors.BLUE}" == Colors.BLUE.value
|
|
||||||
assert f"{Colors.GREEN}" == Colors.GREEN.value
|
|
||||||
assert f"{Colors.PURPLE}" == Colors.PURPLE.value
|
|
||||||
assert f"{Colors.RED}" == Colors.RED.value
|
|
||||||
assert f"{Colors.SANIC}" == Colors.SANIC.value
|
|
||||||
assert f"{Colors.YELLOW}" == Colors.YELLOW.value
|
|
||||||
|
|||||||
@@ -1,13 +1,23 @@
|
|||||||
import logging
|
import logging
|
||||||
|
|
||||||
from asyncio import CancelledError, sleep
|
from asyncio import CancelledError
|
||||||
from itertools import count
|
from itertools import count
|
||||||
|
from unittest.mock import Mock
|
||||||
|
|
||||||
|
import pytest
|
||||||
|
|
||||||
from sanic.exceptions import NotFound
|
from sanic.exceptions import NotFound
|
||||||
|
from sanic.middleware import Middleware
|
||||||
from sanic.request import Request
|
from sanic.request import Request
|
||||||
from sanic.response import HTTPResponse, json, text
|
from sanic.response import HTTPResponse, json, text
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture(autouse=True)
|
||||||
|
def reset_middleware():
|
||||||
|
yield
|
||||||
|
Middleware.reset_count()
|
||||||
|
|
||||||
|
|
||||||
# ------------------------------------------------------------ #
|
# ------------------------------------------------------------ #
|
||||||
# GET
|
# GET
|
||||||
# ------------------------------------------------------------ #
|
# ------------------------------------------------------------ #
|
||||||
@@ -183,7 +193,7 @@ def test_middleware_response_raise_exception(app, caplog):
|
|||||||
with caplog.at_level(logging.ERROR):
|
with caplog.at_level(logging.ERROR):
|
||||||
reqrequest, response = app.test_client.get("/fail")
|
reqrequest, response = app.test_client.get("/fail")
|
||||||
|
|
||||||
assert response.status == 404
|
assert response.status == 500
|
||||||
# 404 errors are not logged
|
# 404 errors are not logged
|
||||||
assert (
|
assert (
|
||||||
"sanic.error",
|
"sanic.error",
|
||||||
@@ -323,27 +333,10 @@ def test_middleware_return_response(app):
|
|||||||
assert request_middleware_run_count == 1
|
assert request_middleware_run_count == 1
|
||||||
|
|
||||||
|
|
||||||
def test_middleware_run_on_timeout(app):
|
def test_middleware_object():
|
||||||
app.config.RESPONSE_TIMEOUT = 0.1
|
mock = Mock()
|
||||||
response_middleware_run_count = 0
|
middleware = Middleware(mock)
|
||||||
request_middleware_run_count = 0
|
middleware(1, 2, 3, answer=42)
|
||||||
|
|
||||||
@app.on_response
|
mock.assert_called_once_with(1, 2, 3, answer=42)
|
||||||
def response(_, response):
|
assert middleware.order == (0, 0)
|
||||||
nonlocal response_middleware_run_count
|
|
||||||
response_middleware_run_count += 1
|
|
||||||
|
|
||||||
@app.on_request
|
|
||||||
def request(_):
|
|
||||||
nonlocal request_middleware_run_count
|
|
||||||
request_middleware_run_count += 1
|
|
||||||
|
|
||||||
@app.get("/")
|
|
||||||
async def handler(request):
|
|
||||||
resp1 = await request.respond()
|
|
||||||
await sleep(1)
|
|
||||||
return resp1
|
|
||||||
|
|
||||||
app.test_client.get("/")
|
|
||||||
assert request_middleware_run_count == 1
|
|
||||||
assert response_middleware_run_count == 1
|
|
||||||
|
|||||||
@@ -3,7 +3,6 @@ from functools import partial
|
|||||||
import pytest
|
import pytest
|
||||||
|
|
||||||
from sanic import Sanic
|
from sanic import Sanic
|
||||||
from sanic.middleware import Middleware
|
|
||||||
from sanic.response import json
|
from sanic.response import json
|
||||||
|
|
||||||
|
|
||||||
@@ -34,12 +33,6 @@ PRIORITY_TEST_CASES = (
|
|||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture(autouse=True)
|
|
||||||
def reset_middleware():
|
|
||||||
yield
|
|
||||||
Middleware.reset_count()
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.mark.parametrize(
|
@pytest.mark.parametrize(
|
||||||
"expected,priorities",
|
"expected,priorities",
|
||||||
PRIORITY_TEST_CASES,
|
PRIORITY_TEST_CASES,
|
||||||
|
|||||||
@@ -4,8 +4,8 @@ import os
|
|||||||
import time
|
import time
|
||||||
|
|
||||||
from collections import namedtuple
|
from collections import namedtuple
|
||||||
from datetime import datetime, timedelta
|
from datetime import datetime
|
||||||
from email.utils import formatdate, parsedate_to_datetime
|
from email.utils import formatdate
|
||||||
from logging import ERROR, LogRecord
|
from logging import ERROR, LogRecord
|
||||||
from mimetypes import guess_type
|
from mimetypes import guess_type
|
||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
@@ -665,11 +665,13 @@ def test_multiple_responses(
|
|||||||
|
|
||||||
with caplog.at_level(ERROR):
|
with caplog.at_level(ERROR):
|
||||||
_, response = app.test_client.get("/4")
|
_, response = app.test_client.get("/4")
|
||||||
|
print(response.json)
|
||||||
assert response.status == 200
|
assert response.status == 200
|
||||||
assert "foo" not in response.text
|
assert "foo" not in response.text
|
||||||
assert "one" in response.headers
|
assert "one" in response.headers
|
||||||
assert response.headers["one"] == "one"
|
assert response.headers["one"] == "one"
|
||||||
|
|
||||||
|
print(response.headers)
|
||||||
assert message_in_records(caplog.records, error_msg2)
|
assert message_in_records(caplog.records, error_msg2)
|
||||||
|
|
||||||
with caplog.at_level(ERROR):
|
with caplog.at_level(ERROR):
|
||||||
@@ -839,10 +841,10 @@ def test_file_validate(app: Sanic, static_file_directory: str):
|
|||||||
time.sleep(1)
|
time.sleep(1)
|
||||||
with open(file_path, "a") as f:
|
with open(file_path, "a") as f:
|
||||||
f.write("bar\n")
|
f.write("bar\n")
|
||||||
|
|
||||||
_, response = app.test_client.get(
|
_, response = app.test_client.get(
|
||||||
"/validate", headers={"If-Modified-Since": last_modified}
|
"/validate", headers={"If-Modified-Since": last_modified}
|
||||||
)
|
)
|
||||||
|
|
||||||
assert response.status == 200
|
assert response.status == 200
|
||||||
assert response.body == b"foo\nbar\n"
|
assert response.body == b"foo\nbar\n"
|
||||||
|
|
||||||
@@ -919,28 +921,3 @@ def test_file_validating_304_response(
|
|||||||
)
|
)
|
||||||
assert response.status == 304
|
assert response.status == 304
|
||||||
assert response.body == b""
|
assert response.body == b""
|
||||||
|
|
||||||
|
|
||||||
@pytest.mark.parametrize(
|
|
||||||
"file_name", ["test.file", "decode me.txt", "python.png"]
|
|
||||||
)
|
|
||||||
def test_file_validating_304_response(
|
|
||||||
app: Sanic, file_name: str, static_file_directory: str
|
|
||||||
):
|
|
||||||
app.static("static", Path(static_file_directory) / file_name)
|
|
||||||
|
|
||||||
_, response = app.test_client.get("/static")
|
|
||||||
assert response.status == 200
|
|
||||||
assert response.body == get_file_content(static_file_directory, file_name)
|
|
||||||
last_modified = parsedate_to_datetime(response.headers["Last-Modified"])
|
|
||||||
last_modified += timedelta(seconds=1)
|
|
||||||
_, response = app.test_client.get(
|
|
||||||
"/static",
|
|
||||||
headers={
|
|
||||||
"if-modified-since": formatdate(
|
|
||||||
last_modified.timestamp(), usegmt=True
|
|
||||||
)
|
|
||||||
},
|
|
||||||
)
|
|
||||||
assert response.status == 304
|
|
||||||
assert response.body == b""
|
|
||||||
|
|||||||
@@ -1,215 +0,0 @@
|
|||||||
import json
|
|
||||||
|
|
||||||
from functools import partial
|
|
||||||
from unittest.mock import Mock
|
|
||||||
|
|
||||||
import pytest
|
|
||||||
|
|
||||||
from sanic import Request, Sanic
|
|
||||||
from sanic.exceptions import SanicException
|
|
||||||
from sanic.response import json as json_response
|
|
||||||
from sanic.response.types import JSONResponse
|
|
||||||
|
|
||||||
|
|
||||||
JSON_BODY = {"ok": True}
|
|
||||||
json_dumps = partial(json.dumps, separators=(",", ":"))
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture
|
|
||||||
def json_app(app: Sanic):
|
|
||||||
@app.get("/json")
|
|
||||||
async def handle(request: Request):
|
|
||||||
return json_response(JSON_BODY)
|
|
||||||
|
|
||||||
return app
|
|
||||||
|
|
||||||
|
|
||||||
def test_body_can_be_retrieved(json_app: Sanic):
|
|
||||||
_, resp = json_app.test_client.get("/json")
|
|
||||||
assert resp.body == json_dumps(JSON_BODY).encode()
|
|
||||||
|
|
||||||
|
|
||||||
def test_body_can_be_set(json_app: Sanic):
|
|
||||||
new_body = b'{"hello":"world"}'
|
|
||||||
|
|
||||||
@json_app.on_response
|
|
||||||
def set_body(request: Request, response: JSONResponse):
|
|
||||||
response.body = new_body
|
|
||||||
|
|
||||||
_, resp = json_app.test_client.get("/json")
|
|
||||||
assert resp.body == new_body
|
|
||||||
|
|
||||||
|
|
||||||
def test_raw_body_can_be_retrieved(json_app: Sanic):
|
|
||||||
@json_app.on_response
|
|
||||||
def check_body(request: Request, response: JSONResponse):
|
|
||||||
assert response.raw_body == JSON_BODY
|
|
||||||
|
|
||||||
json_app.test_client.get("/json")
|
|
||||||
|
|
||||||
|
|
||||||
def test_raw_body_can_be_set(json_app: Sanic):
|
|
||||||
new_body = {"hello": "world"}
|
|
||||||
|
|
||||||
@json_app.on_response
|
|
||||||
def set_body(request: Request, response: JSONResponse):
|
|
||||||
response.raw_body = new_body
|
|
||||||
assert response.raw_body == new_body
|
|
||||||
assert response.body == json_dumps(new_body).encode()
|
|
||||||
|
|
||||||
json_app.test_client.get("/json")
|
|
||||||
|
|
||||||
|
|
||||||
def test_raw_body_cant_be_retrieved_after_body_set(json_app: Sanic):
|
|
||||||
new_body = b'{"hello":"world"}'
|
|
||||||
|
|
||||||
@json_app.on_response
|
|
||||||
def check_raw_body(request: Request, response: JSONResponse):
|
|
||||||
response.body = new_body
|
|
||||||
with pytest.raises(SanicException):
|
|
||||||
response.raw_body
|
|
||||||
|
|
||||||
json_app.test_client.get("/json")
|
|
||||||
|
|
||||||
|
|
||||||
def test_raw_body_can_be_reset_after_body_set(json_app: Sanic):
|
|
||||||
new_body = b'{"hello":"world"}'
|
|
||||||
new_new_body = {"lorem": "ipsum"}
|
|
||||||
|
|
||||||
@json_app.on_response
|
|
||||||
def set_bodies(request: Request, response: JSONResponse):
|
|
||||||
response.body = new_body
|
|
||||||
response.raw_body = new_new_body
|
|
||||||
|
|
||||||
_, resp = json_app.test_client.get("/json")
|
|
||||||
assert resp.body == json_dumps(new_new_body).encode()
|
|
||||||
|
|
||||||
|
|
||||||
def test_set_body_method(json_app: Sanic):
|
|
||||||
new_body = {"lorem": "ipsum"}
|
|
||||||
|
|
||||||
@json_app.on_response
|
|
||||||
def set_body(request: Request, response: JSONResponse):
|
|
||||||
response.set_body(new_body)
|
|
||||||
|
|
||||||
_, resp = json_app.test_client.get("/json")
|
|
||||||
assert resp.body == json_dumps(new_body).encode()
|
|
||||||
|
|
||||||
|
|
||||||
def test_set_body_method_after_body_set(json_app: Sanic):
|
|
||||||
new_body = b'{"hello":"world"}'
|
|
||||||
new_new_body = {"lorem": "ipsum"}
|
|
||||||
|
|
||||||
@json_app.on_response
|
|
||||||
def set_body(request: Request, response: JSONResponse):
|
|
||||||
response.body = new_body
|
|
||||||
response.set_body(new_new_body)
|
|
||||||
|
|
||||||
_, resp = json_app.test_client.get("/json")
|
|
||||||
assert resp.body == json_dumps(new_new_body).encode()
|
|
||||||
|
|
||||||
|
|
||||||
def test_custom_dumps_and_kwargs(json_app: Sanic):
|
|
||||||
custom_dumps = Mock(return_value="custom")
|
|
||||||
|
|
||||||
@json_app.get("/json-custom")
|
|
||||||
async def handle_custom(request: Request):
|
|
||||||
return json_response(JSON_BODY, dumps=custom_dumps, prry="platypus")
|
|
||||||
|
|
||||||
_, resp = json_app.test_client.get("/json-custom")
|
|
||||||
assert resp.body == "custom".encode()
|
|
||||||
custom_dumps.assert_called_once_with(JSON_BODY, prry="platypus")
|
|
||||||
|
|
||||||
|
|
||||||
def test_override_dumps_and_kwargs(json_app: Sanic):
|
|
||||||
custom_dumps_1 = Mock(return_value="custom1")
|
|
||||||
custom_dumps_2 = Mock(return_value="custom2")
|
|
||||||
|
|
||||||
@json_app.get("/json-custom")
|
|
||||||
async def handle_custom(request: Request):
|
|
||||||
return json_response(JSON_BODY, dumps=custom_dumps_1, prry="platypus")
|
|
||||||
|
|
||||||
@json_app.on_response
|
|
||||||
def set_body(request: Request, response: JSONResponse):
|
|
||||||
response.set_body(JSON_BODY, dumps=custom_dumps_2, platypus="prry")
|
|
||||||
|
|
||||||
_, resp = json_app.test_client.get("/json-custom")
|
|
||||||
|
|
||||||
assert resp.body == "custom2".encode()
|
|
||||||
custom_dumps_1.assert_called_once_with(JSON_BODY, prry="platypus")
|
|
||||||
custom_dumps_2.assert_called_once_with(JSON_BODY, platypus="prry")
|
|
||||||
|
|
||||||
|
|
||||||
def test_append(json_app: Sanic):
|
|
||||||
@json_app.get("/json-append")
|
|
||||||
async def handler_append(request: Request):
|
|
||||||
return json_response(["a", "b"], status=200)
|
|
||||||
|
|
||||||
@json_app.on_response
|
|
||||||
def do_append(request: Request, response: JSONResponse):
|
|
||||||
response.append("c")
|
|
||||||
|
|
||||||
_, resp = json_app.test_client.get("/json-append")
|
|
||||||
assert resp.body == json_dumps(["a", "b", "c"]).encode()
|
|
||||||
|
|
||||||
|
|
||||||
def test_extend(json_app: Sanic):
|
|
||||||
@json_app.get("/json-extend")
|
|
||||||
async def handler_extend(request: Request):
|
|
||||||
return json_response(["a", "b"], status=200)
|
|
||||||
|
|
||||||
@json_app.on_response
|
|
||||||
def do_extend(request: Request, response: JSONResponse):
|
|
||||||
response.extend(["c", "d"])
|
|
||||||
|
|
||||||
_, resp = json_app.test_client.get("/json-extend")
|
|
||||||
assert resp.body == json_dumps(["a", "b", "c", "d"]).encode()
|
|
||||||
|
|
||||||
|
|
||||||
def test_update(json_app: Sanic):
|
|
||||||
@json_app.get("/json-update")
|
|
||||||
async def handler_update(request: Request):
|
|
||||||
return json_response({"a": "b"}, status=200)
|
|
||||||
|
|
||||||
@json_app.on_response
|
|
||||||
def do_update(request: Request, response: JSONResponse):
|
|
||||||
response.update({"c": "d"}, e="f")
|
|
||||||
|
|
||||||
_, resp = json_app.test_client.get("/json-update")
|
|
||||||
assert resp.body == json_dumps({"a": "b", "c": "d", "e": "f"}).encode()
|
|
||||||
|
|
||||||
|
|
||||||
def test_pop_dict(json_app: Sanic):
|
|
||||||
@json_app.get("/json-pop")
|
|
||||||
async def handler_pop(request: Request):
|
|
||||||
return json_response({"a": "b", "c": "d"}, status=200)
|
|
||||||
|
|
||||||
@json_app.on_response
|
|
||||||
def do_pop(request: Request, response: JSONResponse):
|
|
||||||
val = response.pop("c")
|
|
||||||
assert val == "d"
|
|
||||||
|
|
||||||
val_default = response.pop("e", "f")
|
|
||||||
assert val_default == "f"
|
|
||||||
|
|
||||||
_, resp = json_app.test_client.get("/json-pop")
|
|
||||||
assert resp.body == json_dumps({"a": "b"}).encode()
|
|
||||||
|
|
||||||
|
|
||||||
def test_pop_list(json_app: Sanic):
|
|
||||||
@json_app.get("/json-pop")
|
|
||||||
async def handler_pop(request: Request):
|
|
||||||
return json_response(["a", "b"], status=200)
|
|
||||||
|
|
||||||
@json_app.on_response
|
|
||||||
def do_pop(request: Request, response: JSONResponse):
|
|
||||||
val = response.pop(0)
|
|
||||||
assert val == "a"
|
|
||||||
|
|
||||||
with pytest.raises(
|
|
||||||
TypeError, match="pop doesn't accept a default argument for lists"
|
|
||||||
):
|
|
||||||
response.pop(21, "nah nah")
|
|
||||||
|
|
||||||
_, resp = json_app.test_client.get("/json-pop")
|
|
||||||
assert resp.body == json_dumps(["b"]).encode()
|
|
||||||
@@ -503,10 +503,9 @@ def test_stack_trace_on_not_found(app, static_file_directory, caplog):
|
|||||||
counter = Counter([(r[0], r[1]) for r in caplog.record_tuples])
|
counter = Counter([(r[0], r[1]) for r in caplog.record_tuples])
|
||||||
|
|
||||||
assert response.status == 404
|
assert response.status == 404
|
||||||
assert counter[("sanic.root", logging.INFO)] == 9
|
assert counter[("sanic.root", logging.INFO)] == 11
|
||||||
assert counter[("sanic.root", logging.ERROR)] == 0
|
assert counter[("sanic.root", logging.ERROR)] == 0
|
||||||
assert counter[("sanic.error", logging.ERROR)] == 0
|
assert counter[("sanic.error", logging.ERROR)] == 0
|
||||||
assert counter[("sanic.server", logging.INFO)] == 2
|
|
||||||
|
|
||||||
|
|
||||||
def test_no_stack_trace_on_not_found(app, static_file_directory, caplog):
|
def test_no_stack_trace_on_not_found(app, static_file_directory, caplog):
|
||||||
@@ -522,10 +521,9 @@ def test_no_stack_trace_on_not_found(app, static_file_directory, caplog):
|
|||||||
counter = Counter([(r[0], r[1]) for r in caplog.record_tuples])
|
counter = Counter([(r[0], r[1]) for r in caplog.record_tuples])
|
||||||
|
|
||||||
assert response.status == 404
|
assert response.status == 404
|
||||||
assert counter[("sanic.root", logging.INFO)] == 9
|
assert counter[("sanic.root", logging.INFO)] == 11
|
||||||
assert counter[("sanic.root", logging.ERROR)] == 0
|
assert counter[("sanic.root", logging.ERROR)] == 0
|
||||||
assert counter[("sanic.error", logging.ERROR)] == 0
|
assert counter[("sanic.error", logging.ERROR)] == 0
|
||||||
assert counter[("sanic.server", logging.INFO)] == 2
|
|
||||||
assert response.text == "No file: /static/non_existing_file.file"
|
assert response.text == "No file: /static/non_existing_file.file"
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -4,7 +4,6 @@ import ssl
|
|||||||
import subprocess
|
import subprocess
|
||||||
|
|
||||||
from contextlib import contextmanager
|
from contextlib import contextmanager
|
||||||
from multiprocessing import Event
|
|
||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
from unittest.mock import Mock, patch
|
from unittest.mock import Mock, patch
|
||||||
from urllib.parse import urlparse
|
from urllib.parse import urlparse
|
||||||
@@ -265,7 +264,6 @@ def test_cert_sni_list(app):
|
|||||||
assert response.text == "sanic.example"
|
assert response.text == "sanic.example"
|
||||||
|
|
||||||
|
|
||||||
@pytest.mark.xfail
|
|
||||||
def test_missing_sni(app):
|
def test_missing_sni(app):
|
||||||
"""The sanic cert does not list 127.0.0.1 and httpx does not send
|
"""The sanic cert does not list 127.0.0.1 and httpx does not send
|
||||||
IP as SNI anyway."""
|
IP as SNI anyway."""
|
||||||
@@ -284,7 +282,6 @@ def test_missing_sni(app):
|
|||||||
assert "Request and response object expected" in str(exc.value)
|
assert "Request and response object expected" in str(exc.value)
|
||||||
|
|
||||||
|
|
||||||
@pytest.mark.xfail
|
|
||||||
def test_no_matching_cert(app):
|
def test_no_matching_cert(app):
|
||||||
"""The sanic cert does not list 127.0.0.1 and httpx does not send
|
"""The sanic cert does not list 127.0.0.1 and httpx does not send
|
||||||
IP as SNI anyway."""
|
IP as SNI anyway."""
|
||||||
@@ -304,7 +301,6 @@ def test_no_matching_cert(app):
|
|||||||
assert "Request and response object expected" in str(exc.value)
|
assert "Request and response object expected" in str(exc.value)
|
||||||
|
|
||||||
|
|
||||||
@pytest.mark.xfail
|
|
||||||
def test_wildcards(app):
|
def test_wildcards(app):
|
||||||
ssl_list = [None, localhost_dir, sanic_dir]
|
ssl_list = [None, localhost_dir, sanic_dir]
|
||||||
|
|
||||||
@@ -640,29 +636,3 @@ def test_sanic_ssl_context_create():
|
|||||||
|
|
||||||
assert sanic_context is context
|
assert sanic_context is context
|
||||||
assert isinstance(sanic_context, SanicSSLContext)
|
assert isinstance(sanic_context, SanicSSLContext)
|
||||||
|
|
||||||
|
|
||||||
def test_ssl_in_multiprocess_mode(app: Sanic, caplog):
|
|
||||||
|
|
||||||
ssl_dict = {"cert": localhost_cert, "key": localhost_key}
|
|
||||||
event = Event()
|
|
||||||
|
|
||||||
@app.main_process_start
|
|
||||||
async def main_start(app: Sanic):
|
|
||||||
app.shared_ctx.event = event
|
|
||||||
|
|
||||||
@app.after_server_start
|
|
||||||
async def shutdown(app):
|
|
||||||
app.shared_ctx.event.set()
|
|
||||||
app.stop()
|
|
||||||
|
|
||||||
assert not event.is_set()
|
|
||||||
with caplog.at_level(logging.INFO):
|
|
||||||
app.run(ssl=ssl_dict)
|
|
||||||
assert event.is_set()
|
|
||||||
|
|
||||||
assert (
|
|
||||||
"sanic.root",
|
|
||||||
logging.INFO,
|
|
||||||
"Goin' Fast @ https://127.0.0.1:8000",
|
|
||||||
) in caplog.record_tuples
|
|
||||||
|
|||||||
@@ -2,7 +2,7 @@
|
|||||||
import logging
|
import logging
|
||||||
import os
|
import os
|
||||||
|
|
||||||
from asyncio import AbstractEventLoop, sleep
|
from asyncio import AbstractEventLoop
|
||||||
from string import ascii_lowercase
|
from string import ascii_lowercase
|
||||||
|
|
||||||
import httpcore
|
import httpcore
|
||||||
@@ -179,7 +179,6 @@ async def client(app: Sanic, loop: AbstractEventLoop):
|
|||||||
assert r.status_code == 200
|
assert r.status_code == 200
|
||||||
assert r.text == os.path.abspath(SOCKPATH)
|
assert r.text == os.path.abspath(SOCKPATH)
|
||||||
finally:
|
finally:
|
||||||
await sleep(0.2)
|
|
||||||
app.stop()
|
app.stop()
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -1,56 +0,0 @@
|
|||||||
from typing import Any, Callable, Coroutine
|
|
||||||
|
|
||||||
import pytest
|
|
||||||
|
|
||||||
from websockets.client import WebSocketClientProtocol
|
|
||||||
|
|
||||||
from sanic import Request, Sanic, Websocket
|
|
||||||
|
|
||||||
|
|
||||||
MimicClientType = Callable[
|
|
||||||
[WebSocketClientProtocol], Coroutine[None, None, Any]
|
|
||||||
]
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture
|
|
||||||
def simple_ws_mimic_client():
|
|
||||||
async def client_mimic(ws: WebSocketClientProtocol):
|
|
||||||
await ws.send("test 1")
|
|
||||||
await ws.recv()
|
|
||||||
await ws.send("test 2")
|
|
||||||
await ws.recv()
|
|
||||||
|
|
||||||
return client_mimic
|
|
||||||
|
|
||||||
|
|
||||||
def test_ws_handler(
|
|
||||||
app: Sanic,
|
|
||||||
simple_ws_mimic_client: MimicClientType,
|
|
||||||
):
|
|
||||||
@app.websocket("/ws")
|
|
||||||
async def ws_echo_handler(request: Request, ws: Websocket):
|
|
||||||
while True:
|
|
||||||
msg = await ws.recv()
|
|
||||||
await ws.send(msg)
|
|
||||||
|
|
||||||
_, ws_proxy = app.test_client.websocket(
|
|
||||||
"/ws", mimic=simple_ws_mimic_client
|
|
||||||
)
|
|
||||||
assert ws_proxy.client_sent == ["test 1", "test 2", ""]
|
|
||||||
assert ws_proxy.client_received == ["test 1", "test 2"]
|
|
||||||
|
|
||||||
|
|
||||||
def test_ws_handler_async_for(
|
|
||||||
app: Sanic,
|
|
||||||
simple_ws_mimic_client: MimicClientType,
|
|
||||||
):
|
|
||||||
@app.websocket("/ws")
|
|
||||||
async def ws_echo_handler(request: Request, ws: Websocket):
|
|
||||||
async for msg in ws:
|
|
||||||
await ws.send(msg)
|
|
||||||
|
|
||||||
_, ws_proxy = app.test_client.websocket(
|
|
||||||
"/ws", mimic=simple_ws_mimic_client
|
|
||||||
)
|
|
||||||
assert ws_proxy.client_sent == ["test 1", "test 2", ""]
|
|
||||||
assert ws_proxy.client_received == ["test 1", "test 2"]
|
|
||||||
@@ -86,10 +86,6 @@ def test_input_is_module():
|
|||||||
@patch("sanic.worker.loader.TrustmeCreator")
|
@patch("sanic.worker.loader.TrustmeCreator")
|
||||||
@patch("sanic.worker.loader.MkcertCreator")
|
@patch("sanic.worker.loader.MkcertCreator")
|
||||||
def test_cert_loader(MkcertCreator: Mock, TrustmeCreator: Mock, creator: str):
|
def test_cert_loader(MkcertCreator: Mock, TrustmeCreator: Mock, creator: str):
|
||||||
CertLoader._creators = {
|
|
||||||
"mkcert": MkcertCreator,
|
|
||||||
"trustme": TrustmeCreator,
|
|
||||||
}
|
|
||||||
MkcertCreator.return_value = MkcertCreator
|
MkcertCreator.return_value = MkcertCreator
|
||||||
TrustmeCreator.return_value = TrustmeCreator
|
TrustmeCreator.return_value = TrustmeCreator
|
||||||
data = {
|
data = {
|
||||||
|
|||||||
@@ -3,7 +3,6 @@ from unittest.mock import Mock, call, patch
|
|||||||
|
|
||||||
import pytest
|
import pytest
|
||||||
|
|
||||||
from sanic.exceptions import ServerKilled
|
|
||||||
from sanic.worker.manager import WorkerManager
|
from sanic.worker.manager import WorkerManager
|
||||||
|
|
||||||
|
|
||||||
@@ -77,7 +76,6 @@ def test_kill(os_mock: Mock):
|
|||||||
(Mock(), Mock()),
|
(Mock(), Mock()),
|
||||||
{},
|
{},
|
||||||
)
|
)
|
||||||
with pytest.raises(ServerKilled):
|
|
||||||
manager.kill()
|
manager.kill()
|
||||||
os_mock.kill.assert_called_once_with(1234, SIGKILL)
|
os_mock.kill.assert_called_once_with(1234, SIGKILL)
|
||||||
|
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
from multiprocessing import Event
|
from multiprocessing import Event
|
||||||
from os import environ, getpid
|
from os import environ, getpid
|
||||||
from typing import Any, Dict, Type, Union
|
from typing import Any, Dict
|
||||||
from unittest.mock import Mock
|
from unittest.mock import Mock
|
||||||
|
|
||||||
import pytest
|
import pytest
|
||||||
@@ -117,26 +117,3 @@ def test_properties(
|
|||||||
assert m.workers == worker_state
|
assert m.workers == worker_state
|
||||||
assert m.state == worker_state["Test"]
|
assert m.state == worker_state["Test"]
|
||||||
assert isinstance(m.state, WorkerState)
|
assert isinstance(m.state, WorkerState)
|
||||||
|
|
||||||
|
|
||||||
@pytest.mark.parametrize(
|
|
||||||
"params,expected",
|
|
||||||
(
|
|
||||||
({}, "Test"),
|
|
||||||
({"name": "foo"}, "foo"),
|
|
||||||
({"all_workers": True}, "__ALL_PROCESSES__:"),
|
|
||||||
({"name": "foo", "all_workers": True}, ValueError),
|
|
||||||
),
|
|
||||||
)
|
|
||||||
def test_restart_params(
|
|
||||||
monitor_publisher: Mock,
|
|
||||||
m: WorkerMultiplexer,
|
|
||||||
params: Dict[str, Any],
|
|
||||||
expected: Union[str, Type[Exception]],
|
|
||||||
):
|
|
||||||
if isinstance(expected, str):
|
|
||||||
m.restart(**params)
|
|
||||||
monitor_publisher.send.assert_called_once_with(expected)
|
|
||||||
else:
|
|
||||||
with pytest.raises(expected):
|
|
||||||
m.restart(**params)
|
|
||||||
|
|||||||
@@ -1,18 +1,13 @@
|
|||||||
import re
|
|
||||||
import signal
|
import signal
|
||||||
import threading
|
|
||||||
|
|
||||||
from asyncio import Event
|
from asyncio import Event
|
||||||
from logging import DEBUG
|
|
||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
from unittest.mock import Mock
|
from unittest.mock import Mock
|
||||||
|
|
||||||
import pytest
|
import pytest
|
||||||
|
|
||||||
from sanic.app import Sanic
|
from sanic.app import Sanic
|
||||||
from sanic.constants import RestartOrder
|
|
||||||
from sanic.worker.loader import AppLoader
|
from sanic.worker.loader import AppLoader
|
||||||
from sanic.worker.process import ProcessState, WorkerProcess
|
|
||||||
from sanic.worker.reloader import Reloader
|
from sanic.worker.reloader import Reloader
|
||||||
|
|
||||||
|
|
||||||
@@ -72,64 +67,6 @@ def test_iter_files():
|
|||||||
assert len_total_files == len_python_files + len_static_files
|
assert len_total_files == len_python_files + len_static_files
|
||||||
|
|
||||||
|
|
||||||
@pytest.mark.parametrize(
|
|
||||||
"order,expected",
|
|
||||||
(
|
|
||||||
(
|
|
||||||
"shutdown_first",
|
|
||||||
[
|
|
||||||
"Restarting a process",
|
|
||||||
"Begin restart termination",
|
|
||||||
"Starting a process",
|
|
||||||
],
|
|
||||||
),
|
|
||||||
(
|
|
||||||
"startup_first",
|
|
||||||
[
|
|
||||||
"Restarting a process",
|
|
||||||
"Starting a process",
|
|
||||||
"Begin restart termination",
|
|
||||||
"Waiting for process to be acked",
|
|
||||||
"Process acked. Terminating",
|
|
||||||
],
|
|
||||||
),
|
|
||||||
),
|
|
||||||
)
|
|
||||||
def test_default_reload_shutdown_order(monkeypatch, caplog, order, expected):
|
|
||||||
|
|
||||||
current_process = Mock()
|
|
||||||
worker_process = WorkerProcess(
|
|
||||||
lambda **_: current_process,
|
|
||||||
"Test",
|
|
||||||
lambda **_: ...,
|
|
||||||
{},
|
|
||||||
{},
|
|
||||||
RestartOrder[order.upper()],
|
|
||||||
)
|
|
||||||
|
|
||||||
def start(self):
|
|
||||||
worker_process.set_state(ProcessState.ACKED)
|
|
||||||
self._target()
|
|
||||||
|
|
||||||
orig = threading.Thread.start
|
|
||||||
monkeypatch.setattr(threading.Thread, "start", start)
|
|
||||||
|
|
||||||
with caplog.at_level(DEBUG):
|
|
||||||
worker_process.restart()
|
|
||||||
|
|
||||||
ansi = re.compile(r"\x1B(?:[@-Z\\-_]|\[[0-?]*[ -/]*[@-~])")
|
|
||||||
|
|
||||||
def clean(msg: str):
|
|
||||||
msg, _ = ansi.sub("", msg).split(":", 1)
|
|
||||||
return msg
|
|
||||||
|
|
||||||
debug = [clean(record[2]) for record in caplog.record_tuples]
|
|
||||||
assert debug == expected
|
|
||||||
current_process.start.assert_called_once()
|
|
||||||
current_process.terminate.assert_called_once()
|
|
||||||
monkeypatch.setattr(threading.Thread, "start", orig)
|
|
||||||
|
|
||||||
|
|
||||||
def test_reloader_triggers_start_stop_listeners(
|
def test_reloader_triggers_start_stop_listeners(
|
||||||
app: Sanic, app_loader: AppLoader
|
app: Sanic, app_loader: AppLoader
|
||||||
):
|
):
|
||||||
|
|||||||
@@ -1,5 +1,3 @@
|
|||||||
import logging
|
|
||||||
|
|
||||||
from os import environ
|
from os import environ
|
||||||
from unittest.mock import Mock, patch
|
from unittest.mock import Mock, patch
|
||||||
|
|
||||||
@@ -39,7 +37,7 @@ def test_config_app(mock_app: Mock):
|
|||||||
mock_app.update_config.assert_called_once_with({"FOO": "BAR"})
|
mock_app.update_config.assert_called_once_with({"FOO": "BAR"})
|
||||||
|
|
||||||
|
|
||||||
def test_bad_process(mock_app: Mock, caplog):
|
def test_bad_process(mock_app: Mock):
|
||||||
environ["SANIC_WORKER_NAME"] = "FOO"
|
environ["SANIC_WORKER_NAME"] = "FOO"
|
||||||
|
|
||||||
message = "No restart publisher found in worker process"
|
message = "No restart publisher found in worker process"
|
||||||
@@ -47,12 +45,8 @@ def test_bad_process(mock_app: Mock, caplog):
|
|||||||
worker_serve(**args(mock_app))
|
worker_serve(**args(mock_app))
|
||||||
|
|
||||||
message = "No worker state found in worker process"
|
message = "No worker state found in worker process"
|
||||||
publisher = Mock()
|
with pytest.raises(RuntimeError, match=message):
|
||||||
with caplog.at_level(logging.ERROR):
|
worker_serve(**args(mock_app, monitor_publisher=Mock()))
|
||||||
worker_serve(**args(mock_app, monitor_publisher=publisher))
|
|
||||||
|
|
||||||
assert ("sanic.error", logging.ERROR, message) in caplog.record_tuples
|
|
||||||
publisher.send.assert_called_once_with("__TERMINATE_EARLY__")
|
|
||||||
|
|
||||||
del environ["SANIC_WORKER_NAME"]
|
del environ["SANIC_WORKER_NAME"]
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user