Skip to content

Fix flask decorator function return other types #489

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 26, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion openapi_core/contrib/flask/decorators.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
from typing import Type

from flask.globals import request
from flask.helpers import make_response
from flask.wrappers import Request
from flask.wrappers import Response

Expand Down Expand Up @@ -74,7 +75,8 @@ def _handle_request_view(
) -> Response:
request = self._get_request()
request.openapi = request_result # type: ignore
return view(*args, **kwargs)
rv = view(*args, **kwargs)
return make_response(rv)

def _handle_request_errors(
self, request_result: RequestValidationResult
Expand Down
8 changes: 7 additions & 1 deletion tests/integration/contrib/flask/data/v3.0/flask_factory.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,16 @@ paths:
type: integer
get:
responses:
404:
description: Return error.
content:
text/html:
schema:
type: string
200:
description: Return the resource.
content:
application/json:
application/json:
schema:
type: object
required:
Expand Down
46 changes: 45 additions & 1 deletion tests/integration/contrib/flask/test_flask_decorator.py
Original file line number Diff line number Diff line change
Expand Up @@ -174,7 +174,7 @@ def test_endpoint_error(self, client):
}
assert result.json == expected_data

def test_valid(self, client):
def test_valid_response_object(self, client):
def view_response_callable(*args, **kwargs):
from flask.globals import request

Expand All @@ -197,3 +197,47 @@ def view_response_callable(*args, **kwargs):
assert result.json == {
"data": "data",
}

def test_valid_tuple_str(self, client):
def view_response_callable(*args, **kwargs):
from flask.globals import request

assert request.openapi
assert not request.openapi.errors
assert request.openapi.parameters == Parameters(
path={
"id": 12,
}
)
return ("Not found", 404)

self.view_response_callable = view_response_callable

result = client.get("/browse/12/")

assert result.status_code == 404
assert result.text == "Not found"

def test_valid_tuple_dict(self, client):
def view_response_callable(*args, **kwargs):
from flask.globals import request

assert request.openapi
assert not request.openapi.errors
assert request.openapi.parameters == Parameters(
path={
"id": 12,
}
)
body = dict(data="data")
headers = {"X-Rate-Limit": "12"}
return (body, headers)

self.view_response_callable = view_response_callable

result = client.get("/browse/12/")

assert result.status_code == 200
assert result.json == {
"data": "data",
}