37f0e884fbad9667e38940169d0a3c95

Edit file

File name : veryhigh.html

Content :

<!DOCTYPE html>

<title>The Very High Level Layer &#8212; Python 3.10.12 documentation</title><meta name="viewport" content="width=device-width, initial-scale=1.0">
 
 <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
 <link rel="stylesheet" type="text/css" href="../_static/pydoctheme.css?2022.1" />
 
 <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 3.10.12 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="Reference Counting" href="refcounting.html" />
 <link rel="prev" title="C API Stability" href="stable.html" />
 <link rel="canonical" href="file:///usr/share/doc/python3.10/html/c-api/veryhigh.html" />

</head>
<body>
<div class="mobile-nav">
 <input type="checkbox" id="menuToggler" class="toggler__input" aria-controls="navigation"
 aria-pressed="false" aria-expanded="false" role="button" aria-label="Menu" />
 <label for="menuToggler" class="toggler__label">
 
 </label>
 <nav class="nav-content" role="navigation">
 <a href="https://www.python.org/" class="nav-logo">
 <img src="../_static/py.svg" alt="Logo"/>
 </a>
 <div class="version_switcher_placeholder"></div>
 <form role="search" class="search" action="../search.html" method="get">
 <svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" class="search-icon">
 <path fill-rule="nonzero"
 d="M15.5 14h-.79l-.28-.27a6.5 6.5 0 001.48-5.34c-.47-2.78-2.79-5-5.59-5.34a6.505 6.505 0 00-7.27 7.27c.34 2.8 2.56 5.12 5.34 5.59a6.5 6.5 0 005.34-1.48l.27.28v.79l4.25 4.25c.41.41 1.08.41 1.49 0 .41-.41.41-1.08 0-1.49L15.5 14zm-6 0C7.01 14 5 11.99 5 9.5S7.01 5 9.5 5 14 7.01 14 9.5 11.99 14 9.5 14z" fill="#444"></path>
 </svg>
 <input type="text" name="q" aria-label="Quick search"/>
 <input type="submit" value="Go"/>
 </form>
 </nav>
 <div class="menu-wrapper">
 <nav class="menu" role="navigation" aria-label="main navigation">
 <div class="language_switcher_placeholder"></div>
 <h4>Previous topic</h4>
 <a href="stable.html"
 title="previous chapter">C API Stability</a>
 <h4>Next topic</h4>
 <a href="refcounting.html"
 title="next chapter">Reference Counting</a>
 <div role="note" aria-label="source link">
 <h3>This Page</h3>
 <ul class="this-page-menu">
 <li><a href="../bugs.html">Report a Bug</a></li>
 <li>
 <a href="https://github.com/python/cpython/blob/3.10/Doc/c-api/veryhigh.rst"
 rel="nofollow">Show Source
 </a>
 </li>
 </ul>
 </div>
 </nav>
 </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"
 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="refcounting.html" title="Reference Counting"
 accesskey="N">next</a> |</li>
 <li class="right" >
 <a href="stable.html" title="C API Stability"
 accesskey="P">previous</a> |</li>

<li><img src="../_static/py.svg" alt="python logo" style="vertical-align: middle; margin-top: -1px"/></li>
 <li><a href="https://www.python.org/">Python</a> &#187;</li>
 <li class="switchers">
 <div class="language_switcher_placeholder"></div>
 <div class="version_switcher_placeholder"></div>
 </li>
 <li>
 
 </li>
 <li id="cpython-language-and-version">
 <a href="../index.html">3.10.12 Documentation</a> &#187;
 </li>

<li class="nav-item nav-item-1"><a href="index.html" accesskey="U">Python/C API Reference Manual</a> &#187;</li>
 <li class="nav-item nav-item-this"><a href="">The Very High Level Layer</a></li>
 <li class="right">

<div class="document">
 <div class="documentwrapper">
 <div class="bodywrapper">
 <div class="body" role="main">
 
 <section id="the-very-high-level-layer">
