Merge branch 'fake-backends' of https://github.com/ElePT/qiskit-terra into fake-backends-v1

Author: ElePT

qiskit/qpy/__init__.py

@@ -162,6 +162,16 @@
 by ``num_circuits`` in the file header). There is no padding between the
 circuits in the data.
 
+.. _qpy_version_11:
+
+Version 11
+==========
+
+Version 11 is identical to Version 10 except that for names in the CUSTOM_INSTRUCTION blocks
+have a suffix of the form ``"_{uuid_hex}"`` where ``uuid_hex`` is a uuid
+hexadecimal string such as returned by :attr:`.UUID.hex`. For example:
+``"b3ecab5b4d6a4eb6bc2b2dbf18d83e1e"``.
+
 .. _qpy_version_10:
 
 Version 10

qiskit/qpy/binary_io/circuits.py

@@ -373,6 +373,9 @@ def _parse_custom_operation(
         ) = custom_operations[gate_name]
     else:
         type_str, num_qubits, num_clbits, definition = custom_operations[gate_name]
+    # Strip the trailing "_{uuid}" from the gate name if the version >=11
+    if version >= 11:
+        gate_name = "_".join(gate_name.split("_")[:-1])
     type_key = type_keys.CircuitInstruction(type_str)
 
     if type_key == type_keys.CircuitInstruction.INSTRUCTION:
@@ -572,7 +575,7 @@ def _dumps_instruction_parameter(param, index_map, use_symengine):
 
 
 # pylint: disable=too-many-boolean-expressions
-def _write_instruction(file_obj, instruction, custom_operations, index_map, use_symengine):
+def _write_instruction(file_obj, instruction, custom_operations, index_map, use_symengine, version):
     if isinstance(instruction.operation, Instruction):
         gate_class_name = instruction.operation.base_class.__name__
     else:
@@ -591,15 +594,17 @@ def _write_instruction(file_obj, instruction, custom_operations, index_map, use_
         or isinstance(instruction.operation, library.BlueprintCircuit)
     ):
         gate_class_name = instruction.operation.name
+        if version >= 11:
+            # Assign a uuid to each instance of a custom operation
+            gate_class_name = f"{gate_class_name}_{uuid.uuid4().hex}"
         # ucr*_dg gates can have different numbers of parameters,
         # the uuid is appended to avoid storing a single definition
         # in circuits with multiple ucr*_dg gates.
-        if instruction.operation.name in ["ucrx_dg", "ucry_dg", "ucrz_dg"]:
-            gate_class_name += "_" + str(uuid.uuid4())
+        elif instruction.operation.name in {"ucrx_dg", "ucry_dg", "ucrz_dg"}:
+            gate_class_name = f"{gate_class_name}_{uuid.uuid4()}"
 
-        if gate_class_name not in custom_operations:
-            custom_operations[gate_class_name] = instruction.operation
-            custom_operations_list.append(gate_class_name)
+        custom_operations[gate_class_name] = instruction.operation
+        custom_operations_list.append(gate_class_name)
 
     elif gate_class_name == "ControlledGate":
         # controlled gates can have the same name but different parameter
@@ -724,7 +729,7 @@ def _write_elem(buffer, op):
     file_obj.write(synth_data)
 
 
-def _write_custom_operation(file_obj, name, operation, custom_operations, use_symengine):
+def _write_custom_operation(file_obj, name, operation, custom_operations, use_symengine, version):
     type_key = type_keys.CircuitInstruction.assign(operation)
     has_definition = False
     size = 0
@@ -768,6 +773,7 @@ def _write_custom_operation(file_obj, name, operation, custom_operations, use_sy
                 custom_operations,
                 {},
                 use_symengine,
+                version,
             )
             base_gate_raw = base_gate_buffer.getvalue()
     name_raw = name.encode(common.ENCODE)
@@ -1002,7 +1008,9 @@ def _read_layout_v2(file_obj, circuit):
         circuit._layout._output_qubit_list = circuit.qubits
 
 
