Qiskit / qiskit / 32119509814

88%

Build Type

push

github

Committed by web-flow

Commit Message

Qpy v18 big endian (#16707)

* QPY: bump to version 18 and drop CalibrationsPack from format

Pulse gate calibrations were removed in Qiskit 2.0. Since then the
CalibrationsPack field in the QPY circuit payload has always been written
as an empty placeholder (num_cals=0). Version 18 removes it entirely.

- Bump QPY_VERSION to 18 in qiskit/qpy/common.py
- Gate CalibrationsPack field in QPYCircuit on version < 18 (binrw
  Option + if attribute covers both reader and writer)
- Guard Python writer and reader paths with version < 18 / 5 <= version < 18
- Add regression test asserting v18 output is 2 bytes smaller than v17
- Add reno release note and Version 18 docstring section

Signed-off-by: Elad Venezian <eladv@il.ibm.com>

* QPY: use big-endian instruction parameters in v18+

QPY format versions 1–17 mistakenly serialised integer and float
INSTRUCTION_PARAM values in little-endian byte order. Version 18
corrects this to big-endian, consistent with the rest of the format.

The fix is fully backward-compatible: files written at version ≤ 17
are still read correctly via the LittleForV17AndBelow path. The Python
read/write path (circuits.py) only handles versions ≤ 16 and is
unchanged — the little-endian encoding there remains correct for those
versions.

Key implementation points:
- New ValueEndian enum (Big / Little / LittleForV17AndBelow) replaces
  binrw::Endian at every QPY value call site; ValueEndian::resolve(version)
  is the single place where the version-to-endian mapping lives.
- GenericValue::as_little_for_v17_and_below(&self, version) consolidates
  the remaining as_le() call sites that work directly with GenericValue.
- Regression tests in test/python/qpy/test_v18_big_endian_params.py verify
  that v17 and v18 bytes differ for float params, for-loop integer lists,
  and switch-case labels, and that both versions round-trip correctly.

Signed-off-by: Elad Venezian <eladv@il.ibm.com>

* Address Gadi's review comments

- Inline endian.resolve() ... (continued)

Coverage Stats

100 of 122 new or added lines in 7 files covered. (81.97%)

36 existing lines in 5 files now uncovered.

113816 of 129681 relevant lines covered (87.77%)

995403.75 hits per line