Skip to content

Use pip to detect if common wheels need regenerating in nox #13770

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
notatallshaw wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Use pip to detect if common wheels need regenerating in nox #13770

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 37 additions & 2 deletions noxfile.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,14 @@ def run_with_protected_pip(session: nox.Session, *arguments: str) -> None:
session.run_install(*command, env=env, silent=True)


def should_update_common_wheels() -> bool:
def should_update_common_wheels(session: nox.Session) -> bool:
"""Determine if the common wheels cache needs to be updated.

The cache is invalidated if:
1. It doesn't exist yet
2. pyproject.toml was modified after the cache was created
3. The cached wheels cannot satisfy the current Python version's requirements
"""
# If the cache hasn't been created, create it.
if not os.path.exists(LOCATIONS["common-wheels"]):
return True
Expand All @@ -54,6 +61,34 @@ def should_update_common_wheels() -> bool:
pyproject_updated_at = os.path.getmtime("pyproject.toml")
need_to_repopulate = pyproject_updated_at > cache_last_populated_at

if not need_to_repopulate:
# Check all common wheels are available for the current Python version,
# by using --ignore-installed and --dry-run against the common-wheels
# directory.
result = session.run(
"python",
LOCATIONS["protected-pip"],
"install",
"--dry-run",
"--ignore-installed",
"--no-index",
"--find-links",
LOCATIONS["common-wheels"],
"--group",
"test-common-wheels",
env={"VIRTUAL_ENV": session.virtualenv.location},
silent=True,
success_codes=[0, 1], # Accept both success and failure and check result
)

# Result is the stdout of the pip install command.
if result is None or "Would install" not in result:
session.log(
"Regenerating common wheels as cached wheels "
"cannot satisfy test-common-wheels"
)
need_to_repopulate = True

# Clear the stale cache.
if need_to_repopulate:
shutil.rmtree(LOCATIONS["common-wheels"], ignore_errors=True)
Expand All @@ -67,7 +102,7 @@ def should_update_common_wheels() -> bool:
@nox.session(python=["3.9", "3.10", "3.11", "3.12", "3.13", "3.14", "pypy3"])
def test(session: nox.Session) -> None:
# Get the common wheels.
if should_update_common_wheels():
if should_update_common_wheels(session):
# fmt: off
run_with_protected_pip(
session,
Expand Down