From 2a0e288b751f127514240d23a01a367d76907778 Mon Sep 17 00:00:00 2001 From: Donald Stufft Date: Sat, 25 Jun 2022 13:54:20 -0400 Subject: [PATCH 1/3] Fix the data model to match reality --- pep-0691.rst | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/pep-0691.rst b/pep-0691.rst index 8bbdcf2da13..a32a7fc6a6f 100644 --- a/pep-0691.rst +++ b/pep-0691.rst @@ -982,6 +982,11 @@ this PEP. class PEP529File(File): yanked: bool | str + @dataclass + class PEP658File(PEP529File): + # Limited to a len() of 1 in HTML + dist_info_metadata: bool | dict[str, str] + # Simple Index page (/simple/) @dataclass @@ -1017,8 +1022,7 @@ this PEP. @dataclass class PEP658_Detail(PEP629_Detail): - # Limited to a len() of 1 in HTML - dist_info_metadata: bool | dict[str, str] + files: set[PEP658File] @dataclass From fae88a9c83f6dfe4da84ff70293103aed1204f73 Mon Sep 17 00:00:00 2001 From: Donald Stufft Date: Sat, 25 Jun 2022 13:56:44 -0400 Subject: [PATCH 2/3] grammar --- pep-0691.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/pep-0691.rst b/pep-0691.rst index a32a7fc6a6f..704b0ade3a8 100644 --- a/pep-0691.rst +++ b/pep-0691.rst @@ -519,7 +519,7 @@ human based exploration of the API within a browser, or to allow documentation o notes to link to a specific version+format. Servers that do not support this parameter may choose to return an error when it is -present, or they may simple ignore it's presence. +present, or they may simple ignore its presence. When a server does implement this parameter, it **SHOULD** take precedence over any values in the client's ``Accept`` header, and if the server does not support the @@ -830,7 +830,7 @@ that static repositories will no longer be able to be hosted on GitHub Pages unless GitHub adds the ``application/vnd.pypi.simple.v1+json`` content type. This PEP believes that the benefits are not large enough to add that content -type alias at this time, and that it's inclusion would likely be a footgun +type alias at this time, and that its inclusion would likely be a footgun waiting for unsuspecting people to accidentally pick it up. Especially given that we can always add it in the future, but removing things is a lot harder to do. @@ -941,13 +941,13 @@ Appendix 2: Rough Underlying Data Models ======================================== These are not intended to perfectly match the server, client, or wire -formats. Rather, these are concpetual models, put to code to make them +formats. Rather, these are conceptual models, put to code to make them more explicit as to the abstract models underlining the repository API as it evolved through :pep:`503`, :pep:`529`, :pep:`629`, :pep:`658`, and now this PEP, :pep:`691`. The existing HTML, and the new JSON serialization of these models then -represent how these underlying concpetual models get mapped onto the +represent how these underlying conceptual models get mapped onto the actual wire formats. How servers or clients choose to model this data is out of scope for From b08e1840baac451b9f2a01d8745455d82b71a30f Mon Sep 17 00:00:00 2001 From: Donald Stufft Date: Sat, 25 Jun 2022 13:56:52 -0400 Subject: [PATCH 3/3] Mark Accepted --- pep-0691.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/pep-0691.rst b/pep-0691.rst index 704b0ade3a8..a962c4007c9 100644 --- a/pep-0691.rst +++ b/pep-0691.rst @@ -6,12 +6,13 @@ Author: Donald Stufft , Dustin Ingram PEP-Delegate: Brett Cannon Discussions-To: https://discuss.python.org/t/pep-691-json-based-simple-api-for-python-package-indexes/15553 -Status: Draft +Status: Accepted Type: Standards Track Topic: Packaging Content-Type: text/x-rst Created: 04-May-2022 Post-History: `05-May-2022 `__ +Resolution: https://discuss.python.org/t/pep-691-json-based-simple-api-for-python-package-indexes/15553/70 Abstract