Qiskit / qiskit / 22955033271

88%

Build Type

push

github

Committed by web-flow

Commit Message

Add `qiskit.capi` module (#15711)

* Add `qiskit.capi` module

This adds a basic `qiskit.capi` module for Python-space interaction with
the C API.  The two initial functions included are `get_include` and
`get_lib`, to get the package include directory and shared-object
library containing the C-API exported symbols, respectively.

Note that while the included header files _are_ complete information to
build against the C API, the file returned from `get_lib` is not
generally useful as part of a _build_ system, but can be used to
interact with the C API live through a Python session.

I hope to follow this patch with two more:

* provide a second "mode" for the packaged header files that allows
  building safe Python extension modules against the C API.  This would
  mean that all the C API function names will be `#define`'d to function
  pointers looked up in a static table stored inside a `PyCapsule` that
  is initialised as part of `_accelerate`'s initialisation.

* generate a `ctypes` wrapper file for the C API as part of the
  `_accelerate` (`pyext`) build script, which would expose all of the C
  API functions directly to Python space, potentially allowing them to
  be jitted through Numba, or allowing direct tests of C API
  functionality (without the manually-written file currently in our test
  suite).

Co-authored-by: Max Rossmannek <max@rossmannek.de>

* Vendor `generated-files` handling from `setuptools-rust`

We need https://github.com/PyO3/setuptools-rust/pull/574 (or something
akin to it) to handle the movement of the generated files from the build
script to the output. This is not yet ready for merge, and is highly
unlikely to be ready in time for the Qiskit 2.4.0 release (or at least
2.4.0rc1), so to avoid blocking ourselves, we vendor in a
monkey-patching reimplementation of the code temporarily.

The allowed range of `setuptools-rust` is _probably_ larger than the
hard pin, but the monkey-patch is so invasive and v1.12.0 is
sufficien... (continued)

Run Details

33 of 33 new or added lines in 4 files covered. (100.0%)

8 existing lines in 4 files now uncovered.

101321 of 115361 relevant lines covered (87.83%)

1169590.87 hits per line