chore: cleanup blitz PR (#1855)

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

Author: RobPasMue

doc/changelog.d/1855.maintenance.md

@@ -0,0 +1 @@
+cleanup blitz PR

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

@@ -57,6 +57,27 @@ def is_core_service(backend_type: "BackendType") -> bool:
             BackendType.CORE_LINUX,
         )
 
+    @staticmethod
+    def is_headless_service(backend_type: "BackendType") -> bool:
+        """Determine whether the backend is a headless service or not.
+
+        Parameters
+        ----------
+        backend_type : BackendType
+            The backend type to check whether or not it's a headless service.
+
+        Returns
+        -------
+        bool
+            True if the backend is a headless service, False otherwise.
+        """
+        return backend_type in (
+            BackendType.WINDOWS_SERVICE,
+            BackendType.LINUX_SERVICE,
+            BackendType.CORE_WINDOWS,
+            BackendType.CORE_LINUX,
+        )
+
     @staticmethod
     def is_linux_service(backend_type: "BackendType") -> bool:
         """Determine whether the backend is a Linux service or not.

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

@@ -99,7 +99,6 @@
 from ansys.geometry.core.shapes.curves.trimmed_curve import TrimmedCurve
 from ansys.geometry.core.shapes.parameterization import Interval, ParamUV
 from ansys.geometry.core.shapes.surfaces import TrimmedSurface
-from ansys.geometry.core.sketch.arc import Arc
 from ansys.geometry.core.sketch.sketch import Sketch
 from ansys.geometry.core.typing import Real
 
@@ -1149,21 +1148,15 @@ def create_beams(
         self,
         segments: list[tuple[Point3D, Point3D]],
         profile: BeamProfile,
-        arcs: list[Arc] = None,
-        circles: list[Circle] = None,
     ) -> list[Beam]:
         """Create beams under the component.
 
         Parameters
         ----------
         segments : list[tuple[Point3D, Point3D]]
-            list of start and end pairs, each specifying a single line segment.
+            List of start and end pairs, each specifying a single line segment.
         profile : BeamProfile
             Beam profile to use to create the beams.
-        arcs : list[Curve], default: None
-            list of arcs to create beams from.
-        circles : list[Curve], default: None
-            list of circles to create beams from.
 
         Returns
         -------
