Repository navigation
Preserve recent multiple-use metadata fields in JSON - #545
Merged
Merged
Conversation
Assisted-by: OpenAI Codex
jaraco
reviewed
Oct 31, 2026
Comment on lines
+284
to
+305
| @fixtures.parameterize( | ||
| dict(key='License-File', values=['LICENSE', 'NOTICE']), | ||
| dict(key='Import-Name', values=['example', '_example ; private']), | ||
| dict(key='Import-Namespace', values=['example', 'another']), | ||
| dict(key='Import-Name', values=['']), | ||
| ) | ||
| def test_as_json_recent_multiple_use_fields(self, key, values): | ||
| for count in range(1, len(values) + 1): | ||
| with self.subTest(count=count): | ||
| selected = values[:count] | ||
| headers = '\n'.join( | ||
| f'{key if index == 0 else key.upper()}: {value}' | ||
| for index, value in enumerate(selected) | ||
| ) | ||
| content = ( | ||
| 'Metadata-Version: 2.5\nName: distinfo-pkg\nVersion: 1.0.0\n' | ||
| + headers | ||
| ) | ||
| path = self.site_dir / 'distinfo_pkg-1.0.0.dist-info' / 'METADATA' | ||
| path.write_text(content, encoding='utf-8') | ||
| md = metadata('distinfo-pkg').json | ||
| assert md[key.lower().replace('-', '_')] == selected |
Member
There was a problem hiding this comment.
Are there already tests for multi-use fields? If so, I'd prefer to re-use that test. "recent multiple use fields" will have a stale meaning as soon as this is committed.
Member
There was a problem hiding this comment.
I see now there's no test in particular for the multiple use keys. Still, I don't think a regression test is needed to prove that multiple-use keys is working; it's already covered by the checks for keywords above.
That multiple-use keys become lists is already covered by the 'keywords' and 'requires_dist' assertions in the as_json tests, so the new keys need no test of their own. Its name would also have gone stale as soon as it was committed. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
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
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.
metadata(name).jsoncurrently returns only the firstLicense-File,Import-Name, orImport-Namespacevalue as a string. For example, metadata containing bothLicense-File: LICENSEandLicense-File: NOTICEbecomes{"license_file": "LICENSE"}, losing the second file.Add these three fields to the existing multiple-use field set. Core Metadata defines
License-Fileas multiple-use since 2.4, andImport-NameandImport-Namespacesince 2.5. PEP 566's JSON conversion requires multiple-use fields to be lists, including when only one value appears.The public API regression covers single and repeated values, differently cased duplicate headers, preservation of the
; privatesuffix, and an emptyImport-Name. All seven subcases fail before the fix. A Towncrier bugfix fragment is included.Validation on Windows with Python 3.12:
tox -e py312: 216 passed, 3 skipped, and one pre-existing environment failure in thetests._path.builddoctest because this Windows account cannot create symlinks (WinError 1314). The same doctest fails on clean upstreamc5acd62._adapters.pyhas 100% coverage; overall coverage is 98%.tox -e docs: Sphinx's warning-as-error build and sphinx-lint pass.AI assistance: implemented and tested with OpenAI Codex; independently reviewed by a second Codex agent.