You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Add support for TypedDict extra_items= and closed= (PEP 728) #18176
I would like to see support for this added to mypy.
Pitch
I am working on using mypy to validate Python code associated with rest API services. It is not uncommon for the OpenAPI specs we use to include objects whose additionalProperties values map to schemas. This is how OpenAPI handles the case of objects whose keywords are not known in advance, but whose values must be of a particular type.
I want to be able to type annotate these schemas in Python, but currently there is no good mechanism for doing this. That is one of the problems that PEP 728 attempts to solve.
Currently with mypy I have found a few ways to handle this (in the absence of adding the requested support):
As noted in the PEP, one can always suppress the typeddict-unknown-key errors. But of course that means no type checking is happening for the additional keys being used.
I haven't coded it up yet, but I suspect with overloading I could probably come up with something that works for this. Basically, I could overload the getitem/setitem methods in a Protocol, specifying the correct return types for the various pre-defined keys (as Literals), and then add "generic" fallback get/set item methods for the "extra key type".
It's possible I could come up with some Frankensteining of TypedDicts and defaultdicts that accomplishes this. Although that has the downside that the dict would always return a value regardless of the key, and that's not desirable.
For both 2 and 3, it would definitely be less clean and much lengthier than using the solution in typing_extensions.
From my research when trying to figure out how to handle this problem, I get the impression I am not the only one trying to handle this case. That is also indicated by the fact that the current JSON schema and OpenAPI spec includes this ability. And of course, that is part of the motivation for the PEP being opened in the first place.
changed the title [-]Add support for TypedDict __extra_items__ (PEP 728)[/-][+]Add support for TypedDict extra_items= and closed= (PEP 728)[/+]on Jun 5, 2025
Activity
layday commentedon Nov 22, 2024
The PEP has been updated and no longer specifies the
__extra_items__property.typing_extensionsdoes not yet support the new parametrised form.mharding-hpe commentedon Nov 22, 2024
Good catch -- I missed that. In that case, I think it makes sense to wait for
typing_extensionsto catch up with the PEP before supporting it in mypy.I have opened a
typing_extensionsissue for this, as I do not see one currently open.mharding-hpe commentedon Mar 21, 2025
The
typing_extensionswork just got completed for thisJukkaL commentedon Jun 5, 2025
I think all the prerequisites are ready to start work on the implementation -- we just need somebody who has time and interest to work on this.
[-]Add support for TypedDict __extra_items__ (PEP 728)[/-][+]Add support for TypedDict extra_items= and closed= (PEP 728)[/+]TypedDictwithclosed=Truecauseserror: Unexpected keyword argument "closed" for "__init_subclass__" of "TypedDict" [call-arg]typing_extensions#686 as a duplicate of this issuepeacefulotter commentedon Jan 7, 2026
Any news on this? Thanks !
Implement support for closed TypedDicts (PEP 728) (#21382)
Ignore mypy errors for TypedDict extra_items