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

Remove xfail for defaul_factory in openapi

pull/14829/head
Yurii Motov 4 months ago
parent
27cc340880
commit
d90bcc8569
5 changed files with 71 additions and 64 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Split View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 40
      tests/test_request_params/test_body/test_nullable_and_defaults.py
  2. 1
      tests/test_request_params/test_file/test_nullable_and_defaults.py
  3. 34
      tests/test_request_params/test_form/test_nullable_and_defaults.py
  4. 27
      tests/test_request_params/test_header/test_nullable_and_defaults.py
  5. 33
      tests/test_request_params/test_query/test_nullable_and_defaults.py

40
tests/test_request_params/test_body/test_nullable_and_defaults.py
View File

@ -2,7 +2,7 @@ from typing import Annotated, Any, Union
from unittest.mock import Mock, patch
import pytest
from dirty_equals import IsList, IsOneOf
from dirty_equals import IsList, IsOneOf, IsPartialDict
from fastapi import Body, FastAPI
from fastapi.testclient import TestClient
from pydantic import BaseModel, BeforeValidator, field_validator
@ -811,20 +811,16 @@ async def read_nullable_with_non_null_default_no_embed_list(
@pytest.mark.parametrize(
"path",
[
pytest.param(
"/nullable-with-non-null-default",
marks=pytest.mark.xfail(
reason="`default_factory` is not reflected in OpenAPI schema"
),
),
"/nullable-with-non-null-default",
"/model-nullable-with-non-null-default",
],
)
def test_nullable_with_non_null_default_schema(path: str):
openapi = app.openapi()
body_model_name = get_body_model_name(openapi, path)
body_model = app.openapi()["components"]["schemas"][body_model_name]
assert app.openapi()["components"]["schemas"][body_model_name] == {
assert body_model == {
"properties": {
"int_val": {
"title": "Int Val",
@ -836,19 +832,25 @@ def test_nullable_with_non_null_default_schema(path: str):
"anyOf": [{"type": "string"}, {"type": "null"}],
"default": "default",
},
"list_val": {
"title": "List Val",
"anyOf": [
{"type": "array", "items": {"type": "integer"}},
{"type": "null"},
],
"default": [0], # default_factory is not reflected in OpenAPI schema
},
"list_val": IsPartialDict(
{
"title": "List Val",
"anyOf": [
{"type": "array", "items": {"type": "integer"}},
{"type": "null"},
],
},
),
},
"title": body_model_name,
"type": "object",
}
if path == "/model-nullable-with-non-null-default":
# Check default value for list_val param for model-based Body parameters only.
# default_factory is not reflected in OpenAPI schema
assert body_model["properties"]["list_val"]["default"] == [0]
@pytest.mark.parametrize(
("path", "schema"),
@ -869,7 +871,7 @@ def test_nullable_with_non_null_default_schema(path: str):
"default": -1,
},
),
pytest.param(
(
"/nullable-with-non-null-default-list",
{
"anyOf": [
@ -877,11 +879,7 @@ def test_nullable_with_non_null_default_schema(path: str):
{"type": "null"},
],
"title": "List Val",
"default": [0], # default_factory is not reflected in OpenAPI schema
},
marks=pytest.mark.xfail(
reason="`default_factory` is not reflected in OpenAPI schema"
),
),
],
)

1
tests/test_request_params/test_file/test_nullable_and_defaults.py
View File

@ -393,7 +393,6 @@ def test_nullable_with_non_null_default_schema(path: str):
{"type": "array", "items": {"type": "string", "format": "binary"}},
{"type": "null"},
],
# "default": None, # default_factory is not reflected in OpenAPI schema
},
},
"title": body_model_name,

34
tests/test_request_params/test_form/test_nullable_and_defaults.py
View File

