Export rust QCS ClientConfiguration to python

.gitignore

@@ -19,5 +19,6 @@ qcs-api/docs
 # macOS
 .DS_Store
 
-# pytest artifacts
+# Python artifacts
 **/__pycache__
+crates/python/qcs_sdk/*.so

crates/lib/Cargo.toml

@@ -21,9 +21,9 @@ lazy_static = "1.4.0"
 log = "0.4.17"
 num = { version = "0.4.0", features = ["serde"] }
 qcs-api = "0.2.1"
-qcs-api-client-common = "0.2.7"
-qcs-api-client-openapi = "0.3.8"
-qcs-api-client-grpc = "0.2.7"
+qcs-api-client-common = "0.3.0"
+qcs-api-client-openapi = "0.4.0"
+qcs-api-client-grpc = "0.3.0"
 quil-rs = "0.15"
 reqwest = { version = "0.11.12", default-features = false, features = ["rustls-tls", "json"] }
 rmp-serde = "1.1.1"
@@ -42,7 +42,7 @@ erased-serde = "0.3.23"
 float-cmp = "0.9.0"
 hex = "0.4.3"
 maplit = "1.0.2"
-qcs-api-client-grpc = { version = "0.2.7", features = ["server"] }
+qcs-api-client-grpc = { version = "0.3.0", features = ["server"] }
 simple_logger = { version = "2.3.0", default-features = false }
 tempfile = "3.3.0"
 tokio = { version = "1.21.2", features = ["macros", "rt-multi-thread"] }

crates/lib/src/api.rs

@@ -1,7 +1,7 @@
 //! This module provides convenience functions to handle compilation,
 //! translation, parameter arithmetic rewriting, and results collection.
 
-use std::{collections::HashMap, str::FromStr};
+use std::{collections::HashMap, str::FromStr, time::Duration};
 
 use num::Complex;
 use qcs_api_client_grpc::{
@@ -10,9 +10,11 @@ use qcs_api_client_grpc::{
         get_controller_job_results_request::Target, GetControllerJobResultsRequest,
     },
 };
+use qcs_api_client_openapi::apis::{quantum_processors_api, Error as OpenAPIError};
 use quil_rs::expression::Expression;
 use quil_rs::{program::ProgramError, Program};
 use serde::Serialize;
+use tokio::time::error::Elapsed;
 
 use crate::qpu::{
     self,
@@ -313,3 +315,53 @@ pub async fn retrieve_results(
         .map(ExecutionResults::from)
         .ok_or_else(|| GrpcClientError::ResponseEmpty("Controller Job Execution Results".into()))
 }
+
+/// API Errors encountered when trying to list available quantum processors.
+#[derive(Debug, thiserror::Error)]
+pub enum ListQuantumProcessorsError {
+    /// Failed the http call
+    #[error("Failed to list processors via API: {0}")]
+    ApiError(#[from] OpenAPIError<quantum_processors_api::ListQuantumProcessorsError>),
+
+    /// Pagination did not finish before timeout
+    #[error("API pagination did not finish before timeout: {0:?}")]
+    TimeoutError(#[from] Elapsed),
+}
+
+/// Query the QCS API for the names of all available quantum processors.
+/// If `None`, the default `timeout` used is 10 seconds.
+pub async fn list_quantum_processors(
+    client: &Qcs,
+    timeout: Option<Duration>,
+) -> Result<Vec<String>, ListQuantumProcessorsError> {
+    let timeout = timeout.unwrap_or_else(|| Duration::from_secs(10));
+
+    tokio::time::timeout(timeout, async move {
+        let mut quantum_processors = vec![];
+        let mut page_token = None;
+
+        loop {
+            let result = quantum_processors_api::list_quantum_processors(
+                &client.get_openapi_client(),
+                Some(100),
+                page_token.as_deref(),
+            )
+            .await?;
+
+            let mut data = result
+                .quantum_processors
+                .into_iter()
+                .map(|qpu| qpu.id)
+                .collect::<Vec<_>>();
+            quantum_processors.append(&mut data);
+
+            page_token = result.next_page_token;
+            if page_token.is_none() {
+                break;
+            }
+        }
+
+        Ok(quantum_processors)
+    })
+    .await?
+}

crates/lib/src/executable.rs

@@ -313,7 +313,7 @@ impl Executable<'_, '_> {
         if let Some(config) = &self.config {
             Ok(config.clone())
         } else {
-            let config = ClientConfiguration::load().await?;
+            let config = ClientConfiguration::load_default().await?;
             self.config = Some(config.clone());
             Ok(config)
         }

crates/lib/src/qpu/client.rs

@@ -36,7 +36,9 @@ pub struct Qcs {
 impl Qcs {
     /// Create a [`Qcs`] and initialize it with the user's default [`ClientConfiguration`]
     pub async fn load() -> Result<Self, LoadError> {
-        ClientConfiguration::load().await.map(Self::with_config)
+        ClientConfiguration::load_default()
+            .await
+            .map(Self::with_config)
     }
 
     /// Create a [`Qcs`] and initialize it with the given [`ClientConfiguration`]

crates/python/Cargo.toml

@@ -17,14 +17,17 @@ crate-type = ["cdylib"]
 
 [dependencies]
 qcs = { path = "../lib" }
-qcs-api-client-common = "0.2.7"
-qcs-api-client-grpc = "0.2.7"
+qcs-api-client-common = "0.3.0"
+qcs-api-client-grpc = "0.3.0"
 pyo3 = { version = "0.17", features = ["extension-module"] }
 pyo3-asyncio = { version = "0.17", features = ["tokio-runtime"] }
 quil-rs = "0.15"
 tokio = "1.21"
 qcs-api = "0.2.1"
-rigetti-pyo3 = { version = "0.1.0-rc.0", features = ["extension-module", "complex"] }
+rigetti-pyo3 = { version = "0.1.0-rc.0", features = [
+    "extension-module",
+    "complex",
+] }
 serde_json = "1.0.86"
 
 [build-dependencies]

crates/python/qcs_sdk/__init__.py

@@ -0,0 +1,4 @@
+# See the following documentation for why this file is necessary:
+# https://pyo3.rs/v0.18.0/python_typing_hints#__init__py-content
+
+from .qcs_sdk import *

crates/python/qcs_sdk/__init__.pyi

@@ -0,0 +1,23 @@
+from .api import *
+
+from .qpu.client import (
+    QcsClient as QcsClient
+)
+
+from ._execution_data import (
+    QPU as QPU,
+    QVM as QVM,
+    ReadoutMap as ReadoutMap,
+)
+
+from ._executable import (
+    Executable as Executable,
+    ExeParameter as ExeParameter,
+    JobHandle as JobHandle,
+    QcsExecutionError as QcsExecutionError,
+    Service as Service,
+)
+
+from ._register_data import (
+    RegisterData as RegisterData,
+)