Adds docs about exhaustive literal and enum checks #10860
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
ilevkivskyi
approved these changes
Jul 22, 2021
docs/source/literal_types.rst
Outdated
|
|
||
| PossibleValues = Literal['one', 'two'] | ||
|
|
||
| def assert_exhaustive(value: NoReturn) -> NoReturn: |
There was a problem hiding this comment.
People actually often call this function assert_never() it can be used is some other cases where people want to check statically some will not be executed.
docs/source/literal_types.rst
Outdated
| return False | ||
| assert_exhaustive(x) # E: Argument 1 to "assert_exhaustive" has incompatible type "Literal['three']"; expected "NoReturn" | ||
|
|
||
| This technique works with ``Enum`` values as well. |
There was a problem hiding this comment.
I would move the Enum reference to the start, and maybe even make this a default example (while mentioning it also works for literal types with a short example). IMO literal types are more for legacy code, while enums are the future.
|
@ilevkivskyi thanks a lot for the review! Fixed 👍 |
ilevkivskyi
reviewed
Jul 22, 2021
docs/source/literal_types.rst
Outdated
| return True | ||
| elif x == 'two': | ||
| return False | ||
| assert_never(x) # E: Argument 1 to "assert_exhaustive" has incompatible type "Literal['three']"; expected "NoReturn" |
There was a problem hiding this comment.
The comment still refers to the old name assert_exhaustive
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 feature is not-really known from my experience. I had to explain it several times to other devs.
But, I think that this technique should be widely recognised! It is awesome!
Refs #6366