Qiskit / qiskit-fermions / 30363137094

98%

push

github

Introduce proper python `Protocol`s (#226)

* refactor: consolidate qiskit_fermions.protocols

* feat(protocols): add SupportsFermionOperator protocol

Introduces the SupportsFermionOperator protocol along with its type-agnostic
fermion_operator wrapper, mirroring ffsim's equivalent. MajoranaOperator,
EdgeVertexOperator, and TransferVertexOperator implement it by delegating to
their respective FermionOperator conversion mappers, each with docstrings and
regenerated .pyi stubs; adds unit tests covering all three implementers plus
a duck-typed fake to confirm protocol-based dispatch.

Co-authored-by: Claude Sonnet 5 <noreply@anthropic.com>

* feat(protocols): add SupportsMajoranaOperator and majorana_operator

Mirrors the existing SupportsFermionOperator/fermion_operator pattern for
MajoranaOperator conversion. The protocol method is implemented only by
operator classes with a genuine native `*_to_majorana` mapper function
(FermionOperator, EdgeVertexOperator, TransferVertexOperator); a
fermionic-detour conversion chain for other operators can be added later
if needed. Includes unit tests for the wrapper and docstrings for the new
protocol, wrapper function, and Rust `_majorana_operator_` methods.

Co-authored-by: Claude Sonnet 5 <noreply@anthropic.com>

* docs(protocols): cross-link protocols with their helper functions

Each SupportsXOperator/SupportsCommutators protocol docstring now links to
its dispatching helper function and carries a runnable doctest, completing
the reverse direction of the existing helper -> protocol links. The
qiskit_fermions.protocols module docstring gains a Protocol/Method/Helper
function table (paired with a hidden autosummary block, so the :toctree:
stub pages still generate without duplicating the table) to give readers a
single place to see how the protocols and their dispatch functions relate.

The mappers.library module docstring now separates the type-agnostic
Python convenience mappers from the native library impleme... (continued)

104 of 105 new or added lines in 20 files covered. (99.05%)

10223 of 10432 relevant lines covered (98.0%)

317.66 hits per line