qcs-sdk-python 0.26.0__cp313-cp313-win_amd64.whl

qcs_sdk/_tracing_subscriber/common/__init__.pyi

@@ -0,0 +1,46 @@
+# *****************************************************************************
+# *                             AUTO-GENERATED CODE                           *
+# *                                                                           *
+# * This code was generated by the `pyo3-tracing-subscriber` crate. Any       *
+# * modifications to this file should be made to the script or the generation *
+# * process that produced this code. Specifically, see:                       *
+# * `pyo3_tracing_subscriber::stubs::write_stub_files`                        *
+# *                                                                           *
+# * Do not manually edit this file, as your changes may be overwritten the    *
+# * next time the code is generated.                                          *
+# *****************************************************************************
+
+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.
+    """
+
+    def __new__(
+        cls,
+        name: str,
+        /,
+        version: Optional[str] = None,
+        schema_url: Optional[str] = None,
+        attributes: Optional[Dict[str, str]] = None,
+    ) -> "InstrumentationLibrary":
+        """
+        Initializes a new instance of `InstrumentationLibrary`.
+
+        :param name: The name of the instrumentation library.
+        :param version: The version of the instrumentation library.
+        :param schema_url: The `schema URL <https://opentelemetry.io/docs/specs/otel/schemas/>`_ of
+            the instrumentation library.
+        :param attributes: The attributes of the instrumentation library.
+        """
+        ...
+

qcs_sdk/_tracing_subscriber/layers/__init__.py

@@ -0,0 +1,18 @@
+# *****************************************************************************
+# *                             AUTO-GENERATED CODE                           *
+# *                                                                           *
+# * This code was generated by the `pyo3-tracing-subscriber` crate. Any       *
+# * modifications to this file should be made to the script or the generation *
+# * process that produced this code. Specifically, see:                       *
+# * `pyo3_tracing_subscriber::stubs::write_stub_files`                        *
+# *                                                                           *
+# * Do not manually edit this file, as your changes may be overwritten the    *
+# * next time the code is generated.                                          *
+# *****************************************************************************
+
+from qcs_sdk._tracing_subscriber import layers
+
+
+__doc__ = layers.__doc__
+__all__ = getattr(layers, "__all__", [])
+

qcs_sdk/_tracing_subscriber/layers/__init__.pyi

@@ -0,0 +1,30 @@
+# *****************************************************************************
+# *                             AUTO-GENERATED CODE                           *
+# *                                                                           *
+# * This code was generated by the `pyo3-tracing-subscriber` crate. Any       *
+# * modifications to this file should be made to the script or the generation *
+# * process that produced this code. Specifically, see:                       *
+# * `pyo3_tracing_subscriber::stubs::write_stub_files`                        *
+# *                                                                           *
+# * Do not manually edit this file, as your changes may be overwritten the    *
+# * next time the code is generated.                                          *
+# *****************************************************************************
+
+from __future__ import annotations
+from typing import TYPE_CHECKING
+
+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
+
+  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.
+  """

qcs_sdk/_tracing_subscriber/layers/file/__init__.py

@@ -0,0 +1,19 @@
+# *****************************************************************************
+# *                             AUTO-GENERATED CODE                           *
+# *                                                                           *
+# * This code was generated by the `pyo3-tracing-subscriber` crate. Any       *
+# * modifications to this file should be made to the script or the generation *
+# * process that produced this code. Specifically, see:                       *
+# * `pyo3_tracing_subscriber::stubs::write_stub_files`                        *
+# *                                                                           *
+# * Do not manually edit this file, as your changes may be overwritten the    *
+# * next time the code is generated.                                          *
+# *****************************************************************************
+
+from qcs_sdk._tracing_subscriber.layers import file
+
+
+__doc__ = file.__doc__
+__all__ = getattr(file, "__all__", [])
+
+

qcs_sdk/_tracing_subscriber/layers/file/__init__.pyi

