Mirror
/
cpython
mirror of https://github.com/python/cpython
4
1
Fork 0
Code Issues Releases Wiki Activity

bpo-46480: rephrase typing.assert_type docs (GH-32069) 

The goal here is to reduce potential confusion between
`assert_type(val, type)` and `assert isinstance(val, typ)`.

The former is meant to ask a type checker to confirm a fact, the latter
is meant to tell a type checker a fact. The behaviour of the latter more
closely resembles what I'd expect from the prior phrasing of
"assert [something] to the type checker".
This commit is contained in:
Shantanu 2022-03-23 19:15:06 -07:00 committed by GitHub
parent 366c54633e
commit 3354245daf
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Doc/library/typing.rst
View File

@ -2150,7 +2150,7 @@ Functions and decorators
.. function:: assert_type(val, typ, /)
Assert (to the type checker) that *val* has an inferred type of *typ*.
Ask a static type checker to confirm that *val* has an inferred type of *typ*.
When the type checker encounters a call to ``assert_type()``, it
emits an error if the value is not of the specified type::

2
Lib/typing.py
View File

@ -2085,7 +2085,7 @@ def cast(typ, val):
def assert_type(val, typ, /):
"""Assert (to the type checker) that the value is of the given type.
"""Ask a static type checker to confirm that the value is of the given type.
When the type checker encounters a call to assert_type(), it
emits an error if the value is not of the specified type::