maint: Deprecated new APIs and removed previous deprecated APIs (#664)

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

Author: ansnfernand

doc/changelog.d/664.miscellaneous.md

@@ -0,0 +1 @@
+Maint: Deprecated new APIs and removed previous deprecated APIs

doc/source/api/parts_types.rst

@@ -18,7 +18,5 @@ Constants
 
 Classes
 -------
-.. autoclass:: PartLocation
-     :members:
 .. autoclass:: GetPartsListPropertiesRequest
      :members:

src/ansys/sherlock/core/errors.py

@@ -533,18 +533,6 @@ def __str__(self):
         return f"Enable lead modeling error: {self.message}"
 
 
-class SherlockGetPartLocationError(Exception):
-    """Contains the error raised when getting part location results in an error."""
-
-    def __init__(self, message: str):
-        """Initialize error message."""
-        self.message = message
-
-    def __str__(self):
-        """Format error message."""
-        return f"Get part location error: {self.message}"
-
-
 class SherlockLoadThermalProfileError(Exception):
     """Contains the error raised when loading thermal profile."""
 

src/ansys/sherlock/core/lifecycle.py

@@ -105,7 +105,8 @@ def _init_harmonic_profile_types(self):
     def _init_ampl_units(self):
         """Initialize the list for amplitude units.
 
-        Available Since: 2021R1
+        .. deprecated:: 2026 R1
+
         """
         if self._is_connection_up():
             ampl_unit_request = SherlockLifeCycleService_pb2.ListAmplUnitsRequest()
@@ -127,7 +128,8 @@ def _init_cycle_states(self):
     def _init_load_units(self):
         """Initialize the list for load units.
 
-        Available Since: 2021R1
+        .. deprecated:: 2026 R1
+
         """
         if self._is_connection_up():
             load_unit_request = SherlockLifeCycleService_pb2.ListShockLoadUnitsRequest()

src/ansys/sherlock/core/parts.py

@@ -15,7 +15,6 @@
     SherlockEnableLeadModelingError,
     SherlockExportNetListError,
     SherlockExportPartsListError,
-    SherlockGetPartLocationError,
     SherlockImportPartsListError,
     SherlockNoGrpcConnectionException,
     SherlockUpdatePartsFromAVLError,
@@ -32,7 +31,6 @@
     DeletePartsFromPartsListRequest,
     GetPartsListPropertiesRequest,
     ImportPartsToAVLRequest,
-    PartLocation,
     PartsListSearchDuplicationMode,
     UpdatePadPropertiesRequest,
 )
@@ -654,83 +652,6 @@ def enable_lead_modeling(self, project: str, cca_name: str):
             LOG.error(str(e))
             raise e
 
