tests: use zipfile (#785)

A better fit in general, and doesn't require Python 3.8.

Signed-off-by: Henry Schreiner <[email protected]>

Author: henryiii

.github/workflows/ci.yml

@@ -38,7 +38,7 @@ jobs:
 
   checks:
     name:
-      Check 🐍 ${{ matrix.python-version }} • CMake ${{ matrix.cmake-version }}
+      🐍 ${{ matrix.python-version }} • CMake ${{ matrix.cmake-version }}
       on ${{ matrix.runs-on }}
     runs-on: ${{ matrix.runs-on }}
     timeout-minutes: 40

.pre-commit-config.yaml

@@ -19,7 +19,7 @@ repos:
       - id: mixed-line-ending
       - id: name-tests-test
         args: ["--pytest-test-first"]
-        exclude: "^tests/packages/"
+        exclude: "^tests/packages/|^tests/utils"
       - id: requirements-txt-fixer
       - id: trailing-whitespace
         exclude: "^tests"

docs/getting_started.md

@@ -381,9 +381,8 @@ your `pyproject.toml`. You should specify exactly what language you use to keep
 CMake from searching for both `C` and `CXX` compilers (the default).
 
 You'll need to handle the generation of files by NumPy directly at the moment.
-A helper (similar to scikti-build classic) might be added in the future. On
-macOS, you may need to set the Fortran compiler and C compiler to different
-toolchains with `CC=clang FC=gfortran`.
+A helper (similar to scikti-build classic) might be added in the future. You'll
+need gfortran on macOS.
 
 ````
 

pyproject.toml

@@ -125,7 +125,7 @@ build.hooks.vcs.version-file = "src/scikit_build_core/_version.py"
 
 [tool.pytest.ini_options]
 minversion = "7.0"
-addopts = ["-ra", "--strict-markers", "--strict-config"]
+addopts = ["-rfEsX", "--strict-markers", "--strict-config"]
 xfail_strict = true
 filterwarnings = [
     "error",
@@ -137,6 +137,7 @@ filterwarnings = [
     "default:check_home argument is deprecated and ignored.:DeprecationWarning",  # Caused by setuptools sometimes
 ]
 log_cli_level = "info"
+pythonpath = ["tests/utils"]
 testpaths = ["tests"]
 markers = [
     "broken_on_urct: Broken for now due to lib not found",
@@ -154,7 +155,7 @@ norecursedirs = ["tests/packages/**"]
 
 [tool.mypy]
 files = ["src", "tests", "noxfile.py"]
-mypy_path = ["$MYPY_CONFIG_FILE_DIR/src"]
+mypy_path = ["$MYPY_CONFIG_FILE_DIR/src", "$MYPY_CONFIG_FILE_DIR/tests/utils"]
 python_version = "3.8"
 warn_unused_configs = true
 enable_error_code = ["ignore-without-code", "redundant-expr", "truthy-bool"]
@@ -264,6 +265,9 @@ ignore = [
 ]
 typing-modules = ["scikit_build_core._compat.typing"]
 
+[tool.ruff.lint.isort]
+known-local-folder = ["pathutils"]
+
 [tool.ruff.lint.flake8-tidy-imports.banned-api]
 "typing.Callable".msg = "Use collections.abc.Callable instead."
 "typing.Iterator".msg = "Use collections.abc.Iterator instead."

tests/test_dynamic_metadata.py

@@ -20,6 +20,8 @@
 from scikit_build_core.metadata import regex
 from scikit_build_core.settings.skbuild_read_settings import SettingsReader
 
+from pathutils import contained
+
 
 # these are mock plugins returning known results
 # it turns out to be easier to create EntryPoint objects pointing to real
@@ -242,18 +244,15 @@ def test_pep517_wheel(virtualenv):
         )
         assert license == "MIT License"
 
-        with wheel.open("rb") as f:
-            p = zipfile.Path(f)
-            file_names = {x.name for x in p.iterdir()}
-            dynamic_pkg = {x.name for x in p.joinpath("dynamic").iterdir()}
+    with zipfile.ZipFile(wheel) as zf:
+        file_paths = {Path(n) for n in zf.namelist()}
 
-        filtered_pkg = {x for x in dynamic_pkg if not x.startswith("_module")}
+    dynamic_pkg = {x.name for x in contained(file_paths, "dynamic")}
+    filtered_pkg = {x for x in dynamic_pkg if not x.startswith("_module")}
 
-        assert len(filtered_pkg) == len(dynamic_pkg) - 1
-        assert {"dynamic-0.0.2.dist-info", "dynamic"} == file_names
-        assert {
-            "__init__.py",
-        } == filtered_pkg
+    assert len(filtered_pkg) == len(dynamic_pkg) - 1
+    assert {"dynamic-0.0.2.dist-info", "dynamic"} == {p.parts[0] for p in file_paths}
+    assert {"__init__.py"} == filtered_pkg
 
     version = virtualenv.execute("from dynamic import square; print(square(2))")
     assert version == "4.0"

tests/test_fortran.py

@@ -1,5 +1,4 @@
 import shutil
-import sys
 import sysconfig
 import zipfile
 from pathlib import Path
@@ -48,20 +47,17 @@ def test_pep517_wheel(tmp_path, monkeypatch, virtualenv):
     out = build_wheel(str(dist))
     (wheel,) = dist.glob("fibby-0.0.1-*.whl")
     assert wheel == dist / out
-    print(wheel)
 
-    if sys.version_info >= (3, 8):
-        with wheel.open("rb") as f:
-            p = zipfile.Path(f)
-            file_names = [p.name for p in p.iterdir()]
+    with zipfile.ZipFile(wheel) as zf:
+        file_names = {Path(n).parts[0] for n in zf.namelist()}
 
-        assert len(file_names) == 2
-        assert "fibby-0.0.1.dist-info" in file_names
-        file_names.remove("fibby-0.0.1.dist-info")
-        (so_file,) = file_names
+    assert len(file_names) == 2
+    assert "fibby-0.0.1.dist-info" in file_names
+    file_names.remove("fibby-0.0.1.dist-info")
+    (so_file,) = file_names
 
-        assert so_file.startswith("fibby")
-        print("SOFILE:", so_file)
+    assert so_file.startswith("fibby")
+    print("SOFILE:", so_file)
 
     virtualenv.install(wheel)
 

tests/test_pyproject_abi3.py

@@ -40,30 +40,28 @@ def test_abi3_wheel(tmp_path, monkeypatch, virtualenv):
     else:
         assert "-cp37-abi3-" not in out
 
-    if sys.version_info >= (3, 8):
-        with wheel.open("rb") as f:
-            p = zipfile.Path(f)
-            file_names = [p.name for p in p.iterdir()]
+    with zipfile.ZipFile(wheel) as zf:
+        file_names = {Path(n).parts[0] for n in zf.namelist()}
 
-        assert len(file_names) == 2
-        assert "abi3_example-0.0.1.dist-info" in file_names
-        file_names.remove("abi3_example-0.0.1.dist-info")
-        (so_file,) = file_names
+    assert len(file_names) == 2
+    assert "abi3_example-0.0.1.dist-info" in file_names
+    file_names.remove("abi3_example-0.0.1.dist-info")
+    (so_file,) = file_names
 
-        if sysconfig.get_platform().startswith("win"):
-            if sys.implementation.name == "cpython":
-                assert so_file == "abi3_example.pyd"
-            else:
-                assert so_file.endswith(".pyd")
-        elif sys.platform.startswith("cygwin"):
-            if abi3:
-                assert so_file == "abi3_example.abi3.dll"
-            else:
-                assert so_file != "abi3_example.abi3.dll"
-        elif abi3:
-            assert so_file == "abi3_example.abi3.so"
+    if sysconfig.get_platform().startswith("win"):
+        if sys.implementation.name == "cpython":
+            assert so_file == "abi3_example.pyd"
         else:
-            assert so_file != "abi3_example.abi3.so"
+            assert so_file.endswith(".pyd")
+    elif sys.platform.startswith("cygwin"):
+        if abi3:
+            assert so_file == "abi3_example.abi3.dll"
+        else:
+            assert so_file != "abi3_example.abi3.dll"
+    elif abi3:
+        assert so_file == "abi3_example.abi3.so"
+    else:
+        assert so_file != "abi3_example.abi3.so"
 
     virtualenv.install(wheel)
 

tests/test_pyproject_extra_dirs.py

@@ -1,4 +1,3 @@
-import sys
 import zipfile
 from pathlib import Path
 
@@ -7,13 +6,11 @@
 from scikit_build_core.build import build_wheel
 from scikit_build_core.errors import CMakeConfigError
 
+from pathutils import contained
+
 
 @pytest.mark.compile()
 @pytest.mark.configure()
-@pytest.mark.skipif(
-    sys.version_info < (3, 8),
-    reason="Python 3.7 doesn't have a nice Path zipfile interface",
-)
 @pytest.mark.usefixtures("package_filepath_pure")
 def test_pep517_wheel_extra_dirs(monkeypatch):
     monkeypatch.setenv("SKBUILD_CMAKE_DEFINE", "SOME_DEFINE3=baz;SOME_DEFINE4=baz")
@@ -27,33 +24,30 @@ def test_pep517_wheel_extra_dirs(monkeypatch):
     (wheel,) = dist.glob("cmake_dirs-0.0.1-*.whl")
     assert wheel == dist / out
 
-    if sys.version_info >= (3, 8):
-        with wheel.open("rb") as f:
-            p = zipfile.Path(f)
-            file_names = {p.name for p in p.iterdir()}
-            data_dir = {p.name for p in p.joinpath("cmake_dirs-0.0.1.data").iterdir()}
-            package = {p.name for p in p.joinpath("cmake_dirs").iterdir()}
-            data = {p.name for p in p.joinpath("cmake_dirs-0.0.1.data/data").iterdir()}
-            headers = {
-                p.name for p in p.joinpath("cmake_dirs-0.0.1.data/headers").iterdir()
-            }
-            scripts = {
-                p.name for p in p.joinpath("cmake_dirs-0.0.1.data/scripts").iterdir()
-            }
+    with zipfile.ZipFile(wheel) as zf:
+        file_paths = {Path(n) for n in zf.namelist()}
+    data_paths = set(contained(file_paths, "cmake_dirs-0.0.1.data"))
+
+    file_names = {p.parts[0] for p in file_paths}
+    data_dir = {p.parts[0] for p in data_paths}
+    package = {p.name for p in contained(file_paths, "cmake_dirs")}
+    data = {p.name for p in contained(data_paths, "data")}
+    headers = {p.name for p in contained(data_paths, "headers")}
+    scripts = {p.name for p in contained(data_paths, "scripts")}
 
-        assert {
-            "cmake_dirs-0.0.1.dist-info",
-            "cmake_dirs-0.0.1.data",
-            "cmake_dirs",
-            "random_file.py",
-        } == file_names
+    assert {
+        "cmake_dirs-0.0.1.dist-info",
+        "cmake_dirs-0.0.1.data",
+        "cmake_dirs",
+        "random_file.py",
+    } == file_names
 
-        assert data_dir == {"data", "headers", "scripts"}
+    assert data_dir == {"data", "headers", "scripts"}
 
-        assert package == {"main.py"}
-        assert data == {"in_data.txt"}
-        assert headers == {"in_headers.h"}
-        assert scripts == {"in_scripts.py"}
+    assert package == {"main.py"}
+    assert data == {"in_data.txt"}
+    assert headers == {"in_headers.h"}
+    assert scripts == {"in_scripts.py"}
 
 
 @pytest.mark.usefixtures("package_filepath_pure")

tests/test_pyproject_pep517.py

@@ -198,31 +198,33 @@ def test_pep517_wheel(virtualenv):
     (wheel,) = dist.glob("cmake_example-0.0.1-*.whl")
     assert wheel == dist / out
 
-    if sys.version_info >= (3, 8):
-        with wheel.open("rb") as f:
-            p = zipfile.Path(f)
-            file_names = [p.name for p in p.iterdir()]
-            metadata = p.joinpath("cmake_example-0.0.1.dist-info/METADATA").read_text()
-            entry_points = p.joinpath(
-                "cmake_example-0.0.1.dist-info/entry_points.txt"
-            ).read_text()
-            assert p.joinpath("cmake_example-0.0.1.dist-info/licenses/LICENSE").exists()
-
-        assert len(file_names) == 2
-        assert "cmake_example-0.0.1.dist-info" in file_names
-        file_names.remove("cmake_example-0.0.1.dist-info")
-        (so_file,) = file_names
-
-        assert so_file.startswith("cmake_example")
-        print("SOFILE:", so_file)
-
-        print(entry_points == ENTRYPOINTS)
-        assert 'Requires-Dist: pytest>=6.0; extra == "test"' in metadata
-        assert "Metadata-Version: 2.1" in metadata
-        assert "Name: CMake.Example" in metadata
-        assert "Version: 0.0.1" in metadata
-        assert "Requires-Python: >=3.7" in metadata
-        assert "Provides-Extra: test" in metadata
+    with zipfile.ZipFile(wheel) as zf:
+        file_paths = {Path(p) for p in zf.namelist()}
+        file_names = {p.parts[0] for p in file_paths}
+
+        with zf.open("cmake_example-0.0.1.dist-info/METADATA") as f:
+            metadata = f.read().decode("utf-8")
+
+        with zf.open("cmake_example-0.0.1.dist-info/entry_points.txt") as f:
+            entry_points = f.read().decode("utf-8")
+
+    assert Path("cmake_example-0.0.1.dist-info/licenses/LICENSE") in file_paths
+
+    assert len(file_names) == 2
+    assert "cmake_example-0.0.1.dist-info" in file_names
+    file_names.remove("cmake_example-0.0.1.dist-info")
+    (so_file,) = file_names
+
+    assert so_file.startswith("cmake_example")
+    print("SOFILE:", so_file)
+
+    print(entry_points == ENTRYPOINTS)
+    assert 'Requires-Dist: pytest>=6.0; extra == "test"' in metadata
+    assert "Metadata-Version: 2.1" in metadata
+    assert "Name: CMake.Example" in metadata
+    assert "Version: 0.0.1" in metadata
+    assert "Requires-Python: >=3.7" in metadata
+    assert "Provides-Extra: test" in metadata
 
     virtualenv.install(wheel)
 
@@ -246,39 +248,41 @@ def test_pep517_wheel_source_dir(virtualenv):
     (wheel,) = dist.glob("cmake_example-0.0.1-*.whl")
     assert wheel == dist / out
 
-    if sys.version_info >= (3, 8):
-        with wheel.open("rb") as f:
-            p = zipfile.Path(f)
-            file_names = [p.name for p in p.iterdir()]
-            metadata = p.joinpath("cmake_example-0.0.1.dist-info/METADATA").read_text()
-            wheel_metadata = p.joinpath(
-                "cmake_example-0.0.1.dist-info/WHEEL"
-            ).read_text()
-            entry_points = p.joinpath(
-                "cmake_example-0.0.1.dist-info/entry_points.txt"
-            ).read_text()
-            assert p.joinpath("cmake_example-0.0.1.dist-info/licenses/LICENSE").exists()
-
-        assert len(file_names) == 2
-        assert "cmake_example-0.0.1.dist-info" in file_names
-        file_names.remove("cmake_example-0.0.1.dist-info")
-        (so_file,) = file_names
-
-        assert so_file.startswith("cmake_example")
-        print("SOFILE:", so_file)
-
-        print(entry_points == ENTRYPOINTS)
-        assert 'Requires-Dist: pytest>=6.0; extra == "test"' in metadata
-        assert "Metadata-Version: 2.1" in metadata
-        assert "Name: CMake.Example" in metadata
-        assert "Version: 0.0.1" in metadata
-        assert "Requires-Python: >=3.7" in metadata
-        assert "Provides-Extra: test" in metadata
-
-        assert "Build: 1foo" in wheel_metadata
-        assert "Wheel-Version: 1.0" in wheel_metadata
-        assert "Generator: scikit-build" in wheel_metadata
-        assert "Root-Is-Purelib: false" in wheel_metadata
+    with zipfile.ZipFile(wheel) as zf:
+        file_paths = {Path(p) for p in zf.namelist()}
+        file_names = {p.parts[0] for p in file_paths}
+
+        with zf.open("cmake_example-0.0.1.dist-info/METADATA") as f:
+            metadata = f.read().decode("utf-8")
+
+        with zf.open("cmake_example-0.0.1.dist-info/WHEEL") as f:
+            wheel_metadata = f.read().decode("utf-8")
+
+        with zf.open("cmake_example-0.0.1.dist-info/entry_points.txt") as f:
+            entry_points = f.read().decode("utf-8")
+
+    assert Path("cmake_example-0.0.1.dist-info/licenses/LICENSE") in file_paths
+
+    assert len(file_names) == 2
+    assert "cmake_example-0.0.1.dist-info" in file_names
+    file_names.remove("cmake_example-0.0.1.dist-info")
+    (so_file,) = file_names
+
+    assert so_file.startswith("cmake_example")
+    print("SOFILE:", so_file)
+
+    print(entry_points == ENTRYPOINTS)
+    assert 'Requires-Dist: pytest>=6.0; extra == "test"' in metadata
+    assert "Metadata-Version: 2.1" in metadata
+    assert "Name: CMake.Example" in metadata
+    assert "Version: 0.0.1" in metadata
+    assert "Requires-Python: >=3.7" in metadata
+    assert "Provides-Extra: test" in metadata
+
+    assert "Build: 1foo" in wheel_metadata
+    assert "Wheel-Version: 1.0" in wheel_metadata
+    assert "Generator: scikit-build" in wheel_metadata
+    assert "Root-Is-Purelib: false" in wheel_metadata
 
     virtualenv.install(wheel)