PEP 655 Add interaction with __required_keys__, __optional_keys__ and get_type_hints() #1057
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Change TypedDict to respect keys that are marked as Required or NotRequired (requires PEP 560). Make TypedDict and is_typeddict accessible if typing doesn't implement Required.
Replace _strip_annotations() with _strip_extras() to strip Annotated, Required and NotRequired. Change get_type_hints() to pass include_extras=True to newer versions of typing.get_type_hints() and use _strip_extras(). Make get_type_hints accessible if typing doesn't implement Required.
JelleZijlstra
approved these changes
Feb 9, 2022
There was a problem hiding this comment.
Looks good, thank you!
cc @davidfstr in case you also want to take a look
4 tasks
JelleZijlstra
requested changes
Feb 11, 2022
JelleZijlstra
approved these changes
Feb 11, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The current implementation of PEP 655 doesn't implement all specified features of the current draft:
RequiredandNotRequireddon't interact with__required_keys__and__optional_keys__get_type_hints()doesn't strip outRequirednorNotRequired(by default)Implementing the first aspect requires modifying
_TypedDictMeta, which breaks backward compatibility when using typing'sis_typeddict()on typing_extensions'TypedDict:For example this PR breaks the current version of typeguard when using
typing_extension.TypedDicton a recent version of python.This is my first contribution, so please point out if I missed any required steps before opening a PR.