|
| 1 | +"""Tooling for pyproject.toml""" |
| 2 | + |
| 3 | +import logging |
| 4 | +import pathlib |
| 5 | +import typing |
| 6 | + |
| 7 | +import tomlkit |
| 8 | +from packaging.requirements import Requirement |
| 9 | +from packaging.utils import NormalizedName, canonicalize_name |
| 10 | + |
| 11 | +from . import context |
| 12 | + |
| 13 | +logger = logging.getLogger(__name__) |
| 14 | + |
| 15 | +TomlDict = dict[str, typing.Any] |
| 16 | + |
| 17 | +# section / key names |
| 18 | +BUILD_SYSTEM = "build-system" |
| 19 | +BUILD_BACKEND = "build-backend" |
| 20 | +BUILD_REQUIRES = "requires" |
| 21 | + |
| 22 | + |
| 23 | +class PyprojectFix: |
| 24 | + """Auto-fixer for pyproject.toml settings |
| 25 | +
|
| 26 | + - add missing pyproject.toml |
| 27 | + - add or update `[build-system] requires` |
| 28 | +
|
| 29 | + Requirements in `update_build_requires` are added to |
| 30 | + `[build-system] requires`. If a requirement name matches an existing |
| 31 | + name, then the requirement is replaced. |
| 32 | +
|
| 33 | + Requirements in `remove_build_requires` are removed from |
| 34 | + `[build-system] requires`. |
| 35 | + """ |
| 36 | + |
| 37 | + def __init__( |
| 38 | + self, |
| 39 | + req: Requirement, |
| 40 | + *, |
| 41 | + build_dir: pathlib.Path, |
| 42 | + update_build_requires: list[str], |
| 43 | + remove_build_requires: list[NormalizedName], |
| 44 | + ) -> None: |
| 45 | + self.req = req |
| 46 | + self.build_dir = build_dir |
| 47 | + self.update_requirements = update_build_requires |
| 48 | + self.remove_requirements = remove_build_requires |
| 49 | + self.pyproject_toml = self.build_dir / "pyproject.toml" |
| 50 | + self.setup_py = self.build_dir / "setup.py" |
| 51 | + |
| 52 | + def run(self) -> None: |
| 53 | + doc = self._load() |
| 54 | + build_system = self._default_build_system(doc) |
| 55 | + self._update_build_requires(build_system) |
| 56 | + logger.debug( |
| 57 | + "%s: pyproject.toml %s: %s=%r, %s=%r", |
| 58 | + self.req.name, |
| 59 | + BUILD_SYSTEM, |
| 60 | + BUILD_BACKEND, |
| 61 | + build_system.get(BUILD_BACKEND), |
| 62 | + BUILD_REQUIRES, |
| 63 | + build_system.get(BUILD_REQUIRES), |
| 64 | + ) |
| 65 | + self._save(doc) |
| 66 | + |
| 67 | + def _load(self) -> tomlkit.TOMLDocument: |
| 68 | + """Load pyproject toml or create empty TOML doc""" |
| 69 | + try: |
| 70 | + doc = tomlkit.parse(self.pyproject_toml.read_bytes()) |
| 71 | + logger.debug("%s: loaded pyproject.toml", self.req.name) |
| 72 | + except FileNotFoundError: |
| 73 | + logger.debug("%s: no pyproject.toml, create empty doc", self.req.name) |
| 74 | + doc = tomlkit.parse(b"") |
| 75 | + return doc |
| 76 | + |
| 77 | + def _save(self, doc: tomlkit.TOMLDocument) -> None: |
| 78 | + """Write pyproject.toml to build directory""" |
| 79 | + with self.pyproject_toml.open("w") as f: |
| 80 | + tomlkit.dump(doc, f) |
| 81 | + |
| 82 | + def _default_build_system(self, doc: tomlkit.TOMLDocument) -> TomlDict: |
| 83 | + """Add / fix basic 'build-system' dict""" |
| 84 | + build_system: TomlDict | None = doc.get(BUILD_SYSTEM) |
| 85 | + if build_system is None: |
| 86 | + logger.debug("%s: adding %s", self.req.name, BUILD_SYSTEM) |
| 87 | + build_system = doc.setdefault(BUILD_SYSTEM, {}) |
| 88 | + # ensure `[build-system] requires` exists |
| 89 | + build_system.setdefault(BUILD_REQUIRES, []) |
| 90 | + return build_system |
| 91 | + |
| 92 | + def _update_build_requires(self, build_system: TomlDict) -> None: |
| 93 | + old_requires = build_system[BUILD_REQUIRES] |
| 94 | + # always include setuptools |
| 95 | + req_map: dict[NormalizedName, Requirement] = { |
| 96 | + canonicalize_name("setuptools"): Requirement("setuptools"), |
| 97 | + } |
| 98 | + # parse original build reqirements (if available) |
| 99 | + for reqstr in old_requires: |
| 100 | + req = Requirement(reqstr) |
| 101 | + req_map[canonicalize_name(req.name)] = req |
| 102 | + # remove unwanted requirements |
| 103 | + for name in self.remove_requirements: |
| 104 | + req_map.pop(canonicalize_name(name), None) |
| 105 | + # add / update requirements |
| 106 | + for reqstr in self.update_requirements: |
| 107 | + req = Requirement(reqstr) |
| 108 | + req_map[canonicalize_name(req.name)] = req |
| 109 | + |
| 110 | + new_requires = sorted(str(req) for req in req_map.values()) |
| 111 | + if set(new_requires) != set(old_requires): |
| 112 | + # ignore order of items |
| 113 | + build_system[BUILD_REQUIRES] = new_requires |
| 114 | + logger.info( |
| 115 | + "%s: changed build-system requires from %r to %r", |
| 116 | + self.req.name, |
| 117 | + old_requires, |
| 118 | + new_requires, |
| 119 | + ) |
| 120 | + |
| 121 | + |
| 122 | +def apply_project_override( |
| 123 | + ctx: context.WorkContext, req: Requirement, sdist_root_dir: pathlib.Path |
| 124 | +) -> None: |
| 125 | + """Apply project_overrides""" |
| 126 | + pbi = ctx.package_build_info(req) |
| 127 | + update_build_requires = pbi.project_override.update_build_requires |
| 128 | + remove_build_requires = pbi.project_override.remove_build_requires |
| 129 | + if update_build_requires or remove_build_requires: |
| 130 | + logger.debug( |
| 131 | + f"{req.name}: applying project_override: " |
| 132 | + f"{update_build_requires=}, {remove_build_requires=}" |
| 133 | + ) |
| 134 | + build_dir = pbi.build_dir(sdist_root_dir) |
| 135 | + PyprojectFix( |
| 136 | + req, |
| 137 | + build_dir=build_dir, |
| 138 | + update_build_requires=update_build_requires, |
| 139 | + remove_build_requires=remove_build_requires, |
| 140 | + ).run() |
| 141 | + else: |
| 142 | + logger.debug(f"{req.name}: no project_override") |
0 commit comments