Add convenience methods to BP groups (#2209)

This commit is contained in:
Adam Hopkins 2021-08-07 23:06:11 +03:00 committed by GitHub
parent e22ff3828b
commit 71a631237d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 49 additions and 4 deletions

View File

@ -1,6 +1,7 @@
from __future__ import annotations from __future__ import annotations
from collections.abc import MutableSequence from collections.abc import MutableSequence
from functools import partial
from typing import TYPE_CHECKING, List, Optional, Union from typing import TYPE_CHECKING, List, Optional, Union
@ -229,3 +230,15 @@ class BlueprintGroup(MutableSequence):
args = list(args)[1:] args = list(args)[1:]
return register_middleware_for_blueprints(fn) return register_middleware_for_blueprints(fn)
return register_middleware_for_blueprints return register_middleware_for_blueprints
def on_request(self, middleware=None):
if callable(middleware):
return self.middleware(middleware, "request")
else:
return partial(self.middleware, attach_to="request")
def on_response(self, middleware=None):
if callable(middleware):
return self.middleware(middleware, "response")
else:
return partial(self.middleware, attach_to="response")

View File

@ -116,6 +116,16 @@ def test_bp_group(app: Sanic):
global MIDDLEWARE_INVOKE_COUNTER global MIDDLEWARE_INVOKE_COUNTER
MIDDLEWARE_INVOKE_COUNTER["request"] += 1 MIDDLEWARE_INVOKE_COUNTER["request"] += 1
@blueprint_group_1.on_request
def blueprint_group_1_convenience_1(request):
global MIDDLEWARE_INVOKE_COUNTER
MIDDLEWARE_INVOKE_COUNTER["request"] += 1
@blueprint_group_1.on_request()
def blueprint_group_1_convenience_2(request):
global MIDDLEWARE_INVOKE_COUNTER
MIDDLEWARE_INVOKE_COUNTER["request"] += 1
@blueprint_3.route("/") @blueprint_3.route("/")
def blueprint_3_default_route(request): def blueprint_3_default_route(request):
return text("BP3_OK") return text("BP3_OK")
@ -129,6 +139,16 @@ def test_bp_group(app: Sanic):
global MIDDLEWARE_INVOKE_COUNTER global MIDDLEWARE_INVOKE_COUNTER
MIDDLEWARE_INVOKE_COUNTER["response"] += 1 MIDDLEWARE_INVOKE_COUNTER["response"] += 1
@blueprint_group_2.on_response
def blueprint_group_2_middleware_convenience_1(request, response):
global MIDDLEWARE_INVOKE_COUNTER
MIDDLEWARE_INVOKE_COUNTER["response"] += 1
@blueprint_group_2.on_response()
def blueprint_group_2_middleware_convenience_2(request, response):
global MIDDLEWARE_INVOKE_COUNTER
MIDDLEWARE_INVOKE_COUNTER["response"] += 1
app.blueprint(blueprint_group_2) app.blueprint(blueprint_group_2)
@app.route("/") @app.route("/")
@ -147,8 +167,8 @@ def test_bp_group(app: Sanic):
_, response = app.test_client.get("/api/bp3") _, response = app.test_client.get("/api/bp3")
assert response.text == "BP3_OK" assert response.text == "BP3_OK"
assert MIDDLEWARE_INVOKE_COUNTER["response"] == 3 assert MIDDLEWARE_INVOKE_COUNTER["response"] == 9
assert MIDDLEWARE_INVOKE_COUNTER["request"] == 4 assert MIDDLEWARE_INVOKE_COUNTER["request"] == 8
def test_bp_group_list_operations(app: Sanic): def test_bp_group_list_operations(app: Sanic):

View File

@ -37,14 +37,19 @@ def test_middleware_request_as_convenience(app):
async def handler1(request): async def handler1(request):
results.append(request) results.append(request)
@app.route("/") @app.on_request()
async def handler2(request): async def handler2(request):
results.append(request)
@app.route("/")
async def handler3(request):
return text("OK") return text("OK")
request, response = app.test_client.get("/") request, response = app.test_client.get("/")
assert response.text == "OK" assert response.text == "OK"
assert type(results[0]) is Request assert type(results[0]) is Request
assert type(results[1]) is Request
def test_middleware_response(app): def test_middleware_response(app):
@ -79,7 +84,12 @@ def test_middleware_response_as_convenience(app):
results.append(request) results.append(request)
@app.on_response @app.on_response
async def process_response(request, response): async def process_response_1(request, response):
results.append(request)
results.append(response)
@app.on_response()
async def process_response_2(request, response):
results.append(request) results.append(request)
results.append(response) results.append(response)
@ -93,6 +103,8 @@ def test_middleware_response_as_convenience(app):
assert type(results[0]) is Request assert type(results[0]) is Request
assert type(results[1]) is Request assert type(results[1]) is Request
assert isinstance(results[2], HTTPResponse) assert isinstance(results[2], HTTPResponse)
assert type(results[3]) is Request
assert isinstance(results[4], HTTPResponse)
def test_middleware_response_as_convenience_called(app): def test_middleware_response_as_convenience_called(app):