Describe the file format of core metadata #851
Merged
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.
Following this discussion on discourse. The file format of core metadata is not precisely defined (PEP 241 said RFC 822, but that's outdated in practice), but there is a practical standard: the major tools consuming metadata use the
email.parser
module with the (default)compat32
policy. I think it's better to describe the situation than to leave it completely unspecified.Hopefully this is an interim measure until someone gets around to describing the format properly. But that's a much bigger job, and so far no-one is volunteering.