Fix typing for FastAPI add api route #10240
Open
Conversation
This file contains 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
Make typing of endpoint parameter consistent with downstream calls and other utilities.
iudeen
approved these changes
Sep 13, 2023
|
As far as I've tested, this PR is missing the test coverage for issue #10236. Checked this modification with the tests and modification made on PR #10250, but this modification would be breaking the tests cases (I've also tested for the generators case, since this modification could be more general). |
|
Thanks @danielfcollier, can you send a link to the CI build / enumerate the tests that failed? |
|
Hi @ordinary-jamie , I run locally. But, I've just put the tests on PR #10258 to show you what would be required to add coverage for Issue #10236. There is still a more complex problem with generators, but I've left the tests for the generator's case commented. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Closes #10236
Make typing of endpoint parameter consistent with downstream calls and other utilities.
Justification for picking
Callable[..., Any]over original:FastAPI.add_api_routemakes a direct call toAPIRouter.add_api_routeanywaysfastapi.dependencies.utils.get_typed_return_annotationhas signaturedef get_typed_return_annotation(call: Callable[..., Any]) -> Any:FastAPI.add_api_websocket_route)route_class: Type[APIRoute]of whichfastapi.routing.APIRoutesubclassesstarlette.routing.Routewhich also typesendpointwithCallable[..., typing.Any]