chore: v1 implementation of repair stubs (#2441)

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

Author: 4 people

doc/changelog.d/1753.maintenance.md

@@ -0,0 +1 @@
+update CHANGELOG for v0.9.0

doc/changelog.d/2441.maintenance.md

@@ -0,0 +1 @@
+Chore: v1 implementation of repair stubs

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

@@ -19,12 +19,7 @@
 # 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 repair tools service implementation for v0.
-
-This module defines an abstract base class for a gRPC-based repair tools service.
-The class provides a set of abstract methods for identifying and repairing various
-geometry issues, such as split edges, extra edges, duplicate faces etc.
-"""
+"""Module containing the repair tools service implementation for v0."""
 
 from google.protobuf.wrappers_pb2 import Int32Value
 import grpc
@@ -393,7 +388,7 @@ def find_and_fix_short_edges(self, **kwargs):  # noqa: D102
             "repaired": response.repaired,
             "created_bodies_monikers": [],
             "modified_bodies_monikers": [],
-            "complete_command_response": serialized_tracker_response,
+            "tracker_response": serialized_tracker_response,
         }
 
     @protect_grpc
@@ -420,7 +415,7 @@ def find_and_fix_extra_edges(self, **kwargs) -> dict:  # noqa: D102
             "repaired": response.repaired,
             "created_bodies_monikers": response.created_bodies_monikers,
             "modified_bodies_monikers": response.modified_bodies_monikers,
-            "complete_command_response": serialized_tracker_response,
+            "tracker_response": serialized_tracker_response,
         }
 
     @protect_grpc
@@ -449,7 +444,7 @@ def find_and_fix_split_edges(self, **kwargs) -> dict:  # noqa: D102
             "repaired": response.repaired,
             "created_bodies_monikers": [],
             "modified_bodies_monikers": [],
-            "complete_command_response": serialized_tracker_response,
+            "tracker_response": serialized_tracker_response,
         }
 
     @protect_grpc
@@ -476,7 +471,7 @@ def find_and_fix_simplify(self, **kwargs) -> dict:  # noqa: D102
             "repaired": response.repaired,
             "created_bodies_monikers": [],
             "modified_bodies_monikers": [],
-            "complete_command_response": serialized_tracker_response,
+            "tracker_response": serialized_tracker_response,
         }
 
     @protect_grpc
@@ -514,15 +509,15 @@ def find_and_fix_stitch_faces(self, **kwargs) -> dict:  # noqa: D102
             "modified_bodies_monikers": response.modified_bodies_monikers,
             "found": response.found,
             "repaired": response.repaired,
-            "complete_command_response": serialized_tracker_response,
+            "tracker_response": serialized_tracker_response,
         }
 
     @protect_grpc
     def inspect_geometry(self, **kwargs) -> dict:  # noqa: D102
         from ansys.api.geometry.v0.repairtools_pb2 import InspectGeometryRequest
 
         # Create the request - assumes all inputs are valid and of the proper type
-        request = InspectGeometryRequest(bodies=kwargs.get("bodies", []))
+        request = InspectGeometryRequest(bodies=kwargs.get("bodies"))
 
         # Call the gRPC service
         inspect_result_response = self.stub.InspectGeometry(request)
@@ -535,7 +530,7 @@ def repair_geometry(self, **kwargs) -> dict:  # noqa: D102
         from ansys.api.geometry.v0.repairtools_pb2 import RepairGeometryRequest
 
         # Create the request - assumes all inputs are valid and of the proper type
-        request = RepairGeometryRequest(bodies=kwargs.get("bodies", []))
+        request = RepairGeometryRequest(bodies=kwargs.get("bodies"))
 
         # Call the gRPC service
         response = self.stub.RepairGeometry(request)
@@ -566,7 +561,9 @@ def fix_duplicate_faces(self, **kwargs) -> dict:  # noqa: D102
         # Return the response - formatted as a dictionary
         return {
             "tracker_response": serialized_tracker_response,
-            "repair_tracker_response": self.__serialize_message_response(response),
+            "success": response.result.success,
+            "created_bodies_monikers": response.result.created_bodies_monikers,
+            "modified_bodies_monikers": response.result.modified_bodies_monikers,
         }
 
     @protect_grpc
@@ -590,7 +587,9 @@ def fix_missing_faces(self, **kwargs) -> dict:  # noqa: D102
         # Return the response - formatted as a dictionary
         return {
             "tracker_response": serialized_tracker_response,
-            "repair_tracker_response": self.__serialize_message_response(response),
+            "success": response.result.success,
+            "created_bodies_monikers": response.result.created_bodies_monikers,
+            "modified_bodies_monikers": response.result.modified_bodies_monikers,
         }
 
     @protect_grpc
@@ -614,7 +613,9 @@ def fix_inexact_edges(self, **kwargs) -> dict:  # noqa: D102
         # Return the response - formatted as a dictionary
         return {
             "tracker_response": serialized_tracker_response,
-            "repair_tracker_response": self.__serialize_message_response(response),
+            "success": response.result.success,
+            "created_bodies_monikers": response.result.created_bodies_monikers,
+            "modified_bodies_monikers": response.result.modified_bodies_monikers,
         }
 
     @protect_grpc
@@ -636,7 +637,9 @@ def fix_extra_edges(self, **kwargs) -> dict:  # noqa: D102
         # Return the response - formatted as a dictionary
         return {
             "tracker_response": serialized_tracker_response,
-            "repair_tracker_response": self.__serialize_message_response(response),
+            "success": response.result.success,
+            "created_bodies_monikers": response.result.created_bodies_monikers,
+            "modified_bodies_monikers": response.result.modified_bodies_monikers,
         }
 
     @protect_grpc
@@ -658,7 +661,9 @@ def fix_short_edges(self, **kwargs) -> dict:  # noqa: D102
         # Return the response - formatted as a dictionary
         return {
             "tracker_response": serialized_tracker_response,
-            "repair_tracker_response": self.__serialize_message_response(response),
+            "success": response.result.success,
+            "created_bodies_monikers": response.result.created_bodies_monikers,
+            "modified_bodies_monikers": response.result.modified_bodies_monikers,
         }
 
     @protect_grpc
@@ -680,7 +685,9 @@ def fix_small_faces(self, **kwargs) -> dict:  # noqa: D102
         # Return the response - formatted as a dictionary
         return {
             "tracker_response": serialized_tracker_response,
-            "repair_tracker_response": self.__serialize_message_response(response),
+            "success": response.result.success,
+            "created_bodies_monikers": response.result.created_bodies_monikers,
+            "modified_bodies_monikers": response.result.modified_bodies_monikers,
         }
 
     @protect_grpc
@@ -702,7 +709,9 @@ def fix_split_edges(self, **kwargs) -> dict:  # noqa: D102
         # Return the response - formatted as a dictionary
         return {
             "tracker_response": serialized_tracker_response,
-            "repair_tracker_response": self.__serialize_message_response(response),
+            "success": response.result.success,
+            "created_bodies_monikers": response.result.created_bodies_monikers,
+            "modified_bodies_monikers": response.result.modified_bodies_monikers,
         }
 
     @protect_grpc
@@ -726,7 +735,9 @@ def fix_stitch_faces(self, **kwargs) -> dict:  # noqa: D102
         # Return the response - formatted as a dictionary
         return {
             "tracker_response": serialized_tracker_response,
-            "repair_tracker_response": self.__serialize_message_response(response),
+            "success": response.result.success,
+            "created_bodies_monikers": response.result.created_bodies_monikers,
+            "modified_bodies_monikers": response.result.modified_bodies_monikers,
         }
 
     @protect_grpc
@@ -750,7 +761,9 @@ def fix_unsimplified_faces(self, **kwargs) -> dict:  # noqa: D102
         # Return the response - formatted as a dictionary
         return {
             "tracker_response": serialized_tracker_response,
-            "repair_tracker_response": self.__serialize_message_response(response),
+            "success": response.result.success,
+            "created_bodies_monikers": response.result.created_bodies_monikers,
+            "modified_bodies_monikers": response.result.modified_bodies_monikers,
         }
 
     @protect_grpc
@@ -774,7 +787,9 @@ def fix_interference(self, **kwargs) -> dict:  # noqa: D102
         # Return the response - formatted as a dictionary
         return {
             "tracker_response": serialized_tracker_response,
-            "repair_tracker_response": self.__serialize_message_response(response),
+            "success": response.result.success,
+            "created_bodies_monikers": response.result.created_bodies_monikers,
+            "modified_bodies_monikers": response.result.modified_bodies_monikers,
         }
 
     def __serialize_inspect_result_response(self, response) -> dict:  # noqa: D102
@@ -830,10 +845,3 @@ def serialize_issue(issue):
                 for body_issues in response.issues_by_body
             ]
         }
-
-    def __serialize_message_response(self, response):
-        return {
-            "success": response.result.success,
-            "created_bodies_monikers": response.result.created_bodies_monikers,
-            "modified_bodies_monikers": response.result.modified_bodies_monikers,
-        }

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

@@ -44,6 +44,7 @@
     CurveGeometry as GRPCCurveGeometry,
     DrivingDimensionEntity as GRPCDrivingDimension,
     EdgeTessellation as GRPCEdgeTessellation,
+    EnhancedRepairToolMessage as GRPCEnhancedRepairToolResponse,
     Geometries as GRPCGeometries,
     Knot as GRPCKnot,
     MaterialEntity as GRPCMaterial,
@@ -1382,6 +1383,38 @@ def from_angle_to_grpc_quantity(input: "Measurement") -> GRPCQuantity:
     return GRPCQuantity(value_in_geometry_units=input.value.m_as(DEFAULT_UNITS.SERVER_ANGLE))
 
 
+def from_area_to_grpc_quantity(input: "Measurement") -> GRPCQuantity:
+    """Convert a ``Measurement`` containing an area to a gRPC quantity.
+
+    Parameters
+    ----------
+    input : Measurement
+        Source measurement data.
+
+    Returns
+    -------
+    GRPCQuantity
+        Converted gRPC quantity.
+    """
+    return GRPCQuantity(value_in_geometry_units=input.value.m_as(DEFAULT_UNITS.SERVER_AREA))
+
+
+def from_volume_to_grpc_quantity(input: "Measurement") -> GRPCQuantity:
+    """Convert a ``Measurement`` containing a volume to a gRPC quantity.
+
+    Parameters
+    ----------
+    input : Measurement
+        Source measurement data.
+
+    Returns
+    -------
+    GRPCQuantity
+        Converted gRPC quantity.
+    """
+    return GRPCQuantity(value_in_geometry_units=input.value.m_as(DEFAULT_UNITS.SERVER_VOLUME))
+
+
 def from_grpc_volume_to_volume(grpc_quantity: GRPCQuantity) -> "pint.Quantity":
     """Convert a gRPC quantity representing volume to a pint Quantity.
 
@@ -1633,3 +1666,93 @@ def get_tracker_response_with_created_bodies(response) -> dict:
         "created_bodies", []
     )
     return serialized_response
