feat: stricter selector parsing, refactor to platforms module

Author: joerick

cibuildwheel/__main__.py

@@ -11,24 +11,21 @@
 import time
 import traceback
 import typing
-from collections.abc import Generator, Iterable, Sequence, Set
+from collections.abc import Generator, Iterable, Sequence
 from pathlib import Path
 from tempfile import mkdtemp
-from typing import Any, Protocol, TextIO, assert_never
+from typing import Any, TextIO
 
 import cibuildwheel
-import cibuildwheel.linux
-import cibuildwheel.macos
-import cibuildwheel.pyodide
 import cibuildwheel.util
-import cibuildwheel.windows
 from cibuildwheel import errors
 from cibuildwheel.architecture import Architecture, allowed_architectures_check
 from cibuildwheel.ci import CIProvider, detect_ci_provider, fix_ansi_codes_for_github_actions
 from cibuildwheel.logger import log
 from cibuildwheel.options import CommandLineArguments, Options, compute_options
-from cibuildwheel.selector import BuildSelector, EnableGroup
-from cibuildwheel.typing import PLATFORMS, GenericPythonConfiguration, PlatformName
+from cibuildwheel.platforms import ALL_PLATFORM_MODULES, get_build_identifiers, get_platform_module
+from cibuildwheel.selector import BuildSelector, EnableGroup, selector_matches
+from cibuildwheel.typing import PLATFORMS, PlatformName
 from cibuildwheel.util.file import CIBW_CACHE_PATH
 from cibuildwheel.util.helpers import strtobool
 
@@ -284,28 +281,6 @@ def _compute_platform(args: CommandLineArguments) -> PlatformName:
     return _compute_platform_auto()
 
 
