mirror of
https://github.com/astral-sh/uv.git
synced 2025-07-08 05:45:00 +00:00
e69b76bc72
## Summary This PR attempts to use a similar trick to that we added in https://github.com/astral-sh/uv/pull/1878, but for post-releases. In https://github.com/astral-sh/uv/pull/1878, we added a fake "minimum" version to enable us to treat `< 1.0.0` as _excluding_ pre-releases of 1.0.0. Today, on `main`, we accept post-releases and local versions in `> 1.0.0`. But per PEP 440, that should _exclude_ post-releases and local versions, unless the specifier is itself a pre-release, in which case, pre-releases are allowed (e.g., `> 1.0.0.post0` should allow `> 1.0.0.post1`). To support this, we add a fake "maximum" version that's greater than all the post and local releases for a given version. This leverages our last remaining free bit in the compact representation.
276 lines
8.1 KiB
Python
Executable file
276 lines
8.1 KiB
Python
Executable file
#!/usr/bin/env python3
|
|
"""
|
|
Generates and updates snapshot test cases from packse scenarios.
|
|
|
|
Important:
|
|
|
|
This script is the backend called by `./scripts/scenarios/sync.sh`, consider using that
|
|
if not developing scenarios.
|
|
|
|
Requirements:
|
|
|
|
$ uv pip install -r scripts/scenarios/requirements.txt
|
|
|
|
Uses `git`, `rustfmt`, and `cargo insta test` requirements from the project.
|
|
|
|
Usage:
|
|
|
|
Regenerate the scenario test files using the given scenarios:
|
|
|
|
$ ./scripts/scenarios/generate.py <path>
|
|
|
|
Scenarios can be developed locally with the following workflow:
|
|
|
|
Serve scenarios on a local index using packse
|
|
|
|
$ packse serve --no-hash <path to scenarios>
|
|
|
|
Override the uv package index and update the tests
|
|
|
|
$ UV_INDEX_URL="http://localhost:3141" ./scripts/scenarios/generate.py <path to scenarios>
|
|
|
|
If an editable version of packse is installed, this script will use its bundled scenarios by default.
|
|
|
|
Use
|
|
|
|
"""
|
|
|
|
import argparse
|
|
import importlib.metadata
|
|
import logging
|
|
import os
|
|
import subprocess
|
|
import sys
|
|
import textwrap
|
|
from pathlib import Path
|
|
|
|
TOOL_ROOT = Path(__file__).parent
|
|
TEMPLATES = TOOL_ROOT / "templates"
|
|
INSTALL_TEMPLATE = TEMPLATES / "install.mustache"
|
|
COMPILE_TEMPLATE = TEMPLATES / "compile.mustache"
|
|
PACKSE = TOOL_ROOT / "packse-scenarios"
|
|
REQUIREMENTS = TOOL_ROOT / "requirements.txt"
|
|
PROJECT_ROOT = TOOL_ROOT.parent.parent
|
|
TESTS = PROJECT_ROOT / "crates" / "uv" / "tests"
|
|
INSTALL_TESTS = TESTS / "pip_install_scenarios.rs"
|
|
COMPILE_TESTS = TESTS / "pip_compile_scenarios.rs"
|
|
|
|
try:
|
|
import packse
|
|
import packse.inspect
|
|
except ImportError:
|
|
print(
|
|
f"missing requirement `packse`: install the requirements at {REQUIREMENTS.relative_to(PROJECT_ROOT)}",
|
|
file=sys.stderr,
|
|
)
|
|
exit(1)
|
|
|
|
|
|
try:
|
|
import chevron_blue
|
|
except ImportError:
|
|
print(
|
|
f"missing requirement `chevron-blue`: install the requirements at {REQUIREMENTS.relative_to(PROJECT_ROOT)}",
|
|
file=sys.stderr,
|
|
)
|
|
exit(1)
|
|
|
|
|
|
def main(scenarios: list[Path], snapshot_update: bool = True):
|
|
# Fetch packse version
|
|
packse_version = importlib.metadata.version("packse")
|
|
|
|
debug = logging.getLogger().getEffectiveLevel() <= logging.DEBUG
|
|
|
|
if not scenarios:
|
|
if packse_version == "0.0.0":
|
|
path = packse.__development_base_path__ / "scenarios"
|
|
if path.exists():
|
|
logging.info(
|
|
"Detected development version of packse, using scenarios from %s",
|
|
path,
|
|
)
|
|
scenarios = path.glob("*.json")
|
|
else:
|
|
logging.error(
|
|
"No scenarios provided. Found development version of packse but is missing scenarios. Is it installed as an editable?"
|
|
)
|
|
sys.exit(1)
|
|
else:
|
|
logging.error("No scenarios provided, nothing to do.")
|
|
return
|
|
|
|
targets = []
|
|
for target in scenarios:
|
|
if target.is_dir():
|
|
targets.extend(target.glob("*.json"))
|
|
else:
|
|
targets.append(target)
|
|
|
|
logging.info("Loading scenario metadata...")
|
|
data = packse.inspect.inspect(
|
|
targets=targets,
|
|
no_hash=True,
|
|
)
|
|
|
|
data["scenarios"] = [
|
|
scenario
|
|
for scenario in data["scenarios"]
|
|
# Drop the example scenario
|
|
if scenario["name"] != "example"
|
|
]
|
|
|
|
# Wrap the description onto multiple lines
|
|
for scenario in data["scenarios"]:
|
|
scenario["description_lines"] = textwrap.wrap(scenario["description"], width=80)
|
|
|
|
# Wrap the expected explanation onto multiple lines
|
|
for scenario in data["scenarios"]:
|
|
expected = scenario["expected"]
|
|
expected["explanation_lines"] = (
|
|
textwrap.wrap(expected["explanation"], width=80)
|
|
if expected["explanation"]
|
|
else []
|
|
)
|
|
|
|
|
|
for scenario in data["scenarios"]:
|
|
expected = scenario["expected"]
|
|
|
|
# TODO(charlie): We do not yet support local version identifiers
|
|
if scenario["name"] in (
|
|
"local-less-than-or-equal",
|
|
"local-simple",
|
|
"local-transitive-confounding",
|
|
"local-transitive-backtrack",
|
|
"local-used-with-sdist",
|
|
"local-used-without-sdist",
|
|
"local-transitive",
|
|
"local-transitive-less-than-or-equal",
|
|
):
|
|
expected["satisfiable"] = False
|
|
expected[
|
|
"explanation"
|
|
] = "We do not have correct behavior for local version identifiers yet"
|
|
|
|
# Split scenarios into `install` and `compile` cases
|
|
install_scenarios = []
|
|
compile_scenarios = []
|
|
|
|
for scenario in data["scenarios"]:
|
|
if (scenario["resolver_options"] or {}).get("python") is not None:
|
|
compile_scenarios.append(scenario)
|
|
else:
|
|
install_scenarios.append(scenario)
|
|
|
|
for template, tests, scenarios in [
|
|
(INSTALL_TEMPLATE, INSTALL_TESTS, install_scenarios),
|
|
(COMPILE_TEMPLATE, COMPILE_TESTS, compile_scenarios),
|
|
]:
|
|
data = {"scenarios": scenarios}
|
|
|
|
ref = "HEAD" if packse_version == "0.0.0" else packse_version
|
|
|
|
# Add generated metadata
|
|
data[
|
|
"generated_from"
|
|
] = f"https://github.com/zanieb/packse/tree/{ref}/scenarios"
|
|
data["generated_with"] = "./scripts/scenarios/sync.sh"
|
|
data[
|
|
"vendor_links"
|
|
] = f"https://raw.githubusercontent.com/zanieb/packse/{ref}/vendor/links.html"
|
|
|
|
data["index_url"] = f"https://astral-sh.github.io/packse/{ref}/simple-html/"
|
|
|
|
# Render the template
|
|
logging.info(f"Rendering template {template.name}")
|
|
output = chevron_blue.render(
|
|
template=template.read_text(), data=data, no_escape=True, warn=True
|
|
)
|
|
|
|
# Update the test files
|
|
logging.info(
|
|
f"Updating test file at `{tests.relative_to(PROJECT_ROOT)}`...",
|
|
)
|
|
with open(tests, "wt") as test_file:
|
|
test_file.write(output)
|
|
|
|
# Format
|
|
logging.info(
|
|
"Formatting test file...",
|
|
)
|
|
subprocess.check_call(
|
|
["rustfmt", str(tests)],
|
|
stderr=subprocess.STDOUT,
|
|
stdout=sys.stderr if debug else subprocess.DEVNULL,
|
|
)
|
|
|
|
# Update snapshots
|
|
if snapshot_update:
|
|
logging.info("Updating snapshots...")
|
|
env = os.environ.copy()
|
|
env["UV_TEST_PYTHON_PATH"] = str(PROJECT_ROOT / "bin")
|
|
subprocess.call(
|
|
[
|
|
"cargo",
|
|
"insta",
|
|
"test",
|
|
"--features",
|
|
"pypi,python",
|
|
"--accept",
|
|
"--test-runner",
|
|
"nextest",
|
|
"--test",
|
|
tests.with_suffix("").name,
|
|
],
|
|
cwd=PROJECT_ROOT,
|
|
stderr=subprocess.STDOUT,
|
|
stdout=sys.stderr if debug else subprocess.DEVNULL,
|
|
env=env,
|
|
)
|
|
else:
|
|
logging.info("Skipping snapshot update")
|
|
|
|
logging.info("Done!")
|
|
|
|
|
|
if __name__ == "__main__":
|
|
parser = argparse.ArgumentParser(
|
|
description="Generates and updates snapshot test cases from packse scenarios.",
|
|
)
|
|
parser.add_argument(
|
|
"scenarios",
|
|
type=Path,
|
|
nargs="*",
|
|
help="The scenario files to use",
|
|
)
|
|
parser.add_argument(
|
|
"-v",
|
|
"--verbose",
|
|
action="store_true",
|
|
help="Enable debug logging",
|
|
)
|
|
parser.add_argument(
|
|
"-q",
|
|
"--quiet",
|
|
action="store_true",
|
|
help="Disable logging",
|
|
)
|
|
|
|
parser.add_argument(
|
|
"--no-snapshot-update",
|
|
action="store_true",
|
|
help="Disable automatic snapshot updates",
|
|
)
|
|
|
|
args = parser.parse_args()
|
|
if args.quiet:
|
|
log_level = logging.CRITICAL
|
|
elif args.verbose:
|
|
log_level = logging.DEBUG
|
|
else:
|
|
log_level = logging.INFO
|
|
|
|
logging.basicConfig(level=log_level, format="%(message)s")
|
|
|
|
main(args.scenarios, snapshot_update=not args.no_snapshot_update)
|