-    @require_version()
-    def get_part_location(
-        self, project: str, cca_name: str, ref_des: str, location_units: str
-    ) -> list[PartLocation]:
-        """Return the location properties for one or more part.
-
-        Available Since: 2022R1
-
-        Parameters
-        ----------
-        project: str
-            Name of the Sherlock project.
-        cca_name: str
-            Name of the CCA.
-        ref_des: str
-            Comma separated list of reference designators of parts to retrieve locations for.
-        location_units: str
-            Valid units for a part's location.
-
-        Returns
-        -------
-        list[PartLocation]
-            PartLocation for each part that corresponds to the reference designators.
-
-        Examples
-        --------
-        >>> from ansys.sherlock.core.launcher import launch_sherlock
-        >>> sherlock = launch_sherlock()
-        >>> sherlock.project.import_odb_archive(
-            "ODB++ Tutorial.tgz",
-            True,
-            True,
-            True,
-            True,
-            project="Test",
-            cca_name="Card",
-        )
-        >>> part_locations = sherlock.parts.get_part_location(
-            project="Test",
-            cca_name="Card",
-            ref_des="C1,C2",
-            location_units="in",
-        )
-        >>> print(f"{part_locations}")
-        """
-        try:
-            if project == "":
-                raise SherlockGetPartLocationError(message="Project name is invalid.")
-            if cca_name == "":
-                raise SherlockGetPartLocationError(message="CCA name is invalid.")
-            if ref_des == "":
-                raise SherlockGetPartLocationError(message="Ref Des is invalid.")
-            if location_units == "":
-                raise SherlockGetPartLocationError(message="Location unit is invalid.")
-            if not self._is_connection_up():
-                raise SherlockNoGrpcConnectionException()
-
-            request = SherlockPartsService_pb2.GetPartLocationRequest(
-                project=project,
-                ccaName=cca_name,
-                refDes=ref_des,
-                locationUnits=location_units,
-            )
-            response = self.stub.getPartLocation(request)
-            return_code = response.returnCode
-
-            if return_code.value == -1:
-                raise SherlockGetPartLocationError(return_code.message)
-
-            locations = []
-            for location in response.locationData:
-                locations.append(PartLocation(location))
-            return locations
-        except SherlockGetPartLocationError as e:
-            LOG.error(str(e))
-            raise e
-
     @require_version(252)
     def get_parts_list_properties(
         self, request: GetPartsListPropertiesRequest

src/ansys/sherlock/core/stackup.py

@@ -50,7 +50,8 @@ def __init__(self, channel: Channel, server_version: int):
     def _init_laminate_thickness_units(self):
         """Initialize the list of units for the laminate thickness.
 
-        Available Since: 2021R1
+        .. deprecated:: 2026 R1
+
         """
         if self._is_connection_up():
             laminate_thickness_unit_request = (

src/ansys/sherlock/core/types/parts_types.py

@@ -71,27 +71,6 @@ class AVLDescription:
     """DoNotChangeDescription"""
 
 
-class PartLocation:
-    """Part Location property values."""
-
-    def __init__(self, location):
-        """Initialize members from the location."""
-        self.x = location.x
-        """X coordinate"""
-        self.y = location.y
-        """Y coordinate"""
-        self.rotation = location.rotation
-        """Rotation (in degrees)"""
-        self.location_units = location.locationUnits
-        """Units for location coordinates"""
-        self.board_side = location.boardSide
-        """Board side - ``"TOP"`` or ``"BOTTOM"`` """
-        self.mirrored = location.mirrored
-        """Mirrored - ``True`` or ``False`` """
-        self.ref_des = location.refDes
-        """Reference designator"""
-
-
 class GetPartsListPropertiesRequest(BaseModel):
     """Request for getting properties of parts in the parts list of a CCA."""
 

tests/test_parts.py

@@ -12,7 +12,6 @@
     SherlockEnableLeadModelingError,
     SherlockExportNetListError,
     SherlockExportPartsListError,
-    SherlockGetPartLocationError,
     SherlockImportPartsListError,
     SherlockNoGrpcConnectionException,
     SherlockUpdatePartsFromAVLError,
@@ -52,7 +51,6 @@ def test_all():
     helper_test_export_parts_list(parts)
     helper_test_export_net_list(parts)
     helper_test_enable_lead_modeling(parts)
-    helper_test_get_part_location(parts)
     helper_test_get_parts_list_properties(parts)
     helper_test_update_pad_properties(parts)
     helper_test_import_parts_to_avl(parts)
@@ -602,96 +600,6 @@ def helper_test_enable_lead_modeling(parts: Parts):
         assert str(e) == "Enable lead modeling error: CCA name is invalid."
 
 
-def helper_test_get_part_location(parts: Parts):
-    """Test get_part_location API"""
-
-    if parts._is_connection_up():
-        try:
-            parts.get_part_location(
-                "Tutorial Project",
-                "Invalid CCA",
-                "C1",
-                "in",
-            )
-            pytest.fail("No exception raised when using an invalid parameter")
-        except Exception as e:
-            assert type(e) == SherlockGetPartLocationError
-
-        try:
-            locations = parts.get_part_location(
-                "Tutorial Project",
-                "Main Board",
-                "C1, C3",
-                "in",
-            )
-
-            assert len(locations) == 2, "Incorrect number of locations"
-            location_c1 = locations[0]
-            assert location_c1.ref_des == "C1", "Incorrect refDes"
-            assert location_c1.x == -2.7, "Incorrect X coordinate for C1"
-            assert location_c1.y == -1.65, "Incorrect Y coordinate for C1"
-            assert location_c1.rotation == 0, "Incorrect rotation for C1"
-            assert location_c1.location_units == "in", "Incorrect location units for C1"
-            assert location_c1.board_side == "TOP", "Incorrect board side for C1"
-            assert location_c1.mirrored is False, "Incorrect mirrored for C1"
-
-            location_c3 = locations[1]
-            assert location_c3.ref_des == "C3", "Incorrect refDes"
-            assert location_c3.x == -2.4, "Incorrect X coordinate for C3"
-            assert location_c3.y == -1.9, "Incorrect Y coordinate for C3"
-            assert location_c3.rotation == 180, "Incorrect rotation for C3"
-            assert location_c3.location_units == "in", "Incorrect location units for C3"
-            assert location_c3.board_side == "TOP", "Incorrect board side for C3"
-            assert location_c3.mirrored is False, "Incorrect mirrored for C3"
-
-        except SherlockGetPartLocationError as e:
-            pytest.fail(e.message)
-
-    try:
-        parts.get_part_location(
-            "",
-            "Card",
-            "C1",
-            "in",
-        )
-        pytest.fail("No exception raised when using an invalid parameter")
-    except SherlockGetPartLocationError as e:
-        assert str(e) == "Get part location error: Project name is invalid."
-
-    try:
-        parts.get_part_location(
-            "Test",
-            "",
-            "C1",
-            "in",
-        )
-        pytest.fail("No exception raised when using an invalid parameter")
-    except SherlockGetPartLocationError as e:
-        assert str(e) == "Get part location error: CCA name is invalid."
-
-    try:
-        parts.get_part_location(
-            "Test",
-            "Card",
-            "",
-            "in",
-        )
-        pytest.fail("No exception raised when using an invalid parameter")
-    except SherlockGetPartLocationError as e:
-        assert str(e) == "Get part location error: Ref Des is invalid."
-
-    try:
-        parts.get_part_location(
-            "Test",
-            "Card",
-            "C1",
-            "",
-        )
-        pytest.fail("No exception raised when using an invalid parameter")
-    except SherlockGetPartLocationError as e:
-        assert str(e) == "Get part location error: Location unit is invalid."
-
-
 def helper_test_get_parts_list_properties(parts: Parts):
     """Test get_parts_list_properties API"""
     try: