mirror
/
tiangolo.fastapi
mirror of https://github.com/tiangolo/fastapi
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Browse Source

🎨 [pre-commit.ci] Auto format from pre-commit.com hooks

pull/11634/head
pre-commit-ci[bot] 1 year ago
committed by Alex Couper
parent
78d1336cbb
commit
aa503064c0
4 changed files with 48 additions and 33 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 40
      fastapi/applications.py
  2. 38
      fastapi/routing.py
  3. 1
      tests/test_serialize_response_model.py
  4. 2
      tests/utils.py

40
fastapi/applications.py
View File

@ -1716,7 +1716,8 @@ class FastAPI(Starlette):
), ),
] = False, ] = False,
response_model_context: Annotated[ response_model_context: Annotated[
Optional[Dict[str, Any]], Doc( Optional[Dict[str, Any]],
Doc(
""" """
Additional context to pass to Pydantic when creating the response. Additional context to pass to Pydantic when creating the response.
@ -1727,7 +1728,7 @@ class FastAPI(Starlette):
Read more about serialization context in the Read more about serialization context in the
[Pydantic documentation](https://docs.pydantic.dev/latest/concepts/serialization/#serialization-context) [Pydantic documentation](https://docs.pydantic.dev/latest/concepts/serialization/#serialization-context)
""" """
) ),
] = None, ] = None,
include_in_schema: Annotated[ include_in_schema: Annotated[
bool, bool,
@ -2104,7 +2105,8 @@ class FastAPI(Starlette):
), ),
] = False, ] = False,
response_model_context: Annotated[ response_model_context: Annotated[
Optional[Dict[str, Any]], Doc( Optional[Dict[str, Any]],
Doc(
""" """
Additional context to pass to Pydantic when creating the response. Additional context to pass to Pydantic when creating the response.
@ -2115,7 +2117,7 @@ class FastAPI(Starlette):
Read more about serialization context in the Read more about serialization context in the
[Pydantic documentation](https://docs.pydantic.dev/latest/concepts/serialization/#serialization-context) [Pydantic documentation](https://docs.pydantic.dev/latest/concepts/serialization/#serialization-context)
""" """
) ),
] = None, ] = None,
include_in_schema: Annotated[ include_in_schema: Annotated[
bool, bool,
@ -2497,7 +2499,8 @@ class FastAPI(Starlette):
), ),
] = False, ] = False,
response_model_context: Annotated[ response_model_context: Annotated[
Optional[Dict[str, Any]], Doc( Optional[Dict[str, Any]],
Doc(
""" """
Additional context to pass to Pydantic when creating the response. Additional context to pass to Pydantic when creating the response.
@ -2508,7 +2511,7 @@ class FastAPI(Starlette):
Read more about serialization context in the Read more about serialization context in the
[Pydantic documentation](https://docs.pydantic.dev/latest/concepts/serialization/#serialization-context) [Pydantic documentation](https://docs.pydantic.dev/latest/concepts/serialization/#serialization-context)
""" """
) ),
] = None, ] = None,
include_in_schema: Annotated[ include_in_schema: Annotated[
bool, bool,
@ -2890,7 +2893,8 @@ class FastAPI(Starlette):
), ),
] = False, ] = False,
response_model_context: Annotated[ response_model_context: Annotated[
Optional[Dict[str, Any]], Doc( Optional[Dict[str, Any]],
Doc(
""" """
Additional context to pass to Pydantic when creating the response. Additional context to pass to Pydantic when creating the response.
@ -2901,7 +2905,7 @@ class FastAPI(Starlette):
Read more about serialization context in the Read more about serialization context in the
[Pydantic documentation](https://docs.pydantic.dev/latest/concepts/serialization/#serialization-context) [Pydantic documentation](https://docs.pydantic.dev/latest/concepts/serialization/#serialization-context)
""" """
) ),
] = None, ] = None,
include_in_schema: Annotated[ include_in_schema: Annotated[
bool, bool,
@ -3278,7 +3282,8 @@ class FastAPI(Starlette):
), ),
] = False, ] = False,
response_model_context: Annotated[ response_model_context: Annotated[
Optional[Dict[str, Any]], Doc( Optional[Dict[str, Any]],
Doc(
""" """
Additional context to pass to Pydantic when creating the response. Additional context to pass to Pydantic when creating the response.
@ -3289,7 +3294,7 @@ class FastAPI(Starlette):
Read more about serialization context in the Read more about serialization context in the
[Pydantic documentation](https://docs.pydantic.dev/latest/concepts/serialization/#serialization-context) [Pydantic documentation](https://docs.pydantic.dev/latest/concepts/serialization/#serialization-context)
""" """
) ),
] = None, ] = None,
include_in_schema: Annotated[ include_in_schema: Annotated[
bool, bool,
@ -3666,7 +3671,8 @@ class FastAPI(Starlette):
), ),
] = False, ] = False,
response_model_context: Annotated[ response_model_context: Annotated[
Optional[Dict[str, Any]], Doc( Optional[Dict[str, Any]],
Doc(
""" """
Additional context to pass to Pydantic when creating the response. Additional context to pass to Pydantic when creating the response.
@ -3677,7 +3683,7 @@ class FastAPI(Starlette):
Read more about serialization context in the Read more about serialization context in the
[Pydantic documentation](https://docs.pydantic.dev/latest/concepts/serialization/#serialization-context) [Pydantic documentation](https://docs.pydantic.dev/latest/concepts/serialization/#serialization-context)
""" """
) ),
] = None, ] = None,
include_in_schema: Annotated[ include_in_schema: Annotated[
bool, bool,
@ -4054,7 +4060,8 @@ class FastAPI(Starlette):
), ),
] = False, ] = False,
response_model_context: Annotated[ response_model_context: Annotated[
Optional[Dict[str, Any]], Doc( Optional[Dict[str, Any]],
Doc(
""" """
Additional context to pass to Pydantic when creating the response. Additional context to pass to Pydantic when creating the response.
@ -4065,7 +4072,7 @@ class FastAPI(Starlette):
Read more about serialization context in the Read more about serialization context in the
[Pydantic documentation](https://docs.pydantic.dev/latest/concepts/serialization/#serialization-context) [Pydantic documentation](https://docs.pydantic.dev/latest/concepts/serialization/#serialization-context)
""" """
) ),
] = None, ] = None,
include_in_schema: Annotated[ include_in_schema: Annotated[
bool, bool,
@ -4447,7 +4454,8 @@ class FastAPI(Starlette):
), ),
] = False, ] = False,
response_model_context: Annotated[ response_model_context: Annotated[
Optional[Dict[str, Any]], Doc( Optional[Dict[str, Any]],
Doc(
""" """
Additional context to pass to Pydantic when creating the response. Additional context to pass to Pydantic when creating the response.
@ -4458,7 +4466,7 @@ class FastAPI(Starlette):
Read more about serialization context in the Read more about serialization context in the
[Pydantic documentation](https://docs.pydantic.dev/latest/concepts/serialization/#serialization-context) [Pydantic documentation](https://docs.pydantic.dev/latest/concepts/serialization/#serialization-context)
""" """
) ),
] = None, ] = None,
include_in_schema: Annotated[ include_in_schema: Annotated[
bool, bool,

38
fastapi/routing.py
View File

@ -1576,7 +1576,8 @@ class APIRouter(routing.Router):
), ),
] = False, ] = False,
response_model_context: Annotated[ response_model_context: Annotated[
Optional[Dict[str, Any]], Doc( Optional[Dict[str, Any]],
Doc(
""" """
Additional context to pass to Pydantic when creating the response. Additional context to pass to Pydantic when creating the response.
@ -1968,7 +1969,8 @@ class APIRouter(routing.Router):
), ),
] = False, ] = False,
response_model_context: Annotated[ response_model_context: Annotated[
Optional[Dict[str, Any]], Doc( Optional[Dict[str, Any]],
Doc(
""" """
Additional context to pass to Pydantic when creating the response. Additional context to pass to Pydantic when creating the response.
@ -1979,7 +1981,7 @@ class APIRouter(routing.Router):
Read more about serialization context in the Read more about serialization context in the
[Pydantic documentation](https://docs.pydantic.dev/latest/concepts/serialization/#serialization-context) [Pydantic documentation](https://docs.pydantic.dev/latest/concepts/serialization/#serialization-context)
""" """
) ),
] = None, ] = None,
include_in_schema: Annotated[ include_in_schema: Annotated[
bool, bool,
@ -2365,7 +2367,8 @@ class APIRouter(routing.Router):
), ),
] = False, ] = False,
response_model_context: Annotated[ response_model_context: Annotated[
Optional[Dict[str, Any]], Doc( Optional[Dict[str, Any]],
Doc(
""" """
Additional context to pass to Pydantic when creating the response. Additional context to pass to Pydantic when creating the response.
@ -2376,7 +2379,7 @@ class APIRouter(routing.Router):
Read more about serialization context in the Read more about serialization context in the
[Pydantic documentation](https://docs.pydantic.dev/latest/concepts/serialization/#serialization-context) [Pydantic documentation](https://docs.pydantic.dev/latest/concepts/serialization/#serialization-context)
""" """
) ),
] = None, ] = None,
include_in_schema: Annotated[ include_in_schema: Annotated[
bool, bool,
@ -2762,7 +2765,8 @@ class APIRouter(routing.Router):
), ),
] = False, ] = False,
response_model_context: Annotated[ response_model_context: Annotated[
Optional[Dict[str, Any]], Doc( Optional[Dict[str, Any]],
Doc(
""" """
Additional context to pass to Pydantic when creating the response. Additional context to pass to Pydantic when creating the response.
@ -2773,7 +2777,7 @@ class APIRouter(routing.Router):
Read more about serialization context in the Read more about serialization context in the
[Pydantic documentation](https://docs.pydantic.dev/latest/concepts/serialization/#serialization-context) [Pydantic documentation](https://docs.pydantic.dev/latest/concepts/serialization/#serialization-context)
""" """
) ),
] = None, ] = None,
include_in_schema: Annotated[ include_in_schema: Annotated[
bool, bool,
@ -3154,7 +3158,8 @@ class APIRouter(routing.Router):
), ),
] = False, ] = False,
response_model_context: Annotated[ response_model_context: Annotated[
Optional[Dict[str, Any]], Doc( Optional[Dict[str, Any]],
Doc(
""" """
Additional context to pass to Pydantic when creating the response. Additional context to pass to Pydantic when creating the response.
@ -3165,7 +3170,7 @@ class APIRouter(routing.Router):
Read more about serialization context in the Read more about serialization context in the
[Pydantic documentation](https://docs.pydantic.dev/latest/concepts/serialization/#serialization-context) [Pydantic documentation](https://docs.pydantic.dev/latest/concepts/serialization/#serialization-context)
""" """
) ),
] = None, ] = None,
include_in_schema: Annotated[ include_in_schema: Annotated[
bool, bool,
@ -3546,7 +3551,8 @@ class APIRouter(routing.Router):
), ),
] = False, ] = False,
response_model_context: Annotated[ response_model_context: Annotated[
Optional[Dict[str, Any]], Doc( Optional[Dict[str, Any]],
Doc(
""" """
Additional context to pass to Pydantic when creating the response. Additional context to pass to Pydantic when creating the response.
@ -3557,7 +3563,7 @@ class APIRouter(routing.Router):
Read more about serialization context in the Read more about serialization context in the
[Pydantic documentation](https://docs.pydantic.dev/latest/concepts/serialization/#serialization-context) [Pydantic documentation](https://docs.pydantic.dev/latest/concepts/serialization/#serialization-context)
""" """
) ),
] = None, ] = None,
include_in_schema: Annotated[ include_in_schema: Annotated[
bool, bool,
@ -3943,7 +3949,8 @@ class APIRouter(routing.Router):
), ),
] = False, ] = False,
response_model_context: Annotated[ response_model_context: Annotated[
Optional[Dict[str, Any]], Doc( Optional[Dict[str, Any]],
Doc(
""" """
Additional context to pass to Pydantic when creating the response. Additional context to pass to Pydantic when creating the response.
@ -3954,7 +3961,7 @@ class APIRouter(routing.Router):
Read more about serialization context in the Read more about serialization context in the
[Pydantic documentation](https://docs.pydantic.dev/latest/concepts/serialization/#serialization-context) [Pydantic documentation](https://docs.pydantic.dev/latest/concepts/serialization/#serialization-context)
""" """
) ),
] = None, ] = None,
include_in_schema: Annotated[ include_in_schema: Annotated[
bool, bool,
@ -4340,7 +4347,8 @@ class APIRouter(routing.Router):
), ),
] = False, ] = False,
response_model_context: Annotated[ response_model_context: Annotated[
Optional[Dict[str, Any]], Doc( Optional[Dict[str, Any]],
Doc(
""" """
Additional context to pass to Pydantic when creating the response. Additional context to pass to Pydantic when creating the response.
@ -4351,7 +4359,7 @@ class APIRouter(routing.Router):
Read more about serialization context in the Read more about serialization context in the
[Pydantic documentation](https://docs.pydantic.dev/latest/concepts/serialization/#serialization-context) [Pydantic documentation](https://docs.pydantic.dev/latest/concepts/serialization/#serialization-context)
""" """
) ),
] = None, ] = None,
include_in_schema: Annotated[ include_in_schema: Annotated[
bool, bool,

1
tests/test_serialize_response_model.py
View File

@ -99,7 +99,6 @@ def get_validdict_exclude_unset():
response_model_context={"mode": "FASTAPI"}, response_model_context={"mode": "FASTAPI"},
) )
async def get_validdict_with_context(): async def get_validdict_with_context():
return { return {
"k1": Item(aliased_name="foo"), "k1": Item(aliased_name="foo"),
"k2": Item(aliased_name="bar", price=1.0), "k2": Item(aliased_name="bar", price=1.0),

2
tests/utils.py
View File

@ -8,4 +8,4 @@ needs_py310 = pytest.mark.skipif(
sys.version_info < (3, 10), reason="requires python3.10+" sys.version_info < (3, 10), reason="requires python3.10+"
) )
needs_pydanticv2 = pytest.mark.skipif(not PYDANTIC_V2, reason="requires Pydantic v2") needs_pydanticv2 = pytest.mark.skipif(not PYDANTIC_V2, reason="requires Pydantic v2")
needs_pydanticv1 = pytest.mark.skipif(PYDANTIC_V2, reason="requires Pydantic v1") needs_pydanticv1 = pytest.mark.skipif(PYDANTIC_V2, reason="requires Pydantic v1")

Write Preview
Loading…
Cancel
Save