Use PEP 639 license metadata

Author: oscarbenjamin

.github/workflows/buildwheel.yml

@@ -167,7 +167,7 @@ jobs:
       # We don't need to specify ninja as a requirement in pyproject.toml
       # because without --no-build-isolation meson-python handles it
       # automatically in get_requirements_for_build_wheel().
-      - run: 'pip install "cython==3.0.11" "meson-python==0.13" "ninja<1.11"'
+      - run: 'pip install "cython==3.0.11" "meson-python==0.18" "ninja<1.11"'
       - run: pip install --no-build-isolation .
       - run: python -m flint.test --verbose
 

bin/cibw_repair_wheel_licenses.py

@@ -0,0 +1,106 @@
+#!/usr/bin/env python
+
+import argparse
+from pathlib import Path
+from subprocess import run
+from tempfile import TemporaryDirectory
+from shutil import copyfile
+from os import makedirs
+
+
+def main(*args: str):
+    """
+    Update license information in wheels after running auditwheel etc.
+
+    Usage:
+       cibw_repair_wheel_licenses.py <dest_dir> <wheel_file> \
+           --license MIT --license-file licenses/license_foo_MIT.txt \
+           --license BSD-3-Clause --license-file licenses/license_bar_BSD-3-Clause.txt \
+           ...
+
+    CWD should be at project root (containing pyproject.toml) and license-file
+    paths must be relative.
+    """
+    parser = argparse.ArgumentParser()
+    parser.add_argument("dest_dir")
+    parser.add_argument("wheel_file")
+    parser.add_argument("--license", action="append", default=[])
+    parser.add_argument("--license-file", action="append", default=[])
+
+    parsed = parser.parse_args(args)
+    dest_dir = Path(parsed.dest_dir)
+    wheel_file = Path(parsed.wheel_file)
+    license_files = [Path(f) for f in parsed.license_file]
+
+    if any(f.is_absolute() for f in license_files):
+        #
+        # PEP 639 says:
+        #
+        # Inside the root license directory, packaging tools MUST reproduce the
+        # directory structure under which the source license files are located
+        # relative to the project root.
+        #
+        raise ValueError("license-file paths must be relative to project root")
+
+    update_licenses_wheel(dest_dir, wheel_file, parsed.license, license_files)
+
+
+def update_licenses_wheel(
+    dest_dir: Path, wheel_file: Path, licenses: list[str], license_files: list[Path]
+):
+    # foo/bar-1.0-cp310-cp310-linux_x86_64.whl -> bar-1.0
+    name, version = wheel_file.stem.split('-')[:2]
+    base = f"{name}-{version}"
+
+    with TemporaryDirectory() as tmpdir:
+        run(["wheel", "unpack", "--dest", tmpdir, wheel_file], check=True)
+        dist_info = Path(tmpdir) / base / f"{base}.dist-info"
+        print(f"Adding licenses in {dist_info}")
+        update_license_dist_info(dist_info, licenses, license_files)
+        run(["wheel", "pack", "--dest-dir", dest_dir, Path(tmpdir) / base], check=True)
+
+
+def update_license_dist_info(
+    dist_info: Path, licenses: list[str], license_files: list[Path]
+):
+    for license_file in license_files:
+        makedirs(dist_info / license_file.parent, exist_ok=True)
+        copyfile(license_file, dist_info / license_file)
+        print(f"Added license file {license_file}")
+
+    metadata_file = dist_info / "METADATA"
+
+    with open(metadata_file, "r") as f:
+        lines = f.readlines()
+
+    for n, line in enumerate(lines):
+        if line.startswith("License-Expression: "):
+            base_license = line[len("License-Expression: ") :].strip()
+            all_licenses = [base_license, *licenses]
+            expression = ' AND '.join([f"({license})" for license in all_licenses])
+            lines[n] = f"License-Expression: {expression}\n"
+            break
+    else:
+        raise ValueError("Could not find License-Expression in METADATA")
+
+    print("Updated License-Expression from")
+    print("    " + base_license)
+    print("to")
+    print("    " + expression)
+
+    license_files_lines = [line for line in lines if line.startswith("License-File: ")]
+
+    if not license_files_lines:
+        raise ValueError("Could not find License-File in METADATA")
+
+    last_index = lines.index(license_files_lines[-1])
+    new_lines = [f"License-File: {f}\n" for f in license_files]
+    lines = lines[:last_index] + new_lines + lines[last_index:]
+
+    with open(metadata_file, "w") as f:
+        f.writelines(lines)
+
+
+if __name__ == "__main__":
+    import sys
+    sys.exit(main(*sys.argv[1:]))

