Correct default language in docstring for process_circuits(). (#579)

Author: cqc-alec

pytket/extensions/quantinuum/backends/api_wrappers.py

@@ -525,7 +525,7 @@ def get_machine_list(self) -> list[dict[str, Any]]:
         self._response_check(res, "get machine list")
         jr = res.json()
 
-        return cast(list[dict[str, Any]], jr)
+        return cast("list[dict[str, Any]]", jr)
 
 
 OFFLINE_MACHINE_LIST = [

pytket/extensions/quantinuum/backends/leakage_gadget.py

@@ -15,13 +15,15 @@
 
 
 from collections import Counter
-from collections.abc import Sequence
-from typing import cast
+from typing import TYPE_CHECKING, cast
 
 from pytket import Bit, Circuit, OpType, Qubit  # type: ignore
 from pytket.backends.backendresult import BackendResult
 from pytket.utils.outcomearray import OutcomeArray
 
+if TYPE_CHECKING:
+    from collections.abc import Sequence
+
 LEAKAGE_DETECTION_BIT_NAME_ = "leakage_detection_bit"
 LEAKAGE_DETECTION_QUBIT_NAME_ = "leakage_detection_qubit"
 
@@ -181,5 +183,5 @@ def prune_shots_detected_as_leaky(result: BackendResult) -> BackendResult:
                 for key, val in discarded_counts.items()
             }
         ),
-        c_bits=cast(Sequence[Bit], regular_bits),
+        c_bits=cast("Sequence[Bit]", regular_bits),
     )

pytket/extensions/quantinuum/backends/quantinuum.py

