Edit File: code.html
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <title>28.1. code — Interpreter base classes — Python 2.7.5 documentation</title> <link rel="stylesheet" href="../_static/default.css" type="text/css" /> <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> <script type="text/javascript"> var DOCUMENTATION_OPTIONS = { URL_ROOT: '../', VERSION: '2.7.5', COLLAPSE_INDEX: false, FILE_SUFFIX: '.html', HAS_SOURCE: true }; </script> <script type="text/javascript" src="../_static/jquery.js"></script> <script type="text/javascript" src="../_static/underscore.js"></script> <script type="text/javascript" src="../_static/doctools.js"></script> <script type="text/javascript" src="../_static/sidebar.js"></script> <link rel="search" type="application/opensearchdescription+xml" title="Search within Python 2.7.5 documentation" href="../_static/opensearch.xml"/> <link rel="author" title="About these documents" href="../about.html" /> <link rel="copyright" title="Copyright" href="../copyright.html" /> <link rel="top" title="Python 2.7.5 documentation" href="../index.html" /> <link rel="up" title="28. Custom Python Interpreters" href="custominterp.html" /> <link rel="next" title="28.2. codeop — Compile Python code" href="codeop.html" /> <link rel="prev" title="28. Custom Python Interpreters" href="custominterp.html" /> <link rel="shortcut icon" type="image/png" href="../_static/py.png" /> <script type="text/javascript" src="../_static/copybutton.js"></script> </head> <body> <div class="related"> <h3>Navigation</h3> <ul> <li class="right" style="margin-right: 10px"> <a href="../genindex.html" title="General Index" accesskey="I">index</a></li> <li class="right" > <a href="../py-modindex.html" title="Python Module Index" >modules</a> |</li> <li class="right" > <a href="codeop.html" title="28.2. codeop — Compile Python code" accesskey="N">next</a> |</li> <li class="right" > <a href="custominterp.html" title="28. Custom Python Interpreters" accesskey="P">previous</a> |</li> <li><img src="../_static/py.png" alt="" style="vertical-align: middle; margin-top: -1px"/></li> <li><a href="http://www.python.org/">Python</a> »</li> <li> <a href="../index.html">Python 2.7.5 documentation</a> » </li> <li><a href="index.html" >The Python Standard Library</a> »</li> <li><a href="custominterp.html" accesskey="U">28. Custom Python Interpreters</a> »</li> </ul> </div> <div class="document"> <div class="documentwrapper"> <div class="bodywrapper"> <div class="body"> <div class="section" id="module-code"> <span id="code-interpreter-base-classes"></span><h1>28.1. <a class="reference internal" href="#module-code" title="code: Facilities to implement read-eval-print loops."><tt class="xref py py-mod docutils literal"><span class="pre">code</span></tt></a> — Interpreter base classes<a class="headerlink" href="#module-code" title="Permalink to this headline">¶</a></h1> <p>The <tt class="docutils literal"><span class="pre">code</span></tt> module provides facilities to implement read-eval-print loops in Python. Two classes and convenience functions are included which can be used to build applications which provide an interactive interpreter prompt.</p> <dl class="class"> <dt id="code.InteractiveInterpreter"> <em class="property">class </em><tt class="descclassname">code.</tt><tt class="descname">InteractiveInterpreter</tt><big>(</big><span class="optional">[</span><em>locals</em><span class="optional">]</span><big>)</big><a class="headerlink" href="#code.InteractiveInterpreter" title="Permalink to this definition">¶</a></dt> <dd><p>This class deals with parsing and interpreter state (the user’s namespace); it does not deal with input buffering or prompting or input file naming (the filename is always passed in explicitly). The optional <em>locals</em> argument specifies the dictionary in which code will be executed; it defaults to a newly created dictionary with key <tt class="docutils literal"><span class="pre">'__name__'</span></tt> set to <tt class="docutils literal"><span class="pre">'__console__'</span></tt> and key <tt class="docutils literal"><span class="pre">'__doc__'</span></tt> set to <tt class="docutils literal"><span class="pre">None</span></tt>.</p> </dd></dl> <dl class="class"> <dt id="code.InteractiveConsole"> <em class="property">class </em><tt class="descclassname">code.</tt><tt class="descname">InteractiveConsole</tt><big>(</big><span class="optional">[</span><em>locals</em><span class="optional">[</span>, <em>filename</em><span class="optional">]</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#code.InteractiveConsole" title="Permalink to this definition">¶</a></dt> <dd><p>Closely emulate the behavior of the interactive Python interpreter. This class builds on <a class="reference internal" href="#code.InteractiveInterpreter" title="code.InteractiveInterpreter"><tt class="xref py py-class docutils literal"><span class="pre">InteractiveInterpreter</span></tt></a> and adds prompting using the familiar <tt class="docutils literal"><span class="pre">sys.ps1</span></tt> and <tt class="docutils literal"><span class="pre">sys.ps2</span></tt>, and input buffering.</p> </dd></dl> <dl class="function"> <dt id="code.interact"> <tt class="descclassname">code.</tt><tt class="descname">interact</tt><big>(</big><span class="optional">[</span><em>banner</em><span class="optional">[</span>, <em>readfunc</em><span class="optional">[</span>, <em>local</em><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#code.interact" title="Permalink to this definition">¶</a></dt> <dd><p>Convenience function to run a read-eval-print loop. This creates a new instance of <a class="reference internal" href="#code.InteractiveConsole" title="code.InteractiveConsole"><tt class="xref py py-class docutils literal"><span class="pre">InteractiveConsole</span></tt></a> and sets <em>readfunc</em> to be used as the <a class="reference internal" href="functions.html#raw_input" title="raw_input"><tt class="xref py py-meth docutils literal"><span class="pre">raw_input()</span></tt></a> method, if provided. If <em>local</em> is provided, it is passed to the <a class="reference internal" href="#code.InteractiveConsole" title="code.InteractiveConsole"><tt class="xref py py-class docutils literal"><span class="pre">InteractiveConsole</span></tt></a> constructor for use as the default namespace for the interpreter loop. The <a class="reference internal" href="#code.interact" title="code.interact"><tt class="xref py py-meth docutils literal"><span class="pre">interact()</span></tt></a> method of the instance is then run with <em>banner</em> passed as the banner to use, if provided. The console object is discarded after use.</p> </dd></dl> <dl class="function"> <dt id="code.compile_command"> <tt class="descclassname">code.</tt><tt class="descname">compile_command</tt><big>(</big><em>source</em><span class="optional">[</span>, <em>filename</em><span class="optional">[</span>, <em>symbol</em><span class="optional">]</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#code.compile_command" title="Permalink to this definition">¶</a></dt> <dd><p>This function is useful for programs that want to emulate Python’s interpreter main loop (a.k.a. the read-eval-print loop). The tricky part is to determine when the user has entered an incomplete command that can be completed by entering more text (as opposed to a complete command or a syntax error). This function <em>almost</em> always makes the same decision as the real interpreter main loop.</p> <p><em>source</em> is the source string; <em>filename</em> is the optional filename from which source was read, defaulting to <tt class="docutils literal"><span class="pre">'<input>'</span></tt>; and <em>symbol</em> is the optional grammar start symbol, which should be either <tt class="docutils literal"><span class="pre">'single'</span></tt> (the default) or <tt class="docutils literal"><span class="pre">'eval'</span></tt>.</p> <p>Returns a code object (the same as <tt class="docutils literal"><span class="pre">compile(source,</span> <span class="pre">filename,</span> <span class="pre">symbol)</span></tt>) if the command is complete and valid; <tt class="docutils literal"><span class="pre">None</span></tt> if the command is incomplete; raises <a class="reference internal" href="exceptions.html#exceptions.SyntaxError" title="exceptions.SyntaxError"><tt class="xref py py-exc docutils literal"><span class="pre">SyntaxError</span></tt></a> if the command is complete and contains a syntax error, or raises <a class="reference internal" href="exceptions.html#exceptions.OverflowError" title="exceptions.OverflowError"><tt class="xref py py-exc docutils literal"><span class="pre">OverflowError</span></tt></a> or <a class="reference internal" href="exceptions.html#exceptions.ValueError" title="exceptions.ValueError"><tt class="xref py py-exc docutils literal"><span class="pre">ValueError</span></tt></a> if the command contains an invalid literal.</p> </dd></dl> <div class="section" id="interactive-interpreter-objects"> <span id="interpreter-objects"></span><h2>28.1.1. Interactive Interpreter Objects<a class="headerlink" href="#interactive-interpreter-objects" title="Permalink to this headline">¶</a></h2> <dl class="method"> <dt id="code.InteractiveInterpreter.runsource"> <tt class="descclassname">InteractiveInterpreter.</tt><tt class="descname">runsource</tt><big>(</big><em>source</em><span class="optional">[</span>, <em>filename</em><span class="optional">[</span>, <em>symbol</em><span class="optional">]</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#code.InteractiveInterpreter.runsource" title="Permalink to this definition">¶</a></dt> <dd><p>Compile and run some source in the interpreter. Arguments are the same as for <a class="reference internal" href="#code.compile_command" title="code.compile_command"><tt class="xref py py-func docutils literal"><span class="pre">compile_command()</span></tt></a>; the default for <em>filename</em> is <tt class="docutils literal"><span class="pre">'<input>'</span></tt>, and for <em>symbol</em> is <tt class="docutils literal"><span class="pre">'single'</span></tt>. One several things can happen:</p> <ul class="simple"> <li>The input is incorrect; <a class="reference internal" href="#code.compile_command" title="code.compile_command"><tt class="xref py py-func docutils literal"><span class="pre">compile_command()</span></tt></a> raised an exception (<a class="reference internal" href="exceptions.html#exceptions.SyntaxError" title="exceptions.SyntaxError"><tt class="xref py py-exc docutils literal"><span class="pre">SyntaxError</span></tt></a> or <a class="reference internal" href="exceptions.html#exceptions.OverflowError" title="exceptions.OverflowError"><tt class="xref py py-exc docutils literal"><span class="pre">OverflowError</span></tt></a>). A syntax traceback will be printed by calling the <a class="reference internal" href="#code.InteractiveInterpreter.showsyntaxerror" title="code.InteractiveInterpreter.showsyntaxerror"><tt class="xref py py-meth docutils literal"><span class="pre">showsyntaxerror()</span></tt></a> method. <a class="reference internal" href="#code.InteractiveInterpreter.runsource" title="code.InteractiveInterpreter.runsource"><tt class="xref py py-meth docutils literal"><span class="pre">runsource()</span></tt></a> returns <tt class="docutils literal"><span class="pre">False</span></tt>.</li> <li>The input is incomplete, and more input is required; <a class="reference internal" href="#code.compile_command" title="code.compile_command"><tt class="xref py py-func docutils literal"><span class="pre">compile_command()</span></tt></a> returned <tt class="docutils literal"><span class="pre">None</span></tt>. <a class="reference internal" href="#code.InteractiveInterpreter.runsource" title="code.InteractiveInterpreter.runsource"><tt class="xref py py-meth docutils literal"><span class="pre">runsource()</span></tt></a> returns <tt class="docutils literal"><span class="pre">True</span></tt>.</li> <li>The input is complete; <a class="reference internal" href="#code.compile_command" title="code.compile_command"><tt class="xref py py-func docutils literal"><span class="pre">compile_command()</span></tt></a> returned a code object. The code is executed by calling the <a class="reference internal" href="#code.InteractiveInterpreter.runcode" title="code.InteractiveInterpreter.runcode"><tt class="xref py py-meth docutils literal"><span class="pre">runcode()</span></tt></a> (which also handles run-time exceptions, except for <a class="reference internal" href="exceptions.html#exceptions.SystemExit" title="exceptions.SystemExit"><tt class="xref py py-exc docutils literal"><span class="pre">SystemExit</span></tt></a>). <a class="reference internal" href="#code.InteractiveInterpreter.runsource" title="code.InteractiveInterpreter.runsource"><tt class="xref py py-meth docutils literal"><span class="pre">runsource()</span></tt></a> returns <tt class="docutils literal"><span class="pre">False</span></tt>.</li> </ul> <p>The return value can be used to decide whether to use <tt class="docutils literal"><span class="pre">sys.ps1</span></tt> or <tt class="docutils literal"><span class="pre">sys.ps2</span></tt> to prompt the next line.</p> </dd></dl> <dl class="method"> <dt id="code.InteractiveInterpreter.runcode"> <tt class="descclassname">InteractiveInterpreter.</tt><tt class="descname">runcode</tt><big>(</big><em>code</em><big>)</big><a class="headerlink" href="#code.InteractiveInterpreter.runcode" title="Permalink to this definition">¶</a></dt> <dd><p>Execute a code object. When an exception occurs, <a class="reference internal" href="#code.InteractiveInterpreter.showtraceback" title="code.InteractiveInterpreter.showtraceback"><tt class="xref py py-meth docutils literal"><span class="pre">showtraceback()</span></tt></a> is called to display a traceback. All exceptions are caught except <a class="reference internal" href="exceptions.html#exceptions.SystemExit" title="exceptions.SystemExit"><tt class="xref py py-exc docutils literal"><span class="pre">SystemExit</span></tt></a>, which is allowed to propagate.</p> <p>A note about <a class="reference internal" href="exceptions.html#exceptions.KeyboardInterrupt" title="exceptions.KeyboardInterrupt"><tt class="xref py py-exc docutils literal"><span class="pre">KeyboardInterrupt</span></tt></a>: this exception may occur elsewhere in this code, and may not always be caught. The caller should be prepared to deal with it.</p> </dd></dl> <dl class="method"> <dt id="code.InteractiveInterpreter.showsyntaxerror"> <tt class="descclassname">InteractiveInterpreter.</tt><tt class="descname">showsyntaxerror</tt><big>(</big><span class="optional">[</span><em>filename</em><span class="optional">]</span><big>)</big><a class="headerlink" href="#code.InteractiveInterpreter.showsyntaxerror" title="Permalink to this definition">¶</a></dt> <dd><p>Display the syntax error that just occurred. This does not display a stack trace because there isn’t one for syntax errors. If <em>filename</em> is given, it is stuffed into the exception instead of the default filename provided by Python’s parser, because it always uses <tt class="docutils literal"><span class="pre">'<string>'</span></tt> when reading from a string. The output is written by the <a class="reference internal" href="#code.InteractiveInterpreter.write" title="code.InteractiveInterpreter.write"><tt class="xref py py-meth docutils literal"><span class="pre">write()</span></tt></a> method.</p> </dd></dl> <dl class="method"> <dt id="code.InteractiveInterpreter.showtraceback"> <tt class="descclassname">InteractiveInterpreter.</tt><tt class="descname">showtraceback</tt><big>(</big><big>)</big><a class="headerlink" href="#code.InteractiveInterpreter.showtraceback" title="Permalink to this definition">¶</a></dt> <dd><p>Display the exception that just occurred. We remove the first stack item because it is within the interpreter object implementation. The output is written by the <a class="reference internal" href="#code.InteractiveInterpreter.write" title="code.InteractiveInterpreter.write"><tt class="xref py py-meth docutils literal"><span class="pre">write()</span></tt></a> method.</p> </dd></dl> <dl class="method"> <dt id="code.InteractiveInterpreter.write"> <tt class="descclassname">InteractiveInterpreter.</tt><tt class="descname">write</tt><big>(</big><em>data</em><big>)</big><a class="headerlink" href="#code.InteractiveInterpreter.write" title="Permalink to this definition">¶</a></dt> <dd><p>Write a string to the standard error stream (<tt class="docutils literal"><span class="pre">sys.stderr</span></tt>). Derived classes should override this to provide the appropriate output handling as needed.</p> </dd></dl> </div> <div class="section" id="interactive-console-objects"> <span id="console-objects"></span><h2>28.1.2. Interactive Console Objects<a class="headerlink" href="#interactive-console-objects" title="Permalink to this headline">¶</a></h2> <p>The <a class="reference internal" href="#code.InteractiveConsole" title="code.InteractiveConsole"><tt class="xref py py-class docutils literal"><span class="pre">InteractiveConsole</span></tt></a> class is a subclass of <a class="reference internal" href="#code.InteractiveInterpreter" title="code.InteractiveInterpreter"><tt class="xref py py-class docutils literal"><span class="pre">InteractiveInterpreter</span></tt></a>, and so offers all the methods of the interpreter objects as well as the following additions.</p> <dl class="method"> <dt id="code.InteractiveConsole.interact"> <tt class="descclassname">InteractiveConsole.</tt><tt class="descname">interact</tt><big>(</big><span class="optional">[</span><em>banner</em><span class="optional">]</span><big>)</big><a class="headerlink" href="#code.InteractiveConsole.interact" title="Permalink to this definition">¶</a></dt> <dd><p>Closely emulate the interactive Python console. The optional banner argument specify the banner to print before the first interaction; by default it prints a banner similar to the one printed by the standard Python interpreter, followed by the class name of the console object in parentheses (so as not to confuse this with the real interpreter – since it’s so close!).</p> </dd></dl> <dl class="method"> <dt id="code.InteractiveConsole.push"> <tt class="descclassname">InteractiveConsole.</tt><tt class="descname">push</tt><big>(</big><em>line</em><big>)</big><a class="headerlink" href="#code.InteractiveConsole.push" title="Permalink to this definition">¶</a></dt> <dd><p>Push a line of source text 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 <tt class="xref py py-meth docutils literal"><span class="pre">runsource()</span></tt> 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 <tt class="docutils literal"><span class="pre">True</span></tt> if more input is required, <tt class="docutils literal"><span class="pre">False</span></tt> if the line was dealt with in some way (this is the same as <tt class="xref py py-meth docutils literal"><span class="pre">runsource()</span></tt>).</p> </dd></dl> <dl class="method"> <dt id="code.InteractiveConsole.resetbuffer"> <tt class="descclassname">InteractiveConsole.</tt><tt class="descname">resetbuffer</tt><big>(</big><big>)</big><a class="headerlink" href="#code.InteractiveConsole.resetbuffer" title="Permalink to this definition">¶</a></dt> <dd><p>Remove any unhandled source text from the input buffer.</p> </dd></dl> <dl class="method"> <dt id="code.InteractiveConsole.raw_input"> <tt class="descclassname">InteractiveConsole.</tt><tt class="descname">raw_input</tt><big>(</big><span class="optional">[</span><em>prompt</em><span class="optional">]</span><big>)</big><a class="headerlink" href="#code.InteractiveConsole.raw_input" title="Permalink to this definition">¶</a></dt> <dd><p>Write a prompt and read a line. The returned line does not include the trailing newline. When the user enters the EOF key sequence, <a class="reference internal" href="exceptions.html#exceptions.EOFError" title="exceptions.EOFError"><tt class="xref py py-exc docutils literal"><span class="pre">EOFError</span></tt></a> is raised. The base implementation uses the built-in function <a class="reference internal" href="functions.html#raw_input" title="raw_input"><tt class="xref py py-func docutils literal"><span class="pre">raw_input()</span></tt></a>; a subclass may replace this with a different implementation.</p> </dd></dl> </div> </div> </div> </div> </div> <div class="sphinxsidebar"> <div class="sphinxsidebarwrapper"> <h3><a href="../contents.html">Table Of Contents</a></h3> <ul> <li><a class="reference internal" href="#">28.1. <tt class="docutils literal"><span class="pre">code</span></tt> — Interpreter base classes</a><ul> <li><a class="reference internal" href="#interactive-interpreter-objects">28.1.1. Interactive Interpreter Objects</a></li> <li><a class="reference internal" href="#interactive-console-objects">28.1.2. Interactive Console Objects</a></li> </ul> </li> </ul> <h4>Previous topic</h4> <p class="topless"><a href="custominterp.html" title="previous chapter">28. Custom Python Interpreters</a></p> <h4>Next topic</h4> <p class="topless"><a href="codeop.html" title="next chapter">28.2. <tt class="docutils literal"><span class="pre">codeop</span></tt> — Compile Python code</a></p> <h3>This Page</h3> <ul class="this-page-menu"> <li><a href="../bugs.html">Report a Bug</a></li> <li><a href="../_sources/library/code.txt" rel="nofollow">Show Source</a></li> </ul> <div id="searchbox" style="display: none"> <h3>Quick search</h3> <form class="search" action="../search.html" method="get"> <input type="text" name="q" /> <input type="submit" value="Go" /> <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> <p class="searchtip" style="font-size: 90%"> Enter search terms or a module, class or function name. </p> </div> <script type="text/javascript">$('#searchbox').show(0);</script> </div> </div> <div class="clearer"></div> </div> <div class="related"> <h3>Navigation</h3> <ul> <li class="right" style="margin-right: 10px"> <a href="../genindex.html" title="General Index" >index</a></li> <li class="right" > <a href="../py-modindex.html" title="Python Module Index" >modules</a> |</li> <li class="right" > <a href="codeop.html" title="28.2. codeop — Compile Python code" >next</a> |</li> <li class="right" > <a href="custominterp.html" title="28. Custom Python Interpreters" >previous</a> |</li> <li><img src="../_static/py.png" alt="" style="vertical-align: middle; margin-top: -1px"/></li> <li><a href="http://www.python.org/">Python</a> »</li> <li> <a href="../index.html">Python 2.7.5 documentation</a> » </li> <li><a href="index.html" >The Python Standard Library</a> »</li> <li><a href="custominterp.html" >28. Custom Python Interpreters</a> »</li> </ul> </div> <div class="footer"> © <a href="../copyright.html">Copyright</a> 1990-2020, Python Software Foundation. <br /> The Python Software Foundation is a non-profit corporation. <a href="http://www.python.org/psf/donations/">Please donate.</a> <br /> Last updated on Oct 13, 2020. <a href="../bugs.html">Found a bug</a>? <br /> Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3. </div> </body> </html>