pyproject.toml

@@ -2,13 +2,17 @@
 name = "python-flint"
 description = "Bindings for FLINT"
 version = "0.8.0"
+
 # This needs to be in sync with README, and CI config.
 requires-python = ">= 3.11"
 authors = [
     {name = "Fredrik Johansson", email = "[email protected]"},
     {name = "Oscar Benjamin", email = "[email protected]"},
 ]
-license = {file = "LICENSE"}
+
+license = "MIT"
+license-files = ["LICENSE"]
+
 classifiers = [
     "Topic :: Scientific/Engineering :: Mathematics",
 ]
@@ -37,7 +41,7 @@ content-type = "text/markdown"
 # fine. It is not possible to have a separate version constraint here for the
 # freethreading build only though.
 #
-requires = ["meson-python >= 0.13", "cython >=3.1,<3.2"]
+requires = ["meson-python >= 0.18", "cython >=3.1,<3.2"]
 build-backend = "mesonpy"
 
 [tool.cython-lint]
@@ -108,24 +112,30 @@ PKG_CONFIG_PATH = "$(pwd)/.local/lib/pkgconfig"
 
 [tool.cibuildwheel.linux]
 before-all = "bin/cibw_before_all_linux_$(uname -m).sh"
+before-build = "pip install wheel auditwheel"
+repair-wheel-command = [
+    "auditwheel repair -w {dest_dir} {wheel}",
+    """bin/cibw_repair_wheel_licenses.py {dest_dir} {wheel} \
+            --license-files wheels/LICENSE_linux_wheels.txt \
+    """,
+]
 
 [tool.cibuildwheel.macos]
 before-all = "bin/cibw_before_all_macosx_$(uname -m).sh"
+before-build = "pip install wheel delocate"
+repair-wheel-command = [
+    "delocate-wheel --require-archs {delocate_archs} -w {dest_dir} -v {wheel}",
+    """bin/cibw_repair_wheel_licenses.py {dest_dir} {wheel}  \
+            --license-files wheels/LICENSE_macosx_wheels.txt \
+    """,
+]
 
 [tool.cibuildwheel.windows]
 before-all = "C:\\msys64\\usr\\bin\\bash bin/cibw_before_all_windows.sh"
-before-build = "pip install delvewheel"
-repair-wheel-command = "delvewheel repair -w {dest_dir} {wheel} --add-path .local/bin"
-
-# Previously with setuptools and MinGW it was necessary to run
-# bin/cibw_before_build_windows.sh before building the wheel to create the
-# libpython*.a files. This is no longer necessary now meson is used:
-#
-#   before-build = "pip install delvewheel && C:\\msys64\\usr\\bin\\bash bin/cibw_before_build_windows.sh"
-#
-# Previously a custom delvewheel command was needed because delvewheel would
-# reject binaries created with MinGW unless they had been stripped. This is not
-# needed any more with newer versions of delvewheel:
-#
-#   repair-wheel-command = "bin\\cibw_repair_wheel_command_windows.bat {dest_dir} {wheel}"
-#
+before-build = "pip install wheel delvewheel"
+repair-wheel-command = [
+    "delvewheel repair -w {dest_dir} {wheel} --add-path .local/bin",
+    """bin/cibw_repair_wheel_licenses.py {dest_dir} {wheel}   \
+            --license-files wheels/LICENSE_windows_wheels.txt \
+    """,
+]