Add signal reservations (#2060)

* Add signal reservations

* Simplify reservations
This commit is contained in:
Adam Hopkins
2021-03-14 15:21:59 +02:00
committed by GitHub
parent d4660d0ca7
commit 2fea954dcf
2 changed files with 43 additions and 10 deletions

View File

@@ -3,7 +3,7 @@ from __future__ import annotations
import asyncio
from inspect import isawaitable
from typing import Any, Dict, List, Optional, Union
from typing import Any, Dict, List, Optional, Tuple, Union
from sanic_routing import BaseRouter, Route # type: ignore
from sanic_routing.exceptions import NotFound # type: ignore
@@ -13,6 +13,12 @@ from sanic.exceptions import InvalidSignal
from sanic.models.handler_types import SignalHandler
RESERVED_NAMESPACES = (
"server",
"http",
)
class Signal(Route):
def get_handler(self, raw_path, method, _):
method = method or self.router.DEFAULT_METHOD
@@ -97,15 +103,7 @@ class SignalRouter(BaseRouter):
event: str,
condition: Optional[Dict[str, Any]] = None,
) -> Signal:
parts = path_to_parts(event, self.delimiter)
if (
len(parts) != 3
or parts[0].startswith("<")
or parts[1].startswith("<")
):
raise InvalidSignal(f"Invalid signal event: {event}")
parts = self._build_event_parts(event)
if parts[2].startswith("<"):
name = ".".join([*parts[:-1], "*"])
else:
@@ -131,3 +129,18 @@ class SignalRouter(BaseRouter):
signal.ctx.event = asyncio.Event()
return super().finalize(do_compile=do_compile)
def _build_event_parts(self, event: str) -> Tuple[str, str, str]:
parts = path_to_parts(event, self.delimiter)
if (
len(parts) != 3
or parts[0].startswith("<")
or parts[1].startswith("<")
):
raise InvalidSignal("Invalid signal event: %s" % event)
if parts[0] in RESERVED_NAMESPACES:
raise InvalidSignal(
"Cannot declare reserved signal event: %s" % event
)
return parts