forked from fastapi/fastapi
-
Notifications
You must be signed in to change notification settings - Fork 0
Fix Annotated ForwardRef dependencies with postponed annotations #5
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
Open
yashwant86
wants to merge
5
commits into
master
Choose a base branch
from
pr-15234
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
2703df6
Fix Annotated ForwardRef dependencies with future annotations
abishekgiri 83c35bb
Merge branch 'master' into fix/annotated-forwardref-dependency
abishekgiri ed5ace8
Fix mypy builtins lookup in annotation resolution
abishekgiri 87063e8
🎨 Auto format
pre-commit-ci-lite[bot] 380c416
Use lenient ForwardRef resolution as fallback
abishekgiri File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
59 changes: 59 additions & 0 deletions
59
tests/test_stringified_annotation_forwardref_dependency.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,59 @@ | ||
| from __future__ import annotations | ||
|
|
||
| from dataclasses import dataclass | ||
| from typing import Annotated | ||
|
|
||
| from fastapi import Depends, FastAPI | ||
| from fastapi.testclient import TestClient | ||
| from inline_snapshot import snapshot | ||
|
|
||
| app = FastAPI() | ||
|
|
||
|
|
||
| def get_potato() -> Potato: | ||
| return Potato(color="red", size=10) | ||
|
|
||
|
|
||
| @app.get("/") | ||
| async def read_root(potato: Annotated[Potato, Depends(get_potato)]): | ||
| return {"color": potato.color, "size": potato.size} | ||
|
|
||
|
|
||
| @dataclass | ||
| class Potato: | ||
| color: str | ||
| size: int | ||
|
|
||
|
|
||
| client = TestClient(app) | ||
|
|
||
|
|
||
| def test_stringified_annotated_forwardref_dependency(): | ||
| response = client.get("/") | ||
| assert response.status_code == 200, response.text | ||
| assert response.json() == {"color": "red", "size": 10} | ||
|
|
||
|
|
||
| def test_stringified_annotated_forwardref_dependency_openapi(): | ||
| response = client.get("/openapi.json") | ||
| assert response.status_code == 200, response.text | ||
| assert response.json() == snapshot( | ||
| { | ||
| "openapi": "3.1.0", | ||
| "info": {"title": "FastAPI", "version": "0.1.0"}, | ||
| "paths": { | ||
| "/": { | ||
| "get": { | ||
| "summary": "Read Root", | ||
| "operationId": "read_root__get", | ||
| "responses": { | ||
| "200": { | ||
| "description": "Successful Response", | ||
| "content": {"application/json": {"schema": {}}}, | ||
| } | ||
| }, | ||
| } | ||
| } | ||
| }, | ||
| } | ||
| ) |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Bare
except Exception: passsilently swallows all eval errorsThe fallback
eval()catches and discards all exceptions includingSyntaxError,NameError, andTypeError. When a developer has a genuine typo or syntax error in a complexAnnotatedtype annotation, this will silently degrade to an unresolvedForwardRefwith no diagnostic output, making the root cause very hard to track down. Consider logging a debug/warning message or narrowing the exception type.Add a
logger.debug()orwarnings.warn()inside the except block so developers can diagnose annotation resolution failures, e.g.except Exception as e: logger.debug(f'Failed to resolve ForwardRef {annotation.__forward_arg__!r}: {e}').