feat: Streaming upload support (#1779)

Co-authored-by: pyansys-ci-bot <[email protected]>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Roberto Pastor Muela <[email protected]>
Co-authored-by: Umut Soysal <[email protected]>

Author: 5 people

doc/changelog.d/1779.added.md

@@ -0,0 +1 @@
+Streaming upload support

src/ansys/geometry/core/connection/__init__.py

@@ -38,11 +38,7 @@
     trimmed_curve_to_grpc_trimmed_curve,
     unit_vector_to_grpc_direction,
 )
-from ansys.geometry.core.connection.defaults import (
-    DEFAULT_HOST,
-    DEFAULT_PORT,
-    GEOMETRY_SERVICE_DOCKER_IMAGE,
-)
+import ansys.geometry.core.connection.defaults as defaults
 from ansys.geometry.core.connection.docker_instance import (
     GeometryContainers,
     LocalDockerInstance,

src/ansys/geometry/core/connection/client.py

@@ -54,7 +54,7 @@
 )
 from ansys.api.dbu.v0.admin_pb2_grpc import AdminStub
 from ansys.geometry.core.connection.backend import BackendType
-from ansys.geometry.core.connection.defaults import DEFAULT_HOST, DEFAULT_PORT, MAX_MESSAGE_LENGTH
+import ansys.geometry.core.connection.defaults as pygeom_defaults
 from ansys.geometry.core.connection.docker_instance import LocalDockerInstance
 from ansys.geometry.core.connection.product_instance import ProductInstance
 from ansys.geometry.core.logger import LOG, PyGeometryCustomAdapter
