fix!: convert all pyo3 async functions to sync, use python name casing (#252)

* fix!: convert all async function to sync

* Update crates/python/src/lib.rs

Co-authored-by: Michael Bryant <[email protected]>

* chore: initial mr changes

* chore: implement sync/async for all python wrappers

* chore: remove comments

* Apply suggestions from code review

Co-authored-by: Michael Bryant <[email protected]>

* fix: macro cleanup

* chore: add test async

* fix: simplify macro

* chore: add type hinting and exports for async functions

* chore: mr fixes

* Apply suggestions from code review

Co-authored-by: Michael Bryant <[email protected]>

* chore: mr review fixes

* chore: untest the comment system

* chore: use hygeinic references in py_sync macros

* fix: pythonize initialisms

* chore: fix acronym naming

* chore: fix docs

---------

Co-authored-by: Michael Bryant <[email protected]>

Author: jselig-rigetti

.gitignore

@@ -25,4 +25,5 @@ qcs-api/docs
 
 # Python artifacts
 **/__pycache__
+crates/python/.hypothesis
 crates/python/qcs_sdk/*.so

Cargo.lock

@@ -12,9 +12,9 @@ MEASURE 0 ro[0]
 async fn main() {
     let mut exe = Executable::from_quil(PROGRAM);
     let job_handle = exe
-        .submit_to_qpu("Aspen-11")
+        .submit_to_qpu("Aspen-M-3")
         .await
-        .expect("Program should be sucessfully submitted for execution");
+        .expect("Program should be successfully submitted for execution");
     // Do some other stuff
     let _data = exe
         .retrieve_results(job_handle)

crates/lib/examples/delayed_job_retrieval.rs

@@ -690,7 +690,7 @@ mod describe_qpu_for_id {
             qpu::Execution::new(
                 "".into(),
                 shots,
-                "Aspen-11",
+                "Aspen-M-3",
                 exe.get_config().await.unwrap_or_default(),
                 exe.compile_with_quilc,
             )
@@ -700,7 +700,7 @@ mod describe_qpu_for_id {
         // Load config with no credentials to prevent creating a new Execution if it tries
         exe.config = Some(Arc::new(Configuration::default()));
 
-        assert!(exe.qpu_for_id("Aspen-11").await.is_ok());
+        assert!(exe.qpu_for_id("Aspen-M-3").await.is_ok());
     }
 
     #[tokio::test]

crates/lib/src/executable.rs

@@ -28,6 +28,7 @@ serde_json.workspace = true
 tokio.workspace = true
 numpy.workspace = true
 rigetti-pyo3.workspace = true
+paste = "1.0.11"
 
 [build-dependencies]
 pyo3-build-config.workspace = true

crates/python/Cargo.toml

@@ -28,4 +28,4 @@ dependencies = [
     "pre-test-install-lib",
     "test",
     "post-test",
-]
+]

crates/python/Makefile.toml

@@ -1,8 +1,26 @@
-from .api import *
+from .api import (
+    compile as compile,
+    compile_async as compile_async,
+    rewrite_arithmetic as rewrite_arithmetic,
+    build_patch_values as build_patch_values,
+    translate as translate,
+    translate_async as translate_async,
+    submit as submit,
+    submit_async as submit_async,
+    retrieve_results as retrieve_results,
+    retrieve_results_async as retrieve_results_async,
+    get_quilc_version as get_quilc_version,
+    get_quilc_version_async as get_quilc_version_async,
+    list_quantum_processors as list_quantum_processors,
+    list_quantum_processors_async as list_quantum_processors_async,
+)
 
-from .qpu.client import QcsClient as QcsClient
+from .qpu.client import (
+    QCSClient as QCSClient,
+)
 from .qpu.isa import (
     get_instruction_set_architecture as get_instruction_set_architecture,
+    get_instruction_set_architecture_async as get_instruction_set_architecture_async,
 )
 
 from ._execution_data import (
@@ -17,7 +35,7 @@ from ._executable import (
     Executable as Executable,
     ExeParameter as ExeParameter,
     JobHandle as JobHandle,
-    QcsExecutionError as QcsExecutionError,
+    QCSExecutionError as QCSExecutionError,
     Service as Service,
 )
 

crates/python/qcs_sdk/__init__.pyi

@@ -8,7 +8,7 @@ from typing import Dict, List, Optional
 from .qpu.quilc import CompilerOpts
 from ._execution_data import ExecutionData
 
-class QcsExecutionError(RuntimeError):
+class QCSExecutionError(RuntimeError):
     """Error encounteted when executing programs."""
 
     ...
@@ -22,28 +22,58 @@ class Executable:
         compile_with_quilc: Optional[bool] = None,
         compiler_options: Optional[CompilerOpts] = None,
     ) -> "Executable": ...
-    async def execute_on_qvm(self) -> ExecutionData:
+    def execute_on_qvm(self) -> ExecutionData:
         """
         Execute on a QVM which must be available at the configured URL (default http://localhost:5000).
 
         Raises:
-            - ``QcsExecutionError``: If the job fails to execute.
+            - ``QCSExecutionError``: If the job fails to execute.
         """
         ...
-    async def execute_on_qpu(self, quantum_processor_id: str) -> ExecutionData:
+    async def execute_on_qvm_async(self) -> ExecutionData:
+        """
+        Async version of ``execute_on_qvm``.
+
+        Execute on a QVM which must be available at the configured URL (default http://localhost:5000).
+
+        Raises:
+            - ``QCSExecutionError``: If the job fails to execute.
+        """
+        ...
+    def execute_on_qpu(self, quantum_processor_id: str) -> ExecutionData:
         """
         Compile the program and execute it on a QPU, waiting for results.
 
         Raises:
-            - ``QcsExecutionError``: If the job fails to execute.
+            - ``QCSExecutionError``: If the job fails to execute.
         """
         ...
-    async def retrieve_results(self, job_handle: JobHandle) -> ExecutionData:
+    async def execute_on_qpu_async(self, quantum_processor_id: str) -> ExecutionData:
         """
+        Async version of ``execute_on_qvm``.
+
+        Compile the program and execute it on a QPU, waiting for results.
+
+        Raises:
+            - ``QCSExecutionError``: If the job fails to execute.
+        """
+        ...
+    def retrieve_results(self, job_handle: JobHandle) -> ExecutionData:
+        """
+        Wait for the results of a job to complete.
+
+        Raises:
+            - ``QCSExecutionError``: If there is a problem constructing job results.
+        """
+        ...
+    async def retrieve_results_async(self, job_handle: JobHandle) -> ExecutionData:
+        """
+        Async version of ``retrieve_results``.
+
         Wait for the results of a job to complete.
 
         Raises:
-            - ``QcsExecutionError``: If there is a problem constructing job results.
+            - ``QCSExecutionError``: If there is a problem constructing job results.
         """
         ...
 
@@ -95,6 +125,6 @@ class ExeParameter:
 
 class Service(Enum):
     Quilc = "Quilc"
-    Qvm = "Qvm"
-    Qcs = "Qcs"
-    Qpu = "Qpu"
+    QVM = "QVM"
+    QCS = "QCS"
+    QPU = "QPU"