From ce8d276336f305f5a0ae7e4787535dfb360070db Mon Sep 17 00:00:00 2001 From: sobolevn Date: Tue, 4 Mar 2025 18:15:00 +0300 Subject: [PATCH] gh-129567: Add a note to `typing.TypedDict` docs about name mangling (GH-130233) (cherry picked from commit 63ffb406bb000a42b0dbddcfc01cb98a12f8f76a) Co-authored-by: sobolevn --- Doc/library/typing.rst | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/Doc/library/typing.rst b/Doc/library/typing.rst index 0c45c21841ace4..bd6a793b88234b 100644 --- a/Doc/library/typing.rst +++ b/Doc/library/typing.rst @@ -2475,15 +2475,20 @@ types. This functional syntax allows defining keys which are not valid :ref:`identifiers `, for example because they are - keywords or contain hyphens:: + keywords or contain hyphens, or when key names must not be + :ref:`mangled ` like regular private names:: # raises SyntaxError class Point2D(TypedDict): in: int # 'in' is a keyword x-y: int # name with hyphens + class Definition(TypedDict): + __schema: str # mangled to `_Definition__schema` + # OK, functional syntax Point2D = TypedDict('Point2D', {'in': int, 'x-y': int}) + Definition = TypedDict('Definition', {'__schema': str}) # not mangled By default, all keys must be present in a ``TypedDict``. It is possible to mark individual keys as non-required using :data:`NotRequired`::