gh-106309: Deprecate typing.no_type_check_decorator (#106312)

python · Jul 13, 2023 · 32718f9 · 32718f9
1 parent 4b4a5b7
commit 32718f9
Show file tree

Hide file tree

Showing 5 changed files with 36 additions and 19 deletions.
diff --git a/Doc/library/typing.rst b/Doc/library/typing.rst
@@ -2849,6 +2849,9 @@ Functions and decorators
    This wraps the decorator with something that wraps the decorated
    function in :func:`no_type_check`.
 
+   .. deprecated-removed:: 3.13 3.15
+      No type checker ever added support for ``@no_type_check_decorator``. It
+      is therefore deprecated, and will be removed in Python 3.15.
 
 .. decorator:: override
 
@@ -3648,18 +3651,20 @@ Certain features in ``typing`` are deprecated and may be removed in a future
 version of Python. The following table summarizes major deprecations for your
 convenience. This is subject to change, and not all deprecations are listed.
 
-+----------------------------------+---------------+-------------------+----------------+
-|  Feature                         | Deprecated in | Projected removal | PEP/issue      |
-+==================================+===============+===================+================+
-|  ``typing`` versions of standard | 3.9           | Undecided         | :pep:`585`     |
-|  collections                     |               |                   |                |
-+----------------------------------+---------------+-------------------+----------------+
-|  ``typing.ByteString``           | 3.9           | 3.14              | :gh:`91896`    |
-+----------------------------------+---------------+-------------------+----------------+
-|  ``typing.Text``                 | 3.11          | Undecided         | :gh:`92332`    |
-+----------------------------------+---------------+-------------------+----------------+
-|  ``typing.Hashable`` and         | 3.12          | Undecided         | :gh:`94309`    |
-|  ``typing.Sized``                |               |                   |                |
-+----------------------------------+---------------+-------------------+----------------+
-|  ``typing.TypeAlias``            | 3.12          | Undecided         | :pep:`695`     |
-+----------------------------------+---------------+-------------------+----------------+
++-------------------------------------+---------------+-------------------+----------------+
+|  Feature                            | Deprecated in | Projected removal | PEP/issue      |
++=====================================+===============+===================+================+
+|  ``typing`` versions of standard    | 3.9           | Undecided         | :pep:`585`     |
+|  collections                        |               |                   |                |
++-------------------------------------+---------------+-------------------+----------------+
+|  ``typing.ByteString``              | 3.9           | 3.14              | :gh:`91896`    |
++-------------------------------------+---------------+-------------------+----------------+
+|  ``typing.Text``                    | 3.11          | Undecided         | :gh:`92332`    |
++-------------------------------------+---------------+-------------------+----------------+
+|  ``typing.Hashable`` and            | 3.12          | Undecided         | :gh:`94309`    |
+|  ``typing.Sized``                   |               |                   |                |
++-------------------------------------+---------------+-------------------+----------------+
+|  ``typing.TypeAlias``               | 3.12          | Undecided         | :pep:`695`     |
++-------------------------------------+---------------+-------------------+----------------+
+|  ``typing.no_type_check_decorator`` | 3.13          | 3.15              | :gh:`106309`   |
++-------------------------------------+---------------+-------------------+----------------+
diff --git a/Doc/whatsnew/3.13.rst b/Doc/whatsnew/3.13.rst
@@ -161,6 +161,10 @@ Deprecated
   ``NT = NamedTuple("NT", [])``. To create a TypedDict class with 0 fields, use
   ``class TD(TypedDict): pass`` or ``TD = TypedDict("TD", {})``.
   (Contributed by Alex Waygood in :gh:`105566` and :gh:`105570`.)
+* :func:`typing.no_type_check_decorator` is deprecated, and scheduled for
+  removal in Python 3.15. After eight years in the :mod:`typing` module, it
+  has yet to be supported by any major type checkers.
+  (Contributed by Alex Waygood in :gh:`106309`.)
 
 * :mod:`array`'s ``'u'`` format code, deprecated in docs since Python 3.3,
   emits :exc:`DeprecationWarning` since 3.13

diff --git a/Lib/test/test_typing.py b/Lib/test/test_typing.py
@@ -5794,10 +5794,14 @@ class F:
                 get_type_hints(clazz)
 
     def test_meta_no_type_check(self):
-
-        @no_type_check_decorator
-        def magic_decorator(func):
-            return func
+        depr_msg = (
+            "'typing.no_type_check_decorator' is deprecated "
+            "and slated for removal in Python 3.15"
+        )
+        with self.assertWarnsRegex(DeprecationWarning, depr_msg):
+            @no_type_check_decorator
+            def magic_decorator(func):
+                return func
 
         self.assertEqual(magic_decorator.__name__, 'magic_decorator')
 

diff --git a/Lib/typing.py b/Lib/typing.py
@@ -2395,6 +2395,8 @@ def no_type_check_decorator(decorator):
     This wraps the decorator with something that wraps the decorated
     function in @no_type_check.
     """
+    import warnings
+    warnings._deprecated("typing.no_type_check_decorator", remove=(3, 15))
     @functools.wraps(decorator)
     def wrapped_decorator(*args, **kwds):
         func = decorator(*args, **kwds)

diff --git a/Misc/NEWS.d/next/Library/2023-07-01-16-51-55.gh-issue-106309.hSlB17.rst b/Misc/NEWS.d/next/Library/2023-07-01-16-51-55.gh-issue-106309.hSlB17.rst
@@ -0,0 +1,2 @@
+Deprecate :func:`typing.no_type_check_decorator`. No major type checker ever
+added support for this decorator. Patch by Alex Waygood.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		Deprecate :func:`typing.no_type_check_decorator`. No major type checker ever
		added support for this decorator. Patch by Alex Waygood.