| FazBrowse GitHub Viewer | Trending | | Home |
| Tools: [Download Repo ZIP] [Original HTTPS Page] |
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| Expand Up | @@ -5,7 +5,7 @@ | |
| * Imports and exports, all public names should be explicitly added to __all__. | ||
| * Internal helper functions: these should never be used in code outside this module. | ||
| * _SpecialForm and its instances (special forms): | ||
| Any, NoReturn, ClassVar, Union, Optional, Concatenate | ||
| Any, NoReturn, Never, ClassVar, Union, Optional, Concatenate | ||
| * Classes whose instances can be type arguments in addition to types: | ||
| ForwardRef, TypeVar and ParamSpec | ||
| * The core of internal generics API: _GenericAlias and _VariadicGenericAlias, the latter is | ||
| Expand Down Expand Up | @@ -117,12 +117,14 @@ def _idfunc(_, x): | |
|
|
||
| # One-off things. | ||
| 'AnyStr', | ||
| 'assert_never', | ||
| 'cast', | ||
| 'final', | ||
| 'get_args', | ||
| 'get_origin', | ||
| 'get_type_hints', | ||
| 'is_typeddict', | ||
| 'Never', | ||
| 'NewType', | ||
| 'no_type_check', | ||
| 'no_type_check_decorator', | ||
| Expand Down Expand Up | @@ -175,7 +177,7 @@ def _type_check(arg, msg, is_argument=True, module=None, *, allow_special_forms= | |
| if (isinstance(arg, _GenericAlias) and | ||
| arg.__origin__ in invalid_generic_forms): | ||
| raise TypeError(f"{arg} is not valid as type argument") | ||
| if arg in (Any, NoReturn, Self, ClassVar, Final, TypeAlias): | ||
| if arg in (Any, NoReturn, Never, Self, ClassVar, Final, TypeAlias): | ||
| return arg | ||
| if isinstance(arg, _SpecialForm) or arg in (Generic, Protocol): | ||
| raise TypeError(f"Plain {arg} is not valid as type argument") | ||
| Expand Down Expand Up | @@ -441,8 +443,39 @@ def NoReturn(self, parameters): | |
| def stop() -> NoReturn: | ||
| raise Exception('no way') | ||
|
|
||
| This type is invalid in other positions, e.g., ``List[NoReturn]`` | ||
| will fail in static type checkers. | ||
| NoReturn can also be used as a bottom type, a type that | ||
| has no values. Starting in Python 3.11, the Never type should | ||
| be used for this concept instead. Type checkers should treat the two | ||
| equivalently. | ||
|
|
||
| """ | ||
| raise TypeError(f"{self} is not subscriptable") | ||
|
|
||
| # This is semantically identical to NoReturn, but it is implemented | ||
| # separately so that type checkers can distinguish between the two | ||
| # if they want. | ||
| @_SpecialForm | ||
| def Never(self, parameters): | ||
|
Comment thread
JelleZijlstra marked this conversation as resolved.
|
||
| """The bottom type, a type that has no members. | ||
|
|
||
| This can be used to define a function that should never be | ||
| called, or a function that never returns:: | ||
|
|
||
| from typing import Never | ||
|
|
||
| def never_call_me(arg: Never) -> None: | ||
| pass | ||
|
|
||
| def int_or_str(arg: int | str) -> None: | ||
| never_call_me(arg) # type checker error | ||
| match arg: | ||
| case int(): | ||
| print("It's an int") | ||
| case str(): | ||
| print("It's a str") | ||
| case _: | ||
| never_call_me(arg) # ok, arg is of type Never | ||
|
|
||
| """ | ||
| raise TypeError(f"{self} is not subscriptable") | ||
|
|
||
| Expand Down Expand Up | @@ -2050,6 +2083,29 @@ class Film(TypedDict): | |
| return isinstance(tp, _TypedDictMeta) | ||
|
|
||
|
|
||
| def assert_never(arg: Never, /) -> Never: | ||
| """Statically assert that a line of code is unreachable. | ||
|
|
||
| Example:: | ||
|
|
||
| def int_or_str(arg: int | str) -> None: | ||
| match arg: | ||
| case int(): | ||
| print("It's an int") | ||
| case str(): | ||
| print("It's a str") | ||
| case _: | ||
| assert_never(arg) | ||
|
|
||
| If a type checker finds that a call to assert_never() is | ||
| reachable, it will emit an error. | ||
|
Comment thread
Comment on lines
+2091
to
+2101
Copy link
Copy Markdown
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low QualityThis example is much better than the examples in the main doc. :-) And so is the sentence following the example.
Sorry, something went wrong.
All reactions
Copy link
Copy Markdown
Member
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low QualityThat sentence is also in the docs for assert_never, but not Never. I'm pushing some changes to improve the Never docs according to your feedback. Honestly I'm a bit confused about the relationship between the docstring and the RST docs. I end up copying from one to the other.
Sorry, something went wrong.
All reactions
Copy link
Copy Markdown
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low QualityUsually the docstring is shorter, since it is often displayed by tools that have limited output space (it's really annoying to get a scroll bar in a tooltip in VS Code :-).
Sorry, something went wrong.
All reactions
|
||
|
|
||
| At runtime, this throws an exception when called. | ||
|
|
||
| """ | ||
| raise AssertionError("Expected code to be unreachable") | ||
|
Comment thread
gvanrossum marked this conversation as resolved.
|
||
|
|
||
|
|
||
| def no_type_check(arg): | ||
| """Decorator to indicate that annotations are not type hints. | ||
|
|
||
| Expand Down | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| Add :data:`typing.Never` and :func:`typing.assert_never`. Patch by Jelle | ||
| Zijlstra. |
| Back | FazBrowse Home | New Git URL |
Uh oh!
There was an error while loading. Please reload this page.