run_python_file

Optislang.run_python_file(file_path: str | Path, args: Sequence[object] | None = None) → Tuple[str, str]

Read a Python script from a file, load it in a project context, and run it.

Parameters:

file_pathUnion[str, pathlib.Path]

Path to the Python script file with the content to execute on the server.

argsSequence[object], None, optional

Sequence of arguments to use in the Python script. The default is None.

Returns:

Tuple[str, str]

STDOUT and STDERR from the executed Python script.

Raises:

FileNotFoundError

Raised when the specified Python script file does not exist.

OslCommunicationError

Raised when an error occurs while communicating with the server.

OslCommandError

Raised when a command or query fails.

TimeoutError

Raised when the timeout float value expires.

Deprecated since version 0.6.0: This functionality was moved to Project.