Add route context

sanic/app.py

@@ -384,12 +384,16 @@ def _apply_route(self, route: FutureRoute) -> List[Route]:
             websocket_handler.is_websocket = True  # type: ignore
             params["handler"] = websocket_handler
 
+        ctx = params.pop("route_context")
+
         routes = self.router.add(**params)
         if isinstance(routes, Route):
             routes = [routes]
+
         for r in routes:
             r.ctx.websocket = websocket
             r.ctx.static = params.get("static", False)
+            r.ctx.__dict__.update(ctx)
 
         return routes
 

sanic/blueprints.py

@@ -326,6 +326,7 @@ def register(self, app, options):
                 future.static,
                 version_prefix,
                 error_format,
+                future.route_context,
             )
 
             route = app._apply_route(apply_route)

sanic/mixins/routes.py

@@ -26,12 +26,21 @@
 from sanic.models.futures import FutureRoute, FutureStatic
 from sanic.models.handler_types import RouteHandler
 from sanic.response import HTTPResponse, file, file_stream
+from sanic.types import HashableDict
 from sanic.views import CompositionView
 
 
 RouteWrapper = Callable[
     [RouteHandler], Union[RouteHandler, Tuple[Route, RouteHandler]]
 ]
+RESTRICTED_ROUTE_CONTEXT = (
+    "ignore_body",
+    "stream",
+    "hosts",
+    "static",
+    "error_format",
+    "websocket",
+)
 
 
 class RouteMixin:
@@ -65,6 +74,7 @@ def route(
         static: bool = False,
         version_prefix: str = "/v",
         error_format: Optional[str] = None,
+        **kwargs,
     ) -> RouteWrapper:
         """
         Decorate a function to be registered as a route
@@ -94,6 +104,8 @@ def route(
         if not methods and not websocket:
             methods = frozenset({"GET"})
 
+        route_context = self._build_route_context(kwargs)
+
         def decorator(handler):
             nonlocal uri
             nonlocal methods
@@ -152,6 +164,7 @@ def decorator(handler):
                 static,
                 version_prefix,
                 error_format,
+                route_context,
             )
 
             self._future_routes.add(route)
@@ -196,6 +209,7 @@ def add_route(
         stream: bool = False,
         version_prefix: str = "/v",
         error_format: Optional[str] = None,
+        **kwargs,
     ) -> RouteHandler:
         """A helper method to register class instance or
         functions as a handler to the application url
@@ -247,6 +261,7 @@ def add_route(
             name=name,
             version_prefix=version_prefix,
             error_format=error_format,
+            **kwargs,
         )(handler)
         return handler
 
@@ -261,6 +276,7 @@ def get(
         ignore_body: bool = True,
         version_prefix: str = "/v",
         error_format: Optional[str] = None,
+        **kwargs,
     ) -> RouteWrapper:
         """
         Add an API URL under the **GET** *HTTP* method
@@ -285,6 +301,7 @@ def get(
             ignore_body=ignore_body,
             version_prefix=version_prefix,
             error_format=error_format,
+            **kwargs,
         )
 
     def post(
@@ -297,6 +314,7 @@ def post(
         name: Optional[str] = None,
         version_prefix: str = "/v",
         error_format: Optional[str] = None,
+        **kwargs,
     ) -> RouteWrapper:
         """
         Add an API URL under the **POST** *HTTP* method
