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 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742
|
#!/usr/bin/env python3
from __future__ import annotations
import argparse
import asyncio
import contextlib
import datetime
import enum
import functools
import io
import os
import re
import subprocess
import sys
import tarfile
import textwrap
import urllib.parse
import zipfile
from collections.abc import Iterator, Mapping, Sequence
from dataclasses import dataclass
from pathlib import Path
from typing import Annotated, Any, ClassVar, NamedTuple, TypeVar
from typing_extensions import TypeAlias
import aiohttp
import packaging.specifiers
import packaging.version
import tomli
import tomlkit
from termcolor import colored
ActionLevelSelf = TypeVar("ActionLevelSelf", bound="ActionLevel")
class ActionLevel(enum.IntEnum):
def __new__(cls: type[ActionLevelSelf], value: int, doc: str) -> ActionLevelSelf:
member = int.__new__(cls, value)
member._value_ = value
member.__doc__ = doc
return member
@classmethod
def from_cmd_arg(cls, cmd_arg: str) -> ActionLevel:
try:
return cls[cmd_arg]
except KeyError:
raise argparse.ArgumentTypeError(f'Argument must be one of "{list(cls.__members__)}"')
nothing = 0, "make no changes"
local = 1, "make changes that affect local repo"
fork = 2, "make changes that affect remote repo, but won't open PRs against upstream"
everything = 3, "do everything, e.g. open PRs"
@dataclass
class StubInfo:
distribution: str
version_spec: str
obsolete: bool
no_longer_updated: bool
def read_typeshed_stub_metadata(stub_path: Path) -> StubInfo:
with (stub_path / "METADATA.toml").open("rb") as f:
meta = tomli.load(f)
return StubInfo(
distribution=stub_path.name,
version_spec=meta["version"],
obsolete="obsolete_since" in meta,
no_longer_updated=meta.get("no_longer_updated", False),
)
@dataclass
class PypiReleaseDownload:
url: str
packagetype: Annotated[str, "Should hopefully be either 'bdist_wheel' or 'sdist'"]
filename: str
version: packaging.version.Version
upload_date: datetime.datetime
VersionString: TypeAlias = str
ReleaseDownload: TypeAlias = dict[str, Any]
@dataclass
class PypiInfo:
distribution: str
pypi_root: str
releases: dict[VersionString, list[ReleaseDownload]]
info: dict[str, Any]
def get_release(self, *, version: VersionString) -> PypiReleaseDownload:
# prefer wheels, since it's what most users will get / it's pretty easy to mess up MANIFEST
release_info = sorted(self.releases[version], key=lambda x: bool(x["packagetype"] == "bdist_wheel"))[-1]
return PypiReleaseDownload(
url=release_info["url"],
packagetype=release_info["packagetype"],
filename=release_info["filename"],
version=packaging.version.Version(version),
upload_date=datetime.datetime.fromisoformat(release_info["upload_time"]),
)
def get_latest_release(self) -> PypiReleaseDownload:
return self.get_release(version=self.info["version"])
def releases_in_descending_order(self) -> Iterator[PypiReleaseDownload]:
for version in sorted(self.releases, key=packaging.version.Version, reverse=True):
yield self.get_release(version=version)
async def fetch_pypi_info(distribution: str, session: aiohttp.ClientSession) -> PypiInfo:
# Cf. # https://warehouse.pypa.io/api-reference/json.html#get--pypi--project_name--json
pypi_root = f"https://pypi.org/pypi/{urllib.parse.quote(distribution)}"
async with session.get(f"{pypi_root}/json") as response:
response.raise_for_status()
j = await response.json()
return PypiInfo(distribution=distribution, pypi_root=pypi_root, releases=j["releases"], info=j["info"])
@dataclass
class Update:
distribution: str
stub_path: Path
old_version_spec: str
new_version_spec: str
links: dict[str, str]
diff_analysis: DiffAnalysis | None
def __str__(self) -> str:
return f"Updating {self.distribution} from {self.old_version_spec!r} to {self.new_version_spec!r}"
@dataclass
class Obsolete:
distribution: str
stub_path: Path
obsolete_since_version: str
obsolete_since_date: datetime.datetime
links: dict[str, str]
def __str__(self) -> str:
return f"Marking {self.distribution} as obsolete since {self.obsolete_since_version!r}"
@dataclass
class NoUpdate:
distribution: str
reason: str
def __str__(self) -> str:
return f"Skipping {self.distribution}: {self.reason}"
async def release_contains_py_typed(release_to_download: PypiReleaseDownload, *, session: aiohttp.ClientSession) -> bool:
async with session.get(release_to_download.url) as response:
body = io.BytesIO(await response.read())
packagetype = release_to_download.packagetype
if packagetype == "bdist_wheel":
assert release_to_download.filename.endswith(".whl")
with zipfile.ZipFile(body) as zf:
return any(Path(f).name == "py.typed" for f in zf.namelist())
elif packagetype == "sdist":
assert release_to_download.filename.endswith(".tar.gz")
with tarfile.open(fileobj=body, mode="r:gz") as zf:
return any(Path(f).name == "py.typed" for f in zf.getnames())
else:
raise AssertionError(f"Unknown package type: {packagetype!r}")
async def find_first_release_with_py_typed(pypi_info: PypiInfo, *, session: aiohttp.ClientSession) -> PypiReleaseDownload:
release_iter = pypi_info.releases_in_descending_order()
while await release_contains_py_typed(release := next(release_iter), session=session):
first_release_with_py_typed = release
return first_release_with_py_typed
def _check_spec(updated_spec: str, version: packaging.version.Version) -> str:
assert version in packaging.specifiers.SpecifierSet(f"=={updated_spec}"), f"{version} not in {updated_spec}"
return updated_spec
def get_updated_version_spec(spec: str, version: packaging.version.Version) -> str:
"""
Given the old specifier and an updated version, returns an updated specifier that has the
specificity of the old specifier, but matches the updated version.
For example:
spec="1", version="1.2.3" -> "1.2.3"
spec="1.0.1", version="1.2.3" -> "1.2.3"
spec="1.*", version="1.2.3" -> "1.*"
spec="1.*", version="2.3.4" -> "2.*"
spec="1.1.*", version="1.2.3" -> "1.2.*"
spec="1.1.1.*", version="1.2.3" -> "1.2.3.*"
"""
if not spec.endswith(".*"):
return _check_spec(version.base_version, version)
specificity = spec.count(".") if spec.removesuffix(".*") else 0
rounded_version = version.base_version.split(".")[:specificity]
rounded_version.extend(["0"] * (specificity - len(rounded_version)))
return _check_spec(".".join(rounded_version) + ".*", version)
@functools.cache
def get_github_api_headers() -> Mapping[str, str]:
headers = {"Accept": "application/vnd.github.v3+json"}
secret = os.environ.get("GITHUB_TOKEN")
if secret is not None:
headers["Authorization"] = f"token {secret}" if secret.startswith("ghp") else f"Bearer {secret}"
return headers
@dataclass
class GithubInfo:
repo_path: str
tags: list[dict[str, Any]]
async def get_github_repo_info(session: aiohttp.ClientSession, pypi_info: PypiInfo) -> GithubInfo | None:
"""
If the project represented by `pypi_info` is hosted on GitHub,
return information regarding the project as it exists on GitHub.
Else, return None.
"""
project_urls = pypi_info.info.get("project_urls", {}).values()
for project_url in project_urls:
assert isinstance(project_url, str)
split_url = urllib.parse.urlsplit(project_url)
if split_url.netloc == "github.com" and not split_url.query and not split_url.fragment:
url_path = split_url.path.strip("/")
if len(Path(url_path).parts) == 2:
github_tags_info_url = f"https://api.github.com/repos/{url_path}/tags"
async with session.get(github_tags_info_url, headers=get_github_api_headers()) as response:
if response.status == 200:
tags = await response.json()
assert isinstance(tags, list)
return GithubInfo(repo_path=url_path, tags=tags)
return None
class GithubDiffInfo(NamedTuple):
repo_path: str
old_tag: str
new_tag: str
diff_url: str
async def get_diff_info(
session: aiohttp.ClientSession, stub_info: StubInfo, pypi_info: PypiInfo, pypi_version: packaging.version.Version
) -> GithubDiffInfo | None:
"""Return a tuple giving info about the diff between two releases, if possible.
Return `None` if the project isn't hosted on GitHub,
or if a link pointing to the diff couldn't be found for any other reason.
"""
github_info = await get_github_repo_info(session, pypi_info)
if github_info is None:
return None
versions_to_tags = {}
for tag in github_info.tags:
tag_name = tag["name"]
# Some packages in typeshed (e.g. emoji) have tag names
# that are invalid to be passed to the Version() constructor,
# e.g. v.1.4.2
with contextlib.suppress(packaging.version.InvalidVersion):
versions_to_tags[packaging.version.Version(tag_name)] = tag_name
curr_specifier = packaging.specifiers.SpecifierSet(f"=={stub_info.version_spec}")
try:
new_tag = versions_to_tags[pypi_version]
except KeyError:
return None
try:
old_version = max(version for version in versions_to_tags if version in curr_specifier)
except ValueError:
return None
else:
old_tag = versions_to_tags[old_version]
diff_url = f"https://github.com/{github_info.repo_path}/compare/{old_tag}...{new_tag}"
async with session.get(diff_url, headers=get_github_api_headers()) as response:
# Double-check we're returning a valid URL here
response.raise_for_status()
return GithubDiffInfo(repo_path=github_info.repo_path, old_tag=old_tag, new_tag=new_tag, diff_url=diff_url)
FileInfo: TypeAlias = dict[str, Any]
def _plural_s(num: int, /) -> str:
return "s" if num != 1 else ""
@dataclass
class DiffAnalysis:
MAXIMUM_NUMBER_OF_FILES_TO_LIST: ClassVar[int] = 7
py_files: list[FileInfo]
py_files_stubbed_in_typeshed: list[FileInfo]
@property
def runtime_definitely_has_consistent_directory_structure_with_typeshed(self) -> bool:
"""
If 0 .py files in the GitHub diff exist in typeshed's stubs,
there's a possibility that the .py files might be found
in a different directory at runtime.
For example: pyopenssl has its .py files in the `src/OpenSSL/` directory at runtime,
but in typeshed the stubs are in the `OpenSSL/` directory.
"""
return bool(self.py_files_stubbed_in_typeshed)
@functools.cached_property
def public_files_added(self) -> Sequence[str]:
return [
file["filename"]
for file in self.py_files
if not re.match("_[^_]", Path(file["filename"]).name) and file["status"] == "added"
]
@functools.cached_property
def typeshed_files_deleted(self) -> Sequence[str]:
return [file["filename"] for file in self.py_files_stubbed_in_typeshed if file["status"] == "removed"]
@functools.cached_property
def typeshed_files_modified(self) -> Sequence[str]:
return [file["filename"] for file in self.py_files_stubbed_in_typeshed if file["status"] in {"modified", "renamed"}]
@property
def total_lines_added(self) -> int:
return sum(file["additions"] for file in self.py_files)
@property
def total_lines_deleted(self) -> int:
return sum(file["deletions"] for file in self.py_files)
def _describe_files(self, *, verb: str, filenames: Sequence[str]) -> str:
num_files = len(filenames)
if num_files > 1:
description = f"have been {verb}"
# Don't list the filenames if there are *loads* of files
if num_files <= self.MAXIMUM_NUMBER_OF_FILES_TO_LIST:
description += ": "
description += ", ".join(f"`{filename}`" for filename in filenames)
description += "."
return description
if num_files == 1:
return f"has been {verb}: `{filenames[0]}`."
return f"have been {verb}."
def describe_public_files_added(self) -> str:
num_files_added = len(self.public_files_added)
analysis = f"{num_files_added} public Python file{_plural_s(num_files_added)} "
analysis += self._describe_files(verb="added", filenames=self.public_files_added)
return analysis
def describe_typeshed_files_deleted(self) -> str:
num_files_deleted = len(self.typeshed_files_deleted)
analysis = f"{num_files_deleted} file{_plural_s(num_files_deleted)} included in typeshed's stubs "
analysis += self._describe_files(verb="deleted", filenames=self.typeshed_files_deleted)
return analysis
def describe_typeshed_files_modified(self) -> str:
num_files_modified = len(self.typeshed_files_modified)
analysis = f"{num_files_modified} file{_plural_s(num_files_modified)} included in typeshed's stubs "
analysis += self._describe_files(verb="modified or renamed", filenames=self.typeshed_files_modified)
return analysis
def __str__(self) -> str:
data_points = []
if self.runtime_definitely_has_consistent_directory_structure_with_typeshed:
data_points += [
self.describe_public_files_added(),
self.describe_typeshed_files_deleted(),
self.describe_typeshed_files_modified(),
]
data_points += [
f"Total lines of Python code added: {self.total_lines_added}.",
f"Total lines of Python code deleted: {self.total_lines_deleted}.",
]
return "Stubsabot analysis of the diff between the two releases:\n - " + "\n - ".join(data_points)
async def analyze_diff(
github_repo_path: str, stub_path: Path, old_tag: str, new_tag: str, *, session: aiohttp.ClientSession
) -> DiffAnalysis | None:
url = f"https://api.github.com/repos/{github_repo_path}/compare/{old_tag}...{new_tag}"
async with session.get(url, headers=get_github_api_headers()) as response:
response.raise_for_status()
json_resp = await response.json()
assert isinstance(json_resp, dict)
# https://docs.github.com/en/rest/commits/commits#compare-two-commits
py_files: list[FileInfo] = [file for file in json_resp["files"] if Path(file["filename"]).suffix == ".py"]
files_in_typeshed = set(stub_path.rglob("*.pyi"))
py_files_stubbed_in_typeshed = [file for file in py_files if (stub_path / f"{file['filename']}i") in files_in_typeshed]
return DiffAnalysis(py_files=py_files, py_files_stubbed_in_typeshed=py_files_stubbed_in_typeshed)
async def determine_action(stub_path: Path, session: aiohttp.ClientSession) -> Update | NoUpdate | Obsolete:
stub_info = read_typeshed_stub_metadata(stub_path)
if stub_info.obsolete:
return NoUpdate(stub_info.distribution, "obsolete")
if stub_info.no_longer_updated:
return NoUpdate(stub_info.distribution, "no longer updated")
pypi_info = await fetch_pypi_info(stub_info.distribution, session)
latest_release = pypi_info.get_latest_release()
latest_version = latest_release.version
spec = packaging.specifiers.SpecifierSet(f"=={stub_info.version_spec}")
if latest_version in spec:
return NoUpdate(stub_info.distribution, "up to date")
is_obsolete = await release_contains_py_typed(latest_release, session=session)
if is_obsolete:
first_release_with_py_typed = await find_first_release_with_py_typed(pypi_info, session=session)
relevant_version = version_obsolete_since = first_release_with_py_typed.version
else:
relevant_version = latest_version
project_urls = pypi_info.info["project_urls"] or {}
maybe_links: dict[str, str | None] = {
"Release": f"{pypi_info.pypi_root}/{relevant_version}",
"Homepage": project_urls.get("Homepage"),
"Changelog": project_urls.get("Changelog") or project_urls.get("Changes") or project_urls.get("Change Log"),
}
links = {k: v for k, v in maybe_links.items() if v is not None}
diff_info = await get_diff_info(session, stub_info, pypi_info, relevant_version)
if diff_info is not None:
github_repo_path, old_tag, new_tag, diff_url = diff_info
links["Diff"] = diff_url
if is_obsolete:
return Obsolete(
stub_info.distribution,
stub_path,
obsolete_since_version=str(version_obsolete_since),
obsolete_since_date=first_release_with_py_typed.upload_date,
links=links,
)
if diff_info is None:
diff_analysis: DiffAnalysis | None = None
else:
diff_analysis = await analyze_diff(
github_repo_path=github_repo_path, stub_path=stub_path, old_tag=old_tag, new_tag=new_tag, session=session
)
return Update(
distribution=stub_info.distribution,
stub_path=stub_path,
old_version_spec=stub_info.version_spec,
new_version_spec=get_updated_version_spec(stub_info.version_spec, latest_version),
links=links,
diff_analysis=diff_analysis,
)
TYPESHED_OWNER = "python"
@functools.lru_cache()
def get_origin_owner() -> str:
output = subprocess.check_output(["git", "remote", "get-url", "origin"], text=True).strip()
match = re.match(r"(git@github.com:|https://github.com/)(?P<owner>[^/]+)/(?P<repo>[^/\s]+)", output)
assert match is not None, f"Couldn't identify origin's owner: {output!r}"
assert match.group("repo").removesuffix(".git") == "typeshed", f'Unexpected repo: {match.group("repo")!r}'
return match.group("owner")
async def create_or_update_pull_request(*, title: str, body: str, branch_name: str, session: aiohttp.ClientSession) -> None:
fork_owner = get_origin_owner()
async with session.post(
f"https://api.github.com/repos/{TYPESHED_OWNER}/typeshed/pulls",
json={"title": title, "body": body, "head": f"{fork_owner}:{branch_name}", "base": "main"},
headers=get_github_api_headers(),
) as response:
resp_json = await response.json()
if response.status == 422 and any(
"A pull request already exists" in e.get("message", "") for e in resp_json.get("errors", [])
):
# Find the existing PR
async with session.get(
f"https://api.github.com/repos/{TYPESHED_OWNER}/typeshed/pulls",
params={"state": "open", "head": f"{fork_owner}:{branch_name}", "base": "main"},
headers=get_github_api_headers(),
) as response:
response.raise_for_status()
resp_json = await response.json()
assert len(resp_json) >= 1
pr_number = resp_json[0]["number"]
# Update the PR's title and body
async with session.patch(
f"https://api.github.com/repos/{TYPESHED_OWNER}/typeshed/pulls/{pr_number}",
json={"title": title, "body": body},
headers=get_github_api_headers(),
) as response:
response.raise_for_status()
return
response.raise_for_status()
def has_non_stubsabot_commits(branch: str) -> bool:
assert not branch.startswith("origin/")
try:
# commits on origin/branch that are not on branch or are
# patch equivalent to a commit on branch
print(
"[debugprint]",
subprocess.check_output(
["git", "log", "--right-only", "--pretty=%an %s", "--cherry-pick", f"{branch}...origin/{branch}"]
),
)
print(
"[debugprint]",
subprocess.check_output(
["git", "log", "--right-only", "--pretty=%an", "--cherry-pick", f"{branch}...origin/{branch}"]
),
)
output = subprocess.check_output(
["git", "log", "--right-only", "--pretty=%an", "--cherry-pick", f"{branch}...origin/{branch}"],
stderr=subprocess.DEVNULL,
)
return bool(set(output.splitlines()) - {b"stubsabot"})
except subprocess.CalledProcessError:
# origin/branch does not exist
return False
def latest_commit_is_different_to_last_commit_on_origin(branch: str) -> bool:
assert not branch.startswith("origin/")
try:
# https://www.git-scm.com/docs/git-range-diff
# If the number of lines is >1,
# it indicates that something about our commit is different to the last commit
# (Could be the commit "content", or the commit message).
commit_comparison = subprocess.run(
["git", "range-diff", f"origin/{branch}~1..origin/{branch}", "HEAD~1..HEAD"], check=True, capture_output=True
)
return len(commit_comparison.stdout.splitlines()) > 1
except subprocess.CalledProcessError:
# origin/branch does not exist
return True
class RemoteConflict(Exception):
pass
def somewhat_safe_force_push(branch: str) -> None:
if has_non_stubsabot_commits(branch):
raise RemoteConflict(f"origin/{branch} has non-stubsabot changes that are not on {branch}!")
subprocess.check_call(["git", "push", "origin", branch, "--force"])
def normalize(name: str) -> str:
# PEP 503 normalization
return re.sub(r"[-_.]+", "-", name).lower()
# lock should be unnecessary, but can't hurt to enforce mutual exclusion
_repo_lock = asyncio.Lock()
BRANCH_PREFIX = "stubsabot"
def get_update_pr_body(update: Update, metadata: dict[str, Any]) -> str:
body = "\n".join(f"{k}: {v}" for k, v in update.links.items())
if update.diff_analysis is not None:
body += f"\n\n{update.diff_analysis}"
stubtest_will_run = not metadata.get("stubtest", {}).get("skip", False)
if stubtest_will_run:
body += textwrap.dedent(
"""
If stubtest fails for this PR:
- Leave this PR open (as a reminder, and to prevent stubsabot from opening another PR)
- Fix stubtest failures in another PR, then close this PR
Note that you will need to close and re-open the PR in order to trigger CI
"""
)
else:
body += textwrap.dedent(
f"""
:warning: Review this PR manually, as stubtest is skipped in CI for {update.distribution}! :warning:
"""
)
return body
async def suggest_typeshed_update(update: Update, session: aiohttp.ClientSession, action_level: ActionLevel) -> None:
if action_level <= ActionLevel.nothing:
return
title = f"[stubsabot] Bump {update.distribution} to {update.new_version_spec}"
async with _repo_lock:
branch_name = f"{BRANCH_PREFIX}/{normalize(update.distribution)}"
subprocess.check_call(["git", "checkout", "-B", branch_name, "origin/main"])
with open(update.stub_path / "METADATA.toml", "rb") as f:
meta = tomlkit.load(f)
meta["version"] = update.new_version_spec
with open(update.stub_path / "METADATA.toml", "w", encoding="UTF-8") as f:
tomlkit.dump(meta, f)
body = get_update_pr_body(update, meta)
subprocess.check_call(["git", "commit", "--all", "-m", f"{title}\n\n{body}"])
if action_level <= ActionLevel.local:
return
if not latest_commit_is_different_to_last_commit_on_origin(branch_name):
print(f"No pushing to origin required: origin/{branch_name} exists and requires no changes!")
return
somewhat_safe_force_push(branch_name)
if action_level <= ActionLevel.fork:
return
await create_or_update_pull_request(title=title, body=body, branch_name=branch_name, session=session)
async def suggest_typeshed_obsolete(obsolete: Obsolete, session: aiohttp.ClientSession, action_level: ActionLevel) -> None:
if action_level <= ActionLevel.nothing:
return
title = f"[stubsabot] Mark {obsolete.distribution} as obsolete since {obsolete.obsolete_since_version}"
async with _repo_lock:
branch_name = f"{BRANCH_PREFIX}/{normalize(obsolete.distribution)}"
subprocess.check_call(["git", "checkout", "-B", branch_name, "origin/main"])
with open(obsolete.stub_path / "METADATA.toml", "rb") as f:
meta = tomlkit.load(f)
obs_string = tomlkit.string(obsolete.obsolete_since_version)
obs_string.comment(f"Released on {obsolete.obsolete_since_date.date().isoformat()}")
meta["obsolete_since"] = obs_string
with open(obsolete.stub_path / "METADATA.toml", "w", encoding="UTF-8") as f:
tomlkit.dump(meta, f)
body = "\n".join(f"{k}: {v}" for k, v in obsolete.links.items())
subprocess.check_call(["git", "commit", "--all", "-m", f"{title}\n\n{body}"])
if action_level <= ActionLevel.local:
return
if not latest_commit_is_different_to_last_commit_on_origin(branch_name):
print(f"No PR required: origin/{branch_name} exists and requires no changes!")
return
somewhat_safe_force_push(branch_name)
if action_level <= ActionLevel.fork:
return
await create_or_update_pull_request(title=title, body=body, branch_name=branch_name, session=session)
async def main() -> None:
assert sys.version_info >= (3, 9)
parser = argparse.ArgumentParser()
parser.add_argument(
"--action-level",
type=ActionLevel.from_cmd_arg,
default=ActionLevel.everything,
help="Limit actions performed to achieve dry runs for different levels of dryness",
)
parser.add_argument(
"--action-count-limit",
type=int,
default=None,
help="Limit number of actions performed and the remainder are logged. Useful for testing",
)
args = parser.parse_args()
if args.action_level > ActionLevel.nothing:
subprocess.run(["git", "update-index", "--refresh"], capture_output=True)
diff_result = subprocess.run(["git", "diff-index", "HEAD", "--name-only"], text=True, capture_output=True)
if diff_result.returncode:
print("Unexpected exception!")
print(diff_result.stdout)
print(diff_result.stderr)
sys.exit(diff_result.returncode)
if diff_result.stdout:
changed_files = ", ".join(repr(line) for line in diff_result.stdout.split("\n") if line)
print(f"Cannot run stubsabot, as uncommitted changes are present in {changed_files}!")
sys.exit(1)
if args.action_level > ActionLevel.fork:
if os.environ.get("GITHUB_TOKEN") is None:
raise ValueError("GITHUB_TOKEN environment variable must be set")
denylist = {"gdb"} # gdb is not a pypi distribution
original_branch = subprocess.run(
["git", "branch", "--show-current"], text=True, capture_output=True, check=True
).stdout.strip()
if args.action_level >= ActionLevel.fork:
subprocess.check_call(["git", "fetch", "--prune", "--all"])
try:
conn = aiohttp.TCPConnector(limit_per_host=10)
async with aiohttp.ClientSession(connector=conn) as session:
tasks = [
asyncio.create_task(determine_action(stubs_path, session))
for stubs_path in Path("stubs").iterdir()
if stubs_path.name not in denylist
]
action_count = 0
for task in asyncio.as_completed(tasks):
update = await task
print(update)
if isinstance(update, NoUpdate):
continue
if args.action_count_limit is not None and action_count >= args.action_count_limit:
print(colored("... but we've reached action count limit", "red"))
continue
action_count += 1
try:
if isinstance(update, Update):
await suggest_typeshed_update(update, session, action_level=args.action_level)
continue
if isinstance(update, Obsolete):
await suggest_typeshed_obsolete(update, session, action_level=args.action_level)
continue
except RemoteConflict as e:
print(colored(f"... but ran into {type(e).__qualname__}: {e}", "red"))
continue
raise AssertionError
finally:
# if you need to cleanup, try:
# git branch -D $(git branch --list 'stubsabot/*')
if args.action_level >= ActionLevel.local:
subprocess.check_call(["git", "checkout", original_branch])
if __name__ == "__main__":
asyncio.run(main())
|