Qiskit / qiskit / 26638257821

88%

main: 87%

Build Type

push

github

Committed by web-flow

Commit Message

Add C-API slot-assignment compatibility check (#16301)

* Add C-API slot-assignment compatibility check

We already have a linter that all C API functions are assigned exactly
one slot (or explicitly overridden in metadata to some other behaviour),
but we didn't have a check that the slot assignments for a _new_ version
of Qiskit are compatible with an old version.  This is necessary to
allow compatibility between releases; if an arbitrary Python C extension
is built against Qiskit 2.4, for it to work with Qiskit 2.5 at runtime
it is necessary that all the assigned slots in Qiskit 2.4 are assigned
to the same table and offset in Qiskit 2.5.

The checker here allows semver-aware comparison between two sets of the
output of `qiskit-bindgen-cli show-slots`, or between one explicit
output and the current state of `qiskit-cext-vtable`.  This is currently
_mostly_ a pass/fail evaluation.  There is a minimal-effort version of
the changeset between the two slots lists, but the reported changes do
not minimise the estimated Levenshtein distance between the two lists;
the reported changeset has no concept of "insertion" (only "added",
"removed" and "changed"), but "insertion" is actually the most realistic
error.  We'll still report it correctly as semver-breaking, but the
actual suggested changes will be overly verbose.

* Clarify documentation comment

Coverage Stats

0 of 167 new or added lines in 2 files covered. (0.0%)

6 existing lines in 2 files now uncovered.

108470 of 123919 relevant lines covered (87.53%)

960892.95 hits per line