<h1>The Very High Level Layer<a class="headerlink" href="#the-very-high-level-layer" title="Permalink to this headline">¶</a></h1>
The functions in this chapter will let you execute Python source code given in a
file or a buffer, but they will not let you interact in a more detailed way with
the interpreter.
Several of these functions accept a start symbol from the grammar as a
parameter. The available start symbols are <code class="xref py py-const docutils literal notranslate">Py_eval_input</code>,
<code class="xref py py-const docutils literal notranslate">Py_file_input</code>, and <code class="xref py py-const docutils literal notranslate">Py_single_input</code>. These are described
following the functions which accept them as parameters.
Note also that several of these functions take FILE* parameters. One
particular issue which needs to be handled carefully is that the FILE
structure for different C libraries can be different and incompatible. Under
Windows (at least), it is possible for dynamically linked extensions to actually
use different libraries, so care should be taken that FILE* parameters
are only passed to these functions if it is certain that they were created by
the same library that the Python runtime is using.
<dl class="c function">
<dt class="sig sig-object c" id="c.Py_Main">
int Py_Main(int argc, wchar_t **argv)<a class="headerlink" href="#c.Py_Main" title="Permalink to this definition">¶</a> </dt>
<dd> Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a>.The main program for the standard interpreter. This is made available for
programs which embed Python. The argc and argv parameters should be
prepared exactly as those which are passed to a C program’s <code class="xref c c-func docutils literal notranslate">main()</code>
function (converted to wchar_t according to the user’s locale). It is
important to note that the argument list may be modified (but the contents of
the strings pointed to by the argument list are not). The return value will
be <code class="docutils literal notranslate">0</code> if the interpreter exits normally (i.e., without an exception),
<code class="docutils literal notranslate">1</code> if the interpreter exits due to an exception, or <code class="docutils literal notranslate">2</code> if the parameter
list does not represent a valid Python command line.
Note that if an otherwise unhandled <a class="reference internal" href="../library/exceptions.html#SystemExit" title="SystemExit"><code class="xref py py-exc docutils literal notranslate">SystemExit</code></a> is raised, this
function will not return <code class="docutils literal notranslate">1</code>, but exit the process, as long as
<code class="docutils literal notranslate">Py_InspectFlag</code> is not set.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.Py_BytesMain">
int Py_BytesMain(int argc, char **argv)<a class="headerlink" href="#c.Py_BytesMain" title="Permalink to this definition">¶</a> </dt>
<dd> Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a> since version 3.8.Similar to <a class="reference internal" href="#c.Py_Main" title="Py_Main"><code class="xref c c-func docutils literal notranslate">Py_Main()</code></a> but argv is an array of bytes strings.
<div class="versionadded">
New in version 3.8.
</div>
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyRun_AnyFile">
int PyRun_AnyFile(FILE *fp, const char *filename)<a class="headerlink" href="#c.PyRun_AnyFile" title="Permalink to this definition">¶</a> </dt>
<dd>This is a simplified interface to <a class="reference internal" href="#c.PyRun_AnyFileExFlags" title="PyRun_AnyFileExFlags"><code class="xref c c-func docutils literal notranslate">PyRun_AnyFileExFlags()</code></a> below, leaving
closeit set to <code class="docutils literal notranslate">0</code> and flags set to <code class="docutils literal notranslate">NULL</code>.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyRun_AnyFileFlags">
int PyRun_AnyFileFlags(FILE *fp, const char *filename, <a class="reference internal" href="#c.PyCompilerFlags" title="PyCompilerFlags">PyCompilerFlags</a> *flags)<a class="headerlink" href="#c.PyRun_AnyFileFlags" title="Permalink to this definition">¶</a> </dt>
<dd>This is a simplified interface to <a class="reference internal" href="#c.PyRun_AnyFileExFlags" title="PyRun_AnyFileExFlags"><code class="xref c c-func docutils literal notranslate">PyRun_AnyFileExFlags()</code></a> below, leaving
the closeit argument set to <code class="docutils literal notranslate">0</code>.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyRun_AnyFileEx">
int PyRun_AnyFileEx(FILE *fp, const char *filename, int closeit)<a class="headerlink" href="#c.PyRun_AnyFileEx" title="Permalink to this definition">¶</a> </dt>
<dd>This is a simplified interface to <a class="reference internal" href="#c.PyRun_AnyFileExFlags" title="PyRun_AnyFileExFlags"><code class="xref c c-func docutils literal notranslate">PyRun_AnyFileExFlags()</code></a> below, leaving
the flags argument set to <code class="docutils literal notranslate">NULL</code>.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyRun_AnyFileExFlags">
int PyRun_AnyFileExFlags(FILE *fp, const char *filename, int closeit, <a class="reference internal" href="#c.PyCompilerFlags" title="PyCompilerFlags">PyCompilerFlags</a> *flags)<a class="headerlink" href="#c.PyRun_AnyFileExFlags" title="Permalink to this definition">¶</a> </dt>
<dd>If fp refers to a file associated with an interactive device (console or
terminal input or Unix pseudo-terminal), return the value of
<a class="reference internal" href="#c.PyRun_InteractiveLoop" title="PyRun_InteractiveLoop"><code class="xref c c-func docutils literal notranslate">PyRun_InteractiveLoop()</code></a>, otherwise return the result of
<a class="reference internal" href="#c.PyRun_SimpleFile" title="PyRun_SimpleFile"><code class="xref c c-func docutils literal notranslate">PyRun_SimpleFile()</code></a>. filename is decoded from the filesystem
encoding (<a class="reference internal" href="../library/sys.html#sys.getfilesystemencoding" title="sys.getfilesystemencoding"><code class="xref py py-func docutils literal notranslate">sys.getfilesystemencoding()</code></a>). If filename is <code class="docutils literal notranslate">NULL</code>, this
function uses <code class="docutils literal notranslate">&quot;???&quot;</code> as the filename.
If closeit is true, the file is closed before
<code class="docutils literal notranslate">PyRun_SimpleFileExFlags()</code> returns.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyRun_SimpleString">
int PyRun_SimpleString(const char *command)<a class="headerlink" href="#c.PyRun_SimpleString" title="Permalink to this definition">¶</a> </dt>
<dd>This is a simplified interface to <a class="reference internal" href="#c.PyRun_SimpleStringFlags" title="PyRun_SimpleStringFlags"><code class="xref c c-func docutils literal notranslate">PyRun_SimpleStringFlags()</code></a> below,
leaving the <a class="reference internal" href="#c.PyCompilerFlags" title="PyCompilerFlags"><code class="xref c c-struct docutils literal notranslate">PyCompilerFlags</code></a>* argument set to <code class="docutils literal notranslate">NULL</code>.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyRun_SimpleStringFlags">
int PyRun_SimpleStringFlags(const char *command, <a class="reference internal" href="#c.PyCompilerFlags" title="PyCompilerFlags">PyCompilerFlags</a> *flags)<a class="headerlink" href="#c.PyRun_SimpleStringFlags" title="Permalink to this definition">¶</a> </dt>
<dd>Executes the Python source code from command in the <a class="reference internal" href="../library/__main__.html#module-__main__" title="__main__: The environment where top-level code is run. Covers command-line interfaces, import-time behavior, and ``__name__ == '__main__'``."><code class="xref py py-mod docutils literal notranslate">__main__</code></a> module
according to the flags argument. If <a class="reference internal" href="../library/__main__.html#module-__main__" title="__main__: The environment where top-level code is run. Covers command-line interfaces, import-time behavior, and ``__name__ == '__main__'``."><code class="xref py py-mod docutils literal notranslate">__main__</code></a> does not already exist, it
is created. Returns <code class="docutils literal notranslate">0</code> on success or <code class="docutils literal notranslate">-1</code> if an exception was raised. If
there was an error, there is no way to get the exception information. For the
meaning of flags, see below.
Note that if an otherwise unhandled <a class="reference internal" href="../library/exceptions.html#SystemExit" title="SystemExit"><code class="xref py py-exc docutils literal notranslate">SystemExit</code></a> is raised, this
function will not return <code class="docutils literal notranslate">-1</code>, but exit the process, as long as
<code class="docutils literal notranslate">Py_InspectFlag</code> is not set.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyRun_SimpleFile">
int PyRun_SimpleFile(FILE *fp, const char *filename)<a class="headerlink" href="#c.PyRun_SimpleFile" title="Permalink to this definition">¶</a> </dt>
<dd>This is a simplified interface to <a class="reference internal" href="#c.PyRun_SimpleFileExFlags" title="PyRun_SimpleFileExFlags"><code class="xref c c-func docutils literal notranslate">PyRun_SimpleFileExFlags()</code></a> below,
leaving closeit set to <code class="docutils literal notranslate">0</code> and flags set to <code class="docutils literal notranslate">NULL</code>.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyRun_SimpleFileEx">
int PyRun_SimpleFileEx(FILE *fp, const char *filename, int closeit)<a class="headerlink" href="#c.PyRun_SimpleFileEx" title="Permalink to this definition">¶</a> </dt>
<dd>This is a simplified interface to <a class="reference internal" href="#c.PyRun_SimpleFileExFlags" title="PyRun_SimpleFileExFlags"><code class="xref c c-func docutils literal notranslate">PyRun_SimpleFileExFlags()</code></a> below,
leaving flags set to <code class="docutils literal notranslate">NULL</code>.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyRun_SimpleFileExFlags">
int PyRun_SimpleFileExFlags(FILE *fp, const char *filename, int closeit, <a class="reference internal" href="#c.PyCompilerFlags" title="PyCompilerFlags">PyCompilerFlags</a> *flags)<a class="headerlink" href="#c.PyRun_SimpleFileExFlags" title="Permalink to this definition">¶</a> </dt>
<dd>Similar to <a class="reference internal" href="#c.PyRun_SimpleStringFlags" title="PyRun_SimpleStringFlags"><code class="xref c c-func docutils literal notranslate">PyRun_SimpleStringFlags()</code></a>, but the Python source code is read
from fp instead of an in-memory string. filename should be the name of
the file, it is decoded from <a class="reference internal" href="../glossary.html#term-filesystem-encoding-and-error-handler">filesystem encoding and error handler</a>.
If closeit is true, the file is closed before
<code class="docutils literal notranslate">PyRun_SimpleFileExFlags()</code> returns.
<div class="admonition note">
Note
On Windows, fp should be opened as binary mode (e.g. <code class="docutils literal notranslate">fopen(filename, &quot;rb&quot;)</code>).
Otherwise, Python may not handle script file with LF line ending correctly.
</div>
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyRun_InteractiveOne">
int PyRun_InteractiveOne(FILE *fp, const char *filename)<a class="headerlink" href="#c.PyRun_InteractiveOne" title="Permalink to this definition">¶</a> </dt>
<dd>This is a simplified interface to <a class="reference internal" href="#c.PyRun_InteractiveOneFlags" title="PyRun_InteractiveOneFlags"><code class="xref c c-func docutils literal notranslate">PyRun_InteractiveOneFlags()</code></a> below,
leaving flags set to <code class="docutils literal notranslate">NULL</code>.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyRun_InteractiveOneFlags">
int PyRun_InteractiveOneFlags(FILE *fp, const char *filename, <a class="reference internal" href="#c.PyCompilerFlags" title="PyCompilerFlags">PyCompilerFlags</a> *flags)<a class="headerlink" href="#c.PyRun_InteractiveOneFlags" title="Permalink to this definition">¶</a> </dt>
<dd>Read and execute a single statement from a file associated with an
interactive device according to the flags argument. The user will be
prompted using <code class="docutils literal notranslate">sys.ps1</code> and <code class="docutils literal notranslate">sys.ps2</code>. filename is decoded from the
<a class="reference internal" href="../glossary.html#term-filesystem-encoding-and-error-handler">filesystem encoding and error handler</a>.
Returns <code class="docutils literal notranslate">0</code> when the input was
executed successfully, <code class="docutils literal notranslate">-1</code> if there was an exception, or an error code
from the <code class="file docutils literal notranslate">errcode.h</code> include file distributed as part of Python if
there was a parse error. (Note that <code class="file docutils literal notranslate">errcode.h</code> is not included by
<code class="file docutils literal notranslate">Python.h</code>, so must be included specifically if needed.)
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyRun_InteractiveLoop">
int PyRun_InteractiveLoop(FILE *fp, const char *filename)<a class="headerlink" href="#c.PyRun_InteractiveLoop" title="Permalink to this definition">¶</a> </dt>
<dd>This is a simplified interface to <a class="reference internal" href="#c.PyRun_InteractiveLoopFlags" title="PyRun_InteractiveLoopFlags"><code class="xref c c-func docutils literal notranslate">PyRun_InteractiveLoopFlags()</code></a> below,
leaving flags set to <code class="docutils literal notranslate">NULL</code>.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyRun_InteractiveLoopFlags">
int PyRun_InteractiveLoopFlags(FILE *fp, const char *filename, <a class="reference internal" href="#c.PyCompilerFlags" title="PyCompilerFlags">PyCompilerFlags</a> *flags)<a class="headerlink" href="#c.PyRun_InteractiveLoopFlags" title="Permalink to this definition">¶</a> </dt>
<dd>Read and execute statements from a file associated with an interactive device
until EOF is reached. The user will be prompted using <code class="docutils literal notranslate">sys.ps1</code> and
<code class="docutils literal notranslate">sys.ps2</code>. filename is decoded from the <a class="reference internal" href="../glossary.html#term-filesystem-encoding-and-error-handler">filesystem encoding and
error handler</a>. Returns <code class="docutils literal notranslate">0</code> at EOF or a negative number upon failure.
</dd></dl>

