Compare commits
2 Commits
current-re
...
breaking-c
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
c695c5250a | ||
|
|
23c1eaab29 |
33
.github/ISSUE_TEMPLATE/rfc.yml
vendored
33
.github/ISSUE_TEMPLATE/rfc.yml
vendored
@@ -1,33 +0,0 @@
|
|||||||
name: 💡 Request for Comments
|
|
||||||
description: Open an RFC for discussion
|
|
||||||
labels: ["RFC"]
|
|
||||||
body:
|
|
||||||
- type: input
|
|
||||||
id: compare
|
|
||||||
attributes:
|
|
||||||
label: Link to code
|
|
||||||
description: If available, share a [comparison](https://github.com/sanic-org/sanic/compare) from a POC branch to main
|
|
||||||
placeholder: https://github.com/sanic-org/sanic/compare/main...some-new-branch
|
|
||||||
validations:
|
|
||||||
required: false
|
|
||||||
- type: textarea
|
|
||||||
id: proposal
|
|
||||||
attributes:
|
|
||||||
label: Proposal
|
|
||||||
description: A thorough discussion of the proposal discussing the problem it solves, potential code, use cases, and impacts
|
|
||||||
validations:
|
|
||||||
required: true
|
|
||||||
- type: textarea
|
|
||||||
id: additional
|
|
||||||
attributes:
|
|
||||||
label: Additional context
|
|
||||||
description: Add any other context that is relevant
|
|
||||||
validations:
|
|
||||||
required: false
|
|
||||||
- type: checkboxes
|
|
||||||
id: breaking
|
|
||||||
attributes:
|
|
||||||
label: Is this a breaking change?
|
|
||||||
options:
|
|
||||||
- label: "Yes"
|
|
||||||
required: false
|
|
||||||
@@ -316,6 +316,8 @@ Version 21.3.0
|
|||||||
Version 20.12.3
|
Version 20.12.3
|
||||||
---------------
|
---------------
|
||||||
|
|
||||||
|
`Current LTS version`
|
||||||
|
|
||||||
**Bugfixes**
|
**Bugfixes**
|
||||||
|
|
||||||
*
|
*
|
||||||
|
|||||||
@@ -1,11 +1,6 @@
|
|||||||
📜 Changelog
|
📜 Changelog
|
||||||
============
|
============
|
||||||
|
|
||||||
| 🔶 Current release
|
|
||||||
| 🔷 In support release
|
|
||||||
|
|
|
||||||
|
|
||||||
.. mdinclude:: ./releases/23/23.3.md
|
|
||||||
.. mdinclude:: ./releases/22/22.12.md
|
.. mdinclude:: ./releases/22/22.12.md
|
||||||
.. mdinclude:: ./releases/22/22.9.md
|
.. mdinclude:: ./releases/22/22.9.md
|
||||||
.. mdinclude:: ./releases/22/22.6.md
|
.. mdinclude:: ./releases/22/22.6.md
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
## Version 22.12.0 🔷
|
## Version 22.12.0 🔶
|
||||||
|
|
||||||
_Current version_
|
_Current version_
|
||||||
|
|
||||||
|
|||||||
@@ -1,53 +0,0 @@
|
|||||||
## Version 23.3.0 🔶
|
|
||||||
|
|
||||||
### Features
|
|
||||||
- [#2545](https://github.com/sanic-org/sanic/pull/2545) Standardize init of exceptions for more consistent control of HTTP responses using exceptions
|
|
||||||
- [#2606](https://github.com/sanic-org/sanic/pull/2606) Decode headers as UTF-8 also in ASGI
|
|
||||||
- [#2646](https://github.com/sanic-org/sanic/pull/2646) Separate ASGI request and lifespan callables
|
|
||||||
- [#2659](https://github.com/sanic-org/sanic/pull/2659) Use ``FALLBACK_ERROR_FORMAT`` for handlers that return ``empty()``
|
|
||||||
- [#2662](https://github.com/sanic-org/sanic/pull/2662) Add basic file browser (HTML page) and auto-index serving
|
|
||||||
- [#2667](https://github.com/sanic-org/sanic/pull/2667) Nicer traceback formatting (HTML page)
|
|
||||||
- [#2668](https://github.com/sanic-org/sanic/pull/2668) Smarter error page rendering format selection; more reliant upon header and "common sense" defaults
|
|
||||||
- [#2680](https://github.com/sanic-org/sanic/pull/2680) Check the status of socket before shutting down with ``SHUT_RDWR``
|
|
||||||
- [#2687](https://github.com/sanic-org/sanic/pull/2687) Refresh ``Request.accept`` functionality to be more performant and spec-compliant
|
|
||||||
- [#2696](https://github.com/sanic-org/sanic/pull/2696) Add header accessors as properties
|
|
||||||
```
|
|
||||||
Example-Field: Foo, Bar
|
|
||||||
Example-Field: Baz
|
|
||||||
```
|
|
||||||
```python
|
|
||||||
request.headers.example_field == "Foo, Bar,Baz"
|
|
||||||
```
|
|
||||||
- [#2700](https://github.com/sanic-org/sanic/pull/2700) Simpler CLI targets
|
|
||||||
|
|
||||||
```sh
|
|
||||||
$ sanic path.to.module:app # global app instance
|
|
||||||
$ sanic path.to.module:create_app # factory pattern
|
|
||||||
$ sanic ./path/to/directory/ # simple serve
|
|
||||||
```
|
|
||||||
- [#2701](https://github.com/sanic-org/sanic/pull/2701) API to define a number of workers in managed processes
|
|
||||||
- [#2704](https://github.com/sanic-org/sanic/pull/2704) Add convenience for dynamic changes to routing
|
|
||||||
- [#2706](https://github.com/sanic-org/sanic/pull/2706) Add convenience methods for cookie creation and deletion
|
|
||||||
|
|
||||||
```python
|
|
||||||
response = text("...")
|
|
||||||
response.add_cookie("test", "It worked!", domain=".yummy-yummy-cookie.com")
|
|
||||||
```
|
|
||||||
- [#2707](https://github.com/sanic-org/sanic/pull/2707) Simplified ``parse_content_header`` escaping to be RFC-compliant and remove outdated FF hack
|
|
||||||
- [#2710](https://github.com/sanic-org/sanic/pull/2710) Stricter charset handling and escaping of request URLs
|
|
||||||
- [#2711](https://github.com/sanic-org/sanic/pull/2711) Consume body on ``DELETE`` by default
|
|
||||||
- [#2719](https://github.com/sanic-org/sanic/pull/2719) Allow ``password`` to be passed to TLS context
|
|
||||||
- [#2720](https://github.com/sanic-org/sanic/pull/2720) Skip middleware on ``RequestCancelled``
|
|
||||||
- [#2721](https://github.com/sanic-org/sanic/pull/2721) Change access logging format to ``%s``
|
|
||||||
- [#2722](https://github.com/sanic-org/sanic/pull/2722) Add ``CertLoader`` as application option for directly controlling ``SSLContext`` objects
|
|
||||||
- [#2725](https://github.com/sanic-org/sanic/pull/2725) Worker sync state tolerance on race condition
|
|
||||||
|
|
||||||
### Bugfixes
|
|
||||||
- [#2651](https://github.com/sanic-org/sanic/pull/2651) ASGI websocket to pass thru bytes as is
|
|
||||||
- [#2697](https://github.com/sanic-org/sanic/pull/2697) Fix comparison between datetime aware and naive in ``file`` when using ``If-Modified-Since``
|
|
||||||
|
|
||||||
### Deprecations and Removals
|
|
||||||
- [#2666](https://github.com/sanic-org/sanic/pull/2666) Remove deprecated ``__blueprintname__`` property
|
|
||||||
|
|
||||||
### Improved Documentation
|
|
||||||
- [#2712](https://github.com/sanic-org/sanic/pull/2712) Improved example using ``'https'`` to create the redirect
|
|
||||||
@@ -29,7 +29,7 @@ def proxy(request, path):
|
|||||||
path=path,
|
path=path,
|
||||||
_server=https.config.SERVER_NAME,
|
_server=https.config.SERVER_NAME,
|
||||||
_external=True,
|
_external=True,
|
||||||
_scheme="https",
|
_scheme="http",
|
||||||
)
|
)
|
||||||
return response.redirect(url)
|
return response.redirect(url)
|
||||||
|
|
||||||
|
|||||||
@@ -2,22 +2,6 @@ from sanic.__version__ import __version__
|
|||||||
from sanic.app import Sanic
|
from sanic.app import Sanic
|
||||||
from sanic.blueprints import Blueprint
|
from sanic.blueprints import Blueprint
|
||||||
from sanic.constants import HTTPMethod
|
from sanic.constants import HTTPMethod
|
||||||
from sanic.exceptions import (
|
|
||||||
BadRequest,
|
|
||||||
ExpectationFailed,
|
|
||||||
FileNotFound,
|
|
||||||
Forbidden,
|
|
||||||
HeaderNotFound,
|
|
||||||
InternalServerError,
|
|
||||||
InvalidHeader,
|
|
||||||
MethodNotAllowed,
|
|
||||||
NotFound,
|
|
||||||
RangeNotSatisfiable,
|
|
||||||
SanicException,
|
|
||||||
ServerError,
|
|
||||||
ServiceUnavailable,
|
|
||||||
Unauthorized,
|
|
||||||
)
|
|
||||||
from sanic.request import Request
|
from sanic.request import Request
|
||||||
from sanic.response import (
|
from sanic.response import (
|
||||||
HTTPResponse,
|
HTTPResponse,
|
||||||
@@ -25,7 +9,6 @@ from sanic.response import (
|
|||||||
file,
|
file,
|
||||||
html,
|
html,
|
||||||
json,
|
json,
|
||||||
raw,
|
|
||||||
redirect,
|
redirect,
|
||||||
text,
|
text,
|
||||||
)
|
)
|
||||||
@@ -34,34 +17,16 @@ from sanic.server.websockets.impl import WebsocketImplProtocol as Websocket
|
|||||||
|
|
||||||
__all__ = (
|
__all__ = (
|
||||||
"__version__",
|
"__version__",
|
||||||
# Common objects
|
|
||||||
"Sanic",
|
"Sanic",
|
||||||
"Blueprint",
|
"Blueprint",
|
||||||
"HTTPMethod",
|
"HTTPMethod",
|
||||||
"HTTPResponse",
|
"HTTPResponse",
|
||||||
"Request",
|
"Request",
|
||||||
"Websocket",
|
"Websocket",
|
||||||
# Common exceptions
|
|
||||||
"BadRequest",
|
|
||||||
"ExpectationFailed",
|
|
||||||
"FileNotFound",
|
|
||||||
"Forbidden",
|
|
||||||
"HeaderNotFound",
|
|
||||||
"InternalServerError",
|
|
||||||
"InvalidHeader",
|
|
||||||
"MethodNotAllowed",
|
|
||||||
"NotFound",
|
|
||||||
"RangeNotSatisfiable",
|
|
||||||
"SanicException",
|
|
||||||
"ServerError",
|
|
||||||
"ServiceUnavailable",
|
|
||||||
"Unauthorized",
|
|
||||||
# Common response methods
|
|
||||||
"empty",
|
"empty",
|
||||||
"file",
|
"file",
|
||||||
"html",
|
"html",
|
||||||
"json",
|
"json",
|
||||||
"raw",
|
|
||||||
"redirect",
|
"redirect",
|
||||||
"text",
|
"text",
|
||||||
)
|
)
|
||||||
|
|||||||
@@ -1 +1,10 @@
|
|||||||
__version__ = "23.3.0"
|
__version__ = "23.3.0"
|
||||||
|
__compatibility__ = "22.12"
|
||||||
|
|
||||||
|
from inspect import currentframe, stack
|
||||||
|
|
||||||
|
for frame_info in stack():
|
||||||
|
if frame_info.frame is not currentframe():
|
||||||
|
value = frame_info.frame.f_globals.get("__SANIC_COMPATIBILITY__")
|
||||||
|
if value:
|
||||||
|
__compatibility__ = value
|
||||||
|
|||||||
100
sanic/app.py
100
sanic/app.py
@@ -16,7 +16,7 @@ from asyncio import (
|
|||||||
)
|
)
|
||||||
from asyncio.futures import Future
|
from asyncio.futures import Future
|
||||||
from collections import defaultdict, deque
|
from collections import defaultdict, deque
|
||||||
from contextlib import contextmanager, suppress
|
from contextlib import suppress
|
||||||
from functools import partial
|
from functools import partial
|
||||||
from inspect import isawaitable
|
from inspect import isawaitable
|
||||||
from os import environ
|
from os import environ
|
||||||
@@ -33,7 +33,6 @@ from typing import (
|
|||||||
Deque,
|
Deque,
|
||||||
Dict,
|
Dict,
|
||||||
Iterable,
|
Iterable,
|
||||||
Iterator,
|
|
||||||
List,
|
List,
|
||||||
Optional,
|
Optional,
|
||||||
Set,
|
Set,
|
||||||
@@ -49,7 +48,7 @@ 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, ServerStage
|
||||||
from sanic.asgi import ASGIApp, Lifespan
|
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
|
||||||
@@ -64,7 +63,12 @@ from sanic.exceptions import (
|
|||||||
from sanic.handlers import ErrorHandler
|
from sanic.handlers import ErrorHandler
|
||||||
from sanic.helpers import Default, _default
|
from sanic.helpers import Default, _default
|
||||||
from sanic.http import Stage
|
from sanic.http import Stage
|
||||||
from sanic.log import LOGGING_CONFIG_DEFAULTS, error_logger, logger
|
from sanic.log import (
|
||||||
|
LOGGING_CONFIG_DEFAULTS,
|
||||||
|
deprecation,
|
||||||
|
error_logger,
|
||||||
|
logger,
|
||||||
|
)
|
||||||
from sanic.middleware import Middleware, MiddlewareLocation
|
from sanic.middleware import Middleware, MiddlewareLocation
|
||||||
from sanic.mixins.listeners import ListenerEvent
|
from sanic.mixins.listeners import ListenerEvent
|
||||||
from sanic.mixins.startup import StartupMixin
|
from sanic.mixins.startup import StartupMixin
|
||||||
@@ -87,7 +91,6 @@ from sanic.signals import Signal, SignalRouter
|
|||||||
from sanic.touchup import TouchUp, TouchUpMeta
|
from sanic.touchup import TouchUp, TouchUpMeta
|
||||||
from sanic.types.shared_ctx import SharedContext
|
from sanic.types.shared_ctx import SharedContext
|
||||||
from sanic.worker.inspector import Inspector
|
from sanic.worker.inspector import Inspector
|
||||||
from sanic.worker.loader import CertLoader
|
|
||||||
from sanic.worker.manager import WorkerManager
|
from sanic.worker.manager import WorkerManager
|
||||||
|
|
||||||
|
|
||||||
@@ -116,7 +119,6 @@ class Sanic(StaticHandleMixin, BaseSanic, StartupMixin, metaclass=TouchUpMeta):
|
|||||||
)
|
)
|
||||||
__slots__ = (
|
__slots__ = (
|
||||||
"_asgi_app",
|
"_asgi_app",
|
||||||
"_asgi_lifespan",
|
|
||||||
"_asgi_client",
|
"_asgi_client",
|
||||||
"_blueprint_order",
|
"_blueprint_order",
|
||||||
"_delayed_tasks",
|
"_delayed_tasks",
|
||||||
@@ -135,7 +137,6 @@ class Sanic(StaticHandleMixin, BaseSanic, StartupMixin, metaclass=TouchUpMeta):
|
|||||||
"_test_client",
|
"_test_client",
|
||||||
"_test_manager",
|
"_test_manager",
|
||||||
"blueprints",
|
"blueprints",
|
||||||
"certloader_class",
|
|
||||||
"config",
|
"config",
|
||||||
"configure_logging",
|
"configure_logging",
|
||||||
"ctx",
|
"ctx",
|
||||||
@@ -178,7 +179,6 @@ class Sanic(StaticHandleMixin, BaseSanic, StartupMixin, metaclass=TouchUpMeta):
|
|||||||
loads: Optional[Callable[..., Any]] = None,
|
loads: Optional[Callable[..., Any]] = None,
|
||||||
inspector: bool = False,
|
inspector: bool = False,
|
||||||
inspector_class: Optional[Type[Inspector]] = None,
|
inspector_class: Optional[Type[Inspector]] = None,
|
||||||
certloader_class: Optional[Type[CertLoader]] = None,
|
|
||||||
) -> None:
|
) -> None:
|
||||||
super().__init__(name=name)
|
super().__init__(name=name)
|
||||||
# logging
|
# logging
|
||||||
@@ -198,8 +198,6 @@ class Sanic(StaticHandleMixin, BaseSanic, StartupMixin, metaclass=TouchUpMeta):
|
|||||||
self.config.INSPECTOR = inspector
|
self.config.INSPECTOR = inspector
|
||||||
|
|
||||||
# Then we can do the rest
|
# Then we can do the rest
|
||||||
self._asgi_app: Optional[ASGIApp] = None
|
|
||||||
self._asgi_lifespan: Optional[Lifespan] = None
|
|
||||||
self._asgi_client: Any = None
|
self._asgi_client: Any = None
|
||||||
self._blueprint_order: List[Blueprint] = []
|
self._blueprint_order: List[Blueprint] = []
|
||||||
self._delayed_tasks: List[str] = []
|
self._delayed_tasks: List[str] = []
|
||||||
@@ -213,9 +211,6 @@ class Sanic(StaticHandleMixin, BaseSanic, StartupMixin, metaclass=TouchUpMeta):
|
|||||||
self.asgi = False
|
self.asgi = False
|
||||||
self.auto_reload = False
|
self.auto_reload = False
|
||||||
self.blueprints: Dict[str, Blueprint] = {}
|
self.blueprints: Dict[str, Blueprint] = {}
|
||||||
self.certloader_class: Type[CertLoader] = (
|
|
||||||
certloader_class or CertLoader
|
|
||||||
)
|
|
||||||
self.configure_logging: bool = configure_logging
|
self.configure_logging: bool = configure_logging
|
||||||
self.ctx: Any = ctx or SimpleNamespace()
|
self.ctx: Any = ctx or SimpleNamespace()
|
||||||
self.error_handler: ErrorHandler = error_handler or ErrorHandler()
|
self.error_handler: ErrorHandler = error_handler or ErrorHandler()
|
||||||
@@ -435,15 +430,14 @@ class Sanic(StaticHandleMixin, BaseSanic, StartupMixin, metaclass=TouchUpMeta):
|
|||||||
|
|
||||||
ctx = params.pop("route_context")
|
ctx = params.pop("route_context")
|
||||||
|
|
||||||
with self.amend():
|
routes = self.router.add(**params)
|
||||||
routes = self.router.add(**params)
|
if isinstance(routes, Route):
|
||||||
if isinstance(routes, Route):
|
routes = [routes]
|
||||||
routes = [routes]
|
|
||||||
|
|
||||||
for r in routes:
|
for r in routes:
|
||||||
r.extra.websocket = websocket
|
r.extra.websocket = websocket
|
||||||
r.extra.static = params.get("static", False)
|
r.extra.static = params.get("static", False)
|
||||||
r.ctx.__dict__.update(ctx)
|
r.ctx.__dict__.update(ctx)
|
||||||
|
|
||||||
return routes
|
return routes
|
||||||
|
|
||||||
@@ -452,19 +446,17 @@ class Sanic(StaticHandleMixin, BaseSanic, StartupMixin, metaclass=TouchUpMeta):
|
|||||||
middleware: FutureMiddleware,
|
middleware: FutureMiddleware,
|
||||||
route_names: Optional[List[str]] = None,
|
route_names: Optional[List[str]] = None,
|
||||||
):
|
):
|
||||||
with self.amend():
|
if route_names:
|
||||||
if route_names:
|
return self.register_named_middleware(
|
||||||
return self.register_named_middleware(
|
middleware.middleware, route_names, middleware.attach_to
|
||||||
middleware.middleware, route_names, middleware.attach_to
|
)
|
||||||
)
|
else:
|
||||||
else:
|
return self.register_middleware(
|
||||||
return self.register_middleware(
|
middleware.middleware, middleware.attach_to
|
||||||
middleware.middleware, middleware.attach_to
|
)
|
||||||
)
|
|
||||||
|
|
||||||
def _apply_signal(self, signal: FutureSignal) -> Signal:
|
def _apply_signal(self, signal: FutureSignal) -> Signal:
|
||||||
with self.amend():
|
return self.signal_router.add(*signal)
|
||||||
return self.signal_router.add(*signal)
|
|
||||||
|
|
||||||
def dispatch(
|
def dispatch(
|
||||||
self,
|
self,
|
||||||
@@ -1357,14 +1349,12 @@ class Sanic(StaticHandleMixin, BaseSanic, StartupMixin, metaclass=TouchUpMeta):
|
|||||||
three arguments: scope, receive, send. See the ASGI reference for more
|
three arguments: scope, receive, send. See the ASGI reference for more
|
||||||
details: https://asgi.readthedocs.io/en/latest
|
details: https://asgi.readthedocs.io/en/latest
|
||||||
"""
|
"""
|
||||||
|
self.asgi = True
|
||||||
if scope["type"] == "lifespan":
|
if scope["type"] == "lifespan":
|
||||||
self.asgi = True
|
|
||||||
self.motd("")
|
self.motd("")
|
||||||
self._asgi_lifespan = Lifespan(self, scope, receive, send)
|
self._asgi_app = await ASGIApp.create(self, scope, receive, send)
|
||||||
await self._asgi_lifespan()
|
asgi_app = self._asgi_app
|
||||||
else:
|
await asgi_app()
|
||||||
self._asgi_app = await ASGIApp.create(self, scope, receive, send)
|
|
||||||
await self._asgi_app()
|
|
||||||
|
|
||||||
_asgi_single_callable = True # We conform to ASGI 3.0 single-callable
|
_asgi_single_callable = True # We conform to ASGI 3.0 single-callable
|
||||||
|
|
||||||
@@ -1525,27 +1515,6 @@ class Sanic(StaticHandleMixin, BaseSanic, StartupMixin, metaclass=TouchUpMeta):
|
|||||||
# Lifecycle
|
# Lifecycle
|
||||||
# -------------------------------------------------------------------- #
|
# -------------------------------------------------------------------- #
|
||||||
|
|
||||||
@contextmanager
|
|
||||||
def amend(self) -> Iterator[None]:
|
|
||||||
"""
|
|
||||||
If the application has started, this function allows changes
|
|
||||||
to be made to add routes, middleware, and signals.
|
|
||||||
"""
|
|
||||||
if not self.state.is_started:
|
|
||||||
yield
|
|
||||||
else:
|
|
||||||
do_router = self.router.finalized
|
|
||||||
do_signal_router = self.signal_router.finalized
|
|
||||||
if do_router:
|
|
||||||
self.router.reset()
|
|
||||||
if do_signal_router:
|
|
||||||
self.signal_router.reset()
|
|
||||||
yield
|
|
||||||
if do_signal_router:
|
|
||||||
self.signalize(self.config.TOUCHUP)
|
|
||||||
if do_router:
|
|
||||||
self.finalize()
|
|
||||||
|
|
||||||
def finalize(self):
|
def finalize(self):
|
||||||
try:
|
try:
|
||||||
self.router.finalize()
|
self.router.finalize()
|
||||||
@@ -1579,20 +1548,17 @@ class Sanic(StaticHandleMixin, BaseSanic, StartupMixin, metaclass=TouchUpMeta):
|
|||||||
self.signalize(self.config.TOUCHUP)
|
self.signalize(self.config.TOUCHUP)
|
||||||
self.finalize()
|
self.finalize()
|
||||||
|
|
||||||
route_names = [route.extra.ident for route in self.router.routes]
|
route_names = [route.name for route in self.router.routes]
|
||||||
duplicates = {
|
duplicates = {
|
||||||
name for name in route_names if route_names.count(name) > 1
|
name for name in route_names if route_names.count(name) > 1
|
||||||
}
|
}
|
||||||
if duplicates:
|
if duplicates:
|
||||||
names = ", ".join(duplicates)
|
names = ", ".join(duplicates)
|
||||||
message = (
|
deprecation(
|
||||||
f"Duplicate route names detected: {names}. You should rename "
|
f"Duplicate route names detected: {names}. In the future, "
|
||||||
"one or more of them explicitly by using the `name` param, "
|
"Sanic will enforce uniqueness in route naming.",
|
||||||
"or changing the implicit name derived from the class and "
|
23.3,
|
||||||
"function name. For more details, please see "
|
|
||||||
"https://sanic.dev/en/guide/release-notes/v23.3.html#duplicated-route-names-are-no-longer-allowed" # noqa
|
|
||||||
)
|
)
|
||||||
raise ServerError(message)
|
|
||||||
|
|
||||||
Sanic._check_uvloop_conflict()
|
Sanic._check_uvloop_conflict()
|
||||||
|
|
||||||
|
|||||||
193
sanic/asgi.py
193
sanic/asgi.py
@@ -3,9 +3,10 @@ from __future__ import annotations
|
|||||||
import warnings
|
import warnings
|
||||||
|
|
||||||
from typing import TYPE_CHECKING, Optional
|
from typing import TYPE_CHECKING, Optional
|
||||||
|
from urllib.parse import quote
|
||||||
|
|
||||||
from sanic.compat import Header
|
from sanic.compat import Header
|
||||||
from sanic.exceptions import BadRequest, ServerError
|
from sanic.exceptions import ServerError
|
||||||
from sanic.helpers import Default
|
from sanic.helpers import Default
|
||||||
from sanic.http import Stage
|
from sanic.http import Stage
|
||||||
from sanic.log import error_logger, logger
|
from sanic.log import error_logger, logger
|
||||||
@@ -21,15 +22,13 @@ if TYPE_CHECKING:
|
|||||||
|
|
||||||
|
|
||||||
class Lifespan:
|
class Lifespan:
|
||||||
def __init__(
|
def __init__(self, asgi_app: ASGIApp) -> None:
|
||||||
self, sanic_app, scope: ASGIScope, receive: ASGIReceive, send: ASGISend
|
self.asgi_app = asgi_app
|
||||||
) -> None:
|
|
||||||
self.sanic_app = sanic_app
|
|
||||||
self.scope = scope
|
|
||||||
self.receive = receive
|
|
||||||
self.send = send
|
|
||||||
|
|
||||||
if "server.init.before" in self.sanic_app.signal_router.name_index:
|
if (
|
||||||
|
"server.init.before"
|
||||||
|
in self.asgi_app.sanic_app.signal_router.name_index
|
||||||
|
):
|
||||||
logger.debug(
|
logger.debug(
|
||||||
'You have set a listener for "before_server_start" '
|
'You have set a listener for "before_server_start" '
|
||||||
"in ASGI mode. "
|
"in ASGI mode. "
|
||||||
@@ -37,7 +36,10 @@ class Lifespan:
|
|||||||
"the ASGI server is started.",
|
"the ASGI server is started.",
|
||||||
extra={"verbosity": 1},
|
extra={"verbosity": 1},
|
||||||
)
|
)
|
||||||
if "server.shutdown.after" in self.sanic_app.signal_router.name_index:
|
if (
|
||||||
|
"server.shutdown.after"
|
||||||
|
in self.asgi_app.sanic_app.signal_router.name_index
|
||||||
|
):
|
||||||
logger.debug(
|
logger.debug(
|
||||||
'You have set a listener for "after_server_stop" '
|
'You have set a listener for "after_server_stop" '
|
||||||
"in ASGI mode. "
|
"in ASGI mode. "
|
||||||
@@ -55,11 +57,11 @@ class Lifespan:
|
|||||||
in sequence since the ASGI lifespan protocol only supports a single
|
in sequence since the ASGI lifespan protocol only supports a single
|
||||||
startup event.
|
startup event.
|
||||||
"""
|
"""
|
||||||
await self.sanic_app._startup()
|
await self.asgi_app.sanic_app._startup()
|
||||||
await self.sanic_app._server_event("init", "before")
|
await self.asgi_app.sanic_app._server_event("init", "before")
|
||||||
await self.sanic_app._server_event("init", "after")
|
await self.asgi_app.sanic_app._server_event("init", "after")
|
||||||
|
|
||||||
if not isinstance(self.sanic_app.config.USE_UVLOOP, Default):
|
if not isinstance(self.asgi_app.sanic_app.config.USE_UVLOOP, 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."
|
||||||
@@ -75,33 +77,35 @@ class Lifespan:
|
|||||||
in sequence since the ASGI lifespan protocol only supports a single
|
in sequence since the ASGI lifespan protocol only supports a single
|
||||||
shutdown event.
|
shutdown event.
|
||||||
"""
|
"""
|
||||||
await self.sanic_app._server_event("shutdown", "before")
|
await self.asgi_app.sanic_app._server_event("shutdown", "before")
|
||||||
await self.sanic_app._server_event("shutdown", "after")
|
await self.asgi_app.sanic_app._server_event("shutdown", "after")
|
||||||
|
|
||||||
async def __call__(self) -> None:
|
async def __call__(
|
||||||
while True:
|
self, scope: ASGIScope, receive: ASGIReceive, send: ASGISend
|
||||||
message = await self.receive()
|
) -> None:
|
||||||
if message["type"] == "lifespan.startup":
|
message = await receive()
|
||||||
try:
|
if message["type"] == "lifespan.startup":
|
||||||
await self.startup()
|
try:
|
||||||
except Exception as e:
|
await self.startup()
|
||||||
error_logger.exception(e)
|
except Exception as e:
|
||||||
await self.send(
|
error_logger.exception(e)
|
||||||
{"type": "lifespan.startup.failed", "message": str(e)}
|
await send(
|
||||||
)
|
{"type": "lifespan.startup.failed", "message": str(e)}
|
||||||
else:
|
)
|
||||||
await self.send({"type": "lifespan.startup.complete"})
|
else:
|
||||||
elif message["type"] == "lifespan.shutdown":
|
await send({"type": "lifespan.startup.complete"})
|
||||||
try:
|
|
||||||
await self.shutdown()
|
message = await receive()
|
||||||
except Exception as e:
|
if message["type"] == "lifespan.shutdown":
|
||||||
error_logger.exception(e)
|
try:
|
||||||
await self.send(
|
await self.shutdown()
|
||||||
{"type": "lifespan.shutdown.failed", "message": str(e)}
|
except Exception as e:
|
||||||
)
|
error_logger.exception(e)
|
||||||
else:
|
await send(
|
||||||
await self.send({"type": "lifespan.shutdown.complete"})
|
{"type": "lifespan.shutdown.failed", "message": str(e)}
|
||||||
return
|
)
|
||||||
|
else:
|
||||||
|
await send({"type": "lifespan.shutdown.complete"})
|
||||||
|
|
||||||
|
|
||||||
class ASGIApp:
|
class ASGIApp:
|
||||||
@@ -113,78 +117,73 @@ class ASGIApp:
|
|||||||
stage: Stage
|
stage: Stage
|
||||||
response: Optional[BaseHTTPResponse]
|
response: Optional[BaseHTTPResponse]
|
||||||
|
|
||||||
|
def __init__(self) -> None:
|
||||||
|
self.ws = None
|
||||||
|
|
||||||
@classmethod
|
@classmethod
|
||||||
async def create(
|
async def create(
|
||||||
cls,
|
cls, sanic_app, scope: ASGIScope, receive: ASGIReceive, send: ASGISend
|
||||||
sanic_app: Sanic,
|
) -> "ASGIApp":
|
||||||
scope: ASGIScope,
|
|
||||||
receive: ASGIReceive,
|
|
||||||
send: ASGISend,
|
|
||||||
) -> ASGIApp:
|
|
||||||
instance = cls()
|
instance = cls()
|
||||||
instance.ws = None
|
|
||||||
instance.sanic_app = sanic_app
|
instance.sanic_app = sanic_app
|
||||||
instance.transport = MockTransport(scope, receive, send)
|
instance.transport = MockTransport(scope, receive, send)
|
||||||
instance.transport.loop = sanic_app.loop
|
instance.transport.loop = sanic_app.loop
|
||||||
instance.stage = Stage.IDLE
|
instance.stage = Stage.IDLE
|
||||||
instance.response = None
|
instance.response = None
|
||||||
instance.sanic_app.state.is_started = True
|
|
||||||
setattr(instance.transport, "add_task", sanic_app.loop.create_task)
|
setattr(instance.transport, "add_task", sanic_app.loop.create_task)
|
||||||
|
|
||||||
try:
|
headers = Header(
|
||||||
headers = Header(
|
[
|
||||||
[
|
(key.decode("latin-1"), value.decode("latin-1"))
|
||||||
(
|
for key, value in scope.get("headers", [])
|
||||||
key.decode("ASCII"),
|
]
|
||||||
value.decode(errors="surrogateescape"),
|
)
|
||||||
)
|
instance.lifespan = Lifespan(instance)
|
||||||
for key, value in scope.get("headers", [])
|
|
||||||
]
|
|
||||||
)
|
|
||||||
except UnicodeDecodeError:
|
|
||||||
raise BadRequest(
|
|
||||||
"Header names can only contain US-ASCII characters"
|
|
||||||
)
|
|
||||||
|
|
||||||
if scope["type"] == "http":
|
if scope["type"] == "lifespan":
|
||||||
version = scope["http_version"]
|
await instance.lifespan(scope, receive, send)
|
||||||
method = scope["method"]
|
|
||||||
elif scope["type"] == "websocket":
|
|
||||||
version = "1.1"
|
|
||||||
method = "GET"
|
|
||||||
|
|
||||||
instance.ws = instance.transport.create_websocket_connection(
|
|
||||||
send, receive
|
|
||||||
)
|
|
||||||
else:
|
else:
|
||||||
raise ServerError("Received unknown ASGI scope")
|
path = (
|
||||||
|
scope["path"][1:]
|
||||||
|
if scope["path"].startswith("/")
|
||||||
|
else scope["path"]
|
||||||
|
)
|
||||||
|
url = "/".join([scope.get("root_path", ""), quote(path)])
|
||||||
|
url_bytes = url.encode("latin-1")
|
||||||
|
url_bytes += b"?" + scope["query_string"]
|
||||||
|
|
||||||
url_bytes, query = scope["raw_path"], scope["query_string"]
|
if scope["type"] == "http":
|
||||||
if query:
|
version = scope["http_version"]
|
||||||
# httpx ASGI client sends query string as part of raw_path
|
method = scope["method"]
|
||||||
url_bytes = url_bytes.split(b"?", 1)[0]
|
elif scope["type"] == "websocket":
|
||||||
# All servers send them separately
|
version = "1.1"
|
||||||
url_bytes = b"%b?%b" % (url_bytes, query)
|
method = "GET"
|
||||||
|
|
||||||
request_class = sanic_app.request_class or Request
|
instance.ws = instance.transport.create_websocket_connection(
|
||||||
instance.request = request_class(
|
send, receive
|
||||||
url_bytes,
|
)
|
||||||
headers,
|
else:
|
||||||
version,
|
raise ServerError("Received unknown ASGI scope")
|
||||||
method,
|
|
||||||
instance.transport,
|
|
||||||
sanic_app,
|
|
||||||
)
|
|
||||||
instance.request.stream = instance # type: ignore
|
|
||||||
instance.request_body = True
|
|
||||||
instance.request.conn_info = ConnInfo(instance.transport)
|
|
||||||
|
|
||||||
await instance.sanic_app.dispatch(
|
request_class = sanic_app.request_class or Request
|
||||||
"http.lifecycle.request",
|
instance.request = request_class(
|
||||||
inline=True,
|
url_bytes,
|
||||||
context={"request": instance.request},
|
headers,
|
||||||
fail_not_found=False,
|
version,
|
||||||
)
|
method,
|
||||||
|
instance.transport,
|
||||||
|
sanic_app,
|
||||||
|
)
|
||||||
|
instance.request.stream = instance
|
||||||
|
instance.request_body = True
|
||||||
|
instance.request.conn_info = ConnInfo(instance.transport)
|
||||||
|
|
||||||
|
await sanic_app.dispatch(
|
||||||
|
"http.lifecycle.request",
|
||||||
|
inline=True,
|
||||||
|
context={"request": instance.request},
|
||||||
|
fail_not_found=False,
|
||||||
|
)
|
||||||
|
|
||||||
return instance
|
return instance
|
||||||
|
|
||||||
|
|||||||
@@ -93,7 +93,6 @@ class Blueprint(BaseSanic):
|
|||||||
"_future_listeners",
|
"_future_listeners",
|
||||||
"_future_exceptions",
|
"_future_exceptions",
|
||||||
"_future_signals",
|
"_future_signals",
|
||||||
"copied_from",
|
|
||||||
"ctx",
|
"ctx",
|
||||||
"exceptions",
|
"exceptions",
|
||||||
"host",
|
"host",
|
||||||
@@ -119,7 +118,6 @@ class Blueprint(BaseSanic):
|
|||||||
):
|
):
|
||||||
super().__init__(name=name)
|
super().__init__(name=name)
|
||||||
self.reset()
|
self.reset()
|
||||||
self.copied_from = ""
|
|
||||||
self.ctx = SimpleNamespace()
|
self.ctx = SimpleNamespace()
|
||||||
self.host = host
|
self.host = host
|
||||||
self.strict_slashes = strict_slashes
|
self.strict_slashes = strict_slashes
|
||||||
@@ -215,7 +213,6 @@ class Blueprint(BaseSanic):
|
|||||||
self.reset()
|
self.reset()
|
||||||
new_bp = deepcopy(self)
|
new_bp = deepcopy(self)
|
||||||
new_bp.name = name
|
new_bp.name = name
|
||||||
new_bp.copied_from = self.name
|
|
||||||
|
|
||||||
if not isinstance(url_prefix, Default):
|
if not isinstance(url_prefix, Default):
|
||||||
new_bp.url_prefix = url_prefix
|
new_bp.url_prefix = url_prefix
|
||||||
@@ -355,16 +352,6 @@ class Blueprint(BaseSanic):
|
|||||||
|
|
||||||
registered.add(apply_route)
|
registered.add(apply_route)
|
||||||
route = app._apply_route(apply_route)
|
route = app._apply_route(apply_route)
|
||||||
|
|
||||||
# If it is a copied BP, then make sure all of the names of routes
|
|
||||||
# matchup with the new BP name
|
|
||||||
if self.copied_from:
|
|
||||||
for r in route:
|
|
||||||
r.name = r.name.replace(self.copied_from, self.name)
|
|
||||||
r.extra.ident = r.extra.ident.replace(
|
|
||||||
self.copied_from, self.name
|
|
||||||
)
|
|
||||||
|
|
||||||
operation = (
|
operation = (
|
||||||
routes.extend if isinstance(route, list) else routes.append
|
routes.extend if isinstance(route, list) else routes.append
|
||||||
)
|
)
|
||||||
|
|||||||
18
sanic/breaking/__init__.py
Normal file
18
sanic/breaking/__init__.py
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
from sanic.__version__ import __compatibility__
|
||||||
|
|
||||||
|
if __compatibility__ == "22.12":
|
||||||
|
from .v22_12.request import (
|
||||||
|
File,
|
||||||
|
Request,
|
||||||
|
RequestParameters,
|
||||||
|
parse_multipart_form,
|
||||||
|
)
|
||||||
|
elif __compatibility__ == "23.3":
|
||||||
|
from .v23_3.request import (
|
||||||
|
File,
|
||||||
|
Request,
|
||||||
|
RequestParameters,
|
||||||
|
parse_multipart_form,
|
||||||
|
)
|
||||||
|
else:
|
||||||
|
raise RuntimeError(f"Unknown compatibility value: {__compatibility__}")
|
||||||
0
sanic/breaking/v22_12/__init__.py
Normal file
0
sanic/breaking/v22_12/__init__.py
Normal file
@@ -8,10 +8,10 @@ from typing import (
|
|||||||
DefaultDict,
|
DefaultDict,
|
||||||
Dict,
|
Dict,
|
||||||
List,
|
List,
|
||||||
|
NamedTuple,
|
||||||
Optional,
|
Optional,
|
||||||
Tuple,
|
Tuple,
|
||||||
Union,
|
Union,
|
||||||
cast,
|
|
||||||
)
|
)
|
||||||
|
|
||||||
from sanic_routing.route import Route
|
from sanic_routing.route import Route
|
||||||
@@ -21,16 +21,17 @@ from sanic.http.stream import Stream
|
|||||||
from sanic.models.asgi import ASGIScope
|
from sanic.models.asgi import ASGIScope
|
||||||
from sanic.models.http_types import Credentials
|
from sanic.models.http_types import Credentials
|
||||||
|
|
||||||
|
|
||||||
if TYPE_CHECKING:
|
if TYPE_CHECKING:
|
||||||
from sanic.server import ConnInfo
|
from sanic.server import ConnInfo
|
||||||
from sanic.app import Sanic
|
from sanic.app import Sanic
|
||||||
|
|
||||||
|
import email.utils
|
||||||
|
import unicodedata
|
||||||
import uuid
|
import uuid
|
||||||
|
|
||||||
from collections import defaultdict
|
from collections import defaultdict
|
||||||
|
from http.cookies import SimpleCookie
|
||||||
from types import SimpleNamespace
|
from types import SimpleNamespace
|
||||||
from urllib.parse import parse_qs, parse_qsl, urlunparse
|
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
|
||||||
@@ -42,7 +43,6 @@ from sanic.constants import (
|
|||||||
IDEMPOTENT_HTTP_METHODS,
|
IDEMPOTENT_HTTP_METHODS,
|
||||||
SAFE_HTTP_METHODS,
|
SAFE_HTTP_METHODS,
|
||||||
)
|
)
|
||||||
from sanic.cookies.request import CookieRequestParameters, parse_cookie
|
|
||||||
from sanic.exceptions import BadRequest, BadURL, ServerError
|
from sanic.exceptions import BadRequest, BadURL, ServerError
|
||||||
from sanic.headers import (
|
from sanic.headers import (
|
||||||
AcceptList,
|
AcceptList,
|
||||||
@@ -55,20 +55,35 @@ from sanic.headers import (
|
|||||||
parse_xforwarded,
|
parse_xforwarded,
|
||||||
)
|
)
|
||||||
from sanic.http import Stage
|
from sanic.http import Stage
|
||||||
from sanic.log import error_logger
|
from sanic.log import deprecation, error_logger, logger
|
||||||
from sanic.models.protocol_types import TransportProtocol
|
from sanic.models.protocol_types import TransportProtocol
|
||||||
from sanic.response import BaseHTTPResponse, HTTPResponse
|
from sanic.response import BaseHTTPResponse, HTTPResponse
|
||||||
|
|
||||||
from .form import parse_multipart_form
|
|
||||||
from .parameters import RequestParameters
|
|
||||||
|
|
||||||
|
|
||||||
try:
|
try:
|
||||||
from ujson import loads as json_loads # type: ignore
|
from ujson import loads as json_loads # type: ignore
|
||||||
except ImportError:
|
except ImportError:
|
||||||
from json import loads as json_loads # type: ignore
|
from json import loads as json_loads # type: ignore
|
||||||
|
|
||||||
|
|
||||||
|
class RequestParameters(dict):
|
||||||
|
"""
|
||||||
|
Hosts a dict with lists as values where get returns the first
|
||||||
|
value of the list and getlist returns the whole shebang
|
||||||
|
"""
|
||||||
|
|
||||||
|
def get(self, name: str, default: Optional[Any] = None) -> Optional[Any]:
|
||||||
|
"""Return the first value, either the default or actual"""
|
||||||
|
return super().get(name, [default])[0]
|
||||||
|
|
||||||
|
def getlist(
|
||||||
|
self, name: str, default: Optional[Any] = None
|
||||||
|
) -> Optional[Any]:
|
||||||
|
"""
|
||||||
|
Return the entire list
|
||||||
|
"""
|
||||||
|
return super().get(name, default)
|
||||||
|
|
||||||
|
|
||||||
class Request:
|
class Request:
|
||||||
"""
|
"""
|
||||||
Properties of an HTTP request such as URL, headers, etc.
|
Properties of an HTTP request such as URL, headers, etc.
|
||||||
@@ -102,7 +117,6 @@ class Request:
|
|||||||
"method",
|
"method",
|
||||||
"parsed_accept",
|
"parsed_accept",
|
||||||
"parsed_args",
|
"parsed_args",
|
||||||
"parsed_cookies",
|
|
||||||
"parsed_credentials",
|
"parsed_credentials",
|
||||||
"parsed_files",
|
"parsed_files",
|
||||||
"parsed_form",
|
"parsed_form",
|
||||||
@@ -133,8 +147,7 @@ class Request:
|
|||||||
try:
|
try:
|
||||||
self._parsed_url = parse_url(url_bytes)
|
self._parsed_url = parse_url(url_bytes)
|
||||||
except HttpParserInvalidURLError:
|
except HttpParserInvalidURLError:
|
||||||
url = url_bytes.decode(errors="backslashreplace")
|
raise BadURL(f"Bad URL: {url_bytes.decode()}")
|
||||||
raise BadURL(f"Bad URL: {url}")
|
|
||||||
self._id: Optional[Union[uuid.UUID, str, int]] = None
|
self._id: Optional[Union[uuid.UUID, str, int]] = None
|
||||||
self._name: Optional[str] = None
|
self._name: Optional[str] = None
|
||||||
self._stream_id = stream_id
|
self._stream_id = stream_id
|
||||||
@@ -150,25 +163,25 @@ class Request:
|
|||||||
self.body = b""
|
self.body = b""
|
||||||
self.conn_info: Optional[ConnInfo] = None
|
self.conn_info: Optional[ConnInfo] = None
|
||||||
self.ctx = SimpleNamespace()
|
self.ctx = SimpleNamespace()
|
||||||
|
self.parsed_forwarded: Optional[Options] = None
|
||||||
self.parsed_accept: Optional[AcceptList] = None
|
self.parsed_accept: Optional[AcceptList] = None
|
||||||
|
self.parsed_credentials: Optional[Credentials] = None
|
||||||
|
self.parsed_json = None
|
||||||
|
self.parsed_form: Optional[RequestParameters] = None
|
||||||
|
self.parsed_files: Optional[RequestParameters] = None
|
||||||
|
self.parsed_token: Optional[str] = None
|
||||||
self.parsed_args: DefaultDict[
|
self.parsed_args: DefaultDict[
|
||||||
Tuple[bool, bool, str, str], RequestParameters
|
Tuple[bool, bool, str, str], RequestParameters
|
||||||
] = defaultdict(RequestParameters)
|
] = defaultdict(RequestParameters)
|
||||||
self.parsed_cookies: Optional[RequestParameters] = None
|
|
||||||
self.parsed_credentials: Optional[Credentials] = None
|
|
||||||
self.parsed_files: Optional[RequestParameters] = None
|
|
||||||
self.parsed_form: Optional[RequestParameters] = None
|
|
||||||
self.parsed_forwarded: Optional[Options] = None
|
|
||||||
self.parsed_json = None
|
|
||||||
self.parsed_not_grouped_args: DefaultDict[
|
self.parsed_not_grouped_args: DefaultDict[
|
||||||
Tuple[bool, bool, str, str], List[Tuple[str, str]]
|
Tuple[bool, bool, str, str], List[Tuple[str, str]]
|
||||||
] = defaultdict(list)
|
] = defaultdict(list)
|
||||||
self.parsed_token: Optional[str] = None
|
|
||||||
self._request_middleware_started = False
|
self._request_middleware_started = False
|
||||||
self._response_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._cookies: Optional[Dict[str, str]] = None
|
||||||
self._match_info: Dict[str, Any] = {}
|
self._match_info: Dict[str, Any] = {}
|
||||||
self._protocol = None
|
self._protocol = None
|
||||||
|
|
||||||
@@ -205,6 +218,16 @@ class Request:
|
|||||||
def generate_id(*_):
|
def generate_id(*_):
|
||||||
return uuid.uuid4()
|
return uuid.uuid4()
|
||||||
|
|
||||||
|
@property
|
||||||
|
def request_middleware_started(self):
|
||||||
|
deprecation(
|
||||||
|
"Request.request_middleware_started has been deprecated and will"
|
||||||
|
"be removed. You should set a flag on the request context using"
|
||||||
|
"either middleware or signals if you need this feature.",
|
||||||
|
23.3,
|
||||||
|
)
|
||||||
|
return self._request_middleware_started
|
||||||
|
|
||||||
@property
|
@property
|
||||||
def stream_id(self):
|
def stream_id(self):
|
||||||
"""
|
"""
|
||||||
@@ -705,21 +728,24 @@ class Request:
|
|||||||
default values.
|
default values.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
def get_cookies(self) -> RequestParameters:
|
|
||||||
cookie = self.headers.getone("cookie", "")
|
|
||||||
self.parsed_cookies = CookieRequestParameters(parse_cookie(cookie))
|
|
||||||
return self.parsed_cookies
|
|
||||||
|
|
||||||
@property
|
@property
|
||||||
def cookies(self) -> RequestParameters:
|
def cookies(self) -> Dict[str, str]:
|
||||||
"""
|
"""
|
||||||
:return: Incoming cookies on the request
|
:return: Incoming cookies on the request
|
||||||
:rtype: Dict[str, str]
|
:rtype: Dict[str, str]
|
||||||
"""
|
"""
|
||||||
|
|
||||||
if self.parsed_cookies is None:
|
if self._cookies is None:
|
||||||
self.get_cookies()
|
cookie = self.headers.getone("cookie", None)
|
||||||
return cast(CookieRequestParameters, self.parsed_cookies)
|
if cookie is not None:
|
||||||
|
cookies: SimpleCookie = SimpleCookie()
|
||||||
|
cookies.load(cookie)
|
||||||
|
self._cookies = {
|
||||||
|
name: cookie.value for name, cookie in cookies.items()
|
||||||
|
}
|
||||||
|
else:
|
||||||
|
self._cookies = {}
|
||||||
|
return self._cookies
|
||||||
|
|
||||||
@property
|
@property
|
||||||
def content_type(self) -> str:
|
def content_type(self) -> str:
|
||||||
@@ -997,3 +1023,101 @@ class Request:
|
|||||||
:rtype: bool
|
:rtype: bool
|
||||||
"""
|
"""
|
||||||
return self.method in CACHEABLE_HTTP_METHODS
|
return self.method in CACHEABLE_HTTP_METHODS
|
||||||
|
|
||||||
|
|
||||||
|
class File(NamedTuple):
|
||||||
|
"""
|
||||||
|
Model for defining a file. It is a ``namedtuple``, therefore you can
|
||||||
|
iterate over the object, or access the parameters by name.
|
||||||
|
|
||||||
|
:param type: The mimetype, defaults to text/plain
|
||||||
|
:param body: Bytes of the file
|
||||||
|
:param name: The filename
|
||||||
|
"""
|
||||||
|
|
||||||
|
type: str
|
||||||
|
body: bytes
|
||||||
|
name: str
|
||||||
|
|
||||||
|
|
||||||
|
def parse_multipart_form(body, boundary):
|
||||||
|
"""
|
||||||
|
Parse a request body and returns fields and files
|
||||||
|
|
||||||
|
:param body: bytes request body
|
||||||
|
:param boundary: bytes multipart boundary
|
||||||
|
:return: fields (RequestParameters), files (RequestParameters)
|
||||||
|
"""
|
||||||
|
files = RequestParameters()
|
||||||
|
fields = RequestParameters()
|
||||||
|
|
||||||
|
form_parts = body.split(boundary)
|
||||||
|
for form_part in form_parts[1:-1]:
|
||||||
|
file_name = None
|
||||||
|
content_type = "text/plain"
|
||||||
|
content_charset = "utf-8"
|
||||||
|
field_name = None
|
||||||
|
line_index = 2
|
||||||
|
line_end_index = 0
|
||||||
|
while not line_end_index == -1:
|
||||||
|
line_end_index = form_part.find(b"\r\n", line_index)
|
||||||
|
form_line = form_part[line_index:line_end_index].decode("utf-8")
|
||||||
|
line_index = line_end_index + 2
|
||||||
|
|
||||||
|
if not form_line:
|
||||||
|
break
|
||||||
|
|
||||||
|
colon_index = form_line.index(":")
|
||||||
|
idx = colon_index + 2
|
||||||
|
form_header_field = form_line[0:colon_index].lower()
|
||||||
|
form_header_value, form_parameters = parse_content_header(
|
||||||
|
form_line[idx:]
|
||||||
|
)
|
||||||
|
|
||||||
|
if form_header_field == "content-disposition":
|
||||||
|
field_name = form_parameters.get("name")
|
||||||
|
file_name = form_parameters.get("filename")
|
||||||
|
|
||||||
|
# non-ASCII filenames in RFC2231, "filename*" format
|
||||||
|
if file_name is None and form_parameters.get("filename*"):
|
||||||
|
encoding, _, value = email.utils.decode_rfc2231(
|
||||||
|
form_parameters["filename*"]
|
||||||
|
)
|
||||||
|
file_name = unquote(value, encoding=encoding)
|
||||||
|
|
||||||
|
# Normalize to NFC (Apple MacOS/iOS send NFD)
|
||||||
|
# Notes:
|
||||||
|
# - No effect for Windows, Linux or Android clients which
|
||||||
|
# already send NFC
|
||||||
|
# - Python open() is tricky (creates files in NFC no matter
|
||||||
|
# which form you use)
|
||||||
|
if file_name is not None:
|
||||||
|
file_name = unicodedata.normalize("NFC", file_name)
|
||||||
|
|
||||||
|
elif form_header_field == "content-type":
|
||||||
|
content_type = form_header_value
|
||||||
|
content_charset = form_parameters.get("charset", "utf-8")
|
||||||
|
|
||||||
|
if field_name:
|
||||||
|
post_data = form_part[line_index:-4]
|
||||||
|
if file_name is None:
|
||||||
|
value = post_data.decode(content_charset)
|
||||||
|
if field_name in fields:
|
||||||
|
fields[field_name].append(value)
|
||||||
|
else:
|
||||||
|
fields[field_name] = [value]
|
||||||
|
else:
|
||||||
|
form_file = File(
|
||||||
|
type=content_type, name=file_name, body=post_data
|
||||||
|
)
|
||||||
|
if field_name in files:
|
||||||
|
files[field_name].append(form_file)
|
||||||
|
else:
|
||||||
|
files[field_name] = [form_file]
|
||||||
|
else:
|
||||||
|
logger.debug(
|
||||||
|
"Form-data field does not have a 'name' parameter "
|
||||||
|
"in the Content-Disposition header"
|
||||||
|
)
|
||||||
|
|
||||||
|
return fields, files
|
||||||
0
sanic/breaking/v23_3/__init__.py
Normal file
0
sanic/breaking/v23_3/__init__.py
Normal file
9
sanic/breaking/v23_3/request.py
Normal file
9
sanic/breaking/v23_3/request.py
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
from ..v22_12.request import File
|
||||||
|
from ..v22_12.request import Request as LegacyRequest
|
||||||
|
from ..v22_12.request import RequestParameters, parse_multipart_form
|
||||||
|
|
||||||
|
|
||||||
|
class Request(LegacyRequest):
|
||||||
|
@property
|
||||||
|
def something_new(self):
|
||||||
|
return 123
|
||||||
@@ -1,3 +1,4 @@
|
|||||||
|
import logging
|
||||||
import os
|
import os
|
||||||
import shutil
|
import shutil
|
||||||
import sys
|
import sys
|
||||||
@@ -5,7 +6,7 @@ import sys
|
|||||||
from argparse import Namespace
|
from argparse import Namespace
|
||||||
from functools import partial
|
from functools import partial
|
||||||
from textwrap import indent
|
from textwrap import indent
|
||||||
from typing import List, Union
|
from typing import List, Union, cast
|
||||||
|
|
||||||
from sanic.app import Sanic
|
from sanic.app import Sanic
|
||||||
from sanic.application.logo import get_logo
|
from sanic.application.logo import get_logo
|
||||||
@@ -13,7 +14,7 @@ from sanic.cli.arguments import Group
|
|||||||
from sanic.cli.base import SanicArgumentParser, SanicHelpFormatter
|
from sanic.cli.base import SanicArgumentParser, SanicHelpFormatter
|
||||||
from sanic.cli.inspector import make_inspector_parser
|
from sanic.cli.inspector import make_inspector_parser
|
||||||
from sanic.cli.inspector_client import InspectorClient
|
from sanic.cli.inspector_client import InspectorClient
|
||||||
from sanic.log import error_logger
|
from sanic.log import Colors, error_logger
|
||||||
from sanic.worker.loader import AppLoader
|
from sanic.worker.loader import AppLoader
|
||||||
|
|
||||||
|
|
||||||
@@ -23,22 +24,17 @@ class SanicCLI:
|
|||||||
{get_logo(True)}
|
{get_logo(True)}
|
||||||
|
|
||||||
To start running a Sanic application, provide a path to the module, where
|
To start running a Sanic application, provide a path to the module, where
|
||||||
app is a Sanic() instance in the global scope:
|
app is a Sanic() instance:
|
||||||
|
|
||||||
$ sanic path.to.server:app
|
$ sanic path.to.server:app
|
||||||
|
|
||||||
If the Sanic instance variable is called 'app', you can leave off the last
|
|
||||||
part, and only provide a path to the module where the instance is:
|
|
||||||
|
|
||||||
$ sanic path.to.server
|
|
||||||
|
|
||||||
Or, a path to a callable that returns a Sanic() instance:
|
Or, a path to a callable that returns a Sanic() instance:
|
||||||
|
|
||||||
$ sanic path.to.factory:create_app
|
$ sanic path.to.factory:create_app --factory
|
||||||
|
|
||||||
Or, a path to a directory to run as a simple HTTP server:
|
Or, a path to a directory to run as a simple HTTP server:
|
||||||
|
|
||||||
$ sanic ./path/to/static
|
$ sanic ./path/to/static --simple
|
||||||
""",
|
""",
|
||||||
prefix=" ",
|
prefix=" ",
|
||||||
)
|
)
|
||||||
@@ -99,9 +95,13 @@ Or, a path to a directory to run as a simple HTTP server:
|
|||||||
self.args = self.parser.parse_args(args=parse_args)
|
self.args = self.parser.parse_args(args=parse_args)
|
||||||
self._precheck()
|
self._precheck()
|
||||||
app_loader = AppLoader(
|
app_loader = AppLoader(
|
||||||
self.args.target, self.args.factory, self.args.simple, self.args
|
self.args.module, self.args.factory, self.args.simple, self.args
|
||||||
)
|
)
|
||||||
|
|
||||||
|
if self.args.inspect or self.args.inspect_raw or self.args.trigger:
|
||||||
|
self._inspector_legacy(app_loader)
|
||||||
|
return
|
||||||
|
|
||||||
try:
|
try:
|
||||||
app = self._get_app(app_loader)
|
app = self._get_app(app_loader)
|
||||||
kwargs = self._build_run_kwargs()
|
kwargs = self._build_run_kwargs()
|
||||||
@@ -112,10 +112,38 @@ Or, a path to a directory to run as a simple HTTP server:
|
|||||||
app.prepare(**kwargs, version=http_version)
|
app.prepare(**kwargs, version=http_version)
|
||||||
if self.args.single:
|
if self.args.single:
|
||||||
serve = Sanic.serve_single
|
serve = Sanic.serve_single
|
||||||
|
elif self.args.legacy:
|
||||||
|
serve = Sanic.serve_legacy
|
||||||
else:
|
else:
|
||||||
serve = partial(Sanic.serve, app_loader=app_loader)
|
serve = partial(Sanic.serve, app_loader=app_loader)
|
||||||
serve(app)
|
serve(app)
|
||||||
|
|
||||||
|
def _inspector_legacy(self, app_loader: AppLoader):
|
||||||
|
host = port = None
|
||||||
|
module = cast(str, self.args.module)
|
||||||
|
if ":" in module:
|
||||||
|
maybe_host, maybe_port = module.rsplit(":", 1)
|
||||||
|
if maybe_port.isnumeric():
|
||||||
|
host, port = maybe_host, int(maybe_port)
|
||||||
|
if not host:
|
||||||
|
app = self._get_app(app_loader)
|
||||||
|
host, port = app.config.INSPECTOR_HOST, app.config.INSPECTOR_PORT
|
||||||
|
|
||||||
|
action = self.args.trigger or "info"
|
||||||
|
|
||||||
|
InspectorClient(
|
||||||
|
str(host), int(port or 6457), False, self.args.inspect_raw, ""
|
||||||
|
).do(action)
|
||||||
|
sys.stdout.write(
|
||||||
|
f"\n{Colors.BOLD}{Colors.YELLOW}WARNING:{Colors.END} "
|
||||||
|
"You are using the legacy CLI command that will be removed in "
|
||||||
|
f"{Colors.RED}v23.3{Colors.END}. See "
|
||||||
|
"https://sanic.dev/en/guide/release-notes/v22.12.html"
|
||||||
|
"#deprecations-and-removals or checkout the new "
|
||||||
|
"style commands:\n\n\t"
|
||||||
|
f"{Colors.YELLOW}sanic inspect --help{Colors.END}\n"
|
||||||
|
)
|
||||||
|
|
||||||
def _inspector(self):
|
def _inspector(self):
|
||||||
args = sys.argv[2:]
|
args = sys.argv[2:]
|
||||||
self.args, unknown = self.parser.parse_known_args(args=args)
|
self.args, unknown = self.parser.parse_known_args(args=args)
|
||||||
@@ -169,6 +197,8 @@ Or, a path to a directory to run as a simple HTTP server:
|
|||||||
)
|
)
|
||||||
error_logger.error(message)
|
error_logger.error(message)
|
||||||
sys.exit(1)
|
sys.exit(1)
|
||||||
|
if self.args.inspect or self.args.inspect_raw:
|
||||||
|
logging.disable(logging.CRITICAL)
|
||||||
|
|
||||||
def _get_app(self, app_loader: AppLoader):
|
def _get_app(self, app_loader: AppLoader):
|
||||||
try:
|
try:
|
||||||
@@ -216,6 +246,7 @@ Or, a path to a directory to run as a simple HTTP server:
|
|||||||
"workers": self.args.workers,
|
"workers": self.args.workers,
|
||||||
"auto_tls": self.args.auto_tls,
|
"auto_tls": self.args.auto_tls,
|
||||||
"single_process": self.args.single,
|
"single_process": self.args.single,
|
||||||
|
"legacy": self.args.legacy,
|
||||||
}
|
}
|
||||||
|
|
||||||
for maybe_arg in ("auto_reload", "dev"):
|
for maybe_arg in ("auto_reload", "dev"):
|
||||||
|
|||||||
@@ -57,15 +57,11 @@ class GeneralGroup(Group):
|
|||||||
)
|
)
|
||||||
|
|
||||||
self.container.add_argument(
|
self.container.add_argument(
|
||||||
"target",
|
"module",
|
||||||
help=(
|
help=(
|
||||||
"Path to your Sanic app instance.\n"
|
"Path to your Sanic app. Example: path.to.server:app\n"
|
||||||
"\tExample: path.to.server:app\n"
|
"If running a Simple Server, path to directory to serve. "
|
||||||
"If running a Simple Server, path to directory to serve.\n"
|
"Example: ./\n"
|
||||||
"\tExample: ./\n"
|
|
||||||
"Additionally, this can be a path to a factory function\n"
|
|
||||||
"that returns a Sanic app instance.\n"
|
|
||||||
"\tExample: path.to.server:create_app\n"
|
|
||||||
),
|
),
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -93,6 +89,32 @@ class ApplicationGroup(Group):
|
|||||||
"a directory\n(module arg should be a path)"
|
"a directory\n(module arg should be a path)"
|
||||||
),
|
),
|
||||||
)
|
)
|
||||||
|
group.add_argument(
|
||||||
|
"--inspect",
|
||||||
|
dest="inspect",
|
||||||
|
action="store_true",
|
||||||
|
help=("Inspect the state of a running instance, human readable"),
|
||||||
|
)
|
||||||
|
group.add_argument(
|
||||||
|
"--inspect-raw",
|
||||||
|
dest="inspect_raw",
|
||||||
|
action="store_true",
|
||||||
|
help=("Inspect the state of a running instance, JSON output"),
|
||||||
|
)
|
||||||
|
group.add_argument(
|
||||||
|
"--trigger-reload",
|
||||||
|
dest="trigger",
|
||||||
|
action="store_const",
|
||||||
|
const="reload",
|
||||||
|
help=("Trigger worker processes to reload"),
|
||||||
|
)
|
||||||
|
group.add_argument(
|
||||||
|
"--trigger-shutdown",
|
||||||
|
dest="trigger",
|
||||||
|
action="store_const",
|
||||||
|
const="shutdown",
|
||||||
|
help=("Trigger all processes to shutdown"),
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
class HTTPVersionGroup(Group):
|
class HTTPVersionGroup(Group):
|
||||||
@@ -221,6 +243,11 @@ class WorkerGroup(Group):
|
|||||||
action="store_true",
|
action="store_true",
|
||||||
help="Do not use multiprocessing, run server in a single process",
|
help="Do not use multiprocessing, run server in a single process",
|
||||||
)
|
)
|
||||||
|
self.container.add_argument(
|
||||||
|
"--legacy",
|
||||||
|
action="store_true",
|
||||||
|
help="Use the legacy server manager",
|
||||||
|
)
|
||||||
self.add_bool_arguments(
|
self.add_bool_arguments(
|
||||||
"--access-logs",
|
"--access-logs",
|
||||||
dest="access_log",
|
dest="access_log",
|
||||||
|
|||||||
156
sanic/cookies.py
Normal file
156
sanic/cookies.py
Normal file
@@ -0,0 +1,156 @@
|
|||||||
|
import re
|
||||||
|
import string
|
||||||
|
|
||||||
|
from datetime import datetime
|
||||||
|
from typing import Dict
|
||||||
|
|
||||||
|
|
||||||
|
DEFAULT_MAX_AGE = 0
|
||||||
|
|
||||||
|
# ------------------------------------------------------------ #
|
||||||
|
# SimpleCookie
|
||||||
|
# ------------------------------------------------------------ #
|
||||||
|
|
||||||
|
# Straight up copied this section of dark magic from SimpleCookie
|
||||||
|
|
||||||
|
_LegalChars = string.ascii_letters + string.digits + "!#$%&'*+-.^_`|~:"
|
||||||
|
_UnescapedChars = _LegalChars + " ()/<=>?@[]{}"
|
||||||
|
|
||||||
|
_Translator = {
|
||||||
|
n: "\\%03o" % n for n in set(range(256)) - set(map(ord, _UnescapedChars))
|
||||||
|
}
|
||||||
|
_Translator.update({ord('"'): '\\"', ord("\\"): "\\\\"})
|
||||||
|
|
||||||
|
|
||||||
|
def _quote(str):
|
||||||
|
r"""Quote a string for use in a cookie header.
|
||||||
|
If the string does not need to be double-quoted, then just return the
|
||||||
|
string. Otherwise, surround the string in doublequotes and quote
|
||||||
|
(with a \) special characters.
|
||||||
|
"""
|
||||||
|
if str is None or _is_legal_key(str):
|
||||||
|
return str
|
||||||
|
else:
|
||||||
|
return '"' + str.translate(_Translator) + '"'
|
||||||
|
|
||||||
|
|
||||||
|
_is_legal_key = re.compile("[%s]+" % re.escape(_LegalChars)).fullmatch
|
||||||
|
|
||||||
|
# ------------------------------------------------------------ #
|
||||||
|
# Custom SimpleCookie
|
||||||
|
# ------------------------------------------------------------ #
|
||||||
|
|
||||||
|
|
||||||
|
class CookieJar(dict):
|
||||||
|
"""
|
||||||
|
CookieJar dynamically writes headers as cookies are added and removed
|
||||||
|
It gets around the limitation of one header per name by using the
|
||||||
|
MultiHeader class to provide a unique key that encodes to Set-Cookie.
|
||||||
|
"""
|
||||||
|
|
||||||
|
def __init__(self, headers):
|
||||||
|
super().__init__()
|
||||||
|
self.headers: Dict[str, str] = headers
|
||||||
|
self.cookie_headers: Dict[str, str] = {}
|
||||||
|
self.header_key: str = "Set-Cookie"
|
||||||
|
|
||||||
|
def __setitem__(self, key, value):
|
||||||
|
# If this cookie doesn't exist, add it to the header keys
|
||||||
|
if not self.cookie_headers.get(key):
|
||||||
|
cookie = Cookie(key, value)
|
||||||
|
cookie["path"] = "/"
|
||||||
|
self.cookie_headers[key] = self.header_key
|
||||||
|
self.headers.add(self.header_key, cookie)
|
||||||
|
return super().__setitem__(key, cookie)
|
||||||
|
else:
|
||||||
|
self[key].value = value
|
||||||
|
|
||||||
|
def __delitem__(self, key):
|
||||||
|
if key not in self.cookie_headers:
|
||||||
|
self[key] = ""
|
||||||
|
self[key]["max-age"] = 0
|
||||||
|
else:
|
||||||
|
cookie_header = self.cookie_headers[key]
|
||||||
|
# remove it from header
|
||||||
|
cookies = self.headers.popall(cookie_header)
|
||||||
|
for cookie in cookies:
|
||||||
|
if cookie.key != key:
|
||||||
|
self.headers.add(cookie_header, cookie)
|
||||||
|
del self.cookie_headers[key]
|
||||||
|
return super().__delitem__(key)
|
||||||
|
|
||||||
|
|
||||||
|
class Cookie(dict):
|
||||||
|
"""A stripped down version of Morsel from SimpleCookie #gottagofast"""
|
||||||
|
|
||||||
|
_keys = {
|
||||||
|
"expires": "expires",
|
||||||
|
"path": "Path",
|
||||||
|
"comment": "Comment",
|
||||||
|
"domain": "Domain",
|
||||||
|
"max-age": "Max-Age",
|
||||||
|
"secure": "Secure",
|
||||||
|
"httponly": "HttpOnly",
|
||||||
|
"version": "Version",
|
||||||
|
"samesite": "SameSite",
|
||||||
|
}
|
||||||
|
_flags = {"secure", "httponly"}
|
||||||
|
|
||||||
|
def __init__(self, key, value):
|
||||||
|
if key in self._keys:
|
||||||
|
raise KeyError("Cookie name is a reserved word")
|
||||||
|
if not _is_legal_key(key):
|
||||||
|
raise KeyError("Cookie key contains illegal characters")
|
||||||
|
self.key = key
|
||||||
|
self.value = value
|
||||||
|
super().__init__()
|
||||||
|
|
||||||
|
def __setitem__(self, key, value):
|
||||||
|
if key not in self._keys:
|
||||||
|
raise KeyError("Unknown cookie property")
|
||||||
|
if value is not False:
|
||||||
|
if key.lower() == "max-age":
|
||||||
|
if not str(value).isdigit():
|
||||||
|
raise ValueError("Cookie max-age must be an integer")
|
||||||
|
elif key.lower() == "expires":
|
||||||
|
if not isinstance(value, datetime):
|
||||||
|
raise TypeError(
|
||||||
|
"Cookie 'expires' property must be a datetime"
|
||||||
|
)
|
||||||
|
return super().__setitem__(key, value)
|
||||||
|
|
||||||
|
def encode(self, encoding):
|
||||||
|
"""
|
||||||
|
Encode the cookie content in a specific type of encoding instructed
|
||||||
|
by the developer. Leverages the :func:`str.encode` method provided
|
||||||
|
by python.
|
||||||
|
|
||||||
|
This method can be used to encode and embed ``utf-8`` content into
|
||||||
|
the cookies.
|
||||||
|
|
||||||
|
:param encoding: Encoding to be used with the cookie
|
||||||
|
:return: Cookie encoded in a codec of choosing.
|
||||||
|
:except: UnicodeEncodeError
|
||||||
|
"""
|
||||||
|
return str(self).encode(encoding)
|
||||||
|
|
||||||
|
def __str__(self):
|
||||||
|
"""Format as a Set-Cookie header value."""
|
||||||
|
output = ["%s=%s" % (self.key, _quote(self.value))]
|
||||||
|
for key, value in self.items():
|
||||||
|
if key == "max-age":
|
||||||
|
try:
|
||||||
|
output.append("%s=%d" % (self._keys[key], value))
|
||||||
|
except TypeError:
|
||||||
|
output.append("%s=%s" % (self._keys[key], value))
|
||||||
|
elif key == "expires":
|
||||||
|
output.append(
|
||||||
|
"%s=%s"
|
||||||
|
% (self._keys[key], value.strftime("%a, %d-%b-%Y %T GMT"))
|
||||||
|
)
|
||||||
|
elif key in self._flags and self[key]:
|
||||||
|
output.append(self._keys[key])
|
||||||
|
else:
|
||||||
|
output.append("%s=%s" % (self._keys[key], value))
|
||||||
|
|
||||||
|
return "; ".join(output)
|
||||||
@@ -1,4 +0,0 @@
|
|||||||
from .response import Cookie, CookieJar
|
|
||||||
|
|
||||||
|
|
||||||
__all__ = ("Cookie", "CookieJar")
|
|
||||||
@@ -1,119 +0,0 @@
|
|||||||
import re
|
|
||||||
|
|
||||||
from typing import Any, Dict, List, Optional
|
|
||||||
|
|
||||||
from sanic.cookies.response import Cookie
|
|
||||||
from sanic.log import deprecation
|
|
||||||
from sanic.request.parameters import RequestParameters
|
|
||||||
|
|
||||||
|
|
||||||
COOKIE_NAME_RESERVED_CHARS = re.compile(
|
|
||||||
'[\x00-\x1F\x7F-\xFF()<>@,;:\\\\"/[\\]?={} \x09]'
|
|
||||||
)
|
|
||||||
OCTAL_PATTERN = re.compile(r"\\[0-3][0-7][0-7]")
|
|
||||||
QUOTE_PATTERN = re.compile(r"[\\].")
|
|
||||||
|
|
||||||
|
|
||||||
def _unquote(str): # no cov
|
|
||||||
if str is None or len(str) < 2:
|
|
||||||
return str
|
|
||||||
if str[0] != '"' or str[-1] != '"':
|
|
||||||
return str
|
|
||||||
|
|
||||||
str = str[1:-1]
|
|
||||||
|
|
||||||
i = 0
|
|
||||||
n = len(str)
|
|
||||||
res = []
|
|
||||||
while 0 <= i < n:
|
|
||||||
o_match = OCTAL_PATTERN.search(str, i)
|
|
||||||
q_match = QUOTE_PATTERN.search(str, i)
|
|
||||||
if not o_match and not q_match:
|
|
||||||
res.append(str[i:])
|
|
||||||
break
|
|
||||||
# else:
|
|
||||||
j = k = -1
|
|
||||||
if o_match:
|
|
||||||
j = o_match.start(0)
|
|
||||||
if q_match:
|
|
||||||
k = q_match.start(0)
|
|
||||||
if q_match and (not o_match or k < j):
|
|
||||||
res.append(str[i:k])
|
|
||||||
res.append(str[k + 1])
|
|
||||||
i = k + 2
|
|
||||||
else:
|
|
||||||
res.append(str[i:j])
|
|
||||||
res.append(chr(int(str[j + 1 : j + 4], 8))) # noqa: E203
|
|
||||||
i = j + 4
|
|
||||||
return "".join(res)
|
|
||||||
|
|
||||||
|
|
||||||
def parse_cookie(raw: str):
|
|
||||||
cookies: Dict[str, List] = {}
|
|
||||||
|
|
||||||
for token in raw.split(";"):
|
|
||||||
name, __, value = token.partition("=")
|
|
||||||
name = name.strip()
|
|
||||||
value = value.strip()
|
|
||||||
|
|
||||||
if not name:
|
|
||||||
continue
|
|
||||||
|
|
||||||
if COOKIE_NAME_RESERVED_CHARS.search(name): # no cov
|
|
||||||
continue
|
|
||||||
|
|
||||||
if len(value) > 2 and value[0] == '"' and value[-1] == '"': # no cov
|
|
||||||
value = _unquote(value)
|
|
||||||
|
|
||||||
if name in cookies:
|
|
||||||
cookies[name].append(value)
|
|
||||||
else:
|
|
||||||
cookies[name] = [value]
|
|
||||||
|
|
||||||
return cookies
|
|
||||||
|
|
||||||
|
|
||||||
class CookieRequestParameters(RequestParameters):
|
|
||||||
def __getitem__(self, key: str) -> Optional[str]:
|
|
||||||
deprecation(
|
|
||||||
f"You are accessing cookie key '{key}', which is currently in "
|
|
||||||
"compat mode returning a single cookie value. Starting in v24.3 "
|
|
||||||
"accessing a cookie value like this will return a list of values. "
|
|
||||||
"To avoid this behavior and continue accessing a single value, "
|
|
||||||
f"please upgrade from request.cookies['{key}'] to "
|
|
||||||
f"request.cookies.get('{key}'). See more details: "
|
|
||||||
"https://sanic.dev/en/guide/release-notes/v23.3.html#request-cookies", # noqa
|
|
||||||
24.3,
|
|
||||||
)
|
|
||||||
try:
|
|
||||||
value = self._get_prefixed_cookie(key)
|
|
||||||
except KeyError:
|
|
||||||
value = super().__getitem__(key)
|
|
||||||
return value[0]
|
|
||||||
|
|
||||||
def __getattr__(self, key: str) -> str:
|
|
||||||
if key.startswith("_"):
|
|
||||||
return self.__getattribute__(key)
|
|
||||||
key = key.rstrip("_").replace("_", "-")
|
|
||||||
return str(self.get(key, ""))
|
|
||||||
|
|
||||||
def get(self, name: str, default: Optional[Any] = None) -> Optional[Any]:
|
|
||||||
try:
|
|
||||||
return self._get_prefixed_cookie(name)[0]
|
|
||||||
except KeyError:
|
|
||||||
return super().get(name, default)
|
|
||||||
|
|
||||||
def getlist(
|
|
||||||
self, name: str, default: Optional[Any] = None
|
|
||||||
) -> Optional[Any]:
|
|
||||||
try:
|
|
||||||
return self._get_prefixed_cookie(name)
|
|
||||||
except KeyError:
|
|
||||||
return super().getlist(name, default)
|
|
||||||
|
|
||||||
def _get_prefixed_cookie(self, name: str) -> Any:
|
|
||||||
getitem = super().__getitem__
|
|
||||||
try:
|
|
||||||
return getitem(f"{Cookie.HOST_PREFIX}{name}")
|
|
||||||
except KeyError:
|
|
||||||
return getitem(f"{Cookie.SECURE_PREFIX}{name}")
|
|
||||||
@@ -1,617 +0,0 @@
|
|||||||
from __future__ import annotations
|
|
||||||
|
|
||||||
import re
|
|
||||||
import string
|
|
||||||
import sys
|
|
||||||
|
|
||||||
from datetime import datetime
|
|
||||||
from typing import TYPE_CHECKING, Any, Dict, List, Optional, Union
|
|
||||||
|
|
||||||
from sanic.exceptions import ServerError
|
|
||||||
from sanic.log import deprecation
|
|
||||||
|
|
||||||
|
|
||||||
if TYPE_CHECKING:
|
|
||||||
from sanic.compat import Header
|
|
||||||
|
|
||||||
if sys.version_info < (3, 8): # no cov
|
|
||||||
SameSite = str
|
|
||||||
else: # no cov
|
|
||||||
from typing import Literal
|
|
||||||
|
|
||||||
SameSite = Union[
|
|
||||||
Literal["Strict"],
|
|
||||||
Literal["Lax"],
|
|
||||||
Literal["None"],
|
|
||||||
Literal["strict"],
|
|
||||||
Literal["lax"],
|
|
||||||
Literal["none"],
|
|
||||||
]
|
|
||||||
|
|
||||||
DEFAULT_MAX_AGE = 0
|
|
||||||
SAMESITE_VALUES = ("strict", "lax", "none")
|
|
||||||
|
|
||||||
LEGAL_CHARS = string.ascii_letters + string.digits + "!#$%&'*+-.^_`|~:"
|
|
||||||
UNESCAPED_CHARS = LEGAL_CHARS + " ()/<=>?@[]{}"
|
|
||||||
TRANSLATOR = {ch: f"\\{ch:03o}" for ch in bytes(range(32)) + b'";\\\x7F'}
|
|
||||||
|
|
||||||
|
|
||||||
def _quote(str): # no cov
|
|
||||||
r"""Quote a string for use in a cookie header.
|
|
||||||
If the string does not need to be double-quoted, then just return the
|
|
||||||
string. Otherwise, surround the string in doublequotes and quote
|
|
||||||
(with a \) special characters.
|
|
||||||
"""
|
|
||||||
if str is None or _is_legal_key(str):
|
|
||||||
return str
|
|
||||||
else:
|
|
||||||
return f'"{str.translate(TRANSLATOR)}"'
|
|
||||||
|
|
||||||
|
|
||||||
_is_legal_key = re.compile("[%s]+" % re.escape(LEGAL_CHARS)).fullmatch
|
|
||||||
|
|
||||||
|
|
||||||
# In v24.3, we should remove this as being a subclass of dict
|
|
||||||
class CookieJar(dict):
|
|
||||||
"""
|
|
||||||
CookieJar dynamically writes headers as cookies are added and removed
|
|
||||||
It gets around the limitation of one header per name by using the
|
|
||||||
MultiHeader class to provide a unique key that encodes to Set-Cookie.
|
|
||||||
"""
|
|
||||||
|
|
||||||
HEADER_KEY = "Set-Cookie"
|
|
||||||
|
|
||||||
def __init__(self, headers: Header):
|
|
||||||
super().__init__()
|
|
||||||
self.headers = headers
|
|
||||||
|
|
||||||
def __setitem__(self, key, value):
|
|
||||||
# If this cookie doesn't exist, add it to the header keys
|
|
||||||
deprecation(
|
|
||||||
"Setting cookie values using the dict pattern has been "
|
|
||||||
"deprecated. You should instead use the cookies.add_cookie "
|
|
||||||
"method. To learn more, please see: "
|
|
||||||
"https://sanic.dev/en/guide/release-notes/v23.3.html#response-cookies", # noqa
|
|
||||||
0,
|
|
||||||
)
|
|
||||||
if key not in self:
|
|
||||||
self.add_cookie(key, value, secure=False, samesite=None)
|
|
||||||
else:
|
|
||||||
self[key].value = value
|
|
||||||
|
|
||||||
def __delitem__(self, key):
|
|
||||||
deprecation(
|
|
||||||
"Deleting cookie values using the dict pattern has been "
|
|
||||||
"deprecated. You should instead use the cookies.delete_cookie "
|
|
||||||
"method. To learn more, please see: "
|
|
||||||
"https://sanic.dev/en/guide/release-notes/v23.3.html#response-cookies", # noqa
|
|
||||||
0,
|
|
||||||
)
|
|
||||||
if key in self:
|
|
||||||
super().__delitem__(key)
|
|
||||||
self.delete_cookie(key)
|
|
||||||
|
|
||||||
def __len__(self): # no cov
|
|
||||||
return len(self.cookies)
|
|
||||||
|
|
||||||
def __getitem__(self, key: str) -> Cookie:
|
|
||||||
deprecation(
|
|
||||||
"Accessing cookies from the CookieJar by dict key is deprecated. "
|
|
||||||
"You should instead use the cookies.get_cookie method. "
|
|
||||||
"To learn more, please see: "
|
|
||||||
"https://sanic.dev/en/guide/release-notes/v23.3.html#response-cookies", # noqa
|
|
||||||
0,
|
|
||||||
)
|
|
||||||
return super().__getitem__(key)
|
|
||||||
|
|
||||||
def __iter__(self): # no cov
|
|
||||||
deprecation(
|
|
||||||
"Iterating over the CookieJar has been deprecated and will be "
|
|
||||||
"removed in v24.3. To learn more, please see: "
|
|
||||||
"https://sanic.dev/en/guide/release-notes/v23.3.html#response-cookies", # noqa
|
|
||||||
24.3,
|
|
||||||
)
|
|
||||||
return super().__iter__()
|
|
||||||
|
|
||||||
def keys(self): # no cov
|
|
||||||
deprecation(
|
|
||||||
"Accessing CookieJar.keys() has been deprecated and will be "
|
|
||||||
"removed in v24.3. To learn more, please see: "
|
|
||||||
"https://sanic.dev/en/guide/release-notes/v23.3.html#response-cookies", # noqa
|
|
||||||
24.3,
|
|
||||||
)
|
|
||||||
return super().keys()
|
|
||||||
|
|
||||||
def values(self): # no cov
|
|
||||||
deprecation(
|
|
||||||
"Accessing CookieJar.values() has been deprecated and will be "
|
|
||||||
"removed in v24.3. To learn more, please see: "
|
|
||||||
"https://sanic.dev/en/guide/release-notes/v23.3.html#response-cookies", # noqa
|
|
||||||
24.3,
|
|
||||||
)
|
|
||||||
return super().values()
|
|
||||||
|
|
||||||
def items(self): # no cov
|
|
||||||
deprecation(
|
|
||||||
"Accessing CookieJar.items() has been deprecated and will be "
|
|
||||||
"removed in v24.3. To learn more, please see: "
|
|
||||||
"https://sanic.dev/en/guide/release-notes/v23.3.html#response-cookies", # noqa
|
|
||||||
24.3,
|
|
||||||
)
|
|
||||||
return super().items()
|
|
||||||
|
|
||||||
def get(self, *args, **kwargs): # no cov
|
|
||||||
deprecation(
|
|
||||||
"Accessing cookies from the CookieJar using get is deprecated "
|
|
||||||
"and will be removed in v24.3. You should instead use the "
|
|
||||||
"cookies.get_cookie method. To learn more, please see: "
|
|
||||||
"https://sanic.dev/en/guide/release-notes/v23.3.html#response-cookies", # noqa
|
|
||||||
24.3,
|
|
||||||
)
|
|
||||||
return super().get(*args, **kwargs)
|
|
||||||
|
|
||||||
def pop(self, key, *args, **kwargs): # no cov
|
|
||||||
deprecation(
|
|
||||||
"Using CookieJar.pop() has been deprecated and will be "
|
|
||||||
"removed in v24.3. To learn more, please see: "
|
|
||||||
"https://sanic.dev/en/guide/release-notes/v23.3.html#response-cookies", # noqa
|
|
||||||
24.3,
|
|
||||||
)
|
|
||||||
self.delete(key)
|
|
||||||
return super().pop(key, *args, **kwargs)
|
|
||||||
|
|
||||||
@property
|
|
||||||
def header_key(self): # no cov
|
|
||||||
deprecation(
|
|
||||||
"The CookieJar.header_key property has been deprecated and will "
|
|
||||||
"be removed in version 24.3. Use CookieJar.HEADER_KEY. ",
|
|
||||||
24.3,
|
|
||||||
)
|
|
||||||
return CookieJar.HEADER_KEY
|
|
||||||
|
|
||||||
@property
|
|
||||||
def cookie_headers(self) -> Dict[str, str]: # no cov
|
|
||||||
deprecation(
|
|
||||||
"The CookieJar.coookie_headers property has been deprecated "
|
|
||||||
"and will be removed in version 24.3. If you need to check if a "
|
|
||||||
"particular cookie key has been set, use CookieJar.has_cookie.",
|
|
||||||
24.3,
|
|
||||||
)
|
|
||||||
return {key: self.header_key for key in self}
|
|
||||||
|
|
||||||
@property
|
|
||||||
def cookies(self) -> List[Cookie]:
|
|
||||||
return self.headers.getall(self.HEADER_KEY)
|
|
||||||
|
|
||||||
def get_cookie(
|
|
||||||
self,
|
|
||||||
key: str,
|
|
||||||
path: str = "/",
|
|
||||||
domain: Optional[str] = None,
|
|
||||||
host_prefix: bool = False,
|
|
||||||
secure_prefix: bool = False,
|
|
||||||
) -> Optional[Cookie]:
|
|
||||||
for cookie in self.cookies:
|
|
||||||
if (
|
|
||||||
cookie.key == Cookie.make_key(key, host_prefix, secure_prefix)
|
|
||||||
and cookie.path == path
|
|
||||||
and cookie.domain == domain
|
|
||||||
):
|
|
||||||
return cookie
|
|
||||||
return None
|
|
||||||
|
|
||||||
def has_cookie(
|
|
||||||
self,
|
|
||||||
key: str,
|
|
||||||
path: str = "/",
|
|
||||||
domain: Optional[str] = None,
|
|
||||||
host_prefix: bool = False,
|
|
||||||
secure_prefix: bool = False,
|
|
||||||
) -> bool:
|
|
||||||
for cookie in self.cookies:
|
|
||||||
if (
|
|
||||||
cookie.key == Cookie.make_key(key, host_prefix, secure_prefix)
|
|
||||||
and cookie.path == path
|
|
||||||
and cookie.domain == domain
|
|
||||||
):
|
|
||||||
return True
|
|
||||||
return False
|
|
||||||
|
|
||||||
def add_cookie(
|
|
||||||
self,
|
|
||||||
key: str,
|
|
||||||
value: str,
|
|
||||||
*,
|
|
||||||
path: str = "/",
|
|
||||||
domain: Optional[str] = None,
|
|
||||||
secure: bool = True,
|
|
||||||
max_age: Optional[int] = None,
|
|
||||||
expires: Optional[datetime] = None,
|
|
||||||
httponly: bool = False,
|
|
||||||
samesite: Optional[SameSite] = "Lax",
|
|
||||||
partitioned: bool = False,
|
|
||||||
comment: Optional[str] = None,
|
|
||||||
host_prefix: bool = False,
|
|
||||||
secure_prefix: bool = False,
|
|
||||||
) -> Cookie:
|
|
||||||
"""
|
|
||||||
Add a cookie to the CookieJar
|
|
||||||
|
|
||||||
:param key: Key of the cookie
|
|
||||||
:type key: str
|
|
||||||
:param value: Value of the cookie
|
|
||||||
:type value: str
|
|
||||||
:param path: Path of the cookie, defaults to None
|
|
||||||
:type path: Optional[str], optional
|
|
||||||
:param domain: Domain of the cookie, defaults to None
|
|
||||||
:type domain: Optional[str], optional
|
|
||||||
:param secure: Whether to set it as a secure cookie, defaults to True
|
|
||||||
:type secure: bool
|
|
||||||
:param max_age: Max age of the cookie in seconds; if set to 0 a
|
|
||||||
browser should delete it, defaults to None
|
|
||||||
:type max_age: Optional[int], optional
|
|
||||||
:param expires: When the cookie expires; if set to None browsers
|
|
||||||
should set it as a session cookie, defaults to None
|
|
||||||
:type expires: Optional[datetime], optional
|
|
||||||
:param httponly: Whether to set it as HTTP only, defaults to False
|
|
||||||
:type httponly: bool
|
|
||||||
:param samesite: How to set the samesite property, should be
|
|
||||||
strict, lax or none (case insensitive), defaults to Lax
|
|
||||||
:type samesite: Optional[SameSite], optional
|
|
||||||
:param partitioned: Whether to set it as partitioned, defaults to False
|
|
||||||
:type partitioned: bool
|
|
||||||
:param comment: A cookie comment, defaults to None
|
|
||||||
:type comment: Optional[str], optional
|
|
||||||
:param host_prefix: Whether to add __Host- as a prefix to the key.
|
|
||||||
This requires that path="/", domain=None, and secure=True,
|
|
||||||
defaults to False
|
|
||||||
:type host_prefix: bool
|
|
||||||
:param secure_prefix: Whether to add __Secure- as a prefix to the key.
|
|
||||||
This requires that secure=True, defaults to False
|
|
||||||
:type secure_prefix: bool
|
|
||||||
:return: The instance of the created cookie
|
|
||||||
:rtype: Cookie
|
|
||||||
"""
|
|
||||||
cookie = Cookie(
|
|
||||||
key,
|
|
||||||
value,
|
|
||||||
path=path,
|
|
||||||
expires=expires,
|
|
||||||
comment=comment,
|
|
||||||
domain=domain,
|
|
||||||
max_age=max_age,
|
|
||||||
secure=secure,
|
|
||||||
httponly=httponly,
|
|
||||||
samesite=samesite,
|
|
||||||
partitioned=partitioned,
|
|
||||||
host_prefix=host_prefix,
|
|
||||||
secure_prefix=secure_prefix,
|
|
||||||
)
|
|
||||||
self.headers.add(self.HEADER_KEY, cookie)
|
|
||||||
|
|
||||||
# This should be removed in v24.3
|
|
||||||
super().__setitem__(key, cookie)
|
|
||||||
|
|
||||||
return cookie
|
|
||||||
|
|
||||||
def delete_cookie(
|
|
||||||
self,
|
|
||||||
key: str,
|
|
||||||
*,
|
|
||||||
path: str = "/",
|
|
||||||
domain: Optional[str] = None,
|
|
||||||
host_prefix: bool = False,
|
|
||||||
secure_prefix: bool = False,
|
|
||||||
) -> None:
|
|
||||||
"""
|
|
||||||
Delete a cookie
|
|
||||||
|
|
||||||
This will effectively set it as Max-Age: 0, which a browser should
|
|
||||||
interpret it to mean: "delete the cookie".
|
|
||||||
|
|
||||||
Since it is a browser/client implementation, your results may vary
|
|
||||||
depending upon which client is being used.
|
|
||||||
|
|
||||||
:param key: The key to be deleted
|
|
||||||
:type key: str
|
|
||||||
:param path: Path of the cookie, defaults to None
|
|
||||||
:type path: Optional[str], optional
|
|
||||||
:param domain: Domain of the cookie, defaults to None
|
|
||||||
:type domain: Optional[str], optional
|
|
||||||
:param host_prefix: Whether to add __Host- as a prefix to the key.
|
|
||||||
This requires that path="/", domain=None, and secure=True,
|
|
||||||
defaults to False
|
|
||||||
:type host_prefix: bool
|
|
||||||
:param secure_prefix: Whether to add __Secure- as a prefix to the key.
|
|
||||||
This requires that secure=True, defaults to False
|
|
||||||
:type secure_prefix: bool
|
|
||||||
"""
|
|
||||||
# remove it from header
|
|
||||||
cookies: List[Cookie] = self.headers.popall(self.HEADER_KEY, [])
|
|
||||||
for cookie in cookies:
|
|
||||||
if (
|
|
||||||
cookie.key != Cookie.make_key(key, host_prefix, secure_prefix)
|
|
||||||
or cookie.path != path
|
|
||||||
or cookie.domain != domain
|
|
||||||
):
|
|
||||||
self.headers.add(self.HEADER_KEY, cookie)
|
|
||||||
|
|
||||||
# This should be removed in v24.3
|
|
||||||
try:
|
|
||||||
super().__delitem__(key)
|
|
||||||
except KeyError:
|
|
||||||
...
|
|
||||||
|
|
||||||
self.add_cookie(
|
|
||||||
key=key,
|
|
||||||
value="",
|
|
||||||
path=path,
|
|
||||||
domain=domain,
|
|
||||||
max_age=0,
|
|
||||||
samesite=None,
|
|
||||||
host_prefix=host_prefix,
|
|
||||||
secure_prefix=secure_prefix,
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
# In v24.3, we should remove this as being a subclass of dict
|
|
||||||
# Instead, it should be an object with __slots__
|
|
||||||
# All of the current property accessors should be removed in favor
|
|
||||||
# of actual slotted properties.
|
|
||||||
class Cookie(dict):
|
|
||||||
"""A stripped down version of Morsel from SimpleCookie"""
|
|
||||||
|
|
||||||
HOST_PREFIX = "__Host-"
|
|
||||||
SECURE_PREFIX = "__Secure-"
|
|
||||||
|
|
||||||
_keys = {
|
|
||||||
"path": "Path",
|
|
||||||
"comment": "Comment",
|
|
||||||
"domain": "Domain",
|
|
||||||
"max-age": "Max-Age",
|
|
||||||
"expires": "expires",
|
|
||||||
"samesite": "SameSite",
|
|
||||||
"version": "Version",
|
|
||||||
"secure": "Secure",
|
|
||||||
"httponly": "HttpOnly",
|
|
||||||
"partitioned": "Partitioned",
|
|
||||||
}
|
|
||||||
_flags = {"secure", "httponly", "partitioned"}
|
|
||||||
|
|
||||||
def __init__(
|
|
||||||
self,
|
|
||||||
key: str,
|
|
||||||
value: str,
|
|
||||||
*,
|
|
||||||
path: str = "/",
|
|
||||||
domain: Optional[str] = None,
|
|
||||||
secure: bool = True,
|
|
||||||
max_age: Optional[int] = None,
|
|
||||||
expires: Optional[datetime] = None,
|
|
||||||
httponly: bool = False,
|
|
||||||
samesite: Optional[SameSite] = "Lax",
|
|
||||||
partitioned: bool = False,
|
|
||||||
comment: Optional[str] = None,
|
|
||||||
host_prefix: bool = False,
|
|
||||||
secure_prefix: bool = False,
|
|
||||||
):
|
|
||||||
if key in self._keys:
|
|
||||||
raise KeyError("Cookie name is a reserved word")
|
|
||||||
if not _is_legal_key(key):
|
|
||||||
raise KeyError("Cookie key contains illegal characters")
|
|
||||||
if host_prefix:
|
|
||||||
if not secure:
|
|
||||||
raise ServerError(
|
|
||||||
"Cannot set host_prefix on a cookie without secure=True"
|
|
||||||
)
|
|
||||||
if path != "/":
|
|
||||||
raise ServerError(
|
|
||||||
"Cannot set host_prefix on a cookie unless path='/'"
|
|
||||||
)
|
|
||||||
if domain:
|
|
||||||
raise ServerError(
|
|
||||||
"Cannot set host_prefix on a cookie with a defined domain"
|
|
||||||
)
|
|
||||||
elif secure_prefix and not secure:
|
|
||||||
raise ServerError(
|
|
||||||
"Cannot set secure_prefix on a cookie without secure=True"
|
|
||||||
)
|
|
||||||
if partitioned and not host_prefix:
|
|
||||||
# This is technically possible, but it is not advisable so we will
|
|
||||||
# take a stand and say "don't shoot yourself in the foot"
|
|
||||||
raise ServerError(
|
|
||||||
"Cannot create a partitioned cookie without "
|
|
||||||
"also setting host_prefix=True"
|
|
||||||
)
|
|
||||||
|
|
||||||
self.key = self.make_key(key, host_prefix, secure_prefix)
|
|
||||||
self.value = value
|
|
||||||
super().__init__()
|
|
||||||
|
|
||||||
# This is a temporary solution while this object is a dict. We update
|
|
||||||
# all of the values in bulk, except for the values that have
|
|
||||||
# key-specific validation in _set_value
|
|
||||||
self.update(
|
|
||||||
{
|
|
||||||
"path": path,
|
|
||||||
"comment": comment,
|
|
||||||
"domain": domain,
|
|
||||||
"secure": secure,
|
|
||||||
"httponly": httponly,
|
|
||||||
"partitioned": partitioned,
|
|
||||||
"expires": None,
|
|
||||||
"max-age": None,
|
|
||||||
"samesite": None,
|
|
||||||
}
|
|
||||||
)
|
|
||||||
if expires is not None:
|
|
||||||
self._set_value("expires", expires)
|
|
||||||
if max_age is not None:
|
|
||||||
self._set_value("max-age", max_age)
|
|
||||||
if samesite is not None:
|
|
||||||
self._set_value("samesite", samesite)
|
|
||||||
|
|
||||||
def __setitem__(self, key, value):
|
|
||||||
deprecation(
|
|
||||||
"Setting values on a Cookie object as a dict has been deprecated. "
|
|
||||||
"This feature will be removed in v24.3. You should instead set "
|
|
||||||
f"values on cookies as object properties: cookie.{key}=... ",
|
|
||||||
24.3,
|
|
||||||
)
|
|
||||||
self._set_value(key, value)
|
|
||||||
|
|
||||||
# This is a temporary method for backwards compat and should be removed
|
|
||||||
# in v24.3 when this is no longer a dict
|
|
||||||
def _set_value(self, key: str, value: Any) -> None:
|
|
||||||
if key not in self._keys:
|
|
||||||
raise KeyError("Unknown cookie property: %s=%s" % (key, value))
|
|
||||||
|
|
||||||
if value is not None:
|
|
||||||
if key.lower() == "max-age" and not str(value).isdigit():
|
|
||||||
raise ValueError("Cookie max-age must be an integer")
|
|
||||||
elif key.lower() == "expires" and not isinstance(value, datetime):
|
|
||||||
raise TypeError("Cookie 'expires' property must be a datetime")
|
|
||||||
elif key.lower() == "samesite":
|
|
||||||
if value.lower() not in SAMESITE_VALUES:
|
|
||||||
raise TypeError(
|
|
||||||
"Cookie 'samesite' property must "
|
|
||||||
f"be one of: {','.join(SAMESITE_VALUES)}"
|
|
||||||
)
|
|
||||||
value = value.title()
|
|
||||||
|
|
||||||
super().__setitem__(key, value)
|
|
||||||
|
|
||||||
def encode(self, encoding):
|
|
||||||
"""
|
|
||||||
Encode the cookie content in a specific type of encoding instructed
|
|
||||||
by the developer. Leverages the :func:`str.encode` method provided
|
|
||||||
by python.
|
|
||||||
|
|
||||||
This method can be used to encode and embed ``utf-8`` content into
|
|
||||||
the cookies.
|
|
||||||
|
|
||||||
:param encoding: Encoding to be used with the cookie
|
|
||||||
:return: Cookie encoded in a codec of choosing.
|
|
||||||
:except: UnicodeEncodeError
|
|
||||||
"""
|
|
||||||
deprecation(
|
|
||||||
"Direct encoding of a Cookie object has been deprecated and will "
|
|
||||||
"be removed in v24.3.",
|
|
||||||
24.3,
|
|
||||||
)
|
|
||||||
return str(self).encode(encoding)
|
|
||||||
|
|
||||||
def __str__(self):
|
|
||||||
"""Format as a Set-Cookie header value."""
|
|
||||||
output = ["%s=%s" % (self.key, _quote(self.value))]
|
|
||||||
key_index = list(self._keys)
|
|
||||||
for key, value in sorted(
|
|
||||||
self.items(), key=lambda x: key_index.index(x[0])
|
|
||||||
):
|
|
||||||
if value is not None and value is not False:
|
|
||||||
if key == "max-age":
|
|
||||||
try:
|
|
||||||
output.append("%s=%d" % (self._keys[key], value))
|
|
||||||
except TypeError:
|
|
||||||
output.append("%s=%s" % (self._keys[key], value))
|
|
||||||
elif key == "expires":
|
|
||||||
output.append(
|
|
||||||
"%s=%s"
|
|
||||||
% (
|
|
||||||
self._keys[key],
|
|
||||||
value.strftime("%a, %d-%b-%Y %T GMT"),
|
|
||||||
)
|
|
||||||
)
|
|
||||||
elif key in self._flags:
|
|
||||||
output.append(self._keys[key])
|
|
||||||
else:
|
|
||||||
output.append("%s=%s" % (self._keys[key], value))
|
|
||||||
|
|
||||||
return "; ".join(output)
|
|
||||||
|
|
||||||
@property
|
|
||||||
def path(self) -> str: # no cov
|
|
||||||
return self["path"]
|
|
||||||
|
|
||||||
@path.setter
|
|
||||||
def path(self, value: str) -> None: # no cov
|
|
||||||
self._set_value("path", value)
|
|
||||||
|
|
||||||
@property
|
|
||||||
def expires(self) -> Optional[datetime]: # no cov
|
|
||||||
return self.get("expires")
|
|
||||||
|
|
||||||
@expires.setter
|
|
||||||
def expires(self, value: datetime) -> None: # no cov
|
|
||||||
self._set_value("expires", value)
|
|
||||||
|
|
||||||
@property
|
|
||||||
def comment(self) -> Optional[str]: # no cov
|
|
||||||
return self.get("comment")
|
|
||||||
|
|
||||||
@comment.setter
|
|
||||||
def comment(self, value: str) -> None: # no cov
|
|
||||||
self._set_value("comment", value)
|
|
||||||
|
|
||||||
@property
|
|
||||||
def domain(self) -> Optional[str]: # no cov
|
|
||||||
return self.get("domain")
|
|
||||||
|
|
||||||
@domain.setter
|
|
||||||
def domain(self, value: str) -> None: # no cov
|
|
||||||
self._set_value("domain", value)
|
|
||||||
|
|
||||||
@property
|
|
||||||
def max_age(self) -> Optional[int]: # no cov
|
|
||||||
return self.get("max-age")
|
|
||||||
|
|
||||||
@max_age.setter
|
|
||||||
def max_age(self, value: int) -> None: # no cov
|
|
||||||
self._set_value("max-age", value)
|
|
||||||
|
|
||||||
@property
|
|
||||||
def secure(self) -> bool: # no cov
|
|
||||||
return self.get("secure", False)
|
|
||||||
|
|
||||||
@secure.setter
|
|
||||||
def secure(self, value: bool) -> None: # no cov
|
|
||||||
self._set_value("secure", value)
|
|
||||||
|
|
||||||
@property
|
|
||||||
def httponly(self) -> bool: # no cov
|
|
||||||
return self.get("httponly", False)
|
|
||||||
|
|
||||||
@httponly.setter
|
|
||||||
def httponly(self, value: bool) -> None: # no cov
|
|
||||||
self._set_value("httponly", value)
|
|
||||||
|
|
||||||
@property
|
|
||||||
def samesite(self) -> Optional[SameSite]: # no cov
|
|
||||||
return self.get("samesite")
|
|
||||||
|
|
||||||
@samesite.setter
|
|
||||||
def samesite(self, value: SameSite) -> None: # no cov
|
|
||||||
self._set_value("samesite", value)
|
|
||||||
|
|
||||||
@property
|
|
||||||
def partitioned(self) -> bool: # no cov
|
|
||||||
return self.get("partitioned", False)
|
|
||||||
|
|
||||||
@partitioned.setter
|
|
||||||
def partitioned(self, value: bool) -> None: # no cov
|
|
||||||
self._set_value("partitioned", value)
|
|
||||||
|
|
||||||
@classmethod
|
|
||||||
def make_key(
|
|
||||||
cls, key: str, host_prefix: bool = False, secure_prefix: bool = False
|
|
||||||
) -> str:
|
|
||||||
if host_prefix and secure_prefix:
|
|
||||||
raise ServerError(
|
|
||||||
"Both host_prefix and secure_prefix were requested. "
|
|
||||||
"A cookie should have only one prefix."
|
|
||||||
)
|
|
||||||
elif host_prefix:
|
|
||||||
key = cls.HOST_PREFIX + key
|
|
||||||
elif secure_prefix:
|
|
||||||
key = cls.SECURE_PREFIX + key
|
|
||||||
return key
|
|
||||||
@@ -1,6 +1,5 @@
|
|||||||
from asyncio import CancelledError, Protocol
|
from asyncio import CancelledError
|
||||||
from os import PathLike
|
from typing import Any, Dict, Optional, Union
|
||||||
from typing import Any, Dict, Optional, Sequence, Union
|
|
||||||
|
|
||||||
from sanic.helpers import STATUS_CODES
|
from sanic.helpers import STATUS_CODES
|
||||||
|
|
||||||
@@ -10,158 +9,51 @@ class RequestCancelled(CancelledError):
|
|||||||
|
|
||||||
|
|
||||||
class ServerKilled(Exception):
|
class ServerKilled(Exception):
|
||||||
"""
|
...
|
||||||
Exception Sanic server uses when killing a server process for something
|
|
||||||
unexpected happening.
|
|
||||||
"""
|
|
||||||
|
|
||||||
|
|
||||||
class SanicException(Exception):
|
class SanicException(Exception):
|
||||||
"""
|
|
||||||
Generic exception that will generate an HTTP response when raised
|
|
||||||
in the context of a request lifecycle.
|
|
||||||
|
|
||||||
Usually it is best practice to use one of the more specific exceptions
|
|
||||||
than this generic. Even when trying to raise a 500, it is generally
|
|
||||||
preferrable to use :class:`.ServerError`
|
|
||||||
|
|
||||||
.. code-block:: python
|
|
||||||
|
|
||||||
raise SanicException(
|
|
||||||
"Something went wrong",
|
|
||||||
status_code=999,
|
|
||||||
context={
|
|
||||||
"info": "Some additional details",
|
|
||||||
},
|
|
||||||
headers={
|
|
||||||
"X-Foo": "bar"
|
|
||||||
}
|
|
||||||
)
|
|
||||||
|
|
||||||
:param message: The message to be sent to the client. If ``None``
|
|
||||||
then the appropriate HTTP response status message will be used
|
|
||||||
instead, defaults to None
|
|
||||||
:type message: Optional[Union[str, bytes]], optional
|
|
||||||
:param status_code: The HTTP response code to send, if applicable. If
|
|
||||||
``None``, then it will be 500, defaults to None
|
|
||||||
:type status_code: Optional[int], optional
|
|
||||||
:param quiet: When ``True``, the error traceback will be suppressed
|
|
||||||
from the logs, defaults to None
|
|
||||||
:type quiet: Optional[bool], optional
|
|
||||||
:param context: Additional mapping of key/value data that will be
|
|
||||||
sent to the client upon exception, defaults to None
|
|
||||||
:type context: Optional[Dict[str, Any]], optional
|
|
||||||
:param extra: Additional mapping of key/value data that will NOT be
|
|
||||||
sent to the client when in PRODUCTION mode, defaults to None
|
|
||||||
:type extra: Optional[Dict[str, Any]], optional
|
|
||||||
:param headers: Additional headers that should be sent with the HTTP
|
|
||||||
response, defaults to None
|
|
||||||
:type headers: Optional[Dict[str, Any]], optional
|
|
||||||
"""
|
|
||||||
|
|
||||||
status_code: int = 500
|
|
||||||
quiet: Optional[bool] = False
|
|
||||||
headers: Dict[str, str] = {}
|
|
||||||
message: str = ""
|
message: str = ""
|
||||||
|
|
||||||
def __init__(
|
def __init__(
|
||||||
self,
|
self,
|
||||||
message: Optional[Union[str, bytes]] = None,
|
message: Optional[Union[str, bytes]] = None,
|
||||||
status_code: Optional[int] = None,
|
status_code: Optional[int] = None,
|
||||||
*,
|
|
||||||
quiet: Optional[bool] = None,
|
quiet: Optional[bool] = None,
|
||||||
context: Optional[Dict[str, Any]] = None,
|
context: Optional[Dict[str, Any]] = None,
|
||||||
extra: Optional[Dict[str, Any]] = None,
|
extra: Optional[Dict[str, Any]] = None,
|
||||||
headers: Optional[Dict[str, Any]] = None,
|
|
||||||
) -> None:
|
) -> None:
|
||||||
self.context = context
|
self.context = context
|
||||||
self.extra = extra
|
self.extra = extra
|
||||||
status_code = status_code or getattr(
|
|
||||||
self.__class__, "status_code", None
|
|
||||||
)
|
|
||||||
quiet = quiet or getattr(self.__class__, "quiet", None)
|
|
||||||
headers = headers or getattr(self.__class__, "headers", {})
|
|
||||||
if message is None:
|
if message is None:
|
||||||
if self.message:
|
if self.message:
|
||||||
message = self.message
|
message = self.message
|
||||||
elif status_code:
|
elif status_code is not None:
|
||||||
msg: bytes = STATUS_CODES.get(status_code, b"")
|
msg: bytes = STATUS_CODES.get(status_code, b"")
|
||||||
message = msg.decode("utf8")
|
message = msg.decode("utf8")
|
||||||
|
|
||||||
super().__init__(message)
|
super().__init__(message)
|
||||||
|
|
||||||
self.status_code = status_code
|
if status_code is not None:
|
||||||
self.quiet = quiet
|
self.status_code = status_code
|
||||||
self.headers = headers
|
|
||||||
|
# quiet=None/False/True with None meaning choose by status
|
||||||
|
if quiet or quiet is None and status_code not in (None, 500):
|
||||||
|
self.quiet = True
|
||||||
|
|
||||||
|
|
||||||
class HTTPException(SanicException):
|
class NotFound(SanicException):
|
||||||
"""
|
|
||||||
A base class for other exceptions and should not be called directly.
|
|
||||||
"""
|
|
||||||
|
|
||||||
def __init__(
|
|
||||||
self,
|
|
||||||
message: Optional[Union[str, bytes]] = None,
|
|
||||||
*,
|
|
||||||
quiet: Optional[bool] = None,
|
|
||||||
context: Optional[Dict[str, Any]] = None,
|
|
||||||
extra: Optional[Dict[str, Any]] = None,
|
|
||||||
headers: Optional[Dict[str, Any]] = None,
|
|
||||||
) -> None:
|
|
||||||
super().__init__(
|
|
||||||
message,
|
|
||||||
quiet=quiet,
|
|
||||||
context=context,
|
|
||||||
extra=extra,
|
|
||||||
headers=headers,
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
class NotFound(HTTPException):
|
|
||||||
"""
|
"""
|
||||||
**Status**: 404 Not Found
|
**Status**: 404 Not Found
|
||||||
|
|
||||||
:param message: The message to be sent to the client. If ``None``
|
|
||||||
then the HTTP status 'Not Found' will be sent, defaults to None
|
|
||||||
:type message: Optional[Union[str, bytes]], optional
|
|
||||||
:param quiet: When ``True``, the error traceback will be suppressed
|
|
||||||
from the logs, defaults to None
|
|
||||||
:type quiet: Optional[bool], optional
|
|
||||||
:param context: Additional mapping of key/value data that will be
|
|
||||||
sent to the client upon exception, defaults to None
|
|
||||||
:type context: Optional[Dict[str, Any]], optional
|
|
||||||
:param extra: Additional mapping of key/value data that will NOT be
|
|
||||||
sent to the client when in PRODUCTION mode, defaults to None
|
|
||||||
:type extra: Optional[Dict[str, Any]], optional
|
|
||||||
:param headers: Additional headers that should be sent with the HTTP
|
|
||||||
response, defaults to None
|
|
||||||
:type headers: Optional[Dict[str, Any]], optional
|
|
||||||
"""
|
"""
|
||||||
|
|
||||||
status_code = 404
|
status_code = 404
|
||||||
quiet = True
|
quiet = True
|
||||||
|
|
||||||
|
|
||||||
class BadRequest(HTTPException):
|
class BadRequest(SanicException):
|
||||||
"""
|
"""
|
||||||
**Status**: 400 Bad Request
|
**Status**: 400 Bad Request
|
||||||
|
|
||||||
:param message: The message to be sent to the client. If ``None``
|
|
||||||
then the HTTP status 'Bad Request' will be sent, defaults to None
|
|
||||||
:type message: Optional[Union[str, bytes]], optional
|
|
||||||
:param quiet: When ``True``, the error traceback will be suppressed
|
|
||||||
from the logs, defaults to None
|
|
||||||
:type quiet: Optional[bool], optional
|
|
||||||
:param context: Additional mapping of key/value data that will be
|
|
||||||
sent to the client upon exception, defaults to None
|
|
||||||
:type context: Optional[Dict[str, Any]], optional
|
|
||||||
:param extra: Additional mapping of key/value data that will NOT be
|
|
||||||
sent to the client when in PRODUCTION mode, defaults to None
|
|
||||||
:type extra: Optional[Dict[str, Any]], optional
|
|
||||||
:param headers: Additional headers that should be sent with the HTTP
|
|
||||||
response, defaults to None
|
|
||||||
:type headers: Optional[Dict[str, Any]], optional
|
|
||||||
"""
|
"""
|
||||||
|
|
||||||
status_code = 400
|
status_code = 400
|
||||||
@@ -169,133 +61,51 @@ class BadRequest(HTTPException):
|
|||||||
|
|
||||||
|
|
||||||
InvalidUsage = BadRequest
|
InvalidUsage = BadRequest
|
||||||
BadURL = BadRequest
|
|
||||||
|
|
||||||
|
|
||||||
class MethodNotAllowed(HTTPException):
|
class BadURL(BadRequest):
|
||||||
|
...
|
||||||
|
|
||||||
|
|
||||||
|
class MethodNotAllowed(SanicException):
|
||||||
"""
|
"""
|
||||||
**Status**: 405 Method Not Allowed
|
**Status**: 405 Method Not Allowed
|
||||||
|
|
||||||
:param message: The message to be sent to the client. If ``None``
|
|
||||||
then the HTTP status 'Method Not Allowed' will be sent,
|
|
||||||
defaults to None
|
|
||||||
:type message: Optional[Union[str, bytes]], optional
|
|
||||||
:param method: The HTTP method that was used, defaults to an empty string
|
|
||||||
:type method: Optional[str], optional
|
|
||||||
:param allowed_methods: The HTTP methods that can be used instead of the
|
|
||||||
one that was attempted
|
|
||||||
:type allowed_methods: Optional[Sequence[str]], optional
|
|
||||||
:param quiet: When ``True``, the error traceback will be suppressed
|
|
||||||
from the logs, defaults to None
|
|
||||||
:type quiet: Optional[bool], optional
|
|
||||||
:param context: Additional mapping of key/value data that will be
|
|
||||||
sent to the client upon exception, defaults to None
|
|
||||||
:type context: Optional[Dict[str, Any]], optional
|
|
||||||
:param extra: Additional mapping of key/value data that will NOT be
|
|
||||||
sent to the client when in PRODUCTION mode, defaults to None
|
|
||||||
:type extra: Optional[Dict[str, Any]], optional
|
|
||||||
:param headers: Additional headers that should be sent with the HTTP
|
|
||||||
response, defaults to None
|
|
||||||
:type headers: Optional[Dict[str, Any]], optional
|
|
||||||
"""
|
"""
|
||||||
|
|
||||||
status_code = 405
|
status_code = 405
|
||||||
quiet = True
|
quiet = True
|
||||||
|
|
||||||
def __init__(
|
def __init__(self, message, method, allowed_methods):
|
||||||
self,
|
super().__init__(message)
|
||||||
message: Optional[Union[str, bytes]] = None,
|
self.headers = {"Allow": ", ".join(allowed_methods)}
|
||||||
method: str = "",
|
|
||||||
allowed_methods: Optional[Sequence[str]] = None,
|
|
||||||
*,
|
|
||||||
quiet: Optional[bool] = None,
|
|
||||||
context: Optional[Dict[str, Any]] = None,
|
|
||||||
extra: Optional[Dict[str, Any]] = None,
|
|
||||||
headers: Optional[Dict[str, Any]] = None,
|
|
||||||
):
|
|
||||||
super().__init__(
|
|
||||||
message,
|
|
||||||
quiet=quiet,
|
|
||||||
context=context,
|
|
||||||
extra=extra,
|
|
||||||
headers=headers,
|
|
||||||
)
|
|
||||||
if allowed_methods:
|
|
||||||
self.headers = {
|
|
||||||
**self.headers,
|
|
||||||
"Allow": ", ".join(allowed_methods),
|
|
||||||
}
|
|
||||||
self.method = method
|
|
||||||
self.allowed_methods = allowed_methods
|
|
||||||
|
|
||||||
|
|
||||||
MethodNotSupported = MethodNotAllowed
|
MethodNotSupported = MethodNotAllowed
|
||||||
|
|
||||||
|
|
||||||
class ServerError(HTTPException):
|
class ServerError(SanicException):
|
||||||
"""
|
"""
|
||||||
**Status**: 500 Internal Server Error
|
**Status**: 500 Internal Server Error
|
||||||
|
|
||||||
A general server-side error has occurred. If no other HTTP exception is
|
|
||||||
appropriate, then this should be used
|
|
||||||
|
|
||||||
:param message: The message to be sent to the client. If ``None``
|
|
||||||
then the HTTP status 'Internal Server Error' will be sent,
|
|
||||||
defaults to None
|
|
||||||
:type message: Optional[Union[str, bytes]], optional
|
|
||||||
:param quiet: When ``True``, the error traceback will be suppressed
|
|
||||||
from the logs, defaults to None
|
|
||||||
:type quiet: Optional[bool], optional
|
|
||||||
:param context: Additional mapping of key/value data that will be
|
|
||||||
sent to the client upon exception, defaults to None
|
|
||||||
:type context: Optional[Dict[str, Any]], optional
|
|
||||||
:param extra: Additional mapping of key/value data that will NOT be
|
|
||||||
sent to the client when in PRODUCTION mode, defaults to None
|
|
||||||
:type extra: Optional[Dict[str, Any]], optional
|
|
||||||
:param headers: Additional headers that should be sent with the HTTP
|
|
||||||
response, defaults to None
|
|
||||||
:type headers: Optional[Dict[str, Any]], optional
|
|
||||||
"""
|
"""
|
||||||
|
|
||||||
status_code = 500
|
status_code = 500
|
||||||
|
|
||||||
|
|
||||||
InternalServerError = ServerError
|
class ServiceUnavailable(SanicException):
|
||||||
|
|
||||||
|
|
||||||
class ServiceUnavailable(HTTPException):
|
|
||||||
"""
|
"""
|
||||||
**Status**: 503 Service Unavailable
|
**Status**: 503 Service Unavailable
|
||||||
|
|
||||||
The server is currently unavailable (because it is overloaded or
|
The server is currently unavailable (because it is overloaded or
|
||||||
down for maintenance). Generally, this is a temporary state.
|
down for maintenance). Generally, this is a temporary state.
|
||||||
|
|
||||||
:param message: The message to be sent to the client. If ``None``
|
|
||||||
then the HTTP status 'Bad Request' will be sent, defaults to None
|
|
||||||
:type message: Optional[Union[str, bytes]], optional
|
|
||||||
:param quiet: When ``True``, the error traceback will be suppressed
|
|
||||||
from the logs, defaults to None
|
|
||||||
:type quiet: Optional[bool], optional
|
|
||||||
:param context: Additional mapping of key/value data that will be
|
|
||||||
sent to the client upon exception, defaults to None
|
|
||||||
:type context: Optional[Dict[str, Any]], optional
|
|
||||||
:param extra: Additional mapping of key/value data that will NOT be
|
|
||||||
sent to the client when in PRODUCTION mode, defaults to None
|
|
||||||
:type extra: Optional[Dict[str, Any]], optional
|
|
||||||
:param headers: Additional headers that should be sent with the HTTP
|
|
||||||
response, defaults to None
|
|
||||||
:type headers: Optional[Dict[str, Any]], optional
|
|
||||||
"""
|
"""
|
||||||
|
|
||||||
status_code = 503
|
status_code = 503
|
||||||
quiet = True
|
quiet = True
|
||||||
|
|
||||||
|
|
||||||
class URLBuildError(HTTPException):
|
class URLBuildError(ServerError):
|
||||||
"""
|
"""
|
||||||
**Status**: 500 Internal Server Error
|
**Status**: 500 Internal Server Error
|
||||||
|
|
||||||
An exception used by Sanic internals when unable to build a URL.
|
|
||||||
"""
|
"""
|
||||||
|
|
||||||
status_code = 500
|
status_code = 500
|
||||||
@@ -304,77 +114,30 @@ class URLBuildError(HTTPException):
|
|||||||
class FileNotFound(NotFound):
|
class FileNotFound(NotFound):
|
||||||
"""
|
"""
|
||||||
**Status**: 404 Not Found
|
**Status**: 404 Not Found
|
||||||
|
|
||||||
A specific form of :class:`.NotFound` that is specifically when looking
|
|
||||||
for a file on the file system at a known path.
|
|
||||||
|
|
||||||
:param message: The message to be sent to the client. If ``None``
|
|
||||||
then the HTTP status 'Not Found' will be sent, defaults to None
|
|
||||||
:type message: Optional[Union[str, bytes]], optional
|
|
||||||
:param path: The path, if any, to the file that could not
|
|
||||||
be found, defaults to None
|
|
||||||
:type path: Optional[PathLike], optional
|
|
||||||
:param relative_url: A relative URL of the file, defaults to None
|
|
||||||
:type relative_url: Optional[str], optional
|
|
||||||
:param quiet: When ``True``, the error traceback will be suppressed
|
|
||||||
from the logs, defaults to None
|
|
||||||
:type quiet: Optional[bool], optional
|
|
||||||
:param context: Additional mapping of key/value data that will be
|
|
||||||
sent to the client upon exception, defaults to None
|
|
||||||
:type context: Optional[Dict[str, Any]], optional
|
|
||||||
:param extra: Additional mapping of key/value data that will NOT be
|
|
||||||
sent to the client when in PRODUCTION mode, defaults to None
|
|
||||||
:type extra: Optional[Dict[str, Any]], optional
|
|
||||||
:param headers: Additional headers that should be sent with the HTTP
|
|
||||||
response, defaults to None
|
|
||||||
:type headers: Optional[Dict[str, Any]], optional
|
|
||||||
"""
|
"""
|
||||||
|
|
||||||
def __init__(
|
def __init__(self, message, path, relative_url):
|
||||||
self,
|
super().__init__(message)
|
||||||
message: Optional[Union[str, bytes]] = None,
|
|
||||||
path: Optional[PathLike] = None,
|
|
||||||
relative_url: Optional[str] = None,
|
|
||||||
*,
|
|
||||||
quiet: Optional[bool] = None,
|
|
||||||
context: Optional[Dict[str, Any]] = None,
|
|
||||||
extra: Optional[Dict[str, Any]] = None,
|
|
||||||
headers: Optional[Dict[str, Any]] = None,
|
|
||||||
):
|
|
||||||
super().__init__(
|
|
||||||
message,
|
|
||||||
quiet=quiet,
|
|
||||||
context=context,
|
|
||||||
extra=extra,
|
|
||||||
headers=headers,
|
|
||||||
)
|
|
||||||
self.path = path
|
self.path = path
|
||||||
self.relative_url = relative_url
|
self.relative_url = relative_url
|
||||||
|
|
||||||
|
|
||||||
class RequestTimeout(HTTPException):
|
class RequestTimeout(SanicException):
|
||||||
"""
|
"""The Web server (running the Web site) thinks that there has been too
|
||||||
The Web server (running the Web site) thinks that there has been too
|
|
||||||
long an interval of time between 1) the establishment of an IP
|
long an interval of time between 1) the establishment of an IP
|
||||||
connection (socket) between the client and the server and
|
connection (socket) between the client and the server and
|
||||||
2) the receipt of any data on that socket, so the server has dropped
|
2) the receipt of any data on that socket, so the server has dropped
|
||||||
the connection. The socket connection has actually been lost - the Web
|
the connection. The socket connection has actually been lost - the Web
|
||||||
server has 'timed out' on that particular socket connection.
|
server has 'timed out' on that particular socket connection.
|
||||||
|
|
||||||
This is an internal exception thrown by Sanic and should not be used
|
|
||||||
directly.
|
|
||||||
"""
|
"""
|
||||||
|
|
||||||
status_code = 408
|
status_code = 408
|
||||||
quiet = True
|
quiet = True
|
||||||
|
|
||||||
|
|
||||||
class PayloadTooLarge(HTTPException):
|
class PayloadTooLarge(SanicException):
|
||||||
"""
|
"""
|
||||||
**Status**: 413 Payload Too Large
|
**Status**: 413 Payload Too Large
|
||||||
|
|
||||||
This is an internal exception thrown by Sanic and should not be used
|
|
||||||
directly.
|
|
||||||
"""
|
"""
|
||||||
|
|
||||||
status_code = 413
|
status_code = 413
|
||||||
@@ -384,126 +147,34 @@ class PayloadTooLarge(HTTPException):
|
|||||||
class HeaderNotFound(BadRequest):
|
class HeaderNotFound(BadRequest):
|
||||||
"""
|
"""
|
||||||
**Status**: 400 Bad Request
|
**Status**: 400 Bad Request
|
||||||
|
|
||||||
:param message: The message to be sent to the client. If ``None``
|
|
||||||
then the HTTP status 'Bad Request' will be sent, defaults to None
|
|
||||||
:type message: Optional[Union[str, bytes]], optional
|
|
||||||
:param quiet: When ``True``, the error traceback will be suppressed
|
|
||||||
from the logs, defaults to None
|
|
||||||
:type quiet: Optional[bool], optional
|
|
||||||
:param context: Additional mapping of key/value data that will be
|
|
||||||
sent to the client upon exception, defaults to None
|
|
||||||
:type context: Optional[Dict[str, Any]], optional
|
|
||||||
:param extra: Additional mapping of key/value data that will NOT be
|
|
||||||
sent to the client when in PRODUCTION mode, defaults to None
|
|
||||||
:type extra: Optional[Dict[str, Any]], optional
|
|
||||||
:param headers: Additional headers that should be sent with the HTTP
|
|
||||||
response, defaults to None
|
|
||||||
:type headers: Optional[Dict[str, Any]], optional
|
|
||||||
"""
|
"""
|
||||||
|
|
||||||
|
|
||||||
class InvalidHeader(BadRequest):
|
class InvalidHeader(BadRequest):
|
||||||
"""
|
"""
|
||||||
**Status**: 400 Bad Request
|
**Status**: 400 Bad Request
|
||||||
|
|
||||||
:param message: The message to be sent to the client. If ``None``
|
|
||||||
then the HTTP status 'Bad Request' will be sent, defaults to None
|
|
||||||
:type message: Optional[Union[str, bytes]], optional
|
|
||||||
:param quiet: When ``True``, the error traceback will be suppressed
|
|
||||||
from the logs, defaults to None
|
|
||||||
:type quiet: Optional[bool], optional
|
|
||||||
:param context: Additional mapping of key/value data that will be
|
|
||||||
sent to the client upon exception, defaults to None
|
|
||||||
:type context: Optional[Dict[str, Any]], optional
|
|
||||||
:param extra: Additional mapping of key/value data that will NOT be
|
|
||||||
sent to the client when in PRODUCTION mode, defaults to None
|
|
||||||
:type extra: Optional[Dict[str, Any]], optional
|
|
||||||
:param headers: Additional headers that should be sent with the HTTP
|
|
||||||
response, defaults to None
|
|
||||||
:type headers: Optional[Dict[str, Any]], optional
|
|
||||||
"""
|
"""
|
||||||
|
|
||||||
|
|
||||||
class ContentRange(Protocol):
|
class RangeNotSatisfiable(SanicException):
|
||||||
total: int
|
|
||||||
|
|
||||||
|
|
||||||
class RangeNotSatisfiable(HTTPException):
|
|
||||||
"""
|
"""
|
||||||
**Status**: 416 Range Not Satisfiable
|
**Status**: 416 Range Not Satisfiable
|
||||||
|
|
||||||
:param message: The message to be sent to the client. If ``None``
|
|
||||||
then the HTTP status 'Range Not Satisfiable' will be sent,
|
|
||||||
defaults to None
|
|
||||||
:type message: Optional[Union[str, bytes]], optional
|
|
||||||
:param content_range: An object meeting the :class:`.ContentRange` protocol
|
|
||||||
that has a ``total`` property, defaults to None
|
|
||||||
:type content_range: Optional[ContentRange], optional
|
|
||||||
:param quiet: When ``True``, the error traceback will be suppressed
|
|
||||||
from the logs, defaults to None
|
|
||||||
:type quiet: Optional[bool], optional
|
|
||||||
:param context: Additional mapping of key/value data that will be
|
|
||||||
sent to the client upon exception, defaults to None
|
|
||||||
:type context: Optional[Dict[str, Any]], optional
|
|
||||||
:param extra: Additional mapping of key/value data that will NOT be
|
|
||||||
sent to the client when in PRODUCTION mode, defaults to None
|
|
||||||
:type extra: Optional[Dict[str, Any]], optional
|
|
||||||
:param headers: Additional headers that should be sent with the HTTP
|
|
||||||
response, defaults to None
|
|
||||||
:type headers: Optional[Dict[str, Any]], optional
|
|
||||||
"""
|
"""
|
||||||
|
|
||||||
status_code = 416
|
status_code = 416
|
||||||
quiet = True
|
quiet = True
|
||||||
|
|
||||||
def __init__(
|
def __init__(self, message, content_range):
|
||||||
self,
|
super().__init__(message)
|
||||||
message: Optional[Union[str, bytes]] = None,
|
self.headers = {"Content-Range": f"bytes */{content_range.total}"}
|
||||||
content_range: Optional[ContentRange] = None,
|
|
||||||
*,
|
|
||||||
quiet: Optional[bool] = None,
|
|
||||||
context: Optional[Dict[str, Any]] = None,
|
|
||||||
extra: Optional[Dict[str, Any]] = None,
|
|
||||||
headers: Optional[Dict[str, Any]] = None,
|
|
||||||
):
|
|
||||||
super().__init__(
|
|
||||||
message,
|
|
||||||
quiet=quiet,
|
|
||||||
context=context,
|
|
||||||
extra=extra,
|
|
||||||
headers=headers,
|
|
||||||
)
|
|
||||||
if content_range is not None:
|
|
||||||
self.headers = {
|
|
||||||
**self.headers,
|
|
||||||
"Content-Range": f"bytes */{content_range.total}",
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
ContentRangeError = RangeNotSatisfiable
|
ContentRangeError = RangeNotSatisfiable
|
||||||
|
|
||||||
|
|
||||||
class ExpectationFailed(HTTPException):
|
class ExpectationFailed(SanicException):
|
||||||
"""
|
"""
|
||||||
**Status**: 417 Expectation Failed
|
**Status**: 417 Expectation Failed
|
||||||
|
|
||||||
:param message: The message to be sent to the client. If ``None``
|
|
||||||
then the HTTP status 'Expectation Failed' will be sent,
|
|
||||||
defaults to None
|
|
||||||
:type message: Optional[Union[str, bytes]], optional
|
|
||||||
:param quiet: When ``True``, the error traceback will be suppressed
|
|
||||||
from the logs, defaults to None
|
|
||||||
:type quiet: Optional[bool], optional
|
|
||||||
:param context: Additional mapping of key/value data that will be
|
|
||||||
sent to the client upon exception, defaults to None
|
|
||||||
:type context: Optional[Dict[str, Any]], optional
|
|
||||||
:param extra: Additional mapping of key/value data that will NOT be
|
|
||||||
sent to the client when in PRODUCTION mode, defaults to None
|
|
||||||
:type extra: Optional[Dict[str, Any]], optional
|
|
||||||
:param headers: Additional headers that should be sent with the HTTP
|
|
||||||
response, defaults to None
|
|
||||||
:type headers: Optional[Dict[str, Any]], optional
|
|
||||||
"""
|
"""
|
||||||
|
|
||||||
status_code = 417
|
status_code = 417
|
||||||
@@ -513,25 +184,9 @@ class ExpectationFailed(HTTPException):
|
|||||||
HeaderExpectationFailed = ExpectationFailed
|
HeaderExpectationFailed = ExpectationFailed
|
||||||
|
|
||||||
|
|
||||||
class Forbidden(HTTPException):
|
class Forbidden(SanicException):
|
||||||
"""
|
"""
|
||||||
**Status**: 403 Forbidden
|
**Status**: 403 Forbidden
|
||||||
|
|
||||||
:param message: The message to be sent to the client. If ``None``
|
|
||||||
then the HTTP status 'Forbidden' will be sent, defaults to None
|
|
||||||
:type message: Optional[Union[str, bytes]], optional
|
|
||||||
:param quiet: When ``True``, the error traceback will be suppressed
|
|
||||||
from the logs, defaults to None
|
|
||||||
:type quiet: Optional[bool], optional
|
|
||||||
:param context: Additional mapping of key/value data that will be
|
|
||||||
sent to the client upon exception, defaults to None
|
|
||||||
:type context: Optional[Dict[str, Any]], optional
|
|
||||||
:param extra: Additional mapping of key/value data that will NOT be
|
|
||||||
sent to the client when in PRODUCTION mode, defaults to None
|
|
||||||
:type extra: Optional[Dict[str, Any]], optional
|
|
||||||
:param headers: Additional headers that should be sent with the HTTP
|
|
||||||
response, defaults to None
|
|
||||||
:type headers: Optional[Dict[str, Any]], optional
|
|
||||||
"""
|
"""
|
||||||
|
|
||||||
status_code = 403
|
status_code = 403
|
||||||
@@ -547,33 +202,20 @@ class InvalidRangeType(RangeNotSatisfiable):
|
|||||||
quiet = True
|
quiet = True
|
||||||
|
|
||||||
|
|
||||||
class PyFileError(SanicException):
|
class PyFileError(Exception):
|
||||||
def __init__(
|
def __init__(self, file):
|
||||||
self,
|
super().__init__("could not execute config file %s", file)
|
||||||
file,
|
|
||||||
status_code: Optional[int] = None,
|
|
||||||
*,
|
|
||||||
quiet: Optional[bool] = None,
|
|
||||||
context: Optional[Dict[str, Any]] = None,
|
|
||||||
extra: Optional[Dict[str, Any]] = None,
|
|
||||||
headers: Optional[Dict[str, Any]] = None,
|
|
||||||
):
|
|
||||||
super().__init__(
|
|
||||||
"could not execute config file %s" % file,
|
|
||||||
status_code=status_code,
|
|
||||||
quiet=quiet,
|
|
||||||
context=context,
|
|
||||||
extra=extra,
|
|
||||||
headers=headers,
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
class Unauthorized(HTTPException):
|
class Unauthorized(SanicException):
|
||||||
"""
|
"""
|
||||||
**Status**: 401 Unauthorized
|
**Status**: 401 Unauthorized
|
||||||
|
|
||||||
When present, additional keyword arguments may be used to complete
|
:param message: Message describing the exception.
|
||||||
the WWW-Authentication header.
|
:param status_code: HTTP Status code.
|
||||||
|
:param scheme: Name of the authentication scheme to be used.
|
||||||
|
|
||||||
|
When present, kwargs is used to complete the WWW-Authentication header.
|
||||||
|
|
||||||
Examples::
|
Examples::
|
||||||
|
|
||||||
@@ -598,58 +240,21 @@ class Unauthorized(HTTPException):
|
|||||||
raise Unauthorized("Auth required.",
|
raise Unauthorized("Auth required.",
|
||||||
scheme="Bearer",
|
scheme="Bearer",
|
||||||
realm="Restricted Area")
|
realm="Restricted Area")
|
||||||
|
|
||||||
:param message: The message to be sent to the client. If ``None``
|
|
||||||
then the HTTP status 'Bad Request' will be sent, defaults to None
|
|
||||||
:type message: Optional[Union[str, bytes]], optional
|
|
||||||
:param scheme: Name of the authentication scheme to be used.
|
|
||||||
:type scheme: Optional[str], optional
|
|
||||||
:param quiet: When ``True``, the error traceback will be suppressed
|
|
||||||
from the logs, defaults to None
|
|
||||||
:type quiet: Optional[bool], optional
|
|
||||||
:param context: Additional mapping of key/value data that will be
|
|
||||||
sent to the client upon exception, defaults to None
|
|
||||||
:type context: Optional[Dict[str, Any]], optional
|
|
||||||
:param extra: Additional mapping of key/value data that will NOT be
|
|
||||||
sent to the client when in PRODUCTION mode, defaults to None
|
|
||||||
:type extra: Optional[Dict[str, Any]], optional
|
|
||||||
:param headers: Additional headers that should be sent with the HTTP
|
|
||||||
response, defaults to None
|
|
||||||
:type headers: Optional[Dict[str, Any]], optional
|
|
||||||
"""
|
"""
|
||||||
|
|
||||||
status_code = 401
|
status_code = 401
|
||||||
quiet = True
|
quiet = True
|
||||||
|
|
||||||
def __init__(
|
def __init__(self, message, status_code=None, scheme=None, **kwargs):
|
||||||
self,
|
super().__init__(message, status_code)
|
||||||
message: Optional[Union[str, bytes]] = None,
|
|
||||||
scheme: Optional[str] = None,
|
|
||||||
*,
|
|
||||||
quiet: Optional[bool] = None,
|
|
||||||
context: Optional[Dict[str, Any]] = None,
|
|
||||||
extra: Optional[Dict[str, Any]] = None,
|
|
||||||
headers: Optional[Dict[str, Any]] = None,
|
|
||||||
**challenges,
|
|
||||||
):
|
|
||||||
super().__init__(
|
|
||||||
message,
|
|
||||||
quiet=quiet,
|
|
||||||
context=context,
|
|
||||||
extra=extra,
|
|
||||||
headers=headers,
|
|
||||||
)
|
|
||||||
|
|
||||||
# if auth-scheme is specified, set "WWW-Authenticate" header
|
# if auth-scheme is specified, set "WWW-Authenticate" header
|
||||||
if scheme is not None:
|
if scheme is not None:
|
||||||
values = [
|
values = ['{!s}="{!s}"'.format(k, v) for k, v in kwargs.items()]
|
||||||
'{!s}="{!s}"'.format(k, v) for k, v in challenges.items()
|
|
||||||
]
|
|
||||||
challenge = ", ".join(values)
|
challenge = ", ".join(values)
|
||||||
|
|
||||||
self.headers = {
|
self.headers = {
|
||||||
**self.headers,
|
"WWW-Authenticate": f"{scheme} {challenge}".rstrip()
|
||||||
"WWW-Authenticate": f"{scheme} {challenge}".rstrip(),
|
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -75,4 +75,4 @@ class ContentRangeHandler:
|
|||||||
}
|
}
|
||||||
|
|
||||||
def __bool__(self):
|
def __bool__(self):
|
||||||
return hasattr(self, "size") and self.size > 0
|
return self.size > 0
|
||||||
|
|||||||
@@ -3,8 +3,7 @@ from __future__ import annotations
|
|||||||
from typing import Dict, List, Optional, Tuple, Type
|
from typing import Dict, List, Optional, Tuple, Type
|
||||||
|
|
||||||
from sanic.errorpages import BaseRenderer, TextRenderer, exception_response
|
from sanic.errorpages import BaseRenderer, TextRenderer, exception_response
|
||||||
from sanic.exceptions import ServerError
|
from sanic.log import deprecation, error_logger
|
||||||
from sanic.log import error_logger
|
|
||||||
from sanic.models.handler_types import RouteHandler
|
from sanic.models.handler_types import RouteHandler
|
||||||
from sanic.response import text
|
from sanic.response import text
|
||||||
|
|
||||||
@@ -44,11 +43,16 @@ class ErrorHandler:
|
|||||||
if name is None:
|
if name is None:
|
||||||
name = "__ALL_ROUTES__"
|
name = "__ALL_ROUTES__"
|
||||||
|
|
||||||
message = (
|
error_logger.warning(
|
||||||
f"Duplicate exception handler definition on: route={name} "
|
f"Duplicate exception handler definition on: route={name} "
|
||||||
f"and exception={exc}"
|
f"and exception={exc}"
|
||||||
)
|
)
|
||||||
raise ServerError(message)
|
deprecation(
|
||||||
|
"A duplicate exception handler definition was discovered. "
|
||||||
|
"This may cause unintended consequences. A warning has been "
|
||||||
|
"issued now, but it will not be allowed starting in v23.3.",
|
||||||
|
23.3,
|
||||||
|
)
|
||||||
self.cached_handlers[key] = handler
|
self.cached_handlers[key] = handler
|
||||||
|
|
||||||
def add(self, exception, handler, route_names: Optional[List[str]] = None):
|
def add(self, exception, handler, route_names: Optional[List[str]] = None):
|
||||||
|
|||||||
@@ -240,14 +240,9 @@ class Http(Stream, metaclass=TouchUpMeta):
|
|||||||
headers_instance.getone("upgrade", "").lower() == "websocket"
|
headers_instance.getone("upgrade", "").lower() == "websocket"
|
||||||
)
|
)
|
||||||
|
|
||||||
try:
|
|
||||||
url_bytes = self.url.encode("ASCII")
|
|
||||||
except UnicodeEncodeError:
|
|
||||||
raise BadRequest("URL may only contain US-ASCII characters.")
|
|
||||||
|
|
||||||
# Prepare a Request object
|
# Prepare a Request object
|
||||||
request = self.protocol.request_class(
|
request = self.protocol.request_class(
|
||||||
url_bytes=url_bytes,
|
url_bytes=self.url.encode(),
|
||||||
headers=headers_instance,
|
headers=headers_instance,
|
||||||
head=bytes(head),
|
head=bytes(head),
|
||||||
version=protocol[5:],
|
version=protocol[5:],
|
||||||
@@ -433,9 +428,7 @@ class Http(Stream, metaclass=TouchUpMeta):
|
|||||||
if self.request is None:
|
if self.request is None:
|
||||||
self.create_empty_request()
|
self.create_empty_request()
|
||||||
|
|
||||||
request_middleware = not isinstance(
|
request_middleware = not isinstance(exception, ServiceUnavailable)
|
||||||
exception, (ServiceUnavailable, RequestCancelled)
|
|
||||||
)
|
|
||||||
try:
|
try:
|
||||||
await app.handle_exception(
|
await app.handle_exception(
|
||||||
self.request, exception, request_middleware
|
self.request, exception, request_middleware
|
||||||
@@ -450,18 +443,9 @@ class Http(Stream, metaclass=TouchUpMeta):
|
|||||||
bogus response for error handling use.
|
bogus response for error handling use.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
# Reformat any URL already received with \xHH escapes for better logs
|
|
||||||
url_bytes = (
|
|
||||||
self.url.encode(errors="surrogateescape")
|
|
||||||
.decode("ASCII", errors="backslashreplace")
|
|
||||||
.encode("ASCII")
|
|
||||||
if self.url
|
|
||||||
else b"*"
|
|
||||||
)
|
|
||||||
|
|
||||||
# FIXME: Avoid this by refactoring error handling and response code
|
# FIXME: Avoid this by refactoring error handling and response code
|
||||||
self.request = self.protocol.request_class(
|
self.request = self.protocol.request_class(
|
||||||
url_bytes=url_bytes,
|
url_bytes=self.url.encode() if self.url else b"*",
|
||||||
headers=Header({}),
|
headers=Header({}),
|
||||||
version="1.1",
|
version="1.1",
|
||||||
method="NONE",
|
method="NONE",
|
||||||
|
|||||||
@@ -18,12 +18,7 @@ from typing import (
|
|||||||
|
|
||||||
from sanic.compat import Header
|
from sanic.compat import Header
|
||||||
from sanic.constants import LocalCertCreator
|
from sanic.constants import LocalCertCreator
|
||||||
from sanic.exceptions import (
|
from sanic.exceptions import PayloadTooLarge, SanicException, ServerError
|
||||||
BadRequest,
|
|
||||||
PayloadTooLarge,
|
|
||||||
SanicException,
|
|
||||||
ServerError,
|
|
||||||
)
|
|
||||||
from sanic.helpers import has_message_body
|
from sanic.helpers import has_message_body
|
||||||
from sanic.http.constants import Stage
|
from sanic.http.constants import Stage
|
||||||
from sanic.http.stream import Stream
|
from sanic.http.stream import Stream
|
||||||
@@ -338,17 +333,7 @@ class Http3:
|
|||||||
return self.receivers[stream_id]
|
return self.receivers[stream_id]
|
||||||
|
|
||||||
def _make_request(self, event: HeadersReceived) -> Request:
|
def _make_request(self, event: HeadersReceived) -> Request:
|
||||||
try:
|
headers = Header(((k.decode(), v.decode()) for k, v in event.headers))
|
||||||
headers = Header(
|
|
||||||
(
|
|
||||||
(k.decode("ASCII"), v.decode(errors="surrogateescape"))
|
|
||||||
for k, v in event.headers
|
|
||||||
)
|
|
||||||
)
|
|
||||||
except UnicodeDecodeError:
|
|
||||||
raise BadRequest(
|
|
||||||
"Header names may only contain US-ASCII characters."
|
|
||||||
)
|
|
||||||
method = headers[":method"]
|
method = headers[":method"]
|
||||||
path = headers[":path"]
|
path = headers[":path"]
|
||||||
scheme = headers.pop(":scheme", "")
|
scheme = headers.pop(":scheme", "")
|
||||||
@@ -357,14 +342,9 @@ class Http3:
|
|||||||
if authority:
|
if authority:
|
||||||
headers["host"] = authority
|
headers["host"] = authority
|
||||||
|
|
||||||
try:
|
|
||||||
url_bytes = path.encode("ASCII")
|
|
||||||
except UnicodeEncodeError:
|
|
||||||
raise BadRequest("URL may only contain US-ASCII characters.")
|
|
||||||
|
|
||||||
transport = HTTP3Transport(self.protocol)
|
transport = HTTP3Transport(self.protocol)
|
||||||
request = self.protocol.request_class(
|
request = self.protocol.request_class(
|
||||||
url_bytes,
|
path.encode(),
|
||||||
headers,
|
headers,
|
||||||
"3",
|
"3",
|
||||||
method,
|
method,
|
||||||
|
|||||||
@@ -159,7 +159,7 @@ class CertSimple(SanicSSLContext):
|
|||||||
# try common aliases, rename to cert/key
|
# try common aliases, rename to cert/key
|
||||||
certfile = kw["cert"] = kw.pop("certificate", None) or cert
|
certfile = kw["cert"] = kw.pop("certificate", None) or cert
|
||||||
keyfile = kw["key"] = kw.pop("keyfile", None) or key
|
keyfile = kw["key"] = kw.pop("keyfile", None) or key
|
||||||
password = kw.get("password", None)
|
password = kw.pop("password", None)
|
||||||
if not certfile or not keyfile:
|
if not certfile or not keyfile:
|
||||||
raise ValueError("SSL dict needs filenames for cert and key.")
|
raise ValueError("SSL dict needs filenames for cert and key.")
|
||||||
subject = {}
|
subject = {}
|
||||||
|
|||||||
25
sanic/log.py
25
sanic/log.py
@@ -62,13 +62,13 @@ LOGGING_CONFIG_DEFAULTS: Dict[str, Any] = dict( # no cov
|
|||||||
},
|
},
|
||||||
formatters={
|
formatters={
|
||||||
"generic": {
|
"generic": {
|
||||||
"format": "%(asctime)s [%(process)s] [%(levelname)s] %(message)s",
|
"format": "%(asctime)s [%(process)d] [%(levelname)s] %(message)s",
|
||||||
"datefmt": "[%Y-%m-%d %H:%M:%S %z]",
|
"datefmt": "[%Y-%m-%d %H:%M:%S %z]",
|
||||||
"class": "logging.Formatter",
|
"class": "logging.Formatter",
|
||||||
},
|
},
|
||||||
"access": {
|
"access": {
|
||||||
"format": "%(asctime)s - (%(name)s)[%(levelname)s][%(host)s]: "
|
"format": "%(asctime)s - (%(name)s)[%(levelname)s][%(host)s]: "
|
||||||
+ "%(request)s %(message)s %(status)s %(byte)s",
|
+ "%(request)s %(message)s %(status)d %(byte)d",
|
||||||
"datefmt": "[%Y-%m-%d %H:%M:%S %z]",
|
"datefmt": "[%Y-%m-%d %H:%M:%S %z]",
|
||||||
"class": "logging.Formatter",
|
"class": "logging.Formatter",
|
||||||
},
|
},
|
||||||
@@ -126,26 +126,7 @@ 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}] "
|
||||||
Add a deprecation notice
|
|
||||||
|
|
||||||
Example when a feature is being removed. In this case, version
|
|
||||||
should be AT LEAST next version + 2
|
|
||||||
|
|
||||||
deprecation("Helpful message", 99.9)
|
|
||||||
|
|
||||||
Example when a feature is deprecated but not being removed:
|
|
||||||
|
|
||||||
deprecation("Helpful message", 0)
|
|
||||||
|
|
||||||
:param message: The message of the notice
|
|
||||||
:type message: str
|
|
||||||
:param version: The version when the feature will be removed. If it is
|
|
||||||
not being removed, then set version=0.
|
|
||||||
:type version: float
|
|
||||||
"""
|
|
||||||
version_display = f" v{version}" if version else ""
|
|
||||||
version_info = f"[DEPRECATION{version_display}] "
|
|
||||||
if is_atty():
|
if is_atty():
|
||||||
version_info = f"{Colors.RED}{version_info}"
|
version_info = f"{Colors.RED}{version_info}"
|
||||||
message = f"{Colors.YELLOW}{message}{Colors.END}"
|
message = f"{Colors.YELLOW}{message}{Colors.END}"
|
||||||
|
|||||||
@@ -546,7 +546,7 @@ class RouteMixin(BaseMixin, metaclass=SanicMeta):
|
|||||||
strict_slashes: Optional[bool] = None,
|
strict_slashes: Optional[bool] = None,
|
||||||
version: Optional[Union[int, str, float]] = None,
|
version: Optional[Union[int, str, float]] = None,
|
||||||
name: Optional[str] = None,
|
name: Optional[str] = None,
|
||||||
ignore_body: bool = False,
|
ignore_body: bool = True,
|
||||||
version_prefix: str = "/v",
|
version_prefix: str = "/v",
|
||||||
error_format: Optional[str] = None,
|
error_format: Optional[str] = None,
|
||||||
**ctx_kwargs: Any,
|
**ctx_kwargs: Any,
|
||||||
|
|||||||
@@ -47,16 +47,17 @@ from sanic.helpers import Default, _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
|
||||||
from sanic.log import Colors, error_logger, logger
|
from sanic.log import Colors, deprecation, error_logger, logger
|
||||||
from sanic.models.handler_types import ListenerType
|
from sanic.models.handler_types import ListenerType
|
||||||
from sanic.server import Signal as ServerSignal
|
from sanic.server import Signal as ServerSignal
|
||||||
from sanic.server import try_use_uvloop
|
from sanic.server import try_use_uvloop
|
||||||
from sanic.server.async_server import AsyncioServer
|
from sanic.server.async_server import AsyncioServer
|
||||||
from sanic.server.events import trigger_events
|
from sanic.server.events import trigger_events
|
||||||
|
from sanic.server.legacy import watchdog
|
||||||
from sanic.server.loop import try_windows_loop
|
from sanic.server.loop import try_windows_loop
|
||||||
from sanic.server.protocols.http_protocol import HttpProtocol
|
from sanic.server.protocols.http_protocol import HttpProtocol
|
||||||
from sanic.server.protocols.websocket_protocol import WebSocketProtocol
|
from sanic.server.protocols.websocket_protocol import WebSocketProtocol
|
||||||
from sanic.server.runners import serve
|
from sanic.server.runners import serve, serve_multiple, serve_single
|
||||||
from sanic.server.socket import configure_socket, remove_unix_socket
|
from sanic.server.socket import configure_socket, remove_unix_socket
|
||||||
from sanic.worker.loader import AppLoader
|
from sanic.worker.loader import AppLoader
|
||||||
from sanic.worker.manager import WorkerManager
|
from sanic.worker.manager import WorkerManager
|
||||||
@@ -134,6 +135,7 @@ class StartupMixin(metaclass=SanicMeta):
|
|||||||
motd_display: Optional[Dict[str, str]] = None,
|
motd_display: Optional[Dict[str, str]] = None,
|
||||||
auto_tls: bool = False,
|
auto_tls: bool = False,
|
||||||
single_process: bool = False,
|
single_process: bool = False,
|
||||||
|
legacy: bool = False,
|
||||||
) -> None:
|
) -> None:
|
||||||
"""
|
"""
|
||||||
Run the HTTP Server and listen until keyboard interrupt or term
|
Run the HTTP Server and listen until keyboard interrupt or term
|
||||||
@@ -195,10 +197,13 @@ class StartupMixin(metaclass=SanicMeta):
|
|||||||
motd_display=motd_display,
|
motd_display=motd_display,
|
||||||
auto_tls=auto_tls,
|
auto_tls=auto_tls,
|
||||||
single_process=single_process,
|
single_process=single_process,
|
||||||
|
legacy=legacy,
|
||||||
)
|
)
|
||||||
|
|
||||||
if single_process:
|
if single_process:
|
||||||
serve = self.__class__.serve_single
|
serve = self.__class__.serve_single
|
||||||
|
elif legacy:
|
||||||
|
serve = self.__class__.serve_legacy
|
||||||
else:
|
else:
|
||||||
serve = self.__class__.serve
|
serve = self.__class__.serve
|
||||||
serve(primary=self) # type: ignore
|
serve(primary=self) # type: ignore
|
||||||
@@ -230,6 +235,7 @@ class StartupMixin(metaclass=SanicMeta):
|
|||||||
coffee: bool = False,
|
coffee: bool = False,
|
||||||
auto_tls: bool = False,
|
auto_tls: bool = False,
|
||||||
single_process: bool = False,
|
single_process: bool = False,
|
||||||
|
legacy: bool = False,
|
||||||
) -> None:
|
) -> None:
|
||||||
if version == 3 and self.state.server_info:
|
if version == 3 and self.state.server_info:
|
||||||
raise RuntimeError(
|
raise RuntimeError(
|
||||||
@@ -258,10 +264,13 @@ class StartupMixin(metaclass=SanicMeta):
|
|||||||
"or auto-reload"
|
"or auto-reload"
|
||||||
)
|
)
|
||||||
|
|
||||||
if register_sys_signals is False and not single_process:
|
if single_process and legacy:
|
||||||
|
raise RuntimeError("Cannot run single process and legacy mode")
|
||||||
|
|
||||||
|
if register_sys_signals is False and not (single_process or legacy):
|
||||||
raise RuntimeError(
|
raise RuntimeError(
|
||||||
"Cannot run Sanic.serve with register_sys_signals=False. "
|
"Cannot run Sanic.serve with register_sys_signals=False. "
|
||||||
"Use Sanic.serve_single."
|
"Use either Sanic.serve_single or Sanic.serve_legacy."
|
||||||
)
|
)
|
||||||
|
|
||||||
if motd_display:
|
if motd_display:
|
||||||
@@ -802,7 +811,7 @@ class StartupMixin(metaclass=SanicMeta):
|
|||||||
ssl = kwargs.get("ssl")
|
ssl = kwargs.get("ssl")
|
||||||
|
|
||||||
if isinstance(ssl, SanicSSLContext):
|
if isinstance(ssl, SanicSSLContext):
|
||||||
kwargs["ssl"] = ssl.sanic
|
kwargs["ssl"] = kwargs["ssl"].sanic
|
||||||
|
|
||||||
manager = WorkerManager(
|
manager = WorkerManager(
|
||||||
primary.state.workers,
|
primary.state.workers,
|
||||||
@@ -947,6 +956,76 @@ class StartupMixin(metaclass=SanicMeta):
|
|||||||
cls._cleanup_env_vars()
|
cls._cleanup_env_vars()
|
||||||
cls._cleanup_apps()
|
cls._cleanup_apps()
|
||||||
|
|
||||||
|
@classmethod
|
||||||
|
def serve_legacy(cls, primary: Optional[Sanic] = None) -> None:
|
||||||
|
apps = list(cls._app_registry.values())
|
||||||
|
|
||||||
|
if not primary:
|
||||||
|
try:
|
||||||
|
primary = apps[0]
|
||||||
|
except IndexError:
|
||||||
|
raise RuntimeError("Did not find any applications.")
|
||||||
|
|
||||||
|
reloader_start = primary.listeners.get("reload_process_start")
|
||||||
|
reloader_stop = primary.listeners.get("reload_process_stop")
|
||||||
|
# We want to run auto_reload if ANY of the applications have it enabled
|
||||||
|
if (
|
||||||
|
cls.should_auto_reload()
|
||||||
|
and os.environ.get("SANIC_SERVER_RUNNING") != "true"
|
||||||
|
): # no cov
|
||||||
|
loop = new_event_loop()
|
||||||
|
trigger_events(reloader_start, loop, primary)
|
||||||
|
reload_dirs: Set[Path] = primary.state.reload_dirs.union(
|
||||||
|
*(app.state.reload_dirs for app in apps)
|
||||||
|
)
|
||||||
|
watchdog(1.0, reload_dirs)
|
||||||
|
trigger_events(reloader_stop, loop, primary)
|
||||||
|
return
|
||||||
|
|
||||||
|
# This exists primarily for unit testing
|
||||||
|
if not primary.state.server_info: # no cov
|
||||||
|
for app in apps:
|
||||||
|
app.state.server_info.clear()
|
||||||
|
return
|
||||||
|
|
||||||
|
primary_server_info = primary.state.server_info[0]
|
||||||
|
primary.before_server_start(partial(primary._start_servers, apps=apps))
|
||||||
|
|
||||||
|
deprecation(
|
||||||
|
f"{Colors.YELLOW}Running {Colors.SANIC}Sanic {Colors.YELLOW}w/ "
|
||||||
|
f"LEGACY manager.{Colors.END} Support for will be dropped in "
|
||||||
|
"version 23.3.",
|
||||||
|
23.3,
|
||||||
|
)
|
||||||
|
try:
|
||||||
|
primary_server_info.stage = ServerStage.SERVING
|
||||||
|
|
||||||
|
if primary.state.workers > 1 and os.name != "posix": # no cov
|
||||||
|
logger.warning(
|
||||||
|
f"Multiprocessing is currently not supported on {os.name},"
|
||||||
|
" using workers=1 instead"
|
||||||
|
)
|
||||||
|
primary.state.workers = 1
|
||||||
|
if primary.state.workers == 1:
|
||||||
|
serve_single(primary_server_info.settings)
|
||||||
|
elif primary.state.workers == 0:
|
||||||
|
raise RuntimeError("Cannot serve with no workers")
|
||||||
|
else:
|
||||||
|
serve_multiple(
|
||||||
|
primary_server_info.settings, primary.state.workers
|
||||||
|
)
|
||||||
|
except BaseException:
|
||||||
|
error_logger.exception(
|
||||||
|
"Experienced exception while trying to serve"
|
||||||
|
)
|
||||||
|
raise
|
||||||
|
finally:
|
||||||
|
primary_server_info.stage = ServerStage.STOPPED
|
||||||
|
logger.info("Server Stopped")
|
||||||
|
|
||||||
|
cls._cleanup_env_vars()
|
||||||
|
cls._cleanup_apps()
|
||||||
|
|
||||||
async def _start_servers(
|
async def _start_servers(
|
||||||
self,
|
self,
|
||||||
primary: Sanic,
|
primary: Sanic,
|
||||||
|
|||||||
@@ -3,7 +3,7 @@ from functools import partial, wraps
|
|||||||
from mimetypes import guess_type
|
from mimetypes import guess_type
|
||||||
from os import PathLike, path
|
from os import PathLike, path
|
||||||
from pathlib import Path, PurePath
|
from pathlib import Path, PurePath
|
||||||
from typing import Optional, Sequence, Set, Union
|
from typing import Optional, Sequence, Set, Union, cast
|
||||||
from urllib.parse import unquote
|
from urllib.parse import unquote
|
||||||
|
|
||||||
from sanic_routing.route import Route
|
from sanic_routing.route import Route
|
||||||
@@ -14,7 +14,7 @@ from sanic.constants import DEFAULT_HTTP_CONTENT_TYPE
|
|||||||
from sanic.exceptions import FileNotFound, HeaderNotFound, RangeNotSatisfiable
|
from sanic.exceptions import FileNotFound, HeaderNotFound, RangeNotSatisfiable
|
||||||
from sanic.handlers import ContentRangeHandler
|
from sanic.handlers import ContentRangeHandler
|
||||||
from sanic.handlers.directory import DirectoryHandler
|
from sanic.handlers.directory import DirectoryHandler
|
||||||
from sanic.log import error_logger
|
from sanic.log import deprecation, error_logger
|
||||||
from sanic.mixins.base import BaseMixin
|
from sanic.mixins.base import BaseMixin
|
||||||
from sanic.models.futures import FutureStatic
|
from sanic.models.futures import FutureStatic
|
||||||
from sanic.request import Request
|
from sanic.request import Request
|
||||||
@@ -31,7 +31,7 @@ class StaticMixin(BaseMixin, metaclass=SanicMeta):
|
|||||||
def static(
|
def static(
|
||||||
self,
|
self,
|
||||||
uri: str,
|
uri: str,
|
||||||
file_or_directory: Union[PathLike, str],
|
file_or_directory: Union[PathLike, str, bytes],
|
||||||
pattern: str = r"/?.+",
|
pattern: str = r"/?.+",
|
||||||
use_modified_since: bool = True,
|
use_modified_since: bool = True,
|
||||||
use_content_range: bool = False,
|
use_content_range: bool = False,
|
||||||
@@ -94,12 +94,14 @@ class StaticMixin(BaseMixin, metaclass=SanicMeta):
|
|||||||
f"Static route must be a valid path, not {file_or_directory}"
|
f"Static route must be a valid path, not {file_or_directory}"
|
||||||
)
|
)
|
||||||
|
|
||||||
try:
|
if isinstance(file_or_directory, bytes):
|
||||||
file_or_directory = Path(file_or_directory)
|
deprecation(
|
||||||
except TypeError:
|
"Serving a static directory with a bytes string is "
|
||||||
raise TypeError(
|
"deprecated and will be removed in v22.9.",
|
||||||
"Static file or directory must be a path-like object or string"
|
22.9,
|
||||||
)
|
)
|
||||||
|
file_or_directory = cast(str, file_or_directory.decode())
|
||||||
|
file_or_directory = Path(file_or_directory)
|
||||||
|
|
||||||
if directory_handler and (directory_view or index):
|
if directory_handler and (directory_view or index):
|
||||||
raise ValueError(
|
raise ValueError(
|
||||||
|
|||||||
6
sanic/request.py
Normal file
6
sanic/request.py
Normal file
@@ -0,0 +1,6 @@
|
|||||||
|
from sanic.breaking import (
|
||||||
|
File,
|
||||||
|
Request,
|
||||||
|
RequestParameters,
|
||||||
|
parse_multipart_form,
|
||||||
|
)
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
from .form import File, parse_multipart_form
|
|
||||||
from .parameters import RequestParameters
|
|
||||||
from .types import Request
|
|
||||||
|
|
||||||
|
|
||||||
__all__ = (
|
|
||||||
"File",
|
|
||||||
"parse_multipart_form",
|
|
||||||
"Request",
|
|
||||||
"RequestParameters",
|
|
||||||
)
|
|
||||||
@@ -1,110 +0,0 @@
|
|||||||
from __future__ import annotations
|
|
||||||
|
|
||||||
import email.utils
|
|
||||||
import unicodedata
|
|
||||||
|
|
||||||
from typing import NamedTuple
|
|
||||||
from urllib.parse import unquote
|
|
||||||
|
|
||||||
from sanic.headers import parse_content_header
|
|
||||||
from sanic.log import logger
|
|
||||||
|
|
||||||
from .parameters import RequestParameters
|
|
||||||
|
|
||||||
|
|
||||||
class File(NamedTuple):
|
|
||||||
"""
|
|
||||||
Model for defining a file. It is a ``namedtuple``, therefore you can
|
|
||||||
iterate over the object, or access the parameters by name.
|
|
||||||
|
|
||||||
:param type: The mimetype, defaults to text/plain
|
|
||||||
:param body: Bytes of the file
|
|
||||||
:param name: The filename
|
|
||||||
"""
|
|
||||||
|
|
||||||
type: str
|
|
||||||
body: bytes
|
|
||||||
name: str
|
|
||||||
|
|
||||||
|
|
||||||
def parse_multipart_form(body, boundary):
|
|
||||||
"""
|
|
||||||
Parse a request body and returns fields and files
|
|
||||||
|
|
||||||
:param body: bytes request body
|
|
||||||
:param boundary: bytes multipart boundary
|
|
||||||
:return: fields (RequestParameters), files (RequestParameters)
|
|
||||||
"""
|
|
||||||
files = {}
|
|
||||||
fields = {}
|
|
||||||
|
|
||||||
form_parts = body.split(boundary)
|
|
||||||
for form_part in form_parts[1:-1]:
|
|
||||||
file_name = None
|
|
||||||
content_type = "text/plain"
|
|
||||||
content_charset = "utf-8"
|
|
||||||
field_name = None
|
|
||||||
line_index = 2
|
|
||||||
line_end_index = 0
|
|
||||||
while not line_end_index == -1:
|
|
||||||
line_end_index = form_part.find(b"\r\n", line_index)
|
|
||||||
form_line = form_part[line_index:line_end_index].decode("utf-8")
|
|
||||||
line_index = line_end_index + 2
|
|
||||||
|
|
||||||
if not form_line:
|
|
||||||
break
|
|
||||||
|
|
||||||
colon_index = form_line.index(":")
|
|
||||||
idx = colon_index + 2
|
|
||||||
form_header_field = form_line[0:colon_index].lower()
|
|
||||||
form_header_value, form_parameters = parse_content_header(
|
|
||||||
form_line[idx:]
|
|
||||||
)
|
|
||||||
|
|
||||||
if form_header_field == "content-disposition":
|
|
||||||
field_name = form_parameters.get("name")
|
|
||||||
file_name = form_parameters.get("filename")
|
|
||||||
|
|
||||||
# non-ASCII filenames in RFC2231, "filename*" format
|
|
||||||
if file_name is None and form_parameters.get("filename*"):
|
|
||||||
encoding, _, value = email.utils.decode_rfc2231(
|
|
||||||
form_parameters["filename*"]
|
|
||||||
)
|
|
||||||
file_name = unquote(value, encoding=encoding)
|
|
||||||
|
|
||||||
# Normalize to NFC (Apple MacOS/iOS send NFD)
|
|
||||||
# Notes:
|
|
||||||
# - No effect for Windows, Linux or Android clients which
|
|
||||||
# already send NFC
|
|
||||||
# - Python open() is tricky (creates files in NFC no matter
|
|
||||||
# which form you use)
|
|
||||||
if file_name is not None:
|
|
||||||
file_name = unicodedata.normalize("NFC", file_name)
|
|
||||||
|
|
||||||
elif form_header_field == "content-type":
|
|
||||||
content_type = form_header_value
|
|
||||||
content_charset = form_parameters.get("charset", "utf-8")
|
|
||||||
|
|
||||||
if field_name:
|
|
||||||
post_data = form_part[line_index:-4]
|
|
||||||
if file_name is None:
|
|
||||||
value = post_data.decode(content_charset)
|
|
||||||
if field_name in fields:
|
|
||||||
fields[field_name].append(value)
|
|
||||||
else:
|
|
||||||
fields[field_name] = [value]
|
|
||||||
else:
|
|
||||||
form_file = File(
|
|
||||||
type=content_type, name=file_name, body=post_data
|
|
||||||
)
|
|
||||||
if field_name in files:
|
|
||||||
files[field_name].append(form_file)
|
|
||||||
else:
|
|
||||||
files[field_name] = [form_file]
|
|
||||||
else:
|
|
||||||
logger.debug(
|
|
||||||
"Form-data field does not have a 'name' parameter "
|
|
||||||
"in the Content-Disposition header"
|
|
||||||
)
|
|
||||||
|
|
||||||
return RequestParameters(fields), RequestParameters(files)
|
|
||||||
@@ -1,22 +0,0 @@
|
|||||||
from __future__ import annotations
|
|
||||||
|
|
||||||
from typing import Any, Optional
|
|
||||||
|
|
||||||
|
|
||||||
class RequestParameters(dict):
|
|
||||||
"""
|
|
||||||
Hosts a dict with lists as values where get returns the first
|
|
||||||
value of the list and getlist returns the whole shebang
|
|
||||||
"""
|
|
||||||
|
|
||||||
def get(self, name: str, default: Optional[Any] = None) -> Optional[Any]:
|
|
||||||
"""Return the first value, either the default or actual"""
|
|
||||||
return super().get(name, [default])[0]
|
|
||||||
|
|
||||||
def getlist(
|
|
||||||
self, name: str, default: Optional[Any] = None
|
|
||||||
) -> Optional[Any]:
|
|
||||||
"""
|
|
||||||
Return the entire list
|
|
||||||
"""
|
|
||||||
return super().get(name, default)
|
|
||||||
@@ -148,26 +148,7 @@ async def validate_file(
|
|||||||
last_modified = datetime.fromtimestamp(
|
last_modified = datetime.fromtimestamp(
|
||||||
float(last_modified), tz=timezone.utc
|
float(last_modified), tz=timezone.utc
|
||||||
).replace(microsecond=0)
|
).replace(microsecond=0)
|
||||||
|
if last_modified <= if_modified_since:
|
||||||
if (
|
|
||||||
last_modified.utcoffset() is None
|
|
||||||
and if_modified_since.utcoffset() is not None
|
|
||||||
):
|
|
||||||
logger.warning(
|
|
||||||
"Cannot compare tz-aware and tz-naive datetimes. To avoid "
|
|
||||||
"this conflict Sanic is converting last_modified to UTC."
|
|
||||||
)
|
|
||||||
last_modified.replace(tzinfo=timezone.utc)
|
|
||||||
elif (
|
|
||||||
last_modified.utcoffset() is not None
|
|
||||||
and if_modified_since.utcoffset() is None
|
|
||||||
):
|
|
||||||
logger.warning(
|
|
||||||
"Cannot compare tz-aware and tz-naive datetimes. To avoid "
|
|
||||||
"this conflict Sanic is converting if_modified_since to UTC."
|
|
||||||
)
|
|
||||||
if_modified_since.replace(tzinfo=timezone.utc)
|
|
||||||
if last_modified.timestamp() <= if_modified_since.timestamp():
|
|
||||||
return HTTPResponse(status=304)
|
return HTTPResponse(status=304)
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -1,6 +1,5 @@
|
|||||||
from __future__ import annotations
|
from __future__ import annotations
|
||||||
|
|
||||||
from datetime import datetime
|
|
||||||
from functools import partial
|
from functools import partial
|
||||||
from typing import (
|
from typing import (
|
||||||
TYPE_CHECKING,
|
TYPE_CHECKING,
|
||||||
@@ -18,7 +17,6 @@ from typing import (
|
|||||||
|
|
||||||
from sanic.compat import Header
|
from sanic.compat import Header
|
||||||
from sanic.cookies import CookieJar
|
from sanic.cookies import CookieJar
|
||||||
from sanic.cookies.response import Cookie, SameSite
|
|
||||||
from sanic.exceptions import SanicException, ServerError
|
from sanic.exceptions import SanicException, ServerError
|
||||||
from sanic.helpers import (
|
from sanic.helpers import (
|
||||||
Default,
|
Default,
|
||||||
@@ -160,117 +158,6 @@ class BaseHTTPResponse:
|
|||||||
end_stream=end_stream or False,
|
end_stream=end_stream or False,
|
||||||
)
|
)
|
||||||
|
|
||||||
def add_cookie(
|
|
||||||
self,
|
|
||||||
key: str,
|
|
||||||
value: str,
|
|
||||||
*,
|
|
||||||
path: str = "/",
|
|
||||||
domain: Optional[str] = None,
|
|
||||||
secure: bool = True,
|
|
||||||
max_age: Optional[int] = None,
|
|
||||||
expires: Optional[datetime] = None,
|
|
||||||
httponly: bool = False,
|
|
||||||
samesite: Optional[SameSite] = "Lax",
|
|
||||||
partitioned: bool = False,
|
|
||||||
comment: Optional[str] = None,
|
|
||||||
host_prefix: bool = False,
|
|
||||||
secure_prefix: bool = False,
|
|
||||||
) -> Cookie:
|
|
||||||
"""
|
|
||||||
Add a cookie to the CookieJar
|
|
||||||
|
|
||||||
:param key: Key of the cookie
|
|
||||||
:type key: str
|
|
||||||
:param value: Value of the cookie
|
|
||||||
:type value: str
|
|
||||||
:param path: Path of the cookie, defaults to None
|
|
||||||
:type path: Optional[str], optional
|
|
||||||
:param domain: Domain of the cookie, defaults to None
|
|
||||||
:type domain: Optional[str], optional
|
|
||||||
:param secure: Whether to set it as a secure cookie, defaults to True
|
|
||||||
:type secure: bool
|
|
||||||
:param max_age: Max age of the cookie in seconds; if set to 0 a
|
|
||||||
browser should delete it, defaults to None
|
|
||||||
:type max_age: Optional[int], optional
|
|
||||||
:param expires: When the cookie expires; if set to None browsers
|
|
||||||
should set it as a session cookie, defaults to None
|
|
||||||
:type expires: Optional[datetime], optional
|
|
||||||
:param httponly: Whether to set it as HTTP only, defaults to False
|
|
||||||
:type httponly: bool
|
|
||||||
:param samesite: How to set the samesite property, should be
|
|
||||||
strict, lax or none (case insensitive), defaults to Lax
|
|
||||||
:type samesite: Optional[SameSite], optional
|
|
||||||
:param partitioned: Whether to set it as partitioned, defaults to False
|
|
||||||
:type partitioned: bool
|
|
||||||
:param comment: A cookie comment, defaults to None
|
|
||||||
:type comment: Optional[str], optional
|
|
||||||
:param host_prefix: Whether to add __Host- as a prefix to the key.
|
|
||||||
This requires that path="/", domain=None, and secure=True,
|
|
||||||
defaults to False
|
|
||||||
:type host_prefix: bool
|
|
||||||
:param secure_prefix: Whether to add __Secure- as a prefix to the key.
|
|
||||||
This requires that secure=True, defaults to False
|
|
||||||
:type secure_prefix: bool
|
|
||||||
:return: The instance of the created cookie
|
|
||||||
:rtype: Cookie
|
|
||||||
"""
|
|
||||||
return self.cookies.add_cookie(
|
|
||||||
key=key,
|
|
||||||
value=value,
|
|
||||||
path=path,
|
|
||||||
domain=domain,
|
|
||||||
secure=secure,
|
|
||||||
max_age=max_age,
|
|
||||||
expires=expires,
|
|
||||||
httponly=httponly,
|
|
||||||
samesite=samesite,
|
|
||||||
partitioned=partitioned,
|
|
||||||
comment=comment,
|
|
||||||
host_prefix=host_prefix,
|
|
||||||
secure_prefix=secure_prefix,
|
|
||||||
)
|
|
||||||
|
|
||||||
def delete_cookie(
|
|
||||||
self,
|
|
||||||
key: str,
|
|
||||||
*,
|
|
||||||
path: str = "/",
|
|
||||||
domain: Optional[str] = None,
|
|
||||||
host_prefix: bool = False,
|
|
||||||
secure_prefix: bool = False,
|
|
||||||
) -> None:
|
|
||||||
"""
|
|
||||||
Delete a cookie
|
|
||||||
|
|
||||||
This will effectively set it as Max-Age: 0, which a browser should
|
|
||||||
interpret it to mean: "delete the cookie".
|
|
||||||
|
|
||||||
Since it is a browser/client implementation, your results may vary
|
|
||||||
depending upon which client is being used.
|
|
||||||
|
|
||||||
:param key: The key to be deleted
|
|
||||||
:type key: str
|
|
||||||
:param path: Path of the cookie, defaults to None
|
|
||||||
:type path: Optional[str], optional
|
|
||||||
:param domain: Domain of the cookie, defaults to None
|
|
||||||
:type domain: Optional[str], optional
|
|
||||||
:param host_prefix: Whether to add __Host- as a prefix to the key.
|
|
||||||
This requires that path="/", domain=None, and secure=True,
|
|
||||||
defaults to False
|
|
||||||
:type host_prefix: bool
|
|
||||||
:param secure_prefix: Whether to add __Secure- as a prefix to the key.
|
|
||||||
This requires that secure=True, defaults to False
|
|
||||||
:type secure_prefix: bool
|
|
||||||
"""
|
|
||||||
self.cookies.delete_cookie(
|
|
||||||
key=key,
|
|
||||||
path=path,
|
|
||||||
domain=domain,
|
|
||||||
host_prefix=host_prefix,
|
|
||||||
secure_prefix=secure_prefix,
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
class HTTPResponse(BaseHTTPResponse):
|
class HTTPResponse(BaseHTTPResponse):
|
||||||
"""
|
"""
|
||||||
@@ -520,8 +407,6 @@ class ResponseStream:
|
|||||||
headers: Optional[Union[Header, Dict[str, str]]] = None,
|
headers: Optional[Union[Header, Dict[str, str]]] = None,
|
||||||
content_type: Optional[str] = None,
|
content_type: Optional[str] = None,
|
||||||
):
|
):
|
||||||
if not isinstance(headers, Header):
|
|
||||||
headers = Header(headers)
|
|
||||||
self.streaming_fn = streaming_fn
|
self.streaming_fn = streaming_fn
|
||||||
self.status = status
|
self.status = status
|
||||||
self.headers = headers or Header()
|
self.headers = headers or Header()
|
||||||
|
|||||||
@@ -44,9 +44,7 @@ class Router(BaseRouter):
|
|||||||
raise MethodNotAllowed(
|
raise MethodNotAllowed(
|
||||||
f"Method {method} not allowed for URL {path}",
|
f"Method {method} not allowed for URL {path}",
|
||||||
method=method,
|
method=method,
|
||||||
allowed_methods=tuple(e.allowed_methods)
|
allowed_methods=e.allowed_methods,
|
||||||
if e.allowed_methods
|
|
||||||
else None,
|
|
||||||
) from None
|
) from None
|
||||||
|
|
||||||
@lru_cache(maxsize=ROUTER_CACHE_SIZE)
|
@lru_cache(maxsize=ROUTER_CACHE_SIZE)
|
||||||
@@ -135,16 +133,7 @@ class Router(BaseRouter):
|
|||||||
if host:
|
if host:
|
||||||
params.update({"requirements": {"host": host}})
|
params.update({"requirements": {"host": host}})
|
||||||
|
|
||||||
ident = name
|
|
||||||
if len(hosts) > 1:
|
|
||||||
ident = (
|
|
||||||
f"{name}_{host.replace('.', '_')}"
|
|
||||||
if name
|
|
||||||
else "__unnamed__"
|
|
||||||
)
|
|
||||||
|
|
||||||
route = super().add(**params) # type: ignore
|
route = super().add(**params) # type: ignore
|
||||||
route.extra.ident = ident
|
|
||||||
route.extra.ignore_body = ignore_body
|
route.extra.ignore_body = ignore_body
|
||||||
route.extra.stream = stream
|
route.extra.stream = stream
|
||||||
route.extra.hosts = hosts
|
route.extra.hosts = hosts
|
||||||
|
|||||||
@@ -2,7 +2,7 @@ from sanic.models.server_types import ConnInfo, Signal
|
|||||||
from sanic.server.async_server import AsyncioServer
|
from sanic.server.async_server import AsyncioServer
|
||||||
from sanic.server.loop import try_use_uvloop
|
from sanic.server.loop import try_use_uvloop
|
||||||
from sanic.server.protocols.http_protocol import HttpProtocol
|
from sanic.server.protocols.http_protocol import HttpProtocol
|
||||||
from sanic.server.runners import serve
|
from sanic.server.runners import serve, serve_multiple, serve_single
|
||||||
|
|
||||||
|
|
||||||
__all__ = (
|
__all__ = (
|
||||||
@@ -11,5 +11,7 @@ __all__ = (
|
|||||||
"HttpProtocol",
|
"HttpProtocol",
|
||||||
"Signal",
|
"Signal",
|
||||||
"serve",
|
"serve",
|
||||||
|
"serve_multiple",
|
||||||
|
"serve_single",
|
||||||
"try_use_uvloop",
|
"try_use_uvloop",
|
||||||
)
|
)
|
||||||
|
|||||||
123
sanic/server/legacy.py
Normal file
123
sanic/server/legacy.py
Normal file
@@ -0,0 +1,123 @@
|
|||||||
|
import itertools
|
||||||
|
import os
|
||||||
|
import signal
|
||||||
|
import subprocess
|
||||||
|
import sys
|
||||||
|
|
||||||
|
from time import sleep
|
||||||
|
|
||||||
|
|
||||||
|
def _iter_module_files():
|
||||||
|
"""This iterates over all relevant Python files.
|
||||||
|
It goes through all
|
||||||
|
loaded files from modules, all files in folders of already loaded modules
|
||||||
|
as well as all files reachable through a package.
|
||||||
|
"""
|
||||||
|
# The list call is necessary on Python 3 in case the module
|
||||||
|
# dictionary modifies during iteration.
|
||||||
|
for module in list(sys.modules.values()):
|
||||||
|
if module is None:
|
||||||
|
continue
|
||||||
|
filename = getattr(module, "__file__", None)
|
||||||
|
if filename:
|
||||||
|
old = None
|
||||||
|
while not os.path.isfile(filename):
|
||||||
|
old = filename
|
||||||
|
filename = os.path.dirname(filename)
|
||||||
|
if filename == old:
|
||||||
|
break
|
||||||
|
else:
|
||||||
|
if filename[-4:] in (".pyc", ".pyo"):
|
||||||
|
filename = filename[:-1]
|
||||||
|
yield filename
|
||||||
|
|
||||||
|
|
||||||
|
def _get_args_for_reloading():
|
||||||
|
"""Returns the executable."""
|
||||||
|
main_module = sys.modules["__main__"]
|
||||||
|
mod_spec = getattr(main_module, "__spec__", None)
|
||||||
|
if sys.argv[0] in ("", "-c"):
|
||||||
|
raise RuntimeError(
|
||||||
|
f"Autoreloader cannot work with argv[0]={sys.argv[0]!r}"
|
||||||
|
)
|
||||||
|
if mod_spec:
|
||||||
|
# Parent exe was launched as a module rather than a script
|
||||||
|
return [sys.executable, "-m", mod_spec.name] + sys.argv[1:]
|
||||||
|
return [sys.executable] + sys.argv
|
||||||
|
|
||||||
|
|
||||||
|
def restart_with_reloader(changed=None):
|
||||||
|
"""Create a new process and a subprocess in it with the same arguments as
|
||||||
|
this one.
|
||||||
|
"""
|
||||||
|
reloaded = ",".join(changed) if changed else ""
|
||||||
|
return subprocess.Popen( # nosec B603
|
||||||
|
_get_args_for_reloading(),
|
||||||
|
env={
|
||||||
|
**os.environ,
|
||||||
|
"SANIC_SERVER_RUNNING": "true",
|
||||||
|
"SANIC_RELOADER_PROCESS": "true",
|
||||||
|
"SANIC_RELOADED_FILES": reloaded,
|
||||||
|
},
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def _check_file(filename, mtimes):
|
||||||
|
need_reload = False
|
||||||
|
|
||||||
|
mtime = os.stat(filename).st_mtime
|
||||||
|
old_time = mtimes.get(filename)
|
||||||
|
if old_time is None:
|
||||||
|
mtimes[filename] = mtime
|
||||||
|
elif mtime > old_time:
|
||||||
|
mtimes[filename] = mtime
|
||||||
|
need_reload = True
|
||||||
|
|
||||||
|
return need_reload
|
||||||
|
|
||||||
|
|
||||||
|
def watchdog(sleep_interval, reload_dirs):
|
||||||
|
"""Watch project files, restart worker process if a change happened.
|
||||||
|
:param sleep_interval: interval in second.
|
||||||
|
:return: Nothing
|
||||||
|
"""
|
||||||
|
|
||||||
|
def interrupt_self(*args):
|
||||||
|
raise KeyboardInterrupt
|
||||||
|
|
||||||
|
mtimes = {}
|
||||||
|
signal.signal(signal.SIGTERM, interrupt_self)
|
||||||
|
if os.name == "nt":
|
||||||
|
signal.signal(signal.SIGBREAK, interrupt_self)
|
||||||
|
|
||||||
|
worker_process = restart_with_reloader()
|
||||||
|
|
||||||
|
try:
|
||||||
|
while True:
|
||||||
|
changed = set()
|
||||||
|
for filename in itertools.chain(
|
||||||
|
_iter_module_files(),
|
||||||
|
*(d.glob("**/*") for d in reload_dirs),
|
||||||
|
):
|
||||||
|
try:
|
||||||
|
if _check_file(filename, mtimes):
|
||||||
|
path = (
|
||||||
|
filename
|
||||||
|
if isinstance(filename, str)
|
||||||
|
else filename.resolve()
|
||||||
|
)
|
||||||
|
changed.add(str(path))
|
||||||
|
except OSError:
|
||||||
|
continue
|
||||||
|
|
||||||
|
if changed:
|
||||||
|
worker_process.terminate()
|
||||||
|
worker_process.wait()
|
||||||
|
worker_process = restart_with_reloader(changed)
|
||||||
|
|
||||||
|
sleep(sleep_interval)
|
||||||
|
except KeyboardInterrupt:
|
||||||
|
pass
|
||||||
|
finally:
|
||||||
|
worker_process.terminate()
|
||||||
|
worker_process.wait()
|
||||||
@@ -10,7 +10,7 @@ except ImportError: # websockets >= 11.0
|
|||||||
|
|
||||||
from websockets.typing import Subprotocol
|
from websockets.typing import Subprotocol
|
||||||
|
|
||||||
from sanic.exceptions import SanicException
|
from sanic.exceptions import ServerError
|
||||||
from sanic.log import logger
|
from sanic.log import logger
|
||||||
from sanic.server import HttpProtocol
|
from sanic.server import HttpProtocol
|
||||||
|
|
||||||
@@ -123,7 +123,7 @@ class WebSocketProtocol(HttpProtocol):
|
|||||||
"Failed to open a WebSocket connection.\n"
|
"Failed to open a WebSocket connection.\n"
|
||||||
"See server log for more information.\n"
|
"See server log for more information.\n"
|
||||||
)
|
)
|
||||||
raise SanicException(msg, status_code=500)
|
raise ServerError(msg, status_code=500)
|
||||||
if 100 <= resp.status_code <= 299:
|
if 100 <= resp.status_code <= 299:
|
||||||
first_line = (
|
first_line = (
|
||||||
f"HTTP/1.1 {resp.status_code} {resp.reason_phrase}\r\n"
|
f"HTTP/1.1 {resp.status_code} {resp.reason_phrase}\r\n"
|
||||||
@@ -138,7 +138,7 @@ class WebSocketProtocol(HttpProtocol):
|
|||||||
rbody += b"\r\n\r\n"
|
rbody += b"\r\n\r\n"
|
||||||
await super().send(rbody)
|
await super().send(rbody)
|
||||||
else:
|
else:
|
||||||
raise SanicException(resp.body, resp.status_code)
|
raise ServerError(resp.body, resp.status_code)
|
||||||
self.websocket = WebsocketImplProtocol(
|
self.websocket = WebsocketImplProtocol(
|
||||||
ws_proto,
|
ws_proto,
|
||||||
ping_interval=self.websocket_ping_interval,
|
ping_interval=self.websocket_ping_interval,
|
||||||
|
|||||||
@@ -9,17 +9,19 @@ from sanic.config import Config
|
|||||||
from sanic.exceptions import ServerError
|
from sanic.exceptions import ServerError
|
||||||
from sanic.http.constants import HTTP
|
from sanic.http.constants import HTTP
|
||||||
from sanic.http.tls import get_ssl_context
|
from sanic.http.tls import get_ssl_context
|
||||||
|
from sanic.server.events import trigger_events
|
||||||
|
|
||||||
|
|
||||||
if TYPE_CHECKING:
|
if TYPE_CHECKING:
|
||||||
from sanic.app import Sanic
|
from sanic.app import Sanic
|
||||||
|
|
||||||
import asyncio
|
import asyncio
|
||||||
|
import multiprocessing
|
||||||
import os
|
import os
|
||||||
import socket
|
import socket
|
||||||
|
|
||||||
from functools import partial
|
from functools import partial
|
||||||
from signal import SIG_IGN, SIGINT, SIGTERM
|
from signal import SIG_IGN, SIGINT, SIGTERM, Signals
|
||||||
from signal import signal as signal_func
|
from signal import signal as signal_func
|
||||||
|
|
||||||
from sanic.application.ext import setup_ext
|
from sanic.application.ext import setup_ext
|
||||||
@@ -29,7 +31,11 @@ from sanic.log import error_logger, server_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
|
||||||
from sanic.server.socket import bind_unix_socket, remove_unix_socket
|
from sanic.server.socket import (
|
||||||
|
bind_socket,
|
||||||
|
bind_unix_socket,
|
||||||
|
remove_unix_socket,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
try:
|
try:
|
||||||
@@ -313,6 +319,94 @@ def _serve_http_3(
|
|||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def serve_single(server_settings):
|
||||||
|
main_start = server_settings.pop("main_start", None)
|
||||||
|
main_stop = server_settings.pop("main_stop", None)
|
||||||
|
|
||||||
|
if not server_settings.get("run_async"):
|
||||||
|
# create new event_loop after fork
|
||||||
|
loop = asyncio.new_event_loop()
|
||||||
|
asyncio.set_event_loop(loop)
|
||||||
|
server_settings["loop"] = loop
|
||||||
|
|
||||||
|
trigger_events(main_start, server_settings["loop"])
|
||||||
|
serve(**server_settings)
|
||||||
|
trigger_events(main_stop, server_settings["loop"])
|
||||||
|
|
||||||
|
server_settings["loop"].close()
|
||||||
|
|
||||||
|
|
||||||
|
def serve_multiple(server_settings, workers):
|
||||||
|
"""Start multiple server processes simultaneously. Stop on interrupt
|
||||||
|
and terminate signals, and drain connections when complete.
|
||||||
|
|
||||||
|
:param server_settings: kw arguments to be passed to the serve function
|
||||||
|
:param workers: number of workers to launch
|
||||||
|
:param stop_event: if provided, is used as a stop signal
|
||||||
|
:return:
|
||||||
|
"""
|
||||||
|
server_settings["reuse_port"] = True
|
||||||
|
server_settings["run_multiple"] = True
|
||||||
|
|
||||||
|
main_start = server_settings.pop("main_start", None)
|
||||||
|
main_stop = server_settings.pop("main_stop", None)
|
||||||
|
loop = asyncio.new_event_loop()
|
||||||
|
asyncio.set_event_loop(loop)
|
||||||
|
|
||||||
|
trigger_events(main_start, loop)
|
||||||
|
|
||||||
|
# Create a listening socket or use the one in settings
|
||||||
|
sock = server_settings.get("sock")
|
||||||
|
unix = server_settings["unix"]
|
||||||
|
backlog = server_settings["backlog"]
|
||||||
|
if unix:
|
||||||
|
sock = bind_unix_socket(unix, backlog=backlog)
|
||||||
|
server_settings["unix"] = unix
|
||||||
|
if sock is None:
|
||||||
|
sock = bind_socket(
|
||||||
|
server_settings["host"], server_settings["port"], backlog=backlog
|
||||||
|
)
|
||||||
|
sock.set_inheritable(True)
|
||||||
|
server_settings["sock"] = sock
|
||||||
|
server_settings["host"] = None
|
||||||
|
server_settings["port"] = None
|
||||||
|
|
||||||
|
processes = []
|
||||||
|
|
||||||
|
def sig_handler(signal, frame):
|
||||||
|
server_logger.info(
|
||||||
|
"Received signal %s. Shutting down.", Signals(signal).name
|
||||||
|
)
|
||||||
|
for process in processes:
|
||||||
|
os.kill(process.pid, SIGTERM)
|
||||||
|
|
||||||
|
signal_func(SIGINT, lambda s, f: sig_handler(s, f))
|
||||||
|
signal_func(SIGTERM, lambda s, f: sig_handler(s, f))
|
||||||
|
mp = multiprocessing.get_context("fork")
|
||||||
|
|
||||||
|
for _ in range(workers):
|
||||||
|
process = mp.Process(
|
||||||
|
target=serve,
|
||||||
|
kwargs=server_settings,
|
||||||
|
)
|
||||||
|
process.daemon = True
|
||||||
|
process.start()
|
||||||
|
processes.append(process)
|
||||||
|
|
||||||
|
for process in processes:
|
||||||
|
process.join()
|
||||||
|
|
||||||
|
# the above processes will block this until they're stopped
|
||||||
|
for process in processes:
|
||||||
|
process.terminate()
|
||||||
|
|
||||||
|
trigger_events(main_stop, loop)
|
||||||
|
|
||||||
|
sock.close()
|
||||||
|
loop.close()
|
||||||
|
remove_unix_socket(unix)
|
||||||
|
|
||||||
|
|
||||||
def _build_protocol_kwargs(
|
def _build_protocol_kwargs(
|
||||||
protocol: Type[asyncio.Protocol], config: Config
|
protocol: Type[asyncio.Protocol], config: Config
|
||||||
) -> Dict[str, Union[int, float]]:
|
) -> Dict[str, Union[int, float]]:
|
||||||
|
|||||||
@@ -29,7 +29,7 @@ except ImportError: # websockets >= 11.0
|
|||||||
|
|
||||||
from websockets.typing import Data
|
from websockets.typing import Data
|
||||||
|
|
||||||
from sanic.log import error_logger, logger
|
from sanic.log import deprecation, 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
|
||||||
@@ -99,6 +99,15 @@ class WebsocketImplProtocol:
|
|||||||
def subprotocol(self):
|
def subprotocol(self):
|
||||||
return self.ws_proto.subprotocol
|
return self.ws_proto.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:
|
||||||
return False
|
return False
|
||||||
|
|||||||
@@ -3,11 +3,8 @@ from __future__ import annotations
|
|||||||
import os
|
import os
|
||||||
import sys
|
import sys
|
||||||
|
|
||||||
from contextlib import suppress
|
|
||||||
from importlib import import_module
|
from importlib import import_module
|
||||||
from inspect import isfunction
|
|
||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
from ssl import SSLContext
|
|
||||||
from typing import TYPE_CHECKING, Any, Callable, Dict, Optional, Union, cast
|
from typing import TYPE_CHECKING, Any, Callable, Dict, Optional, Union, cast
|
||||||
|
|
||||||
from sanic.http.tls.context import process_to_context
|
from sanic.http.tls.context import process_to_context
|
||||||
@@ -17,8 +14,6 @@ from sanic.http.tls.creators import MkcertCreator, TrustmeCreator
|
|||||||
if TYPE_CHECKING:
|
if TYPE_CHECKING:
|
||||||
from sanic import Sanic as SanicApp
|
from sanic import Sanic as SanicApp
|
||||||
|
|
||||||
DEFAULT_APP_NAME = "app"
|
|
||||||
|
|
||||||
|
|
||||||
class AppLoader:
|
class AppLoader:
|
||||||
def __init__(
|
def __init__(
|
||||||
@@ -40,11 +35,7 @@ class AppLoader:
|
|||||||
|
|
||||||
if module_input:
|
if module_input:
|
||||||
delimiter = ":" if ":" in module_input else "."
|
delimiter = ":" if ":" in module_input else "."
|
||||||
if (
|
if module_input.count(delimiter):
|
||||||
delimiter in module_input
|
|
||||||
and "\\" not in module_input
|
|
||||||
and "/" not in module_input
|
|
||||||
):
|
|
||||||
module_name, app_name = module_input.rsplit(delimiter, 1)
|
module_name, app_name = module_input.rsplit(delimiter, 1)
|
||||||
self.module_name = module_name
|
self.module_name = module_name
|
||||||
self.app_name = app_name
|
self.app_name = app_name
|
||||||
@@ -63,30 +54,21 @@ class AppLoader:
|
|||||||
from sanic.app import Sanic
|
from sanic.app import Sanic
|
||||||
from sanic.simple import create_simple_server
|
from sanic.simple import create_simple_server
|
||||||
|
|
||||||
maybe_path = Path(self.module_input)
|
if self.as_simple:
|
||||||
if self.as_simple or (
|
path = Path(self.module_input)
|
||||||
maybe_path.is_dir()
|
app = create_simple_server(path)
|
||||||
and ("\\" in self.module_input or "/" in self.module_input)
|
|
||||||
):
|
|
||||||
app = create_simple_server(maybe_path)
|
|
||||||
else:
|
else:
|
||||||
implied_app_name = False
|
if self.module_name == "" and os.path.isdir(self.module_input):
|
||||||
if not self.module_name and not self.app_name:
|
raise ValueError(
|
||||||
self.module_name = self.module_input
|
"App not found.\n"
|
||||||
self.app_name = DEFAULT_APP_NAME
|
" Please use --simple if you are passing a "
|
||||||
implied_app_name = True
|
"directory to sanic.\n"
|
||||||
|
f" eg. sanic {self.module_input} --simple"
|
||||||
|
)
|
||||||
|
|
||||||
module = import_module(self.module_name)
|
module = import_module(self.module_name)
|
||||||
app = getattr(module, self.app_name, None)
|
app = getattr(module, self.app_name, None)
|
||||||
if not app and implied_app_name:
|
if self.as_factory:
|
||||||
raise ValueError(
|
|
||||||
"Looks like you only supplied a module name. Sanic "
|
|
||||||
"tried to locate an application instance named "
|
|
||||||
f"{self.module_name}:app, but was unable to locate "
|
|
||||||
"an application instance. Please provide a path "
|
|
||||||
"to a global instance of Sanic(), or a callable that "
|
|
||||||
"will return a Sanic() application instance."
|
|
||||||
)
|
|
||||||
if self.as_factory or isfunction(app):
|
|
||||||
try:
|
try:
|
||||||
app = app(self.args)
|
app = app(self.args)
|
||||||
except TypeError:
|
except TypeError:
|
||||||
@@ -97,18 +79,21 @@ class AppLoader:
|
|||||||
if (
|
if (
|
||||||
not isinstance(app, Sanic)
|
not isinstance(app, Sanic)
|
||||||
and self.args
|
and self.args
|
||||||
and hasattr(self.args, "target")
|
and hasattr(self.args, "module")
|
||||||
):
|
):
|
||||||
with suppress(ModuleNotFoundError):
|
if callable(app):
|
||||||
maybe_module = import_module(self.module_input)
|
solution = f"sanic {self.args.module} --factory"
|
||||||
app = getattr(maybe_module, "app", None)
|
raise ValueError(
|
||||||
if not app:
|
"Module is not a Sanic app, it is a "
|
||||||
message = (
|
f"{app_type_name}\n"
|
||||||
"Module is not a Sanic app, "
|
" If this callable returns a "
|
||||||
f"it is a {app_type_name}\n"
|
f"Sanic instance try: \n{solution}"
|
||||||
f" Perhaps you meant {self.args.target}:app?"
|
|
||||||
)
|
)
|
||||||
raise ValueError(message)
|
|
||||||
|
raise ValueError(
|
||||||
|
f"Module is not a Sanic app, it is a {app_type_name}\n"
|
||||||
|
f" Perhaps you meant {self.args.module}:app?"
|
||||||
|
)
|
||||||
return app
|
return app
|
||||||
|
|
||||||
|
|
||||||
@@ -118,16 +103,8 @@ class CertLoader:
|
|||||||
"trustme": TrustmeCreator,
|
"trustme": TrustmeCreator,
|
||||||
}
|
}
|
||||||
|
|
||||||
def __init__(
|
def __init__(self, ssl_data: Dict[str, Union[str, os.PathLike]]):
|
||||||
self,
|
|
||||||
ssl_data: Optional[
|
|
||||||
Union[SSLContext, Dict[str, Union[str, os.PathLike]]]
|
|
||||||
],
|
|
||||||
):
|
|
||||||
self._ssl_data = ssl_data
|
self._ssl_data = ssl_data
|
||||||
self._creator_class = None
|
|
||||||
if not ssl_data or not isinstance(ssl_data, dict):
|
|
||||||
return
|
|
||||||
|
|
||||||
creator_name = cast(str, ssl_data.get("creator"))
|
creator_name = cast(str, ssl_data.get("creator"))
|
||||||
|
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ from itertools import count
|
|||||||
from random import choice
|
from random import choice
|
||||||
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 typing import Any, Callable, Dict, List, Optional
|
from typing import Dict, List, Optional
|
||||||
|
|
||||||
from sanic.compat import OS_IS_WINDOWS
|
from sanic.compat import OS_IS_WINDOWS
|
||||||
from sanic.exceptions import ServerKilled
|
from sanic.exceptions import ServerKilled
|
||||||
@@ -54,36 +54,9 @@ class WorkerManager:
|
|||||||
signal_func(SIGINT, self.shutdown_signal)
|
signal_func(SIGINT, self.shutdown_signal)
|
||||||
signal_func(SIGTERM, self.shutdown_signal)
|
signal_func(SIGTERM, self.shutdown_signal)
|
||||||
|
|
||||||
def manage(
|
def manage(self, ident, func, kwargs, transient=False) -> Worker:
|
||||||
self,
|
|
||||||
ident: str,
|
|
||||||
func: Callable[..., Any],
|
|
||||||
kwargs: Dict[str, Any],
|
|
||||||
transient: bool = False,
|
|
||||||
workers: int = 1,
|
|
||||||
) -> Worker:
|
|
||||||
"""
|
|
||||||
Instruct Sanic to manage a custom process.
|
|
||||||
|
|
||||||
:param ident: A name for the worker process
|
|
||||||
:type ident: str
|
|
||||||
:param func: The function to call in the background process
|
|
||||||
:type func: Callable[..., Any]
|
|
||||||
:param kwargs: Arguments to pass to the function
|
|
||||||
:type kwargs: Dict[str, Any]
|
|
||||||
:param transient: Whether to mark the process as transient. If True
|
|
||||||
then the Worker Manager will restart the process along
|
|
||||||
with any global restart (ex: auto-reload), defaults to False
|
|
||||||
:type transient: bool, optional
|
|
||||||
:param workers: The number of worker processes to run, defaults to 1
|
|
||||||
:type workers: int, optional
|
|
||||||
:return: The Worker instance
|
|
||||||
:rtype: Worker
|
|
||||||
"""
|
|
||||||
container = self.transient if transient else self.durable
|
container = self.transient if transient else self.durable
|
||||||
worker = Worker(
|
worker = Worker(ident, func, kwargs, self.context, self.worker_state)
|
||||||
ident, func, kwargs, self.context, self.worker_state, workers
|
|
||||||
)
|
|
||||||
container[worker.ident] = worker
|
container[worker.ident] = worker
|
||||||
return worker
|
return worker
|
||||||
|
|
||||||
@@ -312,10 +285,6 @@ class WorkerManager:
|
|||||||
|
|
||||||
def _sync_states(self):
|
def _sync_states(self):
|
||||||
for process in self.processes:
|
for process in self.processes:
|
||||||
try:
|
state = self.worker_state[process.name].get("state")
|
||||||
state = self.worker_state[process.name].get("state")
|
|
||||||
except KeyError:
|
|
||||||
process.set_state(ProcessState.TERMINATED, True)
|
|
||||||
continue
|
|
||||||
if state and process.state.name != state:
|
if state and process.state.name != state:
|
||||||
process.set_state(ProcessState[state], True)
|
process.set_state(ProcessState[state], True)
|
||||||
|
|||||||
@@ -192,17 +192,14 @@ class Worker:
|
|||||||
server_settings,
|
server_settings,
|
||||||
context: BaseContext,
|
context: BaseContext,
|
||||||
worker_state: Dict[str, Any],
|
worker_state: Dict[str, Any],
|
||||||
num: int = 1,
|
|
||||||
):
|
):
|
||||||
self.ident = ident
|
self.ident = ident
|
||||||
self.num = num
|
|
||||||
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()
|
||||||
for _ in range(num):
|
self.create_process()
|
||||||
self.create_process()
|
|
||||||
|
|
||||||
def create_process(self) -> WorkerProcess:
|
def create_process(self) -> WorkerProcess:
|
||||||
process = WorkerProcess(
|
process = WorkerProcess(
|
||||||
|
|||||||
@@ -73,8 +73,8 @@ def worker_serve(
|
|||||||
info.settings["app"] = a
|
info.settings["app"] = a
|
||||||
a.state.server_info.append(info)
|
a.state.server_info.append(info)
|
||||||
|
|
||||||
if isinstance(ssl, dict) or app.certloader_class is not CertLoader:
|
if isinstance(ssl, dict):
|
||||||
cert_loader = app.certloader_class(ssl or {})
|
cert_loader = CertLoader(ssl)
|
||||||
ssl = cert_loader.load(app)
|
ssl = cert_loader.load(app)
|
||||||
for info in app.state.server_info:
|
for info in app.state.server_info:
|
||||||
info.settings["ssl"] = ssl
|
info.settings["ssl"] = ssl
|
||||||
|
|||||||
@@ -1,2 +1,4 @@
|
|||||||
[flake8]
|
[flake8]
|
||||||
ignore = E203, W503
|
ignore = E203, W503
|
||||||
|
per-file-ignores =
|
||||||
|
sanic/app.py:E402
|
||||||
|
|||||||
2
setup.py
2
setup.py
@@ -116,7 +116,7 @@ requirements = [
|
|||||||
]
|
]
|
||||||
|
|
||||||
tests_require = [
|
tests_require = [
|
||||||
"sanic-testing>=23.3.0",
|
"sanic-testing>=22.9.0",
|
||||||
"pytest==7.1.*",
|
"pytest==7.1.*",
|
||||||
"coverage",
|
"coverage",
|
||||||
"beautifulsoup4",
|
"beautifulsoup4",
|
||||||
|
|||||||
@@ -1,19 +0,0 @@
|
|||||||
-----BEGIN CERTIFICATE-----
|
|
||||||
MIIDCTCCAfGgAwIBAgIUa7OOlAGQfXOgUgRENJ9GbUgO7kwwDQYJKoZIhvcNAQEL
|
|
||||||
BQAwFDESMBAGA1UEAwwJMTI3LjAuMC4xMB4XDTIzMDMyMDA3MzE1M1oXDTIzMDQx
|
|
||||||
OTA3MzE1M1owFDESMBAGA1UEAwwJMTI3LjAuMC4xMIIBIjANBgkqhkiG9w0BAQEF
|
|
||||||
AAOCAQ8AMIIBCgKCAQEAn2/RqVpzO7GFrgVGiowR5CzcFzf1tSFti1K/WIGr/jsu
|
|
||||||
NP+1R3sim17pgg6SCOFnUMRS0KnDihkzoeP6z+0tFsrbCH4V1+fq0iud8WgYQrgD
|
|
||||||
3ttUcHrz04p7wsMoeqndUQoLbyJzP8MpA2XJsoacdIVkuLv2AESGXLhJym/e9HGN
|
|
||||||
g8bqdz25X0hVTczZW1FN9AZyWWVf9Go6jqC7LCaOnYXAnOkEy2/JHdkeNXYFZHB3
|
|
||||||
71UemfkCjfp0vlRV8pVpkBGMhRNFphBTfxdqeWiGQwVqrhaJO4M7DJlQHCAPY16P
|
|
||||||
o9ywnhLDhFHD7KIfTih9XxrdgTowqcwyGX3e3aJpTwIDAQABo1MwUTAdBgNVHQ4E
|
|
||||||
FgQU5NogMq6mRBeGl4i6hIuUlcR2bVEwHwYDVR0jBBgwFoAU5NogMq6mRBeGl4i6
|
|
||||||
hIuUlcR2bVEwDwYDVR0TAQH/BAUwAwEB/zANBgkqhkiG9w0BAQsFAAOCAQEAYW34
|
|
||||||
JY1kd0UO5HE41oxJD4PioQboXXX0al4RgKaUUsPykeHQbK0q0TSYAZLwRjooTVUO
|
|
||||||
Wvna5bU2mzyULqA2r/Cr/w4zb9xybO3SiHFHcU1RacouauHXROHwRm98i8A73xnH
|
|
||||||
vHws5BADr2ggnVcPNh4VOQ9ZvBlC7jhgpvMjqOEu5ZPCovhfZYfSsvBDHcD74ZYm
|
|
||||||
Di9DvqsJmrb23Dv3SUykm3W+Ql2q+JyjFj30rhD89CFwJ9iSlFwTYEwZLHA+mV6p
|
|
||||||
UKy3I3Fiht1Oc+nIivX5uhRSMbDVvDTVHbjjPujxxFjkiHXMjtwvwfg4Sb6du61q
|
|
||||||
AjBRFyXbNu4hZkkHOA==
|
|
||||||
-----END CERTIFICATE-----
|
|
||||||
@@ -1,30 +0,0 @@
|
|||||||
-----BEGIN ENCRYPTED PRIVATE KEY-----
|
|
||||||
MIIFLTBXBgkqhkiG9w0BBQ0wSjApBgkqhkiG9w0BBQwwHAQI94UBqjaZlG4CAggA
|
|
||||||
MAwGCCqGSIb3DQIJBQAwHQYJYIZIAWUDBAEqBBCvJhEy+3/+0Ec0gpd5dkP6BIIE
|
|
||||||
0E7rLplTe9rxK3sR9V0cx8Xn6V+uFhG3p7dzeMDCCKpGo9MEaacF5m+paGnBkMlH
|
|
||||||
Pz3rRoLA5jqzwXl4US/C5E1Or//2YBgF1XXKi3BPF/bVx/g6vR+xeobf9kQGbqQk
|
|
||||||
FNPYtP7mpg2dekp5BUsKSosIt8BkknWFvhBeNuGZT/zlMUuq1WpMe4KIh/W9IdNr
|
|
||||||
HolcuZJWBhQAwGPciWIZRyq48wKa++W7Jdg/aG8FviJQnjaAUv4CyZJHUJnaNwUx
|
|
||||||
iHOETpzIC+bhF2K+s4g5w68VCj6Jtz78sIBEZKzo7LI5QHdRHqYB5SJ/dGiV+h09
|
|
||||||
R/rQ/M+24mwHDlRSCxxq0yuDwUuGBlHyATeDCFeE3L5OX8yTLuqYJ6vUa6UbzMYA
|
|
||||||
8H4l5zfu9RrAhKYa9tD+4ONxMmHziIgmn5zvSXeBwJKfeUbnN4IKWLsSoSVspBRh
|
|
||||||
zLl51DMAnem4NEjLfIW8WYjhsvSYwd9BYqxXaAiv4Wjx9ZV1yLqFICC7tejpVdRT
|
|
||||||
afI0qMOfWu4ma6xVBg1ezLgF1wHIPrq6euTvWdnifYQopVICALlltEo5oxQ2i/OM
|
|
||||||
NY8RyovWujiGNsa3pId9HmZXiLyLXjKPstGWRK4liMyc2EiP099gTdBvrb+VQp+I
|
|
||||||
EyPavmh3WNhgZGOh3qah39X8HrBprc0PPfSPlxpaWdNMIIMSbcIWWdJEA/e4tcy/
|
|
||||||
uBaV4H3sNCtBApgrb6B9YUbS9CXNUburJo19T1sk2uCaO12qYfdu2IDEnFf8JiF3
|
|
||||||
i7nyftotRuoKq2D+V8d0PeMi/vJSo6+eZIn7VNe6ejYf+w0s7sxlpiKVzkslyOhq
|
|
||||||
n0T4M3ZkSwGIETzgkRRuTY1OK7slhglMgXlQ2FuIUUo6CRg9WjRJvI5rujLzLWfB
|
|
||||||
hkgP8STirjTV0DUWPFGtUcenvEcZPkYIQcoPHxOJGNW3ZPXNpt4RjbvPLeVzDm0O
|
|
||||||
WJiay/qhag/bXGqKraO3b6Y7FOzJa8kG4G0XrcFY1s2oCXRqRqYJAtwaEeVCjCSJ
|
|
||||||
Qy0OZkqcJEU7pv98pLMpG9OWz4Gle77g4KoQUJjQGtmg0MUMoPd0iPRmvkxsYg8E
|
|
||||||
Q9uZS3m6PpWmmYDY0Ik1w/4avs3skl2mW3dqcZGLEepkjiQSnFABsuvxKd+uIEQy
|
|
||||||
lyf9FrynXVcUI87LUkuniLRKwZZzFALVuc+BwtO3SA5mvEK22ZEq9QOysbwlpN54
|
|
||||||
G5xXJKJEeexUSjEUIij4J89RLsXldibhp7YYZ7rFviR6chIqC0V7G6VqAM9TOCrV
|
|
||||||
PWZXr3ZY5/pCZYs5DYKFJBFMSQ2UT/++VYxdZCeBH75vaxugbS8RdUM+iVDevWpQ
|
|
||||||
/AnP1FolNAgkVhi3Rw4L16SibkqpEzIi1svPWKMwXdvewA32UidLElhuTWWjI2Wm
|
|
||||||
veXhmEqwk/7ML4JMI7wHcDQdvSKen0mCL2J9tB7A/pewYyDE0ffIUmjxglOtw30f
|
|
||||||
ZOlQKhMaKJGXp00U2zsHA2NJRI/hThbJncsnZyvuLei0P42RrF+r64b/0gUH6IZ5
|
|
||||||
wPUttT815KSNoy+XXXum9YGDYYFoAL+6WVEkl6dgo+X0hcH7DDf5Nkewiq8UcJGh
|
|
||||||
/69vFIfp+JlpicXzZ+R42LO3T3luC907aFBywF3pmi//
|
|
||||||
-----END ENCRYPTED PRIVATE KEY-----
|
|
||||||
@@ -49,6 +49,6 @@ def create_app_with_args(args):
|
|||||||
try:
|
try:
|
||||||
logger.info(f"foo={args.foo}")
|
logger.info(f"foo={args.foo}")
|
||||||
except AttributeError:
|
except AttributeError:
|
||||||
logger.info(f"target={args.target}")
|
logger.info(f"module={args.module}")
|
||||||
|
|
||||||
return app
|
return app
|
||||||
|
|||||||
@@ -11,7 +11,7 @@ from aioquic.quic.events import ProtocolNegotiated
|
|||||||
from sanic import Request, Sanic
|
from sanic import Request, Sanic
|
||||||
from sanic.compat import Header
|
from sanic.compat import Header
|
||||||
from sanic.config import DEFAULT_CONFIG
|
from sanic.config import DEFAULT_CONFIG
|
||||||
from sanic.exceptions import BadRequest, PayloadTooLarge
|
from sanic.exceptions import PayloadTooLarge
|
||||||
from sanic.http.constants import Stage
|
from sanic.http.constants import Stage
|
||||||
from sanic.http.http3 import Http3, HTTPReceiver
|
from sanic.http.http3 import Http3, HTTPReceiver
|
||||||
from sanic.models.server_types import ConnInfo
|
from sanic.models.server_types import ConnInfo
|
||||||
@@ -292,48 +292,3 @@ def test_request_conn_info(app):
|
|||||||
receiver = http3.get_receiver_by_stream_id(1)
|
receiver = http3.get_receiver_by_stream_id(1)
|
||||||
|
|
||||||
assert isinstance(receiver.request.conn_info, ConnInfo)
|
assert isinstance(receiver.request.conn_info, ConnInfo)
|
||||||
|
|
||||||
|
|
||||||
def test_request_header_encoding(app):
|
|
||||||
protocol = generate_protocol(app)
|
|
||||||
http3 = Http3(protocol, protocol.transmit)
|
|
||||||
with pytest.raises(BadRequest) as exc_info:
|
|
||||||
http3.http_event_received(
|
|
||||||
HeadersReceived(
|
|
||||||
[
|
|
||||||
(b":method", b"GET"),
|
|
||||||
(b":path", b"/location"),
|
|
||||||
(b":scheme", b"https"),
|
|
||||||
(b":authority", b"localhost:8443"),
|
|
||||||
("foo\u00A0".encode(), b"bar"),
|
|
||||||
],
|
|
||||||
1,
|
|
||||||
False,
|
|
||||||
)
|
|
||||||
)
|
|
||||||
assert exc_info.value.status_code == 400
|
|
||||||
assert (
|
|
||||||
str(exc_info.value)
|
|
||||||
== "Header names may only contain US-ASCII characters."
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
def test_request_url_encoding(app):
|
|
||||||
protocol = generate_protocol(app)
|
|
||||||
http3 = Http3(protocol, protocol.transmit)
|
|
||||||
with pytest.raises(BadRequest) as exc_info:
|
|
||||||
http3.http_event_received(
|
|
||||||
HeadersReceived(
|
|
||||||
[
|
|
||||||
(b":method", b"GET"),
|
|
||||||
(b":path", b"/location\xA0"),
|
|
||||||
(b":scheme", b"https"),
|
|
||||||
(b":authority", b"localhost:8443"),
|
|
||||||
(b"foo", b"bar"),
|
|
||||||
],
|
|
||||||
1,
|
|
||||||
False,
|
|
||||||
)
|
|
||||||
)
|
|
||||||
assert exc_info.value.status_code == 400
|
|
||||||
assert str(exc_info.value) == "URL may only contain US-ASCII characters."
|
|
||||||
|
|||||||
@@ -448,7 +448,7 @@ def test_custom_context():
|
|||||||
|
|
||||||
@pytest.mark.parametrize("use", (False, True))
|
@pytest.mark.parametrize("use", (False, True))
|
||||||
def test_uvloop_config(app: Sanic, monkeypatch, use):
|
def test_uvloop_config(app: Sanic, monkeypatch, use):
|
||||||
@app.get("/test", name="test")
|
@app.get("/test")
|
||||||
def handler(request):
|
def handler(request):
|
||||||
return text("ok")
|
return text("ok")
|
||||||
|
|
||||||
@@ -571,6 +571,21 @@ def test_cannot_run_single_process_and_workers_or_auto_reload(
|
|||||||
app.run(single_process=True, **extra)
|
app.run(single_process=True, **extra)
|
||||||
|
|
||||||
|
|
||||||
|
def test_cannot_run_single_process_and_legacy(app: Sanic):
|
||||||
|
message = "Cannot run single process and legacy mode"
|
||||||
|
with pytest.raises(RuntimeError, match=message):
|
||||||
|
app.run(single_process=True, legacy=True)
|
||||||
|
|
||||||
|
|
||||||
|
def test_cannot_run_without_sys_signals_with_workers(app: Sanic):
|
||||||
|
message = (
|
||||||
|
"Cannot run Sanic.serve with register_sys_signals=False. "
|
||||||
|
"Use either Sanic.serve_single or Sanic.serve_legacy."
|
||||||
|
)
|
||||||
|
with pytest.raises(RuntimeError, match=message):
|
||||||
|
app.run(register_sys_signals=False, single_process=False, legacy=False)
|
||||||
|
|
||||||
|
|
||||||
def test_default_configure_logging():
|
def test_default_configure_logging():
|
||||||
with patch("sanic.app.logging") as mock:
|
with patch("sanic.app.logging") as mock:
|
||||||
Sanic("Test")
|
Sanic("Test")
|
||||||
|
|||||||
@@ -2,17 +2,13 @@ import asyncio
|
|||||||
import logging
|
import logging
|
||||||
|
|
||||||
from collections import deque, namedtuple
|
from collections import deque, namedtuple
|
||||||
from unittest.mock import call
|
|
||||||
|
|
||||||
import pytest
|
import pytest
|
||||||
import uvicorn
|
import uvicorn
|
||||||
|
|
||||||
from httpx import Headers
|
|
||||||
from pytest import MonkeyPatch
|
|
||||||
|
|
||||||
from sanic import Sanic
|
from sanic import Sanic
|
||||||
from sanic.application.state import Mode
|
from sanic.application.state import Mode
|
||||||
from sanic.asgi import ASGIApp, Lifespan, MockTransport
|
from sanic.asgi import ASGIApp, MockTransport
|
||||||
from sanic.exceptions import BadRequest, Forbidden, ServiceUnavailable
|
from sanic.exceptions import BadRequest, Forbidden, ServiceUnavailable
|
||||||
from sanic.request import Request
|
from sanic.request import Request
|
||||||
from sanic.response import json, text
|
from sanic.response import json, text
|
||||||
@@ -120,6 +116,10 @@ def test_listeners_triggered(caplog):
|
|||||||
stop_message,
|
stop_message,
|
||||||
) not in caplog.record_tuples
|
) not in caplog.record_tuples
|
||||||
|
|
||||||
|
all_tasks = asyncio.all_tasks(asyncio.get_event_loop())
|
||||||
|
for task in all_tasks:
|
||||||
|
task.cancel()
|
||||||
|
|
||||||
assert before_server_start
|
assert before_server_start
|
||||||
assert after_server_start
|
assert after_server_start
|
||||||
assert before_server_stop
|
assert before_server_stop
|
||||||
@@ -218,6 +218,10 @@ def test_listeners_triggered_async(app, caplog):
|
|||||||
stop_message,
|
stop_message,
|
||||||
) not in caplog.record_tuples
|
) not in caplog.record_tuples
|
||||||
|
|
||||||
|
all_tasks = asyncio.all_tasks(asyncio.get_event_loop())
|
||||||
|
for task in all_tasks:
|
||||||
|
task.cancel()
|
||||||
|
|
||||||
assert before_server_start
|
assert before_server_start
|
||||||
assert after_server_start
|
assert after_server_start
|
||||||
assert before_server_stop
|
assert before_server_stop
|
||||||
@@ -268,6 +272,10 @@ def test_non_default_uvloop_config_raises_warning(app):
|
|||||||
with pytest.warns(UserWarning) as records:
|
with pytest.warns(UserWarning) as records:
|
||||||
server.run()
|
server.run()
|
||||||
|
|
||||||
|
all_tasks = asyncio.all_tasks(asyncio.get_event_loop())
|
||||||
|
for task in all_tasks:
|
||||||
|
task.cancel()
|
||||||
|
|
||||||
msg = ""
|
msg = ""
|
||||||
for record in records:
|
for record in records:
|
||||||
_msg = str(record.message)
|
_msg = str(record.message)
|
||||||
@@ -575,28 +583,15 @@ async def test_error_on_lifespan_exception_start(app, caplog):
|
|||||||
async def before_server_start(_):
|
async def before_server_start(_):
|
||||||
1 / 0
|
1 / 0
|
||||||
|
|
||||||
recv = AsyncMock(
|
recv = AsyncMock(return_value={"type": "lifespan.startup"})
|
||||||
side_effect=[
|
|
||||||
{"type": "lifespan.startup"},
|
|
||||||
{"type": "lifespan.shutdown"},
|
|
||||||
]
|
|
||||||
)
|
|
||||||
send = AsyncMock()
|
send = AsyncMock()
|
||||||
app.asgi = True
|
app.asgi = True
|
||||||
|
|
||||||
lifespan = Lifespan(app, {"type": "lifespan"}, recv, send)
|
|
||||||
with caplog.at_level(logging.ERROR):
|
with caplog.at_level(logging.ERROR):
|
||||||
await lifespan()
|
await ASGIApp.create(app, {"type": "lifespan"}, recv, send)
|
||||||
|
|
||||||
send.assert_has_calls(
|
send.assert_awaited_once_with(
|
||||||
[
|
{"type": "lifespan.startup.failed", "message": "division by zero"}
|
||||||
call(
|
|
||||||
{
|
|
||||||
"type": "lifespan.startup.failed",
|
|
||||||
"message": "division by zero",
|
|
||||||
}
|
|
||||||
)
|
|
||||||
]
|
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
@@ -606,63 +601,13 @@ async def test_error_on_lifespan_exception_stop(app: Sanic):
|
|||||||
async def before_server_stop(_):
|
async def before_server_stop(_):
|
||||||
1 / 0
|
1 / 0
|
||||||
|
|
||||||
recv = AsyncMock(
|
recv = AsyncMock(return_value={"type": "lifespan.shutdown"})
|
||||||
side_effect=[
|
|
||||||
{"type": "lifespan.startup"},
|
|
||||||
{"type": "lifespan.shutdown"},
|
|
||||||
]
|
|
||||||
)
|
|
||||||
send = AsyncMock()
|
send = AsyncMock()
|
||||||
app.asgi = True
|
app.asgi = True
|
||||||
await app._startup()
|
await app._startup()
|
||||||
|
|
||||||
lifespan = Lifespan(app, {"type": "lifespan"}, recv, send)
|
await ASGIApp.create(app, {"type": "lifespan"}, recv, send)
|
||||||
await lifespan()
|
|
||||||
|
|
||||||
send.assert_has_calls(
|
send.assert_awaited_once_with(
|
||||||
[
|
{"type": "lifespan.shutdown.failed", "message": "division by zero"}
|
||||||
call(
|
|
||||||
{
|
|
||||||
"type": "lifespan.shutdown.failed",
|
|
||||||
"message": "division by zero",
|
|
||||||
}
|
|
||||||
)
|
|
||||||
]
|
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
@pytest.mark.asyncio
|
|
||||||
async def test_asgi_headers_decoding(app: Sanic, monkeypatch: MonkeyPatch):
|
|
||||||
@app.get("/")
|
|
||||||
def handler(request: Request):
|
|
||||||
return text("")
|
|
||||||
|
|
||||||
headers_init = Headers.__init__
|
|
||||||
|
|
||||||
def mocked_headers_init(self, *args, **kwargs):
|
|
||||||
if "encoding" in kwargs:
|
|
||||||
kwargs.pop("encoding")
|
|
||||||
headers_init(self, encoding="utf-8", *args, **kwargs)
|
|
||||||
|
|
||||||
monkeypatch.setattr(Headers, "__init__", mocked_headers_init)
|
|
||||||
|
|
||||||
message = "Header names can only contain US-ASCII characters"
|
|
||||||
with pytest.raises(BadRequest, match=message):
|
|
||||||
_, response = await app.asgi_client.get("/", headers={"😂": "😅"})
|
|
||||||
|
|
||||||
_, response = await app.asgi_client.get("/", headers={"Test-Header": "😅"})
|
|
||||||
assert response.status_code == 200
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.mark.asyncio
|
|
||||||
async def test_asgi_url_decoding(app):
|
|
||||||
@app.get("/dir/<name>", unquote=True)
|
|
||||||
def _request(request: Request, name):
|
|
||||||
return text(name)
|
|
||||||
|
|
||||||
# 2F should not become a path separator (unquoted later)
|
|
||||||
_, response = await app.asgi_client.get("/dir/some%2Fpath")
|
|
||||||
assert response.text == "some/path"
|
|
||||||
|
|
||||||
_, response = await app.asgi_client.get("/dir/some%F0%9F%98%80path")
|
|
||||||
assert response.text == "some😀path"
|
|
||||||
|
|||||||
@@ -66,11 +66,3 @@ def test_bp_copy(app: Sanic):
|
|||||||
|
|
||||||
_, response = app.test_client.get("/version6/page")
|
_, response = app.test_client.get("/version6/page")
|
||||||
assert "Hello world!" in response.text
|
assert "Hello world!" in response.text
|
||||||
|
|
||||||
route_names = [route.name for route in app.router.routes]
|
|
||||||
assert "test_bp_copy.test_bp1.handle_request" in route_names
|
|
||||||
assert "test_bp_copy.test_bp2.handle_request" in route_names
|
|
||||||
assert "test_bp_copy.test_bp3.handle_request" in route_names
|
|
||||||
assert "test_bp_copy.test_bp4.handle_request" in route_names
|
|
||||||
assert "test_bp_copy.test_bp5.handle_request" in route_names
|
|
||||||
assert "test_bp_copy.test_bp6.handle_request" in route_names
|
|
||||||
|
|||||||
@@ -303,10 +303,6 @@ def test_bp_with_host_list(app: Sanic):
|
|||||||
|
|
||||||
assert response.text == "Hello subdomain!"
|
assert response.text == "Hello subdomain!"
|
||||||
|
|
||||||
route_names = [r.name for r in app.router.routes]
|
|
||||||
assert "test_bp_with_host_list.test_bp_host.handler1" in route_names
|
|
||||||
assert "test_bp_with_host_list.test_bp_host.handler2" in route_names
|
|
||||||
|
|
||||||
|
|
||||||
def test_several_bp_with_host_list(app: Sanic):
|
def test_several_bp_with_host_list(app: Sanic):
|
||||||
bp = Blueprint(
|
bp = Blueprint(
|
||||||
|
|||||||
@@ -43,10 +43,8 @@ def read_app_info(lines: List[str]):
|
|||||||
"appname,extra",
|
"appname,extra",
|
||||||
(
|
(
|
||||||
("fake.server.app", None),
|
("fake.server.app", None),
|
||||||
("fake.server", None),
|
|
||||||
("fake.server:create_app", "--factory"),
|
("fake.server:create_app", "--factory"),
|
||||||
("fake.server.create_app()", None),
|
("fake.server.create_app()", None),
|
||||||
("fake.server.create_app", None),
|
|
||||||
),
|
),
|
||||||
)
|
)
|
||||||
def test_server_run(
|
def test_server_run(
|
||||||
@@ -62,17 +60,14 @@ def test_server_run(
|
|||||||
assert "Goin' Fast @ http://127.0.0.1:8000" in lines
|
assert "Goin' Fast @ http://127.0.0.1:8000" in lines
|
||||||
|
|
||||||
|
|
||||||
@pytest.mark.parametrize(
|
def test_server_run_factory_with_args(caplog):
|
||||||
"command",
|
command = [
|
||||||
(
|
"fake.server.create_app_with_args",
|
||||||
["fake.server.create_app_with_args", "--factory"],
|
"--factory",
|
||||||
["fake.server.create_app_with_args"],
|
]
|
||||||
),
|
|
||||||
)
|
|
||||||
def test_server_run_factory_with_args(caplog, command):
|
|
||||||
lines = capture(command, caplog)
|
lines = capture(command, caplog)
|
||||||
|
|
||||||
assert "target=fake.server.create_app_with_args" in lines
|
assert "module=fake.server.create_app_with_args" in lines
|
||||||
|
|
||||||
|
|
||||||
def test_server_run_factory_with_args_arbitrary(caplog):
|
def test_server_run_factory_with_args_arbitrary(caplog):
|
||||||
@@ -86,6 +81,25 @@ def test_server_run_factory_with_args_arbitrary(caplog):
|
|||||||
assert "foo=bar" in lines
|
assert "foo=bar" in lines
|
||||||
|
|
||||||
|
|
||||||
|
def test_error_with_function_as_instance_without_factory_arg(caplog):
|
||||||
|
command = ["fake.server.create_app"]
|
||||||
|
lines = capture(command, caplog)
|
||||||
|
assert (
|
||||||
|
"Failed to run app: Module is not a Sanic app, it is a function\n "
|
||||||
|
"If this callable returns a Sanic instance try: \n"
|
||||||
|
"sanic fake.server.create_app --factory"
|
||||||
|
) in lines
|
||||||
|
|
||||||
|
|
||||||
|
def test_error_with_path_as_instance_without_simple_arg(caplog):
|
||||||
|
command = ["./fake/"]
|
||||||
|
lines = capture(command, caplog)
|
||||||
|
assert (
|
||||||
|
"Failed to run app: App not found.\n Please use --simple if you "
|
||||||
|
"are passing a directory to sanic.\n eg. sanic ./fake/ --simple"
|
||||||
|
) in lines
|
||||||
|
|
||||||
|
|
||||||
@pytest.mark.parametrize(
|
@pytest.mark.parametrize(
|
||||||
"cmd",
|
"cmd",
|
||||||
(
|
(
|
||||||
|
|||||||
@@ -1,16 +1,11 @@
|
|||||||
from datetime import datetime, timedelta
|
from datetime import datetime, timedelta
|
||||||
from http.cookies import SimpleCookie
|
from http.cookies import SimpleCookie
|
||||||
from unittest.mock import Mock
|
|
||||||
|
|
||||||
import pytest
|
import pytest
|
||||||
|
|
||||||
from sanic import Request, Sanic
|
from sanic import Sanic
|
||||||
from sanic.compat import Header
|
from sanic.cookies import Cookie
|
||||||
from sanic.cookies import Cookie, CookieJar
|
|
||||||
from sanic.cookies.request import CookieRequestParameters
|
|
||||||
from sanic.exceptions import ServerError
|
|
||||||
from sanic.response import text
|
from sanic.response import text
|
||||||
from sanic.response.convenience import json
|
|
||||||
|
|
||||||
|
|
||||||
# ------------------------------------------------------------ #
|
# ------------------------------------------------------------ #
|
||||||
@@ -116,23 +111,21 @@ def test_cookie_options(app):
|
|||||||
|
|
||||||
|
|
||||||
def test_cookie_deletion(app):
|
def test_cookie_deletion(app):
|
||||||
cookie_jar = None
|
|
||||||
|
|
||||||
@app.route("/")
|
@app.route("/")
|
||||||
def handler(request):
|
def handler(request):
|
||||||
nonlocal cookie_jar
|
|
||||||
response = text("OK")
|
response = text("OK")
|
||||||
del response.cookies["one"]
|
del response.cookies["i_want_to_die"]
|
||||||
response.cookies["two"] = "testing"
|
response.cookies["i_never_existed"] = "testing"
|
||||||
del response.cookies["two"]
|
del response.cookies["i_never_existed"]
|
||||||
cookie_jar = response.cookies
|
|
||||||
return response
|
return response
|
||||||
|
|
||||||
_, response = app.test_client.get("/")
|
request, response = app.test_client.get("/")
|
||||||
|
response_cookies = SimpleCookie()
|
||||||
|
response_cookies.load(response.headers.get("Set-Cookie", {}))
|
||||||
|
|
||||||
assert cookie_jar.get_cookie("one").max_age == 0
|
assert int(response_cookies["i_want_to_die"]["max-age"]) == 0
|
||||||
assert cookie_jar.get_cookie("two").max_age == 0
|
with pytest.raises(KeyError):
|
||||||
assert len(response.cookies) == 0
|
response.cookies["i_never_existed"]
|
||||||
|
|
||||||
|
|
||||||
def test_cookie_reserved_cookie():
|
def test_cookie_reserved_cookie():
|
||||||
@@ -259,262 +252,3 @@ def test_cookie_expires_illegal_instance_type(expires):
|
|||||||
with pytest.raises(expected_exception=TypeError) as e:
|
with pytest.raises(expected_exception=TypeError) as e:
|
||||||
c["expires"] = expires
|
c["expires"] = expires
|
||||||
assert e.message == "Cookie 'expires' property must be a datetime"
|
assert e.message == "Cookie 'expires' property must be a datetime"
|
||||||
|
|
||||||
|
|
||||||
@pytest.mark.parametrize("value", ("foo=one; foo=two", "foo=one;foo=two"))
|
|
||||||
def test_request_with_duplicate_cookie_key(value):
|
|
||||||
headers = Header({"Cookie": value})
|
|
||||||
request = Request(b"/", headers, "1.1", "GET", Mock(), Mock())
|
|
||||||
|
|
||||||
assert request.cookies["foo"] == "one"
|
|
||||||
assert request.cookies.get("foo") == "one"
|
|
||||||
assert request.cookies.getlist("foo") == ["one", "two"]
|
|
||||||
assert request.cookies.get("bar") is None
|
|
||||||
|
|
||||||
|
|
||||||
def test_cookie_jar_cookies():
|
|
||||||
headers = Header()
|
|
||||||
jar = CookieJar(headers)
|
|
||||||
jar.add_cookie("foo", "one")
|
|
||||||
jar.add_cookie("foo", "two", domain="example.com")
|
|
||||||
|
|
||||||
assert len(jar.cookies) == 2
|
|
||||||
assert len(headers) == 2
|
|
||||||
|
|
||||||
|
|
||||||
def test_cookie_jar_has_cookie():
|
|
||||||
headers = Header()
|
|
||||||
jar = CookieJar(headers)
|
|
||||||
jar.add_cookie("foo", "one")
|
|
||||||
jar.add_cookie("foo", "two", domain="example.com")
|
|
||||||
|
|
||||||
assert jar.has_cookie("foo")
|
|
||||||
assert jar.has_cookie("foo", domain="example.com")
|
|
||||||
assert not jar.has_cookie("foo", path="/unknown")
|
|
||||||
assert not jar.has_cookie("bar")
|
|
||||||
|
|
||||||
|
|
||||||
def test_cookie_jar_get_cookie():
|
|
||||||
headers = Header()
|
|
||||||
jar = CookieJar(headers)
|
|
||||||
cookie1 = jar.add_cookie("foo", "one")
|
|
||||||
cookie2 = jar.add_cookie("foo", "two", domain="example.com")
|
|
||||||
|
|
||||||
assert jar.get_cookie("foo") is cookie1
|
|
||||||
assert jar.get_cookie("foo", domain="example.com") is cookie2
|
|
||||||
assert jar.get_cookie("foo", path="/unknown") is None
|
|
||||||
assert jar.get_cookie("bar") is None
|
|
||||||
|
|
||||||
|
|
||||||
def test_cookie_jar_add_cookie_encode():
|
|
||||||
headers = Header()
|
|
||||||
jar = CookieJar(headers)
|
|
||||||
jar.add_cookie("foo", "one")
|
|
||||||
jar.add_cookie(
|
|
||||||
"foo",
|
|
||||||
"two",
|
|
||||||
domain="example.com",
|
|
||||||
path="/something",
|
|
||||||
secure=True,
|
|
||||||
max_age=999,
|
|
||||||
httponly=True,
|
|
||||||
samesite="strict",
|
|
||||||
)
|
|
||||||
jar.add_cookie("foo", "three", secure_prefix=True)
|
|
||||||
jar.add_cookie("foo", "four", host_prefix=True)
|
|
||||||
jar.add_cookie("foo", "five", host_prefix=True, partitioned=True)
|
|
||||||
|
|
||||||
encoded = [cookie.encode("ascii") for cookie in jar.cookies]
|
|
||||||
assert encoded == [
|
|
||||||
b"foo=one; Path=/; SameSite=Lax; Secure",
|
|
||||||
b"foo=two; Path=/something; Domain=example.com; Max-Age=999; SameSite=Strict; Secure; HttpOnly", # noqa
|
|
||||||
b"__Secure-foo=three; Path=/; SameSite=Lax; Secure",
|
|
||||||
b"__Host-foo=four; Path=/; SameSite=Lax; Secure",
|
|
||||||
b"__Host-foo=five; Path=/; SameSite=Lax; Secure; Partitioned",
|
|
||||||
]
|
|
||||||
|
|
||||||
|
|
||||||
def test_cookie_jar_old_school_cookie_encode():
|
|
||||||
headers = Header()
|
|
||||||
jar = CookieJar(headers)
|
|
||||||
jar["foo"] = "one"
|
|
||||||
jar["bar"] = "two"
|
|
||||||
jar["bar"]["domain"] = "example.com"
|
|
||||||
jar["bar"]["path"] = "/something"
|
|
||||||
jar["bar"]["secure"] = True
|
|
||||||
jar["bar"]["max-age"] = 999
|
|
||||||
jar["bar"]["httponly"] = True
|
|
||||||
jar["bar"]["samesite"] = "strict"
|
|
||||||
|
|
||||||
encoded = [cookie.encode("ascii") for cookie in jar.cookies]
|
|
||||||
assert encoded == [
|
|
||||||
b"foo=one; Path=/",
|
|
||||||
b"bar=two; Path=/something; Domain=example.com; Max-Age=999; SameSite=Strict; Secure; HttpOnly", # noqa
|
|
||||||
]
|
|
||||||
|
|
||||||
|
|
||||||
def test_cookie_jar_delete_cookie_encode():
|
|
||||||
headers = Header()
|
|
||||||
jar = CookieJar(headers)
|
|
||||||
jar.delete_cookie("foo")
|
|
||||||
jar.delete_cookie("foo", domain="example.com")
|
|
||||||
|
|
||||||
encoded = [cookie.encode("ascii") for cookie in jar.cookies]
|
|
||||||
assert encoded == [
|
|
||||||
b'foo=""; Path=/; Max-Age=0; Secure',
|
|
||||||
b'foo=""; Path=/; Domain=example.com; Max-Age=0; Secure',
|
|
||||||
]
|
|
||||||
|
|
||||||
|
|
||||||
def test_cookie_jar_old_school_delete_encode():
|
|
||||||
headers = Header()
|
|
||||||
jar = CookieJar(headers)
|
|
||||||
del jar["foo"]
|
|
||||||
|
|
||||||
encoded = [cookie.encode("ascii") for cookie in jar.cookies]
|
|
||||||
assert encoded == [
|
|
||||||
b'foo=""; Path=/; Max-Age=0; Secure',
|
|
||||||
]
|
|
||||||
|
|
||||||
|
|
||||||
def test_bad_cookie_prarms():
|
|
||||||
headers = Header()
|
|
||||||
jar = CookieJar(headers)
|
|
||||||
|
|
||||||
with pytest.raises(
|
|
||||||
ServerError,
|
|
||||||
match=(
|
|
||||||
"Both host_prefix and secure_prefix were requested. "
|
|
||||||
"A cookie should have only one prefix."
|
|
||||||
),
|
|
||||||
):
|
|
||||||
jar.add_cookie("foo", "bar", host_prefix=True, secure_prefix=True)
|
|
||||||
|
|
||||||
with pytest.raises(
|
|
||||||
ServerError,
|
|
||||||
match="Cannot set host_prefix on a cookie without secure=True",
|
|
||||||
):
|
|
||||||
jar.add_cookie("foo", "bar", host_prefix=True, secure=False)
|
|
||||||
|
|
||||||
with pytest.raises(
|
|
||||||
ServerError,
|
|
||||||
match="Cannot set host_prefix on a cookie unless path='/'",
|
|
||||||
):
|
|
||||||
jar.add_cookie(
|
|
||||||
"foo", "bar", host_prefix=True, secure=True, path="/foo"
|
|
||||||
)
|
|
||||||
|
|
||||||
with pytest.raises(
|
|
||||||
ServerError,
|
|
||||||
match="Cannot set host_prefix on a cookie with a defined domain",
|
|
||||||
):
|
|
||||||
jar.add_cookie(
|
|
||||||
"foo", "bar", host_prefix=True, secure=True, domain="foo.bar"
|
|
||||||
)
|
|
||||||
|
|
||||||
with pytest.raises(
|
|
||||||
ServerError,
|
|
||||||
match="Cannot set secure_prefix on a cookie without secure=True",
|
|
||||||
):
|
|
||||||
jar.add_cookie("foo", "bar", secure_prefix=True, secure=False)
|
|
||||||
|
|
||||||
with pytest.raises(
|
|
||||||
ServerError,
|
|
||||||
match=(
|
|
||||||
"Cannot create a partitioned cookie without "
|
|
||||||
"also setting host_prefix=True"
|
|
||||||
),
|
|
||||||
):
|
|
||||||
jar.add_cookie("foo", "bar", partitioned=True)
|
|
||||||
|
|
||||||
|
|
||||||
def test_cookie_accessors(app: Sanic):
|
|
||||||
@app.get("/")
|
|
||||||
async def handler(request: Request):
|
|
||||||
return json(
|
|
||||||
{
|
|
||||||
"getitem": {
|
|
||||||
"one": request.cookies["one"],
|
|
||||||
"two": request.cookies["two"],
|
|
||||||
"three": request.cookies["three"],
|
|
||||||
},
|
|
||||||
"get": {
|
|
||||||
"one": request.cookies.get("one", "fallback"),
|
|
||||||
"two": request.cookies.get("two", "fallback"),
|
|
||||||
"three": request.cookies.get("three", "fallback"),
|
|
||||||
"four": request.cookies.get("four", "fallback"),
|
|
||||||
},
|
|
||||||
"getlist": {
|
|
||||||
"one": request.cookies.getlist("one", ["fallback"]),
|
|
||||||
"two": request.cookies.getlist("two", ["fallback"]),
|
|
||||||
"three": request.cookies.getlist("three", ["fallback"]),
|
|
||||||
"four": request.cookies.getlist("four", ["fallback"]),
|
|
||||||
},
|
|
||||||
"getattr": {
|
|
||||||
"one": request.cookies.one,
|
|
||||||
"two": request.cookies.two,
|
|
||||||
"three": request.cookies.three,
|
|
||||||
"four": request.cookies.four,
|
|
||||||
},
|
|
||||||
}
|
|
||||||
)
|
|
||||||
|
|
||||||
_, response = app.test_client.get(
|
|
||||||
"/",
|
|
||||||
cookies={
|
|
||||||
"__Host-one": "1",
|
|
||||||
"__Secure-two": "2",
|
|
||||||
"three": "3",
|
|
||||||
},
|
|
||||||
)
|
|
||||||
|
|
||||||
assert response.json == {
|
|
||||||
"getitem": {
|
|
||||||
"one": "1",
|
|
||||||
"two": "2",
|
|
||||||
"three": "3",
|
|
||||||
},
|
|
||||||
"get": {
|
|
||||||
"one": "1",
|
|
||||||
"two": "2",
|
|
||||||
"three": "3",
|
|
||||||
"four": "fallback",
|
|
||||||
},
|
|
||||||
"getlist": {
|
|
||||||
"one": ["1"],
|
|
||||||
"two": ["2"],
|
|
||||||
"three": ["3"],
|
|
||||||
"four": ["fallback"],
|
|
||||||
},
|
|
||||||
"getattr": {
|
|
||||||
"one": "1",
|
|
||||||
"two": "2",
|
|
||||||
"three": "3",
|
|
||||||
"four": "",
|
|
||||||
},
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
def test_cookie_accessor_hyphens():
|
|
||||||
cookies = CookieRequestParameters({"session-token": ["abc123"]})
|
|
||||||
|
|
||||||
assert cookies.get("session-token") == cookies.session_token
|
|
||||||
|
|
||||||
|
|
||||||
def test_cookie_passthru(app):
|
|
||||||
cookie_jar = None
|
|
||||||
|
|
||||||
@app.route("/")
|
|
||||||
def handler(request):
|
|
||||||
nonlocal cookie_jar
|
|
||||||
response = text("OK")
|
|
||||||
response.add_cookie("one", "1", host_prefix=True)
|
|
||||||
response.delete_cookie("two", secure_prefix=True)
|
|
||||||
cookie_jar = response.cookies
|
|
||||||
return response
|
|
||||||
|
|
||||||
_, response = app.test_client.get("/")
|
|
||||||
|
|
||||||
assert cookie_jar.get_cookie("two", secure_prefix=True).max_age == 0
|
|
||||||
assert len(response.cookies) == 1
|
|
||||||
assert response.cookies["__Host-one"] == "1"
|
|
||||||
|
|||||||
@@ -248,9 +248,9 @@ def test_fallback_with_content_type_mismatch_accept(app):
|
|||||||
|
|
||||||
app.router.reset()
|
app.router.reset()
|
||||||
|
|
||||||
@app.route("/alt1", name="alt1")
|
@app.route("/alt1")
|
||||||
@app.route("/alt2", error_format="text", name="alt2")
|
@app.route("/alt2", error_format="text")
|
||||||
@app.route("/alt3", error_format="html", name="alt3")
|
@app.route("/alt3", error_format="html")
|
||||||
def handler(_):
|
def handler(_):
|
||||||
raise Exception("problem here")
|
raise Exception("problem here")
|
||||||
# Yes, we know this return value is unreachable. This is on purpose.
|
# Yes, we know this return value is unreachable. This is on purpose.
|
||||||
|
|||||||
@@ -285,15 +285,9 @@ def test_contextual_exception_context(debug):
|
|||||||
def fail():
|
def fail():
|
||||||
raise TeapotError(context={"foo": "bar"})
|
raise TeapotError(context={"foo": "bar"})
|
||||||
|
|
||||||
app.post("/coffee/json", error_format="json", name="json")(
|
app.post("/coffee/json", error_format="json")(lambda _: fail())
|
||||||
lambda _: fail()
|
app.post("/coffee/html", error_format="html")(lambda _: fail())
|
||||||
)
|
app.post("/coffee/text", error_format="text")(lambda _: fail())
|
||||||
app.post("/coffee/html", error_format="html", name="html")(
|
|
||||||
lambda _: fail()
|
|
||||||
)
|
|
||||||
app.post("/coffee/text", error_format="text", name="text")(
|
|
||||||
lambda _: fail()
|
|
||||||
)
|
|
||||||
|
|
||||||
_, response = app.test_client.post("/coffee/json", debug=debug)
|
_, response = app.test_client.post("/coffee/json", debug=debug)
|
||||||
assert response.status == 418
|
assert response.status == 418
|
||||||
@@ -329,15 +323,9 @@ def test_contextual_exception_extra(debug):
|
|||||||
def fail():
|
def fail():
|
||||||
raise TeapotError(extra={"foo": "bar"})
|
raise TeapotError(extra={"foo": "bar"})
|
||||||
|
|
||||||
app.post("/coffee/json", error_format="json", name="json")(
|
app.post("/coffee/json", error_format="json")(lambda _: fail())
|
||||||
lambda _: fail()
|
app.post("/coffee/html", error_format="html")(lambda _: fail())
|
||||||
)
|
app.post("/coffee/text", error_format="text")(lambda _: fail())
|
||||||
app.post("/coffee/html", error_format="html", name="html")(
|
|
||||||
lambda _: fail()
|
|
||||||
)
|
|
||||||
app.post("/coffee/text", error_format="text", name="text")(
|
|
||||||
lambda _: fail()
|
|
||||||
)
|
|
||||||
|
|
||||||
_, response = app.test_client.post("/coffee/json", debug=debug)
|
_, response = app.test_client.post("/coffee/json", debug=debug)
|
||||||
assert response.status == 418
|
assert response.status == 418
|
||||||
|
|||||||
@@ -266,17 +266,20 @@ def test_exception_handler_response_was_sent(
|
|||||||
assert "Error" in response.text
|
assert "Error" in response.text
|
||||||
|
|
||||||
|
|
||||||
def test_errir_on_duplicate(app: Sanic):
|
def test_warn_on_duplicate(
|
||||||
|
app: Sanic, caplog: LogCaptureFixture, recwarn: WarningsRecorder
|
||||||
|
):
|
||||||
@app.exception(ServerError)
|
@app.exception(ServerError)
|
||||||
async def exception_handler_1(request, exception):
|
async def exception_handler_1(request, exception):
|
||||||
...
|
...
|
||||||
|
|
||||||
message = (
|
@app.exception(ServerError)
|
||||||
|
async def exception_handler_2(request, exception):
|
||||||
|
...
|
||||||
|
|
||||||
|
assert len(caplog.records) == 1
|
||||||
|
assert len(recwarn) == 1
|
||||||
|
assert caplog.records[0].message == (
|
||||||
"Duplicate exception handler definition on: route=__ALL_ROUTES__ and "
|
"Duplicate exception handler definition on: route=__ALL_ROUTES__ and "
|
||||||
"exception=<class 'sanic.exceptions.ServerError'>"
|
"exception=<class 'sanic.exceptions.ServerError'>"
|
||||||
)
|
)
|
||||||
with pytest.raises(ServerError, match=message):
|
|
||||||
|
|
||||||
@app.exception(ServerError)
|
|
||||||
async def exception_handler_2(request, exception):
|
|
||||||
...
|
|
||||||
|
|||||||
@@ -98,17 +98,3 @@ def test_transfer_chunked(client):
|
|||||||
data = stdjson.loads(body)
|
data = stdjson.loads(body)
|
||||||
|
|
||||||
assert data == ["foo", "bar"]
|
assert data == ["foo", "bar"]
|
||||||
|
|
||||||
|
|
||||||
def test_url_encoding(client):
|
|
||||||
client.send(
|
|
||||||
"""
|
|
||||||
GET /invalid\xA0url HTTP/1.1
|
|
||||||
|
|
||||||
"""
|
|
||||||
)
|
|
||||||
response = client.recv()
|
|
||||||
headers, body = response.rsplit(b"\r\n\r\n", 1)
|
|
||||||
|
|
||||||
assert b"400 Bad Request" in headers
|
|
||||||
assert b"URL may only contain US-ASCII characters." in body
|
|
||||||
|
|||||||
@@ -1,54 +0,0 @@
|
|||||||
import pytest
|
|
||||||
|
|
||||||
from sanic import Sanic, text
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture
|
|
||||||
def late_app(app: Sanic):
|
|
||||||
app.config.TOUCHUP = False
|
|
||||||
app.get("/")(lambda _: text(""))
|
|
||||||
return app
|
|
||||||
|
|
||||||
|
|
||||||
def test_late_route(late_app: Sanic):
|
|
||||||
@late_app.before_server_start
|
|
||||||
async def late(app: Sanic):
|
|
||||||
@app.get("/late")
|
|
||||||
def handler(_):
|
|
||||||
return text("late")
|
|
||||||
|
|
||||||
_, response = late_app.test_client.get("/late")
|
|
||||||
assert response.status_code == 200
|
|
||||||
assert response.text == "late"
|
|
||||||
|
|
||||||
|
|
||||||
def test_late_middleware(late_app: Sanic):
|
|
||||||
@late_app.get("/late")
|
|
||||||
def handler(request):
|
|
||||||
return text(request.ctx.late)
|
|
||||||
|
|
||||||
@late_app.before_server_start
|
|
||||||
async def late(app: Sanic):
|
|
||||||
@app.on_request
|
|
||||||
def handler(request):
|
|
||||||
request.ctx.late = "late"
|
|
||||||
|
|
||||||
_, response = late_app.test_client.get("/late")
|
|
||||||
assert response.status_code == 200
|
|
||||||
assert response.text == "late"
|
|
||||||
|
|
||||||
|
|
||||||
def test_late_signal(late_app: Sanic):
|
|
||||||
@late_app.get("/late")
|
|
||||||
def handler(request):
|
|
||||||
return text(request.ctx.late)
|
|
||||||
|
|
||||||
@late_app.before_server_start
|
|
||||||
async def late(app: Sanic):
|
|
||||||
@app.signal("http.lifecycle.request")
|
|
||||||
def handler(request):
|
|
||||||
request.ctx.late = "late"
|
|
||||||
|
|
||||||
_, response = late_app.test_client.get("/late")
|
|
||||||
assert response.status_code == 200
|
|
||||||
assert response.text == "late"
|
|
||||||
@@ -49,6 +49,96 @@ def test_multiprocessing(app):
|
|||||||
assert len(process_list) == num_workers + 1
|
assert len(process_list) == num_workers + 1
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.skipif(
|
||||||
|
not hasattr(signal, "SIGALRM"),
|
||||||
|
reason="SIGALRM is not implemented for this platform, we have to come "
|
||||||
|
"up with another timeout strategy to test these",
|
||||||
|
)
|
||||||
|
def test_multiprocessing_legacy(app):
|
||||||
|
"""Tests that the number of children we produce is correct"""
|
||||||
|
# Selects a number at random so we can spot check
|
||||||
|
num_workers = random.choice(range(2, multiprocessing.cpu_count() * 2 + 1))
|
||||||
|
process_list = set()
|
||||||
|
|
||||||
|
@app.after_server_start
|
||||||
|
async def shutdown(app):
|
||||||
|
await sleep(2.1)
|
||||||
|
app.stop()
|
||||||
|
|
||||||
|
def stop_on_alarm(*args):
|
||||||
|
for process in multiprocessing.active_children():
|
||||||
|
process_list.add(process.pid)
|
||||||
|
|
||||||
|
signal.signal(signal.SIGALRM, stop_on_alarm)
|
||||||
|
signal.alarm(2)
|
||||||
|
app.run(HOST, 4121, workers=num_workers, debug=True, legacy=True)
|
||||||
|
|
||||||
|
assert len(process_list) == num_workers
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.skipif(
|
||||||
|
not hasattr(signal, "SIGALRM"),
|
||||||
|
reason="SIGALRM is not implemented for this platform, we have to come "
|
||||||
|
"up with another timeout strategy to test these",
|
||||||
|
)
|
||||||
|
def test_multiprocessing_legacy_sock(app):
|
||||||
|
"""Tests that the number of children we produce is correct"""
|
||||||
|
# Selects a number at random so we can spot check
|
||||||
|
num_workers = random.choice(range(2, multiprocessing.cpu_count() * 2 + 1))
|
||||||
|
process_list = set()
|
||||||
|
|
||||||
|
@app.after_server_start
|
||||||
|
async def shutdown(app):
|
||||||
|
await sleep(2.1)
|
||||||
|
app.stop()
|
||||||
|
|
||||||
|
def stop_on_alarm(*args):
|
||||||
|
for process in multiprocessing.active_children():
|
||||||
|
process_list.add(process.pid)
|
||||||
|
|
||||||
|
signal.signal(signal.SIGALRM, stop_on_alarm)
|
||||||
|
signal.alarm(2)
|
||||||
|
sock = configure_socket(
|
||||||
|
{
|
||||||
|
"host": HOST,
|
||||||
|
"port": 4121,
|
||||||
|
"unix": None,
|
||||||
|
"backlog": 100,
|
||||||
|
}
|
||||||
|
)
|
||||||
|
app.run(workers=num_workers, debug=True, legacy=True, sock=sock)
|
||||||
|
sock.close()
|
||||||
|
|
||||||
|
assert len(process_list) == num_workers
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.skipif(
|
||||||
|
not hasattr(signal, "SIGALRM"),
|
||||||
|
reason="SIGALRM is not implemented for this platform, we have to come "
|
||||||
|
"up with another timeout strategy to test these",
|
||||||
|
)
|
||||||
|
def test_multiprocessing_legacy_unix(app):
|
||||||
|
"""Tests that the number of children we produce is correct"""
|
||||||
|
# Selects a number at random so we can spot check
|
||||||
|
num_workers = random.choice(range(2, multiprocessing.cpu_count() * 2 + 1))
|
||||||
|
process_list = set()
|
||||||
|
|
||||||
|
@app.after_server_start
|
||||||
|
async def shutdown(app):
|
||||||
|
await sleep(2.1)
|
||||||
|
app.stop()
|
||||||
|
|
||||||
|
def stop_on_alarm(*args):
|
||||||
|
for process in multiprocessing.active_children():
|
||||||
|
process_list.add(process.pid)
|
||||||
|
|
||||||
|
signal.signal(signal.SIGALRM, stop_on_alarm)
|
||||||
|
signal.alarm(2)
|
||||||
|
app.run(workers=num_workers, debug=True, legacy=True, unix="./test.sock")
|
||||||
|
|
||||||
|
assert len(process_list) == num_workers
|
||||||
|
|
||||||
|
|
||||||
@pytest.mark.skipif(
|
@pytest.mark.skipif(
|
||||||
not hasattr(signal, "SIGALRM"),
|
not hasattr(signal, "SIGALRM"),
|
||||||
reason="SIGALRM is not implemented for this platform",
|
reason="SIGALRM is not implemented for this platform",
|
||||||
|
|||||||
@@ -1,5 +1,3 @@
|
|||||||
import uuid
|
|
||||||
|
|
||||||
from unittest.mock import Mock
|
from unittest.mock import Mock
|
||||||
from uuid import UUID, uuid4
|
from uuid import UUID, uuid4
|
||||||
|
|
||||||
@@ -7,7 +5,7 @@ import pytest
|
|||||||
|
|
||||||
from sanic import Sanic, response
|
from sanic import Sanic, response
|
||||||
from sanic.exceptions import BadURL, SanicException
|
from sanic.exceptions import BadURL, SanicException
|
||||||
from sanic.request import Request
|
from sanic.request import Request, uuid
|
||||||
from sanic.server import HttpProtocol
|
from sanic.server import HttpProtocol
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -16,9 +16,8 @@ from sanic_testing.testing import (
|
|||||||
)
|
)
|
||||||
|
|
||||||
from sanic import Blueprint, Sanic
|
from sanic import Blueprint, Sanic
|
||||||
from sanic.constants import DEFAULT_HTTP_CONTENT_TYPE
|
|
||||||
from sanic.exceptions import ServerError
|
from sanic.exceptions import ServerError
|
||||||
from sanic.request import RequestParameters
|
from sanic.request import DEFAULT_HTTP_CONTENT_TYPE, RequestParameters
|
||||||
from sanic.response import html, json, text
|
from sanic.response import html, json, text
|
||||||
|
|
||||||
|
|
||||||
@@ -105,11 +104,11 @@ def test_html(app):
|
|||||||
return html("<h1>Hello</h1>")
|
return html("<h1>Hello</h1>")
|
||||||
|
|
||||||
@app.route("/foo")
|
@app.route("/foo")
|
||||||
async def handler_foo(request):
|
async def handler(request):
|
||||||
return html(Foo())
|
return html(Foo())
|
||||||
|
|
||||||
@app.route("/bar")
|
@app.route("/bar")
|
||||||
async def handler_bar(request):
|
async def handler(request):
|
||||||
return html(Bar())
|
return html(Bar())
|
||||||
|
|
||||||
request, response = app.test_client.get("/")
|
request, response = app.test_client.get("/")
|
||||||
@@ -1814,8 +1813,8 @@ def test_request_cookies(app):
|
|||||||
|
|
||||||
request, response = app.test_client.get("/", cookies=cookies)
|
request, response = app.test_client.get("/", cookies=cookies)
|
||||||
|
|
||||||
assert len(request.cookies) == len(cookies)
|
assert request.cookies == cookies
|
||||||
assert request.cookies["test"] == cookies["test"]
|
assert request.cookies == cookies # For request._cookies
|
||||||
|
|
||||||
|
|
||||||
@pytest.mark.asyncio
|
@pytest.mark.asyncio
|
||||||
@@ -1828,8 +1827,8 @@ async def test_request_cookies_asgi(app):
|
|||||||
|
|
||||||
request, response = await app.asgi_client.get("/", cookies=cookies)
|
request, response = await app.asgi_client.get("/", cookies=cookies)
|
||||||
|
|
||||||
assert len(request.cookies) == len(cookies)
|
assert request.cookies == cookies
|
||||||
assert request.cookies["test"] == cookies["test"]
|
assert request.cookies == cookies # For request._cookies
|
||||||
|
|
||||||
|
|
||||||
def test_request_cookies_without_cookies(app):
|
def test_request_cookies_without_cookies(app):
|
||||||
@@ -2199,25 +2198,10 @@ def test_safe_method_with_body(app):
|
|||||||
assert response.body == b"OK"
|
assert response.body == b"OK"
|
||||||
|
|
||||||
|
|
||||||
@pytest.mark.asyncio
|
def test_conflicting_body_methods_overload(app):
|
||||||
async def test_conflicting_body_methods_overload_error(app: Sanic):
|
|
||||||
@app.put("/")
|
@app.put("/")
|
||||||
@app.put("/p/")
|
@app.put("/p/")
|
||||||
@app.put("/p/<foo>")
|
@app.put("/p/<foo>")
|
||||||
async def put(request, foo=None):
|
|
||||||
...
|
|
||||||
|
|
||||||
with pytest.raises(
|
|
||||||
ServerError,
|
|
||||||
match="Duplicate route names detected: test_conflicting_body_methods_overload_error\.put.*",
|
|
||||||
):
|
|
||||||
await app._startup()
|
|
||||||
|
|
||||||
|
|
||||||
def test_conflicting_body_methods_overload(app: Sanic):
|
|
||||||
@app.put("/", name="one")
|
|
||||||
@app.put("/p/", name="two")
|
|
||||||
@app.put("/p/<foo>", name="three")
|
|
||||||
async def put(request, foo=None):
|
async def put(request, foo=None):
|
||||||
return json(
|
return json(
|
||||||
{"name": request.route.name, "body": str(request.body), "foo": foo}
|
{"name": request.route.name, "body": str(request.body), "foo": foo}
|
||||||
@@ -2235,21 +2219,21 @@ def test_conflicting_body_methods_overload(app: Sanic):
|
|||||||
_, response = app.test_client.put("/", json=payload)
|
_, response = app.test_client.put("/", json=payload)
|
||||||
assert response.status == 200
|
assert response.status == 200
|
||||||
assert response.json == {
|
assert response.json == {
|
||||||
"name": "test_conflicting_body_methods_overload.one",
|
"name": "test_conflicting_body_methods_overload.put",
|
||||||
"foo": None,
|
"foo": None,
|
||||||
"body": data,
|
"body": data,
|
||||||
}
|
}
|
||||||
_, response = app.test_client.put("/p", json=payload)
|
_, response = app.test_client.put("/p", json=payload)
|
||||||
assert response.status == 200
|
assert response.status == 200
|
||||||
assert response.json == {
|
assert response.json == {
|
||||||
"name": "test_conflicting_body_methods_overload.two",
|
"name": "test_conflicting_body_methods_overload.put",
|
||||||
"foo": None,
|
"foo": None,
|
||||||
"body": data,
|
"body": data,
|
||||||
}
|
}
|
||||||
_, response = app.test_client.put("/p/test", json=payload)
|
_, response = app.test_client.put("/p/test", json=payload)
|
||||||
assert response.status == 200
|
assert response.status == 200
|
||||||
assert response.json == {
|
assert response.json == {
|
||||||
"name": "test_conflicting_body_methods_overload.three",
|
"name": "test_conflicting_body_methods_overload.put",
|
||||||
"foo": "test",
|
"foo": "test",
|
||||||
"body": data,
|
"body": data,
|
||||||
}
|
}
|
||||||
@@ -2262,26 +2246,9 @@ def test_conflicting_body_methods_overload(app: Sanic):
|
|||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
@pytest.mark.asyncio
|
def test_handler_overload(app):
|
||||||
async def test_handler_overload_error(app: Sanic):
|
|
||||||
@app.get("/long/sub/route/param_a/<param_a:str>/param_b/<param_b:str>")
|
@app.get("/long/sub/route/param_a/<param_a:str>/param_b/<param_b:str>")
|
||||||
@app.post("/long/sub/route/")
|
@app.post("/long/sub/route/")
|
||||||
def handler(request, **kwargs):
|
|
||||||
...
|
|
||||||
|
|
||||||
with pytest.raises(
|
|
||||||
ServerError,
|
|
||||||
match="Duplicate route names detected: test_handler_overload_error\.handler.*",
|
|
||||||
):
|
|
||||||
await app._startup()
|
|
||||||
|
|
||||||
|
|
||||||
def test_handler_overload(app: Sanic):
|
|
||||||
@app.get(
|
|
||||||
"/long/sub/route/param_a/<param_a:str>/param_b/<param_b:str>",
|
|
||||||
name="one",
|
|
||||||
)
|
|
||||||
@app.post("/long/sub/route/", name="two")
|
|
||||||
def handler(request, **kwargs):
|
def handler(request, **kwargs):
|
||||||
return json(kwargs)
|
return json(kwargs)
|
||||||
|
|
||||||
|
|||||||
@@ -1,55 +0,0 @@
|
|||||||
from datetime import datetime, timezone
|
|
||||||
from logging import INFO
|
|
||||||
|
|
||||||
import pytest
|
|
||||||
|
|
||||||
from sanic.compat import Header
|
|
||||||
from sanic.response.convenience import validate_file
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.mark.parametrize(
|
|
||||||
"ifmod,lastmod,expected",
|
|
||||||
(
|
|
||||||
("Sat, 01 Apr 2023 00:00:00 GMT", 1672524000, None),
|
|
||||||
(
|
|
||||||
"Sat, 01 Apr 2023 00:00:00",
|
|
||||||
1672524000,
|
|
||||||
"converting if_modified_since",
|
|
||||||
),
|
|
||||||
(
|
|
||||||
"Sat, 01 Apr 2023 00:00:00 GMT",
|
|
||||||
datetime(2023, 1, 1, 0, 0, 0),
|
|
||||||
"converting last_modified",
|
|
||||||
),
|
|
||||||
(
|
|
||||||
"Sat, 01 Apr 2023 00:00:00",
|
|
||||||
datetime(2023, 1, 1, 0, 0, 0),
|
|
||||||
None,
|
|
||||||
),
|
|
||||||
(
|
|
||||||
"Sat, 01 Apr 2023 00:00:00 GMT",
|
|
||||||
datetime(2023, 1, 1, 0, 0, 0).replace(tzinfo=timezone.utc),
|
|
||||||
None,
|
|
||||||
),
|
|
||||||
(
|
|
||||||
"Sat, 01 Apr 2023 00:00:00",
|
|
||||||
datetime(2023, 1, 1, 0, 0, 0).replace(tzinfo=timezone.utc),
|
|
||||||
"converting if_modified_since",
|
|
||||||
),
|
|
||||||
),
|
|
||||||
)
|
|
||||||
@pytest.mark.asyncio
|
|
||||||
async def test_file_timestamp_validation(
|
|
||||||
lastmod, ifmod, expected, caplog: pytest.LogCaptureFixture
|
|
||||||
):
|
|
||||||
headers = Header([["If-Modified-Since", ifmod]])
|
|
||||||
|
|
||||||
with caplog.at_level(INFO):
|
|
||||||
response = await validate_file(headers, lastmod)
|
|
||||||
assert response.status == 304
|
|
||||||
records = caplog.records
|
|
||||||
if not expected:
|
|
||||||
assert len(records) == 0
|
|
||||||
else:
|
|
||||||
record = records[0]
|
|
||||||
assert expected in record.message
|
|
||||||
@@ -12,7 +12,7 @@ from sanic_testing.testing import SanicTestClient
|
|||||||
|
|
||||||
from sanic import Blueprint, Sanic
|
from sanic import Blueprint, Sanic
|
||||||
from sanic.constants import HTTP_METHODS
|
from sanic.constants import HTTP_METHODS
|
||||||
from sanic.exceptions import NotFound, SanicException, ServerError
|
from sanic.exceptions import NotFound, SanicException
|
||||||
from sanic.request import Request
|
from sanic.request import Request
|
||||||
from sanic.response import empty, json, text
|
from sanic.response import empty, json, text
|
||||||
|
|
||||||
@@ -744,8 +744,8 @@ def test_route_duplicate(app):
|
|||||||
|
|
||||||
|
|
||||||
def test_double_stack_route(app):
|
def test_double_stack_route(app):
|
||||||
@app.route("/test/1", name="test1")
|
@app.route("/test/1")
|
||||||
@app.route("/test/2", name="test2")
|
@app.route("/test/2")
|
||||||
async def handler1(request):
|
async def handler1(request):
|
||||||
return text("OK")
|
return text("OK")
|
||||||
|
|
||||||
@@ -759,8 +759,8 @@ def test_double_stack_route(app):
|
|||||||
async def test_websocket_route_asgi(app):
|
async def test_websocket_route_asgi(app):
|
||||||
ev = asyncio.Event()
|
ev = asyncio.Event()
|
||||||
|
|
||||||
@app.websocket("/test/1", name="test1")
|
@app.websocket("/test/1")
|
||||||
@app.websocket("/test/2", name="test2")
|
@app.websocket("/test/2")
|
||||||
async def handler(request, ws):
|
async def handler(request, ws):
|
||||||
ev.set()
|
ev.set()
|
||||||
|
|
||||||
@@ -1279,7 +1279,7 @@ async def test_added_callable_route_ctx_kwargs(app):
|
|||||||
|
|
||||||
|
|
||||||
@pytest.mark.asyncio
|
@pytest.mark.asyncio
|
||||||
async def test_duplicate_route_error(app):
|
async def test_duplicate_route_deprecation(app):
|
||||||
@app.route("/foo", name="duped")
|
@app.route("/foo", name="duped")
|
||||||
async def handler_foo(request):
|
async def handler_foo(request):
|
||||||
return text("...")
|
return text("...")
|
||||||
@@ -1289,7 +1289,9 @@ async def test_duplicate_route_error(app):
|
|||||||
return text("...")
|
return text("...")
|
||||||
|
|
||||||
message = (
|
message = (
|
||||||
"Duplicate route names detected: test_duplicate_route_error.duped."
|
r"\[DEPRECATION v23\.3\] Duplicate route names detected: "
|
||||||
|
r"test_duplicate_route_deprecation\.duped\. In the future, "
|
||||||
|
r"Sanic will enforce uniqueness in route naming\."
|
||||||
)
|
)
|
||||||
with pytest.raises(ServerError, match=message):
|
with pytest.warns(DeprecationWarning, match=message):
|
||||||
await app._startup()
|
await app._startup()
|
||||||
|
|||||||
@@ -66,8 +66,8 @@ def test_no_register_system_signals_fails(app):
|
|||||||
app.listener("after_server_stop")(after)
|
app.listener("after_server_stop")(after)
|
||||||
|
|
||||||
message = (
|
message = (
|
||||||
r"Cannot run Sanic\.serve with register_sys_signals=False\. Use "
|
"Cannot run Sanic.serve with register_sys_signals=False. Use "
|
||||||
r"Sanic.serve_single\."
|
"either Sanic.serve_single or Sanic.serve_legacy."
|
||||||
)
|
)
|
||||||
with pytest.raises(RuntimeError, match=message):
|
with pytest.raises(RuntimeError, match=message):
|
||||||
app.prepare(HOST, PORT, register_sys_signals=False)
|
app.prepare(HOST, PORT, register_sys_signals=False)
|
||||||
|
|||||||
@@ -9,7 +9,7 @@ from time import gmtime, strftime
|
|||||||
import pytest
|
import pytest
|
||||||
|
|
||||||
from sanic import Sanic, text
|
from sanic import Sanic, text
|
||||||
from sanic.exceptions import FileNotFound, ServerError
|
from sanic.exceptions import FileNotFound
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture(scope="module")
|
@pytest.fixture(scope="module")
|
||||||
@@ -108,9 +108,14 @@ def test_static_file_pathlib(app, static_file_directory, file_name):
|
|||||||
def test_static_file_bytes(app, static_file_directory, file_name):
|
def test_static_file_bytes(app, static_file_directory, file_name):
|
||||||
bsep = os.path.sep.encode("utf-8")
|
bsep = os.path.sep.encode("utf-8")
|
||||||
file_path = static_file_directory.encode("utf-8") + bsep + file_name
|
file_path = static_file_directory.encode("utf-8") + bsep + file_name
|
||||||
message = "Static file or directory must be a path-like object or string"
|
message = (
|
||||||
with pytest.raises(TypeError, match=message):
|
"Serving a static directory with a bytes "
|
||||||
|
"string is deprecated and will be removed in v22.9."
|
||||||
|
)
|
||||||
|
with pytest.warns(DeprecationWarning, match=message):
|
||||||
app.static("/testing.file", file_path)
|
app.static("/testing.file", file_path)
|
||||||
|
request, response = app.test_client.get("/testing.file")
|
||||||
|
assert response.status == 200
|
||||||
|
|
||||||
|
|
||||||
@pytest.mark.parametrize(
|
@pytest.mark.parametrize(
|
||||||
@@ -518,26 +523,10 @@ def test_no_stack_trace_on_not_found(app, static_file_directory, caplog):
|
|||||||
assert response.text == "No file: /static/non_existing_file.file"
|
assert response.text == "No file: /static/non_existing_file.file"
|
||||||
|
|
||||||
|
|
||||||
@pytest.mark.asyncio
|
def test_multiple_statics(app, static_file_directory):
|
||||||
async def test_multiple_statics_error(app, static_file_directory):
|
|
||||||
app.static("/file", get_file_path(static_file_directory, "test.file"))
|
app.static("/file", get_file_path(static_file_directory, "test.file"))
|
||||||
app.static("/png", get_file_path(static_file_directory, "python.png"))
|
app.static("/png", get_file_path(static_file_directory, "python.png"))
|
||||||
|
|
||||||
message = (
|
|
||||||
r"Duplicate route names detected: test_multiple_statics_error\.static"
|
|
||||||
)
|
|
||||||
with pytest.raises(ServerError, match=message):
|
|
||||||
await app._startup()
|
|
||||||
|
|
||||||
|
|
||||||
def test_multiple_statics(app, static_file_directory):
|
|
||||||
app.static(
|
|
||||||
"/file", get_file_path(static_file_directory, "test.file"), name="file"
|
|
||||||
)
|
|
||||||
app.static(
|
|
||||||
"/png", get_file_path(static_file_directory, "python.png"), name="png"
|
|
||||||
)
|
|
||||||
|
|
||||||
_, response = app.test_client.get("/file")
|
_, response = app.test_client.get("/file")
|
||||||
assert response.status == 200
|
assert response.status == 200
|
||||||
assert response.body == get_file_content(
|
assert response.body == get_file_content(
|
||||||
@@ -551,22 +540,10 @@ def test_multiple_statics(app, static_file_directory):
|
|||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
@pytest.mark.asyncio
|
def test_resource_type_default(app, static_file_directory):
|
||||||
async def test_resource_type_default_error(app, static_file_directory):
|
|
||||||
app.static("/static", static_file_directory)
|
app.static("/static", static_file_directory)
|
||||||
app.static("/file", get_file_path(static_file_directory, "test.file"))
|
app.static("/file", get_file_path(static_file_directory, "test.file"))
|
||||||
|
|
||||||
message = r"Duplicate route names detected: test_resource_type_default_error\.static"
|
|
||||||
with pytest.raises(ServerError, match=message):
|
|
||||||
await app._startup()
|
|
||||||
|
|
||||||
|
|
||||||
def test_resource_type_default(app, static_file_directory):
|
|
||||||
app.static("/static", static_file_directory, name="static")
|
|
||||||
app.static(
|
|
||||||
"/file", get_file_path(static_file_directory, "test.file"), name="file"
|
|
||||||
)
|
|
||||||
|
|
||||||
_, response = app.test_client.get("/static")
|
_, response = app.test_client.get("/static")
|
||||||
assert response.status == 404
|
assert response.status == 404
|
||||||
|
|
||||||
|
|||||||
@@ -12,7 +12,7 @@ from urllib.parse import urlparse
|
|||||||
|
|
||||||
import pytest
|
import pytest
|
||||||
|
|
||||||
from sanic_testing.testing import HOST, PORT, SanicTestClient
|
from sanic_testing.testing import HOST, PORT
|
||||||
|
|
||||||
import sanic.http.tls.creators
|
import sanic.http.tls.creators
|
||||||
|
|
||||||
@@ -29,24 +29,16 @@ from sanic.http.tls.creators import (
|
|||||||
get_ssl_context,
|
get_ssl_context,
|
||||||
)
|
)
|
||||||
from sanic.response import text
|
from sanic.response import text
|
||||||
from sanic.worker.loader import CertLoader
|
|
||||||
|
|
||||||
|
|
||||||
current_dir = os.path.dirname(os.path.realpath(__file__))
|
current_dir = os.path.dirname(os.path.realpath(__file__))
|
||||||
localhost_dir = os.path.join(current_dir, "certs/localhost")
|
localhost_dir = os.path.join(current_dir, "certs/localhost")
|
||||||
password_dir = os.path.join(current_dir, "certs/password")
|
|
||||||
sanic_dir = os.path.join(current_dir, "certs/sanic.example")
|
sanic_dir = os.path.join(current_dir, "certs/sanic.example")
|
||||||
invalid_dir = os.path.join(current_dir, "certs/invalid.nonexist")
|
invalid_dir = os.path.join(current_dir, "certs/invalid.nonexist")
|
||||||
localhost_cert = os.path.join(localhost_dir, "fullchain.pem")
|
localhost_cert = os.path.join(localhost_dir, "fullchain.pem")
|
||||||
localhost_key = os.path.join(localhost_dir, "privkey.pem")
|
localhost_key = os.path.join(localhost_dir, "privkey.pem")
|
||||||
sanic_cert = os.path.join(sanic_dir, "fullchain.pem")
|
sanic_cert = os.path.join(sanic_dir, "fullchain.pem")
|
||||||
sanic_key = os.path.join(sanic_dir, "privkey.pem")
|
sanic_key = os.path.join(sanic_dir, "privkey.pem")
|
||||||
password_dict = {
|
|
||||||
"cert": os.path.join(password_dir, "fullchain.pem"),
|
|
||||||
"key": os.path.join(password_dir, "privkey.pem"),
|
|
||||||
"password": "password",
|
|
||||||
"names": ["localhost"],
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture
|
@pytest.fixture
|
||||||
@@ -428,29 +420,6 @@ def test_no_certs_on_list(app):
|
|||||||
assert "No certificates" in str(excinfo.value)
|
assert "No certificates" in str(excinfo.value)
|
||||||
|
|
||||||
|
|
||||||
def test_custom_cert_loader():
|
|
||||||
class MyCertLoader(CertLoader):
|
|
||||||
def load(self, app: Sanic):
|
|
||||||
self._ssl_data = {
|
|
||||||
"key": localhost_key,
|
|
||||||
"cert": localhost_cert,
|
|
||||||
}
|
|
||||||
return super().load(app)
|
|
||||||
|
|
||||||
app = Sanic("custom", certloader_class=MyCertLoader)
|
|
||||||
|
|
||||||
@app.get("/test")
|
|
||||||
async def handler(request):
|
|
||||||
return text("ssl test")
|
|
||||||
|
|
||||||
client = SanicTestClient(app, port=44556)
|
|
||||||
|
|
||||||
request, response = client.get("https://localhost:44556/test")
|
|
||||||
assert request.scheme == "https"
|
|
||||||
assert response.status_code == 200
|
|
||||||
assert response.text == "ssl test"
|
|
||||||
|
|
||||||
|
|
||||||
def test_logger_vhosts(caplog):
|
def test_logger_vhosts(caplog):
|
||||||
app = Sanic(name="test_logger_vhosts")
|
app = Sanic(name="test_logger_vhosts")
|
||||||
|
|
||||||
@@ -708,34 +677,3 @@ def test_ssl_in_multiprocess_mode(app: Sanic, caplog):
|
|||||||
logging.INFO,
|
logging.INFO,
|
||||||
"Goin' Fast @ https://127.0.0.1:8000",
|
"Goin' Fast @ https://127.0.0.1:8000",
|
||||||
) in caplog.record_tuples
|
) in caplog.record_tuples
|
||||||
|
|
||||||
|
|
||||||
@pytest.mark.skipif(
|
|
||||||
sys.platform not in ("linux", "darwin"),
|
|
||||||
reason="This test requires fork context",
|
|
||||||
)
|
|
||||||
def test_ssl_in_multiprocess_mode_password(
|
|
||||||
app: Sanic, caplog: pytest.LogCaptureFixture
|
|
||||||
):
|
|
||||||
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 use_context("fork"):
|
|
||||||
with caplog.at_level(logging.INFO):
|
|
||||||
app.run(ssl=password_dict)
|
|
||||||
assert event.is_set()
|
|
||||||
|
|
||||||
assert (
|
|
||||||
"sanic.root",
|
|
||||||
logging.INFO,
|
|
||||||
"Goin' Fast @ https://127.0.0.1:8000",
|
|
||||||
) in caplog.record_tuples
|
|
||||||
|
|||||||
@@ -52,23 +52,34 @@ def test_cwd_in_path():
|
|||||||
|
|
||||||
def test_input_is_dir():
|
def test_input_is_dir():
|
||||||
loader = AppLoader(str(STATIC))
|
loader = AppLoader(str(STATIC))
|
||||||
app = loader.load()
|
message = (
|
||||||
assert isinstance(app, Sanic)
|
"App not found.\n Please use --simple if you are passing a "
|
||||||
|
f"directory to sanic.\n eg. sanic {str(STATIC)} --simple"
|
||||||
|
)
|
||||||
|
with pytest.raises(ValueError, match=message):
|
||||||
|
loader.load()
|
||||||
|
|
||||||
|
|
||||||
def test_input_is_factory():
|
def test_input_is_factory():
|
||||||
ns = SimpleNamespace(target="foo")
|
ns = SimpleNamespace(module="foo")
|
||||||
loader = AppLoader("tests.fake.server:create_app", args=ns)
|
loader = AppLoader("tests.fake.server:create_app", args=ns)
|
||||||
app = loader.load()
|
message = (
|
||||||
assert isinstance(app, Sanic)
|
"Module is not a Sanic app, it is a function\n If this callable "
|
||||||
|
"returns a Sanic instance try: \nsanic foo --factory"
|
||||||
|
)
|
||||||
|
with pytest.raises(ValueError, match=message):
|
||||||
|
loader.load()
|
||||||
|
|
||||||
|
|
||||||
def test_input_is_module():
|
def test_input_is_module():
|
||||||
ns = SimpleNamespace(target="foo")
|
ns = SimpleNamespace(module="foo")
|
||||||
loader = AppLoader("tests.fake.server", args=ns)
|
loader = AppLoader("tests.fake.server", args=ns)
|
||||||
|
message = (
|
||||||
app = loader.load()
|
"Module is not a Sanic app, it is a module\n "
|
||||||
assert isinstance(app, Sanic)
|
"Perhaps you meant foo:app?"
|
||||||
|
)
|
||||||
|
with pytest.raises(ValueError, match=message):
|
||||||
|
loader.load()
|
||||||
|
|
||||||
|
|
||||||
@pytest.mark.parametrize("creator", ("mkcert", "trustme"))
|
@pytest.mark.parametrize("creator", ("mkcert", "trustme"))
|
||||||
|
|||||||
@@ -72,6 +72,24 @@ def test_not_have_multiplexer_single(app: Sanic):
|
|||||||
assert not event.is_set()
|
assert not event.is_set()
|
||||||
|
|
||||||
|
|
||||||
|
def test_not_have_multiplexer_legacy(app: Sanic):
|
||||||
|
event = Event()
|
||||||
|
|
||||||
|
@app.main_process_start
|
||||||
|
async def setup(app, _):
|
||||||
|
app.shared_ctx.event = event
|
||||||
|
|
||||||
|
@app.after_server_start
|
||||||
|
def stop(app):
|
||||||
|
if hasattr(app, "m") and isinstance(app.m, WorkerMultiplexer):
|
||||||
|
app.shared_ctx.event.set()
|
||||||
|
app.stop()
|
||||||
|
|
||||||
|
app.run(legacy=True)
|
||||||
|
|
||||||
|
assert not event.is_set()
|
||||||
|
|
||||||
|
|
||||||
def test_ack(worker_state: Dict[str, Any], m: WorkerMultiplexer):
|
def test_ack(worker_state: Dict[str, Any], m: WorkerMultiplexer):
|
||||||
worker_state["Test"] = {"foo": "bar"}
|
worker_state["Test"] = {"foo": "bar"}
|
||||||
m.ack()
|
m.ack()
|
||||||
|
|||||||
Reference in New Issue
Block a user