Replacing AWSBraketJob with AmazonBraketTask

qiskit_braket_provider/__init__.py

@@ -2,7 +2,7 @@
 
 from .providers import (
     AWSBraketProvider,
-    AWSBraketJob,
+    AmazonBraketTask,
     AWSBraketBackend,
     BraketLocalBackend,
 )

qiskit_braket_provider/providers/__init__.py

@@ -17,9 +17,9 @@
     AWSBraketBackend
     BraketLocalBackend
     AWSBraketProvider
-    AWSBraketJob
+    AmazonBraketTask
 """
 
 from .braket_backend import AWSBraketBackend, BraketLocalBackend
 from .braket_provider import AWSBraketProvider
-from .braket_job import AWSBraketJob
+from .braket_job import AmazonBraketTask

qiskit_braket_provider/providers/braket_backend.py

@@ -19,7 +19,7 @@
     convert_qiskit_to_braket_circuits,
     wrap_circuits_in_verbatim_box,
 )
-from .braket_job import AWSBraketJob
+from .braket_job import AmazonBraketTask
 from .. import version
 from ..exception import QiskitBraketException
 
@@ -100,7 +100,7 @@ def control_channel(self, qubits: Iterable[int]):
 
     def run(
         self, run_input: Union[QuantumCircuit, List[QuantumCircuit]], **options
-    ) -> AWSBraketJob:
+    ) -> AmazonBraketTask:
         convert_input = (
             [run_input] if isinstance(run_input, QuantumCircuit) else list(run_input)
         )
@@ -127,7 +127,7 @@ def run(
 
         job_id = TASK_ID_DIVIDER.join(task.id for task in tasks)
 
-        return AWSBraketJob(
+        return AmazonBraketTask(
             job_id=job_id,
             tasks=tasks,
             backend=self,
@@ -179,7 +179,7 @@ def __init__(  # pylint: disable=too-many-arguments
         self._device = device
         self._target = aws_device_to_target(device=device)
 
-    def retrieve_job(self, job_id: str) -> AWSBraketJob:
+    def retrieve_job(self, job_id: str) -> AmazonBraketTask:
         """Return a single job submitted to AWS backend.
 
         Args:
@@ -190,7 +190,7 @@ def retrieve_job(self, job_id: str) -> AWSBraketJob:
         """
         task_ids = job_id.split(TASK_ID_DIVIDER)
 
-        return AWSBraketJob(
+        return AmazonBraketTask(
             job_id=job_id,
             backend=self,
             tasks=[AwsQuantumTask(arn=task_id) for task_id in task_ids],
@@ -255,6 +255,6 @@ def run(self, run_input, **options):
         tasks: List[AwsQuantumTask] = batch_task.tasks
         job_id = TASK_ID_DIVIDER.join(task.id for task in tasks)
 
-        return AWSBraketJob(
+        return AmazonBraketTask(
             job_id=job_id, tasks=tasks, backend=self, shots=options.get("shots")
         )

qiskit_braket_provider/providers/braket_job.py

@@ -10,8 +10,10 @@
 from qiskit.result import Result
 from qiskit.result.models import ExperimentResult, ExperimentResultData
 from retrying import retry
+from warnings import warn
 
 
+
 def retry_if_result_none(result):
     """Retry on result function."""
     return result is None
@@ -77,8 +79,8 @@ def _get_result_from_aws_tasks(
     return experiment_results
 
 
-class AWSBraketJob(JobV1):
-    """AWSBraketJob."""
+class AmazonBraketTask(JobV1):
+    """AmazonBraketTask."""
 
     def __init__(
         self,
@@ -87,7 +89,7 @@ def __init__(
         tasks: Union[List[LocalQuantumTask], List[AwsQuantumTask]],
         **metadata: Optional[dict]
     ):
-        """AWSBraketJob for local execution of circuits.
+        """AmazonBraketTask for local execution of circuits.
 
         Args:
             job_id: id of the job
@@ -147,3 +149,17 @@ def status(self):
             status = JobStatus.RUNNING
 
         return status
+
+
+
+class AWSBraketJob(AmazonBraketTask):
+
+    def __init_subclass__(cls, **kwargs):
+        """This throws a deprecation warning on subclassing."""
+        warn(f'{cls.__name__} is deprecated.', DeprecationWarning, stacklevel=2)
+        super().__init_subclass__(**kwargs)
+
+    def __init__(self, *args, **kwargs):
+        """This throws a deprecation warning on initialization."""
+        warn(f'{self.__class__.__name__} is deprecated.', DeprecationWarning, stacklevel=2)
+        super().__init__(*args, **kwargs)

tests/providers/test_braket_job.py

@@ -4,15 +4,15 @@
 
 from qiskit.providers import JobStatus
 
-from qiskit_braket_provider.providers import AWSBraketJob, BraketLocalBackend
+from qiskit_braket_provider.providers import AmazonBraketTask, BraketLocalBackend
 from tests.providers.mocks import MOCK_LOCAL_QUANTUM_TASK
 
 
-class TestAWSBraketJob(TestCase):
-    """Tests AWSBraketJob."""
+class TestAmazonBraketTask(TestCase):
+    """Tests AmazonBraketTask."""
 
     def _get_job(self):
-        return AWSBraketJob(
+        return AmazonBraketTask(
             backend=BraketLocalBackend(name="default"),
             job_id="AwesomeId",
             tasks=[MOCK_LOCAL_QUANTUM_TASK],
@@ -23,7 +23,7 @@ def test_job(self):
         """Tests job."""
         job = self._get_job()
 
-        self.assertTrue(isinstance(job, AWSBraketJob))
+        self.assertTrue(isinstance(job, AmazonBraketTask))
         self.assertEqual(job.shots, 10)
 
         self.assertEqual(job.status(), JobStatus.DONE)