@@ -158,8 +158,8 @@ class GrpcClient:
     @check_input_types
     def __init__(
         self,
-        host: str = DEFAULT_HOST,
-        port: str | int = DEFAULT_PORT,
+        host: str = pygeom_defaults.DEFAULT_HOST,
+        port: str | int = pygeom_defaults.DEFAULT_PORT,
         channel: grpc.Channel | None = None,
         remote_instance: Optional["Instance"] = None,
         docker_instance: LocalDockerInstance | None = None,
@@ -183,8 +183,8 @@ def __init__(
             self._channel = grpc.insecure_channel(
                 self._target,
                 options=[
-                    ("grpc.max_receive_message_length", MAX_MESSAGE_LENGTH),
-                    ("grpc.max_send_message_length", MAX_MESSAGE_LENGTH),
+                    ("grpc.max_receive_message_length", pygeom_defaults.MAX_MESSAGE_LENGTH),
+                    ("grpc.max_send_message_length", pygeom_defaults.MAX_MESSAGE_LENGTH),
                 ],
             )
 

src/ansys/geometry/core/connection/docker_instance.py

@@ -37,7 +37,7 @@
 except ModuleNotFoundError:  # pragma: no cover
     _HAS_DOCKER = False
 
-from ansys.geometry.core.connection.defaults import DEFAULT_PORT, GEOMETRY_SERVICE_DOCKER_IMAGE
+import ansys.geometry.core.connection.defaults as pygeom_defaults
 from ansys.geometry.core.logger import LOG
 
 
@@ -157,7 +157,7 @@ def is_docker_installed() -> bool:
     @_docker_python_available
     def __init__(
         self,
-        port: int = DEFAULT_PORT,
+        port: int = pygeom_defaults.DEFAULT_PORT,
         connect_to_existing_service: bool = True,
         restart_if_existing_service: bool = False,
         name: str | None = None,
@@ -234,7 +234,10 @@ def _is_cont_geom_service(self, cont: "Container") -> bool:
         # If one of the tags matches a Geometry service tag --> Return True
         for tag in cont.image.tags:
             for geom_services in GeometryContainers:
-                if tag == f"{GEOMETRY_SERVICE_DOCKER_IMAGE}:{geom_services.value[2]}":
+                if (
+                    tag
+                    == f"{pygeom_defaults.GEOMETRY_SERVICE_DOCKER_IMAGE}:{geom_services.value[2]}"
+                ):
                     return True
 
         # If you have reached this point, the image is not a Geometry service
@@ -290,7 +293,7 @@ def _deploy_container(self, port: int, name: str | None, image: GeometryContaine
         # Try to deploy it
         try:
             container: Container = self.docker_client().containers.run(
-                image=f"{GEOMETRY_SERVICE_DOCKER_IMAGE}:{image.value[2]}",
+                image=f"{pygeom_defaults.GEOMETRY_SERVICE_DOCKER_IMAGE}:{image.value[2]}",
                 detach=True,
                 auto_remove=True,
                 name=name,
@@ -350,7 +353,7 @@ def get_geometry_container_type(instance: LocalDockerInstance) -> GeometryContai
     """
     for tag in instance.container.image.tags:
         for geom_services in GeometryContainers:
-            if tag == f"{GEOMETRY_SERVICE_DOCKER_IMAGE}:{geom_services.value[2]}":
+            if tag == f"{pygeom_defaults.GEOMETRY_SERVICE_DOCKER_IMAGE}:{geom_services.value[2]}":
                 return geom_services
 
     return None

src/ansys/geometry/core/connection/launcher.py

@@ -27,8 +27,7 @@
 from typing import TYPE_CHECKING
 
 from ansys.geometry.core.connection.backend import ApiVersions, BackendType
-from ansys.geometry.core.connection.client import MAX_MESSAGE_LENGTH
-from ansys.geometry.core.connection.defaults import DEFAULT_PIM_CONFIG, DEFAULT_PORT
+import ansys.geometry.core.connection.defaults as pygeom_defaults
 from ansys.geometry.core.connection.docker_instance import (
     _HAS_DOCKER,
     GeometryContainers,
@@ -290,7 +289,7 @@ def launch_remote_modeler(
 
 
 def launch_docker_modeler(
-    port: int = DEFAULT_PORT,
+    port: int = pygeom_defaults.DEFAULT_PORT,
     connect_to_existing_service: bool = True,
     restart_if_existing_service: bool = False,
     name: str | None = None,
@@ -958,7 +957,7 @@ def _launch_pim_instance(
 
     # If PIM Light is being used and PyPIM configuration is not defined... use defaults.
     if is_pim_light and not os.environ.get("ANSYS_PLATFORM_INSTANCEMANAGEMENT_CONFIG", None):
-        os.environ["ANSYS_PLATFORM_INSTANCEMANAGEMENT_CONFIG"] = DEFAULT_PIM_CONFIG
+        os.environ["ANSYS_PLATFORM_INSTANCEMANAGEMENT_CONFIG"] = pygeom_defaults.DEFAULT_PIM_CONFIG
         pop_out = True
     else:
         pop_out = False
@@ -969,7 +968,7 @@ def _launch_pim_instance(
     instance.wait_for_ready()
     channel = instance.build_grpc_channel(
         options=[
-            ("grpc.max_receive_message_length", MAX_MESSAGE_LENGTH),
+            ("grpc.max_receive_message_length", pygeom_defaults.MAX_MESSAGE_LENGTH),
         ]
     )
 

src/ansys/geometry/core/designer/body.py

@@ -36,6 +36,7 @@
     BooleanRequest,
     CopyRequest,
     GetCollisionRequest,
+    GetTessellationRequest,
     MapRequest,
     MirrorRequest,
     RotateRequest,
@@ -59,6 +60,7 @@
     ShellRequest,
 )
 from ansys.api.geometry.v0.commands_pb2_grpc import CommandsStub
+from ansys.api.geometry.v0.models_pb2 import TessellationOptions as GRPCTessellationOptions
 from ansys.geometry.core.connection.client import GrpcClient
 from ansys.geometry.core.connection.conversions import (
     frame_to_grpc_frame,
@@ -96,6 +98,7 @@
     min_backend_version,
 )
 from ansys.geometry.core.misc.measurements import DEFAULT_UNITS, Angle, Distance
+from ansys.geometry.core.misc.options import TessellationOptions
 from ansys.geometry.core.shapes.curves.trimmed_curve import TrimmedCurve
 from ansys.geometry.core.sketch.sketch import Sketch
 from ansys.geometry.core.typing import Real
@@ -564,7 +567,9 @@ def copy(self, parent: "Component", name: str = None) -> "Body":
         return
 
     @abstractmethod
-    def tessellate(self, merge: bool = False) -> Union["PolyData", "MultiBlock"]:
+    def tessellate(
+        self, merge: bool = False, tessellation_options: TessellationOptions = None
+    ) -> Union["PolyData", "MultiBlock"]:
         """Tessellate the body and return the geometry as triangles.
 
         Parameters
@@ -573,6 +578,8 @@ def tessellate(self, merge: bool = False) -> Union["PolyData", "MultiBlock"]:
             Whether to merge the body into a single mesh. When ``False`` (default), the
             number of triangles are preserved and only the topology is merged.
             When ``True``, the individual faces of the tessellation are merged.
+        tessellation_options : TessellationOptions, default: None
+            A set of options to determine the tessellation quality.
 
         Returns
         -------
@@ -1266,7 +1273,10 @@ def copy(self, parent: "Component", name: str = None) -> "Body":  # noqa: D102
     @protect_grpc
     @graphics_required
     def tessellate(  # noqa: D102
-        self, merge: bool = False, transform: Matrix44 = IDENTITY_MATRIX44
+        self,
+        merge: bool = False,
+        transform: Matrix44 = IDENTITY_MATRIX44,
+        tess_options: TessellationOptions = None,
     ) -> Union["PolyData", "MultiBlock"]:
         # lazy import here to improve initial module load time
         import pyvista as pv
@@ -1278,11 +1288,45 @@ def tessellate(  # noqa: D102
 
         # cache tessellation
         if not self._tessellation:
-            resp = self._bodies_stub.GetTessellation(self._grpc_id)
-            self._tessellation = {
-                str(face_id): tess_to_pd(face_tess)
-                for face_id, face_tess in resp.face_tessellation.items()
-            }
+            if tess_options is not None:
+                request = GetTessellationRequest(
+                    id=self._grpc_id,
+                    options=GRPCTessellationOptions(
+                        surface_deviation=tess_options.surface_deviation,
+                        angle_deviation=tess_options.angle_deviation,
+                        maximum_aspect_ratio=tess_options.max_aspect_ratio,
+                        maximum_edge_length=tess_options.max_edge_length,
+                        watertight=tess_options.watertight,
+                    ),
+                )
+                try:
+                    resp = self._bodies_stub.GetTessellationWithOptions(request)
+                    self._tessellation = {
+                        str(face_id): tess_to_pd(face_tess)
+                        for face_id, face_tess in resp.face_tessellation.items()
+                    }
+                except Exception:
+                    tessellation_map = {}
+                    for response in self._bodies_stub.GetTessellationStream(request):
+                        for key, value in response.face_tessellation.items():
+                            tessellation_map[key] = tess_to_pd(value)
+
+                    self._tessellation = tessellation_map
+            else:
+                try:
+                    resp = self._bodies_stub.GetTessellation(self._grpc_id)
+                    self._tessellation = {
+                        str(face_id): tess_to_pd(face_tess)
+                        for face_id, face_tess in resp.face_tessellation.items()
+                    }
+                except Exception:
+                    tessellation_map = {}
+                    request = GetTessellationRequest(self._grpc_id)
+                    for response in self._bodies_stub.GetTessellationStream(request):
+                        for key, value in response.face_tessellation.items():
+                            tessellation_map[key] = tess_to_pd(value)
+
+                    self._tessellation = tessellation_map
 
         pdata = [tess.transform(transform, inplace=False) for tess in self._tessellation.values()]
         comp = pv.MultiBlock(pdata)
@@ -1810,9 +1854,11 @@ def copy(self, parent: "Component", name: str = None) -> "Body":  # noqa: D102
 
     @ensure_design_is_active
     def tessellate(  # noqa: D102
-        self, merge: bool = False
+        self, merge: bool = False, tess_options: TessellationOptions = None
     ) -> Union["PolyData", "MultiBlock"]:
-        return self._template.tessellate(merge, self.parent_component.get_world_transform())
+        return self._template.tessellate(
+            merge, self.parent_component.get_world_transform(), tess_options
+        )
 
     @ensure_design_is_active
     def shell_body(self, offset: Real) -> bool:  # noqa: D102

src/ansys/geometry/core/designer/design.py

@@ -326,10 +326,7 @@ def download(
         file_location.write_bytes(received_bytes)
         self._grpc_client.log.debug(f"Design downloaded at location {file_location}.")
 
-    def __export_and_download_legacy(
-        self,
-        format: DesignFileFormat = DesignFileFormat.SCDOCX,
-    ) -> bytes:
+    def __export_and_download_legacy(self, format: DesignFileFormat) -> bytes:
         """Export and download the design from the server.
 
         Notes
@@ -339,7 +336,7 @@ def __export_and_download_legacy(
 
         Parameters
         ----------
-        format : DesignFileFormat, default: DesignFileFormat.SCDOCX
+        format : DesignFileFormat
             Format for the file to save to.
 
         Returns
@@ -371,15 +368,12 @@ def __export_and_download_legacy(
 
         return received_bytes
 
-    def __export_and_download(
-        self,
-        format: DesignFileFormat = DesignFileFormat.SCDOCX,
-    ) -> bytes:
+    def __export_and_download(self, format: DesignFileFormat) -> bytes:
         """Export and download the design from the server.
 
         Parameters
         ----------
-        format : DesignFileFormat, default: DesignFileFormat.SCDOCX
+        format : DesignFileFormat
             Format for the file to save to.
 
         Returns
@@ -402,10 +396,23 @@ def __export_and_download(
             DesignFileFormat.SCDOCX,
             DesignFileFormat.STRIDE,
         ]:
-            response = self._design_stub.DownloadExportFile(
-                DownloadExportFileRequest(format=format.value[1])
-            )
-            received_bytes += response.data
+            try:
+                response = self._design_stub.DownloadExportFile(
+                    DownloadExportFileRequest(format=format.value[1])
+                )
+                received_bytes += response.data
+            except Exception:
+                self._grpc_client.log.warning(
+                    f"Failed to download the file in {format.value[0]} format."
+                    " Attempting to stream download."
+                )
+                # Attempt to download the file via streaming
+                received_bytes = bytes()
+                responses = self._design_stub.StreamDownloadExportFile(
+                    DownloadExportFileRequest(format=format.value[1])
+                )
+                for response in responses:
+                    received_bytes += response.data
         else:
             self._grpc_client.log.warning(
                 f"{format.value[0]} format requested is not supported. Ignoring download request."