PBKDF2 type hint matches code - #934
Open
yorickdowne wants to merge 1 commit into
Open
yorickdowne wants to merge 1 commit into
yorickdowne wants to merge 1 commit into
Conversation
This branch has not been deployed
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.
This PR narrowly scratches an itch in my code base, where I need a type ignore for
PBKDF2. We can discuss widening it toPBKDF1andscryptPBKDF2is currently type-hinted withpassword: str, salt: bytes, but the code doesand the doc string agrees
Potential extension
PBKDF1also doespassword = tobytes(password), sopasswordat last could bybytesorstr. The salt is just appended, it must bebytes. This would however also require changing the doc from currentlypassword (string):topassword (string or byte string):scryptdelegates toPBKDF2withstage_1 = PBKDF2(password, salt, p * 128 * r, 1, prf=prf_hmac_sha256)so bytes absolutely work, but docs and type hints saystr. Could be changed in line withPBKDF2Note
tobytesagrees that it could bebytesorstr:def tobytes(s: Union[bytes, str]) -> bytes: