BUG: improve resiliency in distutils.build_ext.finalize_options

Author: neutrinoceros

newsfragments/5083.bugfix.rst

@@ -0,0 +1,5 @@
+Fixed a bug where calling ``build_ext.finalize_options`` more than once would
+raise an exception.
+
+Fixed a bug where calling ``build_ext.finalize_options`` after ``define`` or
+``undef`` attributes were already set would raise an exception.

setuptools/_distutils/command/build_ext.py

@@ -266,20 +266,20 @@ def finalize_options(self) -> None:  # noqa: C901
         # specified by the 'define' option will be set to '1'.  Multiple
         # symbols can be separated with commas.
 
-        if self.define:
+        if isinstance(self.define, str):
             defines = self.define.split(',')
             self.define = [(symbol, '1') for symbol in defines]
 
         # The option for macros to undefine is also a string from the
         # option parsing, but has to be a list.  Multiple symbols can also
         # be separated with commas here.
-        if self.undef:
+        if isinstance(self.undef, str):
             self.undef = self.undef.split(',')
 
-        if self.swig_opts is None:
-            self.swig_opts = []
-        else:
+        if isinstance(self.swig_opts, str):
             self.swig_opts = self.swig_opts.split(' ')
+        elif self.swig_opts is None:
+            self.swig_opts = []
 
         # Finally add the user include and library directories if requested
         if self.user:

setuptools/tests/test_build_ext.py

@@ -178,6 +178,33 @@ def C(file):
         assert example_stub.startswith(f"{build_lib}/mypkg/__pycache__/ext1")
         assert example_stub.endswith(".pyc")
 
+    def test_finalize_options_multiple_call(self):
+        """
+        Regression test. Check that calling build_ext.finalize_options
+        more than once doesn't raise an exception.
+        """
+        extension = Extension('spam.eggs', ['eggs.c'])
+        dist = Distribution(dict(ext_modules=[extension]))
+        cmd = build_ext(dist)
+        cmd.finalize_options()
+        cmd.finalize_options()
+
+    def test_finalize_options_subclassing(self):
+        """
+        Regression test. Check that calling build_ext.finalize_options after
+        define or undef attributes were already set to their final type doesn't raise.
+        """
+        extension = Extension('spam.eggs', ['eggs.c'])
+        dist = Distribution(dict(ext_modules=[extension]))
+        cmd = build_ext(dist)
+        cmd.define = [("MY_MACRO", "1")]
+        cmd.undef = ["EVIL_MACRO"]
+
+        cmd.finalize_options()
+
+        assert cmd.define == [("MY_MACRO", "1")]
+        assert cmd.undef == ["EVIL_MACRO"]
+
 
 class TestBuildExtInplace:
     def get_build_ext_cmd(self, optional: bool, **opts) -> build_ext: