Workaround to fix Pyright/Pydantic missing parameters issue #4725
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
Codecov Report
@@ Coverage Diff @@
## master #4725 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 531 531
Lines 13630 13630
=========================================
Hits 13630 13630
Continue to review full report at Codecov.
|
|
📝 Docs preview for commit f009542 at: https://6266e4e6547fcf1234c09be4--fastapi.netlify.app |
yezz123
approved these changes
Apr 28, 2022
|
📝 Docs preview for commit 23888ca at: https://62752357792e881799766842--fastapi.netlify.app |
|
Resolved by #4906 |
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.
Users of Pyright, or the Pylance extension in Visual Studio Code, may have noticed that when type checking is activated certain models in
fastapi.openapi.modelscomplain about missing parameters that are actually optional.Most notably, the
Schemaobject cannot be created programmatically without a type checking error as Pyright/Pylance believes that it is missing an required keyword argument,$ref, that cannot be legally provided in Python.This is due to a known compatibility issue with a workaround that is documented here:
pydantic/pydantic#3753
This PR implements that workaround for the models in
fastapi.openapi.models.