diff --git a/qiskit/algorithms/amplitude_amplifiers/grover.py b/qiskit/algorithms/amplitude_amplifiers/grover.py index 614a6b055836..2332ff643904 100644 --- a/qiskit/algorithms/amplitude_amplifiers/grover.py +++ b/qiskit/algorithms/amplitude_amplifiers/grover.py @@ -25,7 +25,7 @@ from qiskit.providers import Backend from qiskit.quantum_info import partial_trace from qiskit.utils import QuantumInstance, algorithm_globals -from qiskit.utils.deprecation import deprecate_argument, deprecate_function +from qiskit.utils.deprecation import deprecate_arg, deprecate_function from .amplification_problem import AmplificationProblem from .amplitude_amplifier import AmplitudeAmplifier, AmplitudeAmplifierResult @@ -112,7 +112,7 @@ class Grover(AmplitudeAmplifier): `arXiv:quant-ph/0005055 `_. """ - @deprecate_argument( + @deprecate_arg( "quantum_instance", additional_msg="Instead, use the `sampler` argument.", since="0.22.0", diff --git a/qiskit/algorithms/amplitude_estimators/ae.py b/qiskit/algorithms/amplitude_estimators/ae.py index 9810ae644e56..63d853fabc79 100644 --- a/qiskit/algorithms/amplitude_estimators/ae.py +++ b/qiskit/algorithms/amplitude_estimators/ae.py @@ -23,7 +23,7 @@ from qiskit.providers import Backend from qiskit.primitives import BaseSampler from qiskit.utils import QuantumInstance -from qiskit.utils.deprecation import deprecate_argument, deprecate_function +from qiskit.utils.deprecation import deprecate_arg, deprecate_function from .amplitude_estimator import AmplitudeEstimator, AmplitudeEstimatorResult from .ae_utils import pdf_a, derivative_log_pdf_a, bisect_max from .estimation_problem import EstimationProblem @@ -57,7 +57,7 @@ class AmplitudeEstimation(AmplitudeEstimator): `arXiv:1912.05559 `_. """ - @deprecate_argument( + @deprecate_arg( "quantum_instance", additional_msg="Instead, use the `sampler` argument.", since="0.22.0", diff --git a/qiskit/algorithms/amplitude_estimators/fae.py b/qiskit/algorithms/amplitude_estimators/fae.py index bb6d0a8cede5..4ee9f4e9e055 100644 --- a/qiskit/algorithms/amplitude_estimators/fae.py +++ b/qiskit/algorithms/amplitude_estimators/fae.py @@ -20,7 +20,7 @@ from qiskit.providers import Backend from qiskit.primitives import BaseSampler from qiskit.utils import QuantumInstance -from qiskit.utils.deprecation import deprecate_argument, deprecate_function +from qiskit.utils.deprecation import deprecate_arg, deprecate_function from qiskit.algorithms.exceptions import AlgorithmError from .amplitude_estimator import AmplitudeEstimator, AmplitudeEstimatorResult @@ -48,7 +48,7 @@ class FasterAmplitudeEstimation(AmplitudeEstimator): """ - @deprecate_argument( + @deprecate_arg( "quantum_instance", additional_msg="Instead, use the `sampler` argument.", since="0.22.0", diff --git a/qiskit/algorithms/amplitude_estimators/iae.py b/qiskit/algorithms/amplitude_estimators/iae.py index 90609ceb0c8b..08bb7c59e4c4 100644 --- a/qiskit/algorithms/amplitude_estimators/iae.py +++ b/qiskit/algorithms/amplitude_estimators/iae.py @@ -22,7 +22,7 @@ from qiskit.providers import Backend from qiskit.primitives import BaseSampler from qiskit.utils import QuantumInstance -from qiskit.utils.deprecation import deprecate_argument, deprecate_function +from qiskit.utils.deprecation import deprecate_arg, deprecate_function from .amplitude_estimator import AmplitudeEstimator, AmplitudeEstimatorResult from .estimation_problem import EstimationProblem @@ -50,7 +50,7 @@ class IterativeAmplitudeEstimation(AmplitudeEstimator): `arXiv:quant-ph/0005055 `_. """ - @deprecate_argument( + @deprecate_arg( "quantum_instance", additional_msg="Instead, use the `sampler` argument.", since="0.22.0", diff --git a/qiskit/algorithms/amplitude_estimators/mlae.py b/qiskit/algorithms/amplitude_estimators/mlae.py index 96d83a02f900..11efbd4531a1 100644 --- a/qiskit/algorithms/amplitude_estimators/mlae.py +++ b/qiskit/algorithms/amplitude_estimators/mlae.py @@ -23,7 +23,7 @@ from qiskit import ClassicalRegister, QuantumRegister, QuantumCircuit from qiskit.utils import QuantumInstance from qiskit.primitives import BaseSampler -from qiskit.utils.deprecation import deprecate_argument, deprecate_function +from qiskit.utils.deprecation import deprecate_arg, deprecate_function from .amplitude_estimator import AmplitudeEstimator, AmplitudeEstimatorResult from .estimation_problem import EstimationProblem @@ -53,7 +53,7 @@ class in named ``MaximumLikelihoodAmplitudeEstimation``. `arXiv:quant-ph/0005055 `_. """ - @deprecate_argument( + @deprecate_arg( "quantum_instance", additional_msg="Instead, use the `sampler` argument.", since="0.22.0", diff --git a/qiskit/algorithms/optimizers/adam_amsgrad.py b/qiskit/algorithms/optimizers/adam_amsgrad.py index 1e6c94c19b1a..08b5de5dad80 100644 --- a/qiskit/algorithms/optimizers/adam_amsgrad.py +++ b/qiskit/algorithms/optimizers/adam_amsgrad.py @@ -17,7 +17,7 @@ import csv import numpy as np -from qiskit.utils.deprecation import deprecate_argument +from qiskit.utils.deprecation import deprecate_arg from .optimizer import Optimizer, OptimizerSupportLevel, OptimizerResult, POINT # pylint: disable=invalid-name @@ -193,9 +193,9 @@ def load_params(self, load_dir: str) -> None: t = t[1:-1] self._t = np.fromstring(t, dtype=int, sep=" ") - @deprecate_argument("objective_function", new_alias="fun", since="0.19.0") - @deprecate_argument("initial_point", new_alias="fun", since="0.19.0") - @deprecate_argument("gradient_function", new_alias="jac", since="0.19.0") + @deprecate_arg("objective_function", new_alias="fun", since="0.19.0") + @deprecate_arg("initial_point", new_alias="fun", since="0.19.0") + @deprecate_arg("gradient_function", new_alias="jac", since="0.19.0") # pylint: disable=arguments-differ def minimize( self, diff --git a/qiskit/algorithms/optimizers/qnspsa.py b/qiskit/algorithms/optimizers/qnspsa.py index ac44c2fb32b2..6ce7e05f4b55 100644 --- a/qiskit/algorithms/optimizers/qnspsa.py +++ b/qiskit/algorithms/optimizers/qnspsa.py @@ -20,7 +20,7 @@ from qiskit.circuit import ParameterVector, QuantumCircuit from qiskit.opflow import StateFn, CircuitSampler, ExpectationBase from qiskit.utils import QuantumInstance -from qiskit.utils.deprecation import deprecate_argument +from qiskit.utils.deprecation import deprecate_arg from qiskit.primitives import BaseSampler, Sampler from qiskit.algorithms.state_fidelities import ComputeUncompute @@ -253,13 +253,13 @@ def settings(self) -> dict[str, Any]: return settings @staticmethod - @deprecate_argument( + @deprecate_arg( "backend", deprecation_description="Setting the argument `backend` in QNSPSA.get_fidelity()", since="0.22", pending=True, ) - @deprecate_argument( + @deprecate_arg( "expectation", deprecation_description="Setting the argument `expectation` in QNSPSA.get_fidelity()", since="0.22", diff --git a/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation.py b/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation.py index 6d1a7c896957..80e37a70d3a4 100644 --- a/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation.py +++ b/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation.py @@ -16,7 +16,7 @@ from qiskit import QuantumCircuit from qiskit.utils import QuantumInstance -from qiskit.utils.deprecation import deprecate_argument +from qiskit.utils.deprecation import deprecate_arg from qiskit.opflow import ( SummedOp, PauliOp, @@ -91,7 +91,7 @@ class HamiltonianPhaseEstimation: """ - @deprecate_argument( + @deprecate_arg( "quantum_instance", additional_msg="Instead, use the `sampler` argument.", since="0.22.0", diff --git a/qiskit/algorithms/phase_estimators/ipe.py b/qiskit/algorithms/phase_estimators/ipe.py index 967d51a07def..fc40ed000b0b 100644 --- a/qiskit/algorithms/phase_estimators/ipe.py +++ b/qiskit/algorithms/phase_estimators/ipe.py @@ -22,7 +22,7 @@ from qiskit.circuit.classicalregister import ClassicalRegister from qiskit.providers import Backend from qiskit.utils import QuantumInstance -from qiskit.utils.deprecation import deprecate_argument +from qiskit.utils.deprecation import deprecate_arg from qiskit.algorithms.exceptions import AlgorithmError from .phase_estimator import PhaseEstimator from .phase_estimator import PhaseEstimatorResult @@ -39,7 +39,7 @@ class IterativePhaseEstimation(PhaseEstimator): qubit benchmark, `arxiv/quant-ph/0610214 `_ """ - @deprecate_argument( + @deprecate_arg( "quantum_instance", additional_msg="Instead, use the `sampler` argument.", since="0.22.0", diff --git a/qiskit/algorithms/phase_estimators/phase_estimation.py b/qiskit/algorithms/phase_estimators/phase_estimation.py index f2e6cb934d50..01358098fd45 100644 --- a/qiskit/algorithms/phase_estimators/phase_estimation.py +++ b/qiskit/algorithms/phase_estimators/phase_estimation.py @@ -23,7 +23,7 @@ from qiskit.circuit.classicalregister import ClassicalRegister from qiskit.providers import Backend from qiskit.utils import QuantumInstance -from qiskit.utils.deprecation import deprecate_argument +from qiskit.utils.deprecation import deprecate_arg from qiskit.result import Result from qiskit.algorithms.exceptions import AlgorithmError from .phase_estimation_result import PhaseEstimationResult, _sort_phases @@ -81,7 +81,7 @@ class PhaseEstimation(PhaseEstimator): """ - @deprecate_argument( + @deprecate_arg( "quantum_instance", additional_msg="Instead, use the `sampler` argument.", since="0.22.0", diff --git a/qiskit/assembler/run_config.py b/qiskit/assembler/run_config.py index 386ad52d9346..cc02b9820eb2 100644 --- a/qiskit/assembler/run_config.py +++ b/qiskit/assembler/run_config.py @@ -14,7 +14,7 @@ from types import SimpleNamespace -from qiskit.utils.deprecation import deprecate_argument +from qiskit.utils.deprecation import deprecate_arg class RunConfig(SimpleNamespace): @@ -31,7 +31,7 @@ class RunConfig(SimpleNamespace): parameter_binds (list[dict]): List of parameter bindings """ - @deprecate_argument( + @deprecate_arg( "max_credits", since="0.20.0", additional_msg=( diff --git a/qiskit/circuit/instructionset.py b/qiskit/circuit/instructionset.py index ccba996bbc54..f552a0a35296 100644 --- a/qiskit/circuit/instructionset.py +++ b/qiskit/circuit/instructionset.py @@ -18,7 +18,7 @@ from typing import Callable, Optional, Tuple, Union from qiskit.circuit.exceptions import CircuitError -from qiskit.utils.deprecation import deprecate_argument +from qiskit.utils.deprecation import deprecate_arg from .classicalregister import Clbit, ClassicalRegister from .operation import Operation from .quantumcircuitdata import CircuitInstruction @@ -92,7 +92,7 @@ class InstructionSet: __slots__ = ("_instructions", "_requester") - @deprecate_argument( + @deprecate_arg( "circuit_cregs", since="0.19.0", additional_msg=( diff --git a/qiskit/compiler/assembler.py b/qiskit/compiler/assembler.py index 1a3075eba052..f3d41a019931 100644 --- a/qiskit/compiler/assembler.py +++ b/qiskit/compiler/assembler.py @@ -29,7 +29,7 @@ from qiskit.pulse.channels import PulseChannel from qiskit.qobj import Qobj, QobjHeader from qiskit.qobj.utils import MeasLevel, MeasReturnType -from qiskit.utils.deprecation import deprecate_argument +from qiskit.utils.deprecation import deprecate_arg logger = logging.getLogger(__name__) @@ -40,7 +40,7 @@ def _log_assembly_time(start_time, end_time): # TODO: parallelize over the experiments (serialize each separately, then add global header/config) -@deprecate_argument( +@deprecate_arg( "max_credits", since="0.20.0", additional_msg=( diff --git a/qiskit/dagcircuit/dagnode.py b/qiskit/dagcircuit/dagnode.py index 30f75b3f8d7c..a3ee5ca922a9 100644 --- a/qiskit/dagcircuit/dagnode.py +++ b/qiskit/dagcircuit/dagnode.py @@ -17,7 +17,7 @@ from typing import Iterable from qiskit.circuit import Qubit, Clbit -from qiskit.utils.deprecation import deprecate_argument +from qiskit.utils.deprecation import deprecate_arg def _condition_as_indices(operation, bit_indices): @@ -50,7 +50,7 @@ def __str__(self): return str(id(self)) @staticmethod - @deprecate_argument( + @deprecate_arg( "bit_indices1", deprecation_description="Not setting bit_indices1 in DAGNode.semantic_eq()", additional_msg=( @@ -60,7 +60,7 @@ def __str__(self): since="0.21.0", predicate=lambda arg: arg is None, ) - @deprecate_argument( + @deprecate_arg( "bit_indices2", deprecation_description="Not setting bit_indices2 in DAGNode.semantic_eq()", additional_msg=( diff --git a/qiskit/execute_function.py b/qiskit/execute_function.py index c3b6974ea175..45cb585be24e 100644 --- a/qiskit/execute_function.py +++ b/qiskit/execute_function.py @@ -26,7 +26,7 @@ from qiskit.providers.backend import Backend from qiskit.pulse import Schedule, ScheduleBlock from qiskit.exceptions import QiskitError -from qiskit.utils.deprecation import deprecate_argument +from qiskit.utils.deprecation import deprecate_arg logger = logging.getLogger(__name__) @@ -36,7 +36,7 @@ def _log_submission_time(start_time, end_time): logger.info(log_msg) -@deprecate_argument( +@deprecate_arg( "max_credits", since="0.20.0", additional_msg=( @@ -44,12 +44,8 @@ def _log_submission_time(start_time, end_time): "necessary." ), ) -@deprecate_argument( - "qobj_id", since="0.21.0", additional_msg="This argument has no effect anymore." -) -@deprecate_argument( - "qobj_header", since="0.21.0", additional_msg="This argument has no effect anymore." -) +@deprecate_arg("qobj_id", since="0.21.0", additional_msg="This argument has no effect anymore.") +@deprecate_arg("qobj_header", since="0.21.0", additional_msg="This argument has no effect anymore.") def execute( experiments, backend, diff --git a/qiskit/primitives/base/base_estimator.py b/qiskit/primitives/base/base_estimator.py index 1b12fe08733b..d3a8815b2eb7 100644 --- a/qiskit/primitives/base/base_estimator.py +++ b/qiskit/primitives/base/base_estimator.py @@ -93,7 +93,7 @@ from qiskit.providers import JobV1 as Job from qiskit.quantum_info.operators import SparsePauliOp from qiskit.quantum_info.operators.base_operator import BaseOperator -from qiskit.utils.deprecation import deprecate_argument, deprecate_function +from qiskit.utils.deprecation import deprecate_arg, deprecate_function from ..utils import _circuit_key, _observable_key, init_observable from .base_primitive import BasePrimitive @@ -108,15 +108,15 @@ class BaseEstimator(BasePrimitive): __hash__ = None - @deprecate_argument( + @deprecate_arg( "circuits", since="0.22", additional_msg="Instead, use the run() method to append objects." ) - @deprecate_argument( + @deprecate_arg( "observables", since="0.22", additional_msg="Instead, use the run() method to append objects.", ) - @deprecate_argument( + @deprecate_arg( "parameters", since="0.22", additional_msg="Instead, use the run() method to append objects.", @@ -371,8 +371,8 @@ def close(self): "Use the 'run' method instead.", since="0.22.0", ) - @deprecate_argument("circuit_indices", new_alias="circuits", since="0.21.0") - @deprecate_argument("observable_indices", new_alias="observables", since="0.21.0") + @deprecate_arg("circuit_indices", new_alias="circuits", since="0.21.0") + @deprecate_arg("observable_indices", new_alias="observables", since="0.21.0") def __call__( self, circuits: Sequence[int | QuantumCircuit], diff --git a/qiskit/primitives/base/base_sampler.py b/qiskit/primitives/base/base_sampler.py index 51b4c94da383..72ffee12446c 100644 --- a/qiskit/primitives/base/base_sampler.py +++ b/qiskit/primitives/base/base_sampler.py @@ -85,7 +85,7 @@ from qiskit.circuit import Parameter, QuantumCircuit from qiskit.circuit.parametertable import ParameterView from qiskit.providers import JobV1 as Job -from qiskit.utils.deprecation import deprecate_argument, deprecate_function +from qiskit.utils.deprecation import deprecate_arg, deprecate_function from ..utils import _circuit_key from .base_primitive import BasePrimitive @@ -100,10 +100,10 @@ class BaseSampler(BasePrimitive): __hash__ = None - @deprecate_argument( + @deprecate_arg( "circuits", since="0.22", additional_msg="Instead, use the run() method to append objects." ) - @deprecate_argument( + @deprecate_arg( "parameters", since="0.22", additional_msg="Instead, use the run() method to append objects.", @@ -283,7 +283,7 @@ def close(self): "Use run method instead.", since="0.22.0", ) - @deprecate_argument("circuit_indices", new_alias="circuits", since="0.21.0") + @deprecate_arg("circuit_indices", new_alias="circuits", since="0.21.0") def __call__( self, circuits: Sequence[int | QuantumCircuit], diff --git a/qiskit/providers/basicaer/qasm_simulator.py b/qiskit/providers/basicaer/qasm_simulator.py index 22ad8b466606..7c1231d99334 100644 --- a/qiskit/providers/basicaer/qasm_simulator.py +++ b/qiskit/providers/basicaer/qasm_simulator.py @@ -38,7 +38,7 @@ import numpy as np from qiskit.circuit.quantumcircuit import QuantumCircuit -from qiskit.utils.deprecation import deprecate_argument +from qiskit.utils.deprecation import deprecate_arg from qiskit.utils.multiprocessing import local_hardware_info from qiskit.providers.models import QasmBackendConfiguration from qiskit.result import Result @@ -374,7 +374,7 @@ def _validate_measure_sampling(self, experiment): # measure sampling is allowed self._sample_measure = True - @deprecate_argument( + @deprecate_arg( "qobj", deprecation_description="Using a qobj for the first argument to QasmSimulatorPy.run()", since="0.22.0", diff --git a/qiskit/providers/models/backendconfiguration.py b/qiskit/providers/models/backendconfiguration.py index 703ace0ddfaf..df4d7c46d27e 100644 --- a/qiskit/providers/models/backendconfiguration.py +++ b/qiskit/providers/models/backendconfiguration.py @@ -26,7 +26,7 @@ DriveChannel, MeasureChannel, ) -from qiskit.utils.deprecation import deprecate_argument +from qiskit.utils.deprecation import deprecate_arg class GateConfig: @@ -831,7 +831,7 @@ def acquire(self, qubit: int) -> AcquireChannel: raise BackendConfigurationError(f"Invalid index for {qubit}-qubit systems.") return AcquireChannel(qubit) - @deprecate_argument( + @deprecate_arg( "qubits", since="0.19.0", additional_msg=( diff --git a/qiskit/pulse/library/symbolic_pulses.py b/qiskit/pulse/library/symbolic_pulses.py index dbd728b66c94..afa516d61293 100644 --- a/qiskit/pulse/library/symbolic_pulses.py +++ b/qiskit/pulse/library/symbolic_pulses.py @@ -29,7 +29,7 @@ from qiskit.pulse.library.pulse import Pulse from qiskit.pulse.library.waveform import Waveform from qiskit.utils import optionals as _optional -from qiskit.utils.deprecation import deprecate_argument +from qiskit.utils.deprecation import deprecate_arg if _optional.HAS_SYMENGINE: import symengine as sym @@ -587,7 +587,7 @@ class ScalableSymbolicPulse(SymbolicPulse): :math:'\text{amp}\times\exp\left(i\times\text{angle}\right)' is compared. """ - @deprecate_argument( + @deprecate_arg( "amp", deprecation_description=( "Setting `amp` to a complex in the ScalableSymbolicPulse constructor" diff --git a/qiskit/qobj/pulse_qobj.py b/qiskit/qobj/pulse_qobj.py index 09334ecb64be..caa4d8738436 100644 --- a/qiskit/qobj/pulse_qobj.py +++ b/qiskit/qobj/pulse_qobj.py @@ -23,7 +23,7 @@ from qiskit.qobj.common import QobjDictField from qiskit.qobj.common import QobjHeader from qiskit.qobj.common import QobjExperimentHeader -from qiskit.utils.deprecation import deprecate_argument +from qiskit.utils.deprecation import deprecate_arg class QobjMeasurementOption: @@ -283,7 +283,7 @@ def _to_complex(value: Union[List[float], complex]) -> complex: class PulseQobjConfig(QobjDictField): """A configuration for a Pulse Qobj.""" - @deprecate_argument( + @deprecate_arg( "max_credits", since="0.20.0", additional_msg=( diff --git a/qiskit/qobj/qasm_qobj.py b/qiskit/qobj/qasm_qobj.py index 237a174576a9..69422ace83d1 100644 --- a/qiskit/qobj/qasm_qobj.py +++ b/qiskit/qobj/qasm_qobj.py @@ -18,7 +18,7 @@ from qiskit.circuit.parameterexpression import ParameterExpression from qiskit.qobj.pulse_qobj import PulseQobjInstruction, PulseLibraryItem from qiskit.qobj.common import QobjDictField, QobjHeader -from qiskit.utils.deprecation import deprecate_argument +from qiskit.utils.deprecation import deprecate_arg class QasmQobjInstruction: @@ -279,7 +279,7 @@ def __eq__(self, other): class QasmQobjConfig(SimpleNamespace): """A configuration for a QASM Qobj.""" - @deprecate_argument( + @deprecate_arg( "max_credits", since="0.20.0", additional_msg=( diff --git a/qiskit/qpy/interface.py b/qiskit/qpy/interface.py index fd76554b8d6c..a22ce5f20db3 100644 --- a/qiskit/qpy/interface.py +++ b/qiskit/qpy/interface.py @@ -25,7 +25,7 @@ from qiskit.qpy import formats, common, binary_io, type_keys from qiskit.qpy.exceptions import QpyError from qiskit.version import __version__ -from qiskit.utils.deprecation import deprecate_argument +from qiskit.utils.deprecation import deprecate_arg # pylint: disable=invalid-name @@ -72,7 +72,7 @@ VERSION_PATTERN_REGEX = re.compile(VERSION_PATTERN, re.VERBOSE | re.IGNORECASE) -@deprecate_argument("circuits", new_alias="programs", since="0.21.0") +@deprecate_arg("circuits", new_alias="programs", since="0.21.0") def dump( programs: Union[List[QPY_SUPPORTED_TYPES], QPY_SUPPORTED_TYPES], file_obj: BinaryIO, diff --git a/qiskit/quantum_info/operators/symplectic/pauli_utils.py b/qiskit/quantum_info/operators/symplectic/pauli_utils.py index 1bbf134bae62..f157646db6ce 100644 --- a/qiskit/quantum_info/operators/symplectic/pauli_utils.py +++ b/qiskit/quantum_info/operators/symplectic/pauli_utils.py @@ -14,10 +14,10 @@ """ from qiskit.quantum_info.operators.symplectic.pauli_list import PauliList -from qiskit.utils.deprecation import deprecate_argument +from qiskit.utils.deprecation import deprecate_arg -@deprecate_argument( +@deprecate_arg( "pauli_basis", since="0.22", additional_msg=( diff --git a/qiskit/quantum_info/synthesis/two_qubit_decompose.py b/qiskit/quantum_info/synthesis/two_qubit_decompose.py index c6ba88ba8b38..43d0d4a9e4be 100644 --- a/qiskit/quantum_info/synthesis/two_qubit_decompose.py +++ b/qiskit/quantum_info/synthesis/two_qubit_decompose.py @@ -43,7 +43,7 @@ OneQubitEulerDecomposer, DEFAULT_ATOL, ) -from qiskit.utils.deprecation import deprecate_argument +from qiskit.utils.deprecation import deprecate_arg logger = logging.getLogger(__name__) @@ -1085,7 +1085,7 @@ def decomp3_supercontrolled(self, target): return U3r, U3l, U2r, U2l, U1r, U1l, U0r, U0l - @deprecate_argument("target", new_alias="unitary", since="0.23.0") + @deprecate_arg("target", new_alias="unitary", since="0.23.0") def __call__( self, unitary: Union[Operator, np.ndarray], diff --git a/qiskit/synthesis/evolution/suzuki_trotter.py b/qiskit/synthesis/evolution/suzuki_trotter.py index 82aa6696b5a1..cba416fa5fa3 100644 --- a/qiskit/synthesis/evolution/suzuki_trotter.py +++ b/qiskit/synthesis/evolution/suzuki_trotter.py @@ -18,7 +18,7 @@ from qiskit.circuit.quantumcircuit import QuantumCircuit from qiskit.quantum_info.operators import SparsePauliOp, Pauli -from qiskit.utils.deprecation import deprecate_argument +from qiskit.utils.deprecation import deprecate_arg from .product_formula import ProductFormula @@ -51,7 +51,7 @@ class SuzukiTrotter(ProductFormula): `arXiv:math-ph/0506007 `_ """ - @deprecate_argument( + @deprecate_arg( "order", deprecation_description=( "Setting `order` to an odd number in the constructor of SuzukiTrotter" diff --git a/qiskit/transpiler/instruction_durations.py b/qiskit/transpiler/instruction_durations.py index 26302e4f379c..28d649635309 100644 --- a/qiskit/transpiler/instruction_durations.py +++ b/qiskit/transpiler/instruction_durations.py @@ -18,7 +18,7 @@ from qiskit.circuit.duration import duration_in_dt from qiskit.providers import Backend from qiskit.transpiler.exceptions import TranspilerError -from qiskit.utils.deprecation import deprecate_argument +from qiskit.utils.deprecation import deprecate_arg from qiskit.utils.units import apply_prefix @@ -164,7 +164,7 @@ def update(self, inst_durations: Optional["InstructionDurationsType"], dt: float return self - @deprecate_argument( + @deprecate_arg( "qubits", deprecation_description=( "Using a Qubit or List[Qubit] for the `qubits` argument to InstructionDurations.get()" diff --git a/qiskit/transpiler/passes/calibration/rzx_builder.py b/qiskit/transpiler/passes/calibration/rzx_builder.py index c35b657d14ba..7f21ff0c8098 100644 --- a/qiskit/transpiler/passes/calibration/rzx_builder.py +++ b/qiskit/transpiler/passes/calibration/rzx_builder.py @@ -34,7 +34,7 @@ from qiskit.pulse.filters import filter_instructions from qiskit.pulse.instruction_schedule_map import InstructionScheduleMap from qiskit.transpiler.target import Target -from qiskit.utils.deprecation import deprecate_argument +from qiskit.utils.deprecation import deprecate_arg from .base_builder import CalibrationBuilder from .exceptions import CalibrationNotAvailable @@ -64,7 +64,7 @@ class RZXCalibrationBuilder(CalibrationBuilder): angle. Additional details can be found in https://arxiv.org/abs/2012.11660. """ - @deprecate_argument("qubit_channel_mapping", since="0.22.0") + @deprecate_arg("qubit_channel_mapping", since="0.22.0") def __init__( self, instruction_schedule_map: InstructionScheduleMap = None, diff --git a/qiskit/transpiler/target.py b/qiskit/transpiler/target.py index 5d2c1a93d9f0..d94ac2e83ce5 100644 --- a/qiskit/transpiler/target.py +++ b/qiskit/transpiler/target.py @@ -35,7 +35,7 @@ from qiskit.transpiler.exceptions import TranspilerError from qiskit.transpiler.instruction_durations import InstructionDurations from qiskit.transpiler.timing_constraints import TimingConstraints -from qiskit.utils.deprecation import deprecate_argument +from qiskit.utils.deprecation import deprecate_arg # import QubitProperties here to provide convenience alias for building a # full target @@ -203,7 +203,7 @@ class Target(Mapping): "_global_operations", ) - @deprecate_argument("aquire_alignment", new_alias="acquire_alignment", since="0.23.0") + @deprecate_arg("aquire_alignment", new_alias="acquire_alignment", since="0.23.0") def __init__( self, description=None, diff --git a/qiskit/utils/__init__.py b/qiskit/utils/__init__.py index ffda1bf930dc..752139af58ff 100644 --- a/qiskit/utils/__init__.py +++ b/qiskit/utils/__init__.py @@ -64,7 +64,7 @@ """ from .quantum_instance import QuantumInstance -from .deprecation import deprecate_argument, deprecate_arguments +from .deprecation import deprecate_arg, deprecate_arguments from .deprecation import deprecate_function from .multiprocessing import local_hardware_info from .multiprocessing import is_main_process @@ -93,7 +93,7 @@ "has_aer", "name_args", "algorithm_globals", - "deprecate_argument", + "deprecate_arg", "deprecate_arguments", "deprecate_function", "local_hardware_info", diff --git a/qiskit/utils/deprecation.py b/qiskit/utils/deprecation.py index 5f98ea993974..078b78dff45f 100644 --- a/qiskit/utils/deprecation.py +++ b/qiskit/utils/deprecation.py @@ -18,7 +18,7 @@ from typing import Any, Callable, ClassVar, Dict, Optional, Type -def deprecate_argument( +def deprecate_arg( name: str, *, since: str, @@ -108,7 +108,7 @@ def deprecate_arguments( *, since: Optional[str] = None, ): - """Deprecated in favor of `deprecate_argument` instead. + """Deprecated in favor of `deprecate_arg` instead. Args: kwarg_map: A dictionary of the old argument name to the new name. diff --git a/qiskit/visualization/circuit/_utils.py b/qiskit/visualization/circuit/_utils.py index 0edf80826bc6..27933755f6e2 100644 --- a/qiskit/visualization/circuit/_utils.py +++ b/qiskit/visualization/circuit/_utils.py @@ -31,7 +31,7 @@ from qiskit.circuit.tools import pi_check from qiskit.converters import circuit_to_dag from qiskit.utils import optionals as _optionals -from qiskit.utils.deprecation import deprecate_argument +from qiskit.utils.deprecation import deprecate_arg from ..exceptions import VisualizationError @@ -196,7 +196,7 @@ def get_bit_register(circuit, bit): return bit_loc.registers[0][0] if bit_loc.registers else None -@deprecate_argument("reverse_bits", since="0.22.0") +@deprecate_arg("reverse_bits", since="0.22.0") def get_bit_reg_index(circuit, bit, reverse_bits=None): """Get the register for a bit if there is one, and the index of the bit from the top of the circuit, or the index of the bit within a register. @@ -284,7 +284,7 @@ def get_wire_label(drawer, register, index, layout=None, cregbundle=True): return wire_label -@deprecate_argument("reverse_bits", since="0.22.0") +@deprecate_arg("reverse_bits", since="0.22.0") def get_condition_label_val(condition, circuit, cregbundle, reverse_bits=None): """Get the label and value list to display a condition diff --git a/qiskit/visualization/circuit/latex.py b/qiskit/visualization/circuit/latex.py index 28fd029045bd..b43933bc00fe 100644 --- a/qiskit/visualization/circuit/latex.py +++ b/qiskit/visualization/circuit/latex.py @@ -24,7 +24,7 @@ from qiskit.circuit.library.standard_gates import SwapGate, XGate, ZGate, RZZGate, U1Gate, PhaseGate from qiskit.circuit.measure import Measure from qiskit.circuit.tools.pi_check import pi_check -from qiskit.utils.deprecation import deprecate_argument +from qiskit.utils.deprecation import deprecate_arg from .qcstyle import load_style from ._utils import ( @@ -48,11 +48,11 @@ class QCircuitImage: Thanks to Eric Sabo for the initial implementation for Qiskit. """ - @deprecate_argument("gregs", since="0.20.0") - @deprecate_argument("cregs", since="0.20.0") - @deprecate_argument("layout", since="0.20.0") - @deprecate_argument("global_phase", since="0.20.0") - @deprecate_argument( + @deprecate_arg("gregs", since="0.20.0") + @deprecate_arg("cregs", since="0.20.0") + @deprecate_arg("layout", since="0.20.0") + @deprecate_arg("global_phase", since="0.20.0") + @deprecate_arg( "circuit", deprecation_description=( "Not setting the `circuit` argument in the `QCircuitImage` constructor`" diff --git a/qiskit/visualization/circuit/matplotlib.py b/qiskit/visualization/circuit/matplotlib.py index 305adae326f3..90d6971286bb 100644 --- a/qiskit/visualization/circuit/matplotlib.py +++ b/qiskit/visualization/circuit/matplotlib.py @@ -33,7 +33,7 @@ from qiskit.extensions import Initialize from qiskit.circuit.tools.pi_check import pi_check from qiskit.utils import optionals as _optionals -from qiskit.utils.deprecation import deprecate_argument +from qiskit.utils.deprecation import deprecate_arg from .qcstyle import load_style from ._utils import ( @@ -65,12 +65,12 @@ class MatplotlibDrawer: _mathmode_regex = re.compile(r"(? bool: return False -@deprecate_argument( +@deprecate_arg( "data", deprecation_description=( "Using plot_histogram() `data` argument with QuasiDistribution, ProbDistribution, or a " diff --git a/qiskit/visualization/state_visualization.py b/qiskit/visualization/state_visualization.py index 735a36769a2e..1b43d2815d7d 100644 --- a/qiskit/visualization/state_visualization.py +++ b/qiskit/visualization/state_visualization.py @@ -26,7 +26,7 @@ from qiskit.quantum_info.states.statevector import Statevector from qiskit.quantum_info.operators.symplectic import PauliList, SparsePauliOp from qiskit.quantum_info.states.densitymatrix import DensityMatrix -from qiskit.utils.deprecation import deprecate_argument +from qiskit.utils.deprecation import deprecate_arg from qiskit.utils import optionals as _optionals from qiskit.circuit.tools.pi_check import pi_check @@ -35,7 +35,7 @@ from .exceptions import VisualizationError -@deprecate_argument("rho", new_alias="state", since="0.15.1") +@deprecate_arg("rho", new_alias="state", since="0.15.1") @_optionals.HAS_MATPLOTLIB.require_in_call def plot_state_hinton( state, title="", figsize=None, ax_real=None, ax_imag=None, *, rho=None, filename=None @@ -250,7 +250,7 @@ def plot_bloch_vector(bloch, title="", ax=None, figsize=None, coord_type="cartes return None -@deprecate_argument("rho", new_alias="state", since="0.15.1") +@deprecate_arg("rho", new_alias="state", since="0.15.1") @_optionals.HAS_MATPLOTLIB.require_in_call def plot_bloch_multivector( state, title="", figsize=None, *, rho=None, reverse_bits=False, filename=None @@ -338,7 +338,7 @@ def plot_bloch_multivector( return fig.savefig(filename) -@deprecate_argument("rho", new_alias="state", since="0.15.1") +@deprecate_arg("rho", new_alias="state", since="0.15.1") @_optionals.HAS_MATPLOTLIB.require_in_call def plot_state_city( state, @@ -595,7 +595,7 @@ def plot_state_city( return fig.savefig(filename) -@deprecate_argument("rho", new_alias="state", since="0.15.1") +@deprecate_arg("rho", new_alias="state", since="0.15.1") @_optionals.HAS_MATPLOTLIB.require_in_call def plot_state_paulivec( state, title="", figsize=None, color=None, ax=None, *, rho=None, filename=None @@ -766,7 +766,7 @@ def phase_to_rgb(complex_number): return rgb -@deprecate_argument("rho", new_alias="state", since="0.15.1") +@deprecate_arg("rho", new_alias="state", since="0.15.1") @_optionals.HAS_MATPLOTLIB.require_in_call @_optionals.HAS_SEABORN.require_in_call def plot_state_qsphere( diff --git a/test/python/utils/test_deprecation.py b/test/python/utils/test_deprecation.py index 8aa8aff61a89..6886f866d8c7 100644 --- a/test/python/utils/test_deprecation.py +++ b/test/python/utils/test_deprecation.py @@ -16,7 +16,7 @@ from qiskit.utils.deprecation import ( _DeprecationMetadataEntry, deprecate_function, - deprecate_argument, + deprecate_arg, deprecate_arguments, ) @@ -25,17 +25,17 @@ class TestDeprecations(QiskitTestCase): """Test functions in ``utils.deprecation``.""" def test_deprecate_argument_metadata(self) -> None: - """Test that `@deprecate_argument` stores the correct metadata.""" + """Test that `@deprecate_arg` stores the correct metadata.""" - @deprecate_argument("arg1", since="9.99") - @deprecate_argument("arg2", pending=True, since="9.99") - @deprecate_argument( + @deprecate_arg("arg1", since="9.99") + @deprecate_arg("arg2", pending=True, since="9.99") + @deprecate_arg( "arg3", since="9.99", deprecation_description="Using the argument arg3", new_alias="new_arg3", ) - @deprecate_argument( + @deprecate_arg( "arg4", since="9.99", additional_msg="Instead, use foo.", @@ -131,16 +131,16 @@ def my_func() -> None: ) def test_deprecate_argument_runtime_warning(self) -> None: - """Test that `@deprecate_argument` warns whenever the arguments are used. + """Test that `@deprecate_arg` warns whenever the arguments are used. Also check these edge cases: * If `new_alias` is set, pass the old argument as the new alias. * If `predicate` is set, only warn if the predicate is True. """ - @deprecate_argument("arg1", since="9.99") - @deprecate_argument("arg2", new_alias="new_arg2", since="9.99") - @deprecate_argument("arg3", predicate=lambda arg3: arg3 == "deprecated value", since="9.99") + @deprecate_arg("arg1", since="9.99") + @deprecate_arg("arg2", new_alias="new_arg2", since="9.99") + @deprecate_arg("arg3", predicate=lambda arg3: arg3 == "deprecated value", since="9.99") def my_func(*, arg1: str = "a", new_arg2: str, arg3: str = "a") -> None: del arg1 del arg3