<dl class="c var">
<dt class="sig sig-object c" id="c.PyOS_InputHook">
int (*PyOS_InputHook)(void)<a class="headerlink" href="#c.PyOS_InputHook" title="Permalink to this definition">¶</a> </dt>
<dd> Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a>.Can be set to point to a function with the prototype
<code class="docutils literal notranslate">int func(void)</code>. The function will be called when Python’s
interpreter prompt is about to become idle and wait for user input
from the terminal. The return value is ignored. Overriding this
hook can be used to integrate the interpreter’s prompt with other
event loops, as done in the <code class="file docutils literal notranslate">Modules/_tkinter.c</code> in the
Python source code.
</dd></dl>

<dl class="c var">
<dt class="sig sig-object c" id="c.PyOS_ReadlineFunctionPointer">
char *(*PyOS_ReadlineFunctionPointer)(FILE*, FILE*, const char*)<a class="headerlink" href="#c.PyOS_ReadlineFunctionPointer" title="Permalink to this definition">¶</a> </dt>
<dd>Can be set to point to a function with the prototype
<code class="docutils literal notranslate">char *func(FILE *stdin, FILE *stdout, char *prompt)</code>,
overriding the default function used to read a single line of input
at the interpreter’s prompt. The function is expected to output
the string prompt if it’s not <code class="docutils literal notranslate">NULL</code>, and then read a line of
input from the provided standard input file, returning the
resulting string. For example, The <a class="reference internal" href="../library/readline.html#module-readline" title="readline: GNU readline support for Python. (Unix)"><code class="xref py py-mod docutils literal notranslate">readline</code></a> module sets
this hook to provide line-editing and tab-completion features.
The result must be a string allocated by <a class="reference internal" href="memory.html#c.PyMem_RawMalloc" title="PyMem_RawMalloc"><code class="xref c c-func docutils literal notranslate">PyMem_RawMalloc()</code></a> or
<a class="reference internal" href="memory.html#c.PyMem_RawRealloc" title="PyMem_RawRealloc"><code class="xref c c-func docutils literal notranslate">PyMem_RawRealloc()</code></a>, or <code class="docutils literal notranslate">NULL</code> if an error occurred.
<div class="versionchanged">
Changed in version 3.4: The result must be allocated by <a class="reference internal" href="memory.html#c.PyMem_RawMalloc" title="PyMem_RawMalloc"><code class="xref c c-func docutils literal notranslate">PyMem_RawMalloc()</code></a> or
<a class="reference internal" href="memory.html#c.PyMem_RawRealloc" title="PyMem_RawRealloc"><code class="xref c c-func docutils literal notranslate">PyMem_RawRealloc()</code></a>, instead of being allocated by
<a class="reference internal" href="memory.html#c.PyMem_Malloc" title="PyMem_Malloc"><code class="xref c c-func docutils literal notranslate">PyMem_Malloc()</code></a> or <a class="reference internal" href="memory.html#c.PyMem_Realloc" title="PyMem_Realloc"><code class="xref c c-func docutils literal notranslate">PyMem_Realloc()</code></a>.
</div>
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyRun_String">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyRun_String(const char *str, int start, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *globals, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *locals)<a class="headerlink" href="#c.PyRun_String" title="Permalink to this definition">¶</a> </dt>
<dd>Return value: New reference.This is a simplified interface to <a class="reference internal" href="#c.PyRun_StringFlags" title="PyRun_StringFlags"><code class="xref c c-func docutils literal notranslate">PyRun_StringFlags()</code></a> below, leaving
flags set to <code class="docutils literal notranslate">NULL</code>.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyRun_StringFlags">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyRun_StringFlags(const char *str, int start, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *globals, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *locals, <a class="reference internal" href="#c.PyCompilerFlags" title="PyCompilerFlags">PyCompilerFlags</a> *flags)<a class="headerlink" href="#c.PyRun_StringFlags" title="Permalink to this definition">¶</a> </dt>
<dd>Return value: New reference.Execute Python source code from str in the context specified by the
objects globals and locals with the compiler flags specified by
flags. globals must be a dictionary; locals can be any object
that implements the mapping protocol. The parameter start specifies
the start token that should be used to parse the source code.
Returns the result of executing the code as a Python object, or <code class="docutils literal notranslate">NULL</code> if an
exception was raised.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyRun_File">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyRun_File(FILE *fp, const char *filename, int start, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *globals, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *locals)<a class="headerlink" href="#c.PyRun_File" title="Permalink to this definition">¶</a> </dt>
<dd>Return value: New reference.This is a simplified interface to <a class="reference internal" href="#c.PyRun_FileExFlags" title="PyRun_FileExFlags"><code class="xref c c-func docutils literal notranslate">PyRun_FileExFlags()</code></a> below, leaving
closeit set to <code class="docutils literal notranslate">0</code> and flags set to <code class="docutils literal notranslate">NULL</code>.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyRun_FileEx">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyRun_FileEx(FILE *fp, const char *filename, int start, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *globals, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *locals, int closeit)<a class="headerlink" href="#c.PyRun_FileEx" title="Permalink to this definition">¶</a> </dt>
<dd>Return value: New reference.This is a simplified interface to <a class="reference internal" href="#c.PyRun_FileExFlags" title="PyRun_FileExFlags"><code class="xref c c-func docutils literal notranslate">PyRun_FileExFlags()</code></a> below, leaving
flags set to <code class="docutils literal notranslate">NULL</code>.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyRun_FileFlags">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyRun_FileFlags(FILE *fp, const char *filename, int start, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *globals, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *locals, <a class="reference internal" href="#c.PyCompilerFlags" title="PyCompilerFlags">PyCompilerFlags</a> *flags)<a class="headerlink" href="#c.PyRun_FileFlags" title="Permalink to this definition">¶</a> </dt>
<dd>Return value: New reference.This is a simplified interface to <a class="reference internal" href="#c.PyRun_FileExFlags" title="PyRun_FileExFlags"><code class="xref c c-func docutils literal notranslate">PyRun_FileExFlags()</code></a> below, leaving
closeit set to <code class="docutils literal notranslate">0</code>.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyRun_FileExFlags">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyRun_FileExFlags(FILE *fp, const char *filename, int start, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *globals, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *locals, int closeit, <a class="reference internal" href="#c.PyCompilerFlags" title="PyCompilerFlags">PyCompilerFlags</a> *flags)<a class="headerlink" href="#c.PyRun_FileExFlags" title="Permalink to this definition">¶</a> </dt>
<dd>Return value: New reference.Similar to <a class="reference internal" href="#c.PyRun_StringFlags" title="PyRun_StringFlags"><code class="xref c c-func docutils literal notranslate">PyRun_StringFlags()</code></a>, but the Python source code is read from
fp instead of an in-memory string. filename should be the name of the file,
it is decoded from the <a class="reference internal" href="../glossary.html#term-filesystem-encoding-and-error-handler">filesystem encoding and error handler</a>.
If closeit is true, the file is closed before <a class="reference internal" href="#c.PyRun_FileExFlags" title="PyRun_FileExFlags"><code class="xref c c-func docutils literal notranslate">PyRun_FileExFlags()</code></a>
returns.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.Py_CompileString">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *Py_CompileString(const char *str, const char *filename, int start)<a class="headerlink" href="#c.Py_CompileString" title="Permalink to this definition">¶</a> </dt>
<dd>Return value: New reference. Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a>.This is a simplified interface to <a class="reference internal" href="#c.Py_CompileStringFlags" title="Py_CompileStringFlags"><code class="xref c c-func docutils literal notranslate">Py_CompileStringFlags()</code></a> below, leaving
flags set to <code class="docutils literal notranslate">NULL</code>.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.Py_CompileStringFlags">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *Py_CompileStringFlags(const char *str, const char *filename, int start, <a class="reference internal" href="#c.PyCompilerFlags" title="PyCompilerFlags">PyCompilerFlags</a> *flags)<a class="headerlink" href="#c.Py_CompileStringFlags" title="Permalink to this definition">¶</a> </dt>
<dd>Return value: New reference.This is a simplified interface to <a class="reference internal" href="#c.Py_CompileStringExFlags" title="Py_CompileStringExFlags"><code class="xref c c-func docutils literal notranslate">Py_CompileStringExFlags()</code></a> below, with
optimize set to <code class="docutils literal notranslate">-1</code>.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.Py_CompileStringObject">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *Py_CompileStringObject(const char *str, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *filename, int start, <a class="reference internal" href="#c.PyCompilerFlags" title="PyCompilerFlags">PyCompilerFlags</a> *flags, int optimize)<a class="headerlink" href="#c.Py_CompileStringObject" title="Permalink to this definition">¶</a> </dt>
<dd>Return value: New reference.Parse and compile the Python source code in str, returning the resulting code
object. The start token is given by start; this can be used to constrain the
code which can be compiled and should be <code class="xref py py-const docutils literal notranslate">Py_eval_input</code>,
<code class="xref py py-const docutils literal notranslate">Py_file_input</code>, or <code class="xref py py-const docutils literal notranslate">Py_single_input</code>. The filename specified by
filename is used to construct the code object and may appear in tracebacks or
<a class="reference internal" href="../library/exceptions.html#SyntaxError" title="SyntaxError"><code class="xref py py-exc docutils literal notranslate">SyntaxError</code></a> exception messages. This returns <code class="docutils literal notranslate">NULL</code> if the code
cannot be parsed or compiled.
The integer optimize specifies the optimization level of the compiler; a
value of <code class="docutils literal notranslate">-1</code> selects the optimization level of the interpreter as given by
<a class="reference internal" href="../using/cmdline.html#cmdoption-O"><code class="xref std std-option docutils literal notranslate">-O</code></a> options. Explicit levels are <code class="docutils literal notranslate">0</code> (no optimization;
<code class="docutils literal notranslate">__debug__</code> is true), <code class="docutils literal notranslate">1</code> (asserts are removed, <code class="docutils literal notranslate">__debug__</code> is false)
or <code class="docutils literal notranslate">2</code> (docstrings are removed too).
<div class="versionadded">
New in version 3.4.
</div>
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.Py_CompileStringExFlags">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *Py_CompileStringExFlags(const char *str, const char *filename, int start, <a class="reference internal" href="#c.PyCompilerFlags" title="PyCompilerFlags">PyCompilerFlags</a> *flags, int optimize)<a class="headerlink" href="#c.Py_CompileStringExFlags" title="Permalink to this definition">¶</a> </dt>
<dd>Return value: New reference.Like <a class="reference internal" href="#c.Py_CompileStringObject" title="Py_CompileStringObject"><code class="xref c c-func docutils literal notranslate">Py_CompileStringObject()</code></a>, but filename is a byte string
decoded from the <a class="reference internal" href="../glossary.html#term-filesystem-encoding-and-error-handler">filesystem encoding and error handler</a>.
<div class="versionadded">
New in version 3.2.
</div>
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyEval_EvalCode">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyEval_EvalCode(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *co, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *globals, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *locals)<a class="headerlink" href="#c.PyEval_EvalCode" title="Permalink to this definition">¶</a> </dt>
<dd>Return value: New reference. Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a>.This is a simplified interface to <a class="reference internal" href="#c.PyEval_EvalCodeEx" title="PyEval_EvalCodeEx"><code class="xref c c-func docutils literal notranslate">PyEval_EvalCodeEx()</code></a>, with just
the code object, and global and local variables. The other arguments are
set to <code class="docutils literal notranslate">NULL</code>.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyEval_EvalCodeEx">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyEval_EvalCodeEx(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *co, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *globals, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *locals, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *const *args, int argcount, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *const *kws, int kwcount, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *const *defs, int defcount, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *kwdefs, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *closure)<a class="headerlink" href="#c.PyEval_EvalCodeEx" title="Permalink to this definition">¶</a> </dt>
<dd>Return value: New reference. Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a>.Evaluate a precompiled code object, given a particular environment for its
evaluation. This environment consists of a dictionary of global variables,
a mapping object of local variables, arrays of arguments, keywords and
defaults, a dictionary of default values for <a class="reference internal" href="../glossary.html#keyword-only-parameter">keyword-only</a> arguments and a closure tuple of cells.
</dd></dl>

