diff --git a/CHANGELOG.md b/CHANGELOG.md index 820a8f444..3d14c756b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,6 +6,18 @@ Changelog ### Announcements +### Improvements and Changes + +- `QAMExecutionResult` now includes `execution_duration_microseconds`, providing the amount of time + a job held exclusive hardware access. (@randall-fulton, #1436) + +### Bugfixes + +[v3.1.0](https://github.com/rigetti/pyquil/releases/tag/v3.1.0) +------------------------------------------------------------------------------------ + +### Announcements + - `setup.py` has been removed and will no longer be generated as part of the automated release process. ### Improvements and Changes diff --git a/docs/source/qvm.rst b/docs/source/qvm.rst index 6513f82fd..0c4f69fe4 100644 --- a/docs/source/qvm.rst +++ b/docs/source/qvm.rst @@ -332,6 +332,9 @@ for more details about declaring and accessing classical memory regions. .. tip:: Get the results for qubit 0 with ``numpy.array(bitstrings)[:,0]``. +In addition to ``readout_data``, the result of ``.run(...)`` includes other information about the job's execution, such +as the run duration. See :py:class:`~pyquil.api.QAMExecutionResult` for details. + .. _new_topology: ``.execute`` and ``.get_result`` diff --git a/poetry.lock b/poetry.lock index 9dc442b47..1e1625a74 100644 --- a/poetry.lock +++ b/poetry.lock @@ -1119,7 +1119,7 @@ idna2008 = ["idna"] [[package]] name = "rpcq" -version = "3.9.1" +version = "3.10.0" description = "The RPC framework and message specification for Rigetti QCS." category = "main" optional = false @@ -1411,7 +1411,7 @@ latex = ["ipython"] [metadata] lock-version = "1.1" python-versions = "^3.7" -content-hash = "5d98557a55fd54e7578339ad507f20c6d6782f72edf4f466defff4bed516a2f6" +content-hash = "a2b41292a997e87f5cc8c599e8a824feb1d7f75c98cec276e04903282007a89e" [metadata.files] alabaster = [ @@ -1674,12 +1674,28 @@ lark = [ {file = "lark-0.11.3.tar.gz", hash = "sha256:3100d9749b5a85735ec428b83100876a5da664804579e729c23a36341f961e7e"}, ] markupsafe = [ + {file = "MarkupSafe-2.0.1-cp310-cp310-macosx_10_9_universal2.whl", hash = "sha256:d8446c54dc28c01e5a2dbac5a25f071f6653e6e40f3a8818e8b45d790fe6ef53"}, + {file = "MarkupSafe-2.0.1-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:36bc903cbb393720fad60fc28c10de6acf10dc6cc883f3e24ee4012371399a38"}, + {file = "MarkupSafe-2.0.1-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:2d7d807855b419fc2ed3e631034685db6079889a1f01d5d9dac950f764da3dad"}, + {file = "MarkupSafe-2.0.1-cp310-cp310-manylinux_2_5_i686.manylinux1_i686.manylinux_2_12_i686.manylinux2010_i686.whl", hash = "sha256:add36cb2dbb8b736611303cd3bfcee00afd96471b09cda130da3581cbdc56a6d"}, + {file = "MarkupSafe-2.0.1-cp310-cp310-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_12_x86_64.manylinux2010_x86_64.whl", hash = "sha256:168cd0a3642de83558a5153c8bd34f175a9a6e7f6dc6384b9655d2697312a646"}, + {file = "MarkupSafe-2.0.1-cp310-cp310-musllinux_1_1_aarch64.whl", hash = "sha256:4dc8f9fb58f7364b63fd9f85013b780ef83c11857ae79f2feda41e270468dd9b"}, + {file = "MarkupSafe-2.0.1-cp310-cp310-musllinux_1_1_i686.whl", hash = "sha256:20dca64a3ef2d6e4d5d615a3fd418ad3bde77a47ec8a23d984a12b5b4c74491a"}, + {file = "MarkupSafe-2.0.1-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:cdfba22ea2f0029c9261a4bd07e830a8da012291fbe44dc794e488b6c9bb353a"}, + {file = "MarkupSafe-2.0.1-cp310-cp310-win32.whl", hash = "sha256:99df47edb6bda1249d3e80fdabb1dab8c08ef3975f69aed437cb69d0a5de1e28"}, + {file = "MarkupSafe-2.0.1-cp310-cp310-win_amd64.whl", hash = "sha256:e0f138900af21926a02425cf736db95be9f4af72ba1bb21453432a07f6082134"}, {file = "MarkupSafe-2.0.1-cp36-cp36m-macosx_10_9_x86_64.whl", hash = "sha256:f9081981fe268bd86831e5c75f7de206ef275defcb82bc70740ae6dc507aee51"}, {file = "MarkupSafe-2.0.1-cp36-cp36m-manylinux1_i686.whl", hash = "sha256:0955295dd5eec6cb6cc2fe1698f4c6d84af2e92de33fbcac4111913cd100a6ff"}, {file = "MarkupSafe-2.0.1-cp36-cp36m-manylinux1_x86_64.whl", hash = "sha256:0446679737af14f45767963a1a9ef7620189912317d095f2d9ffa183a4d25d2b"}, {file = "MarkupSafe-2.0.1-cp36-cp36m-manylinux2010_i686.whl", hash = "sha256:f826e31d18b516f653fe296d967d700fddad5901ae07c622bb3705955e1faa94"}, {file = "MarkupSafe-2.0.1-cp36-cp36m-manylinux2010_x86_64.whl", hash = "sha256:fa130dd50c57d53368c9d59395cb5526eda596d3ffe36666cd81a44d56e48872"}, {file = "MarkupSafe-2.0.1-cp36-cp36m-manylinux2014_aarch64.whl", hash = "sha256:905fec760bd2fa1388bb5b489ee8ee5f7291d692638ea5f67982d968366bef9f"}, + {file = "MarkupSafe-2.0.1-cp36-cp36m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:bf5d821ffabf0ef3533c39c518f3357b171a1651c1ff6827325e4489b0e46c3c"}, + {file = "MarkupSafe-2.0.1-cp36-cp36m-manylinux_2_5_i686.manylinux1_i686.manylinux_2_12_i686.manylinux2010_i686.whl", hash = "sha256:0d4b31cc67ab36e3392bbf3862cfbadac3db12bdd8b02a2731f509ed5b829724"}, + {file = "MarkupSafe-2.0.1-cp36-cp36m-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_12_x86_64.manylinux2010_x86_64.whl", hash = "sha256:baa1a4e8f868845af802979fcdbf0bb11f94f1cb7ced4c4b8a351bb60d108145"}, + {file = "MarkupSafe-2.0.1-cp36-cp36m-musllinux_1_1_aarch64.whl", hash = "sha256:deb993cacb280823246a026e3b2d81c493c53de6acfd5e6bfe31ab3402bb37dd"}, + {file = "MarkupSafe-2.0.1-cp36-cp36m-musllinux_1_1_i686.whl", hash = "sha256:63f3268ba69ace99cab4e3e3b5840b03340efed0948ab8f78d2fd87ee5442a4f"}, + {file = "MarkupSafe-2.0.1-cp36-cp36m-musllinux_1_1_x86_64.whl", hash = "sha256:8d206346619592c6200148b01a2142798c989edcb9c896f9ac9722a99d4e77e6"}, {file = "MarkupSafe-2.0.1-cp36-cp36m-win32.whl", hash = "sha256:6c4ca60fa24e85fe25b912b01e62cb969d69a23a5d5867682dd3e80b5b02581d"}, {file = "MarkupSafe-2.0.1-cp36-cp36m-win_amd64.whl", hash = "sha256:b2f4bf27480f5e5e8ce285a8c8fd176c0b03e93dcc6646477d4630e83440c6a9"}, {file = "MarkupSafe-2.0.1-cp37-cp37m-macosx_10_9_x86_64.whl", hash = "sha256:0717a7390a68be14b8c793ba258e075c6f4ca819f15edfc2a3a027c823718567"}, @@ -1688,14 +1704,27 @@ markupsafe = [ {file = "MarkupSafe-2.0.1-cp37-cp37m-manylinux2010_i686.whl", hash = "sha256:d7f9850398e85aba693bb640262d3611788b1f29a79f0c93c565694658f4071f"}, {file = "MarkupSafe-2.0.1-cp37-cp37m-manylinux2010_x86_64.whl", hash = "sha256:6a7fae0dd14cf60ad5ff42baa2e95727c3d81ded453457771d02b7d2b3f9c0c2"}, {file = "MarkupSafe-2.0.1-cp37-cp37m-manylinux2014_aarch64.whl", hash = "sha256:b7f2d075102dc8c794cbde1947378051c4e5180d52d276987b8d28a3bd58c17d"}, + {file = "MarkupSafe-2.0.1-cp37-cp37m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:e9936f0b261d4df76ad22f8fee3ae83b60d7c3e871292cd42f40b81b70afae85"}, + {file = "MarkupSafe-2.0.1-cp37-cp37m-manylinux_2_5_i686.manylinux1_i686.manylinux_2_12_i686.manylinux2010_i686.whl", hash = "sha256:2a7d351cbd8cfeb19ca00de495e224dea7e7d919659c2841bbb7f420ad03e2d6"}, + {file = "MarkupSafe-2.0.1-cp37-cp37m-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_12_x86_64.manylinux2010_x86_64.whl", hash = "sha256:60bf42e36abfaf9aff1f50f52644b336d4f0a3fd6d8a60ca0d054ac9f713a864"}, + {file = "MarkupSafe-2.0.1-cp37-cp37m-musllinux_1_1_aarch64.whl", hash = "sha256:d6c7ebd4e944c85e2c3421e612a7057a2f48d478d79e61800d81468a8d842207"}, + {file = "MarkupSafe-2.0.1-cp37-cp37m-musllinux_1_1_i686.whl", hash = "sha256:f0567c4dc99f264f49fe27da5f735f414c4e7e7dd850cfd8e69f0862d7c74ea9"}, + {file = "MarkupSafe-2.0.1-cp37-cp37m-musllinux_1_1_x86_64.whl", hash = "sha256:89c687013cb1cd489a0f0ac24febe8c7a666e6e221b783e53ac50ebf68e45d86"}, {file = "MarkupSafe-2.0.1-cp37-cp37m-win32.whl", hash = "sha256:a30e67a65b53ea0a5e62fe23682cfe22712e01f453b95233b25502f7c61cb415"}, {file = "MarkupSafe-2.0.1-cp37-cp37m-win_amd64.whl", hash = "sha256:611d1ad9a4288cf3e3c16014564df047fe08410e628f89805e475368bd304914"}, + {file = "MarkupSafe-2.0.1-cp38-cp38-macosx_10_9_universal2.whl", hash = "sha256:5bb28c636d87e840583ee3adeb78172efc47c8b26127267f54a9c0ec251d41a9"}, {file = "MarkupSafe-2.0.1-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:be98f628055368795d818ebf93da628541e10b75b41c559fdf36d104c5787066"}, {file = "MarkupSafe-2.0.1-cp38-cp38-manylinux1_i686.whl", hash = "sha256:1d609f577dc6e1aa17d746f8bd3c31aa4d258f4070d61b2aa5c4166c1539de35"}, {file = "MarkupSafe-2.0.1-cp38-cp38-manylinux1_x86_64.whl", hash = "sha256:7d91275b0245b1da4d4cfa07e0faedd5b0812efc15b702576d103293e252af1b"}, {file = "MarkupSafe-2.0.1-cp38-cp38-manylinux2010_i686.whl", hash = "sha256:01a9b8ea66f1658938f65b93a85ebe8bc016e6769611be228d797c9d998dd298"}, {file = "MarkupSafe-2.0.1-cp38-cp38-manylinux2010_x86_64.whl", hash = "sha256:47ab1e7b91c098ab893b828deafa1203de86d0bc6ab587b160f78fe6c4011f75"}, {file = "MarkupSafe-2.0.1-cp38-cp38-manylinux2014_aarch64.whl", hash = "sha256:97383d78eb34da7e1fa37dd273c20ad4320929af65d156e35a5e2d89566d9dfb"}, + {file = "MarkupSafe-2.0.1-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:6fcf051089389abe060c9cd7caa212c707e58153afa2c649f00346ce6d260f1b"}, + {file = "MarkupSafe-2.0.1-cp38-cp38-manylinux_2_5_i686.manylinux1_i686.manylinux_2_12_i686.manylinux2010_i686.whl", hash = "sha256:5855f8438a7d1d458206a2466bf82b0f104a3724bf96a1c781ab731e4201731a"}, + {file = "MarkupSafe-2.0.1-cp38-cp38-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_12_x86_64.manylinux2010_x86_64.whl", hash = "sha256:3dd007d54ee88b46be476e293f48c85048603f5f516008bee124ddd891398ed6"}, + {file = "MarkupSafe-2.0.1-cp38-cp38-musllinux_1_1_aarch64.whl", hash = "sha256:aca6377c0cb8a8253e493c6b451565ac77e98c2951c45f913e0b52facdcff83f"}, + {file = "MarkupSafe-2.0.1-cp38-cp38-musllinux_1_1_i686.whl", hash = "sha256:04635854b943835a6ea959e948d19dcd311762c5c0c6e1f0e16ee57022669194"}, + {file = "MarkupSafe-2.0.1-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:6300b8454aa6930a24b9618fbb54b5a68135092bc666f7b06901f897fa5c2fee"}, {file = "MarkupSafe-2.0.1-cp38-cp38-win32.whl", hash = "sha256:023cb26ec21ece8dc3907c0e8320058b2e0cb3c55cf9564da612bc325bed5e64"}, {file = "MarkupSafe-2.0.1-cp38-cp38-win_amd64.whl", hash = "sha256:984d76483eb32f1bcb536dc27e4ad56bba4baa70be32fa87152832cdd9db0833"}, {file = "MarkupSafe-2.0.1-cp39-cp39-macosx_10_9_universal2.whl", hash = "sha256:2ef54abee730b502252bcdf31b10dacb0a416229b72c18b19e24a4509f273d26"}, @@ -1705,6 +1734,12 @@ markupsafe = [ {file = "MarkupSafe-2.0.1-cp39-cp39-manylinux2010_i686.whl", hash = "sha256:4efca8f86c54b22348a5467704e3fec767b2db12fc39c6d963168ab1d3fc9135"}, {file = "MarkupSafe-2.0.1-cp39-cp39-manylinux2010_x86_64.whl", hash = "sha256:ab3ef638ace319fa26553db0624c4699e31a28bb2a835c5faca8f8acf6a5a902"}, {file = "MarkupSafe-2.0.1-cp39-cp39-manylinux2014_aarch64.whl", hash = "sha256:f8ba0e8349a38d3001fae7eadded3f6606f0da5d748ee53cc1dab1d6527b9509"}, + {file = "MarkupSafe-2.0.1-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:c47adbc92fc1bb2b3274c4b3a43ae0e4573d9fbff4f54cd484555edbf030baf1"}, + {file = "MarkupSafe-2.0.1-cp39-cp39-manylinux_2_5_i686.manylinux1_i686.manylinux_2_12_i686.manylinux2010_i686.whl", hash = "sha256:37205cac2a79194e3750b0af2a5720d95f786a55ce7df90c3af697bfa100eaac"}, + {file = "MarkupSafe-2.0.1-cp39-cp39-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_12_x86_64.manylinux2010_x86_64.whl", hash = "sha256:1f2ade76b9903f39aa442b4aadd2177decb66525062db244b35d71d0ee8599b6"}, + {file = "MarkupSafe-2.0.1-cp39-cp39-musllinux_1_1_aarch64.whl", hash = "sha256:4296f2b1ce8c86a6aea78613c34bb1a672ea0e3de9c6ba08a960efe0b0a09047"}, + {file = "MarkupSafe-2.0.1-cp39-cp39-musllinux_1_1_i686.whl", hash = "sha256:9f02365d4e99430a12647f09b6cc8bab61a6564363f313126f775eb4f6ef798e"}, + {file = "MarkupSafe-2.0.1-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:5b6d930f030f8ed98e3e6c98ffa0652bdb82601e7a016ec2ab5d7ff23baa78d1"}, {file = "MarkupSafe-2.0.1-cp39-cp39-win32.whl", hash = "sha256:10f82115e21dc0dfec9ab5c0223652f7197feb168c940f3ef61563fc2d6beb74"}, {file = "MarkupSafe-2.0.1-cp39-cp39-win_amd64.whl", hash = "sha256:693ce3f9e70a6cf7d2fb9e6c9d8b204b6b39897a2c4a1aa65728d5ac97dcc1d8"}, {file = "MarkupSafe-2.0.1.tar.gz", hash = "sha256:594c67807fb16238b30c44bdf74f36c02cdf22d1c8cda91ef8a0ed8dabf5620a"}, @@ -2096,7 +2131,7 @@ rfc3986 = [ {file = "rfc3986-1.5.0.tar.gz", hash = "sha256:270aaf10d87d0d4e095063c65bf3ddbc6ee3d0b226328ce21e036f946e421835"}, ] rpcq = [ - {file = "rpcq-3.9.1.tar.gz", hash = "sha256:bd5b9aa8fd14ce68d63306836f02053b674d2fadba05924133e30d12d7b8f651"}, + {file = "rpcq-3.10.0.tar.gz", hash = "sha256:bf21780a1cb1e8676b988c44004d49a168d8937ce2a458c00beb37fa41023684"}, ] "ruamel.yaml" = [ {file = "ruamel.yaml-0.17.9-py3-none-any.whl", hash = "sha256:8873a6f5516e0d848c92418b0b006519c0566b6cd0dcee7deb9bf399e2bd204f"}, diff --git a/pyproject.toml b/pyproject.toml index a9cd4967f..fb06c2b8a 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -25,7 +25,7 @@ python = "^3.7" numpy = "^1.20" scipy = "^1.6.1" lark = "^0.11.1" -rpcq = "^3.6.0" +rpcq = "^3.10.0" networkx = "^2.5" importlib-metadata = { version = "^3.7.3", python = "<3.8" } qcs-api-client = ">=0.8.1,<0.21.0" diff --git a/pyquil/api/_qam.py b/pyquil/api/_qam.py index 5312cc548..d46f152f4 100644 --- a/pyquil/api/_qam.py +++ b/pyquil/api/_qam.py @@ -37,6 +37,9 @@ class QAMExecutionResult: readout_data: Mapping[str, Optional[np.ndarray]] = field(default_factory=dict) """Readout data returned from the QAM, keyed on the name of the readout register or post-processing node.""" + execution_duration_microseconds: Optional[int] = field(default=None) + """Duration job held exclusive hardware access. Defaults to ``None`` when information is not available.""" + class QAM(ABC, Generic[T]): """ diff --git a/pyquil/api/_qpu.py b/pyquil/api/_qpu.py index a9bdeaf8b..2efb31142 100644 --- a/pyquil/api/_qpu.py +++ b/pyquil/api/_qpu.py @@ -177,31 +177,27 @@ def get_result(self, execute_response: QPUExecuteResponse) -> QAMExecutionResult """ Retrieve results from execution on the QPU. """ - raw_results = self._get_buffers(execute_response.job_id) + request = GetBuffersRequest(job_id=execute_response.job_id, wait=True) + results = self._qpu_client.get_execution_results(request) + ro_sources = execute_response._executable.ro_sources + decoded_buffers = {k: decode_buffer(v) for k, v in results.buffers.items()} result_memory = {} - if raw_results is not None: + if decoded_buffers is not None: extracted = _extract_memory_regions( - execute_response._executable.memory_descriptors, ro_sources, raw_results + execute_response._executable.memory_descriptors, ro_sources, decoded_buffers ) for name, array in extracted.items(): result_memory[name] = array elif not ro_sources: result_memory["ro"] = np.zeros((0, 0), dtype=np.int64) - return QAMExecutionResult(executable=execute_response._executable, readout_data=result_memory) - - def _get_buffers(self, job_id: str) -> Dict[str, np.ndarray]: - """ - Return the decoded result buffers for particular job_id. - - :param job_id: Unique identifier for the job in question - :return: Decoded buffers or throw an error - """ - request = GetBuffersRequest(job_id=job_id, wait=True) - buffers = self._qpu_client.get_buffers(request).buffers - return {k: decode_buffer(v) for k, v in buffers.items()} + return QAMExecutionResult( + executable=execute_response._executable, + readout_data=result_memory, + execution_duration_microseconds=results.execution_duration_microseconds, + ) @classmethod def _build_patch_values(cls, program: EncryptedProgram) -> Dict[str, List[Union[int, float]]]: diff --git a/pyquil/api/_qpu_client.py b/pyquil/api/_qpu_client.py index b65cb2aa7..1ca0df6c3 100644 --- a/pyquil/api/_qpu_client.py +++ b/pyquil/api/_qpu_client.py @@ -16,6 +16,7 @@ from dataclasses import dataclass from datetime import datetime from typing import Dict, Optional, cast, Tuple, Union, List, Any +from attr import field import rpcq from dateutil.parser import parse as parsedate @@ -93,6 +94,9 @@ class GetBuffersResponse: buffers: Dict[str, BufferResponse] """Job buffers, by buffer name.""" + execution_duration_microseconds: Optional[int] = field(default=None) + "Duration job held exclusive hardware access." + class QPUClient: """ @@ -156,6 +160,27 @@ def get_buffers(self, request: GetBuffersRequest) -> GetBuffersResponse: } ) + def get_execution_results(self, request: GetBuffersRequest) -> GetBuffersResponse: + """ + Get job buffers and execution metadata. + """ + result = self._rpcq_request( + "get_execution_results", + job_id=request.job_id, + wait=request.wait, + ) + return GetBuffersResponse( + buffers={ + name: BufferResponse( + shape=cast(Tuple[int, int], tuple(val["shape"])), + dtype=val["dtype"], + data=val["data"], + ) + for name, val in result.buffers.items() + }, + execution_duration_microseconds=result.execution_duration_microseconds, + ) + @retry(exceptions=TimeoutError, tries=2) # type: ignore def _rpcq_request(self, method_name: str, *args: Any, **kwargs: Any) -> Any: engagement = self._engagement_manager.get_engagement( diff --git a/test/unit/test_qpu_client.py b/test/unit/test_qpu_client.py index 704256f2b..98c482daa 100644 --- a/test/unit/test_qpu_client.py +++ b/test/unit/test_qpu_client.py @@ -23,7 +23,7 @@ from dateutil.tz import tzutc from pytest_mock import MockerFixture from qcs_api_client.models import EngagementWithCredentials, EngagementCredentials -from rpcq.messages import QPURequest +from rpcq.messages import QPURequest, GetExecutionResultsResponse from pyquil.api._qpu_client import ( QPUClient, @@ -93,13 +93,16 @@ def test_get_buffers__returns_buffers_for_job( credentials=engagement_credentials, port=1234, ) - rpcq_client = patch_rpcq_client(mocker=mocker, return_value={ - "ro": { - "shape": (1000, 2), - "dtype": "float64", - "data": b"buffer-data", + rpcq_client = patch_rpcq_client( + mocker=mocker, + return_value={ + "ro": { + "shape": (1000, 2), + "dtype": "float64", + "data": b"buffer-data", + }, }, - }) + ) job_id = "some-job" wait = True request = GetBuffersRequest( @@ -123,6 +126,55 @@ def test_get_buffers__returns_buffers_for_job( ) +def test_get_execution_results__returns_results_for_job( + mock_engagement_manager: mock.MagicMock, + engagement_credentials: EngagementCredentials, + mocker: MockerFixture, +): + qpu_client = QPUClient(quantum_processor_id="some-processor", engagement_manager=mock_engagement_manager) + mock_engagement_manager.get_engagement.return_value = engagement( + quantum_processor_id="some-processor", + seconds_left=10, + credentials=engagement_credentials, + port=1234, + ) + rpcq_client = patch_rpcq_client( + mocker=mocker, + return_value=GetExecutionResultsResponse( + buffers={ + "ro": { + "shape": (1000, 2), + "dtype": "float64", + "data": b"buffer-data", + } + }, + execution_duration_microseconds=100, + ), + ) + job_id = "some-job" + wait = True + request = GetBuffersRequest( + job_id=job_id, + wait=wait, + ) + + assert qpu_client.get_execution_results(request) == GetBuffersResponse( + buffers={ + "ro": BufferResponse( + shape=(1000, 2), + dtype="float64", + data=b"buffer-data", + ) + }, + execution_duration_microseconds=100, + ) + rpcq_client.call.assert_called_once_with( + "get_execution_results", + job_id=job_id, + wait=wait, + ) + + def test_fetches_engagement_for_quantum_processor_on_request( mock_engagement_manager: mock.MagicMock, engagement_credentials: EngagementCredentials, @@ -235,11 +287,11 @@ def test_run_program__retries_on_timeout( request_timeout=1.0, ) mock_engagement_manager.get_engagement.return_value = engagement( - quantum_processor_id=processor_id, - seconds_left=0, - credentials=engagement_credentials, - port=1234, - ) + quantum_processor_id=processor_id, + seconds_left=0, + credentials=engagement_credentials, + port=1234, + ) rpcq_client = patch_rpcq_client(mocker=mocker, return_value=None) rpcq_client.call.side_effect = [ TimeoutError, # First request must look like it timed out so we can verify retry @@ -256,16 +308,20 @@ def test_run_program__retries_on_timeout( # ASSERT # Engagement should be fetched twice, once per RPC call - mock_engagement_manager.get_engagement.assert_has_calls([ - mocker.call(quantum_processor_id='some-processor', request_timeout=1.0, endpoint_id=None), - mocker.call(quantum_processor_id='some-processor', request_timeout=1.0, endpoint_id=None), - ]) + mock_engagement_manager.get_engagement.assert_has_calls( + [ + mocker.call(quantum_processor_id="some-processor", request_timeout=1.0, endpoint_id=None), + mocker.call(quantum_processor_id="some-processor", request_timeout=1.0, endpoint_id=None), + ] + ) # RPC call should happen twice since the first one times out qpu_request = QPURequest(**request_kwargs) # Thing QPUClient gives to rpcq.Client - rpcq_client.call.assert_has_calls([ - mocker.call("execute_qpu_request", request=qpu_request, priority=0, user=None), - mocker.call("execute_qpu_request", request=qpu_request, priority=0, user=None), - ]) + rpcq_client.call.assert_has_calls( + [ + mocker.call("execute_qpu_request", request=qpu_request, priority=0, user=None), + mocker.call("execute_qpu_request", request=qpu_request, priority=0, user=None), + ] + ) def engagement(