feat: expose API execution options timeout (#516)

Timeout is exposed as QpuApiDuration

Author: erichulburd

Cargo.lock

@@ -28,6 +28,7 @@ ndarray.workspace = true
 num = { version = "0.4.0", features = ["serde"] }
 opentelemetry = { version = "0.23.0" }
 opentelemetry_sdk = { version = "0.23.0" }
+pbjson-types = "0.7.0"
 qcs-api-client-common.workspace = true
 qcs-api-client-openapi.workspace = true
 qcs-api-client-grpc.workspace = true

crates/lib/Cargo.toml

@@ -344,10 +344,9 @@ impl Executable<'_, '_> {
     }
 
     fn get_readouts(&self) -> &[Cow<'_, str>] {
-        return self
-            .readout_memory_region_names
+        self.readout_memory_region_names
             .as_ref()
-            .map_or(&[Cow::Borrowed("ro")], Vec::as_slice);
+            .map_or(&[Cow::Borrowed("ro")], Vec::as_slice)
     }
 
     /// Execute on a QVM which must be available at the configured URL (default <http://localhost:5000>).

crates/lib/src/executable.rs

@@ -3,6 +3,8 @@
 
 use std::{convert::TryFrom, fmt, time::Duration};
 
+#[deny(clippy::module_name_repetitions)]
+pub use ::pbjson_types::Duration as QpuApiDuration;
 use async_trait::async_trait;
 use cached::proc_macro::cached;
 use derive_builder::Builder;
@@ -382,6 +384,21 @@ impl ApiExecutionOptions {
     pub fn bypass_settings_protection(&self) -> bool {
         self.inner.bypass_settings_protection
     }
+
+    /// Get the configured `timeout` value.
+    ///
+    /// Note, this is the timeout while running a job; the job will be evicted from
+    /// the hardware once this time has elapsed.
+    ///
+    /// If unset, the job's estimated duration will be used;
+    /// if the job does not have an estimated duration, the default
+    /// timeout is selected by the service.
+    ///
+    /// The service may also enforce a maximum value for this field.
+    #[must_use]
+    pub fn timeout(&self) -> Option<::pbjson_types::Duration> {
+        self.inner.timeout
+    }
 }
 
 impl From<ApiExecutionOptions> for InnerApiExecutionOptions {
@@ -404,6 +421,14 @@ impl ApiExecutionOptionsBuilder {
             .bypass_settings_protection = bypass_settings_protection;
         self
     }
+
+    /// Set the `timeout` value. See [`ApiExecutionOptions::timeout`] for more information.
+    pub fn timeout(&mut self, timeout: Option<::pbjson_types::Duration>) -> &mut Self {
+        self.inner
+            .get_or_insert(InnerApiExecutionOptions::default())
+            .timeout = timeout;
+        self
+    }
 }
 
 impl ExecutionOptions {

crates/lib/src/qpu/api.rs

@@ -15,3 +15,4 @@
 
 __doc__ = common.__doc__
 __all__ = getattr(common, "__all__", [])
+

crates/python/qcs_sdk/_tracing_subscriber/common/__init__.py

@@ -12,14 +12,15 @@
 
 from typing import Dict, Optional, final
 
+
 @final
 class InstrumentationLibrary:
     """
     Information about a library or crate providing instrumentation.
-
+    
     An instrumentation library should be named to follow any naming conventions
     of the instrumented library (e.g. 'middleware' for a web framework).
-
+    
     See the `instrumentation libraries <https://github.com/open-telemetry/opentelemetry-specification/blob/v1.9.0/specification/overview.md#instrumentation-libraries>`_
     spec for more information.
     """
@@ -41,3 +42,4 @@ class InstrumentationLibrary:
         :param attributes: The attributes of the instrumentation library.
         """
         ...
+

crates/python/qcs_sdk/_tracing_subscriber/common/__init__.pyi

@@ -15,3 +15,4 @@
 
 __doc__ = layers.__doc__
 __all__ = getattr(layers, "__all__", [])
+

crates/python/qcs_sdk/_tracing_subscriber/layers/__init__.py

@@ -13,18 +13,18 @@
 from __future__ import annotations
 from typing import TYPE_CHECKING
 
-from . import file as file
+from . import file as file 
 from . import otel_otlp_file as otel_otlp_file
 from . import otel_otlp as otel_otlp
 
 if TYPE_CHECKING:
-    from typing import Union
+  from typing import Union
 
-    Config = Union[
-        file.Config,
-        otel_otlp_file.Config,
-        otel_otlp.Config,
-    ]
-    """
+  Config = Union[
+    file.Config,
+    otel_otlp_file.Config, 
+    otel_otlp.Config,
+      ]
+  """
   One of the supported layer configurations that may be set on the subscriber configuration.
   """

crates/python/qcs_sdk/_tracing_subscriber/layers/__init__.pyi

@@ -15,3 +15,5 @@
 
 __doc__ = file.__doc__
 __all__ = getattr(file, "__all__", [])
+
+

crates/python/qcs_sdk/_tracing_subscriber/layers/file/__init__.py

@@ -39,3 +39,4 @@ class Config:
         :param json: Whether or not to format the output as JSON. Defaults to `True`.
         """
         ...
+