0x1949 Team - FAZEMRX - MANAGER

Edit File: code.html

<!DOCTYPE html>

<title>29.1. code — Interpreter base classes &#8212; Python 2.7.18 documentation</title>
 <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
 <link rel="stylesheet" type="text/css" href="../_static/classic.css" />
 
 <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
 <script src="../_static/jquery.js"></script>
 <script src="../_static/underscore.js"></script>
 <script src="../_static/doctools.js"></script>
 
 <script src="../_static/sidebar.js"></script>
 
 <link rel="search" type="application/opensearchdescription+xml"
 title="Search within Python 2.7.18 documentation"
 href="../_static/opensearch.xml"/>
 <link rel="author" title="About these documents" href="../about.html" />
 <link rel="index" title="Index" href="../genindex.html" />
 <link rel="search" title="Search" href="../search.html" />
 <link rel="copyright" title="Copyright" href="../copyright.html" />
 <link rel="next" title="29.2. codeop — Compile Python code" href="codeop.html" />
 <link rel="prev" title="29. Custom Python Interpreters" href="custominterp.html" />
 <link rel="shortcut icon" type="image/png" href="../_static/py.png" />
 <link rel="canonical" href="file:///usr/share/doc/python2.7/html/library/code.html" />
 <script type="text/javascript" src="../_static/copybutton.js"></script>

</head><body>
<div id="outdated-warning" style="padding: .5em; text-align: center; background-color: #FFBABA; color: #6A0E0E;">
 This document is for an old version of Python that is <a href="https://devguide.python.org/devcycle/#end-of-life-branches">no longer supported</a>.
 You should install the python3 and python3-doc packages and read the 
 <a href="file:///usr/share/doc/python3-doc/html/library/code.html"> Python documentation for the Python3 version packaged in this release</a>.
</div>
 
 <div class="related" role="navigation" aria-label="related navigation">
 <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="29.2. codeop — Compile Python code"
 accesskey="N">next</a> |</li>
 <li class="right" >
 <a href="custominterp.html" title="29. 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="https://www.python.org/">Python</a> &#187;</li>
 <li>
 <a href="../index.html">Python 2.7.18 documentation</a> &#187;
 </li>

<li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> &#187;</li>
 <li class="nav-item nav-item-2"><a href="custominterp.html" accesskey="U">29. Custom Python Interpreters</a> &#187;</li>
 <li class="nav-item nav-item-this"><a href="">29.1. <code class="xref py py-mod docutils literal notranslate">code</code> — Interpreter base classes</a></li> 
 </ul>
 </div>

<div class="document">
 <div class="documentwrapper">
 <div class="bodywrapper">
 <div class="body" role="main">
 
 <section id="module-code">
