.. include:: headings.inc

.. currentmodule:: py.interpreter

.. highlight:: python



.. _py.interpreter.Interpreter:

==========================================================================================================================================
|phoenix_title|  **Interpreter**
==========================================================================================================================================

Interpreter based on code.InteractiveInterpreter.



|

|class_hierarchy| Inheritance Diagram
=====================================

Inheritance diagram for class **Interpreter**

.. raw:: html

   <p class="graphviz">
   <img src="_static/images/inheritance/py.interpreter.Interpreter_inheritance.png" alt="Inheritance diagram of Interpreter" usemap="#dummy" class="inheritance"/>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="py.interpreter.Interpreter.html" title="Interpreter based on code.InteractiveInterpreter." alt="" coords="269,5,448,35"/> <area shape="rect" id="node2" href="http://docs.python.org/library/code.html#code.InteractiveInterpreter" title="code.InteractiveInterpreter" alt="" coords="7,5,220,35"/> </map> 
   </p>

|


|super_classes| Known Superclasses
==================================

`code.InteractiveInterpreter <http://docs.python.org/library/code.html#code.InteractiveInterpreter>`_

|


|method_summary| Methods Summary
================================

================================================================================ ================================================================================
:meth:`~py.interpreter.Interpreter.__init__`                                     Create an interactive interpreter object.
:meth:`~py.interpreter.Interpreter.getAutoCompleteKeys`                          Return list of auto-completion keycodes.
:meth:`~py.interpreter.Interpreter.getAutoCompleteList`                          Return list of auto-completion options for a command.
:meth:`~py.interpreter.Interpreter.getCallTip`                                   Return call tip text for a command.
:meth:`~py.interpreter.Interpreter.push`                                         Send command to the interpreter to be executed.
:meth:`~py.interpreter.Interpreter.runModule`                                    Compile and run an ast module in the interpreter.
:meth:`~py.interpreter.Interpreter.runsource`                                    Compile and run source code in the interpreter.
================================================================================ ================================================================================


|


|api| Class API
===============
   

.. class:: Interpreter(InteractiveInterpreter)

   Interpreter based on code.InteractiveInterpreter.

   .. method:: __init__(self, locals=None, rawin=None, stdin=sys.stdin, stdout=sys.stdout, stderr=sys.stderr, showInterpIntro=True)

      Create an interactive interpreter object.


   .. method:: getAutoCompleteKeys(self)

      Return list of auto-completion keycodes.


   .. method:: getAutoCompleteList(self, command='', \*args, \*\*kwds)

      Return list of auto-completion options for a command.
      
      The list of options will be based on the locals namespace.


   .. method:: getCallTip(self, command='', \*args, \*\*kwds)

      Return call tip text for a command.
      
      Call tip information will be based on the locals namespace.


   .. method:: push(self, command, astMod=None)

      Send command to the interpreter to be executed.
      
      Because this may be called recursively, we append a new list
      onto the commandBuffer list and then append commands into
      that.  If the passed in command is part of a multi-line
      command we keep appending the pieces to the last list in
      commandBuffer until we have a complete command. If not, we
      delete that last list.


   .. method:: runModule(self, mod)

      Compile and run an ast module in the interpreter.


   .. method:: runsource(self, source)

      Compile and run source code in the interpreter.