Test for the creation of an already existing output wheel, and print a helpful warning about building for Python's limited API

Author: YannickJadoul

cibuildwheel/linux.py

@@ -217,6 +217,18 @@ def build(options: BuildOptions) -> None:
                         # clean up test environment
                         docker.call(['rm', '-rf', venv_dir])
 
+                    existing_output_files = docker.call(['ls'], cwd=container_output_dir).split('\n')
+                    for repaired_wheel in repaired_wheels:
+                        if repaired_wheel.name in existing_output_files:
+                            message = f'Created wheel ({repaired_wheel}) already exists in output directory.'
+                            if 'abi3' in repaired_wheel.name:
+                                message += ('\n'
+                                            "It looks like you are created wheels against Python's limited API/stable ABI;\n"
+                                            'please limit your Python selection to a single version when building limited API\n'
+                                            'wheels, with CIBW_BUILD.')
+                            log.error(message)
+                            sys.exit(1)
+
                     # move repaired wheels to output
                     docker.call(['mkdir', '-p', container_output_dir])
                     docker.call(['mv', *repaired_wheels, container_output_dir])

cibuildwheel/macos.py

@@ -293,6 +293,16 @@ def build(options: BuildOptions) -> None:
                 # clean up
                 shutil.rmtree(venv_dir)
 
+            if (options.output_dir / repaired_wheel.name).exists():
+                message = f'Created wheel ({repaired_wheel}) already exists in output directory.'
+                if 'abi3' in repaired_wheel.name:
+                    message += ('\n'
+                                "It looks like you are created wheels against Python's limited API/stable ABI;\n"
+                                'please limit your Python selection to a single version when building limited API\n'
+                                'wheels, with CIBW_BUILD.')
+                log.error(message)
+                sys.exit(1)
+
             # we're all done here; move it to output (overwrite existing)
             shutil.move(str(repaired_wheel), options.output_dir)
             log.build_end()

cibuildwheel/windows.py

@@ -323,6 +323,16 @@ def build(options: BuildOptions) -> None:
                 # clean up
                 shutil.rmtree(venv_dir)
 
+            if (options.output_dir / repaired_wheel.name).exists():
+                message = f'Created wheel ({repaired_wheel}) already exists in output directory.'
+                if 'abi3' in repaired_wheel.name:
+                    message += ('\n'
+                                "It looks like you are created wheels against Python's limited API/stable ABI;\n"
+                                'please limit your Python selection to a single version when building limited API\n'
+                                'wheels, with CIBW_BUILD.')
+                log.error(message)
+                sys.exit(1)
+
             # we're all done here; move it to output (remove if already exists)
             shutil.move(str(repaired_wheel), options.output_dir)
             log.build_end()