Add type hints for router methods meta kwargs#18
Draft
flapili wants to merge 1 commit into
Draft
Conversation
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
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.
Pull Request
Thanks for contributing to FastOpenAPI!
Before submitting, please make sure you've read CONTRIBUTING.md.
What’s Included?
Describe your changes:
Adding type hint to document usage of router's methods like get/post/... to help autocompletion, does not change runtime behavior
For now the code is draft, contains TODOs and I was not sure where I should put the Meta class so in the meantime, I nested it in the router 👀
How Was It Tested?
For now only checking autocompletion & docstring work in editor (I noticed that Ty lsp does not handle fields docstrings in typedDict yet(?) but pylance do work)
Anything Else?