-class PlatformModule(Protocol):
-    # note that as per PEP544, the self argument is ignored when the protocol
-    # is applied to a module
-    def get_python_configurations(
-        self, build_selector: BuildSelector, architectures: Set[Architecture]
-    ) -> Sequence[GenericPythonConfiguration]: ...
-
-    def build(self, options: Options, tmp_path: Path) -> None: ...
-
-
-def get_platform_module(platform: PlatformName) -> PlatformModule:
-    if platform == "linux":
-        return cibuildwheel.linux
-    if platform == "windows":
-        return cibuildwheel.windows
-    if platform == "macos":
-        return cibuildwheel.macos
-    if platform == "pyodide":
-        return cibuildwheel.pyodide
-    assert_never(platform)
-
-
 @contextlib.contextmanager
 def print_new_wheels(msg: str, output_dir: Path) -> Generator[None, None, None]:
     """
@@ -445,15 +420,6 @@ def print_preamble(platform: str, options: Options, identifiers: Sequence[str])
     print("Here we go!\n")
 
 
-def get_build_identifiers(
-    platform_module: PlatformModule,
-    build_selector: BuildSelector,
-    architectures: Set[Architecture],
-) -> list[str]:
-    python_configurations = platform_module.get_python_configurations(build_selector, architectures)
-    return [config.identifier for config in python_configurations]
-
-
 def detect_warnings(*, options: Options, identifiers: Iterable[str]) -> list[str]:
     warnings = []
 
@@ -479,6 +445,48 @@ def detect_warnings(*, options: Options, identifiers: Iterable[str]) -> list[str
             )
             raise errors.ConfigurationError(msg)
 
+    build_selector = options.globals.build_selector
+    test_selector = options.globals.test_selector
+
+    warnings += check_for_invalid_selectors("build", build_selector.build_config, error=True)
+    warnings += check_for_invalid_selectors("skip", build_selector.skip_config)
+    warnings += check_for_invalid_selectors("test_skip", test_selector.skip_config)
+
+    return warnings
+
+
+def check_for_invalid_selectors(
+    selector_name: str, selector_value: str, *, error: bool = False
+) -> list[str]:
+    warnings = []
+
+    all_valid_identifiers = [
+        identifier
+        for name, module in ALL_PLATFORM_MODULES.items()
+        for identifier in get_build_identifiers(
+            platform_module=module,
+            architectures=Architecture.all_archs(name),
+            build_selector=BuildSelector(build_config="*", skip_config=""),
+        )
+    ]
+
+    for selector in selector_value.split():
+        if not any(selector_matches(selector, i) for i in all_valid_identifiers):
+            msg = f"Invalid `{selector_name}` selector: {selector!r}. "
+            error_type: type = errors.ConfigurationError
+
+            if "p2" in selector or "p35" in selector:
+                msg = f"cibuildwheel 3.x no longer supports Python < 3.8. Please use the 1.x series or update `{selector_name}`"
+                error_type = errors.DeprecationError
+            if "p36" in selector or "p37" in selector:
+                msg = f"cibuildwheel 3.x no longer supports Python < 3.8. Please use the 2.x series or update `{selector_name}`"
+                error_type = errors.DeprecationError
+
+            if error:
+                raise error_type(msg)
+
+            warnings.append(msg)
+
     return warnings
 
 

cibuildwheel/options.py

@@ -839,14 +839,6 @@ def check_for_invalid_configuration(self, identifiers: Iterable[str]) -> None:
                     )
                 )
 
-    def check_for_deprecated_options(self) -> None:
-        build_selector = self.globals.build_selector
-        test_selector = self.globals.test_selector
-
-        deprecated_selectors("CIBW_BUILD", build_selector.build_config, error=True)
-        deprecated_selectors("CIBW_SKIP", build_selector.skip_config)
-        deprecated_selectors("CIBW_TEST_SKIP", test_selector.skip_config)
-
     @functools.cached_property
     def defaults(self) -> Options:
         return Options(
@@ -959,9 +951,7 @@ def compute_options(
     command_line_arguments: CommandLineArguments,
     env: Mapping[str, str],
 ) -> Options:
-    options = Options(platform=platform, command_line_arguments=command_line_arguments, env=env)
-    options.check_for_deprecated_options()
-    return options
+    return Options(platform=platform, command_line_arguments=command_line_arguments, env=env)
 
 
 @functools.cache
@@ -976,16 +966,3 @@ def _get_pinned_container_images() -> Mapping[str, Mapping[str, str]]:
     all_pinned_images = configparser.ConfigParser()
     all_pinned_images.read(resources.PINNED_DOCKER_IMAGES)
     return all_pinned_images
-
-
-def deprecated_selectors(name: str, selector: str, *, error: bool = False) -> None:
-    if "p2" in selector or "p35" in selector:
-        msg = f"cibuildwheel 3.x no longer supports Python < 3.8. Please use the 1.x series or update {name}"
-        if error:
-            raise errors.DeprecationError(msg)
-        log.warning(msg)
-    if "p36" in selector or "p37" in selector:
-        msg = f"cibuildwheel 3.x no longer supports Python < 3.8. Please use the 2.x series or update {name}"
-        if error:
-            raise errors.DeprecationError(msg)
-        log.warning(msg)

cibuildwheel/platforms/__init__.py

@@ -0,0 +1,50 @@
+from __future__ import annotations
+
+from collections.abc import Sequence
+from pathlib import Path
+from typing import Final, Protocol, assert_never
+
+from cibuildwheel.architecture import Architecture
+from cibuildwheel.options import Options
+from cibuildwheel.platforms import linux, macos, pyodide, windows
+from cibuildwheel.selector import BuildSelector
+from cibuildwheel.typing import GenericPythonConfiguration, PlatformName
+
+
+class PlatformModule(Protocol):
+    # note that as per PEP544, the self argument is ignored when the protocol
+    # is applied to a module
+    def get_python_configurations(
+        self, build_selector: BuildSelector, architectures: set[Architecture]
+    ) -> Sequence[GenericPythonConfiguration]: ...
+
+    def build(self, options: Options, tmp_path: Path) -> None: ...
+
+
+def get_platform_module(platform: PlatformName) -> PlatformModule:
+    if platform == "linux":
+        return linux
+    if platform == "windows":
+        return windows
+    if platform == "macos":
+        return macos
+    if platform == "pyodide":
+        return pyodide
+    assert_never(platform)
+
+
+ALL_PLATFORM_MODULES: Final[dict[PlatformName, PlatformModule]] = {
+    "linux": linux,
+    "windows": windows,
+    "macos": macos,
+    "pyodide": pyodide,
+}
+
+
+def get_build_identifiers(
+    platform_module: PlatformModule,
+    build_selector: BuildSelector,
+    architectures: set[Architecture],
+) -> list[str]:
+    python_configurations = platform_module.get_python_configurations(build_selector, architectures)
+    return [config.identifier for config in python_configurations]

cibuildwheel/linux.py cibuildwheel/platforms/linux.py

@@ -12,18 +12,18 @@
 
 from packaging.version import Version
 
-from . import errors
-from .architecture import Architecture
-from .frontend import BuildFrontendConfig, get_build_frontend_extra_flags
-from .logger import log
-from .oci_container import OCIContainer, OCIContainerEngineConfig, OCIPlatform
-from .options import BuildOptions, Options
-from .selector import BuildSelector
-from .typing import PathOrStr
-from .util import resources
-from .util.file import copy_test_sources
-from .util.helpers import prepare_command, unwrap
-from .util.packaging import find_compatible_wheel
+from .. import errors
+from ..architecture import Architecture
+from ..frontend import BuildFrontendConfig, get_build_frontend_extra_flags
+from ..logger import log
+from ..oci_container import OCIContainer, OCIContainerEngineConfig, OCIPlatform
+from ..options import BuildOptions, Options
+from ..selector import BuildSelector
+from ..typing import PathOrStr
+from ..util import resources
+from ..util.file import copy_test_sources
+from ..util.helpers import prepare_command, unwrap
+from ..util.packaging import find_compatible_wheel
 
 ARCHITECTURE_OCI_PLATFORM_MAP = {
     Architecture.x86_64: OCIPlatform.AMD64,

cibuildwheel/macos.py cibuildwheel/platforms/macos.py

@@ -17,26 +17,26 @@
 from filelock import FileLock
 from packaging.version import Version
 
-from . import errors
-from .architecture import Architecture
-from .ci import detect_ci_provider
-from .environment import ParsedEnvironment
-from .frontend import BuildFrontendConfig, BuildFrontendName, get_build_frontend_extra_flags
-from .logger import log
-from .options import Options
-from .selector import BuildSelector
-from .typing import PathOrStr
-from .util import resources
-from .util.cmd import call, shell
-from .util.file import (
+from .. import errors
+from ..architecture import Architecture
+from ..ci import detect_ci_provider
+from ..environment import ParsedEnvironment
+from ..frontend import BuildFrontendConfig, BuildFrontendName, get_build_frontend_extra_flags
+from ..logger import log
+from ..options import Options
+from ..selector import BuildSelector
+from ..typing import PathOrStr
+from ..util import resources
+from ..util.cmd import call, shell
+from ..util.file import (
     CIBW_CACHE_PATH,
     copy_test_sources,
     download,
     move_file,
 )
-from .util.helpers import prepare_command, unwrap
-from .util.packaging import combine_constraints, find_compatible_wheel, get_pip_version
-from .venv import find_uv, virtualenv
+from ..util.helpers import prepare_command, unwrap
+from ..util.packaging import combine_constraints, find_compatible_wheel, get_pip_version
+from ..venv import find_uv, virtualenv
 
 
 @functools.cache

cibuildwheel/pyodide.py cibuildwheel/platforms/pyodide.py

@@ -13,27 +13,27 @@
 
 from filelock import FileLock
 
-from . import errors
-from .architecture import Architecture
-from .environment import ParsedEnvironment
-from .frontend import BuildFrontendConfig, get_build_frontend_extra_flags
-from .logger import log
-from .options import Options
-from .selector import BuildSelector
-from .typing import PathOrStr
-from .util import resources
-from .util.cmd import call, shell
-from .util.file import (
+from .. import errors
+from ..architecture import Architecture
+from ..environment import ParsedEnvironment
+from ..frontend import BuildFrontendConfig, get_build_frontend_extra_flags
+from ..logger import log
+from ..options import Options
+from ..selector import BuildSelector
+from ..typing import PathOrStr
+from ..util import resources
+from ..util.cmd import call, shell
+from ..util.file import (
     CIBW_CACHE_PATH,
     copy_test_sources,
     download,
     extract_tar,
     extract_zip,
     move_file,
 )
-from .util.helpers import prepare_command
-from .util.packaging import combine_constraints, find_compatible_wheel, get_pip_version
-from .venv import virtualenv
+from ..util.helpers import prepare_command
+from ..util.packaging import combine_constraints, find_compatible_wheel, get_pip_version
+from ..venv import virtualenv
 
 IS_WIN: Final[bool] = sys.platform.startswith("win")
 

cibuildwheel/windows.py cibuildwheel/platforms/windows.py

@@ -14,20 +14,20 @@
 from filelock import FileLock
 from packaging.version import Version
 
-from . import errors
-from .architecture import Architecture
-from .environment import ParsedEnvironment
-from .frontend import BuildFrontendConfig, BuildFrontendName, get_build_frontend_extra_flags
-from .logger import log
-from .options import Options
-from .selector import BuildSelector
-from .typing import PathOrStr
-from .util import resources
-from .util.cmd import call, shell
-from .util.file import CIBW_CACHE_PATH, copy_test_sources, download, extract_zip, move_file
-from .util.helpers import prepare_command, unwrap
-from .util.packaging import combine_constraints, find_compatible_wheel, get_pip_version
-from .venv import find_uv, virtualenv
+from .. import errors
+from ..architecture import Architecture
+from ..environment import ParsedEnvironment
+from ..frontend import BuildFrontendConfig, BuildFrontendName, get_build_frontend_extra_flags
+from ..logger import log
+from ..options import Options
+from ..selector import BuildSelector
+from ..typing import PathOrStr
+from ..util import resources
+from ..util.cmd import call, shell
+from ..util.file import CIBW_CACHE_PATH, copy_test_sources, download, extract_zip, move_file
+from ..util.helpers import prepare_command, unwrap
+from ..util.packaging import combine_constraints, find_compatible_wheel, get_pip_version
+from ..venv import find_uv, virtualenv
 
 
 def get_nuget_args(

unit_test/get_platform_test.py

@@ -7,7 +7,7 @@
 
 from cibuildwheel.ci import CIProvider, detect_ci_provider
 from cibuildwheel.errors import FatalError
-from cibuildwheel.windows import PythonConfiguration, setup_setuptools_cross_compile
+from cibuildwheel.platforms.windows import PythonConfiguration, setup_setuptools_cross_compile
 
 # monkeypatching os.name is too flaky. E.g. It works on my machine, but fails in pipeline
 if not sys.platform.startswith("win"):