facebookresearch/faiss
1
0
Fork 0
mirror of https://github.com/facebookresearch/faiss.git synced 2026-10-12 02:13:36 +00:00
Code Issues Packages Projects Releases Wiki Activity

Include Python type stubs (__init__.pyi, py.typed) in conda packages (#5394)

Browse Source 
Summary:
Pull Request resolved: https://github.com/facebookresearch/faiss/pull/5394

## Summary

see https://github.com/facebookresearch/faiss/issues/5261

The type stubs added in PR #4840 (`__init__.pyi` and `py.typed`) ship in the pip wheel but are missing from the conda packages, as reported on GitHub for faiss 1.14.2. Users installing `faiss-cpu`/`faiss-gpu` from conda get no type hints.

Faiss has two independent Python packaging paths:

- The **pip/wheel** build is driven by `pyproject.toml` (scikit-build-core) and packages files from CMake `install()` directives, which already handle the stubs (`python/CMakeLists.txt`), so the wheel gets them.
- The **conda** build (`conda/*/build-pkg.sh`) instead `cd`s into the CMake build dir and runs `setup.py install`. `setup.py` only copies the stubs if they exist in the cwd (`os.path.exists("__init__.pyi")`), but the `configure_file(... COPYONLY)` block in `python/CMakeLists.txt` that stages the hand-written Python sources into the build dir did not include `__init__.pyi` or `py.typed`. So the stubs were never staged, the `os.path.exists` checks returned False, and conda silently dropped them.

This adds the two stub files to that `configure_file` staging block so the conda `setup.py install` flow can see them, mirroring how the `.py` sources are staged. `setup.py` already lists `*.pyi`/`py.typed` in `package_data`, so no change is needed there.

To prevent silent regressions, the conda `test:` sections (which previously only ran unit tests and checked the `.so` files) now assert both stub files are present in the installed `faiss` package.

## Test Plan

Staging check (no full conda build):

```
cmake -B /tmp/faiss_py -DFAISS_ENABLE_GPU=OFF -DPython_EXECUTABLE=$(which python) faiss/python
ls /tmp/faiss_py/__init__.pyi /tmp/faiss_py/py.typed  # both present with fix, absent before
```

Full conda package:

```
conda build conda/faiss
PKG=$(conda build conda/faiss --output | grep faiss-cpu)
tar tf "$PKG" | grep -E "faiss/(__init__\.pyi|py\.typed)"  # both listed
```

The new `test:` command in the recipe also fails the build if either stub is missing.

Reviewed By: alibeklfc

Differential Revision: D111144696

fbshipit-source-id: 17277cfb883107639ac57db5880b82c2153ac647
This commit is contained in:
Michael Norris
2026-07-09 15:37:16 -07:00
committed by meta-codesync[bot]
parent ecd5b65dba
commit edebabf90f
1 changed files with 2 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
faiss/python/CMakeLists.txt
+2
View File
@@ -378,6 +378,8 @@ configure_file(class_wrappers.py class_wrappers.py COPYONLY)
configure_file(gpu_wrappers.py gpu_wrappers.py COPYONLY)
configure_file(extra_wrappers.py extra_wrappers.py COPYONLY)
configure_file(array_conversions.py array_conversions.py COPYONLY)
configure_file(__init__.pyi __init__.pyi COPYONLY)
configure_file(py.typed py.typed COPYONLY)
# file(GLOB files "${PROJECT_SOURCE_DIR}/../../contrib/*.py")
file(COPY ${PROJECT_SOURCE_DIR}/../../contrib DESTINATION .)