Merge pull request #2538 from pypa/bugfix/1390-lenient-description

Repair Descriptions with newlines and emit a warning
pypa · Jan 17, 2021 · cda7414 · cda7414
2 parents 6b44f94 + 2f891b4
commit cda7414
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 1 deletion.
diff --git a/changelog.d/1390.misc.rst b/changelog.d/1390.misc.rst
@@ -0,0 +1 @@
+Validation of Description field now is more lenient, emitting a warning and mangling the value to be valid (replacing newlines with spaces).
diff --git a/setuptools/dist.py b/setuptools/dist.py
@@ -121,7 +121,9 @@ def _read_list(name):
 def single_line(val):
     # quick and dirty validation for description pypa/setuptools#1390
     if '\n' in val:
-        raise ValueError("newlines not allowed")
+        # TODO after 2021-07-31: Replace with `raise ValueError("newlines not allowed")`
+        warnings.UserWarning("newlines not allowed and will break in the future")
+        val = val.replace('\n', ' ')
     return val