@@ -0,0 +1,42 @@
+# *****************************************************************************
+# *                             AUTO-GENERATED CODE                           *
+# *                                                                           *
+# * This code was generated by the `pyo3-tracing-subscriber` crate. Any       *
+# * modifications to this file should be made to the script or the generation *
+# * process that produced this code. Specifically, see:                       *
+# * `pyo3_tracing_subscriber::stubs::write_stub_files`                        *
+# *                                                                           *
+# * Do not manually edit this file, as your changes may be overwritten the    *
+# * next time the code is generated.                                          *
+# *****************************************************************************
+
+from typing import Optional, final
+
+@final
+class Config:
+    """
+    Configuration for a
+    `tracing_subscriber::fmt::Layer <https://docs.rs/tracing-subscriber/latest/tracing_subscriber/fmt/struct.Layer.html>`_.
+    """
+
+    def __new__(
+        cls, file_path: Optional[str] = None, pretty: bool = False, filter: Optional[str] = None, json: bool = True
+    ) -> "Config":
+        """
+        Create a new `Config`.
+
+        :param file_path: The path to the file to write to. If `None`, defaults to `stdout`.
+        :param pretty: Whether or not to pretty-print the output. Defaults to `False`.
+        :param filter: A filter string to use for this layer. This uses the same format as the
+            `tracing_subscriber::filter::EnvFilter
+            <https://docs.rs/tracing-subscriber/latest/tracing_subscriber/filter/struct.EnvFilter.html>`_.
+            In summary, each directive takes the form `target[span{field=value}]=level`, where `target`
+            is roughly the Rust namespace and _only_ `level` is required.
+
+            If not specified, this will first check the `PYO3_TRACING_SUBSCRIBER_ENV_FILTER` environment
+            variable and then `RUST_LOG` environment variable. If all of these values are empty, no spans
+            will be exported.
+        :param json: Whether or not to format the output as JSON. Defaults to `True`.
+        """
+        ...
+

qcs_sdk/_tracing_subscriber/layers/otel_otlp/__init__.py

@@ -0,0 +1,18 @@
+# *****************************************************************************
+# *                             AUTO-GENERATED CODE                           *
+# *                                                                           *
+# * This code was generated by the `pyo3-tracing-subscriber` crate. Any       *
+# * modifications to this file should be made to the script or the generation *
+# * process that produced this code. Specifically, see:                       *
+# * `pyo3_tracing_subscriber::stubs::write_stub_files`                        *
+# *                                                                           *
+# * Do not manually edit this file, as your changes may be overwritten the    *
+# * next time the code is generated.                                          *
+# *****************************************************************************
+
+from qcs_sdk._tracing_subscriber.layers import otel_otlp
+
+
+__doc__ = otel_otlp.__doc__
+__all__ = getattr(otel_otlp, "__all__", [])
+

qcs_sdk/_tracing_subscriber/layers/otel_otlp/__init__.pyi

