Skip to content
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

Use field aliases when converting query parameters #63

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
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 flask_pydantic/converters.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,13 @@ def convert_query_params(
:param model: query parameter's model
:return: resulting parameters
"""
alias_to_name_map = {field.alias: field.name for field in model.__fields__.values()}
return {
**query_params.to_dict(),
**{
key: value
for key, value in query_params.to_dict(flat=False).items()
if key in model.__fields__ and model.__fields__[key].is_complex()
if (key in model.__fields__ and model.__fields__[key].is_complex()) or
(key in alias_to_name_map and model.__fields__[alias_to_name_map[key]].is_complex())
},
}
31 changes: 21 additions & 10 deletions tests/func/test_app.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
from typing import List, Optional
from functools import reduce


import pytest
from flask import jsonify, request
Expand Down Expand Up @@ -123,8 +125,8 @@ def to_camel(x: str) -> str:
return "".join([first] + [x.capitalize() for x in rest])

class RequestModel(BaseModel):
x: int
y: int
initial_value: int
operands_to_use: List[int]

class ResultModel(BaseModel):
result_of_addition: int
Expand All @@ -138,8 +140,8 @@ class Config:
@validate(response_by_alias=True)
def compute(query: RequestModel):
return ResultModel(
result_of_addition=query.x + query.y,
result_of_multiplication=query.x * query.y,
result_of_addition=reduce(sum, query.operands_to_use, query.initial_value),
result_of_multiplication=reduce(lambda x,y: x * y, query.operands_to_use, query.initial_value),
)


Expand Down Expand Up @@ -330,16 +332,25 @@ def test_correctly_returns_both_arrays(self, client):


aliases_test_cases = [
pytest.param(1, 2, {"resultOfMultiplication": 2, "resultOfAddition": 3}),
pytest.param(10, 20, {"resultOfMultiplication": 200, "resultOfAddition": 30}),
pytest.param(999, 0, {"resultOfMultiplication": 0, "resultOfAddition": 999}),
pytest.param(1, [2], {"resultOfMultiplication": 2, "resultOfAddition": 3}),
pytest.param(10, [20, 10], {"resultOfMultiplication": 2000, "resultOfAddition": 40}),
pytest.param(999, [0, 1], {"resultOfMultiplication": 0, "resultOfAddition": 1000}),
]


@pytest.mark.usefixtures("app_with_camel_route")
@pytest.mark.parametrize("x,y,expected_result", aliases_test_cases)
def test_aliases(x, y, expected_result, client):
response = client.get(f"/compute?x={x}&y={y}")
@pytest.mark.parametrize("initial_value,operands_to_use,expected_result", aliases_test_cases)
def test_no_aliases_in_request_and_aliases_in_response(initial_value, operands_to_use, expected_result, client):
response = client.get(f"/compute?initial_value={initial_value}"
f"&operands_to_use={'&operands_to_use='.join(map(str, operands_to_use))}")
assert response.json == expected_result


@pytest.mark.usefixtures("app_with_camel_route")
@pytest.mark.parametrize("initial_value,operands_to_use,expected_result", aliases_test_cases)
def test_aliases_in_request_and_response(initial_value, operands_to_use, expected_result, client):
response = client.get(f"/compute?initialValue={initial_value}"
f"&operandsToUse={'&operandsToUse='.join(map(str, operands_to_use))}")
assert response.json == expected_result


Expand Down