<h1>29.1. <a class="reference internal" href="#module-code" title="code: Facilities to implement read-eval-print loops."><code class="xref py py-mod docutils literal notranslate">code</code></a> — Interpreter base classes<a class="headerlink" href="#module-code" title="Permalink to this headline">¶</a></h1>
The <code class="docutils literal notranslate">code</code> 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.
<dl class="py class">
<dt class="sig sig-object py" id="code.InteractiveInterpreter">
class code.InteractiveInterpreter([locals])<a class="headerlink" href="#code.InteractiveInterpreter" title="Permalink to this definition">¶</a></dt>
<dd>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 locals argument
specifies the dictionary in which code will be executed; it defaults to a newly
created dictionary with key <code class="docutils literal notranslate">'__name__'</code> set to <code class="docutils literal notranslate">'__console__'</code> and key
<code class="docutils literal notranslate">'__doc__'</code> set to <code class="docutils literal notranslate">None</code>.
</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="code.InteractiveConsole">
class code.InteractiveConsole([locals[, filename]])<a class="headerlink" href="#code.InteractiveConsole" title="Permalink to this definition">¶</a></dt>
<dd>Closely emulate the behavior of the interactive Python interpreter. This class
builds on <a class="reference internal" href="#code.InteractiveInterpreter" title="code.InteractiveInterpreter"><code class="xref py py-class docutils literal notranslate">InteractiveInterpreter</code></a> and adds prompting using the familiar
<code class="docutils literal notranslate">sys.ps1</code> and <code class="docutils literal notranslate">sys.ps2</code>, and input buffering.
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="code.interact">
code.interact([banner[, readfunc[, local]]])<a class="headerlink" href="#code.interact" title="Permalink to this definition">¶</a></dt>
<dd>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"><code class="xref py py-class docutils literal notranslate">InteractiveConsole</code></a> and sets readfunc to be used as the
<a class="reference internal" href="#code.InteractiveConsole.raw_input" title="code.InteractiveConsole.raw_input"><code class="xref py py-meth docutils literal notranslate">InteractiveConsole.raw_input()</code></a> method, if provided. If local is
provided, it is passed to the <a class="reference internal" href="#code.InteractiveConsole" title="code.InteractiveConsole"><code class="xref py py-class docutils literal notranslate">InteractiveConsole</code></a> constructor for
use as the default namespace for the interpreter loop. The <a class="reference internal" href="#code.interact" title="code.interact"><code class="xref py py-meth docutils literal notranslate">interact()</code></a>
method of the instance is then run with banner passed as the banner to
use, if provided. The console object is discarded after use.
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="code.compile_command">
code.compile_command(source[, filename[, symbol]])<a class="headerlink" href="#code.compile_command" title="Permalink to this definition">¶</a></dt>
<dd>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 almost always makes the same decision as the real interpreter main
loop.
source is the source string; filename is the optional filename from which
source was read, defaulting to <code class="docutils literal notranslate">'&lt;input&gt;'</code>; and symbol is the optional
grammar start symbol, which should be either <code class="docutils literal notranslate">'single'</code> (the default) or
<code class="docutils literal notranslate">'eval'</code>.
Returns a code object (the same as <code class="docutils literal notranslate">compile(source, filename, symbol)</code>) if the
command is complete and valid; <code class="docutils literal notranslate">None</code> if the command is incomplete; raises
<code class="xref py py-exc docutils literal notranslate">SyntaxError</code> if the command is complete and contains a syntax error, or
raises <code class="xref py py-exc docutils literal notranslate">OverflowError</code> or <code class="xref py py-exc docutils literal notranslate">ValueError</code> if the command contains an
invalid literal.
</dd></dl>