@@ -0,0 +1,118 @@
+# *****************************************************************************
+# *                             AUTO-GENERATED CODE                           *
+# *                                                                           *
+# * This code was generated by the `pyo3-tracing-subscriber` crate. Any       *
+# * modifications to this file should be made to the script or the generation *
+# * process that produced this code. Specifically, see:                       *
+# * `pyo3_tracing_subscriber::stubs::write_stub_files`                        *
+# *                                                                           *
+# * Do not manually edit this file, as your changes may be overwritten the    *
+# * next time the code is generated.                                          *
+# *****************************************************************************
+
+from __future__ import annotations
+from typing import Dict, Optional, TYPE_CHECKING, final
+from qcs_sdk._tracing_subscriber.common import InstrumentationLibrary
+
+@final
+class SpanLimits:
+    def __new__(
+        cls,
+        max_events_per_span: Optional[int] = None,
+        max_attributes_per_span: Optional[int] = None,
+        max_links_per_span: Optional[int] = None,
+        max_attributes_per_event: Optional[int] = None,
+        max_attributes_per_link: Optional[int] = None,
+    ) -> "SpanLimits": ...
+    """
+
+    :param max_events_per_span: The max events that can be added to a `Span`.
+    :param max_attributes_per_span: The max attributes that can be added to a `Span`.
+    :param max_links_per_span: The max links that can be added to a `Span`.
+    :param max_attributes_per_event: The max attributes that can be added to an `Event`.
+    :param max_attributes_per_link: The max attributes that can be added to a `Link`.
+    """
+
+@final
+class Resource:
+    """
+    A `Resource` is a representation of the entity producing telemetry. This should represent the Python
+    process starting the tracing subscription process.
+    """
+
+    def __new__(
+        cls,
+        attrs: Optional[Dict[str, "ResourceValue"]] = None,
+        schema_url: Optional[str] = None,
+    ) -> "Resource": ...
+
+
+
+@final
+class Config:
+    """
+    A configuration for `opentelemetry-otlp <https://docs.rs/opentelemetry-otlp/latest/opentelemetry_otlp/>`_
+    layer. In addition to the values specified at initialization, this configuration will also respect the
+    canonical `OpenTelemetry OTLP environment variables
+    <https://opentelemetry.io/docs/specs/otel/protocol/exporter/>`_ that are `supported by opentelemetry-otlp
+    <https://docs.rs/opentelemetry-otlp/latest/opentelemetry_otlp/trait.WithExportConfig.html#tymethod.with_env>`_.
+    """
+
+    def __new__(
+        cls,
+        span_limits: Optional[SpanLimits] = None,
+        resource: Optional[Resource] = None,
+        metadata_map: Optional[Dict[str, str]] = None,
+        sampler: Optional["Sampler"] = None,
+        endpoint: Optional[str] = None,
+        timeout_millis: Optional[int] = None,
+        pre_shutdown_timeout_millis: Optional[int] = 2000,
+        filter: Optional[str] = None,
+        instrumentation_library: Optional[InstrumentationLibrary] = None,
+    ) -> "Config":
+        """
+        Initializes a new `Config`.
+
+        :param span_limits: The limits to apply to span exports.
+        :param resource: The OpenTelemetry resource to attach to all exported spans.
+        :param metadata_map: A map of metadata to attach to all exported spans. This is a map of key value pairs
+            that may be set as gRPC metadata by the tonic library.
+        :param sampler: The sampling strategy to use. See documentation for `Sampler` for more information.
+        :param endpoint: The endpoint to export to. This should be a valid URL. If not specified, this should be
+            specified by environment variables (see `Config` documentation).
+        :param timeout_millis: The timeout for each request, in milliseconds. If not specified, this should be
+            specified by environment variables (see `Config` documentation).
+        :param pre_shutdown_timeout_millis: The timeout to wait before shutting down the OTLP exporter in milliseconds.
+            This timeout is necessary to ensure all traces from `tracing_subscriber` to make it to the OpenTelemetry
+            layer, which may be effectively force flushed. It is enforced on the `Tracing` context manager exit.
+        :param filter: A filter string to use for this layer. This uses the same format as the
+            `tracing_subscriber::filter::EnvFilter
+            <https://docs.rs/tracing-subscriber/latest/tracing_subscriber/filter/struct.EnvFilter.html>`_.
+            In summary, each directive takes the form `target[span{field=value}]=level`, where `target` is roughly the
+            Rust namespace and _only_ `level` is required.
+
+            If not specified, this will first check the `PYO3_TRACING_SUBSCRIBER_ENV_FILTER` environment variable
+            and then `RUST_LOG` environment variable. If all of these values are empty, no spans will be exported.
+        :param instrumentation_library: Information about the library providing the tracing instrumentation.
+        """
+        ...
+
+if TYPE_CHECKING:
+    from typing import List, Union 
+
+    ResourceValueArray = Union[List[bool], List[int], List[float], List[str]]
+    """
+    An array of `ResourceValue`s. This array is homogenous, so all values must be of the same type.
+    """
+
+    ResourceValue= Union[bool, int, float, str, ResourceValueArray]
+    """
+    A value that can be added to a `Resource`.
+    """
+
+    Sampler = Union[bool, float]
+    """
+    A `Sampler` is a representation of the sampling strategy to use. If this is a `bool`, it will
+    either sample all traces (`True`) or none of them (`False`). If this is a `float`, it will sample
+    traces at the given rate.
+    """

qcs_sdk/_tracing_subscriber/layers/otel_otlp_file/__init__.py

@@ -0,0 +1,18 @@
+# *****************************************************************************
+# *                             AUTO-GENERATED CODE                           *
+# *                                                                           *
+# * This code was generated by the `pyo3-tracing-subscriber` crate. Any       *
+# * modifications to this file should be made to the script or the generation *
+# * process that produced this code. Specifically, see:                       *
+# * `pyo3_tracing_subscriber::stubs::write_stub_files`                        *
+# *                                                                           *
+# * Do not manually edit this file, as your changes may be overwritten the    *
+# * next time the code is generated.                                          *
+# *****************************************************************************
+
+from qcs_sdk._tracing_subscriber.layers import otel_otlp_file
+
+
+__doc__ = otel_otlp_file.__doc__
+__all__ = getattr(otel_otlp_file, "__all__", [])
+

