chore: clean up deprecation warning for trapezoid class and add more info on deprecation (#1754)

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/1754.maintenance.md

@@ -0,0 +1 @@
+clean up deprecation warning for trapezoid class and add more info on deprecation

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

@@ -266,12 +266,14 @@ def backend_version(self) -> semver.version.Version:
         return self._backend_version
 
     @property
-    @deprecated_method(info="Multiple designs for the same service are no longer supported.")
+    @deprecated_method(
+        info="Multiple designs for the same service are no longer supported.",
+        version="0.9.0",
+        remove="0.11.0",
+    )
     def multiple_designs_allowed(self) -> bool:
         """Flag indicating whether multiple designs are allowed.
 
-        Deprecated since version 0.8.X.
-
         Notes
         -----
         Currently, only one design is allowed per service. This method will always

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

@@ -493,8 +493,12 @@ def launch_modeler_with_spaceclaim_and_pimlight(
     )
 
 
-@deprecated_argument(arg="log_level", alternative="server_log_level")
-@deprecated_argument(arg="logs_folder", alternative="server_logs_folder")
+@deprecated_argument(
+    arg="log_level", alternative="server_log_level", version="0.6.2", remove="0.10.0"
+)
+@deprecated_argument(
+    arg="logs_folder", alternative="server_logs_folder", version="0.6.2", remove="0.10.0"
+)
 def launch_modeler_with_geometry_service(
     product_version: int = None,
     host: str = "localhost",
@@ -627,7 +631,9 @@ def launch_modeler_with_geometry_service(
     )
 
 
-@deprecated_argument(arg="log_level", alternative="server_log_level")
+@deprecated_argument(
+    arg="log_level", alternative="server_log_level", version="0.6.2", remove="0.10.0"
+)
 def launch_modeler_with_discovery(
     product_version: int = None,
     host: str = "localhost",
@@ -754,7 +760,9 @@ def launch_modeler_with_discovery(
     )
 
 
-@deprecated_argument(arg="log_level", alternative="server_log_level")
+@deprecated_argument(
+    arg="log_level", alternative="server_log_level", version="0.6.2", remove="0.10.0"
+)
 def launch_modeler_with_spaceclaim(
     product_version: int = None,
     host: str = "localhost",

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

@@ -381,8 +381,8 @@ def normal(self, u: float = 0.5, v: float = 0.5) -> UnitVector3D:
             response = self._faces_stub.GetNormal(GetNormalRequest(id=self.id, u=u, v=v)).direction
             return UnitVector3D([response.x, response.y, response.z])
 
-    @deprecated_method(alternative="normal")
-    def face_normal(self, u: float = 0.5, v: float = 0.5) -> UnitVector3D:  # [deprecated-method]
+    @deprecated_method(alternative="normal", version="0.6.2", remove="0.10.0")
+    def face_normal(self, u: float = 0.5, v: float = 0.5) -> UnitVector3D:
         """Get the normal direction to the face at certain UV coordinates.
 
         Parameters
@@ -440,7 +440,7 @@ def point(self, u: float = 0.5, v: float = 0.5) -> Point3D:
             response = self._faces_stub.Evaluate(EvaluateRequest(id=self.id, u=u, v=v)).point
             return Point3D([response.x, response.y, response.z], DEFAULT_UNITS.SERVER_LENGTH)
 
-    @deprecated_method(alternative="point")
+    @deprecated_method(alternative="point", version="0.6.2", remove="0.10.0")
     def face_point(self, u: float = 0.5, v: float = 0.5) -> Point3D:
         """Get a point of the face evaluated at certain UV coordinates.
 

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

@@ -343,7 +343,12 @@ def wrapper(self, *args, **kwargs):
     return backend_version_decorator
 
 
-def deprecated_method(alternative: str | None = None, info: str | None = None):
+def deprecated_method(
+    alternative: str | None = None,
+    info: str | None = None,
+    version: str | None = None,
+    remove: str | None = None,
+):
     """Decorate a method as deprecated.
 
     Parameters
@@ -353,6 +358,10 @@ def deprecated_method(alternative: str | None = None, info: str | None = None):
         include the alternative method.
     info : str, default: None
         Additional information to include in the warning message.
+    version : str, default: None
+        Version where the method was deprecated.
+    remove : str, default: None
+        Version where the method will be removed.
     """
 
     def deprecated_decorator(method):
@@ -362,6 +371,10 @@ def wrapper(*args, **kwargs):
                 msg += f" Use '{alternative}' instead."
             if info:
                 msg += f" {info}"
+            if version:
+                msg += f" This method was deprecated in version {version}."
+            if remove:
+                msg += f" This method will be removed in version {remove}."
             warnings.warn(msg, DeprecationWarning)
             return method(*args, **kwargs)
 
@@ -370,7 +383,13 @@ def wrapper(*args, **kwargs):
     return deprecated_decorator
 
 
-def deprecated_argument(arg: str, alternative: str | None = None, info: str | None = None):
+def deprecated_argument(
+    arg: str,
+    alternative: str | None = None,
+    info: str | None = None,
+    version: str | None = None,
+    remove: str | None = None,
+):
     """Decorate a method argument as deprecated.
 
     Parameters
@@ -382,6 +401,10 @@ def deprecated_argument(arg: str, alternative: str | None = None, info: str | No
         include the alternative argument.
     info : str, default: None
         Additional information to include in the warning message.
+    version : str, default: None
+        Version where the method was deprecated.
+    remove : str, default: None
+        Version where the method will be removed.
     """
 
     def deprecated_decorator(method):
@@ -392,6 +415,10 @@ def wrapper(*args, **kwargs):
                     msg += f" Use '{alternative}' instead."
                 if info:
                     msg += f" {info}"
+                if version:
+                    msg += f" This argument was deprecated in version {version}."
+                if remove:
+                    msg += f" This argument will be removed in version {remove}."
                 warnings.warn(msg, DeprecationWarning)
 
             return method(*args, **kwargs)

src/ansys/geometry/core/modeler.py

@@ -140,7 +140,7 @@ def design(self) -> "Design":
         return self._design
 
     @property
-    @deprecated_method(alternative="design")
+    @deprecated_method(alternative="design", version="0.9.0", remove="0.11.0")
     def designs(self) -> dict[str, "Design"]:
         """Retrieve the design within the modeler workspace.
 

src/ansys/geometry/core/sketch/trapezoid.py

@@ -27,7 +27,6 @@
 import pyvista as pv
 from scipy.spatial.transform import Rotation as SpatialRotation
 
-from ansys.geometry.core.logger import LOG
 from ansys.geometry.core.math.constants import ZERO_POINT2D
 from ansys.geometry.core.math.matrix import Matrix33
 from ansys.geometry.core.math.point import Point2D
@@ -80,13 +79,6 @@ def __init__(
         """Initialize the trapezoid."""
         super().__init__()
 
-        # TODO: Remove this warning in the next major release (v0.8.0)
-        # https://github.com/ansys/pyansys-geometry/issues/1359
-        LOG.warning(
-            "The signature of the Trapezoid class has changed starting on "
-            "version 0.7.X. Please refer to the documentation for more information."
-        )
-
         self._center = center
         self._base_width = (
             base_width if isinstance(base_width, Distance) else Distance(base_width, center.unit)

tests/test_misc_checks.py

@@ -286,8 +286,13 @@ def deprecated_method_with_info():
             return True
 
         @staticmethod
-        @deprecated_method(info="This is some extra info.", alternative="new_method")
-        def deprecated_method_with_info_and_alternate():
+        @deprecated_method(
+            info="This is some extra info.",
+            alternative="new_method",
+            version="1.0.0",
+            remove="2.0.0",
+        )
+        def deprecated_method_with_info_and_alternate_and_versions():
             return True
 
     mock_object = MockObject()
@@ -302,10 +307,12 @@ def deprecated_method_with_info_and_alternate():
         mock_object.deprecated_method_with_info()
 
     with pytest.deprecated_call(
-        match="The method 'deprecated_method_with_info_and_alternate' is deprecated."
+        match="The method 'deprecated_method_with_info_and_alternate_and_versions' is deprecated."
         " Use 'new_method' instead. This is some extra info."
+        " This method was deprecated in version 1.0.0."
+        " This method will be removed in version 2.0.0."
     ):
-        mock_object.deprecated_method_with_info_and_alternate()
+        mock_object.deprecated_method_with_info_and_alternate_and_versions()
 
 
 def test_deprecated_argument_decorator():
@@ -326,8 +333,16 @@ def deprecated_argument_with_info(dep_arg: str = None):
             return True
 
         @staticmethod
-        @deprecated_argument("dep_arg", info="This is some extra info.", alternative="alt_arg")
-        def deprecated_argument_with_info_and_alternate(dep_arg: str = None, alt_arg: str = None):
+        @deprecated_argument(
+            "dep_arg",
+            info="This is some extra info.",
+            alternative="alt_arg",
+            version="1.0.0",
+            remove="2.0.0",
+        )
+        def deprecated_argument_with_info_and_alternate_and_versions(
+            dep_arg: str = None, alt_arg: str = None
+        ):
             return True
 
     mock_object = MockObject()
@@ -345,12 +360,14 @@ def deprecated_argument_with_info_and_alternate(dep_arg: str = None, alt_arg: st
         mock_object.deprecated_argument_with_info(dep_arg="test")
 
     with pytest.deprecated_call(
-        match="The argument 'dep_arg' in 'deprecated_argument_with_info_and_alternate'"
+        match="The argument 'dep_arg' in 'deprecated_argument_with_info_and_alternate_and_versions'"
         " is deprecated. Use 'alt_arg' instead. This is some extra info."
+        " This argument was deprecated in version 1.0.0."
+        " This argument will be removed in version 2.0.0."
     ):
-        mock_object.deprecated_argument_with_info_and_alternate(dep_arg="test")
+        mock_object.deprecated_argument_with_info_and_alternate_and_versions(dep_arg="test")
 
     # Check that if we use the alternative argument, no warning is raised
     with warnings.catch_warnings():
         warnings.simplefilter("error")
-        mock_object.deprecated_argument_with_info_and_alternate(alt_arg="test")
+        mock_object.deprecated_argument_with_info_and_alternate_and_versions(alt_arg="test")