From: sobolevn <mail@sobolevn.me>
Date: Tue, 4 Mar 2025 15:15:00 +0000 (+0300)
Subject: gh-129567: Add a note to `typing.TypedDict` docs about name mangling (#130233)
X-Git-Tag: v3.14.0a6~167
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=63ffb406bb000a42b0dbddcfc01cb98a12f8f76a;p=thirdparty%2FPython%2Fcpython.git

gh-129567: Add a note to `typing.TypedDict` docs about name mangling (#130233)
---

diff --git a/Doc/library/typing.rst b/Doc/library/typing.rst
index 0fee782121b0..19b4081c993e 100644
--- a/Doc/library/typing.rst
+++ b/Doc/library/typing.rst
@@ -2551,15 +2551,20 @@ types.
 
    This functional syntax allows defining keys which are not valid
    :ref:`identifiers <identifiers>`, for example because they are
-   keywords or contain hyphens::
+   keywords or contain hyphens, or when key names must not be
+   :ref:`mangled <private-name-mangling>` 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`::