qcs_sdk/_tracing_subscriber/layers/otel_otlp_file/__init__.pyi

@@ -0,0 +1,38 @@
+# *****************************************************************************
+# *                             AUTO-GENERATED CODE                           *
+# *                                                                           *
+# * This code was generated by the `pyo3-tracing-subscriber` crate. Any       *
+# * modifications to this file should be made to the script or the generation *
+# * process that produced this code. Specifically, see:                       *
+# * `pyo3_tracing_subscriber::stubs::write_stub_files`                        *
+# *                                                                           *
+# * Do not manually edit this file, as your changes may be overwritten the    *
+# * next time the code is generated.                                          *
+# *****************************************************************************
+
+from typing import Optional, final
+from qcs_sdk._tracing_subscriber.common import InstrumentationLibrary
+
+
+@final
+class Config:
+    """
+    A configuration for `opentelemetry-stdout <https://docs.rs/opentelemetry-stdout/latest/opentelemetry_stdout/>`_
+    layer.
+    """
+
+    def __new__(cls, file_path: Optional[str] = None, filter: Optional[str] = None, instrumentation_library: Optional[InstrumentationLibrary] = None) -> "Config":
+        """
+        :param file_path: The path to the file to write to. If not specified, defaults to stdout.
+        :param filter: A filter string to use for this layer. This uses the same format as the
+            `tracing_subscriber::filter::EnvFilter
+            <https://docs.rs/tracing-subscriber/latest/tracing_subscriber/filter/struct.EnvFilter.html>`_.
+            In summary, each directive takes the form `target[span{field=value}]=level`, where `target` is
+            roughly the Rust namespace and _only_ `level` is required.
+
+            If not specified, this will first check the `PYO3_TRACING_SUBSCRIBER_ENV_FILTER` environment variable
+            and then `RUST_LOG` environment variable. If all of these values are empty, no spans will be exported.
+        :param instrumentation_library: Information about the library providing the tracing instrumentation.
+        """
+        ...
+

qcs_sdk/_tracing_subscriber/subscriber/__init__.py

@@ -0,0 +1,18 @@
+# *****************************************************************************
+# *                             AUTO-GENERATED CODE                           *
+# *                                                                           *
+# * This code was generated by the `pyo3-tracing-subscriber` crate. Any       *
+# * modifications to this file should be made to the script or the generation *
+# * process that produced this code. Specifically, see:                       *
+# * `pyo3_tracing_subscriber::stubs::write_stub_files`                        *
+# *                                                                           *
+# * Do not manually edit this file, as your changes may be overwritten the    *
+# * next time the code is generated.                                          *
+# *****************************************************************************
+
+from qcs_sdk._tracing_subscriber import subscriber
+
+
+__doc__ = subscriber.__doc__
+__all__ = getattr(subscriber, "__all__", [])
+

qcs_sdk/_tracing_subscriber/subscriber/__init__.pyi

@@ -0,0 +1,25 @@
+# *****************************************************************************
+# *                             AUTO-GENERATED CODE                           *
+# *                                                                           *
+# * This code was generated by the `pyo3-tracing-subscriber` crate. Any       *
+# * modifications to this file should be made to the script or the generation *
+# * process that produced this code. Specifically, see:                       *
+# * `pyo3_tracing_subscriber::stubs::write_stub_files`                        *
+# *                                                                           *
+# * Do not manually edit this file, as your changes may be overwritten the    *
+# * next time the code is generated.                                          *
+# *****************************************************************************
+
+from typing import final
+
+from .. import layers
+
+@final
+class Config:
+    """
+    Configuration for the tracing subscriber. Currently, this only requires a single layer to be
+    set on the `tracing_subscriber::Registry`.
+    """
+
+    def __new__(cls, layer: layers.Config | None = None) -> "Config": ...
+

qcs_sdk/client.pyi

