feat: grpc measurement tools stub implementation (#1909)

Co-authored-by: Jacob Kerstetter <[email protected]>
Co-authored-by: pyansys-ci-bot <[email protected]>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

Author: 3 people

doc/changelog.d/1909.added.md

@@ -0,0 +1 @@
+grpc measurement tools stub implementation

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

@@ -26,6 +26,7 @@
 from .base.admin import GRPCAdminService
 from .base.bodies import GRPCBodyService
 from .base.dbuapplication import GRPCDbuApplicationService
+from .base.measurement_tools import GRPCMeasurementToolsService
 from .base.named_selection import GRPCNamedSelectionService
 
 
@@ -71,6 +72,7 @@ def __init__(self, channel: grpc.Channel, version: GeometryApiProtos | str | Non
         self._bodies = None
         self._dbu_application = None
         self._named_selection = None
+        self._measurement_tools = None
 
     @property
     def bodies(self) -> GRPCBodyService:
@@ -175,3 +177,29 @@ def named_selection(self) -> GRPCNamedSelectionService:
                 raise ValueError(f"Unsupported version: {self.version}")
 
         return self._named_selection
+
+    @property
+    def measurement_tools(self) -> GRPCMeasurementToolsService:
+        """
+        Get the measurement tools service for the specified version.
+
+        Returns
+        -------
+        MeasurementToolsServiceBase
+            The measurement tools service for the specified version.
+        """
+        if not self._measurement_tools:
+            # Import the appropriate measurement tools service based on the version
+            from .v0.measurement_tools import GRPCMeasurementToolsServiceV0
+            from .v1.measurement_tools import GRPCMeasurementToolsServiceV1
+
+            if self.version == GeometryApiProtos.V0:
+                self._measurement_tools = GRPCMeasurementToolsServiceV0(self.channel)
+            elif self.version == GeometryApiProtos.V1:  # pragma: no cover
+                # V1 is not implemented yet
+                self._measurement_tools = GRPCMeasurementToolsServiceV1(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._measurement_tools

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

@@ -21,7 +21,7 @@
 # SOFTWARE.
 """Module containing server-version agnostic conversions."""
 
-from ansys.geometry.core.misc.measurements import DEFAULT_UNITS, Measurement
+from ansys.geometry.core.misc.measurements import DEFAULT_UNITS, Distance, Measurement
 
 
 def from_measurement_to_server_length(input: Measurement) -> float:
@@ -54,3 +54,24 @@ def from_measurement_to_server_angle(input: Measurement) -> float:
         Angle value in server-defined units. By default, radians.
     """
     return input.value.m_as(DEFAULT_UNITS.SERVER_ANGLE)
+
+
+def to_distance(value: float | int) -> Distance:
+    """Convert a server value to a Distance object.
+
+    Notes
+    -----
+    The value is converted to a Distance object using the default server length unit.
+    The value should represent a length in the server's unit system.
+
+    Parameters
+    ----------
+    value : float | int
+        Value to convert.
+
+    Returns
+    -------
+    Distance
+        Converted distance.
+    """
+    return Distance(value, DEFAULT_UNITS.SERVER_LENGTH)

src/ansys/geometry/core/_grpc/_services/base/measurement_tools.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 measurement tools service implementation (abstraction layer)."""
+
+from abc import ABC, abstractmethod
+
+import grpc
+
+
+class GRPCMeasurementToolsService(ABC):
+    """Measurement tools 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 MeasurementToolsService class."""
+        pass  # pragma: no cover
+
+    @abstractmethod
+    def min_distance_between_objects(self, **kwargs) -> dict:
+        """Calculate the minimum distance between two objects."""
+        pass  # pragma: no cover

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

@@ -0,0 +1,71 @@
+# 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 measurement tools service implementation for v0."""
+
+import grpc
+
+from ansys.geometry.core.errors import protect_grpc
+
+from ..base.measurement_tools import GRPCMeasurementToolsService
+
+
+class GRPCMeasurementToolsServiceV0(GRPCMeasurementToolsService):
+    """Measurement tools service for gRPC communication with the Geometry server.
+
+    This class provides methods to interact with the Geometry server's
+    measurement tools service. It is specifically designed for the v0 version of the
+    Geometry API.
+
+    Parameters
+    ----------
+    channel : grpc.Channel
+        The gRPC channel to the server.
+    """
+
+    @protect_grpc
+    def __init__(self, channel: grpc.Channel):  # noqa: D102
+        from ansys.api.geometry.v0.measuretools_pb2_grpc import MeasureToolsStub
+
+        self.stub = MeasureToolsStub(channel)
+
+    @protect_grpc
+    def min_distance_between_objects(self, **kwargs) -> dict:  # noqa: D102
+        from ansys.api.geometry.v0.measuretools_pb2 import MinDistanceBetweenObjectsRequest
+
+        from ..base.conversions import to_distance
+
+        # Create the request - assumes all inputs are valid and of the proper type
+        # Request is different based on backend_version (25.2 vs. earlier)
+        if kwargs["backend_version"] < (25, 2, 0):
+            request = MinDistanceBetweenObjectsRequest(bodies=kwargs["selection"])
+        else:
+            from ansys.api.dbu.v0.dbumodels_pb2 import EntityIdentifier
+
+            request = MinDistanceBetweenObjectsRequest(
+                selection=[EntityIdentifier(id=item) for item in kwargs["selection"]]
+            )
+
+        # Call the gRPC service
+        response = self.stub.MinDistanceBetweenSelectionObjects(request)
+
+        # Return the response - formatted as a dictionary
+        return {"distance": to_distance(response.gap.distance)}

src/ansys/geometry/core/_grpc/_services/v1/measurement_tools.py

@@ -0,0 +1,52 @@
+# 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 measurement tools service implementation for v0."""
+
+import grpc
+
+from ansys.geometry.core.errors import protect_grpc
+
+from ..base.measurement_tools import GRPCMeasurementToolsService
+
+
+class GRPCMeasurementToolsServiceV1(GRPCMeasurementToolsService):
+    """Measurement tools service for gRPC communication with the Geometry server.
+
+    This class provides methods to interact with the Geometry server's
+    measurement tools service. It is specifically designed for the v0 version of the
+    Geometry API.
+
+    Parameters
+    ----------
+    channel : grpc.Channel
+        The gRPC channel to the server.
+    """
+
+    @protect_grpc
+    def __init__(self, channel: grpc.Channel):  # noqa: D102
+        from ansys.api.geometry.v1.measuretools_pb2_grpc import MeasureToolsStub
+
+        self.stub = MeasureToolsStub(channel)
+
+    @protect_grpc
+    def min_distance_between_objects(self, **kwargs) -> dict:  # noqa: D102
+        raise NotImplementedError

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

@@ -189,8 +189,8 @@ def __init__(
         response = self._services.admin.get_backend()
 
         # Store the backend type and version
-        self._backend_type = response["backend"]
-        self._backend_version = response["version"]
+        self._backend_type = response.get("backend")
+        self._backend_version = response.get("version")
 
         # Register the close method to be called at exit - irrespectively of
         # the user calling it or not...
@@ -357,8 +357,7 @@ def _get_service_logs(
             the current logs are retrieved). The ``dump_to_file`` parameter
             must be set to ``True``.
         """
-        response = self._services.admin.get_logs(all_logs=all_logs)
-        logs: dict[str, str] = response["logs"]
+        logs: dict[str, str] = self._services.admin.get_logs(all_logs=all_logs).get("logs")
 
         # Let's handle the various scenarios...
         if not dump_to_file:

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

@@ -129,7 +129,7 @@ def __init__(
         response = self._grpc_client.services.named_selection.create_named_selection(
             name=name, members=ids
         )
-        self._id = response["id"]
+        self._id = response.get("id")
 
     @property
     def id(self) -> str:
@@ -204,15 +204,15 @@ def __verify_ns(self) -> None:
             return
 
         # Get all entities from the named selection
-        resp = self._grpc_client.services.named_selection.get_named_selection(id=self._id)
+        response = self._grpc_client.services.named_selection.get_named_selection(id=self._id)
 
         # Check if the named selection has changed
         ids = {
-            "bodies": resp["bodies"],
-            "faces": resp["faces"],
-            "edges": resp["edges"],
-            "beams": resp["beams"],
-            "design_points": resp["design_points"],
+            "bodies": response.get("bodies"),
+            "faces": response.get("faces"),
+            "edges": response.get("edges"),
+            "beams": response.get("beams"),
+            "design_points": response.get("design_points"),
         }
 
         for key in ids:

src/ansys/geometry/core/modeler.py

@@ -566,15 +566,15 @@ def run_discovery_script_file(
             api_version=api_version.value if api_version is not None else None,
         )
 
-        if not response["success"]:
-            raise GeometryRuntimeError(response["message"])
+        if not response.get("success"):
+            raise GeometryRuntimeError(response.get("message"))
 
-        self.client.log.debug(f"Script result message: {response['message']}")
+        self.client.log.debug(f"Script result message: {response.get('message')}")
 
         if import_design:
-            return response["values"], self.read_existing_design()
+            return response.get("values"), self.read_existing_design()
         else:
-            return response["values"], None
+            return response.get("values"), None
 
     @property
     def repair_tools(self) -> RepairTools:

src/ansys/geometry/core/tools/measurement_tools.py

@@ -23,15 +23,9 @@
 
 from typing import TYPE_CHECKING, Union
 
-from ansys.api.geometry.v0.measuretools_pb2 import (
-    MinDistanceBetweenObjectsRequest,
-    MinDistanceBetweenObjectsResponse,
-)
-from ansys.api.geometry.v0.measuretools_pb2_grpc import MeasureToolsStub
 from ansys.geometry.core.connection import GrpcClient
-from ansys.geometry.core.errors import protect_grpc
 from ansys.geometry.core.misc.checks import min_backend_version
-from ansys.geometry.core.misc.measurements import DEFAULT_UNITS, Distance
+from ansys.geometry.core.misc.measurements import Distance
 
 if TYPE_CHECKING:  # pragma: no cover
     from ansys.geometry.core.designer.body import Body
@@ -57,23 +51,6 @@ def distance(self) -> Distance:
         """Returns the closest distance between two bodies."""
         return self._distance
 
-    @classmethod
-    def _from_distance_response(cls, response: MinDistanceBetweenObjectsResponse) -> "Gap":
-        """Construct ``Gap`` object from distance response.
-
-        Parameters
-        ----------
-        response : MinDistanceBetweenObjectsResponse
-            Response from the gRPC server.
-
-        Notes
-        -----
-        This method is used internally to construct a ``Gap`` object from a
-        gRPC response.
-        """
-        distance = Distance(response.gap.distance, unit=DEFAULT_UNITS.LENGTH)
-        return cls(distance)
-
 
 class MeasurementTools:
     """Measurement tools for PyAnsys Geometry.
@@ -84,13 +61,10 @@ class MeasurementTools:
         gRPC client to use for the measurement tools.
     """
 
-    @protect_grpc
     def __init__(self, grpc_client: GrpcClient):
         """Initialize measurement tools class."""
         self._grpc_client = grpc_client
-        self._measure_stub = MeasureToolsStub(self._grpc_client.channel)
 
-    @protect_grpc
     @min_backend_version(24, 2, 0)
     def min_distance_between_objects(
         self, object1: Union["Body", "Face", "Edge"], object2: Union["Body", "Face", "Edge"]
@@ -109,12 +83,8 @@ def min_distance_between_objects(
         Gap
             Gap between two bodies.
         """
-        if self._grpc_client.backend_version < (25, 2, 0):
-            response = self._measure_stub.MinDistanceBetweenObjects(
-                MinDistanceBetweenObjectsRequest(bodies=[object1.id, object2.id])
-            )
-        else:
-            response = self._measure_stub.MinDistanceBetweenSelectionObjects(
-                MinDistanceBetweenObjectsRequest(selection=[object1._grpc_id, object2._grpc_id])
-            )
-        return Gap._from_distance_response(response)
+        response = self._grpc_client.services.measurement_tools.min_distance_between_objects(
+            selection=[object1.id, object2.id],
+            backend_version=self._grpc_client.backend_version,
+        )
+        return Gap(response.get("distance"))