default package_name='qiskit' for deprecate_func and `deprecate_a…

…rgs` (#10877)

* changing the defailt to qiskit

* explict paramater with terra

* revert qiskit/scheduler/utils.py

* black

* change Aer

* Readjust deprecation message

---------

Co-authored-by: Julien Gacon <gaconju@gmail.com>
Co-authored-by: <57907331+ElePT@users.noreply.github.com>

* 0.45 and higher does not change

---------

Co-authored-by: Julien Gacon <gaconju@gmail.com>

docs/conf.py

@@ -242,6 +242,7 @@
 # Redirects
 # ----------------------------------------------------------------------------------
 
+
 def determine_api_redirects() -> dict[str, str]:
     """Set up API redirects for functions that we moved to module pages.
 
@@ -257,8 +258,7 @@ def determine_api_redirects() -> dict[str, str]:
         obj_name, new_module_page_name = line.split(" ")
         # E.g. `../apidoc/assembler.html#qiskit.assembler.assemble_circuits
         new_url = (
-            "https://qiskit.org/documentation/apidoc/" +
-            f"{new_module_page_name}.html#{obj_name}"
+            "https://qiskit.org/documentation/apidoc/" + f"{new_module_page_name}.html#{obj_name}"
         )
         result[f"stubs/{obj_name}"] = new_url
     return result

qiskit/algorithms/amplitude_amplifiers/grover.py

@@ -121,6 +121,7 @@ class Grover(AmplitudeAmplifier):
             "See https://qisk.it/algo_migration for a migration guide."
         ),
         since="0.24.0",
+        package_name="qiskit-terra",
     )
     def __init__(
         self,
@@ -198,6 +199,7 @@ def __init__(
     @property
     @deprecate_func(
         since="0.24.0",
+        package_name="qiskit-terra",
         is_property=True,
         additional_msg="See https://qisk.it/algo_migration for a migration guide.",
     )
@@ -212,6 +214,7 @@ def quantum_instance(self) -> QuantumInstance | None:
     @quantum_instance.setter
     @deprecate_func(
         since="0.24.0",
+        package_name="qiskit-terra",
         is_property=True,
         additional_msg="See https://qisk.it/algo_migration for a migration guide.",
     )

qiskit/algorithms/amplitude_estimators/ae.py

@@ -71,6 +71,7 @@ class AmplitudeEstimation(AmplitudeEstimator):
             "migration guide."
         ),
         since="0.24.0",
+        package_name="qiskit-terra",
     )
     def __init__(
         self,
@@ -135,6 +136,7 @@ def sampler(self, sampler: BaseSampler) -> None:
     @deprecate_func(
         additional_msg="See https://qisk.it/algo_migration for a migration guide.",
         since="0.24.0",
+        package_name="qiskit-terra",
         is_property=True,
     )
     def quantum_instance(self) -> QuantumInstance | None:
@@ -149,6 +151,7 @@ def quantum_instance(self) -> QuantumInstance | None:
     @deprecate_func(
         additional_msg="See https://qisk.it/algo_migration for a migration guide.",
         since="0.24.0",
+        package_name="qiskit-terra",
         is_property=True,
     )
     def quantum_instance(self, quantum_instance: QuantumInstance | Backend) -> None:

qiskit/algorithms/amplitude_estimators/fae.py

@@ -55,6 +55,7 @@ class FasterAmplitudeEstimation(AmplitudeEstimator):
             "migration guide."
         ),
         since="0.24.0",
+        package_name="qiskit-terra",
     )
     def __init__(
         self,
@@ -112,6 +113,7 @@ def sampler(self, sampler: BaseSampler) -> None:
     @property
     @deprecate_func(
         since="0.24.0",
+        package_name="qiskit-terra",
         is_property=True,
         additional_msg="See https://qisk.it/algo_migration for a migration guide.",
     )
@@ -126,6 +128,7 @@ def quantum_instance(self) -> QuantumInstance | None:
     @quantum_instance.setter
     @deprecate_func(
         since="0.24.0",
+        package_name="qiskit-terra",
         is_property=True,
         additional_msg="See https://qisk.it/algo_migration for a migration guide.",
     )

qiskit/algorithms/amplitude_estimators/iae.py

@@ -57,6 +57,7 @@ class IterativeAmplitudeEstimation(AmplitudeEstimator):
             "migration guide."
         ),
         since="0.24.0",
+        package_name="qiskit-terra",
     )
     def __init__(
         self,
@@ -135,6 +136,7 @@ def sampler(self, sampler: BaseSampler) -> None:
     @property
     @deprecate_func(
         since="0.24.0",
+        package_name="qiskit-terra",
         is_property=True,
         additional_msg="See https://qisk.it/algo_migration for a migration guide.",
     )
@@ -149,6 +151,7 @@ def quantum_instance(self) -> QuantumInstance | None:
     @quantum_instance.setter
     @deprecate_func(
         since="0.24.0",
+        package_name="qiskit-terra",
         is_property=True,
         additional_msg="See https://qisk.it/algo_migration for a migration guide.",
     )

qiskit/algorithms/amplitude_estimators/mlae.py

@@ -60,6 +60,7 @@ class in named ``MaximumLikelihoodAmplitudeEstimation``.
             "migration guide."
         ),
         since="0.24.0",
+        package_name="qiskit-terra",
     )
     def __init__(
         self,
@@ -139,6 +140,7 @@ def sampler(self, sampler: BaseSampler) -> None:
     @property
     @deprecate_func(
         since="0.24.0",
+        package_name="qiskit-terra",
         is_property=True,
         additional_msg="See https://qisk.it/algo_migration for a migration guide.",
     )
@@ -153,6 +155,7 @@ def quantum_instance(self) -> QuantumInstance | None:
     @quantum_instance.setter
     @deprecate_func(
         since="0.24.0",
+        package_name="qiskit-terra",
         is_property=True,
         additional_msg="See https://qisk.it/algo_migration for a migration guide.",
     )

qiskit/algorithms/aux_ops_evaluator.py

@@ -38,6 +38,7 @@
         "https://qisk.it/algo_migration for a migration guide."
     ),
     since="0.24.0",
+    package_name="qiskit-terra",
 )
 def eval_observables(
     quantum_instance: QuantumInstance | Backend,

qiskit/algorithms/eigen_solvers/numpy_eigen_solver.py

@@ -54,6 +54,7 @@ class NumPyEigensolver(Eigensolver):
             "See https://qisk.it/algo_migration for a migration guide."
         ),
         since="0.24.0",
+        package_name="qiskit-terra",
     )
     def __init__(
         self,

qiskit/algorithms/eigen_solvers/vqd.py

@@ -103,6 +103,7 @@ class VQD(VariationalAlgorithm, Eigensolver):
             "See https://qisk.it/algo_migration for a migration guide."
         ),
         since="0.24.0",
+        package_name="qiskit-terra",
     )
     def __init__(
         self,
@@ -781,6 +782,7 @@ class VQDResult(VariationalResult, EigensolverResult):
             "See https://qisk.it/algo_migration for a migration guide."
         ),
         since="0.24.0",
+        package_name="qiskit-terra",
     )
     def __init__(self) -> None:
         super().__init__()

qiskit/algorithms/evolvers/evolution_problem.py

@@ -39,6 +39,7 @@ class EvolutionProblem:
             "See https://qisk.it/algo_migration for a migration guide."
         ),
         since="0.24.0",
+        package_name="qiskit-terra",
     )
     def __init__(
         self,

qiskit/algorithms/evolvers/evolution_result.py

@@ -37,6 +37,7 @@ class EvolutionResult(AlgorithmResult):
             "See https://qisk.it/algo_migration for a migration guide."
         ),
         since="0.24.0",
+        package_name="qiskit-terra",
     )
     def __init__(
         self,

qiskit/algorithms/evolvers/real_evolver.py

@@ -35,6 +35,7 @@ class RealEvolver(ABC):
             "See https://qisk.it/algo_migration for a migration guide."
         ),
         since="0.24.0",
+        package_name="qiskit-terra",
     )
     def __init__(self) -> None:
         pass

qiskit/algorithms/evolvers/trotterization/trotter_qrte.py

@@ -71,6 +71,7 @@ class TrotterQRTE(RealEvolver):
             " See https://qisk.it/algo_migration for a migration guide."
         ),
         since="0.24.0",
+        package_name="qiskit-terra",
     )
     def __init__(
         self,

qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py

@@ -43,6 +43,7 @@ class MinimumEigensolver(ABC):
             "See https://qisk.it/algo_migration for a migration guide."
         ),
         since="0.24.0",
+        package_name="qiskit-terra",
     )
     def __init__(self) -> None:
         pass
@@ -100,6 +101,7 @@ class MinimumEigensolverResult(AlgorithmResult):
             "See https://qisk.it/algo_migration for a migration guide."
         ),
         since="0.24.0",
+        package_name="qiskit-terra",
     )
     def __init__(self) -> None:
         super().__init__()

qiskit/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py

@@ -46,6 +46,7 @@ class NumPyMinimumEigensolver(MinimumEigensolver):
             "See https://qisk.it/algo_migration for a migration guide."
         ),
         since="0.24.0",
+        package_name="qiskit-terra",
     )
     def __init__(
         self,

qiskit/algorithms/minimum_eigen_solvers/qaoa.py

@@ -67,6 +67,7 @@ class QAOA(VQE):
             "See https://qisk.it/algo_migration for a migration guide."
         ),
         since="0.24.0",
+        package_name="qiskit-terra",
     )
     def __init__(
         self,

qiskit/algorithms/minimum_eigen_solvers/vqe.py

@@ -133,6 +133,7 @@ def my_minimizer(fun, x0, jac=None, bounds=None) -> OptimizerResult:
             "See https://qisk.it/algo_migration for a migration guide."
         ),
         since="0.24.0",
+        package_name="qiskit-terra",
     )
     def __init__(
         self,
@@ -674,6 +675,7 @@ class VQEResult(VariationalResult, MinimumEigensolverResult):
             "See https://qisk.it/algo_migration for a migration guide."
         ),
         since="0.24.0",
+        package_name="qiskit-terra",
     )
     def __init__(self) -> None:
         with warnings.catch_warnings():

qiskit/algorithms/minimum_eigensolvers/adapt_vqe.py

@@ -101,6 +101,7 @@ class AdaptVQE(VariationalAlgorithm, MinimumEigensolver):
     @deprecate_arg(
         "threshold",
         since="0.24.0",
+        package_name="qiskit-terra",
         pending=True,
         new_alias="gradient_threshold",
     )
@@ -146,6 +147,7 @@ def __init__(
     @property
     @deprecate_func(
         since="0.24.0",
+        package_name="qiskit-terra",
         pending=True,
         is_property=True,
         additional_msg="Instead, use the gradient_threshold attribute.",
@@ -161,6 +163,7 @@ def threshold(self) -> float:
     @threshold.setter
     @deprecate_func(
         since="0.24.0",
+        package_name="qiskit-terra",
         pending=True,
         is_property=True,
         additional_msg="Instead, use the gradient_threshold attribute.",

qiskit/algorithms/optimizers/adam_amsgrad.py

@@ -195,9 +195,13 @@ def load_params(self, load_dir: str) -> None:
         t = t[1:-1]
         self._t = np.fromstring(t, dtype=int, sep=" ")
 
-    @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")
+    @deprecate_arg(
+        "objective_function", new_alias="fun", since="0.19.0", package_name="qiskit-terra"
+    )
+    @deprecate_arg("initial_point", new_alias="fun", since="0.19.0", package_name="qiskit-terra")
+    @deprecate_arg(
+        "gradient_function", new_alias="jac", since="0.19.0", package_name="qiskit-terra"
+    )
     def minimize(
         self,
         fun: Callable[[POINT], float],

qiskit/algorithms/optimizers/qnspsa.py

@@ -258,6 +258,7 @@ def settings(self) -> dict[str, Any]:
     @deprecate_arg(
         "backend",
         since="0.24.0",
+        package_name="qiskit-terra",
         additional_msg="See https://qisk.it/algo_migration for a migration guide.",
         # We allow passing a sampler as the second argument because that will become a positional
         # argument for `sampler` after removing `backend` and `expectation`.
@@ -266,6 +267,7 @@ def settings(self) -> dict[str, Any]:
     @deprecate_arg(
         "expectation",
         since="0.24.0",
+        package_name="qiskit-terra",
         additional_msg="See https://qisk.it/algo_migration for a migration guide.",
     )
     def get_fidelity(

qiskit/algorithms/optimizers/spsa.py

@@ -656,6 +656,7 @@ def get_support_level(self):
             "containing additional information."
         ),
         since="0.21.0",
+        package_name="qiskit-terra",
     )
     def optimize(
         self,

qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation.py

@@ -100,6 +100,7 @@ class HamiltonianPhaseEstimation:
             "migration guide."
         ),
         since="0.24.0",
+        package_name="qiskit-terra",
     )
     def __init__(
         self,

qiskit/algorithms/phase_estimators/ipe.py

@@ -46,6 +46,7 @@ class IterativePhaseEstimation(PhaseEstimator):
             "migration guide."
         ),
         since="0.24.0",
+        package_name="qiskit-terra",
     )
     def __init__(
         self,

qiskit/algorithms/phase_estimators/phase_estimation.py

@@ -88,6 +88,7 @@ class PhaseEstimation(PhaseEstimator):
             "migration guide."
         ),
         since="0.24.0",
+        package_name="qiskit-terra",
     )
     def __init__(
         self,

qiskit/algorithms/phase_estimators/phase_estimation_result.py

@@ -70,6 +70,7 @@ def circuit_result(self) -> Result:
     @deprecate_func(
         additional_msg="Instead, use the property ``phase``, which behaves the same.",
         since="0.18.0",
+        package_name="qiskit-terra",
         is_property=True,
     )
     def most_likely_phase(self) -> float:

qiskit/circuit/bit.py

@@ -63,6 +63,7 @@ def __init__(self, register=None, index=None):
     @deprecate_func(
         is_property=True,
         since="0.17",
+        package_name="qiskit-terra",
         additional_msg=(
             "Instead, use :meth:`~qiskit.circuit.quantumcircuit.QuantumCircuit.find_bit` to find "
             "all the containing registers within a circuit and the index of the bit within the "
@@ -85,6 +86,7 @@ def register(self):  # pylint: disable=bad-docstring-quotes
     @deprecate_func(
         is_property=True,
         since="0.17",
+        package_name="qiskit-terra",
         additional_msg=(
             "Instead, use :meth:`~qiskit.circuit.quantumcircuit.QuantumCircuit.find_bit` to find "
             "all the containing registers within a circuit and the index of the bit within the "

qiskit/circuit/classicalregister.py

@@ -64,6 +64,7 @@ class ClassicalRegister(Register):
             "provided, because the premise is wrong."
         ),
         since="0.23.0",
+        package_name="qiskit-terra",
     )
     def qasm(self):
         """Return OPENQASM string for this register."""

qiskit/circuit/instruction.py

@@ -523,6 +523,7 @@ def _qasmif(self, string):
             "provided, because the premise is wrong."
         ),
         since="0.25.0",
+        package_name="qiskit-terra",
     )
     def qasm(self):
         """Return a default OpenQASM string for the instruction.

qiskit/circuit/library/hamiltonian_gate.py

@@ -130,6 +130,7 @@ def _define(self):
 
     @deprecate_func(
         since="0.25.0",
+        package_name="qiskit-terra",
     )
     def qasm(self):
         """Raise an error, as QASM is not defined for the HamiltonianGate."""

qiskit/circuit/library/standard_gates/x.py

@@ -590,7 +590,7 @@ def _define(self):
 
         self.definition = qc
 
-    @deprecate_func(since="0.25.0")
+    @deprecate_func(since="0.25.0", package_name="qiskit-terra")
     def qasm(self):
         # Gross hack to override the Qiskit name with the name this gate has in Terra's version of
         # 'qelib1.inc'.  In general, the larger exporter mechanism should know about this to do the