@@ -317,7 +317,9 @@ def __init__(
 
         self.api_handler.provider = provider
 
-        self._process_circuits_options = cast(dict[str, Any], kwargs.get("options", {}))
+        self._process_circuits_options = cast(
+            "dict[str, Any]", kwargs.get("options", {})
+        )
 
         self._local_emulator_handles: dict[
             ResultHandle,
@@ -608,7 +610,7 @@ def _gate_set(self) -> set[OpType]:
         return (
             _ALL_GATES
             if self._MACHINE_DEBUG
-            else cast(BackendInfo, self.backend_info).gate_set
+            else cast("BackendInfo", self.backend_info).gate_set
         )
 
     @property
@@ -620,7 +622,7 @@ def required_predicates(self) -> list[Predicate]:
         if not self._MACHINE_DEBUG:
             assert self.backend_info is not None
             preds.append(MaxNQubitsPredicate(self.backend_info.n_nodes))
-            preds.append(MaxNClRegPredicate(cast(int, self.backend_info.n_cl_reg)))
+            preds.append(MaxNClRegPredicate(cast("int", self.backend_info.n_cl_reg)))
         if self.simulator_type == "stabilizer":
             preds.append(CliffordCircuitPredicate())
 
@@ -899,7 +901,7 @@ def get_jobid(handle: ResultHandle) -> str:
         :param handle: result handle.
         :return: Quantinuum API Job ID string.
         """
-        return cast(str, handle[0])
+        return cast("str", handle[0])
 
     @staticmethod
     def get_ppcirc_rep(handle: ResultHandle) -> Any:
@@ -909,7 +911,7 @@ def get_ppcirc_rep(handle: ResultHandle) -> Any:
         :param handle: result handle
         :return: serialized post-processing circuit, if any
         """
-        return json.loads(cast(str, handle[1]))
+        return json.loads(cast("str", handle[1]))
 
     @staticmethod
     def get_results_width(handle: ResultHandle) -> Optional[int]:
@@ -918,7 +920,7 @@ def get_results_width(handle: ResultHandle) -> Optional[int]:
         :param handle: result handle
         :return: truncation width of results, if any
         """
-        n = cast(int, handle[2])
+        n = cast("int", handle[2])
         if n == -1:
             return None
         else:
@@ -931,7 +933,7 @@ def get_results_selection(handle: ResultHandle) -> Any:
         of the expected results in the response. If None, then all results in the
         response are used, in lexicographic order.
         """
-        s = cast(str, handle[3])
+        s = cast("str", handle[3])
         if s == "":
             return None
         bits = json.loads(s)
@@ -1051,7 +1053,7 @@ def submit_program(
 
         # extract job ID from response
         return ResultHandle(
-            cast(str, jobdict["job"]),
+            cast("str", jobdict["job"]),
             "null",
             -1 if results_selection is None else len(results_selection),
             json.dumps(results_selection),
@@ -1088,7 +1090,7 @@ def process_circuits(
         * `request_options`: extra options to add to the request body as a
           json-style dictionary
         * `language`: languange for submission, of type :py:class:`Language`, default
-          QASM.
+          QIR.
         * `leakage_detection`: if true, adds additional Qubit and Bit to Circuit
           to detect leakage errors. Run `prune_shots_detected_as_leaky` on returned
           BackendResult to get counts with leakage errors removed.
@@ -1107,7 +1109,7 @@ def process_circuits(
         )
 
         if kwargs.get("leakage_detection", False):
-            n_device_nodes: int = cast(int, self.backend_info.n_nodes)  # type: ignore
+            n_device_nodes: int = cast("int", self.backend_info.n_nodes)  # type: ignore
             n_leakage_detection_qubits: int = kwargs.get(  # type: ignore
                 "n_leakage_detection_qubits", n_device_nodes
             )
@@ -1127,17 +1129,17 @@ def process_circuits(
         if valid_check:
             self._check_all_circuits(circuits)
 
-        postprocess = cast(bool, kwargs.get("postprocess", False))
+        postprocess = cast("bool", kwargs.get("postprocess", False))
         simplify_initial = kwargs.get("simplify_initial", False)
-        noisy_simulation = cast(bool, kwargs.get("noisy_simulation", True))
+        noisy_simulation = cast("bool", kwargs.get("noisy_simulation", True))
 
-        group = cast(Optional[str], kwargs.get("group", self._group))
+        group = cast("Optional[str]", kwargs.get("group", self._group))
 
-        wasm_fh = cast(Optional[WasmFileHandler], kwargs.get("wasm_file_handler"))
+        wasm_fh = cast("Optional[WasmFileHandler]", kwargs.get("wasm_file_handler"))
 
-        pytket_pass = cast(Optional[BasePass], kwargs.get("pytketpass"))
+        pytket_pass = cast("Optional[BasePass]", kwargs.get("pytketpass"))
 
-        language: Language = cast(Language, kwargs.get("language", Language.QIR))
+        language: Language = cast("Language", kwargs.get("language", Language.QIR))
 
         handle_list = []
 
@@ -1216,7 +1218,7 @@ def process_circuits(
 
                     quantinuum_circ = b64encode(
                         cast(
-                            bytes,
+                            "bytes",
                             pytket_to_qir(
                                 c0,
                                 "circuit generated by pytket-qir",
@@ -1250,9 +1252,9 @@ def process_circuits(
                         group=group,
                         wasm_file_handler=wasm_fh,
                         pytket_pass=pytket_pass,
-                        options=cast(dict[str, Any], kwargs.get("options", {})),
+                        options=cast("dict[str, Any]", kwargs.get("options", {})),
                         request_options=cast(
-                            dict[str, Any], kwargs.get("request_options", {})
+                            "dict[str, Any]", kwargs.get("request_options", {})
                         ),
                     )
 
@@ -1298,7 +1300,7 @@ def start_batch(
         # to batch will be recognised as being added to an existing batch
         self.api_handler.retrieve_job_status(
             self.get_jobid(h1),
-            use_websocket=cast(bool, kwargs.get("use_websocket", True)),
+            use_websocket=cast("bool", kwargs.get("use_websocket", True)),
         )
         return h1
 
@@ -1379,7 +1381,7 @@ def circuit_status(
         ):
             return CircuitStatus(StatusEnum.COMPLETED)
 
-        use_websocket = cast(bool, kwargs.get("use_websocket", True))
+        use_websocket = cast("bool", kwargs.get("use_websocket", True))
         # TODO check queue position and add to message
         try:
             response = self.api_handler.retrieve_job_status(
@@ -1496,7 +1498,7 @@ def get_result(self, handle: ResultHandle, **kwargs: KwargTypes) -> BackendResul
                 wait = kwargs.get("wait")
                 if wait is not None:
                     wait = int(wait)
-                use_websocket = cast(Optional[bool], kwargs.get("use_websocket"))
+                use_websocket = cast("Optional[bool]", kwargs.get("use_websocket"))
 
                 job_retrieve = self._retrieve_job(jobid, timeout, wait, use_websocket)
                 circ_status = _parse_status(job_retrieve)
@@ -1692,7 +1694,7 @@ def conv_int(res: str) -> list:
                 array_dict[creg] = array_dict[creg][:, :n_bits]
 
         stacked_array = cast(
-            Sequence[Sequence[int]],
+            "Sequence[Sequence[int]]",
             np.hstack([array_dict[name] for name in reversed_creg_names]),
         )
     else:

tests/integration/backend_test.py

@@ -497,7 +497,7 @@ def test_postprocess(
     c.measure_all()
     c = b.get_compiled_circuit(c)
     h = b.process_circuit(c, n_shots=10, postprocess=True, language=language)
-    ppcirc = Circuit.from_dict(json.loads(cast(str, h[1])))
+    ppcirc = Circuit.from_dict(json.loads(cast("str", h[1])))
     ppcmds = ppcirc.get_commands()
     assert len(ppcmds) > 0
     assert all(ppcmd.op.type == OpType.ClassicalTransform for ppcmd in ppcmds)

tests/unit/leakage_detection_test.py

@@ -14,8 +14,7 @@
 
 
 from collections import Counter
-from collections.abc import Sequence
-from typing import cast
+from typing import TYPE_CHECKING, cast
 
 import pytest
 
@@ -30,6 +29,9 @@
 )
 from pytket.utils.outcomearray import OutcomeArray
 
+if TYPE_CHECKING:
+    from collections.abc import Sequence
+
 
 def test_postselection_circuits_1qb_task_gen() -> None:
     comparison_circuit: Circuit = Circuit(1, 1)
@@ -193,7 +195,7 @@ def test_postselection_discard_0() -> None:
     discard_result = prune_shots_detected_as_leaky(
         BackendResult(
             counts=counts,
-            c_bits=cast(Sequence[Bit], [Bit(0), Bit(LEAKAGE_DETECTION_BIT_NAME_, 0)]),
+            c_bits=cast("Sequence[Bit]", [Bit(0), Bit(LEAKAGE_DETECTION_BIT_NAME_, 0)]),
         )
     ).get_counts()
     assert discard_result[(0,)] == 100