Remove deprecated legacy pulse builder commands

qiskit/pulse/builder.py

@@ -477,7 +477,7 @@
 from qiskit.pulse.instructions import directives
 from qiskit.pulse.schedule import Schedule, ScheduleBlock
 from qiskit.pulse.transforms.alignments import AlignmentKind
-
+from qiskit.utils.deprecation import deprecate_func
 
 #: contextvars.ContextVar[BuilderContext]: active builder
 BUILDER_CONTEXTVAR = contextvars.ContextVar("backend")
@@ -1197,6 +1197,7 @@ def _qubits_to_channels(*channels_or_qubits: Union[int, chans.Channel]) -> Set[c
     return channels
 
 
+@deprecate_func(since="1.0.0")
 def active_transpiler_settings() -> Dict[str, Any]:
     """Return the current active builder context's transpiler settings.
 
@@ -1223,6 +1224,7 @@ def active_transpiler_settings() -> Dict[str, Any]:
     return dict(_active_builder().transpiler_settings)
 
 
+@deprecate_func(since="1.0.0")
 def active_circuit_scheduler_settings() -> Dict[str, Any]:
     """Return the current active builder context's circuit scheduler settings.
 
@@ -1507,6 +1509,7 @@ def general_transforms(alignment_context: AlignmentKind) -> ContextManager[None]
         builder.append_subroutine(current)
 
 
+@deprecate_func(since="1.0.0")
 @contextmanager
 def transpiler_settings(**settings) -> ContextManager[None]:
     """Set the currently active transpiler settings for this context.
@@ -2549,14 +2552,18 @@ def delay_qubits(duration: int, *qubits: Union[int, Iterable[int]]):
 
 
 # Gate instructions
+@deprecate_func(
+    since="1.0.0",
+    additional_msg="Instead use: ``backend.target['gate_name'][(qubit,)].calibration``",
+)
 def call_gate(gate: circuit.Gate, qubits: Tuple[int, ...], lazy: bool = True):
     """Call a gate and lazily schedule it to its corresponding
     pulse instruction.
 
     .. note::
-        Calling gates directly within the pulse builder namespace will be
-        deprecated in the future in favor of tight integration with a circuit
-        builder interface which is under development.
+        Calling gates directly within the pulse builder namespace has been
+        deprecated in favor of tight integration with a circuit
+        builder interface.
 
     Examples:
 
@@ -2602,14 +2609,17 @@ def call_gate(gate: circuit.Gate, qubits: Tuple[int, ...], lazy: bool = True):
     _active_builder().call_gate(gate, qubits, lazy=lazy)
 
 
+@deprecate_func(
+    since="1.0.0", additional_msg="Instead use: ``backend.target['cx'][(qubit,)].calibration``"
+)
 def cx(control: int, target: int):  # pylint: disable=invalid-name
     """Call a :class:`~qiskit.circuit.library.standard_gates.CXGate` on the
     input physical qubits.
 
     .. note::
-        Calling gates directly within the pulse builder namespace will be
-        deprecated in the future in favor of tight integration with a circuit
-        builder interface which is under development.
+        Calling gates directly within the pulse builder namespace has been
+        deprecated in favor of tight integration with a circuit
+        builder interface.
 
     Examples:
 
@@ -2627,14 +2637,15 @@ def cx(control: int, target: int):  # pylint: disable=invalid-name
     call_gate(gates.CXGate(), (control, target))
 
 
+@deprecate_func(since="1.0.0")
 def u1(theta: float, qubit: int):  # pylint: disable=invalid-name
     """Call a :class:`~qiskit.circuit.library.standard_gates.U1Gate` on the
     input physical qubit.
 
     .. note::
-        Calling gates directly within the pulse builder namespace will be
-        deprecated in the future in favor of tight integration with a circuit
-        builder interface which is under development.
+        Calling gates directly within the pulse builder namespace has been
+        deprecated in favor of tight integration with a circuit
+        builder interface.
 
     Examples:
 
@@ -2654,14 +2665,15 @@ def u1(theta: float, qubit: int):  # pylint: disable=invalid-name
     call_gate(gates.U1Gate(theta), qubit)
 
 
+@deprecate_func(since="1.0.0")
 def u2(phi: float, lam: float, qubit: int):  # pylint: disable=invalid-name
     """Call a :class:`~qiskit.circuit.library.standard_gates.U2Gate` on the
     input physical qubit.
 
     .. note::
-        Calling gates directly within the pulse builder namespace will be
-        deprecated in the future in favor of tight integration with a circuit
-        builder interface which is under development.
+        Calling gates directly within the pulse builder namespace has been
+        deprecated in favor of tight integration with a circuit
+        builder interface.
 
     Examples:
 
@@ -2681,14 +2693,15 @@ def u2(phi: float, lam: float, qubit: int):  # pylint: disable=invalid-name
     call_gate(gates.U2Gate(phi, lam), qubit)
 
 
+@deprecate_func(since="1.0.0")
 def u3(theta: float, phi: float, lam: float, qubit: int):  # pylint: disable=invalid-name
     """Call a :class:`~qiskit.circuit.library.standard_gates.U3Gate` on the
     input physical qubit.
 
     .. note::
-        Calling gates directly within the pulse builder namespace will be
-        deprecated in the future in favor of tight integration with a circuit
-        builder interface which is under development.
+        Calling gates directly within the pulse builder namespace has been
+        deprecated in favor of tight integration with a circuit
+        builder interface.
 
     Examples:
 
@@ -2708,14 +2721,17 @@ def u3(theta: float, phi: float, lam: float, qubit: int):  # pylint: disable=inv
     call_gate(gates.U3Gate(theta, phi, lam), qubit)
 
 
+@deprecate_func(
+    since="1.0.0", additional_msg="Instead use: ``backend.target['x'][(qubit,)].calibration``"
+)
 def x(qubit: int):
     """Call a :class:`~qiskit.circuit.library.standard_gates.XGate` on the
     input physical qubit.
 
     .. note::
-        Calling gates directly within the pulse builder namespace will be
-        deprecated in the future in favor of tight integration with a circuit
-        builder interface which is under development.
+        Calling gates directly within the pulse builder namespace has been
+        deprecated in favor of tight integration with a circuit
+        builder interface.
 
     Examples:
 

releasenotes/notes/Deprecate_legacy_pulse_builder_command-47651b395940e687.yaml

@@ -0,0 +1,30 @@
+---
+deprecations:
+  - |
+    Deprecated injecting circuit gate operation into the pulse context.
+
+    Deprecated
+    :func:`qiskit.pulse.builder.call_gate`,
+    :func:`qiskit.pulse.builder.cx`,
+    :func:`qiskit.pulse.builder.u1`,
+    :func:`qiskit.pulse.builder.u2`,
+    :func:`qiskit.pulse.builder.u3`,
+    :func:`qiskit.pulse.builder.x`
+
+    .. code-block:: python
+      # This example shows how to get pulse gate instructions.
+      from qiskit.providers.fake_provider import FakePerth
+      backend=FakePerth()
+      sched=backend.target['x'][(qubit,)].calibration
+
+    Deprecated
+    :func:`qiskit.pulse.builder.active_transpiler_settings`
+    :func:`qiskit.pulse.builder.active_circuit_scheduler_settings`
+    :func:`qiskit.pulse.builder.transpiler_settings`
+
+    Modified related tests in
+    :file:`test/python/pulse/test_builder.py`,
+    :file:`test/python/pulse/test_block.py`
+    :file:`test/python/pulse/test_builder_v2.py`
+    :file:`test/python/transpiler/test_calibrationbuilder.py`
+

test/python/pulse/test_block.py

@@ -793,7 +793,8 @@ def test_filter_channels_nested_block(self):
                 pulse.delay(5, self.d0)
 
                 with pulse.build(self.backend) as cx_blk:
-                    pulse.cx(0, 1)
+                    with self.assertWarns(DeprecationWarning):
+                        pulse.cx(0, 1)
 
                 pulse.call(cx_blk)
 

test/python/pulse/test_builder.py

@@ -194,13 +194,15 @@ def test_transpiler_settings(self):
         twice_cx_qc.cx(0, 1)
 
         with pulse.build(self.backend) as schedule:
-            with pulse.transpiler_settings(optimization_level=0):
-                builder.call(twice_cx_qc)
+            with self.assertWarns(DeprecationWarning):
+                with pulse.transpiler_settings(optimization_level=0):
+                    builder.call(twice_cx_qc)
         self.assertNotEqual(len(schedule.instructions), 0)
 
         with pulse.build(self.backend) as schedule:
-            with pulse.transpiler_settings(optimization_level=3):
-                builder.call(twice_cx_qc)
+            with self.assertWarns(DeprecationWarning):
+                with pulse.transpiler_settings(optimization_level=3):
+                    builder.call(twice_cx_qc)
         self.assertEqual(len(schedule.instructions), 0)
 
     def test_scheduler_settings(self):
@@ -219,9 +221,10 @@ def test_scheduler_settings(self):
         x_qc.x(0)
 
         with pulse.build(backend=self.backend) as schedule:
-            with pulse.transpiler_settings(basis_gates=["x"]):
-                with pulse.circuit_scheduler_settings(inst_map=inst_map):
-                    builder.call(x_qc)
+            with self.assertWarns(DeprecationWarning):
+                with pulse.transpiler_settings(basis_gates=["x"]):
+                    with pulse.circuit_scheduler_settings(inst_map=inst_map):
+                        builder.call(x_qc)
 
         self.assertScheduleEqual(schedule, ref_sched)
 
@@ -606,16 +609,19 @@ def test_qubit_channels(self):
     def test_active_transpiler_settings(self):
         """Test setting settings of active builder's transpiler."""
         with pulse.build(self.backend):
-            self.assertFalse(pulse.active_transpiler_settings())
-            with pulse.transpiler_settings(test_setting=1):
-                self.assertEqual(pulse.active_transpiler_settings()["test_setting"], 1)
+            with self.assertWarns(DeprecationWarning):
+                self.assertFalse(pulse.active_transpiler_settings())
+                with pulse.transpiler_settings(test_setting=1):
+                    self.assertEqual(pulse.active_transpiler_settings()["test_setting"], 1)
 
     def test_active_circuit_scheduler_settings(self):
         """Test setting settings of active builder's circuit scheduler."""
         with pulse.build(self.backend):
-            self.assertFalse(pulse.active_circuit_scheduler_settings())
+            with self.assertWarns(DeprecationWarning):
+                self.assertFalse(pulse.active_circuit_scheduler_settings())
             with pulse.circuit_scheduler_settings(test_setting=1):
-                self.assertEqual(pulse.active_circuit_scheduler_settings()["test_setting"], 1)
+                with self.assertWarns(DeprecationWarning):
+                    self.assertEqual(pulse.active_circuit_scheduler_settings()["test_setting"], 1)
 
     def test_num_qubits(self):
         """Test builder utility to get number of qubits."""
@@ -787,7 +793,8 @@ class TestGates(TestBuilder):
     def test_cx(self):
         """Test cx gate."""
         with pulse.build(self.backend) as schedule:
-            pulse.cx(0, 1)
+            with self.assertWarns(DeprecationWarning):
+                pulse.cx(0, 1)
 
         reference_qc = circuit.QuantumCircuit(2)
         reference_qc.cx(0, 1)
@@ -798,8 +805,9 @@ def test_cx(self):
     def test_u1(self):
         """Test u1 gate."""
         with pulse.build(self.backend) as schedule:
-            with pulse.transpiler_settings(layout_method="trivial"):
-                pulse.u1(np.pi / 2, 0)
+            with self.assertWarns(DeprecationWarning):
+                with pulse.transpiler_settings(layout_method="trivial"):
+                    pulse.u1(np.pi / 2, 0)
 
         reference_qc = circuit.QuantumCircuit(1)
         reference_qc.append(circuit.library.U1Gate(np.pi / 2), [0])
@@ -810,7 +818,8 @@ def test_u1(self):
     def test_u2(self):
         """Test u2 gate."""
         with pulse.build(self.backend) as schedule:
-            pulse.u2(np.pi / 2, 0, 0)
+            with self.assertWarns(DeprecationWarning):
+                pulse.u2(np.pi / 2, 0, 0)
 
         reference_qc = circuit.QuantumCircuit(1)
         reference_qc.append(circuit.library.U2Gate(np.pi / 2, 0), [0])
@@ -821,7 +830,8 @@ def test_u2(self):
     def test_u3(self):
         """Test u3 gate."""
         with pulse.build(self.backend) as schedule:
-            pulse.u3(np.pi / 8, np.pi / 16, np.pi / 4, 0)
+            with self.assertWarns(DeprecationWarning):
+                pulse.u3(np.pi / 8, np.pi / 16, np.pi / 4, 0)
 
         reference_qc = circuit.QuantumCircuit(1)
         reference_qc.append(circuit.library.U3Gate(np.pi / 8, np.pi / 16, np.pi / 4), [0])
@@ -832,7 +842,8 @@ def test_u3(self):
     def test_x(self):
         """Test x gate."""
         with pulse.build(self.backend) as schedule:
-            pulse.x(0)
+            with self.assertWarns(DeprecationWarning):
+                pulse.x(0)
 
         reference_qc = circuit.QuantumCircuit(1)
         reference_qc.x(0)
@@ -844,8 +855,9 @@ def test_x(self):
     def test_lazy_evaluation_with_transpiler(self):
         """Test that the two cx gates are optimizied away by the transpiler."""
         with pulse.build(self.backend) as schedule:
-            pulse.cx(0, 1)
-            pulse.cx(0, 1)
+            with self.assertWarns(DeprecationWarning):
+                pulse.cx(0, 1)
+                pulse.cx(0, 1)
 
         reference_qc = circuit.QuantumCircuit(2)
         reference = compiler.schedule(reference_qc, self.backend)
@@ -857,7 +869,8 @@ def test_measure(self):
         ensure agreement."""
         with pulse.build(self.backend) as schedule:
             with pulse.align_sequential():
-                pulse.x(0)
+                with self.assertWarns(DeprecationWarning):
+                    pulse.x(0)
                 pulse.measure(0)
 
         reference_qc = circuit.QuantumCircuit(1, 1)
@@ -872,7 +885,8 @@ def test_backend_require(self):
         """Test that a backend is required to use a gate."""
         with self.assertRaises(exceptions.BackendNotSet):
             with pulse.build():
-                pulse.x(0)
+                with self.assertWarns(DeprecationWarning):
+                    pulse.x(0)
 
 
 class TestBuilderComposition(TestBuilder):
@@ -891,15 +905,18 @@ def test_complex_build(self):
         with pulse.build(self.backend) as schedule:
             with pulse.align_sequential():
                 pulse.delay(delay_dur, d0)
-                pulse.u2(0, pi / 2, 1)
+                with self.assertWarns(DeprecationWarning):
+                    pulse.u2(0, pi / 2, 1)
             with pulse.align_right():
                 pulse.play(library.Constant(short_dur, 0.1), d1)
                 pulse.play(library.Constant(long_dur, 0.1), d2)
-                pulse.u2(0, pi / 2, 1)
+                with self.assertWarns(DeprecationWarning):
+                    pulse.u2(0, pi / 2, 1)
             with pulse.align_left():
-                pulse.u2(0, pi / 2, 0)
-                pulse.u2(0, pi / 2, 1)
-                pulse.u2(0, pi / 2, 0)
+                with self.assertWarns(DeprecationWarning):
+                    pulse.u2(0, pi / 2, 0)
+                    pulse.u2(0, pi / 2, 1)
+                    pulse.u2(0, pi / 2, 0)
             pulse.measure(0)
 
         # prepare and schedule circuits that will be used.
@@ -1027,7 +1044,8 @@ def test_call_gate_and_circuit(self):
                 # this is circuit, a subroutine stored as Call instruction
                 pulse.call(h_control)
                 # this is instruction, not subroutine
-                pulse.cx(0, 1)
+                with self.assertWarns(DeprecationWarning):
+                    pulse.cx(0, 1)
                 # this is macro, not subroutine
                 pulse.measure([0, 1])