<dl class="c type">
<dt class="sig sig-object c" id="c.PyFrameObject">
type PyFrameObject<a class="headerlink" href="#c.PyFrameObject" title="Permalink to this definition">¶</a> </dt>
<dd> Part of the <a class="reference internal" href="stable.html#stable">Limited API</a> (as an opaque struct).The C structure of the objects used to describe frame objects. The
fields of this type are subject to change at any time.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyEval_EvalFrame">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyEval_EvalFrame(<a class="reference internal" href="#c.PyFrameObject" title="PyFrameObject">PyFrameObject</a> *f)<a class="headerlink" href="#c.PyEval_EvalFrame" title="Permalink to this definition">¶</a> </dt>
<dd>Return value: New reference. Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a>.Evaluate an execution frame. This is a simplified interface to
<a class="reference internal" href="#c.PyEval_EvalFrameEx" title="PyEval_EvalFrameEx"><code class="xref c c-func docutils literal notranslate">PyEval_EvalFrameEx()</code></a>, for backward compatibility.
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyEval_EvalFrameEx">
<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyEval_EvalFrameEx(<a class="reference internal" href="#c.PyFrameObject" title="PyFrameObject">PyFrameObject</a> *f, int throwflag)<a class="headerlink" href="#c.PyEval_EvalFrameEx" title="Permalink to this definition">¶</a> </dt>
<dd>Return value: New reference. Part of the <a class="reference internal" href="stable.html#stable">Stable ABI</a>.This is the main, unvarnished function of Python interpretation. The code
object associated with the execution frame f is executed, interpreting
bytecode and executing calls as needed. The additional throwflag
parameter can mostly be ignored - if true, then it causes an exception
to immediately be thrown; this is used for the <a class="reference internal" href="../reference/expressions.html#generator.throw" title="generator.throw"><code class="xref py py-meth docutils literal notranslate">throw()</code></a>
methods of generator objects.
<div class="versionchanged">
Changed in version 3.4: This function now includes a debug assertion to help ensure that it
does not silently discard an active exception.
</div>
</dd></dl>

