From dc30bba99b36c5ef8ae1310936eb485a9f240d32 Mon Sep 17 00:00:00 2001 From: Eric Arellano Date: Mon, 20 Feb 2023 08:29:40 -0600 Subject: [PATCH] Pending deprecations set version to when the deprecation will become official --- qiskit/algorithms/amplitude_amplifiers/grover.py | 4 ++-- qiskit/algorithms/amplitude_estimators/ae.py | 4 ++-- qiskit/algorithms/amplitude_estimators/fae.py | 4 ++-- qiskit/algorithms/amplitude_estimators/iae.py | 4 ++-- qiskit/algorithms/amplitude_estimators/mlae.py | 4 ++-- qiskit/algorithms/aux_ops_evaluator.py | 2 +- qiskit/algorithms/eigen_solvers/eigen_solver.py | 4 ++-- qiskit/algorithms/eigen_solvers/numpy_eigen_solver.py | 2 +- qiskit/algorithms/eigen_solvers/vqd.py | 4 ++-- qiskit/algorithms/evolvers/evolution_problem.py | 2 +- qiskit/algorithms/evolvers/evolution_result.py | 2 +- qiskit/algorithms/evolvers/imaginary_evolver.py | 2 +- qiskit/algorithms/evolvers/real_evolver.py | 2 +- qiskit/algorithms/evolvers/trotterization/trotter_qrte.py | 2 +- .../minimum_eigen_solvers/minimum_eigen_solver.py | 4 ++-- .../minimum_eigen_solvers/numpy_minimum_eigen_solver.py | 2 +- qiskit/algorithms/minimum_eigen_solvers/qaoa.py | 2 +- qiskit/algorithms/minimum_eigen_solvers/vqe.py | 4 ++-- qiskit/utils/deprecation.py | 6 ++++-- 19 files changed, 31 insertions(+), 29 deletions(-) diff --git a/qiskit/algorithms/amplitude_amplifiers/grover.py b/qiskit/algorithms/amplitude_amplifiers/grover.py index 0e0c1decd0e7..fde4370b92e2 100644 --- a/qiskit/algorithms/amplitude_amplifiers/grover.py +++ b/qiskit/algorithms/amplitude_amplifiers/grover.py @@ -196,7 +196,7 @@ def __init__( "This property will be deprecated in a future release and subsequently " "removed after that.", category=PendingDeprecationWarning, - since="0.23.0", + since="0.24.0", ) def quantum_instance(self) -> Optional[QuantumInstance]: r"""Pending deprecation\; Get the quantum instance. @@ -212,7 +212,7 @@ def quantum_instance(self) -> Optional[QuantumInstance]: "This property will be deprecated in a future release and subsequently " "removed after that.", category=PendingDeprecationWarning, - since="0.23.0", + since="0.24.0", ) def quantum_instance(self, quantum_instance: Union[QuantumInstance, Backend]) -> None: r"""Pending deprecation\; Set quantum instance. diff --git a/qiskit/algorithms/amplitude_estimators/ae.py b/qiskit/algorithms/amplitude_estimators/ae.py index 91521eede709..413027fa5b79 100644 --- a/qiskit/algorithms/amplitude_estimators/ae.py +++ b/qiskit/algorithms/amplitude_estimators/ae.py @@ -129,7 +129,7 @@ def sampler(self, sampler: BaseSampler) -> None: "This property will be deprecated in a future release and subsequently " "removed after that.", category=PendingDeprecationWarning, - since="0.23.0", + since="0.24.0", ) def quantum_instance(self) -> QuantumInstance | None: """Pending deprecation; Get the quantum instance. @@ -145,7 +145,7 @@ def quantum_instance(self) -> QuantumInstance | None: "This property will be deprecated in a future release and subsequently " "removed after that.", category=PendingDeprecationWarning, - since="0.23.0", + since="0.24.0", ) def quantum_instance(self, quantum_instance: QuantumInstance | Backend) -> None: """Pending deprecation; Set quantum instance. diff --git a/qiskit/algorithms/amplitude_estimators/fae.py b/qiskit/algorithms/amplitude_estimators/fae.py index c1bb0eec9846..65b487878689 100644 --- a/qiskit/algorithms/amplitude_estimators/fae.py +++ b/qiskit/algorithms/amplitude_estimators/fae.py @@ -114,7 +114,7 @@ def sampler(self, sampler: BaseSampler) -> None: "This property will be deprecated in a future release and subsequently " "removed after that.", category=PendingDeprecationWarning, - since="0.23.0", + since="0.24.0", ) def quantum_instance(self) -> QuantumInstance | None: """Pending deprecation; Get the quantum instance. @@ -130,7 +130,7 @@ def quantum_instance(self) -> QuantumInstance | None: "This property will be deprecated in a future release and subsequently " "removed after that.", category=PendingDeprecationWarning, - since="0.23.0", + since="0.24.0", ) def quantum_instance(self, quantum_instance: QuantumInstance | Backend) -> None: """Pending deprecation; Set quantum instance. diff --git a/qiskit/algorithms/amplitude_estimators/iae.py b/qiskit/algorithms/amplitude_estimators/iae.py index 0b0348c15adf..33f3310b3e8b 100644 --- a/qiskit/algorithms/amplitude_estimators/iae.py +++ b/qiskit/algorithms/amplitude_estimators/iae.py @@ -137,7 +137,7 @@ def sampler(self, sampler: BaseSampler) -> None: "This property will be deprecated in a future release and subsequently " "removed after that.", category=PendingDeprecationWarning, - since="0.23.0", + since="0.24.0", ) def quantum_instance(self) -> QuantumInstance | None: """Pending deprecation; Get the quantum instance. @@ -153,7 +153,7 @@ def quantum_instance(self) -> QuantumInstance | None: "This property will be deprecated in a future release and subsequently " "removed after that.", category=PendingDeprecationWarning, - since="0.23.0", + since="0.24.0", ) def quantum_instance(self, quantum_instance: QuantumInstance | Backend) -> None: """Pending deprecation; Set quantum instance. diff --git a/qiskit/algorithms/amplitude_estimators/mlae.py b/qiskit/algorithms/amplitude_estimators/mlae.py index 45ab626ce507..8284052fe8f0 100644 --- a/qiskit/algorithms/amplitude_estimators/mlae.py +++ b/qiskit/algorithms/amplitude_estimators/mlae.py @@ -141,7 +141,7 @@ def sampler(self, sampler: BaseSampler) -> None: "This property will be deprecated in a future release and subsequently " "removed after that.", category=PendingDeprecationWarning, - since="0.23.0", + since="0.24.0", ) def quantum_instance(self) -> QuantumInstance | None: """Pending deprecation; Get the quantum instance. @@ -157,7 +157,7 @@ def quantum_instance(self) -> QuantumInstance | None: "This property will be deprecated in a future release and subsequently " "removed after that.", category=PendingDeprecationWarning, - since="0.23.0", + since="0.24.0", ) def quantum_instance(self, quantum_instance: QuantumInstance | Backend) -> None: """Pending deprecation; Set quantum instance. diff --git a/qiskit/algorithms/aux_ops_evaluator.py b/qiskit/algorithms/aux_ops_evaluator.py index 16c489f39331..8ccb8656962d 100644 --- a/qiskit/algorithms/aux_ops_evaluator.py +++ b/qiskit/algorithms/aux_ops_evaluator.py @@ -37,7 +37,7 @@ "This function will be deprecated in a future release and subsequently " "removed after that.", category=PendingDeprecationWarning, - since="0.23.0", + since="0.24.0", ) def eval_observables( quantum_instance: Union[QuantumInstance, Backend], diff --git a/qiskit/algorithms/eigen_solvers/eigen_solver.py b/qiskit/algorithms/eigen_solvers/eigen_solver.py index c62069154243..30e2debb7a57 100644 --- a/qiskit/algorithms/eigen_solvers/eigen_solver.py +++ b/qiskit/algorithms/eigen_solvers/eigen_solver.py @@ -42,7 +42,7 @@ class Eigensolver(ABC): "This interface will be deprecated in a future release and subsequently " "removed after that.", category=PendingDeprecationWarning, - since="0.23.0", + since="0.24.0", ) def __init__(self) -> None: pass @@ -95,7 +95,7 @@ class EigensolverResult(AlgorithmResult): "This class will be deprecated in a future release and subsequently " "removed after that.", category=PendingDeprecationWarning, - since="0.23.0", + since="0.24.0", ) def __init__(self) -> None: super().__init__() diff --git a/qiskit/algorithms/eigen_solvers/numpy_eigen_solver.py b/qiskit/algorithms/eigen_solvers/numpy_eigen_solver.py index 538494c01690..0da3a2fb0fe5 100755 --- a/qiskit/algorithms/eigen_solvers/numpy_eigen_solver.py +++ b/qiskit/algorithms/eigen_solvers/numpy_eigen_solver.py @@ -55,7 +55,7 @@ class NumPyEigensolver(Eigensolver): "This class will be deprecated in a future release and subsequently " "removed after that.", category=PendingDeprecationWarning, - since="0.23.0", + since="0.24.0", ) def __init__( self, diff --git a/qiskit/algorithms/eigen_solvers/vqd.py b/qiskit/algorithms/eigen_solvers/vqd.py index 70102c4b51dc..bffaa5c34569 100644 --- a/qiskit/algorithms/eigen_solvers/vqd.py +++ b/qiskit/algorithms/eigen_solvers/vqd.py @@ -102,7 +102,7 @@ class VQD(VariationalAlgorithm, Eigensolver): "This class will be deprecated in a future release and subsequently " "removed after that.", category=PendingDeprecationWarning, - since="0.23.0", + since="0.24.0", ) def __init__( self, @@ -773,7 +773,7 @@ class VQDResult(VariationalResult, EigensolverResult): "This class will be deprecated in a future release and subsequently " "removed after that.", category=PendingDeprecationWarning, - since="0.23.0", + since="0.24.0", ) def __init__(self) -> None: super().__init__() diff --git a/qiskit/algorithms/evolvers/evolution_problem.py b/qiskit/algorithms/evolvers/evolution_problem.py index 4a222d9e659f..2524ad8abe90 100644 --- a/qiskit/algorithms/evolvers/evolution_problem.py +++ b/qiskit/algorithms/evolvers/evolution_problem.py @@ -39,7 +39,7 @@ class EvolutionProblem: "This class will be deprecated in a future release and subsequently " "removed after that.", category=PendingDeprecationWarning, - since="0.23.0", + since="0.24.0", ) def __init__( self, diff --git a/qiskit/algorithms/evolvers/evolution_result.py b/qiskit/algorithms/evolvers/evolution_result.py index 400afb3b3cfe..bed811a22810 100644 --- a/qiskit/algorithms/evolvers/evolution_result.py +++ b/qiskit/algorithms/evolvers/evolution_result.py @@ -37,7 +37,7 @@ class EvolutionResult(AlgorithmResult): "This class will be deprecated in a future release and subsequently " "removed after that.", category=PendingDeprecationWarning, - since="0.23.0", + since="0.24.0", ) def __init__( self, diff --git a/qiskit/algorithms/evolvers/imaginary_evolver.py b/qiskit/algorithms/evolvers/imaginary_evolver.py index 37c78c3e5462..aa5ffdccbcdb 100644 --- a/qiskit/algorithms/evolvers/imaginary_evolver.py +++ b/qiskit/algorithms/evolvers/imaginary_evolver.py @@ -35,7 +35,7 @@ class ImaginaryEvolver(ABC): "This interface will be deprecated in a future release and subsequently " "removed after that.", category=PendingDeprecationWarning, - since="0.23.0", + since="0.24.0", ) def __init__(self) -> None: pass diff --git a/qiskit/algorithms/evolvers/real_evolver.py b/qiskit/algorithms/evolvers/real_evolver.py index 144d088eac26..2ce80bf664b1 100644 --- a/qiskit/algorithms/evolvers/real_evolver.py +++ b/qiskit/algorithms/evolvers/real_evolver.py @@ -35,7 +35,7 @@ class RealEvolver(ABC): "This interface will be deprecated in a future release and subsequently " "removed after that.", category=PendingDeprecationWarning, - since="0.23.0", + since="0.24.0", ) def __init__(self) -> None: pass diff --git a/qiskit/algorithms/evolvers/trotterization/trotter_qrte.py b/qiskit/algorithms/evolvers/trotterization/trotter_qrte.py index 4104b535ec0c..002d74b9b2de 100644 --- a/qiskit/algorithms/evolvers/trotterization/trotter_qrte.py +++ b/qiskit/algorithms/evolvers/trotterization/trotter_qrte.py @@ -70,7 +70,7 @@ class TrotterQRTE(RealEvolver): "This class will be deprecated in a future release and subsequently " "removed after that.", category=PendingDeprecationWarning, - since="0.23.0", + since="0.24.0", ) def __init__( self, diff --git a/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py b/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py index e1ea43b40647..11af266fae64 100644 --- a/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py +++ b/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py @@ -42,7 +42,7 @@ class MinimumEigensolver(ABC): "This interface will be deprecated in a future release and subsequently " "removed after that.", category=PendingDeprecationWarning, - since="0.23.0", + since="0.24.0", ) def __init__(self) -> None: pass @@ -99,7 +99,7 @@ class MinimumEigensolverResult(AlgorithmResult): "This class will be deprecated in a future release and subsequently " "removed after that.", category=PendingDeprecationWarning, - since="0.23.0", + since="0.24.0", ) def __init__(self) -> None: super().__init__() diff --git a/qiskit/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py b/qiskit/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py index 43fe10ac0ecc..22e37baca1f1 100644 --- a/qiskit/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py +++ b/qiskit/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py @@ -43,7 +43,7 @@ class NumPyMinimumEigensolver(MinimumEigensolver): "This class will be deprecated in a future release and subsequently " "removed after that.", category=PendingDeprecationWarning, - since="0.23.0", + since="0.24.0", ) def __init__( self, diff --git a/qiskit/algorithms/minimum_eigen_solvers/qaoa.py b/qiskit/algorithms/minimum_eigen_solvers/qaoa.py index be32ae36d58e..47fd1d11e162 100644 --- a/qiskit/algorithms/minimum_eigen_solvers/qaoa.py +++ b/qiskit/algorithms/minimum_eigen_solvers/qaoa.py @@ -65,7 +65,7 @@ class QAOA(VQE): "This class will be deprecated in a future release and subsequently " "removed after that.", category=PendingDeprecationWarning, - since="0.23.0", + since="0.24.0", ) def __init__( self, diff --git a/qiskit/algorithms/minimum_eigen_solvers/vqe.py b/qiskit/algorithms/minimum_eigen_solvers/vqe.py index 90197fd203e8..6a937397a880 100755 --- a/qiskit/algorithms/minimum_eigen_solvers/vqe.py +++ b/qiskit/algorithms/minimum_eigen_solvers/vqe.py @@ -133,7 +133,7 @@ def my_minimizer(fun, x0, jac=None, bounds=None) -> OptimizerResult: "This class will be deprecated in a future release and subsequently " "removed after that.", category=PendingDeprecationWarning, - since="0.23.0", + since="0.24.0", ) def __init__( self, @@ -673,7 +673,7 @@ class VQEResult(VariationalResult, MinimumEigensolverResult): "This class will be deprecated in a future release and subsequently " "removed after that.", category=PendingDeprecationWarning, - since="0.23.0", + since="0.24.0", ) def __init__(self) -> None: with warnings.catch_warnings(): diff --git a/qiskit/utils/deprecation.py b/qiskit/utils/deprecation.py index 93107540c972..1b0ac00e5d9e 100644 --- a/qiskit/utils/deprecation.py +++ b/qiskit/utils/deprecation.py @@ -29,7 +29,8 @@ def deprecate_arguments( kwarg_map: A dictionary of the old argument name to the new name. category: Usually either DeprecationWarning or PendingDeprecationWarning. since: The version the deprecation started at. Only Optional for backwards - compatibility - this should always be set. + compatibility - this should always be set. If the deprecation is pending, + set the version to when the deprecation will officially start. Returns: Callable: The decorated callable. @@ -61,7 +62,8 @@ def deprecate_function( stacklevel: The warning stacklevel to use, defaults to 2. category: Usually either DeprecationWarning or PendingDeprecationWarning. since: The version the deprecation started at. Only Optional for backwards - compatibility - this should always be set. + compatibility - this should always be set. If the deprecation is pending, + set the version to when the deprecation will officially start. Returns: Callable: The decorated, deprecated callable.