feat: grpc reachitecture - several modules (#1988)

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

Author: RobPasMue

.pre-commit-config.yaml

@@ -9,7 +9,7 @@ repos:
 - repo: https://github.com/astral-sh/ruff-pre-commit
   rev: v0.11.10
   hooks:
-    - id: ruff
+    - id: ruff-check
     - id: ruff-format
 
 - repo: https://github.com/codespell-project/codespell

doc/changelog.d/1988.added.md

@@ -0,0 +1 @@
+grpc reachitecture - several modules

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

@@ -26,7 +26,7 @@
 import grpc
 
 
-class GRPCAdminService(ABC):
+class GRPCAdminService(ABC):  # pragma: no cover
     """Admin service for gRPC communication with the Geometry server.
 
     Parameters
@@ -37,19 +37,19 @@ class GRPCAdminService(ABC):
 
     def __init__(self, channel: grpc.Channel):
         """Initialize the GRPCAdminService class."""
-        pass  # pragma: no cover
+        pass
 
     @abstractmethod
     def get_backend(self, **kwargs) -> dict:
         """Get server information."""
-        pass  # pragma: no cover
+        pass
 
     @abstractmethod
     def get_logs(self, **kwargs) -> dict:
         """Get server logs."""
-        pass  # pragma: no cover
+        pass
 
     @abstractmethod
     def get_service_status(self, **kwargs) -> dict:
         """Get server status (i.e. healthy or not)."""
-        pass  # pragma: no cover
+        pass

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

@@ -26,7 +26,7 @@
 import grpc
 
 
-class GRPCBodyService(ABC):
+class GRPCBodyService(ABC):  # pragma: no cover
     """Body service for gRPC communication with the Geometry server.
 
     Parameters
@@ -37,169 +37,169 @@ class GRPCBodyService(ABC):
 
     def __init__(self, channel: grpc.Channel):
         """Initialize the GRPCBodyService class."""
-        pass  # pragma: no cover
+        pass
 
     @abstractmethod
     def create_sphere_body(self, **kwargs) -> dict:
         """Create a sphere body."""
-        pass  # pragma: no cover
+        pass
 
     @abstractmethod
     def create_extruded_body(self, **kwargs) -> dict:
         """Create an extruded body."""
-        pass  # pragma: no cover
+        pass
 
     @abstractmethod
     def create_sweeping_profile_body(self, **kwargs) -> dict:
         """Create a sweeping profile body."""
-        pass  # pragma: no cover
+        pass
 
     @abstractmethod
     def create_sweeping_chain(self, **kwargs) -> dict:
         """Create a sweeping chain."""
-        pass  # pragma: no cover
+        pass
 
     @abstractmethod
     def create_extruded_body_from_face_profile(self, **kwargs) -> dict:
         """Create an extruded body from a face profile."""
-        pass  # pragma: no cover
+        pass
 
     @abstractmethod
     def create_extruded_body_from_loft_profiles(self, **kwargs) -> dict:
         """Create an extruded body from loft profiles."""
-        pass  # pragma: no cover
+        pass
 
     @abstractmethod
     def create_planar_body(self, **kwargs) -> dict:
         """Create a planar body."""
-        pass  # pragma: no cover
+        pass
 
     @abstractmethod
     def create_body_from_face(self, **kwargs) -> dict:
         """Create a body from a face."""
-        pass  # pragma: no cover
+        pass
 
     @abstractmethod
     def create_surface_body(self, **kwargs) -> dict:
         """Create a surface body."""
-        pass  # pragma: no cover
+        pass
 
     @abstractmethod
     def create_surface_body_from_trimmed_curves(self, **kwargs) -> dict:
         """Create a surface body from trimmed curves."""
-        pass  # pragma: no cover
+        pass
 
     @abstractmethod
     def translate(self, **kwargs) -> dict:
         """Translate a body."""
-        pass  # pragma: no cover
+        pass
 
     @abstractmethod
     def delete(self, **kwargs) -> dict:
         """Delete a body."""
-        pass  # pragma: no cover
+        pass
 
     @abstractmethod
     def is_suppressed(self, **kwargs) -> dict:
         """Check if a body is suppressed."""
-        pass  # pragma: no cover
+        pass
 
     @abstractmethod
     def get_color(self, **kwargs) -> dict:
         """Get the color of a body."""
-        pass  # pragma: no cover
+        pass
 
     @abstractmethod
     def get_faces(self, **kwargs) -> dict:
         """Get the faces of a body."""
-        pass  # pragma: no cover
+        pass
 
     @abstractmethod
     def get_edges(self, **kwargs) -> dict:
         """Get the edges of a body."""
-        pass  # pragma: no cover
+        pass
 
     @abstractmethod
     def get_volume(self, **kwargs) -> dict:
         """Get the volume of a body."""
-        pass  # pragma: no cover
+        pass
 
     @abstractmethod
     def get_bounding_box(self, **kwargs) -> dict:
         """Get the bounding box of a body."""
-        pass  # pragma: no cover
+        pass
 
     @abstractmethod
     def set_assigned_material(self, **kwargs) -> dict:
         """Set the assigned material of a body."""
-        pass  # pragma: no cover
+        pass
 
     @abstractmethod
     def get_assigned_material(self, **kwargs) -> dict:
         """Get the assigned material of a body."""
-        pass  # pragma: no cover
+        pass
 
     @abstractmethod
     def set_name(self, **kwargs) -> dict:
         """Set the name of a body."""
-        pass  # pragma: no cover
+        pass
 
     @abstractmethod
     def set_fill_style(self, **kwargs) -> dict:
         """Set the fill style of a body."""
-        pass  # pragma: no cover
+        pass
 
     @abstractmethod
     def set_suppressed(self, **kwargs) -> dict:
         """Set the suppressed state of a body."""
-        pass  # pragma: no cover
+        pass
 
     @abstractmethod
     def set_color(self, **kwargs) -> dict:
         """Set the color of a body."""
-        pass  # pragma: no cover
+        pass
 
     @abstractmethod
     def rotate(self, **kwargs) -> dict:
         """Rotate a body."""
-        pass  # pragma: no cover
+        pass
 
     @abstractmethod
     def scale(self, **kwargs) -> dict:
         """Scale a body."""
-        pass  # pragma: no cover
+        pass
 
     @abstractmethod
     def mirror(self, **kwargs) -> dict:
         """Mirror a body."""
-        pass  # pragma: no cover
+        pass
 
     @abstractmethod
     def map(self, **kwargs) -> dict:
         """Map a body."""
-        pass  # pragma: no cover
+        pass
 
     @abstractmethod
     def get_collision(self, **kwargs) -> dict:
         """Get the collision of a body."""
-        pass  # pragma: no cover
+        pass
 
     @abstractmethod
     def copy(self, **kwargs) -> dict:
         """Copy a body."""
-        pass  # pragma: no cover
+        pass
 
     @abstractmethod
     def get_tesellation(self, **kwargs) -> dict:
         """Get the tessellation of a body."""
-        pass  # pragma: no cover
+        pass
 
     @abstractmethod
     def get_tesellation_with_options(self, **kwargs) -> dict:
         """Get the tessellation of a body with options."""
-        pass  # pragma: no cover
+        pass
 
     @abstractmethod
     def boolean(self, **kwargs) -> dict:
         """Boolean operation."""
-        pass  # pragma: no cover
+        pass

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

@@ -21,6 +21,8 @@
 # SOFTWARE.
 """Module containing server-version agnostic conversions."""
 
+from pint import Quantity
+
 from ansys.geometry.core.misc.measurements import DEFAULT_UNITS, Distance, Measurement
 
 
@@ -75,3 +77,24 @@ def to_distance(value: float | int) -> Distance:
     The value should represent a length in the server's unit system.
     """
     return Distance(value, DEFAULT_UNITS.SERVER_LENGTH)
+
+
+def to_area(value: float | int) -> Quantity:
+    """Convert a server value to an area object.
+
+    Parameters
+    ----------
+    value : float | int
+        Value to convert.
+
+    Returns
+    -------
+    Quantity
+        Converted area.
+
+    Notes
+    -----
+    The value is converted to a Quantity object using the default server area unit.
+    The value should represent an area in the server's unit system.
+    """
+    return Quantity(value, DEFAULT_UNITS.SERVER_AREA)

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

@@ -26,7 +26,7 @@
 import grpc
 
 
-class GRPCCoordinateSystemService(ABC):
+class GRPCCoordinateSystemService(ABC):  # pragma: no cover
     """Coordinate systems service for gRPC communication with the Geometry server.
 
     Parameters
@@ -37,9 +37,9 @@ class GRPCCoordinateSystemService(ABC):
 
     def __init__(self, channel: grpc.Channel):
         """Initialize the GRPCCoordinateSystemService class."""
-        pass  # pragma: no cover
+        pass
 
     @abstractmethod
     def create(self, **kwargs) -> dict:
         """Create a coordinate system."""
-        pass  # pragma: no cover
+        pass

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

@@ -26,7 +26,7 @@
 import grpc
 
 
-class GRPCDbuApplicationService(ABC):
+class GRPCDbuApplicationService(ABC):  # pragma: no cover
     """DBU Application service for gRPC communication with the Geometry server.
 
     Parameters
@@ -37,9 +37,9 @@ class GRPCDbuApplicationService(ABC):
 
     def __init__(self, channel: grpc.Channel):
         """Initialize the GRPCDbuApplicationService class."""
-        pass  # pragma: no cover
+        pass
 
     @abstractmethod
     def run_script(self, **kwargs) -> dict:
         """Run a Scripting API script."""
-        pass  # pragma: no cover
+        pass