Merge branch '358-python-api-metadata'

Author: Denis Jelovina

.github/workflows/pyalp-publish.yml

@@ -85,6 +85,12 @@ jobs:
             # Use a per-ABI build directory to avoid cross-ABI contamination
             ABI_TAG=$(python -c 'import sys; print(f"cp{sys.version_info[0]}{sys.version_info[1]}")')
             BUILD_DIR="build/${ABI_TAG}"
+            # Export the per-ABI build dir so setup.py (inside the wheel build) can find
+            # the CMake-generated metadata file. cibuildwheel runs this before_build
+            # inside the container and environment variables exported here are visible
+            # to the subsequent packaging steps in that container.
+            export CMAKE_BUILD_DIR="${BUILD_DIR}"
+            echo "[cibw] Exported CMAKE_BUILD_DIR=${CMAKE_BUILD_DIR}"
             # Enable NUMA on Linux runners (for linux wheels), keep disabled elsewhere.
             if [ "$(uname -s)" = "Linux" ]; 
             then
@@ -148,6 +154,14 @@ jobs:
             LTO_FLAG="-DCMAKE_INTERPROCEDURAL_OPTIMIZATION=OFF"
             cmake -S . -B "${BUILD_DIR}" -G Ninja -DCMAKE_BUILD_TYPE=Release -DENABLE_PYALP=ON -DCMAKE_POSITION_INDEPENDENT_CODE=ON -DCMAKE_FIND_FRAMEWORK=NEVER ${MACOS_FLAGS} ${NUMA_FLAG} ${CMAKE_PREFIX_HINT:-} ${OSX_DEPLOY_FLAG:-} ${PORTABLE_FLAG} ${LTO_FLAG} -DPython3_EXECUTABLE="${PYEXEC}"
             cmake --build "${BUILD_DIR}" --target pyalp_ref --parallel
+            # Debug: show the generated metadata file (if present) to the CI logs
+            echo "[cibw] Checking for generated metadata file: ${CMAKE_BUILD_DIR}/pyalp_metadata.py"
+            if [ -f "${CMAKE_BUILD_DIR}/pyalp_metadata.py" ]; then
+              echo "[cibw] Found metadata file:"; ls -l "${CMAKE_BUILD_DIR}/pyalp_metadata.py"
+              echo "[cibw] First 100 lines of metadata:"; sed -n '1,100p' "${CMAKE_BUILD_DIR}/pyalp_metadata.py" || true
+            else
+              echo "[cibw] Metadata file not found at ${CMAKE_BUILD_DIR}/pyalp_metadata.py"
+            fi
         run: |
           # Build from repository root so the full CMake project is available in the container
           python -m cibuildwheel --output-dir wheelhouse .

.gitignore

@@ -9,4 +9,5 @@ paths.mk
 [Oo]bj*/
 [Ii]nstall*/
 cmake-build-*/
-.venv/
+.venv/
+pyalp/src/pyalp.egg-info/

pyalp/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "pyalp"
-version = "0.0.0"
+version = "0.8.1"
 description = "Python bindings for ALP GraphBLAS (minimal package layout)"
 authors = [ { name = "ALP" } ]
 readme = "README.md"

pyalp/setup.py

@@ -6,6 +6,7 @@
 import glob
 import shutil
 import sysconfig
+import pathlib
 bdist_wheel_cmd = None
 try:
     # Used to mark wheel as non-pure when bundling a prebuilt .so
@@ -66,6 +67,38 @@ def build_extension(self, ext):
             raise RuntimeError("Prebuilt pyalp shared object not found during build_ext")
         shutil.copyfile(src, target_path)
 
