Import the part of PEP 566 about transforming core metadata to JSON #1466
Conversation
This file contains 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
jeanas
force-pushed
the
json-metadata
branch
from
1fe7485
to
385b8cb
Compare
sinoroc
approved these changes
Jan 24, 2024
EpicWink
approved these changes
Jan 29, 2024
Comment on lines
+877
to
+879
| .. [#json-not-interchange] This is not yet used as a standard interchange | ||
| format; the need for tools to work with years worth of existing packages | ||
| makes it difficult to shift to a new format. |
There was a problem hiding this comment.
Perhaps this should be a warning note rather than a footnote.
| It may be necessary to store metadata in a data structure which does not allow | ||
| for multiple repeated keys, such as JSON. This specification defines a way to | ||
| transform metadata into a JSON-compatible dictionary [#json-not-interchange]_. | ||
|
|
There was a problem hiding this comment.
Simply stating the process seems a little sudden. Perhaps add the introduction from the PEP:
The canonical method to transform metadata fields into such a data structure is as follows:
|
I do not have the time to shepherd PRs at the moment; if anybody feels this is worth saving, please feel free to pick it up. |
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.
https://peps.python.org/pep-0566/#json-compatible-metadata
📚 Documentation preview 📚: https://python-packaging-user-guide--1466.org.readthedocs.build/en/1466/specifications/core-metadata/#transforming-core-metadata-to-json