<section id="interactive-interpreter-objects">
<h2>29.1.1. Interactive Interpreter Objects<a class="headerlink" href="#interactive-interpreter-objects" title="Permalink to this headline">¶</a></h2>
<dl class="py method">
<dt class="sig sig-object py" id="code.InteractiveInterpreter.runsource">
InteractiveInterpreter.runsource(source[, filename[, symbol]])<a class="headerlink" href="#code.InteractiveInterpreter.runsource" title="Permalink to this definition">¶</a></dt>
<dd>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"><code class="xref py py-func docutils literal notranslate">compile_command()</code></a>; the default for filename is <code class="docutils literal notranslate">'&lt;input&gt;'</code>, and for
symbol is <code class="docutils literal notranslate">'single'</code>. One several things can happen:
<ul class="simple">
<li>The input is incorrect; <a class="reference internal" href="#code.compile_command" title="code.compile_command"><code class="xref py py-func docutils literal notranslate">compile_command()</code></a> raised an exception
(<code class="xref py py-exc docutils literal notranslate">SyntaxError</code> or <code class="xref py py-exc docutils literal notranslate">OverflowError</code>). A syntax traceback will be
printed by calling the <a class="reference internal" href="#code.InteractiveInterpreter.showsyntaxerror" title="code.InteractiveInterpreter.showsyntaxerror"><code class="xref py py-meth docutils literal notranslate">showsyntaxerror()</code></a> method. <a class="reference internal" href="#code.InteractiveInterpreter.runsource" title="code.InteractiveInterpreter.runsource"><code class="xref py py-meth docutils literal notranslate">runsource()</code></a>
returns <code class="docutils literal notranslate">False</code>.</li>
<li>The input is incomplete, and more input is required; <a class="reference internal" href="#code.compile_command" title="code.compile_command"><code class="xref py py-func docutils literal notranslate">compile_command()</code></a>
returned <code class="docutils literal notranslate">None</code>. <a class="reference internal" href="#code.InteractiveInterpreter.runsource" title="code.InteractiveInterpreter.runsource"><code class="xref py py-meth docutils literal notranslate">runsource()</code></a> returns <code class="docutils literal notranslate">True</code>.</li>
<li>The input is complete; <a class="reference internal" href="#code.compile_command" title="code.compile_command"><code class="xref py py-func docutils literal notranslate">compile_command()</code></a> returned a code object. The
code is executed by calling the <a class="reference internal" href="#code.InteractiveInterpreter.runcode" title="code.InteractiveInterpreter.runcode"><code class="xref py py-meth docutils literal notranslate">runcode()</code></a> (which also handles run-time
exceptions, except for <code class="xref py py-exc docutils literal notranslate">SystemExit</code>). <a class="reference internal" href="#code.InteractiveInterpreter.runsource" title="code.InteractiveInterpreter.runsource"><code class="xref py py-meth docutils literal notranslate">runsource()</code></a> returns <code class="docutils literal notranslate">False</code>.</li>
</ul>
The return value can be used to decide whether to use <code class="docutils literal notranslate">sys.ps1</code> or <code class="docutils literal notranslate">sys.ps2</code>
to prompt the next line.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="code.InteractiveInterpreter.runcode">
InteractiveInterpreter.runcode(code)<a class="headerlink" href="#code.InteractiveInterpreter.runcode" title="Permalink to this definition">¶</a></dt>
<dd>Execute a code object. When an exception occurs, <a class="reference internal" href="#code.InteractiveInterpreter.showtraceback" title="code.InteractiveInterpreter.showtraceback"><code class="xref py py-meth docutils literal notranslate">showtraceback()</code></a> is called
to display a traceback. All exceptions are caught except <code class="xref py py-exc docutils literal notranslate">SystemExit</code>,
which is allowed to propagate.
A note about <code class="xref py py-exc docutils literal notranslate">KeyboardInterrupt</code>: this exception may occur elsewhere in
this code, and may not always be caught. The caller should be prepared to deal
with it.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="code.InteractiveInterpreter.showsyntaxerror">
InteractiveInterpreter.showsyntaxerror([filename])<a class="headerlink" href="#code.InteractiveInterpreter.showsyntaxerror" title="Permalink to this definition">¶</a></dt>
<dd>Display the syntax error that just occurred. This does not display a stack
trace because there isn’t one for syntax errors. If filename is given, it is
stuffed into the exception instead of the default filename provided by Python’s
parser, because it always uses <code class="docutils literal notranslate">'&lt;string&gt;'</code> when reading from a string. The
output is written by the <a class="reference internal" href="#code.InteractiveInterpreter.write" title="code.InteractiveInterpreter.write"><code class="xref py py-meth docutils literal notranslate">write()</code></a> method.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="code.InteractiveInterpreter.showtraceback">
InteractiveInterpreter.showtraceback()<a class="headerlink" href="#code.InteractiveInterpreter.showtraceback" title="Permalink to this definition">¶</a></dt>
<dd>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"><code class="xref py py-meth docutils literal notranslate">write()</code></a> method.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="code.InteractiveInterpreter.write">
InteractiveInterpreter.write(data)<a class="headerlink" href="#code.InteractiveInterpreter.write" title="Permalink to this definition">¶</a></dt>
<dd>Write a string to the standard error stream (<code class="docutils literal notranslate">sys.stderr</code>). Derived classes
should override this to provide the appropriate output handling as needed.
</dd></dl>

