1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261
|
from __future__ import annotations
import functools
import graphlib
import os
import re
from typing import Any, Optional
from collections.abc import Iterator
import requests
import tomli
from packaging.requirements import Requirement
from .const import META, THIRD_PARTY_NAMESPACE, TYPES_PREFIX, UPLOADED_PATH
class InvalidRequires(Exception):
pass
class Metadata:
def __init__(self, distribution: str, data: dict[str, Any]):
assert not distribution.startswith(TYPES_PREFIX)
self._alleged_upstream_distribution = distribution
self.data = data
@property
def upstream_distribution(self) -> Optional[str]:
# TODO: add a field to METADATA.toml if the stubs are for a package
# that does not exist on PyPI
if self._alleged_upstream_distribution == "gdb":
return None
return self._alleged_upstream_distribution
@property
def stub_distribution(self) -> str:
return TYPES_PREFIX + self._alleged_upstream_distribution
@property
def version_spec(self) -> str:
# The "version" field in METADATA.toml isn't actually a version, it's more
# like a specifier, e.g. we allow it to contain wildcards.
version = self.data["version"]
assert isinstance(version, str)
return version
@property
def _unvalidated_requires(self) -> list[Requirement]:
return [Requirement(req) for req in self.data.get("requires", [])]
@property
def _unvalidated_requires_typeshed(self) -> list[Requirement]:
typeshed = uploaded_packages.read()
return [
r for r in self._unvalidated_requires if canonical_name(r.name) in typeshed
]
@functools.cached_property
def requires_typeshed(self) -> list[Requirement]:
reqs = self._unvalidated_requires_typeshed
for req in reqs:
verify_typeshed_req(req)
return reqs
@property
def _unvalidated_requires_external(self) -> list[Requirement]:
typeshed = uploaded_packages.read()
return [
r
for r in self._unvalidated_requires
if canonical_name(r.name) not in typeshed
]
@functools.cached_property
def requires_external(self) -> list[Requirement]:
reqs = self._unvalidated_requires_external
for req in reqs:
verify_external_req(req, self.upstream_distribution)
return reqs
@property
def extra_description(self) -> str:
return self.data.get("extra_description", "")
@property
def obsolete_since(self) -> Optional[str]:
return self.data.get("obsolete_since")
@property
def no_longer_updated(self) -> bool:
return self.data.get("no_longer_updated", False)
def read_metadata(typeshed_dir: str, distribution: str) -> Metadata:
"""Parse metadata from file."""
assert not distribution.startswith(TYPES_PREFIX)
path = os.path.join(typeshed_dir, THIRD_PARTY_NAMESPACE, distribution, META)
with open(path, "rb") as f:
data = tomli.load(f)
return Metadata(distribution=distribution, data=data)
def canonical_name(name: str) -> str:
# https://peps.python.org/pep-0503/#normalized-names
return re.sub(r"[-_.]+", "-", name).lower()
class _UploadedPackages:
def __init__(self, file_path: str) -> None:
self._file_path = file_path
self._cached: Optional[list[str]] = None
def read(self) -> set[str]:
if self._cached is not None:
return set(map(canonical_name, self._cached))
with open(self._file_path) as f:
self._cached = f.read().splitlines()
return set(map(canonical_name, self._cached))
def add(self, distribution: str) -> None:
assert not distribution.startswith(TYPES_PREFIX)
stub_dist = TYPES_PREFIX + distribution
if canonical_name(stub_dist) not in self.read():
with open(self._file_path) as f:
current = f.read().splitlines()
current.append(stub_dist)
current.sort()
with open(self._file_path, "w") as f:
f.write("\n".join(current))
self._cached = None
uploaded_packages = _UploadedPackages(UPLOADED_PATH)
def strip_types_prefix(dependency: str) -> str:
if not dependency.startswith(TYPES_PREFIX):
raise ValueError("Expected dependency on a typeshed package")
return dependency.removeprefix(TYPES_PREFIX)
def verify_typeshed_req(req: Requirement) -> None:
if not req.name.startswith(TYPES_PREFIX):
raise InvalidRequires(f"Expected dependency {req} to start with {TYPES_PREFIX}")
if not canonical_name(req.name) in uploaded_packages.read():
raise InvalidRequires(
f"Expected dependency {req} to be uploaded from stub_uploader"
)
# TODO: make sure that if a typeshed distribution depends on other typeshed stubs,
# the upstream depends on the upstreams corresponding to those stubs.
# See https://github.com/typeshed-internal/stub_uploader/pull/61#discussion_r979327370
# Presence in the top 1000 PyPI packages could be a necessary but not sufficient criterion for
# inclusion in this allowlist.
# Note we could loosen our criteria once we address:
# https://github.com/typeshed-internal/stub_uploader/pull/61#discussion_r979327370
EXTERNAL_REQ_ALLOWLIST = {
"numpy",
"cryptography",
"torch",
}
def verify_external_req(
req: Requirement,
upstream_distribution: Optional[str],
_unsafe_ignore_allowlist: bool = False, # used for tests
) -> None:
if canonical_name(req.name) in uploaded_packages.read():
raise InvalidRequires(
f"Expected dependency {req} to not be uploaded from stub_uploader"
)
if req.name.startswith(TYPES_PREFIX):
# technically this could be allowed, but it's very suspicious
raise InvalidRequires(
f"Expected dependency {req} to not start with {TYPES_PREFIX}"
)
if upstream_distribution is None:
raise InvalidRequires(
f"There is no upstream distribution on PyPI, so cannot verify {req}"
)
resp = requests.get(f"https://pypi.org/pypi/{upstream_distribution}/json")
if resp.status_code != 200:
raise InvalidRequires(
f"Expected dependency {req} to be accessible on PyPI, but got {resp.status_code}"
)
data = resp.json()
# TODO: consider allowing external dependencies for stubs for packages that do not ship wheels.
# Note that we can't build packages from sdists, since that can execute arbitrary code.
# We could do some hacky setup.py parsing though...
# TODO: PyPI doesn't seem to have version specific requires_dist. This does mean we can be
# broken by new releases of upstream packages, even if they do not match the version spec we
# have for the upstream distribution.
if req.name not in [
Requirement(r).name for r in (data["info"].get("requires_dist") or [])
]:
raise InvalidRequires(
f"Expected dependency {req} to be listed in {upstream_distribution}'s requires_dist"
)
if req.name not in EXTERNAL_REQ_ALLOWLIST and not _unsafe_ignore_allowlist:
raise InvalidRequires(
f"Expected dependency {req} to be present in the allowlist"
)
def sort_by_dependency(typeshed_dir: str, distributions: list[str]) -> Iterator[str]:
# Just a simple topological sort. Unlike previous versions of the code, we do not rely
# on this to perform validation, like requiring the graph to be complete.
# We only use this to help with edge cases like multiple packages being uploaded
# for the first time that depend on each other.
ts: graphlib.TopologicalSorter[str] = graphlib.TopologicalSorter()
for dist in os.listdir(os.path.join(typeshed_dir, THIRD_PARTY_NAMESPACE)):
metadata = read_metadata(typeshed_dir, dist)
ts.add(
metadata.stub_distribution,
# Use _unvalidated_requires instead of requires_typeshed, in case we're uploading
# a new package B that depends on another new package A. Sorting topologically means
# that the A will be in uploaded_packages.txt by the time it comes to verify and
# upload B.
*[r.name for r in metadata._unvalidated_requires],
)
order = [strip_types_prefix(dist) for dist in ts.static_order()]
missing = set(distributions) - set(order)
assert not missing, f"Failed to find distributions {missing}"
for dist in order:
if dist in distributions:
yield dist
def recursive_verify(metadata: Metadata, typeshed_dir: str) -> set[str]:
# While metadata.requires_typeshed and metadata.requires_external will perform validation on the
# stub distribution itself, it seems useful to be able to validate the transitive typeshed
# dependency graph for a stub distribution
_verified: set[str] = set()
def _verify(metadata: Metadata) -> None:
if metadata.stub_distribution in _verified:
return
_verified.add(metadata.stub_distribution)
# calling these checks metadata's requires
assert isinstance(metadata.requires_typeshed, list)
assert isinstance(metadata.requires_external, list)
# and recursively verify all our internal dependencies as well
for req in metadata.requires_typeshed:
_verify(read_metadata(typeshed_dir, strip_types_prefix(req.name)))
_verify(metadata)
return _verified
|