documentation for TypeIs #17821
Merged
documentation for TypeIs #17821
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
for more information, see https://pre-commit.ci
for more information, see https://pre-commit.ci
for more information, see https://pre-commit.ci
JukkaL
reviewed
Oct 8, 2024
docs/source/type_narrowing.rst
Outdated
| TypeIs | ||
| ------ | ||
|
|
||
| Mypy supports TypeIs (:pep:`754`). |
docs/source/type_narrowing.rst
Outdated
|
|
||
|
|
||
| While both TypeIs and TypeGuard allow you to define custom type narrowing | ||
| functions, they differ in important ways: |
There was a problem hiding this comment.
The paragraph above is a duplicate.
docs/source/type_narrowing.rst
Outdated
|
|
||
| def process(x: Any) -> None: | ||
| if is_instance_of(x, int): | ||
| reveal_type(x) # Revealed type is 'int' or any int subclass |
There was a problem hiding this comment.
Nit: The revealed type is just 'int', not any subclass.
JukkaL
pushed a commit
that referenced
this pull request
Oct 9, 2024
Fixes #17156. As requested in the issue, added documentation for the desired behaviour of TypeIs.
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.
Fixes #17156
As requested in the issue, added documentation for the desired behaviour of TypeIs.