Class: QgsCodeInterpreter

An interface for code interpreters.

Added in version 3.30.

class qgis.gui.QgsCodeInterpreter[source]

Bases: object

currentState(self) → int[source]

Returns the current interpreter state.

The actual interpretation of the returned values depend on the interpreter subclass.

Return type:

int

exec(self, command: str | None) → int[source]

Executes a command in the interpreter.

Returns an interpreter specific state value.

Parameters:

command (Optional[str])

Return type:

int

execCommandImpl(self, command: str | None) → int[source]

Pure virtual method for executing commands in the interpreter.

Subclasses must implement this method. It will be called internally whenever the public exec() method is called.

Parameters:

command (Optional[str])

Return type:

int

promptForState(self, state: int) → str[source]

Returns the interactive prompt string to use for the interpreter, given a state.

Parameters:

state (int)

Return type:

str