+        # The _metadata.py file is generated by CMake in the build directory.
+        # We need to find it and copy it to the same directory as the extension.
+        ext_build_dir = os.path.dirname(target_path)
+        # CMAKE_BUILD_DIR is set by the cibuildwheel before_build script to the per-ABI build directory
+        cmake_build_dir = os.environ.get("CMAKE_BUILD_DIR")
+        if cmake_build_dir:
+            metadata_src_path = os.path.join(cmake_build_dir, "pyalp_metadata.py")
+            metadata_dest_path = os.path.join(ext_build_dir, "_metadata.py")
+            if os.path.exists(metadata_src_path):
+                print(f"Copying generated metadata from {metadata_src_path} to {metadata_dest_path}")
+                shutil.copyfile(metadata_src_path, metadata_dest_path)
+            else:
+                print(f"Warning: Generated metadata file not found at {metadata_src_path}. Skipping copy.")
+        else:
+            # Fall back: try to locate the generated metadata under any per-ABI
+            # build directory (e.g. ../build/cp310, ../build/cp39, ...).
+            # This avoids relying strictly on the CMAKE_BUILD_DIR env var which
+            # may not always be propagated into the isolated build environment.
+            search_pattern = os.path.join(here, '..', 'build', '**', 'pyalp_metadata.py')
+            candidates = glob.glob(search_pattern, recursive=True)
+            # Prefer candidate matching the current Python ABI tag if present
+            py_tag = f"cp{sys.version_info[0]}{sys.version_info[1]}"
+            matching = [c for c in candidates if py_tag in os.path.basename(os.path.dirname(c)) or py_tag in os.path.basename(c)]
+            chosen = (matching or candidates)[:1]
+            if chosen:
+                metadata_src_path = os.path.abspath(chosen[0])
+                metadata_dest_path = os.path.join(ext_build_dir, "_metadata.py")
+                print(f"Copying generated metadata from {metadata_src_path} to {metadata_dest_path} (discovered by glob search)")
+                shutil.copyfile(metadata_src_path, metadata_dest_path)
+            else:
+                print("Warning: CMAKE_BUILD_DIR not set and no generated metadata found under ../build. Skipping metadata file copy.")
+
 if prebuilt_so:
     if not os.path.exists(prebuilt_so):
         raise FileNotFoundError(f"PREBUILT_PYALP_SO set but file not found: {prebuilt_so}")
@@ -92,10 +125,13 @@ def build_extension(self, ext):
 
 setup_kwargs = {
     "name": "pyalp",
-    "version": "0.0.0",
+    "version": "0.8.1",
     "description": "pyalp package (C++ bindings)",
     "packages": find_packages(where="src"),
     "package_dir": {"": "src"},
+    # Ensure generated metadata is included in the wheel. The build process
+    # will copy the generated file to the package build dir as `_metadata.py`.
+    "package_data": {"pyalp": ["_metadata.py"]},
     "ext_modules": ext_modules,
     "include_package_data": True,
 }

pyalp/src/CMakeLists.txt

@@ -109,3 +109,43 @@ if( WITH_NONBLOCKING_BACKEND )
 
 endif()
 
+# --- Metadata generation ---
+# These variables are expected to be set by the top-level CMakeLists.txt,
+# but we provide defaults for standalone builds.
+if(NOT DEFINED pyalp_VERSION)
+    set(pyalp_VERSION "0.0.0")
+endif()
+if(NOT DEFINED ALP_VERSION)
+    set(ALP_VERSION "unknown")
+endif()
+if(NOT DEFINED ALP_BUILD_TYPE)
+    set(ALP_BUILD_TYPE "unknown")
+endif()
+if(NOT DEFINED ALP_GIT_COMMIT_SHA)
+    set(ALP_GIT_COMMIT_SHA "unknown")
+endif()
+if(NOT DEFINED ALP_GIT_BRANCH)
+    set(ALP_GIT_BRANCH "unknown")
+endif()
+
+# Get Python and pybind11 versions
+find_package(PythonInterp REQUIRED)
+set(PYTHON_VERSION ${PYTHON_VERSION_STRING})
+set(pybind11_VERSION ${pybind11_VERSION})
+
+# This is a simplified list. A more robust solution would inspect the build targets.
+set(pyalp_ALGORITHMS "conjugate_gradient")
+set(pyalp_BACKENDS "reference, reference_omp")
+
+# Configure the metadata file from the template
+set(METADATA_TEMPLATE "${CMAKE_CURRENT_SOURCE_DIR}/pyalp/_metadata.py.in")
+set(METADATA_OUTPUT "${CMAKE_BINARY_DIR}/pyalp_metadata.py")
+configure_file(${METADATA_TEMPLATE} ${METADATA_OUTPUT} @ONLY)
+
+# This command is useful for debugging inside a cibuildwheel container
+# to verify that the file is being generated correctly.
+# add_custom_command(TARGET ${PYALP_MODULE_NAME} POST_BUILD
+#     COMMAND ${CMAKE_COMMAND} -E echo "Generated metadata file content:"
+#     COMMAND ${CMAKE_COMMAND} -E cat ${METADATA_OUTPUT}
+# )
+