Skip to content

Deprecate unusual ways of creating typing.NamedTuple classes #105566

Closed

Description

@AlexWaygood

Feature or enhancement

I propose that we deprecate in Python 3.13 the following unusual ways of constructing a typing.NamedTuple:

from typing import NamedTuple

Foo = NamedTuple("Foo", x=int, y=int)  # NamedTuple with "x" and "y" fields
Bar = NamedTuple("Bar")                # empty NamedTuple
Baz = NamedTuple("Baz", None)          # empty NamedTuple
Eggs = NamedTuple("Eggs", fields=None) # empty NamedTuple

Pitch

typing.NamedTuple has been around for quite a while now, but none of the above methods of constructing NamedTuples are supported by type checkers. If they're still unsupported by type checkers after all this time, they're unlikely to ever be supported by type checkers.

Deprecating, and eventually removing, these ways of constructing NamedTuples will allow us to simplify the code at runtime. It will also be less confusing for users. Every way in which the runtime and type checkers differ in behaviour is a potential point of confusion for users; in general, we should work to keep these points of difference to a minimum.

These methods of constructing NamedTuples are not commonly seen in the wild. They're also pretty redundant -- if you want to construct a NamedTuple in one line, in a single function call, you can do it like this, which is supported by type checkers:

Foo = NamedTuple("Foo", [("x", int), ("y", int)])

If you want to construct an empty NamedTuple, meanwhile, you can do it in one of the following two ways, which are both supported by type checkers:

Bar = NamedTuple("Bar", [])
class Baz(NamedTuple): ...

Previous discussion

For very similar reasons, we previously deprecated and removed the keyword-argument syntax for creating TypedDicts. This was deprecated in 3.11, and removed in 3.13:

Linked PRs

Activity

  1. added
    type-featureA feature request or enhancement
    stdlibStandard Library Python modules in the Lib/ directory
    3.13only security fixes
    on Jun 9, 2023
  2. changed the title [-]Deprecate unusual ways of constructing `NamedTuple`s[/-] [+]Deprecate unusual ways of creating `typing.NamedTuple` classes[/+] on Jun 9, 2023
  3. added a commit that references this issue on Jun 9, 2023
  4. self-assigned this
    on Jun 10, 2023
  5. added a commit that references this issue on Jun 14, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

3.13only security fixesstdlibStandard Library Python modules in the Lib/ directorytopic-typingtype-featureA feature request or enhancement

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions