Skip to content

Normaliza metadata the description field when contain line break #794

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 2, 2023
Merged

Normaliza metadata the description field when contain line break #794

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
346350d
Normaliza metadata the description field when contain line break
ischaojie Mar 26, 2023
bd57d7c
Apply suggestions from code review
ofek Apr 2, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions backend/src/hatchling/metadata/core.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -462,8 +462,7 @@ def description(self) -> str:
if not isinstance(description, str):
message = 'Field `project.description` must be a string'
raise TypeError(message)

self._description = description
self._description = ' '.join(description.splitlines())

return self._description

Expand Down
5 changes: 5 additions & 0 deletions tests/backend/metadata/test_core.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -338,6 +338,11 @@ def test_custom(self, isolation):

assert metadata.core.description == metadata.core.description == 'foo'

def test_normaliza(self, isolation):
metadata = ProjectMetadata(str(isolation), None, {'project': {'description': '\nfirst line.\r\nsecond line'}})

assert metadata.core.description == metadata.core.description == ' first line. second line'


class TestReadme:
def test_dynamic(self, isolation):
Expand Down