luminarycloud 0.22.0__tar.gz → 0.22.1__tar.gz

{luminarycloud-0.22.0 → luminarycloud-0.22.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: luminarycloud
-Version: 0.22.0
+Version: 0.22.1
 Summary: Luminary Cloud SDK
 Project-URL: Homepage, https://www.luminarycloud.com/
 Project-URL: Documentation, https://app.luminarycloud.com/docs/api/

luminarycloud-0.22.1/luminarycloud/_client/authentication_plugin.py

@@ -0,0 +1,89 @@
+# Copyright 2023 Luminary Cloud, Inc. All Rights Reserved.
+
+import grpc
+
+from .._auth import Auth0Client
+
+
+class AuthenticationPlugin(grpc.AuthMetadataPlugin):
+    """
+    Adds authentication headers for each outgoing RPC.
+
+    Supports two authentication methods:
+    1. Bearer token authentication using Auth0
+    2. API key authentication using x-api-key header
+
+    The __call__ function is invoked for every outgoing call. If using Bearer token
+    and the token has expired or doesn't exist, the Auth0 client tries to acquire
+    a new one.
+    """
+
+    def __init__(self, auth0_client: Auth0Client, api_key: str | None = None):
+        super(AuthenticationPlugin, self).__init__()
+        self.auth0_client = auth0_client
+        self.api_key = api_key
+
+    def __call__(
+        self,
+        context: grpc.AuthMetadataContext,
+        # Takes the list of headers to add as tuples
+        callback: grpc.AuthMetadataPluginCallback,
+    ) -> None:
+        try:
+            if self.api_key and isinstance(self.api_key, str):
+                metadata = [("x-api-key", self.api_key)]
+            else:
+                access_token = self.auth0_client.fetch_access_token()
+                metadata = [("authorization", "Bearer " + access_token)]
+            callback(metadata, None)
+        except Exception as err:
+            callback(None, err)
+
+
+class AuthInterceptor(
+    grpc.UnaryUnaryClientInterceptor,
+    grpc.UnaryStreamClientInterceptor,
+    grpc.StreamUnaryClientInterceptor,
+    grpc.StreamStreamClientInterceptor,
+):
+    """
+    I need this as a workaround for container-to-host connections because I need to create a channel
+    that uses CallCredentials but doesn't use any ChannelCredentials. I.e. I need to authenticate
+    the requests, but I need the connection to be unencrypted. This is because the grpc server on
+    the native host isn't using SSL, so I can't use grpc.ssl_channel_credentials(), but it's also
+    not reachable on a loopback interface, so I can't use grpc.local_channel_credentials() either.
+    So I need to use a grpc.insecure_channel(), but you can't use CallCredentials with an insecure
+    channel. So the workaround is to use an interceptor instead of CallCredentials.
+
+    Also, I don't care about auth0, so I'm only supporting an API key.
+    """
+
+    def __init__(self, api_key: str):
+        self._api_key = api_key
+
+    def _augment(self, metadata):
+        return metadata + [("x-api-key", self._api_key)]
+
+    def intercept_unary_unary(self, continuation, client_call_details, request):
+        new_details = client_call_details._replace(
+            metadata=self._augment(client_call_details.metadata or [])
+        )
+        return continuation(new_details, request)
+
+    def intercept_unary_stream(self, continuation, client_call_details, request):
+        new_details = client_call_details._replace(
+            metadata=self._augment(client_call_details.metadata or [])
+        )
+        return continuation(new_details, request)
+
+    def intercept_stream_unary(self, continuation, client_call_details, request_iter):
+        new_details = client_call_details._replace(
+            metadata=self._augment(client_call_details.metadata or [])
+        )
+        return continuation(new_details, request_iter)
+
+    def intercept_stream_stream(self, continuation, client_call_details, request_iter):
+        new_details = client_call_details._replace(
+            metadata=self._augment(client_call_details.metadata or [])
+        )
+        return continuation(new_details, request_iter)

{luminarycloud-0.22.0 → luminarycloud-0.22.1}/luminarycloud/_client/client.py

@@ -47,7 +47,7 @@ from .._proto.api.v0.luminarycloud.vis.vis_pb2_grpc import VisAPIServiceStub
 from .._proto.api.v0.luminarycloud.feature_flag.feature_flag_pb2_grpc import (
     FeatureFlagServiceStub,
 )
-from .authentication_plugin import AuthenticationPlugin
+from .authentication_plugin import AuthenticationPlugin, AuthInterceptor
 from .config import LC_DOMAIN, LC_API_KEY
 from .logging_interceptor import LoggingInterceptor
 from .retry_interceptor import RetryInterceptor
@@ -93,11 +93,20 @@ class Client(
         The URL of the HTTP REST server. If not provided, it will default to the `target`.
     localhost : bool
         True if the API server is running locally.
+    insecure_grpc_channel : bool
+        True to use an unencrypted gRPC channel, even though requests are authenticated. There's no
+        legitimate reason to do this outside of a local development situation where the SDK is
+        running from a container and connecting to an API server that is running on the host.
     grpc_channel_options : Optional[Iterable[tuple[str, str]]]
         A list of gRPC channel args. The full list is available here:
         https://github.com/grpc/grpc/blob/v1.46.x/include/grpc/impl/codegen/grpc_types.h
     api_key : Optional[str]
         The API key to use for authentication.
+    log_retries : bool
+        True to log each retriable error response. There are some errors the API server may return
+        that are known to be transient, and the client will always retry requests when it gets one
+        of them. By default, the client retries silently. Set this to True to log the error
+        responses (at INFO level) for the retriable errors.
     **kwargs : dict, optional
         Additional arguments are passed to Auth0Client. See _auth/auth.py.
 
@@ -116,9 +125,11 @@ class Client(
         target: str = LC_DOMAIN,
         http_target: str | None = None,
         localhost: bool = False,
+        insecure_grpc_channel: bool = False,
         grpc_channel_options: Optional[Iterable[tuple[str, Union[str, int]]]] = None,
         channel_credentials: Optional[grpc.ChannelCredentials] = None,
         api_key: Optional[str] = LC_API_KEY,
+        log_retries: bool = False,
         **kwargs: Any,
     ):
         self._target = target
@@ -139,7 +150,12 @@ class Client(
         if grpc_channel_options:
             grpc_channel_options_with_keep_alive.extend(grpc_channel_options)
         self._channel = self._create_channel(
-            localhost, grpc_channel_options_with_keep_alive, channel_credentials, api_key
+            localhost,
+            insecure_grpc_channel,
+            grpc_channel_options_with_keep_alive,
+            channel_credentials,
+            api_key,
+            log_retries,
         )
         self._context_tokens: list[Token] = []
         self.__register_rpcs()
@@ -193,9 +209,11 @@ class Client(
     def _create_channel(
         self,
         localhost: bool = False,
+        insecure: bool = False,
         grpc_channel_options: Optional[Iterable[tuple[str, Union[str, int]]]] = None,
         channel_credentials: Optional[grpc.ChannelCredentials] = None,
         api_key: Optional[str] = None,
+        log_retries: bool = False,
     ) -> grpc.Channel:
         if channel_credentials is None:
             if localhost:
@@ -217,15 +235,22 @@ class Client(
         call_creds = grpc.metadata_call_credentials(auth_plugin)
         composite_creds = grpc.composite_channel_credentials(channel_credentials, call_creds)
         options = grpc_channel_options and list(grpc_channel_options)
-        channel = grpc.secure_channel(
-            self._target,
-            composite_creds,
-            options=options,
-        )
+        if insecure:
+            channel = grpc.insecure_channel(self._target, options=options)
+            channel = grpc.intercept_channel(
+                channel,
+                AuthInterceptor(api_key),
+            )
+        else:
+            channel = grpc.secure_channel(
+                self._target,
+                composite_creds,
+                options=options,
+            )
         intercepted_channel = grpc.intercept_channel(
             channel,
             LoggingInterceptor(),
-            RetryInterceptor(),
+            RetryInterceptor(log_retries),
         )
         return add_instrumentation(
             intercepted_channel,

{luminarycloud-0.22.0 → luminarycloud-0.22.1}/luminarycloud/_client/http_client.py

@@ -32,7 +32,7 @@ class HttpClient:
         api_key: str | None = None,
         auth0_client: Auth0Client | None = None,
         *,
-        timeout: int = 10,
+        timeout: int | None = 300,
         retries: int = 3,
         backoff_factor: float = 0.3,
         retriable_status_codes: tuple = (500, 502, 503, 504, 429),

{luminarycloud-0.22.0 → luminarycloud-0.22.1}/luminarycloud/_client/retry_interceptor.py

@@ -2,19 +2,68 @@
 from collections.abc import Callable
 from time import sleep
 from typing import Any
+import logging
 
 import grpc
 from grpc import (
     ClientCallDetails,
     UnaryUnaryClientInterceptor,
 )
+from grpc_status.rpc_status import GRPC_DETAILS_METADATA_KEY
 
 from luminarycloud.exceptions import AuthenticationError
+from luminarycloud._proto.base import base_pb2
+
+
+def _is_rate_limited(call: grpc.Call) -> bool:
+    """
+    Check if a gRPC call failed due to rate limiting.
+
+    Rate limit errors are identified with the SUBCODE_RATE_LIMITED subcode and UNAVAILABLE status.
+
+    Args:
+        call: The gRPC call to check
+
+    Returns:
+        True if the error is a rate limit error, False otherwise
+    """
+    if call.code() != grpc.StatusCode.UNAVAILABLE:
+        return False
+
+    try:
+        # Get the trailing metadata which contains error details
+        # Metadata is a sequence of tuples (key, value)
+        for key, value in call.trailing_metadata() or []:
+            if key != GRPC_DETAILS_METADATA_KEY or not isinstance(value, bytes):
+                continue
+
+            status = base_pb2.Status()
+            status.ParseFromString(value)
+            for any_detail in status.details:
+                if any_detail.Is(base_pb2.StatusPayload.DESCRIPTOR):
+                    payload = base_pb2.StatusPayload()
+                    any_detail.Unpack(payload)
+                    if payload.subcode == base_pb2.SUBCODE_RATE_LIMITED:
+                        return True
+    except Exception:
+        pass
+    return False
+
+
+logger = logging.getLogger(__name__)
 
 
 class RetryInterceptor(UnaryUnaryClientInterceptor):
+    def __init__(self, log_retries: bool = False):
+        self.log_retries = log_retries
+        super().__init__()
+
     """
-    A retry interceptor that retries on status code RESOURCE_EXHAUSTED (i.e. rate-limited).
+    A retry interceptor that retries on rate limit errors and other retryable errors.
+
+    This interceptor handles:
+    1. Rate limit errors (UNAVAILABLE with SUBCODE_RATE_LIMITED) - always retried
+    2. [grpc.StatusCode.RESOURCE_EXHAUSTED, grpc.StatusCode.UNAVAILABLE] - retried
 
     This is required because, while the retry policy for the gRPC client is configurable via
     https://github.com/grpc/grpc-proto/blob/master/grpc/service_config/service_config.proto,
@@ -43,7 +92,10 @@ class RetryInterceptor(UnaryUnaryClientInterceptor):
         n_max_retries = 20
         max_retry_seconds = 20
         backoffs = [min(i * 2, max_retry_seconds) for i in range(1, n_max_retries)]
-        for backoff in backoffs:  # in seconds
+        backoff_index = 0
+        while True:
+            if backoff_index >= len(backoffs):
+                break
             call = continuation(client_call_details, request)
             if call.code() not in retryable_codes:
                 break
@@ -54,7 +106,17 @@ class RetryInterceptor(UnaryUnaryClientInterceptor):
                 details = call.details() or ""
                 if "InteractiveAuthException" in details:
                     break
+            backoff = backoffs[backoff_index]
+            if self.log_retries:
+                logger.info(
+                    f"Retrying {client_call_details.method} in {backoff} seconds (last response: {call.code()}, {call.details()})"
+                )
             sleep(backoff)
+            # Keep retrying rate-limited calls while increasing the backoff up to the max.
+            backoff_index += 1
+            if _is_rate_limited(call):
+                backoff_index = max(min(backoff_index, len(backoffs) - 2), 0)
+
         try:
             call.result()
         except grpc.RpcError as e:

{luminarycloud-0.22.0 → luminarycloud-0.22.1}/luminarycloud/_helpers/download.py

@@ -17,6 +17,7 @@ from .._proto.api.v0.luminarycloud.solution.solution_pb2 import (
 )
 from .._proto.api.v0.luminarycloud.physics_ai.physics_ai_pb2 import (
     GetSolutionDataPhysicsAIRequest,
+    SurfaceGroup,
 )
 from .._client import Client
 from ..enum.quantity_type import QuantityType
@@ -140,6 +141,7 @@ def download_solution_physics_ai(
     process_volume: bool = False,
     single_precision: bool = False,
     internal_options: Optional[Dict[str, str]] = None,
+    export_surface_groups: Optional[Dict[str, List[str]]] = None,
 ) -> Optional[FileChunkStream]:
     """
     Returns the download as a file-like object, or None if destination_url is provided.
@@ -165,6 +167,9 @@ def download_solution_physics_ai(
         Whether to process volume meshes during physics AI processing.
     single_precision: bool
         If True, the solution will be downloaded in single precision.
+    export_surface_groups: Optional[Dict[str, List[str]]]
+        Dictionary mapping group names to lists of surface names.
+        Each group will be exported as an individual STL file.
 
     Examples
     --------
@@ -173,6 +178,11 @@ def download_solution_physics_ai(
     ...         fp.write(dl.read())
     """
 
+    surface_groups_pb = []
+    if export_surface_groups:
+        for group_name, surfaces in export_surface_groups.items():
+            surface_groups_pb.append(SurfaceGroup(name=group_name, surfaces=surfaces))
+
     request = GetSolutionDataPhysicsAIRequest(
         solution_id=solution_id,
         exclude_surfaces=exclude_surfaces or [],
@@ -186,6 +196,7 @@ def download_solution_physics_ai(
         process_volume=process_volume,
         single_precision=single_precision,
         internal_options=internal_options or {},
+        export_surface_groups=surface_groups_pb,
     )
     response = client.GetSolutionDataPhysicsAI(request)