mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-08-04 00:48:58 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 8

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

Browse source 
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
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::