|
| 1 | +""" |
| 2 | +Best-effort metadata extraction for "source checkouts" -- e.g. a local dir containing pyproject.toml. |
| 3 | +
|
| 4 | +This is different from an (extracted) sdist, which *should* have a generated dist-info already. |
| 5 | +
|
| 6 | +Prefers: |
| 7 | +- PEP 621 metadata (pyproject.toml) |
| 8 | +- Poetry metadata (pyproject.toml) |
| 9 | +- Setuptools static metadata (setup.cfg) |
| 10 | +
|
| 11 | +Notably, does not read setup.py or attempt to emulate anything that can't be read staticly. |
| 12 | +""" |
| 13 | + |
| 14 | +from pathlib import Path |
| 15 | + |
| 16 | +try: |
| 17 | + import tomllib as toml |
| 18 | +except ImportError: |
| 19 | + import toml # type: ignore[no-redef,unused-ignore] |
| 20 | + |
| 21 | +from configparser import NoOptionError, NoSectionError, RawConfigParser |
| 22 | + |
| 23 | +from packaging.utils import canonicalize_name |
| 24 | + |
| 25 | +from .types import BasicMetadata |
| 26 | + |
| 27 | + |
| 28 | +def merge_markers(extra_name: str, value: str) -> str: |
| 29 | + """Simulates what a dist-info requirement string would look like if also restricted to an extra.""" |
| 30 | + if ";" not in value: |
| 31 | + return f'{value} ; extra == "{extra_name}"' |
| 32 | + else: |
| 33 | + a, _, b = value.partition(";") |
| 34 | + a = a.strip() |
| 35 | + b = b.strip() |
| 36 | + return f'{a} ; ({b}) and extra == "{extra_name}"' |
| 37 | + |
| 38 | + |
| 39 | +def from_source_checkout(path: Path) -> bytes: |
| 40 | + return ( |
| 41 | + from_pep621_checkout(path) |
| 42 | + or from_poetry_checkout(path) |
| 43 | + or from_setup_cfg_checkout(path) |
| 44 | + ) |
| 45 | + |
| 46 | + |
| 47 | +def from_pep621_checkout(path: Path) -> bytes: |
| 48 | + """ |
| 49 | + Returns a metadata snippet (which is zero-length if this is none of this style). |
| 50 | + """ |
| 51 | + try: |
| 52 | + data = (path / "pyproject.toml").read_text() |
| 53 | + except FileNotFoundError: |
| 54 | + return b"" |
| 55 | + doc = toml.loads(data) |
| 56 | + |
| 57 | + buf: list[str] = [] |
| 58 | + for dep in doc.get("project", {}).get("dependencies", ()): |
| 59 | + buf.append(f"Requires-Dist: {dep}\n") |
| 60 | + for k, v in doc.get("project", {}).get("optional-dependencies", {}).items(): |
| 61 | + extra_name = canonicalize_name(k) |
| 62 | + buf.append(f"Provides-Extra: {extra_name}\n") |
| 63 | + for i in v: |
| 64 | + buf.append("Requires-Dist: " + merge_markers(extra_name, i) + "\n") |
| 65 | + |
| 66 | + return "".join(buf).encode("utf-8") |
| 67 | + |
| 68 | + |
| 69 | +def _translate_caret(specifier: str) -> str: |
| 70 | + """ |
| 71 | + Given a string like "^0.2.3" returns ">=0.2.3,<0.3.0". |
| 72 | + """ |
| 73 | + assert "," not in specifier |
| 74 | + parts = specifier[1:].split(".") |
| 75 | + while len(parts) < 3: |
| 76 | + parts.append("0") |
| 77 | + |
| 78 | + for i in range(len(parts)): |
| 79 | + if parts[i] != "0": |
| 80 | + # The docs are not super clear about how this behaves, but let's |
| 81 | + # assume integer-valued parts and just let the exception raise |
| 82 | + # otherwise. |
| 83 | + incremented = parts[:] |
| 84 | + incremented[i] = str(int(parts[i]) + 1) |
| 85 | + del incremented[i + 1 :] |
| 86 | + incremented_version = ".".join(incremented) |
| 87 | + break |
| 88 | + else: |
| 89 | + raise ValueError("All components were zero?") |
| 90 | + return f">={specifier[1:]},<{incremented_version}" |
| 91 | + |
| 92 | + |
| 93 | +def _translate_tilde(specifier: str) -> str: |
| 94 | + """ |
| 95 | + Given a string like "~1.2.3" returns ">=1.2.3,<1.3". |
| 96 | + """ |
| 97 | + assert "," not in specifier |
| 98 | + parts = specifier[1:].split(".") |
| 99 | + incremented = parts[:2] |
| 100 | + incremented[-1] = str(int(incremented[-1]) + 1) |
| 101 | + incremented_version = ".".join(incremented) |
| 102 | + |
| 103 | + return f">={specifier[1:]},<{incremented_version}" |
| 104 | + |
| 105 | + |
| 106 | +def from_poetry_checkout(path: Path) -> bytes: |
| 107 | + """ |
| 108 | + Returns a metadata snippet (which is zero-length if this is none of this style). |
| 109 | + """ |
| 110 | + try: |
| 111 | + data = (path / "pyproject.toml").read_text() |
| 112 | + except FileNotFoundError: |
| 113 | + return b"" |
| 114 | + doc = toml.loads(data) |
| 115 | + |
| 116 | + saved_extra_constraints = {} |
| 117 | + |
| 118 | + buf: list[str] = [] |
| 119 | + for k, v in doc.get("tool", {}).get("poetry", {}).get("dependencies", {}).items(): |
| 120 | + if k == "python": |
| 121 | + pass # TODO requires-python |
| 122 | + else: |
| 123 | + k = canonicalize_name(k) |
| 124 | + if isinstance(v, dict): |
| 125 | + version = v.get("version", "") |
| 126 | + if "extras" in v: |
| 127 | + extras = "[%s]" % (",".join(v["extras"])) |
| 128 | + else: |
| 129 | + extras = "" |
| 130 | + optional = v.get("optional", False) |
| 131 | + else: |
| 132 | + version = v |
| 133 | + extras = "" |
| 134 | + optional = False |
| 135 | + |
| 136 | + if not version: |
| 137 | + # e.g. git, path or url dependencies, skip for now |
| 138 | + continue |
| 139 | + |
| 140 | + # https://python-poetry.org/docs/dependency-specification/#version-constraints |
| 141 | + # 1.2.* type wildcards are supported natively in packaging |
| 142 | + if version.startswith("^"): |
| 143 | + version = _translate_caret(version) |
| 144 | + elif version.startswith("~"): |
| 145 | + version = _translate_tilde(version) |
| 146 | + elif version == "*": |
| 147 | + version = "" |
| 148 | + |
| 149 | + if version[:1].isdigit(): |
| 150 | + version = "==" + version |
| 151 | + |
| 152 | + if optional: |
| 153 | + saved_extra_constraints[k] = f"{extras}{version}" |
| 154 | + else: |
| 155 | + buf.append(f"Requires-Dist: {k}{extras}{version}\n") |
| 156 | + |
| 157 | + for k, v in doc.get("tool", {}).get("poetry", {}).get("extras", {}).items(): |
| 158 | + k = canonicalize_name(k) |
| 159 | + buf.append(f"Provides-Extra: {k}\n") |
| 160 | + for vi in v: |
| 161 | + vi = canonicalize_name(vi) |
| 162 | + buf.append( |
| 163 | + f"Requires-Dist: {vi}{merge_markers(k, saved_extra_constraints[vi])}" |
| 164 | + ) |
| 165 | + |
| 166 | + return "".join(buf).encode("utf-8") |
| 167 | + |
| 168 | + |
| 169 | +def from_setup_cfg_checkout(path: Path) -> bytes: |
| 170 | + try: |
| 171 | + data = (path / "setup.cfg").read_text() |
| 172 | + except FileNotFoundError: |
| 173 | + return b"" |
| 174 | + |
| 175 | + rc = RawConfigParser() |
| 176 | + rc.read_string(data) |
| 177 | + |
| 178 | + buf: list[str] = [] |
| 179 | + try: |
| 180 | + for dep in rc.get("options", "install_requires").splitlines(): |
| 181 | + dep = dep.strip() |
| 182 | + if dep: |
| 183 | + buf.append(f"Requires-Dist: {dep}\n") |
| 184 | + except (NoOptionError, NoSectionError): |
| 185 | + pass |
| 186 | + |
| 187 | + try: |
| 188 | + section = rc["options.extras_require"] |
| 189 | + except KeyError: |
| 190 | + pass |
| 191 | + else: |
| 192 | + for k, v in section.items(): |
| 193 | + extra_name = canonicalize_name(k) |
| 194 | + buf.append(f"Provides-Extra: {extra_name}\n") |
| 195 | + for i in v.splitlines(): |
| 196 | + i = i.strip() |
| 197 | + if i: |
| 198 | + buf.append("Requires-Dist: " + merge_markers(extra_name, i) + "\n") |
| 199 | + |
| 200 | + return "".join(buf).encode("utf-8") |
| 201 | + |
| 202 | + |
| 203 | +def basic_metadata_from_source_checkout(path: Path) -> BasicMetadata: |
| 204 | + return BasicMetadata.from_metadata(from_source_checkout(path)) |
| 205 | + |
| 206 | + |
| 207 | +if __name__ == "__main__": # pragma: no cover |
| 208 | + import sys |
| 209 | + |
| 210 | + print(basic_metadata_from_source_checkout(Path(sys.argv[1]))) |
0 commit comments