Add return types to all __str__ methods #3221
Closed
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
If this library is to ship type hints, it is important that those type hints are valid. A type checker (e.g. `mypy` or `pyright`) can check that those type hints are valid, but to do so, the codebase must be type hinted throughout. This PR is one small step towards that goal. This change replaces all instances of `def __str__(self):` with `def __str__(self) -> str:`. I chose to do a small PR, as to add passing type checking to the whole codebase involves hundreds or maybe thousands of changes, some of which may need real consideration.
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.
If this library is to ship type hints, it is important that those type hints are valid.
A type checker (e.g.
mypyorpyright) can check that those type hints are valid, but to do so, the codebase must be type hinted throughout. This PR is one small step towards that goal.This change replaces all instances of
def __str__(self):withdef __str__(self) -> str:.I chose to do a small PR, as to add passing type checking to the whole codebase involves hundreds or maybe thousands of changes, some of which may need real consideration.