mirror of
https://github.com/python/cpython.git
synced 2025-09-27 02:39:58 +00:00
gh-104786: Remove kwargs-based TypedDict creation (#104891)
Deprecated since Python 3.11. Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
This commit is contained in:
parent
d08679212d
commit
fea8632ec6
5 changed files with 17 additions and 63 deletions
|
@ -1780,25 +1780,14 @@ These are not used in annotations. They are building blocks for declaring types.
|
||||||
|
|
||||||
assert Point2D(x=1, y=2, label='first') == dict(x=1, y=2, label='first')
|
assert Point2D(x=1, y=2, label='first') == dict(x=1, y=2, label='first')
|
||||||
|
|
||||||
To allow using this feature with older versions of Python that do not
|
An alternative way to create a ``TypedDict`` is by using
|
||||||
support :pep:`526`, ``TypedDict`` supports two additional equivalent
|
function-call syntax. The second argument must be a literal :class:`dict`::
|
||||||
syntactic forms:
|
|
||||||
|
|
||||||
* Using a literal :class:`dict` as the second argument::
|
|
||||||
|
|
||||||
Point2D = TypedDict('Point2D', {'x': int, 'y': int, 'label': str})
|
Point2D = TypedDict('Point2D', {'x': int, 'y': int, 'label': str})
|
||||||
|
|
||||||
* Using keyword arguments::
|
This functional syntax allows defining keys which are not valid
|
||||||
|
:ref:`identifiers <identifiers>`, for example because they are
|
||||||
Point2D = TypedDict('Point2D', x=int, y=int, label=str)
|
keywords or contain hyphens::
|
||||||
|
|
||||||
.. deprecated-removed:: 3.11 3.13
|
|
||||||
The keyword-argument syntax is deprecated in 3.11 and will be removed
|
|
||||||
in 3.13. It may also be unsupported by static type checkers.
|
|
||||||
|
|
||||||
The functional syntax should also be used when any of the keys are not valid
|
|
||||||
:ref:`identifiers <identifiers>`, for example because they are keywords or contain hyphens.
|
|
||||||
Example::
|
|
||||||
|
|
||||||
# raises SyntaxError
|
# raises SyntaxError
|
||||||
class Point2D(TypedDict):
|
class Point2D(TypedDict):
|
||||||
|
@ -1955,6 +1944,9 @@ These are not used in annotations. They are building blocks for declaring types.
|
||||||
.. versionchanged:: 3.11
|
.. versionchanged:: 3.11
|
||||||
Added support for generic ``TypedDict``\ s.
|
Added support for generic ``TypedDict``\ s.
|
||||||
|
|
||||||
|
.. versionchanged:: 3.13
|
||||||
|
Removed support for the keyword-argument method of creating ``TypedDict``\ s.
|
||||||
|
|
||||||
Generic concrete collections
|
Generic concrete collections
|
||||||
----------------------------
|
----------------------------
|
||||||
|
|
||||||
|
|
|
@ -230,6 +230,9 @@ Removed
|
||||||
* :pep:`594`: Remove the :mod:`!chunk` module, deprecated in Python 3.11.
|
* :pep:`594`: Remove the :mod:`!chunk` module, deprecated in Python 3.11.
|
||||||
(Contributed by Victor Stinner in :gh:`104773`.)
|
(Contributed by Victor Stinner in :gh:`104773`.)
|
||||||
|
|
||||||
|
* Remove support for the keyword-argument method of creating
|
||||||
|
:class:`typing.TypedDict` types, deprecated in Python 3.11.
|
||||||
|
(Contributed by Tomas Roun in :gh:`104786`.)
|
||||||
|
|
||||||
Porting to Python 3.13
|
Porting to Python 3.13
|
||||||
======================
|
======================
|
||||||
|
|
|
@ -7018,35 +7018,6 @@ class TypedDictTests(BaseTestCase):
|
||||||
self.assertEqual(Emp.__annotations__, {'name': str, 'id': int})
|
self.assertEqual(Emp.__annotations__, {'name': str, 'id': int})
|
||||||
self.assertEqual(Emp.__total__, True)
|
self.assertEqual(Emp.__total__, True)
|
||||||
|
|
||||||
def test_basics_keywords_syntax(self):
|
|
||||||
with self.assertWarns(DeprecationWarning):
|
|
||||||
Emp = TypedDict('Emp', name=str, id=int)
|
|
||||||
self.assertIsSubclass(Emp, dict)
|
|
||||||
self.assertIsSubclass(Emp, typing.MutableMapping)
|
|
||||||
self.assertNotIsSubclass(Emp, collections.abc.Sequence)
|
|
||||||
jim = Emp(name='Jim', id=1)
|
|
||||||
self.assertIs(type(jim), dict)
|
|
||||||
self.assertEqual(jim['name'], 'Jim')
|
|
||||||
self.assertEqual(jim['id'], 1)
|
|
||||||
self.assertEqual(Emp.__name__, 'Emp')
|
|
||||||
self.assertEqual(Emp.__module__, __name__)
|
|
||||||
self.assertEqual(Emp.__bases__, (dict,))
|
|
||||||
self.assertEqual(Emp.__annotations__, {'name': str, 'id': int})
|
|
||||||
self.assertEqual(Emp.__total__, True)
|
|
||||||
|
|
||||||
def test_typeddict_special_keyword_names(self):
|
|
||||||
with self.assertWarns(DeprecationWarning):
|
|
||||||
TD = TypedDict("TD", cls=type, self=object, typename=str, _typename=int, fields=list, _fields=dict)
|
|
||||||
self.assertEqual(TD.__name__, 'TD')
|
|
||||||
self.assertEqual(TD.__annotations__, {'cls': type, 'self': object, 'typename': str, '_typename': int, 'fields': list, '_fields': dict})
|
|
||||||
a = TD(cls=str, self=42, typename='foo', _typename=53, fields=[('bar', tuple)], _fields={'baz', set})
|
|
||||||
self.assertEqual(a['cls'], str)
|
|
||||||
self.assertEqual(a['self'], 42)
|
|
||||||
self.assertEqual(a['typename'], 'foo')
|
|
||||||
self.assertEqual(a['_typename'], 53)
|
|
||||||
self.assertEqual(a['fields'], [('bar', tuple)])
|
|
||||||
self.assertEqual(a['_fields'], {'baz', set})
|
|
||||||
|
|
||||||
def test_typeddict_create_errors(self):
|
def test_typeddict_create_errors(self):
|
||||||
with self.assertRaises(TypeError):
|
with self.assertRaises(TypeError):
|
||||||
TypedDict.__new__()
|
TypedDict.__new__()
|
||||||
|
@ -7055,7 +7026,9 @@ class TypedDictTests(BaseTestCase):
|
||||||
with self.assertRaises(TypeError):
|
with self.assertRaises(TypeError):
|
||||||
TypedDict('Emp', [('name', str)], None)
|
TypedDict('Emp', [('name', str)], None)
|
||||||
with self.assertRaises(TypeError):
|
with self.assertRaises(TypeError):
|
||||||
TypedDict(_typename='Emp', name=str, id=int)
|
TypedDict(_typename='Emp')
|
||||||
|
with self.assertRaises(TypeError):
|
||||||
|
TypedDict('Emp', name=str, id=int)
|
||||||
|
|
||||||
def test_typeddict_errors(self):
|
def test_typeddict_errors(self):
|
||||||
Emp = TypedDict('Emp', {'name': str, 'id': int})
|
Emp = TypedDict('Emp', {'name': str, 'id': int})
|
||||||
|
|
|
@ -29,7 +29,6 @@ import operator
|
||||||
import re as stdlib_re # Avoid confusion with the typing.re namespace on <=3.11
|
import re as stdlib_re # Avoid confusion with the typing.re namespace on <=3.11
|
||||||
import sys
|
import sys
|
||||||
import types
|
import types
|
||||||
import warnings
|
|
||||||
from types import WrapperDescriptorType, MethodWrapperType, MethodDescriptorType, GenericAlias
|
from types import WrapperDescriptorType, MethodWrapperType, MethodDescriptorType, GenericAlias
|
||||||
|
|
||||||
from _typing import (
|
from _typing import (
|
||||||
|
@ -2822,7 +2821,7 @@ class _TypedDictMeta(type):
|
||||||
__instancecheck__ = __subclasscheck__
|
__instancecheck__ = __subclasscheck__
|
||||||
|
|
||||||
|
|
||||||
def TypedDict(typename, fields=None, /, *, total=True, **kwargs):
|
def TypedDict(typename, fields=None, /, *, total=True):
|
||||||
"""A simple typed namespace. At runtime it is equivalent to a plain dict.
|
"""A simple typed namespace. At runtime it is equivalent to a plain dict.
|
||||||
|
|
||||||
TypedDict creates a dictionary type that expects all of its
|
TypedDict creates a dictionary type that expects all of its
|
||||||
|
@ -2859,23 +2858,9 @@ def TypedDict(typename, fields=None, /, *, total=True, **kwargs):
|
||||||
checker is only expected to support a literal False or True as the value of
|
checker is only expected to support a literal False or True as the value of
|
||||||
the total argument. True is the default, and makes all items defined in the
|
the total argument. True is the default, and makes all items defined in the
|
||||||
class body be required.
|
class body be required.
|
||||||
|
|
||||||
The class syntax is only supported in Python 3.6+, while the other
|
|
||||||
syntax form works for Python 2.7 and 3.2+
|
|
||||||
"""
|
"""
|
||||||
if fields is None:
|
if fields is None:
|
||||||
fields = kwargs
|
fields = {}
|
||||||
elif kwargs:
|
|
||||||
raise TypeError("TypedDict takes either a dict or keyword arguments,"
|
|
||||||
" but not both")
|
|
||||||
if kwargs:
|
|
||||||
warnings.warn(
|
|
||||||
"The kwargs-based syntax for TypedDict definitions is deprecated "
|
|
||||||
"in Python 3.11, will be removed in Python 3.13, and may not be "
|
|
||||||
"understood by third-party type checkers.",
|
|
||||||
DeprecationWarning,
|
|
||||||
stacklevel=2,
|
|
||||||
)
|
|
||||||
|
|
||||||
ns = {'__annotations__': dict(fields)}
|
ns = {'__annotations__': dict(fields)}
|
||||||
module = _caller()
|
module = _caller()
|
||||||
|
|
|
@ -0,0 +1 @@
|
||||||
|
Remove kwargs-based :class:`typing.TypedDict` creation
|
Loading…
Add table
Add a link
Reference in a new issue