</section>
<section id="interactive-console-objects">
<h2>29.1.2. Interactive Console Objects<a class="headerlink" href="#interactive-console-objects" title="Permalink to this headline">¶</a></h2>
The <a class="reference internal" href="#code.InteractiveConsole" title="code.InteractiveConsole"><code class="xref py py-class docutils literal notranslate">InteractiveConsole</code></a> class is a subclass of
<a class="reference internal" href="#code.InteractiveInterpreter" title="code.InteractiveInterpreter"><code class="xref py py-class docutils literal notranslate">InteractiveInterpreter</code></a>, and so offers all the methods of the
interpreter objects as well as the following additions.
<dl class="py method">
<dt class="sig sig-object py" id="code.InteractiveConsole.interact">
InteractiveConsole.interact([banner])<a class="headerlink" href="#code.InteractiveConsole.interact" title="Permalink to this definition">¶</a></dt>
<dd>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!).
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="code.InteractiveConsole.push">
InteractiveConsole.push(line)<a class="headerlink" href="#code.InteractiveConsole.push" title="Permalink to this definition">¶</a></dt>
<dd>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 <code class="xref py py-meth docutils literal notranslate">runsource()</code> 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 <code class="docutils literal notranslate">True</code> if more input is required, <code class="docutils literal notranslate">False</code> if the line was
dealt with in some way (this is the same as <code class="xref py py-meth docutils literal notranslate">runsource()</code>).
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="code.InteractiveConsole.resetbuffer">
InteractiveConsole.resetbuffer()<a class="headerlink" href="#code.InteractiveConsole.resetbuffer" title="Permalink to this definition">¶</a></dt>
<dd>Remove any unhandled source text from the input buffer.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="code.InteractiveConsole.raw_input">
InteractiveConsole.raw_input([prompt])<a class="headerlink" href="#code.InteractiveConsole.raw_input" title="Permalink to this definition">¶</a></dt>
<dd>Write a prompt and read a line. The returned line does not include the trailing
newline. When the user enters the EOF key sequence, <code class="xref py py-exc docutils literal notranslate">EOFError</code> is raised.
The base implementation uses the built-in function <a class="reference internal" href="functions.html#raw_input" title="raw_input"><code class="xref py py-func docutils literal notranslate">raw_input()</code></a>; a subclass
may replace this with a different implementation.
</dd></dl>

</section>
</section>

<div class="clearer"></div>
 </div>
 </div>
 </div>
 <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
 <div class="sphinxsidebarwrapper">
 <h3><a href="../contents.html">Table of Contents</a></h3>
 <ul>
<li><a class="reference internal" href="#">29.1. <code class="xref py py-mod docutils literal notranslate">code</code> — Interpreter base classes</a><ul>
<li><a class="reference internal" href="#interactive-interpreter-objects">29.1.1. Interactive Interpreter Objects</a></li>
<li><a class="reference internal" href="#interactive-console-objects">29.1.2. Interactive Console Objects</a></li>
</ul>
</li>
</ul>

<h4>Previous topic</h4>
 <a href="custominterp.html"
 title="previous chapter">29. Custom Python Interpreters</a>
 <h4>Next topic</h4>
 <a href="codeop.html"
 title="next chapter">29.2. <code class="xref py py-mod docutils literal notranslate">codeop</code> — Compile Python code</a>
 <div role="note" aria-label="source link">
 <h3>This Page</h3>
 <ul class="this-page-menu">
 <li><a href="../_sources/library/code.rst.txt"
 rel="nofollow">Show Source</a></li>
 </ul>
 </div>
<div id="searchbox" style="display: none" role="search">
 <h3 id="searchlabel">Quick search</h3>
 <div class="searchformwrapper">
 <form class="search" action="../search.html" method="get">
 <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
 <input type="submit" value="Go" />
 </form>
 </div>
</div>
<script>$('#searchbox').show(0);</script>
 </div>
 </div>
 <div class="clearer"></div>
 </div> 
 <div class="related" role="navigation" aria-label="related navigation">
 <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="29.2. codeop — Compile Python code"
 >next</a> |</li>
 <li class="right" >
 <a href="custominterp.html" title="29. Custom Python Interpreters"
 >previous</a> |</li>
 <li><img src="../_static/py.png" alt=""
 style="vertical-align: middle; margin-top: -1px"/></li>
 <li><a href="https://www.python.org/">Python</a> &#187;</li>
 <li>
 <a href="../index.html">Python 2.7.18 documentation</a> &#187;
 </li>

<li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> &#187;</li>
 <li class="nav-item nav-item-2"><a href="custominterp.html" >29. Custom Python Interpreters</a> &#187;</li>
 <li class="nav-item nav-item-this"><a href="">29.1. <code class="xref py py-mod docutils literal notranslate">code</code> — Interpreter base classes</a></li> 
 </ul>
 </div> 
 <div class="footer">
 &copy; <a href="../copyright.html">Copyright</a> 1990-2024, Python Software Foundation.
 
 The Python Software Foundation is a non-profit corporation.
 <a href="https://www.python.org/psf/donations/">Please donate.</a>
 
 Last updated on November 21, 2024.
 <a href="../bugs.html">Found a bug</a>?
 
 Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 4.3.2.
 </div>

</body>
</html>