|
| 1 | +#!/usr/bin/env python |
| 2 | + |
| 3 | +import argparse |
| 4 | +from pathlib import Path |
| 5 | +from subprocess import run |
| 6 | +from tempfile import TemporaryDirectory |
| 7 | +from shutil import copyfile |
| 8 | +from os import makedirs |
| 9 | + |
| 10 | + |
| 11 | +def main(*args: str): |
| 12 | + """ |
| 13 | + Update license information in wheels after running auditwheel etc. |
| 14 | +
|
| 15 | + Usage: |
| 16 | + cibw_repair_wheel_licenses.py <wheel_file> \ |
| 17 | + --license MIT --license-file licenses/license_foo_MIT.txt \ |
| 18 | + --license BSD-3-Clause --license-file licenses/license_bar_BSD-3-Clause.txt \ |
| 19 | + ... |
| 20 | +
|
| 21 | + CWD should be at project root (containing pyproject.toml) and license-file |
| 22 | + paths must be relative. |
| 23 | + """ |
| 24 | + parser = argparse.ArgumentParser() |
| 25 | + parser.add_argument("wheel_file") |
| 26 | + parser.add_argument("--license", action="append", default=[]) |
| 27 | + parser.add_argument("--license-file", action="append", default=[]) |
| 28 | + |
| 29 | + parsed = parser.parse_args(args) |
| 30 | + wheel_file = Path(parsed.wheel_file) |
| 31 | + licenses = parsed.license |
| 32 | + license_files = [Path(f) for f in parsed.license_file] |
| 33 | + |
| 34 | + if any(f.is_absolute() for f in license_files): |
| 35 | + # |
| 36 | + # PEP 639 says: |
| 37 | + # |
| 38 | + # Inside the root license directory, packaging tools MUST reproduce the |
| 39 | + # directory structure under which the source license files are located |
| 40 | + # relative to the project root. |
| 41 | + # |
| 42 | + raise ValueError("license-file paths must be relative to project root") |
| 43 | + |
| 44 | + update_licenses_wheel(wheel_file, licenses, license_files) |
| 45 | + |
| 46 | + |
| 47 | +def update_licenses_wheel( |
| 48 | + wheel_file: Path, licenses: list[str], license_files: list[Path] |
| 49 | +): |
| 50 | + # foo/bar-1.0-cp310-cp310-linux_x86_64.whl -> bar-1.0 |
| 51 | + name, version = wheel_file.stem.split('-')[:2] |
| 52 | + base = f"{name}-{version}" |
| 53 | + |
| 54 | + with TemporaryDirectory() as tmpdir: |
| 55 | + |
| 56 | + run(["wheel", "unpack", "--dest", tmpdir, wheel_file], check=True) |
| 57 | + dist_info = Path(tmpdir) / base / f"{base}.dist-info" |
| 58 | + |
| 59 | + print(f"Adding licenses in {dist_info}") |
| 60 | + update_license_dist_info(dist_info, licenses, license_files) |
| 61 | + |
| 62 | + run(["wheel", "pack", Path(tmpdir) / base], check=True) |
| 63 | + |
| 64 | + # glob for *.whl in tmpdir |
| 65 | + wheels = list(Path(tmpdir).glob(f"{base}-*.whl")) |
| 66 | + if len(wheels) != 1: |
| 67 | + raise ValueError(f"Expected one wheel in {tmpdir}, got {wheels}") |
| 68 | + new_wheel_file = wheels[0] |
| 69 | + |
| 70 | + print(f"Repaired wheel: {new_wheel_file}") |
| 71 | + print(f"Copying to {wheel_file}") |
| 72 | + copyfile(new_wheel_file, wheel_file) |
| 73 | + |
| 74 | + |
| 75 | +def update_license_dist_info( |
| 76 | + dist_info: Path, licenses: list[str], license_files: list[Path] |
| 77 | +): |
| 78 | + for license_file in license_files: |
| 79 | + makedirs(dist_info / license_file.parent, exist_ok=True) |
| 80 | + copyfile(license_file, dist_info / license_file) |
| 81 | + print(f"Added license file {license_file}") |
| 82 | + |
| 83 | + metadata_file = dist_info / "METADATA" |
| 84 | + |
| 85 | + with open(metadata_file, "r") as f: |
| 86 | + lines = f.readlines() |
| 87 | + |
| 88 | + for n, line in enumerate(lines): |
| 89 | + if line.startswith("License-Expression: "): |
| 90 | + base_license = line[len("License-Expression: ") :].strip() |
| 91 | + all_licenses = [base_license, *licenses] |
| 92 | + expression = ' AND '.join([f"({license})" for license in all_licenses]) |
| 93 | + lines[n] = f"License-Expression: {expression}\n" |
| 94 | + break |
| 95 | + else: |
| 96 | + raise ValueError("Could not find License-Expression in METADATA") |
| 97 | + |
| 98 | + print("Updated License-Expression from") |
| 99 | + print(" " + base_license) |
| 100 | + print("to") |
| 101 | + print(" " + expression) |
| 102 | + |
| 103 | + license_files_lines = [line for line in lines if line.startswith("License-File: ")] |
| 104 | + |
| 105 | + if not license_files_lines: |
| 106 | + raise ValueError("Could not find License-File in METADATA") |
| 107 | + |
| 108 | + last_index = lines.index(license_files_lines[-1]) |
| 109 | + new_lines = [f"License-File: {f}\n" for f in license_files] |
| 110 | + lines = lines[:last_index] + new_lines + lines[last_index:] |
| 111 | + |
| 112 | + with open(metadata_file, "w") as f: |
| 113 | + f.writelines(lines) |
| 114 | + |
| 115 | + |
| 116 | +if __name__ == "__main__": |
| 117 | + import sys |
| 118 | + sys.exit(main(*sys.argv[1:])) |
0 commit comments