@@ -0,0 +1,124 @@
+# This file is automatically generated by pyo3_stub_gen
+# ruff: noqa: E501, F401
+
+import builtins
+import collections.abc
+import typing
+from qcs_api_client_common.configuration import OAuthSession
+from qcs_sdk import QcsSdkError
+
+class BuildClientError(ClientError):
+    r"""
+    Errors encountered while building the QCS API client configuration manually.
+    """
+    ...
+
+class ClientError(QcsSdkError):
+    r"""
+    Errors encountered while interacting with a QCS API client.
+    """
+    ...
+
+class LoadClientError(ClientError):
+    r"""
+    Errors encountered while loading the QCS API client configuration from the environment configuration.
+    """
+    ...
+
+@typing.final
+class QCSClient:
+    r"""
+    A client providing helper functionality for accessing QCS APIs
+    """
+    @property
+    def api_url(self) -> builtins.str:
+        r"""
+        URL to access the QCS API.
+        """
+    @property
+    def grpc_api_url(self) -> builtins.str:
+        r"""
+        URL to access the QCS gRPC API.
+        """
+    @property
+    def oauth_session(self) -> OAuthSession:
+        r"""
+        Get a copy of the OAuth session.
+        """
+    @property
+    def quilc_url(self) -> builtins.str:
+        r"""
+        URL to access the ``quilc`` compiler.
+        """
+    @property
+    def qvm_url(self) -> builtins.str:
+        r"""
+        URL to access the QVM.
+        """
+    def __eq__(self, other: builtins.object) -> builtins.bool: ...
+    def __new__(cls, oauth_session: typing.Optional[OAuthSession] = None, api_url: typing.Optional[builtins.str] = None, grpc_api_url: typing.Optional[builtins.str] = None, quilc_url: typing.Optional[builtins.str] = None, qvm_url: typing.Optional[builtins.str] = None) -> QCSClient:
+        r"""
+        Manually construct a `QCSClient`.
+        
+        Prefer to use `QCSClient.load` to construct an environment-based profile.
+        """
+    def get_oauth_session_async(self) -> collections.abc.Awaitable[typing.Any]:
+        r"""
+        Get a copy of the OAuth session in an async context.
+        """
+    @staticmethod
+    def load(profile_name: typing.Optional[builtins.str] = None) -> QCSClient:
+        r"""
+        Create a `QCSClient` configuration using an environment-based configuration.
+        
+        :param `profile_name`: The QCS setting's profile name to use. If ``None``, the default value configured in your environment is used.
+        
+        :raises `LoadClientError`: If there is an issue loading the profile details from the environment.
+        """
+    @staticmethod
+    def load_with_login(profile_name: typing.Optional[builtins.str] = None) -> QCSClient:
+        r"""
+        Create a `QCSClient` configuration using an environment-based configuration.
+        
+        If credentials are not found or stale, a PKCE login redirect flow will be initialized.
+        Note that this opens up a TCP port on your system to accept a browser HTTP redirect,
+        so you should not use this in environments where that is not possible,
+        such as hosted `JupyterLab` sessions.
+        
+        :param `profile_name`: The QCS setting's profile name to use. If ``None``, the default value configured in your environment is used.
+        
+        :raises `LoadClientError`: If there is an issue loading the profile details from the environment or if the PKCE login flow fails.
+        
+        See the [QCS documentation](https://docs.rigetti.com/qcs/references/qcs-client-configuration#environment-variables-and-configuration-files)
+        for more details.
+        """
+    @staticmethod
+    def load_with_login_async(profile_name: typing.Optional[builtins.str] = None) -> collections.abc.Awaitable[QCSClient]:
+        r"""
+        Create a `QCSClient` configuration using an environment-based configuration.
+        
+        If credentials are not found or stale, a PKCE login redirect flow will be initialized.
+        Note that this opens up a TCP port on your system to accept a browser HTTP redirect,
+        so you should not use this in environments where that is not possible,
+        such as hosted `JupyterLab` sessions.
+        
+        :param `profile_name`: The QCS setting's profile name to use. If ``None``, the default value configured in your environment is used.
+        
+        :raises `LoadClientError`: If there is an issue loading the profile details from the environment or if the PKCE login flow fails.
+        
+        See the [QCS documentation](https://docs.rigetti.com/qcs/references/qcs-client-configuration#environment-variables-and-configuration-files)
+        for more details.
+        """
+
+class RPCQQuilcError(ClientError):
+    r"""
+    Errors when compiling with RPCQ client.
+    """
+    ...
+
+class TokenError(ClientError):
+    r"""
+    Errors that can occur when managing authorization tokens.
+    """
+    ...
+

qcs_sdk/compiler/__init__.pyi

@@ -0,0 +1,5 @@
+# This file is automatically generated by pyo3_stub_gen
+# ruff: noqa: E501, F401
+
+from . import quilc
+