8.8.1.1.2. Python API Reference

8.8.1.1.2.1. Functions

initScripting(options={}) DebuggerScripting

Initialize the debugger process for scripting and returns a DebuggerScripting object.

# Initialize scripting with default options
ds = initScripting()

# Initialize scripting with debugger messages suppressed
# and a 10 second timeout
ds = initScripting({ "suppressMessages": True, "timeout": 10000 })
Parameters:

options -- Optional configuration options provided as a dictionary. The available options are:

Option

Type

Description

timeout

int

Initial timeout value in milliseconds. By default, there is no timeout.

ccsRoot

str

Absolute path to the root directory of the CCS installation. Only needed if package is relocated.

suppressMessages

bool

Suppresses printing of debugger status and GEL message to the console. (default: false)

logFile

str

If provided, enables logging to the specified file. Should be an absolute path.

attach

int | Literal["auto"]

If provided, will attach to the active debugger with the provided handle. (Experimental: If "auto" is provided, will try to find the active debugger process.)

Return type:

DebuggerScripting

8.8.1.1.2.2. Objects

8.8.1.1.2.3. Types