Skip to content

bpo-38834: enable runtime inspection of TypeDict classes#17214

Merged
ilevkivskyi merged 1 commit intopython:masterfrom
Zac-HD:typdedict-runtime
Nov 24, 2019
Merged

bpo-38834: enable runtime inspection of TypeDict classes#17214
ilevkivskyi merged 1 commit intopython:masterfrom
Zac-HD:typdedict-runtime

Conversation

@Zac-HD
Copy link
Copy Markdown
Contributor

@Zac-HD Zac-HD commented Nov 18, 2019 •
edited
Loading

This patch enables downstream projects inspecting a TypedDict subclass at runtime to tell which keys are optional, which is essential for generating test data with Hypothesis or validating inputs with typeguard or pydantic.

More background on the typing-sig mailing list (cc @ilevkivskyi).

https://bugs.python.org/issue38834

@Zac-HD
Better runtime TypedDict
0433602 
This patch enables downstream projects inspecting a TypedDict subclass at runtime to tell which keys are optional.

This is essential for generating test data with Hypothesis or validating inputs with typeguard or pydantic.
@Zac-HD Zac-HD mentioned this pull request Nov 18, 2019
Merged
ilevkivskyi
ilevkivskyi approved these changes Nov 23, 2019
View reviewed changes
Copy link
Copy Markdown
Member

@ilevkivskyi ilevkivskyi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! All looks good.

@ilevkivskyi
Copy link
Copy Markdown
Member

ilevkivskyi commented Nov 23, 2019

@gvanrossum What do you think, can we include this in 3.8.1? Or should it just go to master (3.9) and typing_extensions?

@gvanrossum
Copy link
Copy Markdown
Member

gvanrossum commented Nov 24, 2019

@gvanrossum What do you think, can we include this in 3.8.1? Or should it just go to master (3.9) and typing_extensions?

I'd put in 3.9 (master) and in typing_extensions.

@ilevkivskyi
Copy link
Copy Markdown
Member

ilevkivskyi commented Nov 24, 2019

OK, @Zac-HD could you please make a PR to https://github.com/python/typing adding this to typing_extensions?

@ilevkivskyi ilevkivskyi merged commit 665ad3d into python:master Nov 24, 2019
@Zac-HD Zac-HD deleted the typdedict-runtime branch November 24, 2019 12:22
@Zac-HD Zac-HD mentioned this pull request Nov 24, 2019
Merged
ilevkivskyi pushed a commit to python/typing that referenced this pull request Nov 24, 2019
@Zac-HD @ilevkivskyi
Track optional TypdeDict keys (#687)
2b4749c 
Backport of python/cpython#17214 (BPO-38834)
jacobneiltaylor pushed a commit to jacobneiltaylor/cpython that referenced this pull request Dec 5, 2019
@Zac-HD
Better runtime TypedDict (pythonGH-17214)
b95e923 
This patch enables downstream projects inspecting a TypedDict subclass at runtime to tell which keys are optional.

This is essential for generating test data with Hypothesis or validating inputs with typeguard or pydantic.
shihai1991 pushed a commit to shihai1991/cpython that referenced this pull request Jan 31, 2020
@Zac-HD @shihai1991
Better runtime TypedDict (pythonGH-17214)
c96737d 
This patch enables downstream projects inspecting a TypedDict subclass at runtime to tell which keys are optional.

This is essential for generating test data with Hypothesis or validating inputs with typeguard or pydantic.
@Zac-HD Zac-HD mentioned this pull request Feb 12, 2020
Closed
@Zac-HD Zac-HD mentioned this pull request May 4, 2020
Merged
@antonagestam antonagestam mentioned this pull request Oct 16, 2020
Closed
@agronholm
Copy link
Copy Markdown
Contributor

agronholm commented Oct 17, 2020

@Zac-HD I don't think this was intended:

>>> DummyDict = TypedDict('DummyDict', {'x': int, 'y': str}, total=False)
>>> DummyDict.__required_keys__
frozenset({'x', 'y'})

__required_keys__ turns out the same regardless of whether total is False or True.
It's unfortunate that this got in the final release.

@agronholm
Copy link
Copy Markdown
Contributor

agronholm commented Oct 17, 2020

The bug is not really your fault though; It happens because def TypedDict(typename, fields=None, /, *, total=True, **kwargs): does not pass total to _TypedDictMeta(). It still passes __total__ in the attribute namespace, but your code does not check that. A test against the older syntax should have been included.

@agronholm
Copy link
Copy Markdown
Contributor

agronholm commented Oct 17, 2020

Created https://bugs.python.org/issue42059.

@Zac-HD Zac-HD mentioned this pull request Mar 1, 2021
Closed
@kkom kkom mentioned this pull request May 17, 2021
Closed
JelleZijlstra pushed a commit to python/typing_extensions that referenced this pull request May 19, 2022
@Zac-HD @ilevkivskyi
Track optional TypdeDict keys (#687)
7ce3093 
Backport of python/cpython#17214 (BPO-38834)
JelleZijlstra pushed a commit to python/typing_extensions that referenced this pull request May 19, 2022
@Zac-HD @ilevkivskyi
Track optional TypdeDict keys (#687)
a867181 
Backport of python/cpython#17214 (BPO-38834)
@a-gardner1 a-gardner1 mentioned this pull request Oct 14, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ilevkivskyi ilevkivskyi ilevkivskyi approved these changes

@gvanrossum gvanrossum Awaiting requested review from gvanrossum

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

6 participants

@Zac-HD @ilevkivskyi @gvanrossum @agronholm @the-knights-who-say-ni @bedevere-bot