@@ -321,6 +339,7 @@ def post(
             name=name,
             version_prefix=version_prefix,
             error_format=error_format,
+            **kwargs,
         )
 
     def put(
@@ -333,6 +352,7 @@ def put(
         name: Optional[str] = None,
         version_prefix: str = "/v",
         error_format: Optional[str] = None,
+        **kwargs,
     ) -> RouteWrapper:
         """
         Add an API URL under the **PUT** *HTTP* method
@@ -357,6 +377,7 @@ def put(
             name=name,
             version_prefix=version_prefix,
             error_format=error_format,
+            **kwargs,
         )
 
     def head(
@@ -369,6 +390,7 @@ def head(
         ignore_body: bool = True,
         version_prefix: str = "/v",
         error_format: Optional[str] = None,
+        **kwargs,
     ) -> RouteWrapper:
         """
         Add an API URL under the **HEAD** *HTTP* method
@@ -401,6 +423,7 @@ def head(
             ignore_body=ignore_body,
             version_prefix=version_prefix,
             error_format=error_format,
+            **kwargs,
         )
 
     def options(
@@ -413,6 +436,7 @@ def options(
         ignore_body: bool = True,
         version_prefix: str = "/v",
         error_format: Optional[str] = None,
+        **kwargs,
     ) -> RouteWrapper:
         """
         Add an API URL under the **OPTIONS** *HTTP* method
@@ -445,6 +469,7 @@ def options(
             ignore_body=ignore_body,
             version_prefix=version_prefix,
             error_format=error_format,
+            **kwargs,
         )
 
     def patch(
@@ -457,6 +482,7 @@ def patch(
         name: Optional[str] = None,
         version_prefix: str = "/v",
         error_format: Optional[str] = None,
+        **kwargs,
     ) -> RouteWrapper:
         """
         Add an API URL under the **PATCH** *HTTP* method
@@ -491,6 +517,7 @@ def patch(
             name=name,
             version_prefix=version_prefix,
             error_format=error_format,
+            **kwargs,
         )
 
     def delete(
@@ -503,6 +530,7 @@ def delete(
         ignore_body: bool = True,
         version_prefix: str = "/v",
         error_format: Optional[str] = None,
+        **kwargs,
     ) -> RouteWrapper:
         """
         Add an API URL under the **DELETE** *HTTP* method
@@ -527,6 +555,7 @@ def delete(
             ignore_body=ignore_body,
             version_prefix=version_prefix,
             error_format=error_format,
+            **kwargs,
         )
 
     def websocket(
@@ -540,6 +569,7 @@ def websocket(
         apply: bool = True,
         version_prefix: str = "/v",
         error_format: Optional[str] = None,
+        **kwargs,
     ):
         """
         Decorate a function to be registered as a websocket route
@@ -567,6 +597,7 @@ def websocket(
             websocket=True,
             version_prefix=version_prefix,
             error_format=error_format,
+            **kwargs,
         )
 
     def add_websocket_route(
@@ -580,6 +611,7 @@ def add_websocket_route(
         name: Optional[str] = None,
         version_prefix: str = "/v",
         error_format: Optional[str] = None,
+        **kwargs,
     ):
         """
         A helper method to register a function as a websocket route.
@@ -609,6 +641,7 @@ def add_websocket_route(
             name=name,
             version_prefix=version_prefix,
             error_format=error_format,
+            **kwargs,
         )(handler)
 
     def static(
@@ -957,3 +990,18 @@ def visit_Return(self, node: Return) -> Any:
         HttpResponseVisitor().visit(node)
 
         return types
+
+    def _build_route_context(self, raw):
+        ctx_kwargs = {
+            key.replace("ctx_", ""): value
+            for key, value in raw.items()
+            if key.startswith("ctx_")
+        }
+        restricted = [
+            key for key in ctx_kwargs.keys() if key in RESTRICTED_ROUTE_CONTEXT
+        ]
+        if restricted:
+            raise AttributeError(
+                f"Cannot use restricted route context: {restricted}."
+            )
+        return HashableDict(ctx_kwargs)

sanic/mixins/signals.py

@@ -3,11 +3,7 @@
 from sanic.models.futures import FutureSignal
 from sanic.models.handler_types import SignalHandler
 from sanic.signals import Signal
-
-
-class HashableDict(dict):
-    def __hash__(self):
-        return hash(tuple(sorted(self.items())))
+from sanic.types import HashableDict
 
 
 class SignalMixin:

sanic/models/futures.py

@@ -7,6 +7,7 @@
     MiddlewareType,
     SignalHandler,
 )
+from sanic.types import HashableDict
 
 
 class FutureRoute(NamedTuple):
@@ -25,6 +26,7 @@ class FutureRoute(NamedTuple):
     static: bool
     version_prefix: str
     error_format: Optional[str]
+    route_context: HashableDict
 
 
 class FutureListener(NamedTuple):

sanic/types/__init__.py

@@ -0,0 +1,4 @@
+from .hashable_dict import HashableDict
+
+
+__all__ = ("HashableDict",)

sanic/types/hashable_dict.py

@@ -0,0 +1,3 @@
+class HashableDict(dict):
+    def __hash__(self):
+        return hash(tuple(sorted(self.items())))