Rename BraketTask to BraketQuantumTask (#173)

Author: speller26

qiskit_braket_provider/__init__.py

@@ -8,7 +8,7 @@
     BraketAwsBackend,
     BraketLocalBackend,
     BraketProvider,
-    BraketTask,
+    BraketQuantumTask,
     to_braket,
     to_qiskit,
 )

qiskit_braket_provider/providers/__init__.py

@@ -24,4 +24,4 @@
 from .braket_backend import AWSBraketBackend, BraketAwsBackend, BraketLocalBackend
 from .braket_job import AmazonBraketTask, AWSBraketJob
 from .braket_provider import AWSBraketProvider, BraketProvider
-from .braket_task import BraketTask
+from .braket_quantum_task import BraketQuantumTask

qiskit_braket_provider/providers/braket_backend.py

@@ -25,7 +25,7 @@
     local_simulator_to_target,
     to_braket,
 )
-from .braket_task import BraketTask
+from .braket_quantum_task import BraketQuantumTask
 
 logger = logging.getLogger(__name__)
 
@@ -125,7 +125,7 @@ def control_channel(self, qubits: Iterable[int]):
 
     def run(
         self, run_input: Union[QuantumCircuit, list[QuantumCircuit]], **options
-    ) -> BraketTask:
+    ) -> BraketQuantumTask:
         convert_input = (
             [run_input] if isinstance(run_input, QuantumCircuit) else list(run_input)
         )
@@ -160,7 +160,7 @@ def run(
 
         task_id = _TASK_ID_DIVIDER.join(task.id for task in tasks)
 
-        return BraketTask(
+        return BraketQuantumTask(
             task_id=task_id,
             tasks=tasks,
             backend=self,
@@ -220,7 +220,7 @@ def __init__(  # pylint: disable=too-many-arguments
         )
         self._target = aws_device_to_target(device=device)
 
-    def retrieve_job(self, task_id: str) -> BraketTask:
+    def retrieve_job(self, task_id: str) -> BraketQuantumTask:
         """Return a single job submitted to AWS backend.
 
         Args:
@@ -231,7 +231,7 @@ def retrieve_job(self, task_id: str) -> BraketTask:
         """
         task_ids = task_id.split(_TASK_ID_DIVIDER)
 
-        return BraketTask(
+        return BraketQuantumTask(
             task_id=task_id,
             backend=self,
             tasks=[AwsQuantumTask(arn=task_id) for task_id in task_ids],
@@ -336,7 +336,7 @@ def run(self, run_input, **options):
         tasks: list[AwsQuantumTask] = batch_task.tasks
         task_id = _TASK_ID_DIVIDER.join(task.id for task in tasks)
 
-        return BraketTask(
+        return BraketQuantumTask(
             task_id=task_id, tasks=tasks, backend=self, shots=options.get("shots")
         )
 

qiskit_braket_provider/providers/braket_job.py

@@ -7,10 +7,10 @@
 from braket.tasks.local_quantum_task import LocalQuantumTask
 from qiskit.providers import BackendV2
 
-from .braket_task import BraketTask
+from .braket_quantum_task import BraketQuantumTask
 
 
-class AmazonBraketTask(BraketTask):
+class AmazonBraketTask(BraketQuantumTask):
     """AmazonBraketTask."""
 
     def __init_subclass__(cls, **kwargs):
@@ -34,7 +34,7 @@ def __init__(
         super().__init__(task_id=task_id, backend=backend, tasks=tasks, **metadata)
 
 
-class AWSBraketJob(BraketTask):
+class AWSBraketJob(BraketQuantumTask):
     """AWSBraketJob."""
 
     def __init_subclass__(cls, **kwargs):

…braket_provider/providers/braket_task.py …rovider/providers/braket_quantum_task.pyqiskit_braket_provider/providers/braket_task.py renamed to qiskit_braket_provider/providers/braket_quantum_task.py qiskit_braket_provider/providers/braket_task.py renamed to qiskit_braket_provider/providers/braket_quantum_task.py

@@ -77,7 +77,7 @@ def _get_result_from_aws_tasks(
     return experiment_results
 
 
-class BraketTask(JobV1):
+class BraketQuantumTask(JobV1):
     """BraketTask."""
 
     def __init__(

tests/providers/test_braket_task.py …ts/providers/test_braket_quantum_task.pytests/providers/test_braket_task.py renamed to tests/providers/test_braket_quantum_task.py tests/providers/test_braket_task.py renamed to tests/providers/test_braket_quantum_task.py

@@ -11,7 +11,7 @@
     AmazonBraketTask,
     AWSBraketJob,
     BraketLocalBackend,
-    BraketTask,
+    BraketQuantumTask,
 )
 from tests.providers.mocks import MOCK_LOCAL_QUANTUM_TASK
 
@@ -20,7 +20,7 @@ class TestBraketTask(TestCase):
     """Tests BraketTask."""
 
     def _get_task(self):
-        return BraketTask(
+        return BraketQuantumTask(
             backend=BraketLocalBackend(name="default"),
             task_id="AwesomeId",
             tasks=[MOCK_LOCAL_QUANTUM_TASK],
@@ -31,7 +31,7 @@ def test_task(self):
         """Tests task."""
         task = self._get_task()
 
-        self.assertTrue(isinstance(task, BraketTask))
+        self.assertTrue(isinstance(task, BraketQuantumTask))
         self.assertEqual(task.shots, 10)
 
         self.assertEqual(task.status(), JobStatus.DONE)
@@ -49,7 +49,7 @@ def test_result(self):
 
     def test_queue_position_for_local_quantum_task(self):
         """Tests job status when multiple task status is present."""
-        task = BraketTask(
+        task = BraketQuantumTask(
             backend=BraketLocalBackend(name="default"),
             task_id="MockId",
             tasks=[MOCK_LOCAL_QUANTUM_TASK],
@@ -156,7 +156,7 @@ def test_status(self, task_states, expected_status):
             tasks=[MOCK_LOCAL_QUANTUM_TASK],
             shots=100,
         )
-        job._tasks = Mock(spec=BraketTask)
+        job._tasks = Mock(spec=BraketQuantumTask)
         job._tasks = [self._get_mock_aws_quantum_task(state) for state in task_states]
 
         assert job.status() == expected_status