Add guide for using Request Header and improve type hints usage #1554
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.
Hi, I'm very greateful this project!
I ran into a few issues when trying to use custom headers.
First, the function argument
my_header
defined as follows didn't work no matter what I did.I got a 422 status code.
To resolve this, I had to use an alias to separate the header name with hyphens.
I also discovered a "mypy cheat" block in
ninja.params
.This causes
Header
to always be annotated in the editor, which causesHeader()
to issue a warning.I'm not entirely sure why "mypy cheat" is necessary today, but it at least seems to work.
I've also added documentation based on the issues I encountered.
Personally, I think it would be better to expect similar usage for parameters like
Query
andPath
inninja.params
, but I won't make any changes in this PR.