chore: dbu application to commands script v1 (#2395)

Co-authored-by: PyAnsys CI Bot <[email protected]>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Roberto Pastor Muela <[email protected]>

Author: 4 people

doc/changelog.d/2395.maintenance.md

@@ -0,0 +1 @@
+Dbu application to commands script v1

src/ansys/geometry/core/_grpc/_services/_service.py

@@ -28,10 +28,10 @@
 from .base.beams import GRPCBeamsService
 from .base.bodies import GRPCBodyService
 from .base.commands import GRPCCommandsService
+from .base.commands_script import GRPCCommandsScriptService
 from .base.components import GRPCComponentsService
 from .base.coordinate_systems import GRPCCoordinateSystemService
 from .base.curves import GRPCCurvesService
-from .base.dbuapplication import GRPCDbuApplicationService
 from .base.designs import GRPCDesignsService
 from .base.driving_dimensions import GRPCDrivingDimensionsService
 from .base.edges import GRPCEdgesService
@@ -94,7 +94,7 @@ def __init__(self, channel: grpc.Channel, version: GeometryApiProtos | str | Non
         self._components = None
         self._coordinate_systems = None
         self._curves = None
-        self._dbu_application = None
+        self._commands_script = None
         self._designs = None
         self._driving_dimensions = None
         self._edges = None
@@ -345,30 +345,30 @@ def designs(self) -> GRPCDesignsService:
         return self._designs
 
     @property
-    def dbu_application(self) -> GRPCDbuApplicationService:
+    def commands_script(self) -> GRPCCommandsScriptService:
         """
         Get the DBU application service for the specified version.
 
         Returns
         -------
-        GRPCDbuApplicationService
-            The DBU application service for the specified version.
+        GRPCCommandsScriptService
+            The commands script application service for the specified version.
         """
-        if not self._dbu_application:
+        if not self._commands_script:
             # Import the appropriate DBU application service based on the version
-            from .v0.dbuapplication import GRPCDbuApplicationServiceV0
-            from .v1.dbuapplication import GRPCDbuApplicationServiceV1
+            from .v0.commands_script import GRPCCommandsScriptServiceV0
+            from .v1.commands_script import GRPCCommandsScriptServiceV1
 
             if self.version == GeometryApiProtos.V0:
-                self._dbu_application = GRPCDbuApplicationServiceV0(self.channel)
+                self._commands_script = GRPCCommandsScriptServiceV0(self.channel)
             elif self.version == GeometryApiProtos.V1:  # pragma: no cover
                 # V1 is not implemented yet
-                self._dbu_application = GRPCDbuApplicationServiceV1(self.channel)
+                self._commands_script = GRPCCommandsScriptServiceV1(self.channel)
             else:  # pragma: no cover
                 # This should never happen as the version is set in the constructor
                 raise ValueError(f"Unsupported version: {self.version}")
 
-        return self._dbu_application
+        return self._commands_script
 
     @property
     def driving_dimensions(self) -> GRPCDrivingDimensionsService:

src/ansys/geometry/core/_grpc/_services/base/dbuapplication.py renamed to src/ansys/geometry/core/_grpc/_services/base/commands_script.py

@@ -19,15 +19,15 @@
 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
-"""Module containing the DBU Application service implementation (abstraction layer)."""
+"""Module containing the CommandsScript service implementation (abstraction layer)."""
 
 from abc import ABC, abstractmethod
 
 import grpc
 
 
-class GRPCDbuApplicationService(ABC):  # pragma: no cover
-    """DBU Application service for gRPC communication with the Geometry server.
+class GRPCCommandsScriptService(ABC):  # pragma: no cover
+    """Commands Script service for gRPC communication with the Geometry server.
 
     Parameters
     ----------
@@ -36,10 +36,10 @@ class GRPCDbuApplicationService(ABC):  # pragma: no cover
     """
 
     def __init__(self, channel: grpc.Channel):
-        """Initialize the GRPCDbuApplicationService class."""
+        """Initialize the GRPCCommandsScriptService class."""
         pass
 
     @abstractmethod
-    def run_script(self, **kwargs) -> dict:
-        """Run a Scripting API script."""
+    def run_script_file(self, **kwargs) -> dict:
+        """Run a Scripting API script file."""
         pass

src/ansys/geometry/core/_grpc/_services/v0/dbuapplication.py renamed to src/ansys/geometry/core/_grpc/_services/v0/commands_script.py

@@ -25,10 +25,10 @@
 
 from ansys.geometry.core.errors import protect_grpc
 
-from ..base.dbuapplication import GRPCDbuApplicationService
+from ..base.commands_script import GRPCCommandsScriptService
 
 
-class GRPCDbuApplicationServiceV0(GRPCDbuApplicationService):
+class GRPCCommandsScriptServiceV0(GRPCCommandsScriptService):
     """DBU Application service for gRPC communication with the Geometry server.
 
     This class provides methods to interact with the Geometry server's
@@ -48,7 +48,7 @@ def __init__(self, channel: grpc.Channel):  # noqa: D102
         self.stub = DbuApplicationStub(channel)
 
     @protect_grpc
-    def run_script(self, **kwargs) -> dict:  # noqa: D102
+    def run_script_file(self, **kwargs) -> dict:  # noqa: D102
         from ansys.api.dbu.v0.dbuapplication_pb2 import RunScriptFileRequest
 
         # Create the request - assumes all inputs are valid and of the proper type

src/ansys/geometry/core/_grpc/_services/v1/dbuapplication.py renamed to src/ansys/geometry/core/_grpc/_services/v1/commands_script.py

@@ -19,20 +19,20 @@
 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
-"""Module containing the DBU Application service implementation for v1."""
+"""Module containing the Commands Script service implementation for v1."""
 
 import grpc
 
 from ansys.geometry.core.errors import protect_grpc
 
-from ..base.dbuapplication import GRPCDbuApplicationService
+from ..base.commands_script import GRPCCommandsScriptService
 
 
-class GRPCDbuApplicationServiceV1(GRPCDbuApplicationService):  # pragma: no cover
-    """DBU Application service for gRPC communication with the Geometry server.
+class GRPCCommandsScriptServiceV1(GRPCCommandsScriptService):  # pragma: no cover
+    """Commands Script service for gRPC communication with the Geometry server.
 
     This class provides methods to interact with the Geometry server's
-    DBU Application service. It is specifically designed for the v1 version
+    Commands Script service. It is specifically designed for the v1 version
     of the Geometry API.
 
     Parameters
@@ -43,10 +43,27 @@ class GRPCDbuApplicationServiceV1(GRPCDbuApplicationService):  # pragma: no cove
 
     @protect_grpc
     def __init__(self, channel: grpc.Channel):  # noqa: D102
-        from ansys.api.dbu.v1.dbuapplication_pb2_grpc import DbuApplicationStub
+        from ansys.api.discovery.v1.commands.script_pb2 import ScriptStub
 
-        self.stub = DbuApplicationStub(channel)
+        self.stub = ScriptStub(channel)
 
     @protect_grpc
-    def run_script(self, **kwargs) -> dict:  # noqa: D102
-        raise NotImplementedError
+    def run_script_file(self, **kwargs) -> dict:  # noqa: D102
+        from aansys.api.discovery.v1.commands.script_pb2 import RunScriptFileRequest
+
+        # Create the request - assumes all inputs are valid and of the proper type
+        request = RunScriptFileRequest(
+            script_path=kwargs["script_path"],
+            script_args=kwargs["script_args"],
+            api_version=kwargs["api_version"],
+        )
+
+        # Call the gRPC service
+        response = self.stub.RunScriptFile(request)
+
+        # Return the response - formatted as a dictionary
+        return {
+            "success": response.success,
+            "message": response.message,
+            "values": None if not response.values else dict(response.values),
+        }

src/ansys/geometry/core/modeler.py

@@ -538,7 +538,7 @@ def run_discovery_script_file(
         serv_path = self._upload_file(file_path)
 
         self.client.log.debug(f"Running Discovery script file at {file_path}...")
-        response = self.client.services.dbu_application.run_script(
+        response = self.client.services.commands_script.run_script_file(
             script_path=serv_path,
             script_args=script_args,
             api_version=api_version.value if api_version is not None else None,