Quick fix for #1390. Now description cannot contain a newline.

pypa · Dec 6, 2020 · 904f4a1 · 904f4a1
1 parent 5cf3865
commit 904f4a1
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 1 deletion.
diff --git a/changelog.d/1390.change.rst b/changelog.d/1390.change.rst
@@ -0,0 +1 @@
+Newlines in metadata description/Summary now trigger a ValueError.
diff --git a/setuptools/dist.py b/setuptools/dist.py
@@ -118,6 +118,13 @@ def _read_list(name):
         self.obsoletes = None
 
 
+def single_line(val):
+    # quick and dirty validation for description pypa/setuptools#1390
+    if '\n' in val:
+        raise ValueError("newlines not allowed")
+    return val
+
+
 # Based on Python 3.5 version
 def write_pkg_file(self, file):
     """Write the PKG-INFO format data to a file object.
@@ -130,7 +137,7 @@ def write_field(key, value):
     write_field('Metadata-Version', str(version))
     write_field('Name', self.get_name())
     write_field('Version', self.get_version())
-    write_field('Summary', self.get_description())
+    write_field('Summary', single_line(self.get_description()))
     write_field('Home-page', self.get_url())
 
     if version < StrictVersion('1.2'):
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		Newlines in metadata description/Summary now trigger a ValueError.