<dl class="c function">
<dt class="sig sig-object c" id="c.PyEval_MergeCompilerFlags">
int PyEval_MergeCompilerFlags(<a class="reference internal" href="#c.PyCompilerFlags" title="PyCompilerFlags">PyCompilerFlags</a> *cf)<a class="headerlink" href="#c.PyEval_MergeCompilerFlags" title="Permalink to this definition">¶</a> </dt>
<dd>This function changes the flags of the current evaluation frame, and returns
true on success, false on failure.
</dd></dl>

<dl class="c var">
<dt class="sig sig-object c" id="c.Py_eval_input">
int Py_eval_input<a class="headerlink" href="#c.Py_eval_input" title="Permalink to this definition">¶</a> </dt>
<dd>The start symbol from the Python grammar for isolated expressions; for use with
<a class="reference internal" href="#c.Py_CompileString" title="Py_CompileString"><code class="xref c c-func docutils literal notranslate">Py_CompileString()</code></a>.
</dd></dl>

<dl class="c var">
<dt class="sig sig-object c" id="c.Py_file_input">
int Py_file_input<a class="headerlink" href="#c.Py_file_input" title="Permalink to this definition">¶</a> </dt>
<dd>The start symbol from the Python grammar for sequences of statements as read
from a file or other source; for use with <a class="reference internal" href="#c.Py_CompileString" title="Py_CompileString"><code class="xref c c-func docutils literal notranslate">Py_CompileString()</code></a>. This is
the symbol to use when compiling arbitrarily long Python source code.
</dd></dl>

