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
- support :pep:`526`, ``TypedDict`` supports two additional equivalent
- syntactic forms:
-
- * Using a literal :class:`dict` as the second argument::
+ An alternative way to create a ``TypedDict`` is by using
+ function-call syntax. The second argument must be a literal :class:`dict`::
Point2D = TypedDict('Point2D', {'x': int, 'y': int, 'label': str})
- * Using keyword arguments::
-
- Point2D = TypedDict('Point2D', x=int, y=int, label=str)
-
- .. 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::
+ This functional syntax allows defining keys which are not valid
+ :ref:`identifiers <identifiers>`, for example because they are
+ keywords or contain hyphens::
# raises SyntaxError
class Point2D(TypedDict):
.. versionchanged:: 3.11
Added support for generic ``TypedDict``\ s.
+ .. versionchanged:: 3.13
+ Removed support for the keyword-argument method of creating ``TypedDict``\ s.
+
Generic concrete collections
----------------------------
self.assertEqual(Emp.__annotations__, {'name': str, 'id': int})
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):
with self.assertRaises(TypeError):
TypedDict.__new__()
with self.assertRaises(TypeError):
TypedDict('Emp', [('name', str)], None)
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):
Emp = TypedDict('Emp', {'name': str, 'id': int})
import re as stdlib_re # Avoid confusion with the typing.re namespace on <=3.11
import sys
import types
-import warnings
from types import WrapperDescriptorType, MethodWrapperType, MethodDescriptorType, GenericAlias
from _typing import (
__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.
TypedDict creates a dictionary type that expects all of its
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
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:
- fields = kwargs
- 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,
- )
+ fields = {}
ns = {'__annotations__': dict(fields)}
module = _caller()
projects / thirdparty / Python / cpython.git / commitdiff
