org.python.util

Class InteractiveConsole

Known Direct Subclasses:
JLineConsole, ReadlineConsole

public class InteractiveConsole
extends InteractiveInterpreter

Field Summary

static String
CONSOLE_FILENAME
String
filename

Fields inherited from class org.python.util.InteractiveInterpreter

buffer, filename

Constructor Summary

InteractiveConsole()
InteractiveConsole(PyObject locals)
InteractiveConsole(PyObject locals, String filename)
InteractiveConsole(PyObject locals, String filename, boolean replaceRawInput)

Method Summary

static String
getDefaultBanner()
void
interact()
Closely emulate the interactive Python console.
void
interact(String banner)
boolean
push(String line)
Push a line to the interpreter.
String
raw_input(PyObject prompt)
Write a prompt and read a line.

Methods inherited from class org.python.util.InteractiveInterpreter

interrupt, resetbuffer, runcode, runsource, runsource, runsource, showexception, write

Methods inherited from class org.python.util.PythonInterpreter

cleanup, eval, exec, exec, execfile, execfile, execfile, get, get, getLocals, initialize, set, set, setErr, setErr, setErr, setLocals, setOut, setOut, setOut

Field Details

CONSOLE_FILENAME

public static final String CONSOLE_FILENAME

filename

public String filename

Constructor Details

InteractiveConsole

public InteractiveConsole()

InteractiveConsole

public InteractiveConsole(PyObject locals)

InteractiveConsole

public InteractiveConsole(PyObject locals,
                          String filename)

InteractiveConsole

public InteractiveConsole(PyObject locals,
                          String filename,
                          boolean replaceRawInput)
Parameters:
replaceRawInput - - if true, we hook this Class's raw_input into the builtins table so that clients like cmd.Cmd use it.

Method Details

getDefaultBanner

public static String getDefaultBanner()

interact

public void interact()
Closely emulate the interactive Python console. The optional banner argument specifies the banner to print before the first interaction; by default it prints "Jython on ".

interact

public void interact(String banner)

push

public boolean push(String line)
Push a line to the interpreter. The line should not have a trailing newline; it may have internal newlines. The line is appended to a buffer and the interpreter's runsource() method is called with the concatenated contents of the buffer as source. If this indicates that the command was executed or invalid, the buffer is reset; otherwise, the command is incomplete, and the buffer is left as it was after the line was appended. The return value is 1 if more input is required, 0 if the line was dealt with in some way (this is the same as runsource()).

raw_input

public String raw_input(PyObject prompt)
Write a prompt and read a line. The returned line does not include the trailing newline. When the user enters the EOF key sequence, EOFError is raised. The base implementation uses the built-in function raw_input(); a subclass may replace this with a different implementation.

Jython homepage