@ -2,7 +2,7 @@ from typing import Annotated, Any, Union
from unittest.mock import Mock, patch
import pytest
from dirty_equals import IsList, IsOneOf
from dirty_equals import IsList, IsOneOf, IsPartialDict
from fastapi import FastAPI, Form
from fastapi.testclient import TestClient
from pydantic import BaseModel, BeforeValidator, field_validator
@ -462,20 +462,16 @@ async def read_model_nullable_with_non_null_default(
@pytest.mark.parametrize(
"path",
[
pytest.param(
"/nullable-with-non-null-default",
marks=pytest.mark.xfail(
reason="`default_factory` is not reflected in OpenAPI schema"
),
),
"/nullable-with-non-null-default",
"/model-nullable-with-non-null-default",
],
)
def test_nullable_with_non_null_default_schema(path: str):
openapi = app.openapi()
body_model_name = get_body_model_name(openapi, path)
body_model = app.openapi()["components"]["schemas"][body_model_name]
assert app.openapi()["components"]["schemas"][body_model_name] == {
assert body_model == {
"properties": {
"int_val": {
"title": "Int Val",
@ -487,19 +483,25 @@ def test_nullable_with_non_null_default_schema(path: str):
"anyOf": [{"type": "string"}, {"type": "null"}],
"default": "default",
},
"list_val": {
"title": "List Val",
"anyOf": [
{"type": "array", "items": {"type": "integer"}},
{"type": "null"},
],
"default": [0], # default_factory is not reflected in OpenAPI schema
},
"list_val": IsPartialDict(
{
"title": "List Val",
"anyOf": [
{"type": "array", "items": {"type": "integer"}},
{"type": "null"},
],
}
),
},
"title": body_model_name,
"type": "object",
}
if path == "/model-nullable-with-non-null-default":
# Check default value for list_val param for model-based Body parameters only.
# default_factory is not reflected in OpenAPI schema
assert body_model["properties"]["list_val"]["default"] == [0]
@pytest.mark.parametrize(
"path",

27
tests/test_request_params/test_header/test_nullable_and_defaults.py
View File

@ -2,7 +2,7 @@ from typing import Annotated, Any, Union
from unittest.mock import Mock, patch
import pytest
from dirty_equals import AnyThing, IsList, IsOneOf
from dirty_equals import AnyThing, IsList, IsOneOf, IsPartialDict
from fastapi import FastAPI, Header
from fastapi.testclient import TestClient
from pydantic import BaseModel, BeforeValidator, field_validator
@ -420,7 +420,8 @@ async def read_model_nullable_with_non_null_default(
],
)
def test_nullable_with_non_null_default_schema(path: str):
assert app.openapi()["paths"][path]["get"]["parameters"] == [
parameters = app.openapi()["paths"][path]["get"]["parameters"]
assert parameters == [
{
"required": False,
"schema": {
@ -443,19 +444,25 @@ def test_nullable_with_non_null_default_schema(path: str):
},
{
"required": False,
"schema": {
"title": "List Val",
"anyOf": [
{"type": "array", "items": {"type": "integer"}},
{"type": "null"},
],
"default": [0],
},
"schema": IsPartialDict(
{
"title": "List Val",
"anyOf": [
{"type": "array", "items": {"type": "integer"}},
{"type": "null"},
],
}
),
"name": "list-val",
"in": "header",
},
]
if path == "/model-nullable-with-non-null-default":
# Check default value for list_val param for model-based Body parameters only.
# default_factory is not reflected in OpenAPI schema
assert parameters[2]["schema"]["default"] == [0]
@pytest.mark.parametrize(
"path",

33
tests/test_request_params/test_query/test_nullable_and_defaults.py
View File

@ -2,7 +2,7 @@ from typing import Annotated, Any, Union
from unittest.mock import Mock, patch
import pytest
from dirty_equals import IsList, IsOneOf
from dirty_equals import IsList, IsOneOf, IsPartialDict
from fastapi import FastAPI, Query
from fastapi.testclient import TestClient
from pydantic import BaseModel, BeforeValidator, field_validator
@ -378,17 +378,13 @@ async def read_model_nullable_with_non_null_default(
@pytest.mark.parametrize(
"path",
[
pytest.param(
"/nullable-with-non-null-default",
marks=pytest.mark.xfail(
reason="`default_factory` is not reflected in OpenAPI schema"
),
),
"/nullable-with-non-null-default",
"/model-nullable-with-non-null-default",
],
)
def test_nullable_with_non_null_default_schema(path: str):
assert app.openapi()["paths"][path]["get"]["parameters"] == [
parameters = app.openapi()["paths"][path]["get"]["parameters"]
assert parameters == [
{
"required": False,
"schema": {
@ -413,17 +409,22 @@ def test_nullable_with_non_null_default_schema(path: str):
"in": "query",
"name": "list_val",
"required": False,
"schema": {
"anyOf": [
{"items": {"type": "integer"}, "type": "array"},
{"type": "null"},
],
"title": "List Val",
"default": [0], # `default_factory` is not reflected in OpenAPI schema
},
"schema": IsPartialDict(
{
"anyOf": [
{"items": {"type": "integer"}, "type": "array"},
{"type": "null"},
],
"title": "List Val",
}
),
},
]
if path == "/model-nullable-with-non-null-default":
# Check default value for list_val param for model-based Body parameters only.
# default_factory is not reflected in OpenAPI schema
assert parameters[2]["schema"]["default"] == [0]
@pytest.mark.parametrize(
"path",

Write Preview
Loading…
Cancel
Save