mirror of
https://github.com/lancedb/lancedb.git
synced 2026-10-20 18:52:28 +00:00
Tobias
1ad97b148b
Closes #4246. lancedb publishes no source distribution, so a platform without a prebuilt wheel (#4104, #4239) has nothing to install. This adds an sdist to the Python release. ## The sdist job The release workflow builds an sdist with the maturin version of the wheel jobs. On a tag, the publish job uploads it with the wheels: to PyPI, and to Fury for beta tags. The job also runs on the pull request dry run, which now starts on a change to `python/pyproject.toml`. ## Checks - The job builds a wheel from the sdist with `--locked` and smoke-tests it in a fresh venv. - `ci/check_sdist.py` fails if a tracked file of the Python package is missing from the tarball. - `twine check --strict` checks that the metadata renders. `pydistcheck` enforces PyPI's 100 MiB size limit. - The unit tests of both check scripts run in the CI scripts workflow. ## Cargo.lock maturin ships the repository lockfile, which pins crates that only the dropped `nodejs` member uses, so `cargo --locked` fails (PyO3/maturin#2609). The job first runs `cargo metadata --locked` on the repository workspace, so a lockfile that has drifted from `Cargo.toml` fails there. It then removes the nodejs-only pins and repacks the sdist. `ci/check_cargo_lock.py` fails if the prune changes any package it keeps, or any dependency of one. The published file is the repacked one. ## Behavior change After the first release with an sdist, pip on a platform with no current wheel builds the newest version from source, which needs a Rust toolchain and `protoc`. Before, pip installed the last version with a wheel for that platform.
72 lines
2.8 KiB
Python
72 lines
2.8 KiB
Python
import subprocess
|
|
import sys
|
|
import tarfile
|
|
import tempfile
|
|
import unittest
|
|
from pathlib import Path
|
|
|
|
REPO_ROOT = Path(__file__).resolve().parents[2]
|
|
SCRIPT = REPO_ROOT / "ci" / "check_sdist.py"
|
|
ROOT = "lancedb-1.0.0"
|
|
|
|
|
|
class CheckSdistTest(unittest.TestCase):
|
|
def run_check(self, tracked, shipped, links=(), root=ROOT):
|
|
"""Run the check in a git repo tracking `tracked`, on an sdist holding `shipped`
|
|
as files and `links` as symlinks, under the folder `root`."""
|
|
with tempfile.TemporaryDirectory() as tmp:
|
|
subprocess.run(["git", "init", "-q", tmp], check=True)
|
|
for name in tracked:
|
|
path = Path(tmp, "python/python/lancedb", name)
|
|
path.parent.mkdir(parents=True, exist_ok=True)
|
|
path.write_text("x = 1\n")
|
|
if tracked:
|
|
subprocess.run(["git", "-C", tmp, "add", "."], check=True)
|
|
sdist = Path(tmp, f"{ROOT}.tar.gz")
|
|
with tarfile.open(sdist, "w:gz") as tar:
|
|
for name in shipped:
|
|
member = Path(tmp, "member")
|
|
member.write_text("x = 1\n")
|
|
tar.add(member, arcname=f"{root}/python/lancedb/{name}")
|
|
for name in links:
|
|
link = tarfile.TarInfo(f"{root}/python/lancedb/{name}")
|
|
link.type = tarfile.SYMTYPE
|
|
link.linkname = "__init__.py"
|
|
tar.addfile(link)
|
|
return subprocess.run(
|
|
[sys.executable, SCRIPT, sdist],
|
|
cwd=tmp,
|
|
capture_output=True,
|
|
text=True,
|
|
)
|
|
|
|
def test_complete_sdist_passes(self):
|
|
result = self.run_check(["__init__.py", "db.py"], ["__init__.py", "db.py"])
|
|
self.assertEqual(result.returncode, 0, result.stderr)
|
|
|
|
def test_missing_tracked_file_fails(self):
|
|
result = self.run_check(["__init__.py", "db.py"], ["__init__.py"])
|
|
self.assertNotEqual(result.returncode, 0)
|
|
self.assertIn("python/python/lancedb/db.py", result.stderr)
|
|
|
|
def test_tracked_file_shipped_as_symlink_fails(self):
|
|
result = self.run_check(
|
|
["__init__.py", "db.py"], ["__init__.py"], links=["db.py"]
|
|
)
|
|
self.assertNotEqual(result.returncode, 0)
|
|
self.assertIn("python/python/lancedb/db.py", result.stderr)
|
|
|
|
def test_files_outside_the_sdist_root_fail(self):
|
|
result = self.run_check(["__init__.py"], ["__init__.py"], root="other-1.0.0")
|
|
self.assertNotEqual(result.returncode, 0)
|
|
self.assertIn("python/python/lancedb/__init__.py", result.stderr)
|
|
|
|
def test_no_tracked_files_fails(self):
|
|
result = self.run_check([], ["__init__.py"])
|
|
self.assertNotEqual(result.returncode, 0)
|
|
self.assertIn("git tracks no files", result.stderr)
|
|
|
|
|
|
if __name__ == "__main__":
|
|
unittest.main()
|