118 lines
3.4 KiB
Python
118 lines
3.4 KiB
Python
|
# mypy: ignore-errors
|
||
|
|
|
||
|
|
from typing import Optional
|
||
|
|
|
||
|
|
import pytest
|
||
|
|
|
||
|
|
from openapi_pydantic.compat import PYDANTIC_V2
|
||
|
|
from openapi_pydantic.v3.v3_0 import (
|
||
|
|
Info,
|
||
|
|
MediaType,
|
||
|
|
OpenAPI,
|
||
|
|
Operation,
|
||
|
|
PathItem,
|
||
|
|
RequestBody,
|
||
|
|
Response,
|
||
|
|
Schema,
|
||
|
|
)
|
||
|
|
from openapi_pydantic.v3.v3_0.util import (
|
||
|
|
PydanticSchema,
|
||
|
|
construct_open_api_with_schema_class,
|
||
|
|
)
|
||
|
|
|
||
|
|
|
||
|
|
@pytest.mark.skipif(not PYDANTIC_V2, reason="computed fields require Pydantic V2")
|
||
|
|
def test_optional_and_computed_fields() -> None:
|
||
|
|
api = construct_sample_api()
|
||
|
|
|
||
|
|
result = construct_open_api_with_schema_class(api)
|
||
|
|
assert result.components is not None
|
||
|
|
assert result.components.schemas is not None
|
||
|
|
|
||
|
|
req_schema = result.components.schemas["SampleRequest"]
|
||
|
|
assert isinstance(req_schema, Schema)
|
||
|
|
assert req_schema.properties is not None
|
||
|
|
assert req_schema.required is not None
|
||
|
|
|
||
|
|
resp_schema = result.components.schemas["SampleResponse"]
|
||
|
|
assert isinstance(resp_schema, Schema)
|
||
|
|
assert resp_schema.properties is not None
|
||
|
|
assert resp_schema.required is not None
|
||
|
|
|
||
|
|
# When validating:
|
||
|
|
# - required fields are still required
|
||
|
|
# - optional fields are still optional
|
||
|
|
# - computed fields don't exist
|
||
|
|
assert "req" in req_schema.properties
|
||
|
|
assert "opt" in req_schema.properties
|
||
|
|
assert "comp" not in req_schema.properties
|
||
|
|
assert set(req_schema.required) == {"req"}
|
||
|
|
|
||
|
|
# When serializing:
|
||
|
|
# - required fields are still required
|
||
|
|
# - optional fields are still optional
|
||
|
|
# (except when json_schema_serialization_defaults_required is enabled)
|
||
|
|
# - computed fields are required
|
||
|
|
assert "req" in resp_schema.properties
|
||
|
|
assert "opt" in resp_schema.properties
|
||
|
|
assert "comp" in resp_schema.properties
|
||
|
|
assert set(resp_schema.required) == {"req", "comp"}
|
||
|
|
|
||
|
|
|
||
|
|
def construct_sample_api() -> OpenAPI:
|
||
|
|
from typing import TYPE_CHECKING, Callable
|
||
|
|
|
||
|
|
from pydantic import BaseModel
|
||
|
|
|
||
|
|
if TYPE_CHECKING:
|
||
|
|
|
||
|
|
def computed_field(x: Callable) -> Callable: ...
|
||
|
|
|
||
|
|
else:
|
||
|
|
from pydantic import computed_field
|
||
|
|
|
||
|
|
class SampleModel(BaseModel):
|
||
|
|
req: bool
|
||
|
|
opt: Optional[bool] = None
|
||
|
|
|
||
|
|
@computed_field # type: ignore
|
||
|
|
@property
|
||
|
|
def comp(self) -> bool:
|
||
|
|
return True
|
||
|
|
|
||
|
|
class SampleRequest(SampleModel):
|
||
|
|
model_config = {"json_schema_mode": "validation"}
|
||
|
|
|
||
|
|
class SampleResponse(SampleModel):
|
||
|
|
model_config = {"json_schema_mode": "serialization"}
|
||
|
|
|
||
|
|
return OpenAPI(
|
||
|
|
info=Info(
|
||
|
|
title="Sample API",
|
||
|
|
version="v0.0.1",
|
||
|
|
),
|
||
|
|
paths={
|
||
|
|
"/callme": PathItem(
|
||
|
|
post=Operation(
|
||
|
|
requestBody=RequestBody(
|
||
|
|
content={
|
||
|
|
"application/json": MediaType(
|
||
|
|
schema=PydanticSchema(schema_class=SampleRequest)
|
||
|
|
)
|
||
|
|
}
|
||
|
|
),
|
||
|
|
responses={
|
||
|
|
"200": Response(
|
||
|
|
description="resp",
|
||
|
|
content={
|
||
|
|
"application/json": MediaType(
|
||
|
|
schema=PydanticSchema(schema_class=SampleResponse)
|
||
|
|
)
|
||
|
|
},
|
||
|
|
)
|
||
|
|
},
|
||
|
|
)
|
||
|
|
)
|
||
|
|
},
|
||
|
|
)
|