mirror of
https://github.com/lancedb/lancedb.git
synced 2026-10-14 15:52:26 +00:00
Xuanwo
255da8a854
Native job metadata types report `builtins` as their module, so Griffe cannot resolve the public `lancedb.job` re-exports and the Python API reference build fails. Set the PyO3 module metadata for `JobInfo`, `JobDescription`, and `JobFailureInfo`, and cover import resolution in the existing package metadata tests. Reproduced the failure and validated the fix with the docs CI toolchain (`griffe==0.49.0`, `mkdocstrings==0.25.2`, and `mkdocstrings-python==1.10.9`). After rebuilding the native extension, the full `PYTHONPATH=. mkdocs build` succeeds and all three classes and their public members appear in the generated reference.
52 lines
1.8 KiB
Python
52 lines
1.8 KiB
Python
# SPDX-License-Identifier: Apache-2.0
|
|
# SPDX-FileCopyrightText: Copyright The LanceDB Authors
|
|
|
|
import importlib
|
|
import re
|
|
import sys
|
|
from pathlib import Path
|
|
|
|
import pytest
|
|
|
|
|
|
@pytest.mark.parametrize("name", ["JobInfo", "JobDescription", "JobFailureInfo"])
|
|
def test_job_metadata_types_have_resolvable_modules(name):
|
|
"""Documentation tools resolve re-exports through each type's module."""
|
|
public_type = getattr(importlib.import_module("lancedb.job"), name)
|
|
defining_module = importlib.import_module(public_type.__module__)
|
|
|
|
assert getattr(defining_module, public_type.__name__, None) is public_type
|
|
|
|
|
|
def test_pyo3_abi_matches_minimum_supported_python():
|
|
project_dir = Path(__file__).parents[2]
|
|
pyproject = (project_dir / "pyproject.toml").read_text()
|
|
cargo_manifest = (project_dir / "Cargo.toml").read_text()
|
|
|
|
minimum_python = re.search(
|
|
r'^requires-python\s*=\s*">=(\d+)\.(\d+)"$', pyproject, re.MULTILINE
|
|
)
|
|
assert minimum_python is not None
|
|
|
|
major, minor = minimum_python.groups()
|
|
expected_abi = f"abi3-py{major}{minor}"
|
|
configured_abis = re.findall(r'"(abi3-py\d+)"', cargo_manifest)
|
|
|
|
assert configured_abis == [expected_abi, expected_abi], (
|
|
"the pyo3 runtime and build ABI features must both match requires-python"
|
|
)
|
|
|
|
|
|
@pytest.mark.skipif(sys.platform != "win32", reason="Windows wheel regression test")
|
|
def test_windows_wheel_tag_and_native_import():
|
|
project_dir = Path(__file__).parents[2]
|
|
wheels = list((project_dir.parent / "target" / "wheels").glob("lancedb-*.whl"))
|
|
if not wheels:
|
|
pytest.skip("no wheel artifact is available in this development environment")
|
|
|
|
assert len(wheels) == 1
|
|
assert wheels[0].name.endswith("-cp310-abi3-win_amd64.whl")
|
|
|
|
native_module = importlib.import_module("lancedb._lancedb")
|
|
assert Path(native_module.__file__).suffix == ".pyd"
|