Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork8.7k
🐛 Fix handling arbitrary types when usingarbitrary_types_allowed=True#14482
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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Merged
+166 −7
Merged
Changes fromall commits
Commits
Show all changes
4 commits Select commitHold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
32 changes: 25 additions & 7 deletionsfastapi/_compat/v2.py
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
141 changes: 141 additions & 0 deletionstests/test_arbitrary_types.py
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,141 @@ | ||
| from typing import List | ||
| import pytest | ||
| from fastapi import FastAPI | ||
| from fastapi.testclient import TestClient | ||
| from inline_snapshot import snapshot | ||
| from typing_extensions import Annotated | ||
| from .utils import needs_pydanticv2 | ||
| @pytest.fixture(name="client") | ||
| def get_client(): | ||
| from pydantic import ( | ||
| BaseModel, | ||
| ConfigDict, | ||
| PlainSerializer, | ||
| TypeAdapter, | ||
| WithJsonSchema, | ||
| ) | ||
| class FakeNumpyArray: | ||
| def __init__(self): | ||
| self.data = [1.0, 2.0, 3.0] | ||
| FakeNumpyArrayPydantic = Annotated[ | ||
| FakeNumpyArray, | ||
| WithJsonSchema(TypeAdapter(List[float]).json_schema()), | ||
| PlainSerializer(lambda v: v.data), | ||
| ] | ||
| class MyModel(BaseModel): | ||
| model_config = ConfigDict(arbitrary_types_allowed=True) | ||
| custom_field: FakeNumpyArrayPydantic | ||
| app = FastAPI() | ||
| @app.get("/") | ||
| def test() -> MyModel: | ||
| return MyModel(custom_field=FakeNumpyArray()) | ||
| client = TestClient(app) | ||
| return client | ||
| @needs_pydanticv2 | ||
| def test_get(client: TestClient): | ||
| response = client.get("/") | ||
| assert response.json() == {"custom_field": [1.0, 2.0, 3.0]} | ||
| @needs_pydanticv2 | ||
| def test_typeadapter(): | ||
| # This test is only to confirm that Pydantic alone is working as expected | ||
| from pydantic import ( | ||
| BaseModel, | ||
| ConfigDict, | ||
| PlainSerializer, | ||
| TypeAdapter, | ||
| WithJsonSchema, | ||
| ) | ||
| class FakeNumpyArray: | ||
| def __init__(self): | ||
| self.data = [1.0, 2.0, 3.0] | ||
| FakeNumpyArrayPydantic = Annotated[ | ||
| FakeNumpyArray, | ||
| WithJsonSchema(TypeAdapter(List[float]).json_schema()), | ||
| PlainSerializer(lambda v: v.data), | ||
| ] | ||
| class MyModel(BaseModel): | ||
| model_config = ConfigDict(arbitrary_types_allowed=True) | ||
| custom_field: FakeNumpyArrayPydantic | ||
| ta = TypeAdapter(MyModel) | ||
| assert ta.dump_python(MyModel(custom_field=FakeNumpyArray())) == { | ||
| "custom_field": [1.0, 2.0, 3.0] | ||
| } | ||
| assert ta.json_schema() == snapshot( | ||
| { | ||
| "properties": { | ||
| "custom_field": { | ||
| "items": {"type": "number"}, | ||
| "title": "Custom Field", | ||
| "type": "array", | ||
| } | ||
| }, | ||
| "required": ["custom_field"], | ||
| "title": "MyModel", | ||
| "type": "object", | ||
| } | ||
| ) | ||
| @needs_pydanticv2 | ||
| def test_openapi_schema(client: TestClient): | ||
| response = client.get("openapi.json") | ||
| assert response.json() == snapshot( | ||
| { | ||
| "openapi": "3.1.0", | ||
| "info": {"title": "FastAPI", "version": "0.1.0"}, | ||
| "paths": { | ||
| "/": { | ||
| "get": { | ||
| "summary": "Test", | ||
| "operationId": "test__get", | ||
| "responses": { | ||
| "200": { | ||
| "description": "Successful Response", | ||
| "content": { | ||
| "application/json": { | ||
| "schema": { | ||
| "$ref": "#/components/schemas/MyModel" | ||
| } | ||
| } | ||
| }, | ||
| } | ||
| }, | ||
| } | ||
| } | ||
| }, | ||
| "components": { | ||
| "schemas": { | ||
| "MyModel": { | ||
| "properties": { | ||
| "custom_field": { | ||
| "items": {"type": "number"}, | ||
| "type": "array", | ||
| "title": "Custom Field", | ||
| } | ||
| }, | ||
| "type": "object", | ||
| "required": ["custom_field"], | ||
| "title": "MyModel", | ||
| } | ||
| } | ||
| }, | ||
| } | ||
| ) |
Oops, something went wrong.
Uh oh!
There was an error while loading.Please reload this page.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.