run_python_script

TcpOslServer.run_python_script(script: str, args: Sequence[object] | None = None, run_async: bool = False) → Tuple[str, str] | str

Load a Python script in a project context and execute it.

Parameters:

scriptstr

Python commands to be executed on the server.

argsSequence[object], None, optional

Sequence of arguments used in Python script. Defaults to None.

run_async: bool, optional

Whether to run the python script as an asynchronous, non-blocking long running operation. If True, this method returns immediately with the ID of the long running operation instead of waiting for the script to complete. Use get_long_running_operation_status() or wait_for_long_running_operation() to poll for or await its completion. By default False.

Note

Argument is supported for Ansys optiSLang version >= 27.1 only.

Returns:

Union[Tuple[str, str], str]

STDOUT and STDERR from executed Python script, or the ID of the long running operation if run_async is True.

Raises:

OslCommunicationError

Raised when an error occurs while communicating with server.

OslCommandError

Raised when the command or query fails.

TimeoutError

Raised when the timeout float value expires.