This repository was archived by the owner on Dec 25, 2024. It is now read-only.
Improves endpoint response type hints, handles all error responses corner case #20
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.
which resulted in:
So those are how I wrote the skip_deserialization inputs in the type hints
It doesn't work in pycharm because of https://youtrack.jetbrains.com/issue/PY-38074/Ignore-return-types-of-fallback-overloads-for-functions-exactly-matched-by-a-literal-type
but it DOES work in VScode
Corner cases for endpoint response type hinting:
PR checklist
This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
These must match the expectations made by your contribution.
You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example
./bin/generate-samples.sh bin/configs/python*
.For Windows users, please run the script in Git BASH.