Skip to content

fix(python): only bundle the DiskANN plugin where it is supported #510

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

Merged
feihongxu0824 merged 2 commits into from
Jun 23, 2026
+16 −3
Merged

fix(python): only bundle the DiskANN plugin where it is supported #510

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a6588ee
fix(python): only bundle the DiskANN plugin where it is supported
Cuiyus Jun 22, 2026
ad1a0b3
chore(python): ignore compiled extension artifacts under python/zvec
Cuiyus Jun 22, 2026
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
8 changes: 8 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,14 @@ dist
html
*.lcov.info

# Compiled extension modules must never live in the source package: they are
# built by CMake and installed into the wheel. A stray copy left here gets
# bundled verbatim by scikit-build's wheel.packages and breaks the wheel
# (e.g. a stale binary with the wrong macOS deployment target).
python/zvec/*.so
python/zvec/*.dylib
python/zvec/*.pyd

# Dependencies
/node_modules

Expand Down
11 changes: 8 additions & 3 deletions CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -183,9 +183,14 @@ if(BUILD_PYTHON_BINDINGS)
# function. The Python extension resolves the module next to _zvec.so
# (see the $ORIGIN rpath in src/binding/python/CMakeLists.txt); the
# module must therefore be installed alongside _zvec.so in the wheel.
# The target exists only on platforms where DiskAnn is buildable
# (currently Linux x86_64 with libaio).
if(TARGET core_knn_diskann)
#
# Gate on DISKANN_SUPPORTED, not on the target's existence: on unsupported
# platforms (e.g. macOS / ARM64) the core_knn_diskann target is still
# defined, but built from an empty stub (src/core/algorithm/CMakeLists.txt)
# with zero exported symbols and a runtime load path compiled out
# (#if DISKANN_SUPPORTED). Shipping that stub is pure dead weight, so it is
# only packaged where DiskAnn is real — currently Linux x86_64 with libaio.
if(DISKANN_SUPPORTED)
install(TARGETS core_knn_diskann LIBRARY DESTINATION ${ZVEC_PY_INSTALL_DIR}
COMPONENT python)
endif()
Expand Down
Loading