chore: cleanup miscellaneous grpc refactors (#2272)

Co-authored-by: pyansys-ci-bot <[email protected]>

Author: RobPasMue

doc/changelog.d/2272.maintenance.md

@@ -0,0 +1 @@
+Cleanup miscellaneous grpc refactors

src/ansys/geometry/core/_grpc/_services/_service.py

@@ -42,6 +42,7 @@
 from .base.named_selection import GRPCNamedSelectionService
 from .base.parts import GRPCPartsService
 from .base.patterns import GRPCPatternsService
+from .base.points import GRPCPointsService
 from .base.prepare_tools import GRPCPrepareToolsService
 from .base.repair_tools import GRPCRepairToolsService
 from .base.unsupported import GRPCUnsupportedService
@@ -104,6 +105,7 @@ def __init__(self, channel: grpc.Channel, version: GeometryApiProtos | str | Non
         self._named_selection = None
         self._parts = None
         self._patterns = None
+        self._points = None
         self._prepare_tools = None
         self._repair_tools = None
         self._unsupported = None
@@ -602,6 +604,32 @@ def patterns(self) -> GRPCPatternsService:
 
         return self._patterns
 
+    @property
+    def points(self) -> GRPCPointsService:
+        """
+        Get the points service for the specified version.
+
+        Returns
+        -------
+        GRPCPointsService
+            The points service for the specified version.
+        """
+        if not self._points:
+            # Import the appropriate points service based on the version
+            from .v0.points import GRPCPointsServiceV0
+            from .v1.points import GRPCPointsServiceV1
+
+            if self.version == GeometryApiProtos.V0:
+                self._points = GRPCPointsServiceV0(self.channel)
+            elif self.version == GeometryApiProtos.V1:  # pragma: no cover
+                # V1 is not implemented yet
+                self._points = GRPCPointsServiceV1(self.channel)
+            else:  # pragma: no cover
+                # This should never happen as the version is set in the constructor
+                raise ValueError(f"Unsupported version: {self.version}")
+
+        return self._points
+
     @property
     def prepare_tools(self) -> GRPCPrepareToolsService:
         """

src/ansys/geometry/core/_grpc/_services/base/curves.py

@@ -42,3 +42,8 @@ def __init__(self, channel: grpc.Channel):
     def revolve_edges(self, **kwargs) -> dict:
         """Revolve edges around an axis to create a surface of revolution."""
         pass
+
+    @abstractmethod
+    def intersect_curves(self, **kwargs) -> dict:
+        """Get intersection points of curves."""
+        pass

src/ansys/geometry/core/_grpc/_services/base/designs.py

@@ -83,3 +83,13 @@ def insert(self, **kwargs) -> dict:
     def get_active(self, **kwargs) -> dict:
         """Get the active design on the service."""
         pass
+
+    @abstractmethod
+    def upload_file(self, **kwargs) -> dict:
+        """Upload a file to the server."""
+        pass
+
+    @abstractmethod
+    def upload_file_stream(self, **kwargs) -> dict:
+        """Upload a file to the server using streaming."""
+        pass

src/ansys/geometry/core/_grpc/_services/base/faces.py

@@ -153,3 +153,8 @@ def get_round_info(self, **kwargs) -> dict:
     def offset_faces(self, **kwargs) -> dict:
         """Offset a selection of faces."""
         pass
+
+    @abstractmethod
+    def setup_offset_relationship(self, **kwargs) -> dict:
+        """Set up an offset relationship between two faces."""
+        pass

src/ansys/geometry/core/_grpc/_services/base/points.py

@@ -0,0 +1,45 @@
+# Copyright (C) 2023 - 2025 ANSYS, Inc. and/or its affiliates.
+# SPDX-License-Identifier: MIT
+#
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+"""Module containing the points service implementation (abstraction layer)."""
+
+from abc import ABC, abstractmethod
+
+import grpc
+
+
+class GRPCPointsService(ABC):  # pragma: no cover
+    """Points service for gRPC communication with the Geometry server.
+
+    Parameters
+    ----------
+    channel : grpc.Channel
+        The gRPC channel to the server.
+    """
+
+    def __init__(self, channel: grpc.Channel):
+        """Initialize the GRPCPointsService class."""
+        pass
+
+    @abstractmethod
+    def create_design_points(self, **kwargs) -> dict:
+        """Create design points."""
+        pass

src/ansys/geometry/core/_grpc/_services/v0/curves.py

@@ -27,7 +27,11 @@
 
 from ..base.conversions import from_measurement_to_server_angle
 from ..base.curves import GRPCCurvesService
-from .conversions import from_line_to_grpc_line, from_trimmed_curve_to_grpc_trimmed_curve
+from .conversions import (
+    from_grpc_point_to_point3d,
+    from_line_to_grpc_line,
+    from_trimmed_curve_to_grpc_trimmed_curve,
+)
 
 
 class GRPCCurvesServiceV0(GRPCCurvesService):  # pragma: no cover
@@ -66,3 +70,22 @@ def revolve_edges(self, **kwargs) -> dict:  # noqa: D102
 
         # Return the result - formatted as a dictionary
         return {}
+
+    @protect_grpc
+    def intersect_curves(self, **kwargs) -> dict:  # noqa: D102
+        from ansys.api.geometry.v0.commands_pb2 import IntersectCurvesRequest
+
+        # Create the request - assumes all inputs are valid and of the proper type
+        request = IntersectCurvesRequest(
+            first=from_trimmed_curve_to_grpc_trimmed_curve(kwargs["first"]),
+            second=from_trimmed_curve_to_grpc_trimmed_curve(kwargs["second"]),
+        )
+
+        # Call the gRPC service
+        response = self.stub.IntersectCurves(request)
+
+        # Return the result - formatted as a dictionary
+        return {
+            "intersect": response.intersect,
+            "points": [from_grpc_point_to_point3d(point) for point in response.points],
+        }

src/ansys/geometry/core/_grpc/_services/v0/designs.py

@@ -49,8 +49,10 @@ class GRPCDesignsServiceV0(GRPCDesignsService):  # pragma: no cover
     @protect_grpc
     def __init__(self, channel: grpc.Channel):  # noqa: D102
         from ansys.api.dbu.v0.designs_pb2_grpc import DesignsStub
+        from ansys.api.geometry.v0.commands_pb2_grpc import CommandsStub
 
-        self.stub = DesignsStub(channel)
+        self.designs_stub = DesignsStub(channel)
+        self.commands_stub = CommandsStub(channel)
 
     @protect_grpc
     def open(self, **kwargs) -> dict:  # noqa: D102
@@ -63,7 +65,7 @@ def open(self, **kwargs) -> dict:  # noqa: D102
         )
 
         # Call the gRPC service
-        _ = self.stub.Open(request)
+        _ = self.designs_stub.Open(request)
 
         # Return the response - formatted as a dictionary
         return {}
@@ -76,7 +78,7 @@ def new(self, **kwargs) -> dict:  # noqa: D102
         request = NewRequest(name=kwargs["name"])
 
         # Call the gRPC service
-        response = self.stub.New(request)
+        response = self.designs_stub.New(request)
 
         # Return the response - formatted as a dictionary
         return {
@@ -90,7 +92,7 @@ def close(self, **kwargs) -> dict:  # noqa: D102
         request = build_grpc_id(id=kwargs["design_id"])
 
         # Call the gRPC service
-        _ = self.stub.Close(request)
+        _ = self.designs_stub.Close(request)
 
         # Return the response - formatted as a dictionary
         return {}
@@ -101,7 +103,7 @@ def put_active(self, **kwargs) -> dict:  # noqa: D102
         request = build_grpc_id(id=kwargs["design_id"])
 
         # Call the gRPC service
-        _ = self.stub.PutActive(request)
+        _ = self.designs_stub.PutActive(request)
 
         # Return the response - formatted as a dictionary
         return {}
@@ -118,7 +120,7 @@ def save_as(self, **kwargs) -> dict:  # noqa: D102
         )
 
         # Call the gRPC service
-        _ = self.stub.SaveAs(request)
+        _ = self.designs_stub.SaveAs(request)
 
         # Return the response - formatted as a dictionary
         return {}
@@ -136,7 +138,7 @@ def download_export(self, **kwargs) -> dict:  # noqa: D102
         )
 
         # Call the gRPC service
-        response = self.stub.DownloadExportFile(request)
+        response = self.designs_stub.DownloadExportFile(request)
 
         # Return the response - formatted as a dictionary
         data = bytes()
@@ -156,7 +158,7 @@ def stream_download_export(self, **kwargs) -> dict:  # noqa: D102
         )
 
         # Call the gRPC service
-        response = self.stub.StreamDownloadExportFile(request)
+        response = self.designs_stub.StreamDownloadExportFile(request)
 
         # Return the response - formatted as a dictionary
         data = bytes()
@@ -175,7 +177,7 @@ def insert(self, **kwargs) -> dict:  # noqa: D102
         )
 
         # Call the gRPC service
-        _ = self.stub.Insert(request)
+        _ = self.designs_stub.Insert(request)
 
         # Return the response - formatted as a dictionary
         return {}
@@ -185,7 +187,7 @@ def get_active(self, **kwargs) -> dict:  # noqa: D102
         from google.protobuf.empty_pb2 import Empty
 
         # Call the gRPC service
-        response = self.stub.GetActive(request=Empty())
+        response = self.designs_stub.GetActive(request=Empty())
 
         # Return the response - formatted as a dictionary
         if response:
@@ -194,3 +196,63 @@ def get_active(self, **kwargs) -> dict:  # noqa: D102
                 "main_part_id": response.main_part.id,
                 "name": response.name,
             }
+
+    @protect_grpc
+    def upload_file(self, **kwargs) -> dict:  # noqa: D102
+        from ansys.api.geometry.v0.commands_pb2 import UploadFileRequest
+
+        # Create the request - assumes all inputs are valid and of the proper type
+        request = UploadFileRequest(
+            data=kwargs["data"],
+            file_name=kwargs["file_name"],
+            open=kwargs["open_file"],
+            import_options=kwargs["import_options"].to_dict(),
+        )
+
+        # Call the gRPC service
+        response = self.commands_stub.UploadFile(request)
+
+        # Return the response - formatted as a dictionary
+        return {"file_path": response.file_path}
+
+    @protect_grpc
+    def upload_file_stream(self, **kwargs) -> dict:  # noqa: D102
+        from pathlib import Path
+        from typing import TYPE_CHECKING, Generator
+
+        from ansys.api.geometry.v0.commands_pb2 import UploadFileRequest
+
+        import ansys.geometry.core.connection.defaults as pygeom_defaults
+
+        if TYPE_CHECKING:  # pragma: no cover
+            from ansys.geometry.core.misc.options import ImportOptions
+
+        def request_generator(
+            file_path: Path, open_file: bool, import_options: "ImportOptions"
+        ) -> Generator[UploadFileRequest, None, None]:
+            """Generate requests for streaming file upload."""
+            msg_buffer = 5 * 1024  # 5KB - for additional message data
+            if pygeom_defaults.MAX_MESSAGE_LENGTH - msg_buffer < 0:  # pragma: no cover
+                raise ValueError("MAX_MESSAGE_LENGTH is too small for file upload.")
+
+            chunk_size = pygeom_defaults.MAX_MESSAGE_LENGTH - msg_buffer
+            with Path.open(file_path, "rb") as file:
+                while chunk := file.read(chunk_size):
+                    yield UploadFileRequest(
+                        data=chunk,
+                        file_name=file_path.name,
+                        open=open_file,
+                        import_options=import_options.to_dict(),
+                    )
+
+        # Call the gRPC service
+        response = self.commands_stub.StreamFileUpload(
+            request_generator(
+                file_path=kwargs["file_path"],
+                open_file=kwargs["open_file"],
+                import_options=kwargs["import_options"],
+            )
+        )
+
+        # Return the response - formatted as a dictionary
+        return {"file_path": response.file_path}

src/ansys/geometry/core/_grpc/_services/v0/faces.py

@@ -531,3 +531,23 @@ def offset_faces(self, **kwargs) -> dict:  # noqa: D102
                 for response_data in response.response_data
             ]
         }
+
+    @protect_grpc
+    def setup_offset_relationship(self, **kwargs) -> dict:  # noqa: D102
+        from ansys.api.geometry.v0.commands_pb2 import FaceOffsetRequest
+
+        # Create the request - assumes all inputs are valid and of the proper type
+        request = FaceOffsetRequest(
+            face1=build_grpc_id(kwargs["face1_id"]),
+            face2=build_grpc_id(kwargs["face2_id"]),
+            set_baselines=kwargs["set_baselines"],
+            process_adjacent_faces=kwargs["process_adjacent_faces"],
+        )
+
+        # Call the gRPC service
+        response = self.commands_stub.FaceOffset(request=request)
+
+        # Return the response - formatted as a dictionary
+        return {
+            "success": response.success,
+        }

src/ansys/geometry/core/_grpc/_services/v0/parts.py

@@ -60,7 +60,7 @@ def export(self, **kwargs) -> dict:  # noqa: D102
         # Call the gRPC service
         response = self.stub.Export(request)
 
-        # Return the response
+        # Return the response - formatted as a dictionary
         data = bytes()
         data += response.data
         return {