From: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
Date: Tue, 2 May 2023 06:05:25 +0000 (-0700)
Subject: Improve assert_type phrasing (#104081)
X-Git-Tag: v3.12.0b1~328
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=82ba6ce303d04a7b21034e38d220e23ca9f1dc0a;p=thirdparty%2FPython%2Fcpython.git

Improve assert_type phrasing (#104081)

I'd like to make the fact that this does nothing at runtime
really obvious, since I suspect this is unintuitive for users who are
unfamiliar with static type checking.

I thought of this because of
https://discuss.python.org/t/add-arg-check-type-to-types/26384
wherein I'm skeptical that the user really did want `assert_type`.
---

diff --git a/Doc/library/typing.rst b/Doc/library/typing.rst
index 409a95d528b5..c22fc0b28a50 100644
--- a/Doc/library/typing.rst
+++ b/Doc/library/typing.rst
@@ -2484,15 +2484,16 @@ Functions and decorators
 
    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
+   At runtime this does nothing: it returns the first argument unchanged with no
+   checks or side effects, no matter the actual type of the argument.
+
+   When a static type checker encounters a call to ``assert_type()``, it
    emits an error if the value is not of the specified type::
 
        def greet(name: str) -> None:
            assert_type(name, str)  # OK, inferred type of `name` is `str`
            assert_type(name, int)  # type checker error
 
-   At runtime this returns the first argument unchanged with no side effects.
-
    This function is useful for ensuring the type checker's understanding of a
    script is in line with the developer's intentions::
 
diff --git a/Lib/typing.py b/Lib/typing.py
index 1a1c989dbaf3..0dacdd9031a7 100644
--- a/Lib/typing.py
+++ b/Lib/typing.py
@@ -2319,15 +2319,16 @@ def cast(typ, val):
 def assert_type(val, typ, /):
     """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
+    At runtime this does nothing: it returns the first argument unchanged with no
+    checks or side effects, no matter the actual type of the argument.
+
+    When a static type checker encounters a call to assert_type(), it
     emits an error if the value is not of the specified type::
 
         def greet(name: str) -> None:
             assert_type(name, str)  # ok
             assert_type(name, int)  # type checker error
 
-    At runtime this returns the first argument unchanged and otherwise
-    does nothing.
     """
     return val