chore: prevent invalid kwargs from being passed to launcher methods (#2293)

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

Author: RobPasMue

doc/changelog.d/2293.maintenance.md

@@ -0,0 +1 @@
+Prevent invalid kwargs from being passed to launcher methods

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

@@ -35,7 +35,11 @@
 )
 from ansys.geometry.core.connection.product_instance import prepare_and_start_backend
 from ansys.geometry.core.logger import LOG
-from ansys.geometry.core.misc.checks import check_type, deprecated_argument
+from ansys.geometry.core.misc.checks import (
+    check_type,
+    deprecated_argument,
+    kwargs_passed_not_accepted,
+)
 
 try:
     import ansys.platform.instancemanagement as pypim
@@ -233,6 +237,7 @@ def _launch_with_automatic_detection(**kwargs: dict | None) -> "Modeler":
     raise NotImplementedError("Geometry service cannot be initialized.")
 
 
+@kwargs_passed_not_accepted
 def launch_remote_modeler(
     platform: str = "windows",
     version: str | None = None,
@@ -287,6 +292,7 @@ def launch_remote_modeler(
     )
 
 
+@kwargs_passed_not_accepted
 def launch_docker_modeler(
     port: int = pygeom_defaults.DEFAULT_PORT,
     connect_to_existing_service: bool = True,
@@ -362,6 +368,7 @@ def launch_docker_modeler(
     )
 
 
+@kwargs_passed_not_accepted
 def launch_modeler_with_discovery_and_pimlight(
     version: str | None = None,
     client_log_level: int = logging.INFO,
@@ -404,6 +411,7 @@ def launch_modeler_with_discovery_and_pimlight(
     )
 
 
+@kwargs_passed_not_accepted
 def launch_modeler_with_geometry_service_and_pimlight(
     version: str | None = None,
     client_log_level: int = logging.INFO,
@@ -446,6 +454,7 @@ def launch_modeler_with_geometry_service_and_pimlight(
     )
 
 
+@kwargs_passed_not_accepted
 def launch_modeler_with_spaceclaim_and_pimlight(
     version: str | None = None,
     client_log_level: int = logging.INFO,
@@ -488,6 +497,7 @@ def launch_modeler_with_spaceclaim_and_pimlight(
     )
 
 
+@kwargs_passed_not_accepted
 @deprecated_argument("product_version", "version", version="0.10.8", remove="0.13.0")
 def launch_modeler_with_geometry_service(
     version: str | int | None = None,
@@ -587,13 +597,6 @@ def launch_modeler_with_geometry_service(
         timeout=300,
         server_log_level=0)
     """
-    # if api_version is passed, throw a warning saying that it is not used
-    if "api_version" in kwargs:
-        LOG.warning(
-            "The 'api_version' parameter is not used in 'launch_modeler_with_geometry_service'. "
-            "Please remove it from the arguments."
-        )
-
     # If we are in a Windows environment, we are going to write down the server
     # logs in the %PUBLIC%/Documents/Ansys/GeometryService folder.
     if os.name == "nt" and server_logs_folder is None:
@@ -617,6 +620,7 @@ def launch_modeler_with_geometry_service(
     )
 
 
+@kwargs_passed_not_accepted
 @deprecated_argument("product_version", "version", version="0.10.8", remove="0.13.0")
 def launch_modeler_with_discovery(
     version: str | int | None = None,
@@ -720,13 +724,6 @@ def launch_modeler_with_discovery(
         timeout=300,
         server_log_level=0)
     """
-    for unused_var in ["server_logs_folder", "logs_folder"]:
-        if unused_var in kwargs:
-            LOG.warning(
-                f"The '{unused_var}' parameter is not used in 'launch_modeler_with_discovery'. "
-                "Please remove it from the arguments."
-            )
-
     return prepare_and_start_backend(
         BackendType.DISCOVERY,
         version=version,
@@ -744,6 +741,7 @@ def launch_modeler_with_discovery(
     )
 
 
+@kwargs_passed_not_accepted
 @deprecated_argument("product_version", "version", version="0.10.8", remove="0.13.0")
 def launch_modeler_with_spaceclaim(
     version: str | int | None = None,
@@ -847,13 +845,6 @@ def launch_modeler_with_spaceclaim(
         timeout=300,
         server_log_level=0)
     """
-    for unused_var in ["server_logs_folder", "logs_folder"]:
-        if unused_var in kwargs:
-            LOG.warning(
-                f"The '{unused_var}' parameter is not used in 'launch_modeler_with_spaceclaim'. "
-                "Please remove it from the arguments."
-            )
-
     return prepare_and_start_backend(
         BackendType.SPACECLAIM,
         version=version,
@@ -871,6 +862,7 @@ def launch_modeler_with_spaceclaim(
     )
 
 
+@kwargs_passed_not_accepted
 @deprecated_argument("product_version", "version", version="0.10.8", remove="0.13.0")
 def launch_modeler_with_core_service(
     version: str | int | None = None,
@@ -970,13 +962,6 @@ def launch_modeler_with_core_service(
         timeout=300,
         server_log_level=0)
     """
-    # if api_version is passed, throw a warning saying that it is not used
-    if "api_version" in kwargs:
-        LOG.warning(
-            "The 'api_version' parameter is not used in 'launch_modeler_with_core_service'. "
-            "Please remove it from the arguments."
-        )
-
     # If we are in a Windows environment, we are going to write down the server
     # logs in the %PUBLIC%/Documents/Ansys/GeometryService folder.
     if os.name == "nt" and server_logs_folder is None:

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

@@ -45,6 +45,7 @@
     deprecated_argument,
     deprecated_method,
     graphics_required,
+    kwargs_passed_not_accepted,
     min_backend_version,
     run_if_graphics_required,
 )

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

@@ -478,3 +478,79 @@ def wrapper(*args, **kwargs):
         return method(*args, **kwargs)
 
     return wrapper
+
+
+def kwargs_passed_not_accepted(method):
+    """Check that no unexpected kwargs are passed to the method.
+
+    This decorator will raise a TypeError if any keyword arguments are passed
+    to the decorated method that don't correspond to the method's parameters.
+    If the method has ``**kwargs`` in its signature, this decorator will raise an
+    error for any kwargs passed to it (that are not explicitly accepted).
+
+    Parameters
+    ----------
+    method : callable
+        The method to decorate.
+
+    Returns
+    -------
+    callable
+        Decorated method that raises TypeError if unexpected kwargs are passed.
+
+    Raises
+    ------
+    TypeError
+        If unexpected keyword arguments are passed to the decorated method.
+
+    Examples
+    --------
+    >>> @kwargs_passed_not_accepted
+    ... def my_method(arg1, arg2):
+    ...     return arg1 + arg2
+    >>> my_method(1, 2)  # Works fine
+    3
+    >>> my_method(arg1=1, arg2=2)  # Works fine
+    3
+    >>> my_method(1, 2, invalid_arg=3)  # Raises TypeError
+    TypeError: The following keyword arguments are not accepted
+    in the method 'my_method': invalid_arg.
+    >>> @kwargs_passed_not_accepted
+    ... def my_method_with_kwargs(arg1, arg2, **kwargs):
+    ...     return arg1 + arg2
+    >>> my_method_with_kwargs(1, 2, invalid_arg=3)  # Raises TypeError
+    TypeError: The following keyword arguments are not accepted
+    in the method 'my_method_with_kwargs': invalid_arg.
+    """
+    import inspect
+
+    def wrapper(*args, **kwargs):
+        # Get the method signature
+        sig = inspect.signature(method)
+
+        # Check if method has **kwargs parameter
+        has_var_keyword = any(
+            param.kind == inspect.Parameter.VAR_KEYWORD for param in sig.parameters.values()
+        )
+
+        # If method has **kwargs and kwargs are passed...
+        if has_var_keyword and len(kwargs) > 0:
+            # Retrieve a list of all parameter names excluding **kwargs
+            param_names = {
+                name
+                for name, param in sig.parameters.items()
+                if param.kind != inspect.Parameter.VAR_KEYWORD
+            }
+
+            # Identify unexpected kwargs
+            unexpected_kwargs = [key for key in kwargs.keys() if key not in param_names]
+
+            if unexpected_kwargs:
+                raise TypeError(
+                    "The following keyword arguments are not accepted in the"
+                    + f" method '{method.__name__}': {', '.join(unexpected_kwargs)}."
+                )
+
+        return method(*args, **kwargs)
+
+    return wrapper

tests/test_laucher.py renamed to tests/test_launcher.py

@@ -40,6 +40,7 @@
     check_type_equivalence,
     deprecated_argument,
     deprecated_method,
+    kwargs_passed_not_accepted,
     min_backend_version,
 )
 
@@ -411,3 +412,30 @@ def deprecated_argument_with_info_and_alternate_and_versions(
     with warnings.catch_warnings():
         warnings.simplefilter("error")
         mock_object.deprecated_argument_with_info_and_alternate_and_versions(alt_arg="test")
+
+
+def test_kwargs_passed_not_accepted():
+    """Test the kwargs_passed_not_accepted decorator."""
+
+    @kwargs_passed_not_accepted
+    def my_method(arg1, arg2, **kwargs):
+        """A method that accepts no keyword arguments."""
+        return arg1 + arg2
+
+    # Call the method without kwargs - should not raise an error
+    assert my_method(1, 2) == 3
+    assert my_method(arg1=1, arg2=2) == 3
+
+    # Call the method with kwargs - should raise an error
+    with pytest.raises(
+        TypeError,
+        match="The following keyword arguments are not accepted in the"
+        " method 'my_method': unexpected_arg, another_one.",
+    ):
+        my_method(1, 2, unexpected_arg=3, another_one="test")
+
+    with pytest.raises(
+        TypeError,
+        match="The following keyword arguments are not accepted in the method 'my_method': arg3.",
+    ):
+        my_method(arg1=1, arg2=2, arg3=3)