<dl class="c var">
<dt class="sig sig-object c" id="c.Py_single_input">
int Py_single_input<a class="headerlink" href="#c.Py_single_input" title="Permalink to this definition">¶</a> </dt>
<dd>The start symbol from the Python grammar for a single statement; for use with
<a class="reference internal" href="#c.Py_CompileString" title="Py_CompileString"><code class="xref c c-func docutils literal notranslate">Py_CompileString()</code></a>. This is the symbol used for the interactive
interpreter loop.
</dd></dl>

<dl class="c struct">
<dt class="sig sig-object c" id="c.PyCompilerFlags">
struct PyCompilerFlags<a class="headerlink" href="#c.PyCompilerFlags" title="Permalink to this definition">¶</a> </dt>
<dd>This is the structure used to hold compiler flags. In cases where code is only
being compiled, it is passed as <code class="docutils literal notranslate">int flags</code>, and in cases where code is being
executed, it is passed as <code class="docutils literal notranslate">PyCompilerFlags *flags</code>. In this case, <code class="docutils literal notranslate">from
__future__ import</code> can modify flags.
Whenever <code class="docutils literal notranslate">PyCompilerFlags *flags</code> is <code class="docutils literal notranslate">NULL</code>, <code class="xref py py-attr docutils literal notranslate">cf_flags</code> is treated as
equal to <code class="docutils literal notranslate">0</code>, and any modification due to <code class="docutils literal notranslate">from __future__ import</code> is
discarded.
<dl class="c member">
<dt class="sig sig-object c" id="c.PyCompilerFlags.cf_flags">
int cf_flags<a class="headerlink" href="#c.PyCompilerFlags.cf_flags" title="Permalink to this definition">¶</a> </dt>
<dd>Compiler flags.
</dd></dl>

