Deprecate PrimitivesV1 reference implementations and their utils

qiskit/primitives/backend_estimator.py

@@ -35,6 +35,7 @@
     Optimize1qGatesDecomposition,
     SetLayout,
 )
+from qiskit.utils.deprecation import deprecate_func
 
 from .base import BaseEstimator, EstimatorResult
 from .primitive_job import PrimitiveJob
@@ -104,6 +105,7 @@ class BackendEstimator(BaseEstimator[PrimitiveJob[EstimatorResult]]):
     precludes doing any provider- or backend-specific optimizations.
     """
 
+    @deprecate_func(since="1.0", additional_msg="Use BackendEstimatorV2 instead.")
     def __init__(
         self,
         backend: BackendV1 | BackendV2,

qiskit/primitives/backend_sampler.py

@@ -23,6 +23,7 @@
 from qiskit.providers.options import Options
 from qiskit.result import QuasiDistribution, Result
 from qiskit.transpiler.passmanager import PassManager
+from qiskit.utils.deprecation import deprecate_func
 
 from .backend_estimator import _prepare_counts, _run_circuits
 from .base import BaseSampler, SamplerResult
@@ -46,6 +47,7 @@ class BackendSampler(BaseSampler[PrimitiveJob[SamplerResult]]):
     precludes doing any provider- or backend-specific optimizations.
     """
 
+    @deprecate_func(since="1.0", additional_msg="Use BackendSamplerV2 instead.")
     def __init__(
         self,
         backend: BackendV1 | BackendV2,

qiskit/primitives/base/base_estimator.py

@@ -23,6 +23,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_func
 
 from ..containers import (
     DataBin,
@@ -103,6 +104,7 @@ class BaseEstimatorV1(BasePrimitive, Generic[T]):
 
     __hash__ = None
 
+    @deprecate_func(since="1.0", additional_msg="Use BaseEstimatorV2 instead.")
     def __init__(
         self,
         *,

qiskit/primitives/base/base_primitive.py

@@ -17,11 +17,13 @@
 from abc import ABC
 
 from qiskit.providers import Options
+from qiskit.utils.deprecation import deprecate_func
 
 
 class BasePrimitive(ABC):
     """Primitive abstract base class."""
 
+    @deprecate_func(since="1.0", additional_msg="Use BasePrimitiveV2 instead.")
     def __init__(self, options: dict | None = None):
         self._run_options = Options()
         if options is not None:

qiskit/primitives/base/base_result.py

@@ -19,6 +19,7 @@
 from collections.abc import Sequence
 from dataclasses import fields
 from typing import Any, Dict
+from warnings import warn
 
 from numpy import ndarray
 
@@ -42,6 +43,13 @@ def __post_init__(self) -> None:
             TypeError: If one of the data fields is not a Sequence or ``numpy.ndarray``.
             ValueError: Inconsistent number of experiments across data fields.
         """
+        warn(
+            "The class ``BasePrimitiveResult`` is deprecated as of qiskit 1.0. "
+            "It will be removed no earlier than 3 months after the release date. "
+            "Use PrimitiveResult class in `qiskit.primitives.containers` instead.",
+            DeprecationWarning,
+        )
+
         num_experiments = None
         for value in self._field_values:  # type: Sequence
             if num_experiments is None:

qiskit/primitives/base/base_sampler.py

@@ -21,6 +21,7 @@
 
 from qiskit.circuit import QuantumCircuit
 from qiskit.providers import JobV1 as Job
+from qiskit.utils.deprecation import deprecate_func
 
 from ..containers.primitive_result import PrimitiveResult
 from ..containers.sampler_pub import SamplerPubLike
@@ -96,6 +97,7 @@ class BaseSamplerV1(BasePrimitive, Generic[T]):
 
     __hash__ = None
 
+    @deprecate_func(since="1.0", additional_msg="Use BaseSamplerV2 instead.")
     def __init__(
         self,
         *,

qiskit/primitives/estimator.py

@@ -24,6 +24,7 @@
 from qiskit.exceptions import QiskitError
 from qiskit.quantum_info import Statevector
 from qiskit.quantum_info.operators.base_operator import BaseOperator
+from qiskit.utils.deprecation import deprecate_func
 
 from .base import BaseEstimator, EstimatorResult
 from .primitive_job import PrimitiveJob
@@ -51,6 +52,7 @@ class Estimator(BaseEstimator[PrimitiveJob[EstimatorResult]]):
           this option is ignored.
     """
 
+    @deprecate_func(since="1.0", additional_msg="Use StatevectorEstimator instead.")
     def __init__(self, *, options: dict | None = None):
         """
         Args:

qiskit/primitives/sampler.py

@@ -24,6 +24,7 @@
 from qiskit.exceptions import QiskitError
 from qiskit.quantum_info import Statevector
 from qiskit.result import QuasiDistribution
+from qiskit.utils.deprecation import deprecate_func
 
 from .base import BaseSampler, SamplerResult
 from .primitive_job import PrimitiveJob
@@ -52,6 +53,7 @@ class Sampler(BaseSampler[PrimitiveJob[SamplerResult]]):
           option is ignored.
     """
 
+    @deprecate_func(since="1.0", additional_msg="Use StatevectorSampler instead.")
     def __init__(self, *, options: dict | None = None):
         """
         Args:

qiskit/primitives/utils.py

@@ -25,8 +25,10 @@
 from qiskit.quantum_info import PauliList, SparsePauliOp, Statevector
 from qiskit.quantum_info.operators.base_operator import BaseOperator
 from qiskit.quantum_info.operators.symplectic.base_pauli import BasePauli
+from qiskit.utils.deprecation import deprecate_func
 
 
+@deprecate_func(since="1.0", additional_msg="There is no replacement for this.")
 def init_circuit(state: QuantumCircuit | Statevector) -> QuantumCircuit:
     """Initialize state by converting the input to a quantum circuit.
 
@@ -45,6 +47,7 @@ def init_circuit(state: QuantumCircuit | Statevector) -> QuantumCircuit:
     return qc
 
 
+@deprecate_func(since="1.0", additional_msg="There is no replacement for this.")
 def init_observable(observable: BaseOperator | str) -> SparsePauliOp:
     """Initialize observable by converting the input to a :class:`~qiskit.quantum_info.SparsePauliOp`.
 
@@ -68,6 +71,7 @@ def init_observable(observable: BaseOperator | str) -> SparsePauliOp:
         return SparsePauliOp(observable)
 
 
+@deprecate_func(since="1.0", additional_msg="There is no replacement for this.")
 def final_measurement_mapping(circuit: QuantumCircuit) -> dict[int, int]:
     """Return the final measurement mapping for the circuit.
 

releasenotes/notes/deprecate-primitives-v1.yaml

@@ -0,0 +1,14 @@
+---
+deprecations_primitives:
+  - |
+    BackendEstimator has been deprecated. Use BackendEstimatorV2 instead.
+    BackendSampler has been deprecated. Use BackendSamplerV2 instead.
+    Estimator has been deprecated. Use StatevectorEstimator instead.
+    Sampler has been deprecated. Use StatevectorSampler instead.
+
+    BaseEstimatorV1 has been deprecated. Use BaseEstimatorV2 instead.
+    BasePrimitive has been deprecated. Use BasePrimitiveV2 instead.
+    BasePrimitiveResult has been deprecated. Use PrimitiveResult class in `qiskit.primitives.containers` instead.
+    BaseSamplerV1 has been deprecated. Use BaseSamplerV2 instead.
+
+    Functions: init_circuit, init_observable and final_measurement_mapping has been deprecated. There is no replacement.