release licenses (#623)

Author: cbellot000

ansys/dpf/core/core.py

@@ -468,6 +468,23 @@ def initialize_with_context(self, context):
                 context.context_type.value, context.xml_path
             )
 
+    @version_requires("6.0")
+    def release_dpf(self):
+        """Clears the available Operators and Releases licenses when necessary.
+
+        Notes
+        -----
+        Available with server's version starting at 6.0 (Ansys 2023R2).
+        """
+        if self._server().has_client():
+            error = self._api.data_processing_release_on_client(
+                self._server().client, 1
+            )
+        else:
+            error = self._api.data_processing_release(
+                1
+            )
+
     def get_runtime_client_config(self):
         if self._server().has_client():
             data_tree_tmp = (

ansys/dpf/core/server_types.py

@@ -445,6 +445,30 @@ def config(self):
     def shutdown(self):
         pass
 
+    def release(self):
+        """Clears the available Operators and Releases licenses when necessary.
+
+        Notes
+        -----
+        Available with server's version starting at 6.0 (Ansys 2023R2).
+        """
+        self._base_service.release_dpf()
+
+    def apply_context(self, context):
+        """Defines the settings that will be used to load DPF's plugins.
+        A DPF xml file can be used to list the plugins and set up variables.
+
+        Parameters
+        ----------
+        context : ServerContext
+            The context allows to choose which capabilities are available server side.
+
+        Notes
+        -----
+        Available with server's version starting at 6.0 (Ansys 2023R2).
+        """
+        self._base_service.apply_context(context)
+
     def check_version(self, required_version, msg=None):
         """Check if the server version matches with a required version.
 

tests/test_service.py

@@ -504,5 +504,17 @@ def test_apply_context_remote(remote_config_server_type, set_context_back_to_pre
     dpf.core.Operator("core::field::high_pass")
 
 
+@pytest.mark.order("last")
+@pytest.mark.skipif(running_docker or not conftest.SERVERS_VERSION_GREATER_THAN_OR_EQUAL_TO_5_0,
+                    reason="AWP ROOT is not set with Docker")
+@conftest.raises_for_servers_version_under("6.0")
+def test_release_dpf(server_type):
+    op = dpf.core.Operator("expansion::modal_superposition", server=server_type)
+    server_type.release()
+
+    with pytest.raises((KeyError, dpf.core.errors.DPFServerException)):
+        dpf.core.Operator("expansion::modal_superposition", server=server_type)
+
+
 if __name__ == "__main__":
     test_load_api_with_awp_root()