Improves typing in Hash classes #146
Closed
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
tedkalaw
commented
Mar 9, 2021
xrpl/binarycodec/types/hash.py
Outdated
| """ | ||
| Construct a Hash. | ||
|
|
||
| :param buffer: The byte buffer that will be used to store | ||
| the serialized encoding of this field. | ||
| """ | ||
| buffer = buffer if buffer is not None else bytes(self._LENGTH) |
There was a problem hiding this comment.
without this, Hash.init struggles to reason about the type of buffer, even though the subclasses have this check. it seemed easier to move this here
tedkalaw
commented
Mar 9, 2021
Comment on lines
+79
to
+80
| def _get_length(cls: Type[Hash]) -> int: | ||
| raise NotImplementedError("Hash._get_length not implemented") |
There was a problem hiding this comment.
a better way to do this would probably use some combination of @property, @abstractmethod, and @classmethod, so that the base class implements an abstract getter for a class property and the subclasses can just use the length = 20 syntax
unfortunately, this isn't officially supported by mypy: python/mypy#8532
as such, i went with using a non-property getter. let me know what you think
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.
High Level Overview of Change
TSIA
Context of Change
Needed for mypy use
Type of Change
Before / After
Hash classes pass mypy --strict checks
Test Plan
CI
poetry run mypy --strict xrpl/binarycodecNo errors should originate from
xrpl/binarycodec