Require that package descriptions not include newlines#219
Merged
neersighted merged 2 commits intoNov 10, 2021
Conversation
Previously, we would include the description-with-newlines directly as
the PKG-INFO summary, which could cause subtly broken builds (for
instance, the package may install, but none of the specified
dependencies).
Now, raise a validation error during building, like:
RuntimeError
The Poetry configuration is invalid:
- [description] 'First line\nSecond line (BOOOOOM)' does not match '^[^\n]+$'
Closes python-poetry/poetry#1372
neersighted
approved these changes
Nov 10, 2021
Member
neersighted
left a comment
neersighted
left a comment
There was a problem hiding this comment.
Looks pretty straightforward and solves the bug nicely. I have to admit the error message is not the best, but I'm in favor of merging this and cleaning up the error later if it's non-obvious to people, since the issue is longstanding.
Merged
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
2 participants
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.
Previously, we would include the description-with-newlines directly as the PKG-INFO summary, which could cause subtly broken builds (for instance, the package may install, but none of the specified dependencies).
Now, raise a validation error during building, like:
Resolves: python-poetry/poetry#1372