Rename to deprecate_arg

Qiskit · Feb 27, 2023 · da959d3 · da959d3
1 parent 6476507
commit da959d3
Show file tree

Hide file tree

Showing 38 changed files with 114 additions and 118 deletions.
diff --git 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 <http://arxiv.org/abs/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
@@ -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 <https://arxiv.org/abs/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
@@ -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
@@ -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 <http://arxiv.org/abs/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
@@ -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 <http://arxiv.org/abs/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
@@ -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
@@ -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
@@ -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
@@ -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 <https://arxiv.org/abs/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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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,20 +36,16 @@ def _log_submission_time(start_time, end_time):
     logger.info(log_msg)
 
 
-@deprecate_argument(
+@deprecate_arg(
     "max_credits",
     since="0.20.0",
     additional_msg=(
         "This argument has no effect on modern IBM Quantum systems, and no alternative is"
         "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
@@ -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
@@ -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
@@ -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",