PEP 705: TypedMapping by alicederyn · Pull Request #2997 · python/peps · GitHub

Proposal to add a TypedMapping protocol to the language.

All commit authors signed the Contributor License Agreement.

I confirm I am sponsoring this PEP 👍

Please use PEP number 705.

(Re-allocating from #2988 which was closed because it didn't yet find a sponsor.)

Standard reminder: You can directly apply all the suggestions you want in one go with Files changed -> Add to batch -> Commit

Basic requirements (all PEP Types)

Read and followed PEP 1 & PEP 12
File created from the latest PEP template
PEP has next available number, & set in filename (pep-NNNN.rst), PR title (PEP 123: <Title of PEP>) and PEP header [resolved in suggestion]
Title clearly, accurately and concisely describes the content in 79 characters or less
Author, Status (Draft), Type and Created headers filled out correctly
PEP-Delegate, Topic, Requires and Replaces headers completed if appropriate [resolved in suggestion]
Core dev/PEP editor listed as author or sponsor, and formally confirmed their approval
Required sections included
- Abstract (first section)
- Copyright (last section; exact wording from template required)
Code is well-formatted (PEP 7/PEP 8) and is in code blocks, with the right lexer names if non-Python [resolved in suggestion]
PEP builds with no warnings, pre-commit checks pass and content displays as intended in the rendered HTML
Authors/sponsor added to .github/CODEOWNERS for the PEP

Standards Track requirements

PEP topic discussed in a suitable venue with general agreement that a PEP is appropriate
Suggested sections included (unless not applicable)
- Motivation
- Rationale
- Specification
- Backwards Compatibility
- Security Implications
- How to Teach This
- Reference Implementation
- Rejected Ideas
Python-Version set to valid (pre-beta) future Python version
Any project stated in the PEP as supporting/endorsing/benefiting from it confirms such N/A
Right before or after initial merging, PEP discussion thread created and linked to in Discussions-To and Post-History

This looks quite good and makes a convincing case for the feature, but I have a few comments.

Note: copyright not yet added

Just to note I'm still addressing the feedback, just tackled the easier stuff first!

Standard reminder: You can directly apply all the suggestions you want in one go with Files changed -> Add to batch -> Commit

Looking good so far! Just a couple quick suggestion followups to the existing fixes, aside from the bigger pending items. Thanks!

Just to note I'm still addressing the feedback, just tackled the easier stuff first!

Thanks @alicederyn ! I've resolved the implemented suggestions and checked the corresponding boxes in the checklist above.

Just FYI, to help make the easy stuff even easier, in case you aren't aware—instead of recreating the suggestions manually, you can apply them all directly in one go by going to the Files changed tab, clicking Add to batch on the suggestions you want, and then clicking Commit once you've selected all of them. This also auto-resolves the linked review comments, so they don't need to be double-checked and resolved manually.

Just FYI, to help make the easy stuff even easier, in case you aren't aware—instead of recreating the suggestions manually, you can apply them all directly in one go

Thanks! I was aware of this, but I wanted to check everything rendered correctly locally and iterate, so I did it in the form of a PR to my PR branch. Sorry for creating extra work!

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>

For reference, I have a bit of a rewrite at alicederyn#4 to address @JelleZijlstra's comments. I'm getting some internal feedback on it before I merge here, but happy for anyone to comment there first.

Define what TypedMapping does support, not just what it doesn't, to clarify edge cases like ``|``.

All blocking changes resolved, thanks!

LGTM from me, aside from still missing a number of recommended sections (see the checklist above) that would likely be quite helpful to include, even if just briefly for each. But that's ultimately up to you, @JelleZijlstra and @pablogsal .

Backcompat and reference implementation sections at alicederyn#5 for internal review

Thanks! Just "Security Implications" (which can be a very brief explanation of why there are none, or mentioning how this might improve user security) and "How to Teach This" suggested sections left, assuming there isn't a reason to omit them. Plus, a couple small suggestions/comments.

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com> Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>

@CAM-Gerlach I added a "How to teach" section. Pablo suggested leaving out the "security implications" section as it would be empty.

A couple last comments/suggestions from my side; otherwise this LGTM!

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>

Thanks for all your hard work on this, @alicederyn ! @JelleZijlstra might have some last comments, but as far as I'm concerned, LGTM!

I have a few more comments but those could also be addressed later. If you would prefer to have the PEP merged now, let me know and I'll do it.

* Remove `typing_extensions` implementation details; this is more than is necessary for the PEP. * Do not mandate adding the PEP to the `typing` module docs, in case that practice ends before the PEP lands. Left in as a suggestion to mirror PEP 692.

"Request rereview" has apparently changed behaviour and I have no idea how it now works :/ Apologies if I spammed anyone.

"Request rereview" has apparently changed behaviour and I have no idea how it now works :/ Apologies if I spammed anyone.

Would be curious what specifically you're referring to—I've used this feature routinely over the past several years and haven't noticed any significant UI/UX changes, including just now on this PEP. Though, perhaps it had something to do with the fact that we both triggered it right around the same time, with me having loaded the page prior to you pressing the button?

I hit the request review icon for hugovk and Jelle as usual, but the end state was as if I hadn't, and this is the description of what I apparently did. Maybe it work differently if you have different privileges, and I've just never seen it before because I normally do this on repos where I have edit privileges?

I've definitely seen this behaviour change a week ago in a private GH server, and those usually lag public GH changes by about a half year.

Hmm, strange. I've put in a request about it to the others and GitHub.

Congratulations @alicederyn , your PEP is now live at https://peps.python.org/pep-0705/ ! Now's the time to open a PEP discussion thread on Typing-SIG and/or the PEP category of the Python Discourse, and link it in the Discusions-To and the Post-History here. Thanks!

Thank you @CAM-Gerlach and @JelleZijlstra for your time and feedback!

alicederyn and others added 4 commits November 7, 2022 17:02

Initial draft

56cedcd

Initial round of revisions

6a7a3bd

Explore interaction with Protocols (#2 )

d5ad9f4

Set sponsor as codeowner

5bb4205

alicederyn requested a review from a team as a code owner February 1, 2023 15:26

hugovk mentioned this pull request Feb 1, 2023

PEP NNN: Recording provenance of installed packages #2988

Closed

Use PEP number 705

b6be6b6

alicederyn changed the title PEP xxxx: TypedMapping PEP 705: TypedMapping Feb 1, 2023

CAM-Gerlach added the new-pep A new draft PEP submitted for initial review label Feb 2, 2023

CAM-Gerlach requested a review from JelleZijlstra February 2, 2023 06:08

CAM-Gerlach previously requested changes Feb 2, 2023

View reviewed changes

JelleZijlstra reviewed Feb 5, 2023

View reviewed changes

Comment thread pep-0705.rst Outdated

Comment thread pep-0705.rst

Comment thread pep-0705.rst Outdated

Comment thread pep-0705.rst Outdated

Comment thread pep-0705.rst Outdated

JelleZijlstra and others added 3 commits February 5, 2023 05:53

Merge branch 'main' into pep.typedmapping

8a02892

Revisions suggested by CAM-Gerlach (#3 )

9933e22

Note: copyright not yet added

Merge branch 'main' into pep.typedmapping

a218afa

CAM-Gerlach reviewed Feb 9, 2023

View reviewed changes

Comment thread pep-0705.rst

Comment thread pep-0705.rst Outdated

Add copyright

2aeb8b4

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>

Revisions suggested by JelleZijlstra (#4 )

f425e49

Define what TypedMapping does support, not just what it doesn't, to clarify edge cases like ``|``.

alicederyn commented Feb 13, 2023

View reviewed changes

Comment thread pep-0705.rst Outdated

Remove pending discussions-to

8493ecc

CAM-Gerlach reviewed Feb 14, 2023

View reviewed changes

CAM-Gerlach reviewed Feb 17, 2023

View reviewed changes

Comment thread pep-0705.rst Outdated

Comment thread pep-0705.rst Outdated

hugovk reviewed Feb 20, 2023

View reviewed changes

Comment thread pep-0705.rst Outdated

alicederyn and others added 2 commits February 21, 2023 10:06

Apply suggestions from code review

18c254a

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com> Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>

Mention why the TypedDict metaclass is check is a problem

7451f57

CAM-Gerlach reviewed Mar 9, 2023

View reviewed changes

Comment thread pep-0705.rst Outdated

alicederyn and others added 2 commits March 10, 2023 15:34

Copy-edit: this->that

caf8b8c

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>

Add How To Teach section (#6 )

ad21445

CAM-Gerlach reviewed Mar 11, 2023

View reviewed changes

Comment thread pep-0705.rst Outdated

Comment thread pep-0705.rst Outdated

Comment thread pep-0705.rst Outdated

Apply suggestions from code review

5259b12

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>

CAM-Gerlach approved these changes Mar 11, 2023

View reviewed changes

CAM-Gerlach requested review from JelleZijlstra and hugovk March 11, 2023 09:49

JelleZijlstra reviewed Mar 11, 2023

View reviewed changes

Comment thread pep-0705.rst Outdated

Comment thread pep-0705.rst

Comment thread pep-0705.rst Outdated

alicederyn added 2 commits March 13, 2023 08:51

Address Jelle's feedback (#7 )

68c928e

* Remove `typing_extensions` implementation details; this is more than is necessary for the PEP. * Do not mandate adding the PEP to the `typing` module docs, in case that practice ends before the PEP lands. Left in as a suggestion to mirror PEP 692.

Can -> could

88d6ed8

alicederyn requested review from JelleZijlstra and hugovk and removed request for JelleZijlstra and hugovk March 13, 2023 08:54

CAM-Gerlach requested a review from JelleZijlstra March 13, 2023 08:56

JelleZijlstra merged commit f749a27 into python:main Mar 14, 2023

alicederyn deleted the pep.typedmapping branch March 14, 2023 13:21

PEP 705: TypedMapping by alicederyn · Pull Request #2997 · python/peps · GitHub

Repository navigation

PEP 705: TypedMapping - #2997

PEP 705: TypedMapping#2997JelleZijlstra merged 20 commits intopython:mainpython/peps:mainfrom alicederyn:pep.typedmappingalicederyn/peps:pep.typedmappingCopy head branch name to clipboard

Conversation

alicederyn commented Feb 1, 2023

Uh oh!

ghost commented Feb 1, 2023 • edited by ghost Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

pablogsal commented Feb 1, 2023

Uh oh!

hugovk commented Feb 1, 2023

Uh oh!

CAM-Gerlach left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Basic requirements (all PEP Types)

Standards Track requirements

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

JelleZijlstra left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

alicederyn commented Feb 8, 2023

Uh oh!

CAM-Gerlach left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

CAM-Gerlach commented Feb 9, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

alicederyn commented Feb 9, 2023

Uh oh!

alicederyn commented Feb 9, 2023

Uh oh!

Uh oh!

CAM-Gerlach left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

alicederyn commented Feb 16, 2023

Uh oh!

CAM-Gerlach left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

alicederyn commented Mar 10, 2023

Uh oh!

CAM-Gerlach left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

CAM-Gerlach left a comment

Choose a reason for hiding this comment

Uh oh!

JelleZijlstra left a comment

Choose a reason for hiding this comment

Uh oh!

PEP 705: TypedMapping#2997
JelleZijlstra merged 20 commits into
python:mainfrom
alicederyn:pep.typedmapping

ghost commented Feb 1, 2023 •
edited by ghost
Loading

CAM-Gerlach left a comment •
edited
Loading

CAM-Gerlach commented Feb 9, 2023 •
edited
Loading

CAM-Gerlach left a comment •
edited
Loading