+
+
+def serialize_repair_command_response(response: GRPCEnhancedRepairToolResponse) -> dict:
+    """Serialize a EnhancedRepairToolResponse object into a dictionary.
+
+    Parameters
+    ----------
+    response : GRPCEnhancedRepairToolResponse
+        The gRPC EnhancedRepairToolResponse object to serialize.
+        A dictionary representation of the EnhancedRepairToolResponse object.
+    """
+    return {
+        "success": response.tracked_command_response.command_response.success,
+        "found": response.found,
+        "repaired": response.repaired,
+        "complete_command_response": serialize_tracked_command_response(response.tracked_changes),
+        "created_bodies_monikers": [
+            created_body.id for created_body in response.tracked_changes.get("created_bodies", [])
+        ],
+        "modified_bodies_monikers": [
+            modified_body.id
+            for modified_body in response.tracked_changes.get("modified_bodies", [])
+        ],
+        "deleted_bodies_monikers": [
+            deleted_body.id for deleted_body in response.tracked_changes.get("deleted_bodies", [])
+        ],
+    }
+
+
+def response_problem_area_for_body(response) -> dict:
+    """Get a dictionary response from problem areas for a body.
+
+    Parameters
+    ----------
+    response
+        The response to convert.
+
+    Returns
+    -------
+    dict
+        A dictionary representation of the ProblemAreaForBody object.
+    """
+    return {
+        "problems": [
+            {"id": res.problem_area_id, "bodies": [body.id for body in res.body_ids]}
+            for res in response.result
+        ]
+    }
+
+
+def response_problem_area_for_face(response) -> dict:
+    """Get a dictionary response from problem areas for a face.
+
+    Parameters
+    ----------
+    response
+        The response to convert.
+
+    Returns
+    -------
+    dict
+        A dictionary representation of the ProblemAreaForFace object.
+    """
+    return {
+        "problems": [
+            {"id": res.problem_area_id, "faces": [face.id for face in res.face_ids]}
+            for res in response.result
+        ]
+    }
+
+
+def response_problem_area_for_edge(response) -> dict:
+    """Get a dictionary response from problem areas for an edge.
+
+    Parameters
+    ----------
+    response
+        The response to convert.
+
+    Returns
+    -------
+    dict
+        A dictionary representation of the ProblemAreaForEdge object.
+    """
+    return {
+        "problems": [
+            {"id": res.problem_area_id, "edges": [edge.id for edge in res.edge_ids]}
+            for res in response.result
+        ]
+    }