Skip to content

Fix pickle and repr for Duration. (backport #14174) #14193

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Apr 8, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions crates/circuit/src/duration.rs
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@

use pyo3::prelude::*;
use pyo3::IntoPyObjectExt;
use pyo3::PyTypeInfo;

/// A length of time used to express circuit timing.
///
Expand Down Expand Up @@ -74,9 +75,7 @@ impl Duration {
}
}
}
}

impl Duration {
fn __repr__(&self) -> String {
match self {
Duration::ns(t) => format!("Duration.ns({})", t),
Expand All @@ -86,4 +85,12 @@ impl Duration {
Duration::dt(t) => format!("Duration.dt({})", t),
}
}

fn __reduce__(&self, py: Python) -> PyResult<Py<PyAny>> {
(
Duration::type_object(py).getattr(self.unit())?,
(self.py_value(py)?,),
)
.into_py_any(py)
}
}
25 changes: 25 additions & 0 deletions crates/circuit/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ mod rustworkx_core_vnext;

use pyo3::prelude::*;
use pyo3::types::{PySequence, PyTuple};
use pyo3::PyTypeInfo;

pub type BitType = u32;
#[derive(Copy, Clone, Debug, Hash, Ord, PartialOrd, Eq, PartialEq, FromPyObject)]
Expand Down Expand Up @@ -169,7 +170,31 @@ pub fn circuit(m: &Bound<PyModule>) -> PyResult<()> {
m.add_class::<bit::PyClassicalRegister>()?;
m.add_class::<bit::PyQuantumRegister>()?;
m.add_class::<bit::PyAncillaRegister>()?;

// We need to explicitly add the auto-generated Python subclasses of Duration
// to the module so that pickle can find them during deserialization.
m.add_class::<duration::Duration>()?;
m.add(
"Duration_ns",
duration::Duration::type_object(m.py()).getattr("ns")?,
)?;
m.add(
"Duration_us",
duration::Duration::type_object(m.py()).getattr("us")?,
)?;
m.add(
"Duration_ms",
duration::Duration::type_object(m.py()).getattr("ms")?,
)?;
m.add(
"Duration_s",
duration::Duration::type_object(m.py()).getattr("s")?,
)?;
m.add(
"Duration_dt",
duration::Duration::type_object(m.py()).getattr("dt")?,
)?;

m.add_class::<circuit_data::CircuitData>()?;
m.add_class::<circuit_instruction::CircuitInstruction>()?;
m.add_class::<dag_circuit::DAGCircuit>()?;
Expand Down
9 changes: 9 additions & 0 deletions releasenotes/notes/fix-duration-props-0543fe1d5e6e2820.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
fixes:
- |
Added missing ``repr`` support for :class:`qiskit.circuit.Duration`.
- |
Added missing support for Python pickling of :class:`qiskit.circuit.Duration`.
This was preventing parallel transpilation of circuits with
:meth:`~.QuantumCircuit.delay` instructions that use duration
expressions.
20 changes: 19 additions & 1 deletion test/python/circuit/test_delay.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,15 @@
# pylint: disable=missing-function-docstring

"""Test delay instruction for quantum circuits."""
import copy
import pickle

import numpy as np

from qiskit.circuit import Delay
from qiskit.circuit import Delay, Duration
from qiskit.circuit import Parameter, ParameterVector
from qiskit.circuit import QuantumCircuit, CircuitInstruction
from qiskit.circuit.classical import expr
from qiskit.circuit.exceptions import CircuitError
from test import QiskitTestCase # pylint: disable=wrong-import-order

Expand Down Expand Up @@ -136,6 +139,21 @@ def circuit_from(delay):
self.assertNotEqual(Delay(a, unit), Delay(a, "dt"))
self.assertNotEqual(circuit_from(Delay(a, unit)), circuit_from(Delay(a, "dt")))

def test_delay_clone(self):
"""Test that circuits with delays can be copied or pickled."""
qc = QuantumCircuit(3)
stretch = qc.add_stretch("a")
qc.delay(100, qc.qubits[0])
qc.delay(expr.lift(Duration.us(1)), 0)
qc.delay(expr.lift(Duration.ns(2)), 0)
qc.delay(expr.lift(Duration.ms(3)), 0)
qc.delay(expr.lift(Duration.s(4)), 0)
qc.delay(expr.lift(Duration.dt(5)), 0)
qc.delay(stretch, [0, 1])
self.assertEqual(qc, pickle.loads(pickle.dumps(qc)))
self.assertEqual(qc, copy.copy(qc))
self.assertEqual(qc, copy.deepcopy(qc))


class TestParameterizedDelay(QiskitTestCase):
"""Test delay instruction with parameterized duration."""
Expand Down