Module code :: Class InteractiveInterpreter

[frames | no frames]

## Class InteractiveInterpreter

Known Subclasses:
  `Interpreter`, `PyShellWindow`

Base class for InteractiveConsole.

This class deals with parsing and interpreter state (the user's namespace); it doesn't deal with input buffering or prompting or input file naming (the filename is always passed in explicitly).

Method Summary
| ``__init__`(self, locals)` Constructor.
| ``runcode`(self, code)` Execute a code object.
| ``runsource`(self, source, filename, symbol)` Compile and run some source in the interpreter.
| ``showsyntaxerror`(self, filename)` Display the syntax error that just occurred.
| ``showtraceback`(self)` Display the exception that just occurred.
| ``write`(self, data)` Write a string.

Method Details

### __init__(self, locals=None)
(Constructor)

Constructor.

The optional 'locals' argument specifies the dictionary in which code will be executed; it defaults to a newly created dictionary with key "__name__" set to "__console__" and key "__doc__" set to None.

### runcode(self, code)

Execute a code object.

When an exception occurs, self.showtraceback() is called to display a traceback. All exceptions are caught except SystemExit, which is reraised.

A note about KeyboardInterrupt: this exception may occur elsewhere in this code, and may not always be caught. The caller should be prepared to deal with it.

### runsource(self, source, filename='<input>', symbol='single')

Compile and run some source in the interpreter.

Arguments are as for compile_command().

One several things can happen:

1) The input is incorrect; compile_command() raised an exception (SyntaxError or OverflowError). A syntax traceback will be printed by calling the showsyntaxerror() method.

2) The input is incomplete, and more input is required; compile_command() returned None. Nothing happens.

3) The input is complete; compile_command() returned a code object. The code is executed by calling self.runcode() (which also handles run-time exceptions, except for SystemExit).

The return value is True in case 2, False in the other cases (unless an exception is raised). The return value can be used to decide whether to use sys.ps1 or sys.ps2 to prompt the next line.

### showsyntaxerror(self, filename=None)

Display the syntax error that just occurred.

This doesn't display a stack trace because there isn't one.

If a filename is given, it is stuffed in the exception instead of what was there before (because Python's parser always uses "<string>" when reading from a string).

The output is written by self.write(), below.

### showtraceback(self)

Display the exception that just occurred.

We remove the first stack item because it is our own code.

The output is written by self.write(), below.

### write(self, data)

Write a string.

The base implementation writes to sys.stderr; a subclass may replace this with a different implementation.

Generated by Epydoc 2.1.20050511.rpd on Thu Mar 22 12:12:19 2007 | http://epydoc.sf.net