<dl class="c member">
<dt class="sig sig-object c" id="c.PyCompilerFlags.cf_feature_version">
int cf_feature_version<a class="headerlink" href="#c.PyCompilerFlags.cf_feature_version" title="Permalink to this definition">¶</a> </dt>
<dd>cf_feature_version is the minor Python version. It should be
initialized to <code class="docutils literal notranslate">PY_MINOR_VERSION</code>.
The field is ignored by default, it is used if and only if
<code class="docutils literal notranslate">PyCF_ONLY_AST</code> flag is set in cf_flags.
</dd></dl>

<div class="versionchanged">
Changed in version 3.8: Added cf_feature_version field.
</div>
</dd></dl>

<dl class="c var">
<dt class="sig sig-object c" id="c.CO_FUTURE_DIVISION">
int CO_FUTURE_DIVISION<a class="headerlink" href="#c.CO_FUTURE_DIVISION" title="Permalink to this definition">¶</a> </dt>
<dd>This bit can be set in flags to cause division operator <code class="docutils literal notranslate">/</code> to be
interpreted as “true division” according to <a class="pep reference external" href="https://www.python.org/dev/peps/pep-0238">PEP 238</a>.
</dd></dl>

</section>

<div class="clearer"></div>
 </div>
 </div>
 </div>
 <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
 <div class="sphinxsidebarwrapper">
 <h4>Previous topic</h4>
 <a href="stable.html"
 title="previous chapter">C API Stability</a>
 <h4>Next topic</h4>
 <a href="refcounting.html"
 title="next chapter">Reference Counting</a>
 <div role="note" aria-label="source link">
 <h3>This Page</h3>
 <ul class="this-page-menu">
 <li><a href="../bugs.html">Report a Bug</a></li>
 <li>
 <a href="https://github.com/python/cpython/blob/3.10/Doc/c-api/veryhigh.rst"
 rel="nofollow">Show Source
 </a>
 </li>
 </ul>
 </div>
 </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="refcounting.html" title="Reference Counting"
 >next</a> |</li>
 <li class="right" >
 <a href="stable.html" title="C API Stability"
 >previous</a> |</li>

<li class="nav-item nav-item-1"><a href="index.html" >Python/C API Reference Manual</a> &#187;</li>
 <li class="nav-item nav-item-this"><a href="">The Very High Level Layer</a></li>
 <li class="right">

<div class="inline-search" role="search">
 <form class="inline-search" action="../search.html" method="get">
 <input placeholder="Quick search" aria-label="Quick search" 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>
 </div>
 |
 </li>
 
 </ul>
 </div> 
 <div class="footer">
 &copy; <a href="../copyright.html">Copyright</a> 2001-2025, Python Software Foundation.
 
 This page is licensed under the Python Software Foundation License Version 2.
 
 Examples, recipes, and other code in the documentation are additionally licensed under the Zero Clause BSD License.
 
 See <a href="/license.html">History and License</a> for more information.

The Python Software Foundation is a non-profit corporation.
<a href="https://www.python.org/psf/donations/">Please donate.</a>

Last updated on February 04, 2025.
 <a href="/bugs.html">Found a bug</a>?

Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 4.3.2.
 </div>

</body>
</html>