]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
gh-129567: Add a note to `typing.TypedDict` docs about name mangling (#130233)
authorsobolevn <mail@sobolevn.me>
Tue, 4 Mar 2025 15:15:00 +0000 (18:15 +0300)
committerGitHub <noreply@github.com>
Tue, 4 Mar 2025 15:15:00 +0000 (18:15 +0300)
Doc/library/typing.rst

index 0fee782121b0af9a12fb9a958e6f120db3eeec72..19b4081c993e4498c9dffff8a5de1ac0a9151a16 100644 (file)
@@ -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`::