pypa · frenzymadness · Mar 18, 2025
diff --git a/newsfragments/4887.bugfix.rst b/newsfragments/4887.bugfix.rst
@@ -0,0 +1 @@
+Fixed handling of keywords following the old specification with spaces instead of commas and containing newlines.
diff --git a/setuptools/_distutils/dist.py b/setuptools/_distutils/dist.py
@@ -644,6 +644,7 @@ def finalize_options(self) -> None:
             if value is None:
                 continue
             if isinstance(value, str):
+                value = value.replace("\n", " ")
                 value = [elm.strip() for elm in value.split(',')]
                 setattr(self.metadata, attr, value)
 

diff --git a/setuptools/tests/test_core_metadata.py b/setuptools/tests/test_core_metadata.py
@@ -164,6 +164,30 @@ def __read_test_cases():
                 version=sic('1.0.0a'),
             ),
         ),
+        (
+            'Keywords with commas',
+            params(
+                keywords='one, two, three',
+            ),
+        ),
+        (
+            'Keywords with spaces',
+            params(
+                keywords='one two three',
+            ),
+        ),
+        (
+            'Keywords with commas multiline',
+            params(
+                keywords='one, two,\nthree, four\n',
+            ),
+        ),
+        (
+            'Keywords with spaces multiline',
+            params(
+                keywords='one two\nthree four\n',
+            ),
+        ),
     ]
 
 

diff --git a/setuptools/modified.py b/setuptools/modified.py
 try:
    # Ensure a DistutilsError raised by these methods is the same as distutils.errors.DistutilsError
    from distutils._modified import (
        newer,
        newer_group,
        newer_pairwise,
diff --git a/setuptools/monkey.py b/setuptools/monkey.py
 import types
 from typing import TypeVar, cast, overload

 import distutils.filelist

 _T = TypeVar("_T")
 _UnpatchT = TypeVar("_UnpatchT", type, types.FunctionType)
    _patch_distribution_metadata()

    # Install Distribution throughout the distutils
    for module in distutils.dist, distutils.core, distutils.cmd:
        module.Distribution = setuptools.dist.Distribution

    # Install the patched Extension
    if 'distutils.command.build_ext' in sys.modules:
        sys.modules[
            'distutils.command.build_ext'
        ].Extension = setuptools.extension.Extension


 def _patch_distribution_metadata():
        'get_fullname',
    ):
        new_val = getattr(_core_metadata, attr)
        setattr(distutils.dist.DistributionMetadata, attr, new_val)


 def patch_func(replacement, target_mod, func_name):
diff --git a/setup.py b/setup.py
        """
        Undo secondary effect of `extra_path` adding to `install_lib`
        """
        suffix = os.path.relpath(self.install_lib, self.install_libbase)

        if suffix.strip() == self._pth_contents.strip():
            self.install_lib = self.install_libbase
diff --git a/_distutils_hack/__init__.py b/_distutils_hack/__init__.py

    # check that submodules load as expected
    core = importlib.import_module('distutils.core')
    assert '_distutils' in core.__file__, core.__file__
    assert 'setuptools._distutils.log' not in sys.modules




 def add_shim():
    DISTUTILS_FINDER in sys.meta_path or insert_shim()


 class shim:
diff --git a/setuptools/tests/test_install_scripts.py b/setuptools/tests/test_install_scripts.py
        cmd.install_dir = install_dir
        if executable is not None:
            bs = cmd.get_finalized_command('build_scripts')
            bs.executable = executable
        cmd.ensure_finalized()
        with contexts.quiet():
            cmd.run()