-def write_circuit(file_obj, circuit, metadata_serializer=None, use_symengine=False):
+def write_circuit(
+    file_obj, circuit, metadata_serializer=None, use_symengine=False, version=common.QPY_VERSION
+):
     """Write a single QuantumCircuit object in the file like object.
 
     Args:
@@ -1016,6 +1024,7 @@ def write_circuit(file_obj, circuit, metadata_serializer=None, use_symengine=Fal
             native mechanism. This is a faster serialization alternative, but not supported in all
             platforms. Please check that your target platform is supported by the symengine library
             before setting this option, as it will be required by qpy to deserialize the payload.
+        version (int): The QPY format version to use for serializing this circuit
     """
     metadata_raw = json.dumps(
         circuit.metadata, separators=(",", ":"), cls=metadata_serializer
@@ -1056,7 +1065,7 @@ def write_circuit(file_obj, circuit, metadata_serializer=None, use_symengine=Fal
     index_map["c"] = {bit: index for index, bit in enumerate(circuit.clbits)}
     for instruction in circuit.data:
         _write_instruction(
-            instruction_buffer, instruction, custom_operations, index_map, use_symengine
+            instruction_buffer, instruction, custom_operations, index_map, use_symengine, version
         )
 
     with io.BytesIO() as custom_operations_buffer:
@@ -1068,7 +1077,12 @@ def write_circuit(file_obj, circuit, metadata_serializer=None, use_symengine=Fal
                 operation = custom_operations[name]
                 new_custom_operations.extend(
                     _write_custom_operation(
-                        custom_operations_buffer, name, operation, custom_operations, use_symengine
+                        custom_operations_buffer,
+                        name,
+                        operation,
+                        custom_operations,
+                        use_symengine,
+                        version,
                     )
                 )
 

qiskit/qpy/binary_io/schedules.py

@@ -574,7 +574,9 @@ def read_schedule_block(file_obj, version, metadata_deserializer=None, use_symen
     return block
 
 
-def write_schedule_block(file_obj, block, metadata_serializer=None, use_symengine=False):
+def write_schedule_block(
+    file_obj, block, metadata_serializer=None, use_symengine=False, version=common.QPY_VERSION
+):  # pylint: disable=unused-argument
     """Write a single ScheduleBlock object in the file like object.
 
     Args:
@@ -588,6 +590,7 @@ def write_schedule_block(file_obj, block, metadata_serializer=None, use_symengin
             native mechanism. This is a faster serialization alternative, but not supported in all
             platforms. Please check that your target platform is supported by the symengine library
             before setting this option, as it will be required by qpy to deserialize the payload.
+        version (int): The QPY format version to use for serializing this circuit block
     Raises:
         TypeError: If any of the instructions is invalid data format.
     """

qiskit/qpy/common.py

@@ -20,7 +20,7 @@
 
 from qiskit.qpy import formats
 
-QPY_VERSION = 10
+QPY_VERSION = 11
 QPY_COMPATIBILITY_VERSION = 10
 ENCODE = "utf8"
 

qiskit/qpy/interface.py

@@ -199,7 +199,11 @@ def dump(
 
     for program in programs:
         writer(
-            file_obj, program, metadata_serializer=metadata_serializer, use_symengine=use_symengine
+            file_obj,
+            program,
+            metadata_serializer=metadata_serializer,
+            use_symengine=use_symengine,
+            version=version,
         )
 
 

releasenotes/notes/fix-qpy-custom-gates-name-conflict-5c4c7df3484f04e0.yaml

@@ -0,0 +1,19 @@
+---
+upgrade:
+  - |
+    The latest format version of QPY is now :ref:`qpy_version_11` and this
+    is what is emitted by default when running :func:`.qpy.dump`.
+fixes:
+  - |
+    Fixed an issue with the QPY serialization when a :class:`.QuantumCircuit`
+    contained multiple custom instructions instances that have the same
+    :attr:`~.Instruction.name` attribute. In QPY format versions before
+    :ref:`qpy_version_11` the QPY payload did not differentiate between
+    these instances and would only serialize the properties of the first
+    instance in a circuit. This could potentially cause an incorrect
+    deserialization if the other properties of the custom instruction were
+    different but the names were the same. This has been fixed in
+    QPY :ref:`qpy_version_11` so that each instance of a custom instruction
+    is serialized individually and there will no longer be a potential
+    conflict with overlapping names.
+    Fixes `#8941 <https://github.com/Qiskit/qiskit/issues/8941>`__

releasenotes/notes/remove_qiskit_test-84bee228d8d768df.yaml

@@ -0,0 +1,5 @@
+---
+upgrade:
+  - |
+    Remove ``qiskit.test``. This includes ``qiskit.test.QiskitTestCase`` (and ``BasicQiskitTestCase``)
+    which are now for interal unittesting use.

test/__init__.py

@@ -15,6 +15,9 @@
 import itertools
 from ddt import data, unpack
 
+from .utils.base import QiskitTestCase
+from .utils.decorators import slow_test
+
 
 class Case(dict):
     """<no description>"""

test/benchmarks/transpiler_qualitative.py

@@ -1,6 +1,6 @@
 # This code is part of Qiskit.
 #
-# (C) Copyright IBM 2023
+# (C) Copyright IBM 2023, 2024.
 #
 # This code is licensed under the Apache License, Version 2.0. You may
 # obtain a copy of this license in the LICENSE.txt file in the root directory

test/python/circuit/classical/test_expr_constructors.py

@@ -16,7 +16,7 @@
 
 from qiskit.circuit import Clbit, ClassicalRegister, Instruction
 from qiskit.circuit.classical import expr, types
-from qiskit.test import QiskitTestCase
+from test import QiskitTestCase  # pylint: disable=wrong-import-order
 
 
 @ddt.ddt

test/python/circuit/classical/test_expr_helpers.py

@@ -17,7 +17,7 @@
 
 from qiskit.circuit import Clbit, ClassicalRegister
 from qiskit.circuit.classical import expr, types
-from qiskit.test import QiskitTestCase
+from test import QiskitTestCase  # pylint: disable=wrong-import-order
 
 
 @ddt.ddt

test/python/circuit/classical/test_expr_properties.py

@@ -14,12 +14,11 @@
 
 import copy
 import pickle
-
 import ddt
 
-from qiskit.test import QiskitTestCase
 from qiskit.circuit import ClassicalRegister, Clbit
 from qiskit.circuit.classical import expr, types
+from test import QiskitTestCase  # pylint: disable=wrong-import-order
 
 
 @ddt.ddt

test/python/circuit/classical/test_types_ordering.py

@@ -13,7 +13,7 @@
 # pylint: disable=missing-module-docstring,missing-class-docstring,missing-function-docstring
 
 from qiskit.circuit.classical import types
-from qiskit.test import QiskitTestCase
+from test import QiskitTestCase  # pylint: disable=wrong-import-order
 
 
 class TestTypesOrdering(QiskitTestCase):

test/python/circuit/library/test_adders.py

@@ -16,10 +16,10 @@
 import numpy as np
 from ddt import ddt, data, unpack
 
-from qiskit.test.base import QiskitTestCase
 from qiskit.circuit import QuantumCircuit
 from qiskit.quantum_info import Statevector
 from qiskit.circuit.library import CDKMRippleCarryAdder, DraperQFTAdder, VBERippleCarryAdder
+from test import QiskitTestCase  # pylint: disable=wrong-import-order
 
 
 @ddt

test/python/circuit/library/test_blueprintcircuit.py

@@ -16,7 +16,6 @@
 import unittest
 from ddt import ddt, data
 
-from qiskit.test.base import QiskitTestCase
 from qiskit.circuit import (
     QuantumRegister,
     Parameter,
@@ -26,6 +25,7 @@
     CircuitInstruction,
 )
 from qiskit.circuit.library import BlueprintCircuit, XGate
+from test import QiskitTestCase  # pylint: disable=wrong-import-order
 
 
 class MockBlueprint(BlueprintCircuit):

test/python/circuit/library/test_boolean_logic.py

@@ -16,10 +16,10 @@
 from ddt import ddt, data, unpack
 import numpy as np
 
-from qiskit.test.base import QiskitTestCase
 from qiskit.circuit import QuantumCircuit
 from qiskit.circuit.library import XOR, InnerProduct, AND, OR
 from qiskit.quantum_info import Statevector
+from test import QiskitTestCase  # pylint: disable=wrong-import-order
 
 
 @ddt

test/python/circuit/library/test_diagonal.py

@@ -16,10 +16,10 @@
 from ddt import ddt, data
 import numpy as np
 
-from qiskit.test.base import QiskitTestCase
 from qiskit.circuit.library import Diagonal
 from qiskit.quantum_info import Statevector, Operator
 from qiskit.quantum_info.operators.predicates import matrix_equal
+from test import QiskitTestCase  # pylint: disable=wrong-import-order
 
 
 @ddt

test/python/circuit/library/test_evolution_gate.py

@@ -21,8 +21,8 @@
 from qiskit.circuit.library import PauliEvolutionGate
 from qiskit.synthesis import LieTrotter, SuzukiTrotter, MatrixExponential, QDrift
 from qiskit.converters import circuit_to_dag
-from qiskit.test import QiskitTestCase
 from qiskit.quantum_info import Operator, SparsePauliOp, Pauli, Statevector
+from test import QiskitTestCase  # pylint: disable=wrong-import-order
 
 X = SparsePauliOp("X")
 Y = SparsePauliOp("Y")

test/python/circuit/library/test_evolved_op_ansatz.py

@@ -20,7 +20,7 @@
 from qiskit.circuit.library import HamiltonianGate
 from qiskit.circuit.library.n_local import EvolvedOperatorAnsatz
 from qiskit.synthesis.evolution import MatrixExponential
-from qiskit.test import QiskitTestCase
+from test import QiskitTestCase  # pylint: disable=wrong-import-order
 
 
 class TestEvolvedOperatorAnsatz(QiskitTestCase):

test/python/circuit/library/test_fourier_checking.py

@@ -16,10 +16,10 @@
 from ddt import ddt, data, unpack
 import numpy as np
 
-from qiskit.test.base import QiskitTestCase
 from qiskit.circuit.library import FourierChecking
 from qiskit.circuit.exceptions import CircuitError
 from qiskit.quantum_info import Operator
+from test import QiskitTestCase  # pylint: disable=wrong-import-order
 
 
 @ddt

test/python/circuit/library/test_functional_pauli_rotations.py

@@ -17,14 +17,14 @@
 import numpy as np
 from ddt import ddt, data, unpack
 
-from qiskit.test.base import QiskitTestCase
 from qiskit.circuit import QuantumCircuit
 from qiskit.circuit.library import (
     LinearPauliRotations,
     PolynomialPauliRotations,
     PiecewiseLinearPauliRotations,
 )
 from qiskit.quantum_info import Statevector
+from test import QiskitTestCase  # pylint: disable=wrong-import-order
 
 
 @ddt

test/python/circuit/library/test_global_r.py

@@ -15,9 +15,9 @@
 import unittest
 import numpy as np
 
-from qiskit.test.base import QiskitTestCase
 from qiskit.circuit import QuantumCircuit
 from qiskit.circuit.library import GR, GRX, GRY, GRZ, RGate, RZGate
+from test import QiskitTestCase  # pylint: disable=wrong-import-order
 
 
 class TestGlobalRLibrary(QiskitTestCase):

test/python/circuit/library/test_gms.py

@@ -15,9 +15,9 @@
 import unittest
 import numpy as np
 
-from qiskit.test.base import QiskitTestCase
 from qiskit.circuit.library import GMS, RXXGate
 from qiskit.quantum_info import Operator
+from test import QiskitTestCase  # pylint: disable=wrong-import-order
 
 
 class TestGMSLibrary(QiskitTestCase):

test/python/circuit/library/test_graph_state.py

@@ -17,7 +17,7 @@
 from qiskit.circuit.exceptions import CircuitError
 from qiskit.circuit.library import GraphState
 from qiskit.quantum_info import Clifford
-from qiskit.test.base import QiskitTestCase
+from test import QiskitTestCase  # pylint: disable=wrong-import-order
 
 
 class TestGraphStateLibrary(QiskitTestCase):

test/python/circuit/library/test_grover_operator.py

@@ -15,11 +15,11 @@
 import unittest
 import numpy as np
 
-from qiskit.test.base import QiskitTestCase
 from qiskit.circuit import QuantumCircuit
 from qiskit.circuit.library import GroverOperator
 from qiskit.converters import circuit_to_dag
 from qiskit.quantum_info import Operator, Statevector, DensityMatrix
+from test import QiskitTestCase  # pylint: disable=wrong-import-order
 
 
 class TestGroverOperator(QiskitTestCase):

test/python/circuit/library/test_hidden_linear_function.py

@@ -15,11 +15,11 @@
 import unittest
 import numpy as np
 
-from qiskit.test.base import QiskitTestCase
 from qiskit.circuit import QuantumCircuit
 from qiskit.circuit.exceptions import CircuitError
 from qiskit.circuit.library import HiddenLinearFunction
 from qiskit.quantum_info import Operator
+from test import QiskitTestCase  # pylint: disable=wrong-import-order
 
 
 class TestHiddenLinearFunctionLibrary(QiskitTestCase):