fix type hint for CSRFProtectMiddleware
#17
Merged
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
Parameter `csrf_secret` of class `CSRFProtectMiddleware` should be of type `Optional[str]` instead of `Optional[ByteString]` as `generate_csrf` and `validate_csrf` take in `csrf_secret` as `str`.
Passing a `ByteString` as `csrf_secret` to `CSRFProtectMiddleware` cause token validation to raise `BadSignature` exception, and `validate_csrf` to raise `ValidationError('The CSRF token is invalid.')`.
|
Awesome! Thanks for the bugfix. |
Merged
amorey
added a commit
that referenced
this pull request
Apr 9, 2024
* Added support for form prefixes (#15) * Fixed type hint issue in CSRFProtectMiddleware (#17) * Fixed deprecation warnings in tests * Updated README to latest dev best practices * Fixed bugs in examples, added READMEs and requirements.txt files --------- Co-authored-by: Le Tuan Hai <letuanhai@live.com>
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.
Parameter
csrf_secretof classCSRFProtectMiddlewareshould be of typeOptional[str]instead ofOptional[ByteString]asgenerate_csrfandvalidate_csrftake incsrf_secretasstr. Passing aByteStringascsrf_secrettoCSRFProtectMiddlewarecause token validation to raiseBadSignatureexception, andvalidate_csrfto raiseValidationError('The CSRF token is invalid.').