Add Type Hints to Bech32 Functions #191
Open
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
This pull request adds type hints to various Bech32 encoding/decoding functions in the provided codebase. These changes aim to improve code readability and make it easier for developers to understand the parameter types and return types of each function. Adding type hints ensures that potential type errors can be caught early by tools such as `mypy`, and it also makes the code easier to maintain and review for developers in the future. Type hints have been added to the following functions: - `bech32_polymod` - `bech32_hrp_expand` - `bech32_verify_checksum` - `bech32_create_checksum` - `bech32_encode` - `bech32_decode` - `convertbits` - `decode` - `encode` Changes: - Added type hints using Python's `typing` module (`List`, `Tuple`, `Optional`). - No changes were made to the logic of any of the functions, ensuring that current functionality remains untouched. Motivation and Context: Adding type hints improves the developer experience by providing clearer signatures for each function. It removes ambiguity about what types the functions expect and return, helping anyone new to the codebase to understand it faster. These hints also assist static analysis tools like `mypy` to catch potential bugs or type issues.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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 pull request adds type hints to various Bech32 encoding/decoding functions in the provided codebase. These changes aim to improve code readability and make it easier for developers to understand the parameter types and return types of each function.
Adding type hints ensures that potential type errors can be caught early by tools such as
mypy, and it also makes the code easier to maintain and review for developers in the future.Type hints have been added to the following functions:
bech32_polymodbech32_hrp_expandbech32_verify_checksumbech32_create_checksumbech32_encodebech32_decodeconvertbitsdecodeencodeChanges:
typingmodule (List,Tuple,Optional).Motivation and Context:
Adding type hints improves the developer experience by providing clearer signatures for each function. It removes ambiguity about what types the functions expect and return, helping anyone new to the codebase to understand it faster. These hints also assist static analysis tools like
mypyto catch potential bugs or type issues.