@@ -1178,7 +1171,7 @@ def create_beams(
         if self._grpc_client.backend_version < (25, 2, 0):
             return self.__create_beams_legacy(segments, profile)
         else:
-            return self.__create_beams(segments, profile, arcs, circles)
+            return self.__create_beams(segments, profile)
 
     def __create_beams_legacy(
         self, segments: list[tuple[Point3D, Point3D]], profile: BeamProfile
@@ -1192,7 +1185,7 @@ def __create_beams_legacy(
         Parameters
         ----------
         segments : list[tuple[Point3D, Point3D]]
-            list of start and end pairs, each specifying a single line segment.
+            List of start and end pairs, each specifying a single line segment.
         profile : BeamProfile
             Beam profile to use to create the beams.
 
@@ -1229,15 +1222,13 @@ def __create_beams(
         self,
         segments: list[tuple[Point3D, Point3D]],
         profile: BeamProfile,
-        arcs: list[Arc],
-        circles: list[Circle],
     ) -> list[Beam]:
         """Create beams under the component.
 
         Parameters
         ----------
         segments : list[tuple[Point3D, Point3D]]
-            list of start and end pairs, each specifying a single line segment.
+            List of start and end pairs, each specifying a single line segment.
         profile : BeamProfile
             Beam profile to use to create the beams.
 
@@ -1263,50 +1254,52 @@ def __create_beams(
         beams = []
         for beam in response.created_beams:
             cross_section = BeamCrossSectionInfo(
-                SectionAnchorType(beam.cross_section.section_anchor),
-                beam.cross_section.section_angle,
-                grpc_frame_to_frame(beam.cross_section.section_frame),
-                [
+                section_anchor=SectionAnchorType(beam.cross_section.section_anchor),
+                section_angle=beam.cross_section.section_angle,
+                section_frame=grpc_frame_to_frame(beam.cross_section.section_frame),
+                section_profile=[
                     [
                         TrimmedCurve(
-                            grpc_curve_to_curve(curve.geometry),
-                            grpc_point_to_point3d(curve.start),
-                            grpc_point_to_point3d(curve.end),
-                            Interval(curve.interval_start, curve.interval_end),
-                            curve.length,
+                            geometry=grpc_curve_to_curve(curve.geometry),
+                            start=grpc_point_to_point3d(curve.start),
+                            end=grpc_point_to_point3d(curve.end),
+                            interval=Interval(curve.interval_start, curve.interval_end),
+                            length=curve.length,
                         )
                         for curve in curve_list
                     ]
                     for curve_list in beam.cross_section.section_profile
                 ],
             )
             properties = BeamProperties(
-                beam.properties.area,
-                ParamUV(beam.properties.centroid_x, beam.properties.centroid_y),
-                beam.properties.warping_constant,
-                beam.properties.ixx,
-                beam.properties.ixy,
-                beam.properties.iyy,
-                ParamUV(beam.properties.shear_center_x, beam.properties.shear_center_y),
-                beam.properties.torsional_constant,
+                area=beam.properties.area,
+                centroid=ParamUV(beam.properties.centroid_x, beam.properties.centroid_y),
+                warping_constant=beam.properties.warping_constant,
+                ixx=beam.properties.ixx,
+                ixy=beam.properties.ixy,
+                iyy=beam.properties.iyy,
+                shear_center=ParamUV(
+                    beam.properties.shear_center_x, beam.properties.shear_center_y
+                ),
+                torsion_constant=beam.properties.torsional_constant,
             )
 
             beams.append(
                 Beam(
-                    beam.id.id,
-                    grpc_point_to_point3d(beam.shape.start),
-                    grpc_point_to_point3d(beam.shape.end),
-                    profile,
-                    self,
-                    beam.name,
-                    beam.is_deleted,
-                    beam.is_reversed,
-                    beam.is_rigid,
-                    grpc_material_to_material(beam.material),
-                    cross_section,
-                    properties,
-                    beam.shape,
-                    beam.type,
+                    id=beam.id.id,
+                    start=grpc_point_to_point3d(beam.shape.start),
+                    end=grpc_point_to_point3d(beam.shape.end),
+                    profile=profile,
+                    parent_component=self,
+                    name=beam.name,
+                    is_deleted=beam.is_deleted,
+                    is_reversed=beam.is_reversed,
+                    is_rigid=beam.is_rigid,
+                    material=grpc_material_to_material(beam.material),
+                    cross_section=cross_section,
+                    properties=properties,
+                    shape=beam.shape,
+                    beam_type=beam.type,
                 )
             )
 

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

@@ -1159,54 +1159,58 @@ def __read_existing_design(self) -> None:
         # Create Beams
         for beam in response.beams:
             cross_section = BeamCrossSectionInfo(
-                SectionAnchorType(beam.cross_section.section_anchor),
-                beam.cross_section.section_angle,
-                grpc_frame_to_frame(beam.cross_section.section_frame),
-                [
+                section_anchor=SectionAnchorType(beam.cross_section.section_anchor),
+                section_angle=beam.cross_section.section_angle,
+                section_frame=grpc_frame_to_frame(beam.cross_section.section_frame),
+                section_profile=[
                     [
                         TrimmedCurve(
-                            grpc_curve_to_curve(curve.curve),
-                            grpc_point_to_point3d(curve.start),
-                            grpc_point_to_point3d(curve.end),
-                            Interval(curve.interval_start, curve.interval_end),
-                            curve.length,
+                            geometry=grpc_curve_to_curve(curve.curve),
+                            start=grpc_point_to_point3d(curve.start),
+                            end=grpc_point_to_point3d(curve.end),
+                            interval=Interval(curve.interval_start, curve.interval_end),
+                            length=curve.length,
                         )
                         for curve in curve_list.curves
                     ]
                     for curve_list in beam.cross_section.section_profile
                 ],
             )
             properties = BeamProperties(
-                beam.properties.area,
-                ParamUV(beam.properties.centroid_x, beam.properties.centroid_y),
-                beam.properties.warping_constant,
-                beam.properties.ixx,
-                beam.properties.ixy,
-                beam.properties.iyy,
-                ParamUV(beam.properties.shear_center_x, beam.properties.shear_center_y),
-                beam.properties.torsional_constant,
+                area=beam.properties.area,
+                centroid=ParamUV(beam.properties.centroid_x, beam.properties.centroid_y),
+                warping_constant=beam.properties.warping_constant,
+                ixx=beam.properties.ixx,
+                ixy=beam.properties.ixy,
+                iyy=beam.properties.iyy,
+                shear_center=ParamUV(
+                    beam.properties.shear_center_x, beam.properties.shear_center_y
+                ),
+                torsion_constant=beam.properties.torsional_constant,
             )
 
             new_beam = Beam(
-                beam.id.id,
-                grpc_point_to_point3d(beam.shape.start),
-                grpc_point_to_point3d(beam.shape.end),
-                None,
+                id=beam.id.id,
+                start=grpc_point_to_point3d(beam.shape.start),
+                end=grpc_point_to_point3d(beam.shape.end),
+                profile=None,
                 # TODO: Beams need BeamProfiles imported from existing design
                 # https://github.com/ansys/pyansys-geometry/issues/1825
-                self,
-                beam.name,
-                beam.is_deleted,
-                beam.is_reversed,
-                beam.is_rigid,
-                grpc_material_to_material(beam.material),
-                cross_section,
-                properties,
-                beam.shape,
-                beam.type,
+                parent_component=self,
+                name=beam.name,
+                is_deleted=beam.is_deleted,
+                is_reversed=beam.is_reversed,
+                is_rigid=beam.is_rigid,
+                material=grpc_material_to_material(beam.material),
+                cross_section=cross_section,
+                properties=properties,
+                shape=beam.shape,
+                beam_type=beam.type,
             )
 
-            self._beams.append(new_beam)
+            # Find the component to which the beam belongs
+            parent = created_components.get(beam.parent.id, self)
+            parent._beams.append(new_beam)
 
         # Create NamedSelections
         for ns in response.named_selections:

src/ansys/geometry/core/misc/auxiliary.py

@@ -120,32 +120,25 @@ def get_design_from_edge(edge: "Edge") -> "Design":
     return get_design_from_body(body)
 
 
-def __traverse_all_bodies(comp: Union["Design", "Component"]) -> list["Body"]:
-    """Traverse all bodies in a design and all its subcomponents.
+def __traverse_component_elem(elem: str, comp: Union["Design", "Component"]) -> list:
+    """Traverses all elements of a component or design, given its name."""
+    elems = []
+    comp_elems = getattr(comp, elem)
+    elems.extend(comp_elems)
+    for component in comp.components:
+        elems.extend(__traverse_component_elem(elem, component))
 
-    This is a private method. Do not use it directly.
+    return elems
 
-    Parameters
-    ----------
-    design : Design
-        Design object to traverse.
 
-    Returns
-    -------
-    list[Body]
-        List of all bodies in the design or component.
+def __traverse_all_bodies(comp: Union["Design", "Component"]) -> list["Body"]:
+    """Traverse all bodies in a design/component and all its subcomponents."""
+    return __traverse_component_elem("bodies", comp)
 
-    Notes
-    -----
-    This method is a recursive helper function to traverse all bodies in a
-    design and all its subcomponents.
-    """
-    bodies = []
-    bodies.extend(comp.bodies)
-    for component in comp.components:
-        bodies.extend(__traverse_all_bodies(component))
 
-    return bodies
+def __traverse_all_beams(comp: Union["Design", "Component"]) -> list["Body"]:
+    """Traverse all beams in a design/component and all its subcomponents."""
+    return __traverse_component_elem("beams", comp)
 
 
 def get_all_bodies_from_design(design: "Design") -> list["Body"]:
@@ -257,7 +250,7 @@ def get_beams_from_ids(design: "Design", beam_ids: list[str]) -> list["Beam"]:
     -----
     This method takes a design and beam ids, and gets their corresponding ``Beam`` objects.
     """
-    return [beam for beam in design.beams if beam.id in beam_ids]  # noqa: E501
+    return [beam for beam in __traverse_all_beams(design) if beam.id in beam_ids]  # noqa: E501
 
 
 def convert_color_to_hex(

src/ansys/geometry/core/modeler.py

@@ -23,7 +23,7 @@
 
 import logging
 from pathlib import Path
-from typing import TYPE_CHECKING, Optional
+from typing import TYPE_CHECKING, Generator, Optional
 
 from grpc import Channel
 
@@ -356,7 +356,7 @@ def _upload_file_stream(
 
     def _generate_file_chunks(
         self, file_path: Path, open_file: bool, import_options: ImportOptions
-    ):
+    ) -> Generator[UploadFileRequest, None, None]:
         """Generate appropriate chunk sizes for uploading files.
 
         Parameters
@@ -368,10 +368,10 @@ def _generate_file_chunks(
         import_options : ImportOptions
             Import options that toggle certain features when opening a file.
 
-        Returns
-        -------
-        Chunked UploadFileRequest
-
+        Yields
+        ------
+        UploadFileRequest
+            Request object for uploading a file in chunks.
         """
         msg_buffer = 5 * 1024  # 5KB - for additional message data
         if pygeom_defaults.MAX_MESSAGE_LENGTH - msg_buffer < 0:  # pragma: no cover
@@ -549,11 +549,7 @@ def run_discovery_script_file(
 
         # Check if API version is specified... if so, validate it
         if api_version is not None:
-            if self.client.backend_type in (
-                BackendType.WINDOWS_SERVICE,
-                BackendType.CORE_WINDOWS,
-                BackendType.CORE_LINUX,
-            ):
+            if BackendType.is_headless_service(self.client.backend_type):
                 self.client.log.warning(
                     "The Ansys Geometry Service only supports "
                     "scripts that are of its same API version."