diff --git a/setuptools/tests/test_logging.py b/setuptools/tests/test_logging.py

    setup_script = tmp_path / "setup.py"
    setup_script.write_text(setup_py, encoding="utf-8")
    dist = distutils.core.run_setup(setup_script, stop_after="init")
    dist.script_args = [flag, "sdist"]
    dist.parse_command_line()  # <- where the log level is set
    log_level = logger.getEffectiveLevel()

    import setuptools.logging

    from distutils import dist

    setuptools.logging.configure()
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		Fixed handling of keywords following the old specification with spaces instead of commas and containing newlines.
	try:
	# Ensure a DistutilsError raised by these methods is the same as distutils.errors.DistutilsError
	from distutils._modified import (
Check warning on line 3 in setuptools/modified.py GitHub Actions / pyright (3.9, ubuntu-latest) `Import "distutils._modified" could not be resolved (reportMissingImports)` Check warning on line 3 in setuptools/modified.py GitHub Actions / pyright (3.13, ubuntu-latest) `Import "distutils._modified" could not be resolved from source (reportMissingModuleSource)`
	newer,
	newer_group,
	newer_pairwise,
	import types
	from typing import TypeVar, cast, overload

	import distutils.filelist
Check warning on line 13 in setuptools/monkey.py GitHub Actions / pyright (3.13, ubuntu-latest) `Import "distutils.filelist" could not be resolved from source (reportMissingModuleSource)`

	_T = TypeVar("_T")
	_UnpatchT = TypeVar("_UnpatchT", type, types.FunctionType)
	_patch_distribution_metadata()

	# Install Distribution throughout the distutils
	for module in distutils.dist, distutils.core, distutils.cmd:
Check warning on line 81 in setuptools/monkey.py GitHub Actions / pyright (3.9, ubuntu-latest) `"dist" is not a known attribute of module "distutils" (reportAttributeAccessIssue)` Check warning on line 81 in setuptools/monkey.py GitHub Actions / pyright (3.9, ubuntu-latest) `"core" is not a known attribute of module "distutils" (reportAttributeAccessIssue)` Check warning on line 81 in setuptools/monkey.py GitHub Actions / pyright (3.9, ubuntu-latest) `"cmd" is not a known attribute of module "distutils" (reportAttributeAccessIssue)` Check warning on line 81 in setuptools/monkey.py GitHub Actions / pyright (3.13, ubuntu-latest) `"dist" is not a known attribute of module "distutils" (reportAttributeAccessIssue)` Check warning on line 81 in setuptools/monkey.py GitHub Actions / pyright (3.13, ubuntu-latest) `"core" is not a known attribute of module "distutils" (reportAttributeAccessIssue)` Check warning on line 81 in setuptools/monkey.py GitHub Actions / pyright (3.13, ubuntu-latest) `"cmd" is not a known attribute of module "distutils" (reportAttributeAccessIssue)`
	module.Distribution = setuptools.dist.Distribution

	# Install the patched Extension
	if 'distutils.command.build_ext' in sys.modules:
	sys.modules[
	'distutils.command.build_ext'
	].Extension = setuptools.extension.Extension
Check warning on line 90 in setuptools/monkey.py GitHub Actions / pyright (3.9, ubuntu-latest) `Cannot assign to attribute "Extension" for class "ModuleType" Attribute "Extension" is unknown (reportAttributeAccessIssue)` Check warning on line 90 in setuptools/monkey.py GitHub Actions / pyright (3.13, ubuntu-latest) `Cannot assign to attribute "Extension" for class "ModuleType" Attribute "Extension" is unknown (reportAttributeAccessIssue)`


	def _patch_distribution_metadata():
	'get_fullname',
	):
	new_val = getattr(_core_metadata, attr)
	setattr(distutils.dist.DistributionMetadata, attr, new_val)
Check warning on line 105 in setuptools/monkey.py GitHub Actions / pyright (3.9, ubuntu-latest) `"dist" is not a known attribute of module "distutils" (reportAttributeAccessIssue)` Check warning on line 105 in setuptools/monkey.py GitHub Actions / pyright (3.13, ubuntu-latest) `"dist" is not a known attribute of module "distutils" (reportAttributeAccessIssue)`


	def patch_func(replacement, target_mod, func_name):
	"""
	Undo secondary effect of `extra_path` adding to `install_lib`
	"""
	suffix = os.path.relpath(self.install_lib, self.install_libbase)
Check warning on line 79 in setup.py GitHub Actions / pyright (3.9, ubuntu-latest) `No overloads for "relpath" match the provided arguments (reportCallIssue)` Check warning on line 79 in setup.py GitHub Actions / pyright (3.9, ubuntu-latest) `Argument of type "str \| None" cannot be assigned to parameter "path" of type "StrPath" in function "relpath" Type "str \| None" is not assignable to type "StrPath" Type "None" is not assignable to type "StrPath" "None" is not assignable to "str" "None" is incompatible with protocol "PathLike[str]" "__fspath__" is not present (reportArgumentType)`

	if suffix.strip() == self._pth_contents.strip():
	self.install_lib = self.install_libbase

	# check that submodules load as expected
	core = importlib.import_module('distutils.core')
	assert '_distutils' in core.__file__, core.__file__
Check warning on line 76 in _distutils_hack/__init__.py GitHub Actions / pyright (3.9, ubuntu-latest) `Operator "in" not supported for types "Literal['_distutils']" and "str \| None" Operator "in" not supported for types "Literal['_distutils']" and "None" (reportOperatorIssue)`
	assert 'setuptools._distutils.log' not in sys.modules




	def add_shim():
	DISTUTILS_FINDER in sys.meta_path or insert_shim()
Check warning on line 215 in _distutils_hack/__init__.py GitHub Actions / pyright (3.9, ubuntu-latest) `Expression value is unused (reportUnusedExpression)`


	class shim:
	cmd.install_dir = install_dir
	if executable is not None:
	bs = cmd.get_finalized_command('build_scripts')
	bs.executable = executable
Check warning on line 30 in setuptools/tests/test_install_scripts.py GitHub Actions / pyright (3.13, ubuntu-latest) `Cannot assign to attribute "executable" for class "Command" Attribute "executable" is unknown (reportAttributeAccessIssue)`
	cmd.ensure_finalized()
	with contexts.quiet():
	cmd.run()

	setup_script = tmp_path / "setup.py"
	setup_script.write_text(setup_py, encoding="utf-8")
	dist = distutils.core.run_setup(setup_script, stop_after="init")
Check warning on line 37 in setuptools/tests/test_logging.py GitHub Actions / pyright (3.13, ubuntu-latest) `"core" is not a known attribute of module "distutils" (reportAttributeAccessIssue)`
	dist.script_args = [flag, "sdist"]
	dist.parse_command_line() # <- where the log level is set
	log_level = logger.getEffectiveLevel()

	import setuptools.logging

	from distutils import dist
Check warning on line 67 in setuptools/tests/test_logging.py GitHub Actions / pyright (3.13, ubuntu-latest) `Import "distutils.dist" could not be resolved from source (reportMissingModuleSource)`

	setuptools.logging.configure()